> For the complete documentation index, see [llms.txt](https://knowledgebase.autorabit.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://knowledgebase.autorabit.com/product-guides/vault/vault-features/masking-rules/synthetic_data_generator-masking_rules.md).

# Synthetic\_Data\_Generator - Masking\_Rules

The Masking Rules module centralizes the creation and management of masking rules for a selected Salesforce org. A masking rule defines the object, field type, masking style, selected fields, and replacement behavior used to protect sensitive values.

This guide explains how a Synthetic Data masking rule is created from the standalone Masking Rules module.

## Open the Masking Rules Module

The Masking Rules page displays the selected Salesforce org and the available rule management options. The grid lists existing masking rules with columns such as Rule Name, Type Of The Rule, Object, Field Type, Masking Style, Selected Fields, Created Date, Modified Date, and Actions. When no rules are available, the page displays No Masking Rules.

The Salesforce org is selected from Salesforce Orgs. The required rule can then be created by selecting NEW MASKING RULE.

<figure><img src="/files/jSJDSkghlz903QJeBUKf" alt=""><figcaption></figcaption></figure>

## Start a New Masking Rule

Selecting NEW MASKING RULE opens the Masking Rule dialog. The dialog displays the selected Salesforce Org and provides the required fields for rule creation.

Rule Name is mandatory. The field supports alphanumerics, hyphen, underscore, and spaces. If the rule name does not follow the allowed format, a validation message is shown and the rule cannot be saved until the value is corrected.

SAVE remains inactive until the mandatory configuration is completed. CANCEL closes the dialog without saving the rule.

<figure><img src="/files/zWHj644GcWnH8q2pPUGA" alt=""><figcaption></figcaption></figure>

## Define the Rule Scope

The rule scope is defined by selecting the Salesforce object and the field type. The Select Object list displays the available objects for the selected Salesforce org. After an object is selected, Field Type is used to narrow the field list to the required type of field.

![](/files/f33742a3d7d3bbd817ea697b0dfc6e3fd8722596)

![](/files/f81118a26b735747924f4a5245e04db325feed4c)

![](/files/25f23366c3e5669f83fb6ea476a64b969cec227f)

## Select the Synthetic Data Masking Style

Masking Style is set to Synthetic Data. This masking style replaces selected field values with generated synthetic values that align with the selected masking strategy.

![](/files/32df342ab6b3ee56fe8919c8f2df50eb0da65d6a)

## Select Fields and Configure Masking Strategy

After the object, field type, and masking style are selected, the matching fields are listed in the table. The Search field can be used to narrow the list. The list can be scrolled to review and select the required number of fields.

Each selected field displays configuration options for Masking Strategy and Sample Value. The Masking Strategy value can be changed as needed for each field. The generated sample value provides a preview of the replacement format that will be used for the selected strategy.

Generate Sample Value can be used to shuffle through generated sample values. The value can be regenerated until an acceptable sample appears for the selected field.

![](/files/59e7cc075ce6ddeda662b4eb03b7d7596640c8f7)

![](/files/ff8280a77064c1e26dccd339711a51d438fdb0b0)

![](/files/1d6eae23caf2b507ca313a640585e7e8e39ec043)

![](/files/3ecfad06ff7167da4246d2380addc51fe6cc83e5)

![](/files/7b158de76266e927ada2de3d91d7af8141ecf424)

![](/files/a502dd85742488331eb11c9dff89c613197e1517)

## Save the Rule

After the required fields are selected and their masking strategy values are configured, SAVE becomes available. Selecting SAVE creates the masking rule for the selected Salesforce org.

The rule is then available from the Masking Rules page and can be reviewed or managed from the rule grid.

![](/files/1e8c78ba6c7174a1867eac4d0b7a6f7440f51417)

## Configuration Summary

| **Configuration area**    | **Purpose**                                                                           |
| ------------------------- | ------------------------------------------------------------------------------------- |
| **Salesforce Orgs**       | Identifies the Salesforce org where the masking rule is created.                      |
| **Rule Name**             | Defines the masking rule name and must follow the allowed character format.           |
| **Select Object**         | Determines the Salesforce object whose fields are available for masking.              |
| **Field Type**            | Filters the available fields by the selected field type.                              |
| **Masking Style**         | Uses Synthetic Data to replace selected field values with generated synthetic values. |
| **Masking Strategy**      | Defines the type of synthetic value generated for each selected field.                |
| **Generate Sample Value** | Regenerates the sample value until a suitable preview value appears.                  |
| **SAVE**                  | Creates the masking rule after the mandatory configuration is complete.               |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://knowledgebase.autorabit.com/product-guides/vault/vault-features/masking-rules/synthetic_data_generator-masking_rules.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
