Actions
The actions
attribute is used to whitelist user actions on the List and Details screens.
There are two types of action:
jobAction
: Actions that are on a job level. These actions appear in a panel at the top right of the Details screen. Supported actions:Receipt
,View Notes
.txnAction
: Actions specific to their associated Txn. Supported actions:Assign
,Claim
,Decision
,Recover
,Release
,Unassign
,View Form
,Withdraw
,Custom
.
Each of these actions has their own display rules as described below.
Job Actions
Receipt
The Receipt action opens a modal displaying the current Txn formReceipt. If there is more than one receipt attached to the Txn, the modal includes a dropdown list allowing the user to select a receipt to view.
Display rules
txn.job || txn.receiptUrl;
View Notes
This action displays the list of available notes/comments associated with a job in a modal. If the Txn is not associated with a job, any notes/comments will be shown for that Txn.
Display rules
txn.comments;
Txn Actions
Assign
This action opens a dropdown list of usernames to pick from. When a user is selected, the current Txn is assigned to that user.
Display rules
txn.taskType === 'Review' &&
txn.userLoginName === '' &&
txn.availableActions.includes('assign') &&
!['Completed', 'Abandoned', 'Expired', 'Submitted'].includes(txn.formStatus);
note
Task assignment happens in Workspaces based on a user's email address. Make sure all JM user accounts have distinct email addresses.
Claim
This action assigns the current Txn to the current user.
Display rules
txn.taskType === 'Review' &&
txn.userLoginName === '' &&
txn.availableActions.includes('assign') &&
txn.userLoginName === currentUser &&
!['Completed', 'Abandoned', 'Expired', 'Submitted'].includes(txn.formStatus);
Decision
This action opens a modal with the current Txn formUrl and &pageId=decision
.
info
We send the query parameter &pageId=decision
in the URL so that it can be used to support special handling on the Maestro form. We also send a message using a postMessage API with the following schema:
{
pageId: 'decision';
}
Display rules
This action is available on the Details screen only, not on the List screen.
!shortcut &&
txn.taskType === 'Review' &&
txn.userLoginName === currentUser &&
!['Completed', 'Abandoned', 'Expired', 'Submitted'].includes(txn.formStatus);
Recover
The Recover action re-opens an abandoned Txn.
Display rules
txn.taskType !== 'Review' &&
txn.availableActions.includes('reopen') &&
txn.userLoginName === currentUser &&
txn.formStatus === 'Abandoned';
Release
This action unassigns the current Txn; that is, it removes the Txn's assignee. This action is available only if the current user is the assignee.
Display rules
txn.taskType === 'Review' &&
txn.availableActions.includes('unassign') &&
txn.userLoginName === currentUser &&
!['Completed', 'Abandoned', 'Expired', 'Submitted'].includes(txn.formStatus);
Unassign
This action unassigns the current Txn; that is, it removes the Txn's assignee. Unassign
differs from Release
in that you can unassign another user, and that it is made available only to users with management oversight.
Display rules
txn.taskType === 'Review' &&
txn.availableActions.includes('unassign') &&
!['Completed', 'Abandoned', 'Expired', 'Submitted'].includes(txn.formStatus);
info
If both the Release
and Unassign
actions are enabled for a Txn then Release
takes precedence and Unassign
is not displayed.
View Form
This action opens a modal with the current Txn formUrl and &pageId=view
.
info
We send the query parameter &pageId=view
in the URL so that it can be used to support special handling on the Maestro form. We also send a message using a postMessage API with the following schema:
{
pageId: 'view';
}
Display rules
txn.taskType !== 'Review' &&
!['Completed', 'Abandoned', 'Expired', 'Submitted'].includes(txn.formStatus);
Withdraw
The Withdraw action is used to abandon a saved Txn.
Display rules
txn.taskType === 'Review' &&
txn.userLoginName === currentUser &&
!['Completed', 'Abandoned', 'Expired', 'Submitted'].includes(txn.formStatus);
Custom
This opens a dropdown list of custom actions.
Display rules
Custom actions are available on the Details screen only, not on the List screen.
!shortcut;
Example
The following example showcases some actions that can be configured for a manager.
{
...
txnActions: {
Claim: {
label: 'Claim',
},
Release: {
label: 'Release',
},
Decision: {
label: 'Decision',
},
Recover: {
label: 'Recover',
},
Custom: {
label: 'More',
properties: [
{
label: 'Re-run background check',
dataIndex: 'formUrl',
type: 'url',
},
],
},
},
jobActions: {
Receipt: {
label: 'Receipt',
permissions: {
type: 'group',
value: ['Manual Review'],
}
},
ViewNotes: {
label: 'View Notes',
},
},
...
}
Attributes
To review the list of supported attributes, see CurrentSpaceTxnActions and CurrentSpaceJobActions.