Enable UI Actions
-
- UpdatedJan 30, 2025
- 2 minutes to read
- Yokohama
- Security Incident Response setup
Before you configure any UI Actions, you must perform certain steps to enable them so that they are available for configuration in the Security Analyst Workspace.
Note: To modify the UI actions, log in as a user with the following roles:
- ui_action_admin
- ui_page_admin
- web_service_admin
There are two types of UI actions that can be configured for the Security Analyst Workspace:
- Dialog Based UI Action
- Server-side UI Action
Dialog Based UI Action
To enable dialog-based UI actions in the Security Analyst Workspace, make the following changes to the UI pages associated with the respective standard UI Actions.
- HTML section: Modify the HTML section to include the
react input tag. The react input tag value is used
in the client script section to identify if the UI Page has been launched from the Security Analyst Workspace. An example is shown below:
<input id="react" name="react" type="hidden" value="${JS,HTML:sysparm_react}" />
- Client script: Additional logic needs to be written in the client
script when the react flag is true. This is needed to handle the
Submit and Cancel button events shown as
part of the dialog window.
- onCancel () event handler needs to dispatch the ‘SIR_WORKBENCH_POPUP_CANCEL’ event from the Security Analyst Workspace
- onSubmit () event handler needs to dispatch the ‘SIR_WORKBENCH_POPUP_SUBMIT’ event from the Security Analyst Workspace
- The execution of the processing script is skipped from the Security Analyst Workspace context as the ‘onSubmit’ action has been modified to return false when the react input tag value is true. The logic of the processing script needs to be handled either via a client callable script (invoked via GlideAjax API) or REST resource endpoint.
Refer the following sample UI pages for more details:
- Related List UI action example: Publish to watchlist (UI page name: publish_to_watchlist)
- Form UI action example: Create Problem (UI page name: create_prb_change_inc)
Server side UI Action
To enable server side UI actions, you must do the following:
The logic of the standard UI action script must be handled as part of a scripted REST resource.
Refer to the following sample Form UI actions for more details:
- Create Outage
- Cancel