An expression rule is a stored expression that can be called from other expressions. Within your expression rules, you can add rule inputs so you can dynamically change the data returned by your expression.
This page explains how to create, edit, and delete expression rules.
For more information on expression rules, see:
Each expression rule has the following properties:
|Name||The name that is used when executing the rule. This property is case-insensitive, but we recommend that you follow the naming standard.|
|Description||Supplemental information about the rule that is displayed in the expression editor and in the objects grid of some Designer views.|
|Save In||The folder that the rule is saved into.|
|Rule Inputs||Rule inputs are used to pass data into the expression rule.
|Test Cases||A set of test scenarios used to evaluate the expression rule.|
|Rule Definition||The expression that is evaluated when the rule is called.|
The following names are reserved for process report metrics, and must not be used.
To create an expression rule:
In the Create Expression Rule dialog, configure the expression rule properties.
The expression rule opens in a new dialog or window, where you can:
Rule inputs allow you to dynamically pass values into your expression.
For example, if you want to return information about a single customer, you could create an expression rule that queries the Customer record type, and use a rule input to filter the query so it only returns data for a specific customer ID.
To create a rule input:
In the expression rule, click New Rule Input.
If you don't see this option, expand the right-hand pane of the expression rule.
Configure the following properties for your rule input:
|Name||The name of the rule input. This is the name you'll reference in the expression.|
|Description||A short description of the rule input.|
|Type||The data type of the rule input.|
|Array||Whether the rule input should accept an array of values or a single value.|
To reference your rule inputs in an expression, use the ri! domain followed by the rule input name.
As naming conventions and requirements evolve, you may need to update the names of your inputs to certain objects. Over time, rules and interfaces can gather many dependents. This can make manual changes to update any keyword references to rules and interfaces difficult and prone to human error.
If you update the name of an input while editing an expression rule or interface, Appian will update any keyword references to that rule input in dependent objects.
There are certain cases when Appian cannot update the dependent object(s):
If there is a blue banner in the rule inputs pane, Appian is going to attempt an automatic update of the keyword references.
After you save your changes, a dialog will appear with a summary of what dependent objects were updated and any that you may need to update manually.
If you accidentally exit the rename dialog before you've completed all manual updates, use design guidance to find the remaining objects to update. Any object using the wrong keyword reference will be flagged with the invalid keyword syntax design guidance on the health dashboard.
All objects that are updated automatically as a result of the rename will show the developer who renamed the input as the last modifier for the dependent objects.
To define your expression rule:
For example, the following expression rule uses an
a!queryRecordType() expression to return all critical cases for a specific customer.
Test the expression rule. If you have rule inputs configured, you can add test inputs to test the values returned by your expression.
Click SAVE CHANGES.
Testing your expression rule allows you to see what the expression rule outputs based on a given set of inputs.
See Expression Rule Testing for more information.
By default, the Ad Hoc Test view displays whenever you open an expression rule.
The Ad Hoc Test view allows you to quickly test your expression by providing sample values or expressions for your rule inputs.
This view is made up of three sections:
|Call out letter||Name||Description|
|A||Test Inputs||Enter test values for the rule inputs configured on the expression. You can use an expression, or provide a static value.
|B||Local Variables||If you use local variables in your expression, the values of your local variables will be displayed in this section.|
|C||Test Output||The results of your expression rule, and any test inputs configured. You can view your test outputs as a formatted map, a raw list, or as an expression.|
Test cases view can be created and saved with an expression rule. This allows you to run test scenarios in bulk and review the results for all the tests together.
The Test Cases view displays all test cases. From this view, you can also:
To create a test case:
|Test Inputs||Enter test values for the rule inputs configured on the expression. You can use an expression, or provide a literal value. All expression or literal text values have a 4,000 character limit. Additionally, the developer must have access to all selected users, groups, documents, or folders to create a test case.|
|Assertion||Determines whether a test case passes or fails. You can choose any of the following assertions. See Assertion examples and recommendations for more information.
|Test Output||The results of your expression rule, and any test inputs configured. You can view your test outputs as a formatted map, a raw list, or as an expression.|
You can save your sample rule input values for later use by saving them as a test case.
To save your ad hoc test values as a test case:
In the Create Test Case dialog, configure and review the following properties:
|Name||The name of the test case.|
|Test Inputs||The values provided in the ad hoc test. Update any of the test values as needed.|
|Assertion||The criteria that determines whether the test case passed or failed.|
|Test Output||The status of the test case, and the values returned from the expression.|
To use a test case in the Ad Hoc Test view, select a test case and click LOAD TEST CASE.
The following examples demonstrate how to use test case assertions to validate that your expression rules are returning the expected results for a variety of scenarios.
Example 1: Expression rules commonly validate that a value is what is expected in a process or interface. Below is an example of test cases for a rule that checks if an email address is valid.
|Test Case Name||Rule Input||Assertion|
|Valid email firstname.lastname@example.org||Output: true|
|Invalid email address - missing @||karen.jonesexample.com||Output: false|
|Invalid email address - missing domain||karen.jones@||Output: true|
|Null is an invalid email address||null||Output: false|
|List of email addresses still outputs a scalar boolean||
Example 2: Another common scenario for expression rules is to manipulate a complex data type or Appian object input which could result in varied outputs. Examples of useful assertion expressions in these scenarios are below.
|The output is not null||
|Specific field in CDT equals some value||
|List contains certain value(s)||
|Has # items in list||
|The output is no longer than a max length limited by a Smart Service||
It is not necessary to have an exhaustive list of all possible permutations for your test cases.
and()function to group assertions together when making an assertion expression since this will make debugging the rule's failed tests more difficult. Duplicate test cases and update their assertion expressions when you want to assert multiple things about the same output.
Once you create your test cases, you can run a single test case or all test cases to see if they pass or fail.
Test results are not persisted with the expression rule on save, so tests must be run each time the rule is opened to view the results.
In addition to running test cases for an individual expression rule, tests for multiple rules can be run in bulk to test an entire application or system at once. See the Automated Testing for Expression Rules page for more details.
To run a single test case:
To run all test cases:
The results of these tests are displayed in the Test Cases grid, which includes the evaluated output of the rule for each test case and the test's status.
A test case can have one of the following resulting statuses:
Test cases are always exported with the expression rule, but can only imported if the destination environment has the Allow Test Values to Be Imported with Design Objects setting enabled.
For more about this configuration, see the Deployment section of the Admin Console.
To edit an expression rule:
Each time you modify and save an expression rule, a new version is created. All expressions that use the rule use the latest version. All versions are accessible to developers who can view the rule, and a rule can be reverted back to a previous version at any time.
For information on how to manage object versions, see Managing Object Versions.
While editing your expression rules, you may encounter guidance. Appian design guidance reinforces best practice design patterns that should be implemented in your objects. Design guidance for expression rules is calculated while editing the rule or when a precedent of the rule is updated.
When a recommendation or warning is triggered, you'll see an indicator icon in the header (A) and next to the corresponding line in the expression editor (B).
Click on the icon in the header to learn more about the suggested guidance (C) and how it can be addressed.
If a recommendation is not applicable to your use case, you can Dismiss (D) that individual recommendation for that rule. Learn more about recommendation dismissal. Warnings cannot be dismissed and should always be addressed to avoid complications when the logic in the object is executed.
Expression rule guidance is also visible outside of rules on the Health Dashboard.
Users with Administrator permission to this object or rule folder can move it to another folder:
Use the folder picker or browser to select the new parent folder.
You can also create a new folder in the browser, if you have Editor permissions to its parent folder.
Any objects that are configured to inherit the security of the parent folder assume the security rights of the target folder.
Developers with Viewer permissions to this object can duplicate it. There are two ways to duplicate an object:
Once you select the Duplicate option, you will see the following dialog:
You can only duplicate the most recent version of an object. If you have unsaved changes and attempt to duplicate the object from within the designer, the most recent saved version of the object will be duplicated without the unsaved changes. A banner appears when there are unsaved changes to remind you before duplicating.
Deleting an expression rule prevents users from further viewing or editing it. However, the last version of the rule is still available to be used in processes, record views, and reports.
Rules can be deleted by users with Administrator permissions to it. Appian does not recommend deleting rules that are in use because the rule can no longer be exported.
To delete an expression rule:
In the Delete Expression Rule? dialog, ensure there are no objects that depend on the expression rule.
If there are objects that depend on the expression rule, then deleting the expression rule will cause an error to appear in those objects.
System administrators have the ability to delete expression rules (and other objects) in bulk by selecting them and clicking Delete in the toolbar.
Expression rules are called using the
rule! domain. When calling a rule, values or variables can be passed to the rule inputs by position or by keyword, as shown below.
Any user can invoke any expression rule that is used by an interface or process they can access.
The security role map of an expression rule controls which developers can see or modify it and its properties.
By default, expression rules inherit the security of the folder that they are saved in. However, after creating the expression rule, you can disable that inheritance and modify the rule's security.
See Editing Object Security to modify an expression rule's security.
The following table outlines the actions that can be completed for each permission level in an expression rule's security role map:
|Evaluate the rule||Yes||Yes||Yes||Yes|
|View the rule definition||Yes||Yes||Yes||No|
|Duplicate the rule||Yes||Yes||Yes||No|
|View and run test cases||Yes||Yes||Yes||No|
|Update the rule definition||Yes||Yes||No||No|
|Create, update, and delete test cases||Yes||Yes||No||No|
|View the security||Yes||Yes||No||No|
|Rename the rule||Yes||Yes||No||No|
|Delete the rule||Yes||No||No||No|
|Update the security||Yes||No||No||No|