RapidIdentity Product Guide: New UI

Action Set Builder

The Action Set Builder is a canvas to choose specific actions from the Actions to build Action Sets. There are two views: Basic view and Advanced view. Regardless of the view chosen, ensure the finished Action Set is named following the RapidIdentity Connect Standards.

Action Set Builder - Basic View
Connect_Action_Set_Builder_Basic.png

The Basic view provides a graphical view of the logic being built into the Action Set. Start and End are placed by default; in order to add an action, click on the line where the action should appear. The two choices provided are to Add Section (Connect_Add_Section.png) and Add Action (Connect_Add_Action.png).

Connect_Add_Something.png
Action Set Builder - Advanced View

The Advanced view provides a code-based view, allowing users to enter Action Sets manually.

Connect_Action_Set_Builder_Advanced.png

Actions are entered by clicking the line that appears when you hover at the bottom of the code area or between two lines of code. This will prompt the Add Action sidebar.

Advanced_View_-_Line_Below.png
Advanced_View_-_Line_Between.png

Add an Action in Advanced View

To prompt the Add Section sidebar, type 1 or search for section in the Search for action bar. Other hotkeys are shown at the top of the workspace for ease of use in this view.

Action Sets - Keyboard Shortcuts

When the Action Set Builder is in Advanced view, you can quickly find and insert any action using just the keyboard by just starting to type the name of the action, which will automatically place you in the Filter Actions... field and show you a list of actions matching what you've started typing. Once the desired action is selected in the list, pressing the Enter key will cause that action to be inserted at the current location in the Action Editor, and an additional press of Enter will start editing the first property of the action.

Additionally, for some of the most common actions, there are shortcut keys that can be pressed to automatically insert the action and, where appropriate, start editing the properties, all with a single keystroke. These numbers are shown on the top of the screen next to the Search bar.

Keyboard_Shortcuts_-_Advanced.png

Note

Other keyboard shortcuts that can be used here are + (or the Insert key) to perform the Insert action, or ^ to perform the Insert before action.

Add Section

Clicking Add Section prompts a right sidebar to configure the section's label and suppressTrace settings.

Note

Click Escape.png to add quotation marks and slashes that will escape a string; click Unescape.png to unescape a string.

Connect_Add_Section_Sidebar.png
Table 304. Connect - Add Section Fields

Field

Description

Supported Types

Label

Give the section a name.

Expression and Variable. Variable allows you to insert the name of an already-defined variable.

suppressTrace

Suppress detailed tracing of the actions in the section.

Boolean, Expression, and Variable. Each type requires a value to be defined.



Add Action

Clicking Add Action prompts a right sidebar to choose the action to be included in that step. Actions are divided into two categories: Core Actions and User Defined Actions. User Defined Actions will be visible once custom Action Sets are saved to a project. Navigate through the folder categories to find the desired action, or use the Search for action bar at the top of the menu.

Connect_Add_Action_Sidebar.png

Each action has a different set of fields, but the functional commonalities are as follows:

Table 305. Add Action Fields

Field Item

Description

Red Asterisk (Red_Asterisk.png)

Used next to a field title to denote that the value is required

Escape (quote) value (Escape.png)

Click this to add characters into the field that will escape the string

Unescape (unquote) value (Unescape.png)

Click this to remove characters from the field

Dropdown List (Dropdown_List.png)

Clicking this will expand a dropdown list of values that can be used in this field

Edit Value (Manual_Edit.png)

Usually used in conjunction with Dropdown List or Password, clicking this icon will replace the current input field with a code editor. This is to support values for the particular field being either inline code expressions or variable names from elsewhere in the context

View Characters (Show_Password.png)

Usually used in conjunction with Password, clicking this icon will show the characters entered for a password instead of obscuring it with asterisks



Detailed Tracing

The Detailed Tracing option is presented whenever an Action Set is run, either manually from the open Action Set itself or from the project's Action Set screen. A confirmation window will display with this option at the top.

Enable_Detailed_Tracing.png

Selecting Enable Detailed Tracing is useful to help "debug" Action Sets that do not run properly. One example of a detailed trace with one error is shown below.

Legacy_Detailed_Tracing_1.png

In this Action Set, the variable sample was defined; however the log action was configured to execute the samples variable. Thus, the log action needs to be configured to execute sample to run properly. When fixed, the Action Set runs properly.

Legacy_Detailed_Tracing_2.png

Detailed trace allows you to see a log of each action and the value (if any) that it returns. With detailed trace turned off, you will only see errors, warnings, and the output of any explicit log() actions within the Action Set.

The detailed trace is particularly useful for more complicated Action Sets involving the manipulation of records and record fields. The detailed trace displays records and JavaScript objects as formatted JSON to enhance readability. XML objects, date objects, and most Java objects embedded inside the record or JavaScript object display as a string value. Strings display as a string literal, including necessary quotes and escaping.