Create a cleaner configuration
A Cleaner configuration saves the Rules that Cleaner will apply during a Run.
The quality of your results depends on the quality of the Configuration. A good Configuration is focused, understandable, and easy to validate. It should reflect a clear business standard instead of a broad goal like "clean everything."
Before you begin
Make sure you have:
- an Import Config for the File format you want to clean
- a clear name for the Cleaner Configuration
- at least one Field you want Cleaner to change
- a practical way to review the output after the Run
Cleaner uses the selected Import Config to show the Fields available for Rules. If the selected Import Config has no current revision, has no enabled Fields, or is not supported for Cleaner column selection, the page shows a warning and you may not be able to save until the issue is corrected.
Typical workflow
A practical way to build a Cleaner Configuration is:
- Open Cleaner and go to Cleaner Configurations.
- Select Create New Config or + New Cleaner Config.
- Enter a Cleaner name.
- Choose an Import configuration.
- Review the Selected columns preview to confirm the expected Fields are available.
- Open Cleaning Rules and select Add rule.
- Define each Rule, including its target Fields and Rule options.
- Review warnings and blocking issues.
- Add a short Description if it will help others choose the Configuration.
- Select Save draft.
When you edit an existing Configuration, use Save to keep changes, Save draft to keep the revision as a draft, or Publish cleaner to make the revision current for users with access.
Screen overview
The Cleaner create and edit screens are organized around setup, Rules, and review.
| Area | What it is for |
|---|---|
| Setup or Quick Setup | Name the Configuration and choose the Import Config. |
| Cleaning Rules | Add, order, enable, disable, and configure Rules. |
| Review & Publish or Advanced | Add a description, review readiness, and save or publish the Configuration. |
| History | On existing Configurations, opens the Configuration history. |
Fields and settings
| Field or setting | What it means | Notes |
|---|---|---|
| Cleaner name | The name users see when choosing the Configuration. | Required. Use a clear business name. |
| Import configuration or Import Config | The import setup that defines the Fields Cleaner can use. | Required. Changing it refreshes the available Fields. |
| Selected columns preview | A preview of the Fields available from the selected Import Config. | This is a Field preview, not a preview of cleaned output values. |
| Description | Optional business context for the Configuration. | Keep it short and useful for reviewers. |
| Publication status | Whether the current revision is kept as a draft or published. | New Configurations are saved as drafts. Existing Configurations can be published from the edit screen. |
Cleaning Rules
Rules run from top to bottom. If more than one Rule affects the same Field, the later Rule works with the value produced by earlier Rules.
Each Rule includes these main settings:
| Setting | What it means |
|---|---|
| Use this rule | Turns the Rule on or off without deleting it. Disabled Rules are ignored during a Run. |
| Plain-language name | A required name that explains the Rule's purpose. |
| What should this rule do? | The Rule action Cleaner will apply. |
| Apply to columns | The Field or Fields the Rule affects. You can type comma-separated Field names, choose from known Fields, or use * for all Fields. |
| Move up and Move down | Change the order in which Rules run. |
| Delete | Removes the Rule from the Configuration. |
Use * only when the Rule truly should affect every Field. The editor warns that applying a Rule to all Fields may affect performance.
Rule options
Cleaner currently shows these Rule actions in What should this rule do?:
| Rule action | What it does | Main options |
|---|---|---|
| Trim spaces | Removes extra spaces at the start and end of values in the selected Fields. | Trim spaces at the start and end |
| Blank value cleanup | Stores matching placeholder values as blank. | Blank value examples, entered as comma-separated values such as N/A, NULL, - |
| Find and replace text | Replaces a known value with another value. | Find and Replace with. Leaving Replace with blank removes the found value. |
| Standardize data type | Converts values to a selected output type where Cleaner can parse the value. | Output type. If the output type is Date, Accepted date formats is required. |
For Standardize data type, review date, whole number, and decimal outputs carefully before relying on them. If you choose another output type shown in the dropdown, test it with representative examples before using the output downstream.
Validation and warnings
Cleaner blocks saving when required setup is missing. Confirm these items before saving:
- Cleaner name is filled in.
- An Import configuration or Import Config is selected.
- At least one Rule is enabled.
- Each Rule has a Plain-language name.
- Each Rule has a selected action in What should this rule do?.
- Each Rule has at least one target in Apply to columns.
- Find is filled in for Find and replace text Rules.
- Accepted date formats is filled in when Standardize data type uses Date.
Cleaner may also show warnings that do not block saving, such as duplicate Rule names or use of * for all Fields. Review warnings before saving because they often point to Rules that need extra care.
Previewing before saving
The create screen includes a Selected columns preview and a short Rule summary. These help you confirm that the Configuration is pointed at the expected Fields and that the Rule list is understandable.
Cleaner screens show the available Fields and Rule summaries before saving, but they do not show a full before-and-after preview of cleaned values before the Run. For a new or changed Configuration, run Cleaner on a small representative File first, then review the output before using it downstream.
Common mistakes to avoid
Avoid these patterns:
- applying a Rule to every Field when only one or two Fields need cleanup
- using a saved Configuration with a File whose Field names do not match the selected Import Config
- building one large Configuration for unrelated cleanup goals
- leaving a Rule enabled before you understand what it changes
- using Standardize data type without representative examples of messy values
- publishing a Configuration before another user can understand its name, description, and Rules
After the Configuration is ready
Once the Configuration is saved and tested, continue to Run Cleaner to apply it to a File and review the result.