{"type":"doc","content":[{"type":"paragraph","content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"excerpt-include","parameters":{"macroParams":{"":{"value":"Framework ECM Header"},"nopanel":{"value":"true"}},"macroMetadata":{"macroId":{"value":"2478b68d-c089-471e-9a8f-fbd73bd44d8a"},"schemaVersion":{"value":"1"},"title":"Insert excerpt"}},"localId":"c319b022-89ee-4991-bdcd-fdd3e2963fc5"}},{"type":"hardBreak"},{"text":"Return to Security","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://insulagroup.atlassian.net/wiki/spaces/FWECM/pages/2285508842"}}]}]},{"type":"paragraph","content":[{"text":"Article Index","type":"text","marks":[{"type":"strong"}]}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"1e752275-5642-4f8b-b87a-db301c1d5fe8"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"b0fe8653-e3f9-414a-9a08-c9b9a0cd2160"}},{"type":"paragraph","content":[{"type":"hardBreak"},{"text":"The Business Rules screen assists businesses to achieve their goals by giving more control over business behaviour.","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":1210,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1210,"alt":"image-20240903-013935.png","id":"0bb3fd0b-17fe-42a2-b3ca-1f229d0499fa","collection":"contentId-2285508965","type":"file","height":846}}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Procedures","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Creating A Business Rule","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"From the ","type":"text"},{"text":"Groups","type":"text","marks":[{"type":"strong"}]},{"text":" list, select the required group. The ","type":"text"},{"text":"Fields","type":"text","marks":[{"type":"strong"}]},{"text":" list will be updated.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"From the ","type":"text"},{"text":"Fields","type":"text","marks":[{"type":"strong"}]},{"text":" list, select the required field. The ","type":"text"},{"text":"Rules","type":"text","marks":[{"type":"strong"}]},{"text":" list will be updated.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Select the ","type":"text"},{"text":"Rules","type":"text","marks":[{"type":"strong"}]},{"text":" list. A shadow will appear around the list to indicate it is selected.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click ","type":"text"},{"text":"New","type":"text","marks":[{"type":"strong"}]},{"text":". The ","type":"text"},{"text":"Business Rule","type":"text","marks":[{"type":"strong"}]},{"text":" dialog will be displayed.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Enter the details.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click ","type":"text"},{"text":"OK","type":"text","marks":[{"type":"strong"}]},{"text":". The dialog will close and a new business rule will be created.","type":"text"}]}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"A business rule clause in Framework ECM consists of an operand + a comparator + an operand. For example, the modified ","type":"text"},{"text":"Initial Deposit Date","type":"text","marks":[{"type":"strong"}]},{"text":" must occur after the ","type":"text"},{"text":"Sale Reported Date","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]}]},{"type":"paragraph"},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"To be complete, a business rule must also have a reversal. For example, the modified ","type":"text"},{"text":"Sale Reported Date","type":"text","marks":[{"type":"strong"}]},{"text":" must occur before the ","type":"text"},{"text":"Initial Deposit Date","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Disabling Individual Rules","type":"text"}]},{"type":"paragraph","content":[{"text":"For situations where business rules that are shipped with Framework ECM are not required to be enforced, they can be easily switched off by modifying the ","type":"text"},{"text":"Enabled?","type":"text","marks":[{"type":"strong"}]},{"text":" field on the ","type":"text"},{"text":"Business Rules","type":"text","marks":[{"type":"strong"}]},{"text":" dialog.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Customising A Standard Rule And Description","type":"text"}]},{"type":"paragraph","content":[{"text":"The default business rules that are shipped with Framework ECM are generic rules based on the major work flow stages. A current rule string or description may be customised for individual needs should the defaults not be applicable.","type":"text"}]},{"type":"paragraph","content":[{"text":"The customisation functionality has been included to enable users to change the terminology of these fields to suit.","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"From the ","type":"text"},{"text":"Groups","type":"text","marks":[{"type":"strong"}]},{"text":" list, select the required group. The ","type":"text"},{"text":"Fields","type":"text","marks":[{"type":"strong"}]},{"text":" list will be updated.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"From the ","type":"text"},{"text":"Fields","type":"text","marks":[{"type":"strong"}]},{"text":" list, select the required field. The ","type":"text"},{"text":"Rules","type":"text","marks":[{"type":"strong"}]},{"text":" list will be updated.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"From the ","type":"text"},{"text":"Rules","type":"text","marks":[{"type":"strong"}]},{"text":" list, select the required business rule.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click ","type":"text"},{"text":"Edit","type":"text","marks":[{"type":"strong"}]},{"text":". The ","type":"text"},{"text":"Business Rule","type":"text","marks":[{"type":"strong"}]},{"text":" dialog will be displayed.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Enter the ","type":"text"},{"text":"Custom Rule?","type":"text","marks":[{"type":"strong"}]},{"text":" status as ","type":"text"},{"text":"Yes","type":"text","marks":[{"type":"strong"}]},{"text":". The ","type":"text"},{"text":"Rule String","type":"text","marks":[{"type":"strong"}]},{"text":" field will be editable.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Modify the rule string, as required.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Modify the ","type":"text"},{"text":"Description","type":"text","marks":[{"type":"strong"}]},{"text":" field, if required.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click ","type":"text"},{"text":"OK","type":"text","marks":[{"type":"strong"}]},{"text":". The dialog will close and the business rule will be modified.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Business Rules - String Syntax","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Incorrect use of business rules in Framework ECM may cause errors and/or unpredictable behaviour. If unsure how to implement business rule changes, please contact your Framework Solution Provider.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"Any field in the Framework ECM database may have none (0) or more rules associated with it. For a new value to be accepted by that field, all rules of this field must evaluate to true.","type":"text"}]},{"type":"paragraph","content":[{"text":"Business rules are unique to RMS fields and region divisions, allowing separate divisions of an organisation to specify their own local rules. Business rules may be switched on/off at the rule level, division level, and global level.","type":"text"}]},{"type":"paragraph","content":[{"text":"All rules are stored in the database as text strings representing the conditions that, as a whole, must logically evaluate to true for the rule to be valid.","type":"text"}]},{"type":"paragraph","content":[{"text":"A rule is either empty or a combination of clauses and logical operators (non-empty).","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Empty Rule","type":"text"}]},{"type":"paragraph","content":[{"text":"The empty rule (no rule) is an empty string:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"“”","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Non-Empty Rule","type":"text"}]},{"type":"paragraph","content":[{"text":"A non-empty rule is either a single clause, or any number of sub-strings, containing 2 clauses and an operator, separated by any amount of white space and enclosed in round brackets “( )”","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Rule with one (1) clause: “[X <= Y]”","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Rule with one (1) operator: “([x <= Y] AND [Y <= Z])”","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Rule with two (2) operators: “([x <= Y] AND ([A = B] OR [Y <= Z]))”","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Operators","type":"text"}]},{"type":"paragraph","content":[{"text":"An operator is any of the following:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"AND","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"OR","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"NAND","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"NOR","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"XOR","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"XNOR","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Clause","type":"text"}]},{"type":"paragraph","content":[{"text":"A clause features two (2) operands separated by a comparator, enclosed in square brackets.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"[X <= Y]","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Where there is any amount of white space between the comparator and operands.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Comparator","type":"text"}]},{"type":"paragraph","content":[{"text":"A comparator is any of the following:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"<","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":">","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"<=","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":">=","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"=","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"!=","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Operand","type":"text"}]},{"type":"paragraph","content":[{"text":"An operand is either a database field’s context id (","type":"text"},{"text":"rmsFieldCtxPKID","type":"text","marks":[{"type":"strong"}]},{"text":"), or a literal value preceded by a single quote character (","type":"text"},{"text":"‘","type":"text","marks":[{"type":"strong"}]},{"text":").","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"49882 - field context ID (long)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"‘2/4/99 - literal value (date)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"‘$4,500 - literal value (currency)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"‘Hooper - literal value (string)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"‘1:00 PM- literal value (time)","type":"text"}]}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"If operands are of different types, an error will be generated.","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Creating Clauses","type":"text"}]},{"type":"paragraph","content":[{"text":"If the value of the left operand is null (missing, empty, “”, white space, unknown, undefined), the clause is ","type":"text"},{"text":"False","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"If the value of the right operand is null (missing, empty, “”, white space, unknown, undefined), the clause is ","type":"text"},{"text":"True","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"A clause may also be a null test of a single field, using the following syntax:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"[isNull<1234>] - Clause is true when the field 1234 is null","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"[notNull<1234>] - Clause is true when the field 1234 is not null","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"In addition to the above, a clause operand may include a mathematical manipulation of the field’s value.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Comparison","type":"text"}]},{"type":"paragraph","content":[{"text":"Users may wish to specify that one field be compared to 5% of another field, or one field be compared to another field minus 2 weeks. This is achieved by prefixing the field’s context ID with the operation and its parameter, followed by the operation again, as follows:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"[86 > %5.5%91] - Field 86 must be greater than 5.5% of field 91","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"[86 > *10*91] - Field 86 must be greater than 10 times field 91","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"[86 > -2-91] - Field 86 must be greater than field 91 minus 2","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"[86 = +12+91] - Field 86 must equal field 91 plus 12","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"[86 != /4.0/91] - Field 86 must not equal field 91 divided by 4","type":"text"}]}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"The units of the parameter in the operation depend on the operation or the value of the field’s type. For all ","type":"text"},{"text":"*,/","type":"text","marks":[{"type":"strong"}]},{"text":" and ","type":"text"},{"text":"%","type":"text","marks":[{"type":"strong"}]},{"text":" operations, the parameter is converted to a floating point double beforehand. For ","type":"text"},{"text":"+","type":"text","marks":[{"type":"strong"}]},{"text":" and ","type":"text"},{"text":"–","type":"text","marks":[{"type":"strong"}]},{"text":" operations, the parameter is converted to the same type as the field value. This may be numerical, date (days), time (minutes), currency (dollars), etc.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"Using the third example above, if field 91 is a date, field 86 must be greater than field 91 minus 2 days.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Summary","type":"text"}]},{"type":"paragraph","content":[{"text":"A clause operand may also be the sum of two (2) or more field values. This is achieved by the use of the ","type":"text"},{"text":"s","type":"text","marks":[{"type":"strong"}]},{"text":" character, and the list of comma separated fields to be summed enclosed in curly brackets:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"[86 < s{20, 30, 40}] - Field 86 must be less than the sum of fields 20,30, and 40","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Framework Examples","type":"text"}]},{"type":"paragraph","content":[{"text":"Rule for Administration Complete:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"([86 <= 91] AND [64 < 91])","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Building Permit Received Date (86) must be less than or equal to Admin Complete Date (91)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"AND","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Ordering Received Date (64) must be less than Admin Complete Date (91)","type":"text"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"Rule for Frame Complete:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"[2123 <= 2135]","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Base Complete Date (2123) must be less than or equal to Frame Complete (2135)","type":"text"}]}]}]}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Business Rules - Rule Control","type":"text"}]},{"type":"paragraph","content":[{"text":"A rule belonging to a specific field can be found in the ","type":"text"},{"text":"rms_ctxBRule","type":"text","marks":[{"type":"strong"}]},{"text":" table, indexed by the Field Context ID (","type":"text"},{"text":"l_rms_fieldCtx_id","type":"text","marks":[{"type":"strong"}]},{"text":") and the Region Context ID (","type":"text"},{"text":"l_context_id","type":"text","marks":[{"type":"strong"}]},{"text":") - the region division to which the rule belongs.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Individual rules can be switched on and off in the ","type":"text"},{"text":"f_customRule","type":"text","marks":[{"type":"strong"}]},{"text":" field","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The message displayed to the user when a rule is violated is stored in ","type":"text"},{"text":"m_notes","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The ID of the context the rule belongs to is stored in ","type":"text"},{"text":"l_context_id","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Rule enforcement is enabled for a specific context (e.g.: region division) in the ","type":"text"},{"text":"l_rDiv_id","type":"text","marks":[{"type":"strong"}]},{"text":" field in the ","type":"text"},{"text":"rDiv","type":"text","marks":[{"type":"strong"}]},{"text":" table, and changes at log on/off. The","type":"text"},{"text":"l_context_id","type":"text","marks":[{"type":"strong"}]},{"text":" of ","type":"text"},{"text":"0","type":"text","marks":[{"type":"strong"}]},{"text":" will apply a rule to all regions/divisions.","type":"text"}]}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"When a rule has been violated in Framework ECM, the screen remains in edit mode to enable the user to modify the offending fields to valid values. If the user cancels at this point, ","type":"text"},{"text":"ALL CHANGES WILL BE LOST","type":"text","marks":[{"type":"strong"}]},{"text":", including changed fields that satisfied their business rules.","type":"text"}]}]}],"version":1}

Browser not supported