Rules and Rulebooks > Configuring the Rules Engine
  
Configuring the Rules Engine
There are a number of system values that you can use to configure how rules processing works.

System Values for Rules and Rulebooks
 
Category
Key
Description
RULES
ADDITIONAL RULE PROGRAM
Specify the name of a custom program that you want rules processing to call when rules are fired.
RULES
ALWAYS OVERRIDE ADDR CHANGES
Possible values: Yes, No.
RULES
ALWAYS USE XMSMDS0 FIELDS
When an override field is populated by a rule, this value checks where the value should be put on the shipment (XMSHDR0 or XMSMDS0).
This parameter lists fields that may exist in both the shipment header file and the shipment header extension file.
The fields may also exist on the shipment override file xmsmds0. If a field is listed here and it exists in both files, then the value in xmsmds0 is always used and the one in the shipment header file is ignored.
Consult the PRECISION Services team before updating this system value. It is used when xmsmds0 fields have been added to the shipment files but these fields are not yet in use by the system.
RULES
APPLY CONSIGNEE RULES
Possible values:
Yes - When running rules processing, check for rules associated with consignees.
No - When running rules processing, for improved performance, do not check for rules associated with consignees.
Default value: Yes
RULES
APPLY CONSIGNOR RULES
Possible values:
Yes - When running rules processing, check for rules associated with consignors.
No - When running rules processing, for improved performance, do not check for rules associated with consignors.
Default value: Yes
RULES
APPLY CUSTOMER RULES
Possible values:
Yes - When running rules processing, check for rules associated with customers.
No - When running rules processing, for improved performance, do not check for rules associated with customers.
Default value: Yes
RULES
APPLY EXPORT REFUND RULES
Possible values: Yes, No.
Yes - When running rules processing, check for rules associated with shipments that are flagged for calculation of an export refund.
No - When running rules processing, for improved performance, do not check for rules associated with shipments that are flagged for calculation of an export refund.
Default value: Yes
Shipments that are flagged for calculation of an export refund have the shipment header field XMSHDR0.SHCALCEXP set to true. This field is set to true when:
The shipment country of despatch (identified by the shipment header field XMSHDR0.SHCDS1) is in the EU. Countries within the EU have the country field XMCTRY0.CTEGRP set to 01.
The shipment country of destination (identified by the shipment header field XMSHDR0.SHCDT1) is not in the EU. Countries outside of the EU have the country field XMCTRY0.CTEGRP set to a value other than 01.
RULES
APPLY FULL FILTERING
This field controls how blank fields in a shipment are treated when checking rule determinations against a shipment.
Possible values:
No - If a field in the rule determination has a value, but the corresponding field in the shipment is blank, then this field does not affect whether the rule determination applies to a shipment.
Yes - When a field in the rule determination has a value, but the corresponding field in the shipment is blank, then this field does affect whether the rule determination applies to a shipment. The particular rule determination will not apply to the shipment because not all of the fields match the corresponding fields on the shipment.
Default value: No
RULES
APPLY PARTNER ADDRESS LINKS
Possible values: Yes, No.
RULES
APPLY PRODUCT RULES
Possible values:
Yes - When running rules processing, check for rules associated with products.
No - When running rules processing, for improved performance, do not check for rules associated with products.
Default value: Yes
RULES
ASSIGN CONSIGNEE TO CUSTOMER
Possible values: Yes, No.
RULES
AutoCreateRuleBookForPartner
Possible values:
Yes - a rulebook is created automatically when a new partner is created. This rulebook has the same name as the rule.
No - a rulebook is not created automatically when a new partner is created.
Default value: No
RULES
DEFAULT-CONTACT-TO-USER
Use this system value to default the shipping officer for documents.
Possible values:
Yes - the value of the shipment Contact field is set to the person who is processing the shipment.
No
RULES
DEFAULT RULE BOOKS
Use this system value to specify the default rule book to be used by PRECISION.
Format: A two-pair comma-separated listing, <SHIPMENT_TYPE>, <RULEBOOK_NAME>.
Example: EX,QDEFAULT where EX is a shipment type listed in option ZS and QDEFAULT is a rulebook listed in option RB.
The value can also be specified as ?,QDEFAULT where ? represents all shipment types, and QDEFAULT is listed in option RB as the default rulebook fired for all shipments that are created.
Updating this system value updates the Default Types for Rulebook <RULEBOOK_NAME> tab on the RULES screen.
RULES
OVERWRITE-NON-BLANK-TEXTS
In the case of a rule that associates texts with a shipment, and those texts already exist on the shipment, this system value determines whether the existing texts are overwritten.
Possible values: Yes, No.
RULES
OVERWRITE SHDSTR
Possible values:
Yes - Update the Delivery Terms field of a transaction based on a rule.
No - Do not allow rule information to overwrite the Delivery Terms field of a transaction.
RULES
OVERWRITE-WITH-BLANK-RULE-TEXT
Possible values: Yes, No.
RULES
RESET NOTES AND TEXT IDS
Possible values:
Yes - When a rule adds a document to a transaction and the document already exists on the transaction, the texts and notes associated with the document are overwritten.
No - When a rule adds a document to a transaction and the document already exists on the transaction, the texts and notes associated with the document are not overwritten.
Default value: No
RULES
RESET PRINT COUNTER
The print counter increases by one each time a document is printed.
Possible values:
Yes - Increments the print counter when a rule adds a document to a transaction and the document is already attached to the transaction.
No - Does not increment the print counter when a rule adds a document to a transaction and the document is already attached to the transaction.
Default value: No
RULES
RULE DEBUG MODE
Debug mode displays information messages when rules are run in the foreground in the Windows UI.
Possible values:
Yes - Debug mode is switched on.
No - Debug mode is switched off.
Default value: No
RULES
RUN CHARGE CALCULATION
Possible values: Yes, No.
Default value: No
RULES
SHIP CARRIER MATCH CHARGE TAB
If you want to specify that a particular charge table should only be associated with a rule when the charge table carrier matches the shipment carrier, then set this field to Yes.
Possible values: Yes, No
Default value: No
RULES
SUB OPTIONS TO USE
A CSV list of sub-options to ignore when running rules processing. This allows you to speed up performance by not checking sub-options specified in the list.
Possible values: A comma-separated list of option codes, which can include:
RUR0 (virtual fields overrides)
RUR101(general information)
RUR102 (partners - trading internal)
RUR103 (route)
RUR104
RUR105 (partners - transport customs financial)
RUR2
RUR201 (ECSI details)
RUR202
RUR203
RUR3 (documents)
RUR4 (texts)
RUR5 (tracking details)
RUR6 (procedure notes)
RUR7 (product descriptions)
RUR8 (product prices)
RUR9 (charge tables)
RURM (EDI messages)
RURN (partner address changes)
RURV (vessels/legs)
Example: RUR7, RUR8
Default value: blank
RULES
USE TRANS TYPE AS RULE SET
Rule sets allow you to specify that a rule or rulebook only applies to a shipment when the rule set of the shipment matches the rule set specified in the Rules Determinations - Create screen.
Use this system value to specify that rule sets are based on transaction types such as shipments or orders. Option Z9 lists transaction types.
Possible values:
Yes - rule sets are based on transaction types such as shipments or orders.
No - rule sets do not play a role in rules processing.
Default value: No - rule sets do not play a role in rules processing.
For more information on the Rule Determinations - Create screen, see “Adding Rules Determinations for a Rulebook” on page 207.