Skip to content
Matt Krins edited this page May 22, 2024 · 18 revisions

About

Rules iterate over the data provided by connectors.
Each row/object/etc is will be evaluated to establish if it should run an action/s.

Settings

Primary Data Source & Primary Key

Select the connector which each set of conditions will evaluate and perform actions for.
The primary key is used to uniquely identify each row/object. For example, you may want to select the users connector and the username column as the primary key.

Secondary Data Sources

If you want to perform actions on another connector, or add additional data to each row/object, then you can add an additional connector here.
For example, if you have multiple CSV files for your user data, you could add each and the use column data from each one, so long as they each have a column which can be used to join it to the primary key. This is similar to an SQL table join. Example:

image

Additionally, each secondary connector can be individually configured:
image
Some types of connectors will have additional options available to configure on this screen.

Entry Display Name

Not required, but can be helpful identify each row/object in the interface. Defaults to the primary key.

Enabled/Disabled

Enables rule to be run via schedule.
Before you enable/automate a rule, ensure you have thoroughly tested it manually using the run button on the rules page.

Logging

  • Disabled: No detailed logging will be performed for this rule.
  • Enabled: A detailed log will be kept for this rule, accessible via the Log Browser tab.

Conditions

All conditions will be evaluated and must be true for actions to be executed.
For example, to run a rule on a specific group of users in your CSV, you may add the following condition:

image image image

There are various conditions/constraints which can be applied:
image
Some conditions are only available to specific connectors. For example, security groups for LDAP users.

Actions

Once all rule conditions are met, you can perform a one or many actions when:

  • The rule initially runs: Run once
  • For each row/object: Run iteratively for each row/object that met the conditions of the rule
  • The rule is about to finish: Run once

image

Actions can move files, copy folders, print templated PDF documents, etc.
For actions which run each row/object you can use the templating system to construct dynamic strings.
You can also use the 'build data template' action to perform advanced data alterations before running actions further down the queue.

image

Some actions are only available to specific connectors. For example, creating users in LDAP directories.

Once you have created a rule, you may want to consider automating it via a run schedule.