Editing batches
Batches are JSON files that contain a description of batch metadata along with the included configuration objects. For a detailed schema description, see the ETL chapter.
Expert users can edit batch files directly using code editors such as Visual Studio Code. Additionally, Customizer Admin provides a set of tools to simplify common batch editing operations.
To access Batch Tools, select the corresponding option from the sidebar menu.
Comparing batches
The Batch Comparison Tool takes two input batches and generates a new batch file that highlights the differences between them. The comparison includes settings that were added, removed, or changed.
Remove activation
The Remove Activation Tool removes all references to the Active/Inactive status settings from a batch. This is useful when performing bulk edits to properties such as custom attributes, names, tags, and categories while ensuring that activation statuses remain unchanged when reimporting the batch into Customizer Admin.
Activate or deactivation
The Activation Editing Tool allows you to modify the activation statuses of component options or products. It supports the following actions:
Activate or deactivate settings globally
Activate or deactivate settings for a specific site channel
AI editing tool
The AI Editing Tool allows you to upload a batch and provide a natural language prompt describing the desired edits. For example:
Add a tag SampleTag
Remove a tag TagToRemove if the option code contains XYZ
Add a custom attribute ABC and set it to XYZ
The natural language prompt supports complex instructions, including conditional and multi-step operations. For example:
Add a custom attribute ABC if the code contains XYZ, and set the value to Prefix-UPC-Suffix, where UPC comes from attribute UPC.
As with many AI tools, the AI Editing Tool may occasionally produce errors. It is recommended to review the generated file for correctness before importing it into Customizer Admin.
Merge vs overwrite functionality
By default, batch operations attempt to be non-destructive - they may overwrite data with explicitly provided new values, but loading a batch should not delete unintentional data, for example, batches would not remove tags, components, etc.
In some case, however, it may be desired to remove data complete, for example, when doing a clear n up. Some use cases include:
Removing tags
Removing site activations
Removing versions
Resetting camera positions etc.
It is recommended to review batches manually prior to applying destructive changes!
In such cases the AI Editing Tool needs to be explicitly instructed to apply destructive changes. Such instructions may include:
Instruction | Effect |
|---|---|
Delete tag X | Tag X will be removed from related entities |
Delete category X | Category X will be removed from related entities |
Delete custom attribute X | Provided custom attribute will be removed |
Overwrite custom attributes | Custom attributes not included in the batch will be removed |
Overwrite tags | New tag lists will be applied to match the batch exactly, instead of only adding new tags |
Overwrite prices | Prices will be set exactly to the batch state instead of updating or adding new price points, which could result in removal of some prices |
Overwrite active flags | Overwrite site-specific activation flags, removing unused site assignments |
Overwrite rules | Set rules only to the lists provided in the batch, removing unused rules |