Version: 20.05

Actions

The actions is used to whitelist user actions on the list and Details Screens. Actions are split into two sections. txnActions and jobActions.

txnActions are actions that are specific to their associated txn. They are Release, Claim, Assign, Unassign, Decision, View Form, Recover, Withdraw, and Custom

jobAction are actions that are on a job level. They will display in a panel at the top right of the details screen. They are Receipt and View Notes

There are eleven different available actions that come with their own display rules:

Options

Receipt

When clicked it opens up a modal with the current Txn formReceipt. If there is more than one receipt attached to the Txn, the modal will show a dropdown list to view each one.

Display rules

txn.job || txn.receiptUrl;

View Notes

When clicked it will show a list of all the 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

Claim

When clicked it 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);

Release

When clicked it unassigns the current Txn. This actions will be 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);

Assign

When clicked, it opens up a dropdown of usernames to pick from. Once a user is selected, the current Txn gets 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 user's email address. Make sure the email address are distinct for the user accounts in JM.

Unassign

When clicked it unassigns the current Txn. The difference with Release is that Unassign is available to all users.

Display rules

txn.taskType === "Review" &&
txn.availableActions.includes("unassign") &&
!["Completed", "Abandoned", "Expired", "Submitted"].includes(txn.formStatus);

Note

If both release and unassign actions are enabled and application for a transaction then release action will take precedence and unassign action will not be displayed

Decision

When clicked it opens up a modal with the current Txn formUrl + &pageId=decision.

Note

Please note we are sending a query param in the url &pageId=decision so that it can be used to support special handling on the Maestro form. We are also sending a message using a postMessage API with the following schema:

{
pageId: 'decision'
}

Display rules

This action will only show on the details screen, not the listing screen

!shortcut &&
txn.taskType === "Review" &&
txn.userLoginName === currentUser &&
!["Completed", "Abandoned", "Expired", "Submitted"].includes(txn.formStatus);

View Form

When clicked it opens up a modal with the current Txn formUrl + &pageId=view,

Note

Please note we are sending a query param in the url &pageId=view so that it can be used to support special handling on the Maestro form. We are also sending a message using a postMessage API with the following schema:

{
pageId: 'view'
}

Display rules

txn.taskType !== "Review" &&
!["Completed", "Abandoned", "Expired", "Submitted"].includes(txn.formStatus);

Recover

When clicked the abandoned txn will be re-opened.

Display rules

txn.taskType !== "Review" &&
txn.availableActions.includes("reopen") &&
txn.userLoginName === currentUser &&
txn.formStatus === 'Abandoned';

Withdraw

When clicked the saved txn will be abandoned.

Display rules

txn.taskType === "Review" &&
txn.userLoginName === currentUser &&
!["Completed", "Abandoned", "Expired", "Submitted"].includes(txn.formStatus);

Custom

When clicked, it opens up a dropdown of custom actions to pick from.

Display rules

This action will only show on the details screen, not the listing screen

!shortcut;

Example

The following example showcases some actions that can be configured for a manager.

Actions config

{
...
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 possible attributes please check the API Reference for txnActions and jobActions.