Create rules

On this page

1. Create rule
2. Re-process entity
3. Change rule
   1. Inactivate rule
   2. Delete rule
4. Actions
5. Results
6. Next steps

Rule Builder allows you to create rules for cleaning, transforming, normalizing, and modifying the data.

In this article, you will learn how to create rules in CluedIn using the Rule Builder tool.

You can create a rule either before or after processing the data.

Create rule

Creating a rule involves configuring a filter and defining the rule action.

To create a rule

1. On the navigation pane, go to Management > Rule Builder.

2. Select Create Rule.

3. Enter the name of the rule. Then, in the lower-right corner, select Create.

   The rule details page opens.

4. In the Filters section, select Add First Filter, and then specify to which items the rule will be applied:

   1. Select the type of property (Property or Vocabulary).

   2. Depending on the type of property that you selected, do one of the following:

      For Property, find and select the needed property.

      For Vocabulary, find and select the needed vocabulary key.

   3. Select the operation.

   4. Select the value of the property.

      If you want to create a rule for a value that does not yet exist in CluedIn, then enter a new value.

      

      Note: The fields for configuring a filter appear one by one. After you complete the previous field, the next field appears.

5. In the Actions section, select Add Action, and then configure the action that CluedIn can perform on the filtered items:

   1. Enter the name of the action.

   2. (Optional) If you want to narrow down your filter query, specify additional conditions for the rule. To do this, in the Conditions section, select Add first rule, and then configure the condition according to the instructions from step 4.

   3. In the Action section, select the action to be performed be the rule. To learn more about what each action does, see Actions.

   4. Depending on the action that you selected, provide the required information.

      For example, if you selected the Add tag action, specify the value of the tag.

      

   5. In the lower-right corner, select Add Action.

   Note: You can add multiple actions to the rule.

6. In the upper-right corner of the rule details page, select Save.

7. Activate the rule by turning on the toggle next to the rule status.

   Now, the rule is active.

   

8. Depending on whether the rule applies to the processed or unprocessed data, do one of the following:

   1. If the rule is applied to the processed data, re-process the entity.

   2. If the rule applies to the unprocessed data, process the data as described in the Ingest data guide.

   You created the rule.

Re-process entity

After you created the rule for the processed data, you need to re-process the entity to apply the rule. Depending on the number of entities that you need to re-process, you can choose one of the following actions:

• If you need to re-process many entities, use the GraphQL tool.

• If you need to re-process few entities, re-process each entity manually.

To re-process the entity using the GraphQL tool

1. On the navigation pane, go to Consume > GraphQL.

2. Enter a query to re-process all entities that belong to a certain entity type. Replace TrainingContact with the needed name of entity type.

   {
    search(query: "entityType:/TrainingContact") {
        entries {
            actions {
                postProcess
            }
        }
    }
   }
   

3. Execute the query.

   You re-processed all entities that belong to a certain entity type. Now, the action from the rule is applied to all entities.

To re-process the entity manually

1. Find and open the needed entity.

2. In the upper-right corner of the entity details page, select More > Re-process entity.

   

   You re-processed the entity. Now, you can view the result of an action performed by the rule.

   

3. To re-process other entities, repeat steps 1–2.

Change rule

After you created the rule, you can edit, inactivate, or delete it.

Inactivate rule

If you currently do not need the rule, but might need it in future, inactivate the rule.

To inactivate the rule

1. Open the rule.

2. Inactivate the rule by turning on the toggle next to the rule status.

   

   You inactivated the rule, but the items to which the rule was applied still contain the changes made by the rule.

3. To return the items to which the rule was applied to their original state, re-process the entity.

   You inactivated the rule and returned the items to which the rule was applied to their original state.

Delete rule

If you no longer need the rule, delete it.

To delete the rule

1. Open the rule.

2. On the rule details page, select the delete icon, and then confirm that you want to delete the rule.

   You deleted the rule, but the items to which the rule was applied still contain the changes made by the rule.

3. To return the items to which the rule was applied to their original state, re-process the entity.

   You deleted the rule and returned the items to which the rule was applied to their original state.

Actions

In the following table, you can learn about the actions that can be performed by the rule.

Results

You have created a rule in CluedIn using the Rule Builder tool.

Next steps

• Create hierarchies