This page covers the following sections:
- What is a Ruleset?
- Data source settings
- Ruleset operations
- Options with individual rules
- Ruleset Templates
What is a Ruleset?
Each transformation applied on the dataset is stored in DataPrep as a rule, in order of their execution. The ordered list of these rules is called a Ruleset. You can access the Ruleset from the Ruleset pane, where you can add, edit, preview or remove rules that have been applied.
To access the Ruleset:
1. Click the Ruleset icon in the top-right corner of the Operations page to view the Ruleset pane.
2. The Ruleset pane will slide open into view. You can see the data source of your dataset added by default to the top of your Ruleset.
3. If you select a rule before the latest (last) one in your Ruleset, the data grid is updated to reflect the state of the sample at that time. You can edit this transformation applied in the rule using the Operations panel.
4. When you are in a previous state of the sample, all subsequent rules will be greyed out in the Ruleset pane.
5. If you apply for a new transformation in a previous state, the new rule will be added after the current selection.
6. At this point, all rules after the new rule will be recomputed for transformation and if this causes any errors in the subsequent rules, they will be highlighted in red.
7. For example, if you delete the column "first_name" in the new rule when the column is being used in the following rule, it cannot be executed and will be highlighted in red so you can address the issue.
Data source details
To access the data source details:
1. Click the Ruleset icon <stack icon> to view the Ruleset pane.
2. The Ruleset pane will slide open into view. You can see the data source of your dataset added by default at the top of your Ruleset.
3. Click on the settings icon <settings icon> in the data source tile to open the Data source details pane.
4. This will have the necessary details on the source of the input data which includes source type, connection details, timestamps of last import and next import, parsing details, and if the import is scheduled.
5. You can edit the data source, and connection from here, depending on the type of data source.
6. You can pause, delete, or edit your import Schedule.
7. You can click on the expand button next to the View file parsing details option to view and edit file parsing details.
8. This will show parsing details which include file encoding, delimiter, text qualifier, etc.
9. File encoding dropdown lists all different encoding mechanisms from the table below.
10. The Delimiter dropdown lists separator values such as comma (,), tab, semicolon (;), space, and pipe(|).
11. Text qualifier lets you qualify data with text data type only if they are enclosed within single or double quotes.
12. When you select the Data contains header option, you can enter which row number should be set as the header in the Row as header field.
The data from the selected row number replaces the column names of their corresponding column.
Using the Ruleset operations, you can import, search and save a ruleset or view a ruleset's edit history.
Let's look at each of these options:
- Save as
- Ruleset history
The Save as option is used to save the Ruleset as a template.
Click the three dots icon to open the menu and choose Save as. Give a name to the template (e.g. "Marketing data rules") and click Save.
Using the import option, you can import rules from another saved ruleset template. Select a Ruleset template from any existing workspace in Zoho DataPrep.
Rules from this template will be added to your current Ruleset.
You can also select the From file option (coming soon) and upload the ruleset template as a file.
Note: To learn more on templates, go to the Ruleset template section.
Click Ruleset history from the three dots icon to view the changes in the Ruleset's timeline.
The history of the Ruleset includes user information such as, who created or modified the rules, the timestamp when the changes were made, and the various operations added to the Ruleset.
Choose Search from the three dots icon to perform a search in your Ruleset. For example, you can search the column name to find all the rules applied in that column.
Actions on individual rules
You can modify individual rules using the actions associated with them. Click the three dots icon menu on the rules to Edit, Disable, or Remove the rule. You can also use the Insert rule before option to insert a rule prior to your current selection. The option Show info is used to retrieve the rule information.
Click Edit when you want to edit the transformation applied with the rule. You can make changes to the transformation in the Operations bar and verify the output in the preview. Click Apply to save your changes. The transformation will be recomputed to reflect the changes.
Click Remove when you want to delete a rule from the Ruleset. This will remove the rule and recompute transformations on data for the rules left.
Tip: You can always undo delete in case you deleted a rule accidentally. The Undo button <undo button> is situated at the top-left portion just above the data grid.
Use this option to disable a rule in your Ruleset. This will disable the rule and recompute transformations on data for the remaining rules. You can Enable the rule again from the three vertical dots menu.
Insert rule before
Use the Insert rule before option to include a previous step before a rule. When you click, you will see an empty placeholder. Once you apply a transformation, the rule of this transformation will be stored in the placeholder.
Click the Show info option for information about a specific rule such as who created or modified the rules. It also includes other details such as, when the rule was created or modified, and the list of users who made the changes.
Note: You can also use the Ruleset history option for more information on all the rules in the Ruleset.
Ruleset templates are the Rulesets from various datasets saved for reuse.
To and save Rulesets as templates:
1. Open your dataset and click the Ruleset icon (stack icon present in the top-right corner) to view the Ruleset pane.
2. Click the three dots icon and choose Save as. Give a name to the template (e.g. "Marketing data rules") and click Save.
To view all the Ruleset templates available in your workspace:
1. Select the Ruleset Templates tab from your Workspace's home page.
2. The Ruleset templates available for the workspace will be shown in the order of Last modified templates.
4. You can click on a Ruleset template to view the list of rules. It also shows the user who created the template and when it was created.
5. You can also perform Share template using the share button in the Ruleset template.
6. You can share it with Individual users or with multiple users in Groups along with an invitation mail.
7. You can also share or delete multiple rulesets using the checkboxes.