The Ruleset Data Object (RDO) is used to create and house reusable variables that can be added to the global root (glb) set of variables in a Ruleset.
The variables assigned in the RDO may have initial values that can be reused when building Rulesets. While the values can be overwritten in the Ruleset, the variables always retain their original value as defined in the RDO. This is important because it allows you to maintain sets of reusable variables in one location; any changes to these variables can be made by editing one object, and not having to edit every Ruleset that uses the variable(s).
Use this object to create and use accumulators, intermediate results, envelope-level data, and system variables in your Rulesets.
Set or inspect the RDO from within a Business Process before or after transformation, allowing to either populate external values from the Business Process that might be needed during transformation or to inspect values after transformation available only during that transformation.
Working with custom variables gives you flexibility and re-usability in your transformations since you can create and maintain these variables once but reuse them across many Rulesets.
An example could be when building multiple Rulesets for a particular trading partner; for every Ruleset, you always include the trading partner’s Corporate ID, which is a 25-digit value. You could create this variable every time you need it in each Ruleset, but instead, you create an RDO object and include the Corporate ID variable (perhaps along with other commonly used variables). You add the RDO to your global (glb) variables in each Ruleset, making the Corporate ID variable available for use (in the Variables section) every time you need it.
- SCAC Codes
- Corporate Address
- Bill To Address
- Ship To Address
A best practice could be to create one RDO for use in your CORE Project, and then share it across multiple Projects.
How the Object Works
Rulesets, by default, do not contain any global root (glb) variables. They must be created as an RDO. Once created and added to a Ruleset, they are available from the glb folder in the Ruleset's Variables section. Rulesets can only use one RDO at a time, but the object can contain many variables.
There are no true constants used in Clarify. Instead, there are variables with an initial value. It is these variable types that are contained within the RDO.
- Create the object.
- Define the variable names, values, and types.
- Add it from the Variable section in a Ruleset
Note: This object is compatible with the new engine by default; however if previously referenced from an older Ruleset, it must be converted before it can work with the newer Ruleset. Please see Converting Resources to Work with the New Engine.