Adding Menu Items to the Workflow Progress Options Menu
Workflow Manager 2020
You can now add custom menu items to the Options menu on the Progress tab of the Workflow Request page.
Custom Items on Options Menu of Progress Tab of Workflow Request View
To create custom menu items on the Options menu, you need to add records to the AMS_CustomWorkFlowLink table in the database. The menu items can link to general URLs (using the LinkUrl field) or they can link to MVC controllers and actions in Workflow Manager (using the ActionName and ControllName fields).
| • | Record Fields in AMS_CustomWorkflowLink Table |
| • | Using the LinkUrl Field to Specify Menu Item URLs |
| • | Using the ControllName and ActionName Fields to Specify Menu Item URLs |
Record Fields in AMS_CustomWorkflowLink Table
The following table lists the fields in the AMS_CustomWorkFlowLink table that need to added for each record.
|
Field |
Description |
||||||
|
linkId |
A unique identifier (GUID) that uniquely identifies the record in the table. |
||||||
|
CompanyID |
A foreign key from the AMS_Company table. Workflow Manager only shows menu items associated with the current user's company. |
||||||
|
LinkText |
The text that Workflow Manager will show on the Options menu. |
||||||
|
LinkUrl |
The URL to which Workflow Manager will navigate. This URL can be either of the following:
Note:Leave this field blank if you are using the ActionName and ControllName fields. |
||||||
|
LinkTarget |
The value for the target attribute on the link. Valid values include: _blank _self _parent _top |
||||||
|
LinkParameter |
Unused |
||||||
|
ActionName |
The MVC action name. Note:Leave this field blank if you are using the LinkUrl field. |
||||||
|
ControllName |
The MVC controller name. Note:Leave this field blank if you are using the LinkUrl field. |
The following table shows example records.
|
linkId |
CompanyID |
LinkText |
LinkUrl |
Link Target |
Link Parameter |
Action Name |
ControllName |
|
23383ff4-8d9f-48ac-b57e-8cfeff5640b9 |
879373fe-2322-43d1-8596-789aded5d6bb |
Notes to QA |
/ASReports/ApplicationReports |
_blank |
NULL |
NULL |
NULL |
|
625deb46-fa7e-429b-8378-bdf821a3f99a |
879373fe-2322-43d1-8596-789aded5d6bb |
Hardware Tracking |
/CustomWorkflow/HardwareTracking.aspx |
_blank |
NULL |
NULL |
NULL |
|
879373fe-2322-43d1-8596-789aded5d6bc |
879373fe-2322-43d1-8596-789aded5d6bb |
Copy this Request |
_self |
copy |
WFProgress |
Using the LinkUrl Field to Specify Menu Item URLs
When using the LinkUrl field, Workflow Manager adds several arguments to the URL. The following table describes the arguments.
|
Argument Name |
Value |
|
A |
The ApplicationID for the current request, represented as a string GUID, such as: ee278931-b80c-4c48-a6bf-ad39411dc9e1 |
|
cid |
The ProjectID (a.k.a. the ContractID) for the current request, represented as a string GUID, such as: 06d14575-fb0c-40e4-9d94-1a0129e08692 |
|
pid |
The PersonID for the currently logged-in user, represented as a string GUID, such as: ed7aa499-4b72-4617-934b-76ce8ae69b53 |
The resulting URL will be similar to this one:
http://MyServer:81/CustomWorkflow/HardwareTracking.aspx?A=ee278931-b80c-4c48-a6bf-ad39411dc9e1&cid06d14575-fb0c-40e4-9d94-1a0129e08692&pided7aa499-4b72-4617-934b-76ce8ae69b53
Using the ControllName and ActionName Fields to Specify Menu Item URLs
When using the ControllName and ActionName fields, Workflow Manager appends a different set of arguments to the final URL, as show in the
|
Argument Name |
Value |
|
a |
The ApplicationID for the current request, represented as a string GUID, such as: ee278931-b80c-4c48-a6bf-ad39411dc9e1 |
|
cid |
The ProjectID (such as the ContractID) for the current request, represented as a string GUID, such as: 06d14575-fb0c-40e4-9d94-1a0129e08692 |
|
pid |
The PersonID for the currently logged-in user, represented as a string GUID, such as: ed7aa499-4b72-4617-934b-76ce8ae69b53 |
The resulting MVC URL will be similar to this one:
http://MyServer:81/WFProgress/copy?a=ee278931-b80c-4c48-a6bf-ad39411dc9e1&cid=06d14575-fb0c-40e4-9d94-1a0129e08692&pid=ed7aa499-4b72-4617-934b-76ce8ae69b53