Updating Shells - Rules Node
Rules can be updated in CBS code-based shells.
The Update Shells process runs in the background. Depending on the number of records and shells you are updating, it can take a considerable amount of time to complete. The process is complete when the End Date column in the Update History window shows the complete date.
Notes:
- Both active and inactive rules can be pushed.
- Rules are identified by the combination of rule name and the source.
- If the rule does not exist, it will be added.
- If a rule exists with the same name and source, that rule will be updated. This includes the status: for example, if the rule being pushed is active, and the rule in the shell is inactive, the system will update the existing rule and activate it.
- It is possible to have more than one rule with the same name and source in a project/shell or template. If two or more rules exist with the same name and source as the rule being pushed, the update will not occur and will give an error.
- When the update process begins, the system will first attempt to validate each rule (equivalent to clicking the Validate button). This will occur whether the rule is active or inactive in the template. If the rule is validated successfully, the system will proceed with the update.
- If the rule fails validation, the rule will not be pushed. The attempt will be captured in the History.
To update rules using Update Shells
- Go to the Company Workspace tab and switch to Admin mode.
- Click Templates > Shells in the left Navigator.
- Open the shell template to update.
- In the Shell Template, navigate to Rules.
- Select one or more rules from the log.
- Click Update Shells and choose one of the following:
- Shells: You can use this option to select one or more shells to update. When the update window opens, it lists all shells in the project. You can use Find to isolate the shells you want to update. The find window contains data elements from the Find form that was designed. When you have isolated the shells to update, click the Update button and select either Selected Shell(s) or All Filtered Shells.
- All Shells: You can use this option to update all shells of that shell type.
- History: You can view the update history from past updates or cancel a request before the update begins.
An Alert window opens letting you know that you are about to push changes to the selected shells; there is no undo for the update.
- Click Yes if you want to proceed with the update, or No to cancel.
Conditions for Creating a Rules setup Configuration Package
The first time that you package the Rules Setup information, you must include the following in the package:
- Design of the Business Processes used in the Rule definition.
- Corresponding designs.
The design for Configuration Package.
For subsequent exports, ensure that the design that uses the Data Element that is specifically used in the setup is present in the Production Published package. As long as this condition is met, the package creation will be successful. If this condition is not met, the latest design will have to be included in the package.
Importing of Rules based on Rule Status
Note: For both Active and Inactive, the system does not check for the existence of the specific CBS codes in the Cost Sheet (Applicable where the Rule definition uses CBS codes).
Rules with Active Status
At the time of Import, ensure that:
- The Cost Sheet or Funding Sheet, used in Rules definition, exists either in the Package or in the destination server.
- The data source is present, as a column, in the Funding sheet.
- The cost sheet columns or the Funding Sheet columns used in Rule definition required for Rule Activation are present either in the package or in the destination server.
When CBS codes are used, ensure that the Cost Sheet used for Rules definition exists either in the Package or in the destination server.
Rules with Inactive Status
The system does not perform any checks at the time of import.
Rules Components in the Configuration Package
The system includes the following components of Rules in the Configuration Package (.zip file):
Component | Field / Option |
---|---|
Rule Properties / General | Name |
Rule Properties / General | Description |
Rule Properties / General | Control Source |
Rule Properties / General | Rule Level |
Rule Properties / General | Status |
Rule Properties / General | Users / Groups who can override field. Users and groups will be part of the Configuration Package. (Applicable only for Rule level = Per selected CBS Codes and Per selected summary CBS codes) |
Rule Properties / General | Notify Users / Groups when overridden field. Users and groups will be part of the Configuration Package. (Applicable only for Rule level = Per selected CBS Codes and Per selected summary CBS codes) |
Rule Properties / Rule | Limit expression formula: Formula string. The formula string contains BPs. |
Rule Properties / Rule | Data Expression: Might be a formula using BP data sources. |
Rule Properties / Rule | Message when condition not met. |
Rule Properties / CBS Codes | CBS Codes (Applicable only for Rule level = Per selected CBS Codes and Per selected summary CBS codes) |
Last Published Monday, August 28, 2023