Expression Editor

BMC Helix Innovation Studio provides an Expression Editor in the View designer, Process designer, and Rule designer that you can use to configure the data required for views, processes, and rules of an application. For example, you can provide an expression to configure the data of input map properties of a Call Activity in a Process designer.

For information about Expression editor in the View designer, see Creating-or-modifying-view-definitions.

Expression Editor in Process designer and Rule designer consists of the following sections:

  • Expression builder, where you build the expression
  • Virtual keyboard
  • Context-based dictionary UI from where you can pick an expression of a process variable, a keyword, and an activity result.

Related topics

Defining-the-application-business-logic-through-processes

Adding-rules-to-validate-data-or-trigger-events-in-a-process

Data dictionary UI

The following table describes the nodes in the Data dictionary UI:

Dictionary node

Description

Expression

Process Variables

The process variables that you define in the process definition are available in the Expression Editor. This includes the process input parameters, output parameters, and local variables.

If a process variable is a record and has associations, the associations are available in the Expression Editor, which helps to  navigate to the associated records without using a query.

To use a dynamic variable in a string, you can simply type the $variable name in the string, and the variable's value is inserted in the string at runtime.

For example:

“Hi $user, your ticket is created. The id is $ticketId. You can view the ticket details at $ticketLink.”

When you use any field, variable, or keyword within a string expression, it will be evaluated to the value at runtime. If you want to use the variable name and not its value in the expression, then add an escape character (\) to the expression.

For example, "$\{processContext.processVariableName}"

${processContext.<variable id or name>}

${processContext.task._associations.<association definition GUID>.nodeA/nodeB...}

Activities

The results of all the activities that have outputs are available in the Expression Editor. The results of all the activities are captured in the process context, and you do not have to store an activity result by using the activity output mapping. You can use an expression to pass the activity result to other activities.

${activityResults.<activity GUID>.field}

General

The keywords such as Server URL, Current date, Current date and time, Current Groups, and so on are available in the Expression Editor.

$<keyword name>$

Errors

This node is available only if you have already defined an Error Boundary event earlier in the process. For more information, see Error Boundary event.

You can use an expression to access the exception class and error number (for Java exception error), or error message (for business error) caught by the Error Boundary event.

${errors.<errorBoundaryEventGUID>.errorMessageOrClass}

Email Receive Event Fields

This node is available only when you are using the Email Receive Event in a rule. For more information, see Email Receive Event.

The incoming mailbox attributes, such as mailbox name, email sent to, plain text body, and so on, are available in the Expression Editor.

"${ruleContext.mailSentTo} = \"helpdesk@calbro.com\" AND ( ${ruleContext.priority} = \"1\" OR ${ruleContext.priority} = \"2\" OR ${ruleContext.priority} =\"3\") AND ${ruleContext.plainTextBody} LIKE \"%sometextfrommailbody%"

Expression Editor examples

The following table illustrates Expression Editor examples:

Configuration using Expression Editor

Example

In Process designers and Rule designers, you can use regular expressions in a Qualification (condition).

In Rule Designers, you can configure expressions in Rule Qualification.
For example, the expression 'Created By' LIKE "%Mi%Jo%" matches with Michael Jordan, Mike Johnson, Micth Joe and so on.

In Process designers, you can use expressions in the following components:

  • Get Records By Query action
  • In the condition for Exclusive gateway
  • User Task Completion condition

In the Process designers, expressions can be used only with the LIKE operator.

The following characters are allowed in the expression:

  • %: Matches any string.
  • _ (Underscore): Matches any single character. For example, the expression 'Created By' LIKE "M_n" matches Man, Men.
  • []: Matches any given char. For example, 'Flag' LIKE [a-p] matches any char in a given range a to p.

22_1_expression_editor.jpg

Configure an expression by using individual attributes from a JSON schema.

22_1_Example of REST API attributes.png

Configure an expression by selecting the fields from the associated records.

Important: Only fields from one to one and one to many associations are supported.

22_1_Edit expression for recipients.png

Configure an expression by using fields in the configured incoming mailbox.338px

22_1_Email attributes in an expression editor.png

Configure condition using an activity result.

22_1_Configure condition using activity result.png

Configure the expression by using error details caught by the Error Boundary event.

22_1_Configure expression_error boundary event.png

Configure a condition to check if the security label for a record instance is updated.

When using SECURITYLABELCHNG() function in a process, add a record instance as a parameter. When using the SECURITYLABELCHNG()function in a rule, you do not need any parameter.

Important: In Rule designer, the SECURITYLABELCHNG() function is supported only with the Record Event trigger type. If you use the SECURITYLABELCHNG()function with the Timer Event or System Event trigger type, an error is generated while saving the rule.

For more information about configuring a condition to identify the changes in the security label, see Identifying updates to the security label.

Using Process:

22_1_Securitylblchng for process.png

Using Rule:

22_1_Securitylblchng for rule.png

Configure a selection field.

22_1_Configure selection field.png

Server URL in user message.

22_1_Expression for server URL.png

Configure Start Process expression in a rule.

22_1_Process start expression.png

Symbols used in Expression Editor.

22_1_Expression editor symbols.png

Set conditions to hide menu, menu items, and action components by using CCS parameters

Configure the condition to hide the menu, menu items, and action components with the Hidden field based on the following CCS parameters:

  • com.bmc.arsys.smartit:*:enableESChatIntegration
  • com.bmc.arsys.smartit:*:es_chat.url
  • com.bmc.arsys.smartit:*:helixdashboard.url
  • com.bmc.arsys.smartit:*:disabledSmartITApplications
  • com.bmc.arsys.smartit:*:reportingServerURL
  • com.bmc.arsys.smartit:*:enableAssetCreator

Use the GET() function under Object node to use the CCS parameters. 

For more information about the CCS parameters, see Centralized configuration. 

image-2024-11-4_15-32-34.png

 Configure navigation menu bar items to open external web page URLs that include the following user properties as query parameters.

  • Email address
  • Login name
  • Person ID
  • User ID
  • Company 
  • Department 
  • First name 
  • Full name
  • Is support staff
  • Last name 
  • Organization 
  • Phone 
  • Site 
  • Support group names 
  • Support group IDs


User attributes in Expression editor.png


 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*