Configure actions

  • Release version: Washingtondc
  • Updated February 1, 2024
  • 2 minutes to read
  • Using the action framework, configure actions and associate a set of actions as action groups for use in the different contexts.

    Before you begin

    Role required: sp_admin or sn_hr_sp.esc_admin

    About this task

    Action items provide quick access to actions that you perform in various contexts. You can modify the actions to suit your business needs. For example, you can use the default approve or reject actions to process the requests directly from the approvals page.

    Procedure

    1. Navigate to All > Employee Center > Action framework > Actions.
    2. Click New or edit an existing record.
    3. On the form, fill in the fields.
      Table 1. Actions form
      Field Description
      Action label Name of the action label that appears on the button.
      Action type Select the action type from the available list.
      Active Check the box to activate the action
      Action icon Icon of the action.
      Table Name of the table to which the action is associated. When a record from this table is open, this list action appears. For approvals, select sysapproval_approver.
    4. Click Save or Update.
    5. On the Action parameters related list, click New or edit an existing record.
    6. On the form, fill in the fields.
      Table 2. Action parameters form
      Field Description
      Action parameter name Name of the action parameter.
      Parameter type Select the parameter type from the available list such as JSON, string, or reference.
      Is client parameter Check the box to use the parameters in the client script.
      Is display value Check the box to display the value. By default, the value in sn_ex_sp_action_parameter is set to false and is only visible in form if the parameter type is reference.
      • When true, you get the display value of the field.
      • When false, you get the actual db value of the field.
      Action parameter value This option appears only when you select string. Parameter value in a string, for example approved
      Table Reference table to which this component is tied to. When a record from this table is open, this list action appears. For approvals, select sysapproval_approver. This option appears only when you select Reference.
      Field Field from the table that you can select from the element tree such as Sys ID. This option appears only when you select Reference.
      JSON parameter JSON string you want to specify. For example, {"param": "value"}. This option appears only when you select JSON.
      In the OOTB actions,
      • The isEsignatureEnabled value is true by default, the esignature approval authentication window appears.
      • The broadcastEventName value broadcasts an event passed in the parameter to hide the buttons when esignature is successful to enable comments before the esignature scenario.
      Note:
      For custom actions, you can customize these two parameters.
    7. Select Save or Update.

    Result

    Action is configured. You can combine a set of related action items as a group.