To create a new rule in Turnkey, begin by navigating to the Rules tab in the main menu. Here, you'll find an overview of all the existing rules and the option to create a new one.
Naming Your Rule
When you begin creating a rule in the system, the first step is to provide a descriptive name for your rule. This name should succinctly convey the purpose or function of the rule.
Selecting the Dataset
Next, you'll need to select the dataset on which you want to build your rule. The dataset serves as the foundation for the rule, providing the data that the rule will analyze and act upon.
Defining Exception Criteria
Once you've chosen the dataset, you'll encounter the Exception Criteria Builder. This tool allows you to define the conditions that identify exceptions for this rule. Think of it as setting up the "where" clause in traditional SQL, but with a more user-friendly interface. Here, you'll specify the criteria that, when met, will signal an exception. These criteria act as the primary building blocks of your rule.
Previewing and Adjusting
After configuring the Exception Criteria, you'll have the opportunity to preview the outcome. This allows you to ensure that the rule behaves as expected based on the defined criteria. If necessary, you can make adjustments before proceeding.
Saving Your Rule
Once you're satisfied with the rule setup, it's time to save your work.
Upon saving the rule, additional tabs become available, allowing for further customization:
Properties
In the Properties section, you define the fundamental attributes of your rule, shaping its behavior and defining ownership and responsibility. Here, you'll find options to:
- Description: Provide a clear and concise description of your rule, detailing its purpose and function for easy reference and understanding by collaborators.
- Action: Specify the action to be taken when the rule is triggered, outlining the steps or procedures to be followed in response to identified exceptions.
- Rule Owner: Assign ownership of the rule to a specific user, designating responsibility for its management and oversight.
- Exception Owner: Choose the individual responsible for addressing exceptions identified by the rule. Utilize exception owner mapping to assign exceptions to specific users based on criteria within your dataset, such as email addresses or employee IDs.
Column Settings
Within the Column Settings tab, you have the opportunity to tailor the handling of dataset columns to suit the requirements of your analysis. Here, you can:
- Override Default Settings: Customize the visibility and order of columns within the rule, providing flexibility in data processing without altering the default settings of the dataset. Note that changes made here only affect the presentation of columns within the context of the rule and can be reverted at any time using the revert button.
Notification Settings
Enable email notifications to stay informed about important rule-related events and exceptions. To begin, select Add Action. Ensure you give your email action an appropriate name, and then customize your notification settings according to your preferences, which include:
- Trigger Events: Specify when notifications should be triggered, such as upon the discovery of new, open, or closed exceptions.
- Email Content: Choose which types of exceptions should be included in email notifications, providing flexibility in managing notifications based on exception status.
- Email Format Customization: Customize the format and content of email notifications, including the email title, template, and CC recipients, to ensure clear and effective communication with relevant stakeholders.
- Email CC: Designate CC recipients by selecting from the list of users or by mapping users based on values in one of your dataset fields.
By leveraging these detailed customization options, you can create rules tailored to your specific data analysis needs, enabling efficient exception management and decision-making within your organization.
You have the flexibility to create multiple email actions, allowing you, for instance, to customize notification settings for each trigger event.
