Matrix Loader: CSV rules upload
Summarize
Summary of Matrix Loader: CSV rules upload
The Matrix Loader in ServiceNow CPQ allows administrators to bulk create, edit, and export rules using CSV files. This tool streamlines configuration management by enabling rule conditions, actions, and logic to be defined in spreadsheets, which can then be uploaded directly into the environment. It significantly improves efficiency by replacing manual rule creation in the Admin interface, facilitating faster setup, easier testing, and simplified migration between sandbox and production instances.
Show less
Key Features
- Bulk Rule Management: Upload multiple rule records at once via CSV, reducing manual effort.
- Rule Upload Structure: Each CSV row corresponds to a rule, with specific columns such as recordtype, rulename, rulevariablename, rulestatus, actiontype, and others that define rule properties and logic.
- Condition Groupings: Supports logical combinations of conditions using groupings like any (OR), all (AND), custom (complex logic), and always (unconditional).
- Supported Operators: Includes equals, not equals, less than, greater than, contains, in, and their negations for condition evaluation.
- Product-BOM Actions: Allows specifying product references and quantities for bill-of-material actions, with options for mandatory or optional products.
- Export Capability: Administrators can export all existing rules into a CSV file for review or migration, accessible from the Admin navigation pane.
- Validation Guidelines: Emphasizes exact matching of variable names, use of inactive status for testing, careful validation of grouping logic, and alignment of product references with Salesforce configuration.
Practical Considerations for ServiceNow Customers
- Use the Matrix Loader to accelerate rule deployment and updates, especially when managing large sets of complex rules.
- Follow the prescribed CSV format and utilize sample files as templates to ensure proper import structure.
- Leverage the export functionality to backup rules or migrate configurations between environments safely.
- Maintain concise and descriptive rule descriptions to aid in administration and troubleshooting.
- Test new or modified rules in inactive status before enabling them in production to prevent unintended effects.
Use the Matrix Loader to bulk create, edit, and export rules in CPQ. Define rule conditions, actions, and logic in a CSV file to streamline configuration management and automate large-scale updates.
The the Matrix Loader enables administrators to efficiently upload and manage all rule types in CPQ. Instead of manually creating each rule in the Admin interface, you can define them in a spreadsheet, export the sheet to CSV format, and upload it directly into the environment. This enables faster configuration setup, easier testing, and simplified migration between sandbox and production environments.
Rules upload structure
Each row in the CSV file represents a rule record. The following table outlines the columns and data that the Matrix Loader accepts for rule uploads.
| Column Name | Description | Valid Values | Notes |
|---|---|---|---|
| record_type | Identifies this as a rule upload | rule | Required |
| rule_name | Name displayed on the rule list Admin page | Valid strings can be composed of up to 255 characters, including letters, numbers, spaces, and the following special characters: {}[]()|\~`_^@?<=>;:/.-,+*’&%$#”! |
Required |
| rule_variable_name | Unique string used by CPQ to reference the rule | Valid field variable names consist of up to 128 letters, numbers, and underscores. The first and last character must be a letter or number. | Required; must be unique |
| rule_description | Contextual description for administrator reference | Valid strings can be composed of up to 255 characters, including letters, numbers, spaces, and the following special characters: {}[]()|\~`_^@?<=>;:/.-,+*’&%$#”! |
Optional |
| rule_status | Determines if the rule is active | active, inactive | Required; inactive rules are ignored by the engine |
| action_type | Defines the type of action executed when the rule runs | visibility, message, exclusion, inclusion, determination, product | Required |
| action_sub_type | Supplementary definition augmenting action_type | hide, info, warning, error, hidden, disabled, set, forceset, manufacturing, sales | Optional; depends on action_type |
| action_field | Field to which the action applies | <field variableName> | Required |
| action_value | Value applied to the action_field | Varies by action type | Required for message, exclusion, inclusion, or determination actions |
| action_product | Product reference for bill-of-material (BOM) actions | SFDC Product Code, Product2 ID, or External ID | Required for product actions |
| action_quantity | Quantity of the product added to the BOM | <positive float> or <positive integer> | Required for product actions |
| action_mandatory | Specifies whether a BOM product is optional or mandatory | TRUE, FALSE, <empty> | Optional; defaults to TRUE |
| grouping | Defines how conditions are grouped and evaluated | any, all, custom, always | Required |
| resource / operator / value | Defines condition tuples forming the rule logic | <field variableName>, operator, value | Resource, operator, and value together define the condition expression |
Condition groupings
- any: ORs all conditions defined in the row.
- all: ANDs all conditions defined in the row.
- custom: Allows complex logic expressions, such as (1 OR 2) AND 3.
- always: Applies the rule unconditionally.
Valid operators
- equals (=, ==, equals)
- not equals (!=)
- less than (<)
- less than or equal
- greater than (>)
- greater than or equal (>=)
- contains / not contains
- in / not in
General guidelines
- Always verify variable names match the field references exactly.
- Keep rule descriptions concise but descriptive to aid troubleshooting.
- Use inactive status for testing new rules before enabling in production.
- Validate grouping logic (any/all/custom) carefully to avoid unintended outcomes.
- Ensure product references (Product2 ID or External ID) align with your Salesforce configuration.
Exporting rules to CSV
- In the left Admin navigation pane, click Rules.
- Optional: enter a search string and press Enter to narrow results.
- Click Export. A message confirming export appears at the bottom of the page.
- Open the Notification Center (bottom left) and click the Download link.
Additional information
- Valid strings may include letters, numbers, spaces, and special characters:
{ } [ ] ( ) | \ ~ ` _ ^ @ ? < = > ; : / . - , + * ’ & % $ # " - Rule variable names can contain up to 255 alphanumeric characters and underscores. They must begin and end with a letter or number.
- Cells with gray backgrounds in sample files denote irrelevant fields for the current context.
- Use the provided sample files (Admin → Matrix Loader → Sample Files → Rules) as a template for formatting.