Skip to main content

Version: 19.11 (EOL)

Actions

The actions config is used to whitelist user actions on List screens and Details screens. The following actions are supported, each with its own display rules.

Supported actions​

Assign​

The Assign 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 the user's email address. Make sure email addresses are distinct for all JM user accounts.

Claim​

The Claim 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​

The Decision action opens a modal using the current Txn formUrl with the query parameter &pageId=decision appended. This query parameter is sent in the URL to support special handling on the Maestro form.

Messages are sent using a postMessage API with the following schema:

{
  pageId: 'decision'
}

Display rules​

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

Receipt​

The Receipt action opens a modal with the current Txn formReceipt. If more than one receipt is attached to the Txn, the modal shows a dropdown list from which the user can select a receipt to view.

Display rules​

txn.job || txn.receiptUrl;

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​

The Release action unassigns the current Txn. This action is the same as the Unassign action except it 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​

The Unassign action unassigns the current Txn. This action is available to all users, unlike the Release action which is available only if the current user is the assignee.

Display rules​

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

View Form​

The View Form action opens a modal using the current Txn formUrl with the query parameter &pageId=view appended. This query parameter is sent in the URL to support special handling on the Maestro form.

Messages are sent 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 abandons a saved txn.

Display rules​

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

Custom actions​

Custom actions are accessed from a custom action button with the label More by default. Click the button to open a dropdown of custom actions to select from.

Display rules​

!shortcut;

Attributes​

The list of supported configuration attributes are available in Reference > CurrentSpaceActions.

Example​

The following example shows some actions that can be configured for a manager (user type).

{
  "actions": {
    "Receipt": {
      "label": "Receipt",
      "permissions": {
        "type": "group",
        "value": ["Manual Review"]
      }
    },
    "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"
        }
      ]
    }
  }
}