Rule[edit]


= Rule =

You can work with Rules in several ways.&nbsp;

== Create a Rule ==

You can create rules to create Requests or Agreements using the Rules tile.&nbsp;For example, you can create a Rule for an Agreement to get the Supporting Documents auto attached at the predefined state. User who is provided with&nbsp;administrative privileges can only create Rules from&nbsp;''Rule''&nbsp;tile.

Using Rules you can ensure that:

*&nbsp;The Agreements/Contracts contain appropriate data depending on the type 
*&nbsp;The Agreements/Contracts get executed as required 

With ICM, you can create Rules for Contract Types. You can create various types of Rules only for the published Contract Types.

To create a Rule:

1.&nbsp;'''Click''' ''Configuration'''''&nbsp;'''on My Dashboard. The ''Configuration'' page opens.

2.&nbsp;'''Click''' ''Rule'''''&nbsp;'''on the ''Configuration'' page. The ''Rules'' page opens.

3.&nbsp;'''Click''' ''Create Rule'''''&nbsp;'''On the ''Rules'' page. The ''Create Rule'' page opens.

The ''Create Rule'' page consists of following&nbsp;&nbsp;tabs:

*Setup 
*Build 
*Summary 

Let us understand each tab one by one.

=== Setup ===

1.&nbsp;'''Select''' the Contract Type for which you want to create a Rule in the ''Contract Type'' list.

2.&nbsp;'''Type''' a name of the rule in the ''Rule Name'' box.

3.&nbsp;'''Type''' a description for the rule in the ''Rule Description'' box.

4.&nbsp;'''Select''' the type of the rule in the ''Rule Type&nbsp;''from the ''Rule Type'' list.&nbsp;

For each type of a Rule, you need to select an approver role from the drop-down options.

*Approval Rule&nbsp;: To build a Rule that defines the conditions in which a specific user will be the approver for the Agreement. 

:If you select the Rule Type as ''Approval Rule'', the ''Team Role'' field appears.&nbsp;You can configure multiple approval rule sets, thus enabling greater flexibility in creating approval rules<br/> '''Select''' the ''appropriate role of an approver'' from the following list of team roles: 

*Approver 
*Deviation Approver 
*External Signatory 
*Internal Signatory 
*Reviewer 

*Clause Assembly: To build&nbsp;a Rule that defines the conditions in which a specific clause will appear in an Agreement. 
*Contract Type Selection: To build&nbsp;a Rule that defines the conditions in which a specific contract type will be selected while creating an Agreement. 
*Dynamic Association: To build a Rule that defines the conditions in which a specific Agreement/Associated Document will be selected while creating an Agreement. 
*Dynamic Attribute: To build&nbsp;a Rule that defines the conditions in which a specific attribute will appear while creating an Agreement. 
*Set Attribute Value: Define the value of the attribute. 
*Template Selection: To build&nbsp;a Rule that defines the conditions in which a specific template will be selected while creating an Agreement. 
<div class="note-box">'''Note''':&nbsp;The types of rules that appear in the list vary according to the type of the contract you select in the ''Contract Type'' list.</div> 
5.&nbsp;'''Click''' ''Next''. The ''Build'' tab opens.

=== Build ===

The Build tab has the following two panes:

*Builder: You can add a Rule in this pane. 
*Validate: You can type the information that is used to validate the Rule you create. 

'''Builder'''<br/> To add a Rule:

1.&nbsp;'''Click''' ''Add Rule''.

2. Under Conditions, '''select''' the appropriate condition:

:
:*And: All the conditions have to be fulfilled to satisfy the rule. 
:*Or: One of the conditions have to be fulfilled to satisfy the rule.   

3. Next to [[File:Rule min.jpg|RTENOTITLE]], in the''Select Value'' field select the appropriate attribute from the list provided:

:
:*Parent Contract Type 
:*Priority 
:*Priority Inheritance 
:*Simba Reference ID 
:*Status 
:*Status Changed Date 
:*Template Name 
:*Type Of Paper   

&nbsp;4. Based on the attribute you have selected, select appropriate value in the very next ''Select Value'' field from the list provided:

:
:*Contains 
:*Equals 
:*Not Equals 
:*Starts With 
:*Has No Value:&nbsp;the Rule is satisfied when no value is selected for the attribute. For example, if the ''Contract value'' is 0, then the Agreement is automatically put on hold (or cancelled). 
:*Has A Value:&nbsp;the Rule is satisfied as long as the attribute has some value. For example, if the ''Contract Value'' is 1, 25,000 or 30,000,000, the Finance Approver gets added to the Agreement workflow 
:*Not Contain:&nbsp;the Rule is satisfied when the value of an attribute is blank. For example, if the ''City'' value is blank, a Rule will be triggered, which will default the name of the city to the city of the head office.   

Once selected, '''enter''' an appropriate value in the ''Enter Value'' field.

5.&nbsp;'''Click''' [[File:Add icon.jpeg|RTENOTITLE]] to add another condition.

6.&nbsp;'''Click''' {} to add another group of conditions. When you add a group, all the conditions in the group should be fulfilled to satisfy the rule.

7. Under ''Actions'', in the ''Select Action'' list, select from the list actions.

:For example: 
:*Require Approval From All 
:*Require Approval From Any 
:*Select User From Attribute   

8.&nbsp;'''Select''' actions consequent to the conditions you have set, and then enter their value. For example, under ''Conditions'', if you select ''Created By Equals x User'', then under ''Actions'' you may select ''Require Approval From Any'', and then type appropriate value. that is if the user x creates an Agreement using the selected Contract Type, then it will require approval from any of the selected approvers.

9.&nbsp;'''Type''' the number of approvers required in the ''MinimumApprovers'' text box, and then '''type''' appropriate ''Step Number'' for those Approvers. The Agreement approval process flows sequentially according to the ''Step Number'' of the approver. When Approvers are defined based on the user attribute, the Administrator can specify a minimum number of approvals required for an Agreement before it can move to the next step in the workflow. As a result, not all Approvers configured for the specific user attribute are required&nbsp;to approve the Agreement.
<div class="image-green-border">[[File:Creating a Rule Create Rule page 7.8.PNG|1050px|RTENOTITLE]]<br/> &nbsp;</div> 
=== Validate ===

Based on the ''Contract Type'' you select in the ''Setup'' section, relevant attributes appear in the ''Validate'' pane. The information you type in this pane validates the Rule that you create.

'''Click''' ''Next''. The ''Summary'' tab opens.

=== Summary ===

Verify the summary of the rule, and then '''click&nbsp;'''''Create''.&nbsp;

The ''Rule created successfully''&nbsp;message appears. The Rule appears in the Rule&nbsp;list of the specific Contract Type.
<div class="note-box">'''Note''': For mutually exclusive rules, you now have an option to stop processing subsequent rules.</div> 
=== Creating Count Based Rules ===

ICM allows you to set the Rules based on the total number of selected values (count of selected values) in multi-select type Attributes.

For example, for an attribute ''Country Name'', if the user selects more than two countries i.e. ''Count is Greater Than 2'', then the Agreement can be sent for approval to the selected users.

The supported operators are:&nbsp;''Equals'', Greater''Than'', ''Greater Than or Equals'', ''Less Than'', ''Less Than or Equals'', and ''Not Equals''.
<div class="image-green-border">[[File:Count based rules 1.png|RTENOTITLE]]</div> 
&nbsp;
<div class="image-green-border">[[File:Count based rule 2.png|RTENOTITLE]]</div> 
== Using Masterdata Value options in Rules Actions ==

You can define Rules&nbsp;based on the Masterdata in the following ways:

*You can define Rules on Masterdata columns when lookup to the Masterdata is added as an Agreement Attribute. You can configure the list of Lookup and/or Cascade Attributes as conditions for Agreement or Contract Request Contract Types Rules, thus improving flexibility in Rules. For example, you may have a supplier Masterdata being referred in MSA Agreement Type via Supplier Country Name lookup. But, there may be scenarios where Rules are required to be configured on basis of Supplier City Name and is not available as an Attribute in the Agreement, which is now made possible. 
*ICM also supports Masterdata value options in the''Actions'' section of Rules, so that you can define Rules without having the Cascade Attribute on the Contract Type where the Rule is being written. For example, if multiple signatories are part of a Lookup Masterdata record, we can now define the Rule (such as – ''Select User From Attribute'') on the Masterdata record itself and use them in the Rule directly, instead of defining Cascade Lookup Attributes in the Agreement. This drastically reduces the time and effort to create and maintain a large number of Attributes for Agreement Contract Types. 
<div class="image-green-border">[[File:SP7 Masterdata Value Options in Rules Actions.PNG|SP7 Masterdata Value Options in Rules Actions]]</div> 
=== Create Rules for Multi-party Agreements ===

Rules can be written for individual attributes of an Association (as done for parent Contract Types). All attributes for Associations are available for the given Rule conditions. You can search selected values on an Agreement or an Associated Document.&nbsp;Depending on the type of the attribute, standard operators are applicable. For example, ''Contains, Starts With, Equals, Greater Than'', and so on.

Rules can also accommodate the count of the Associations so that you can add Clauses based on the count of the Associations. If you ''Select All'' or ''Select Any'', there is no need to specify the count of the Associations to satisfy the rule. However, when selecting the option ''Select Count'', you need to specify the number of Associations, irrespective of the attribute value, that should meet the condition and satisfy the Rule. This rule applies to any type of Association, parent/child or peer.

However, if the attribute belongs to an Association, the following additional filter Conditions are available for all the Rules:

*''Select All'':&nbsp;If all the Associations satisfy the condition 
*''Select Any'':&nbsp;If any Association satisfies the condition 
*''Select Count'': If the number of Associations specified&nbsp;satisfy the condition 
<div class="image-green-border">[[File:Multiparty-Rules1.PNG|Multiparty Rules]]</div> 
For a multi-division Agreement, you can write&nbsp;Rules based on individual instances of the multi-value attributes.

Rules can accommodate the count of the Associations, besides ''Select All'' and ''Select Any ''Conditions.&nbsp;If you ''Select All'' or ''Select Any'', there is no need to specify the count of the Associations to satisfy the Rule. However, when you ''Select Count'', then you need to specify the number of Associations, irrespective of the attribute value, that should meet the condition and satisfy the Rule.
<div class="image-green-border">[[File:Multiparty-Rules2.PNG|Multiparty Rules - Select Count]]</div> 
If you have more than two Associations, the values of the attributes are irrelevant. The count of the Association takes precedence.

== Changes in Document Assembly&nbsp;will replace tags with Metadata value ==

When Rules are written based on the Attributes of the Association, the Rules support tagging of the Metadata that belongs to the Association. The Associations may either be parent-child or peer. After the content control tag is entered, the value of the associated instances’ metadata is placed in the content control as shown in the example below.

'''Example:'''

1. The saved search for the Agreement is sorted based on the Agreement Code.

2. After the content control tag is entered, the value of the associated instances metadata is placed in the content control.

3. If the value taken from the Agreement above was ''Acme Inc''. for the first instance, then it will be displayed as shown in the figure after Edit or Publish.

&nbsp;
<div class="image-green-border">[[File:Rules - Changes in Document Assembly.png|Create a Rule - Changes in Document Assembly will replace tags with metadata value]]</div> 
== View or Edit a Rule ==

In ICM, you can View, Edit, Copy, Activate, Deactivate, or Lock a Rule. Follow these steps to&nbsp;View or Edit a Rule:

1.&nbsp;'''Click '''the ''Configuration ''tile''&nbsp;''on My Dashboard'''.&nbsp;'''

2. '''C''''''lick''' ''Rule. ''The&nbsp;''Rules'' page opens.

3.&nbsp;'''Select''' the appropriate Contract Type from&nbsp;the ''Select Contract Type''&nbsp;drop-down.&nbsp;A list of Rules that are created for the selected Contract Type appear. You can use the filters provided in each column to find the desired Rule.

4.&nbsp;'''Select''' the check box next to the Rule name, and then '''click''' ''Delete''&nbsp;to delete the Rule.
<div class="image-green-border">[[File:Rule Index page.PNG|RTENOTITLE]]<br/> &nbsp;</div> 
Choose one of the following icons:

*[[File:Activate icon 7.8.PNG|20x20px|Activate icon 7.8.PNG]]&nbsp;:&nbsp;'''Click''' to activate the selected Rule.The Rule will no more be applicable to the associated Contract Type. *&nbsp;[[File:Deactivate icon 7.8.PNG|20x20px|Deactivate icon 7.8.PNG]]&nbsp;:'''Click''' to deactivate the selected Rule.The Rule will be applicable to the associated Contract Type. *[[File:Pencil edit.jpg|20x20px|Edit icon]]:&nbsp;'''Click'''&nbsp;to edit the selected Rule. On the&nbsp;''Edit Rule''&nbsp;page, edit appropriate information. and '''click '''''Update''. 

*Editing the Rule automatically locks it. *When updating the Rule,&nbsp;there is a checkbox option (default – unchecked) on the ''Edit Rule'' page, indicating that the Rule will be unlocked on update. If checked, the Rule stays locked for the other users. *[[File:Copy icon.jpg|20x20px|copy icon]]:&nbsp;&nbsp;'''Click'''&nbsp;to copy the selected Rule for another Contract Type.&nbsp;In the&nbsp;''Copy Rule''&nbsp;dialog box, '''select'''&nbsp;Contract Type, '''type''' the Rule name, and then&nbsp;'''click'''&nbsp;''Copy''. The Rule becomes applicable for another Contract Type that you selected. *[[File:Eyeball.png|20x20px|View icon]]:&nbsp;&nbsp;'''Click'''&nbsp;to view the details of the selected Rule.&nbsp;The&nbsp;''Rule Summary''&nbsp;page appears where you can view the Rule details of the selected Rule. *[[File:Audit log.png|20x20px|Audit log icon]]&nbsp;:&nbsp; '''Click''' to view the ''Audit Logs ''of the Rule.&nbsp;''Audit Logs'' screen&nbsp;contains the complete history of the specific Rule. Here, you can track all the changes made to the Rules, including the deletion. Editing a&nbsp;rule set inside a Rule creates a hyperlink ''Hide/Show All Changes''&nbsp;next to that log.&nbsp;'''Click''' the hyperlink to see the ''Old ''and ''New'' values. *[[File:Lock Icon.PNG|23x23px|Lock Icon]]: This icon indicates that the Ruleset is available for editing.&nbsp;'''Click '''to lock a Rule or a Ruleset, so that other users can not edit the Rule until you unlock it.&nbsp; *[[File:Unlock icon.PNG|20x20px|Unlock icon]]: This icon indicates that the Ruleset is locked.&nbsp;When a user hovers over the icon the name of the user who has locked the Rule is displayed. 
<div class="image-green-border">[[File:Edit rule page.png|RTENOTITLE]]</div> 
== Create a Contract Type Selection Rule ==

When you are creating an Agreement from a Contract Request, the Contract Type Selection rule defines which Contract Type should be selected'''.'''

With ICM, you can create Rules for Contract Types. You can create various types of Rules only for the published Contract Types.

To create a Contract Type Selection Rule:

1.&nbsp;'''Click''' ''Configuration'''''&nbsp;'''on &nbsp;''My Dashboard''. The ''Attributes'' page opens.

2.&nbsp;'''Click''' ''Rule''. The ''Rules'' page opens.

3.&nbsp;'''Click''' ''Create Rule''. The ''Create Rule'' page opens.

The ''Create Rule'' page consists of following tabs:

*Setup 
*Build 
*Summary 

Let us understand each tab one by one.

=== Setup<br/> &nbsp; ===
<div class="image-green-border">[[File:Create Rule - Setup - Contract Selection Rule.png|RTENOTITLE]]<br/> &nbsp;</div> 
1.'''Select''' the Contract Type for which you want to create a Rule in the ''Contract Type'' list.

2.'''Type''' a name of the Rule in the ''Rule Name'' box.

3.'''Type''' a description for the Rule in the ''Rule Description'' box.

4.&nbsp;'''Select''' ''Contract Type Selection'''''&nbsp;'''in the ''Rule Type'' list.
<div class="note-box">'''Note''': The types of Rules that appear in the list vary according to the type of Contract you select in the&nbsp;''Contract Type&nbsp;''list.&nbsp;</div> 
5.&nbsp;'''Click''' ''Next''. The ''Build'' tab opens.

=== Build ===

&nbsp;
<div class="image-green-border">[[File:Create Rule-Contract Type Selection Rule - Build.png|RTENOTITLE]]<br/> &nbsp;</div> 
The Build tab has the following&nbsp; panes:

*Builder: You can add a rule in this pane. 
*Validate: You can type the information that is used to validate the rule you create. 

Builder<br/> To add a Rule:

1.'''Click''' ''Add Rule''.

2. Under ''Conditions'', select from the following options:

*And: All the conditions have to fulfilled to satisfy the Rule. 
*Or: One of the conditions have to be fulfilled to satisfy the Rule. 

&nbsp;3. In the ''Select Value'' drop-down list next to [[File:Rule min.jpg|RTENOTITLE]], select an attribute. Based on the attribute you have selected, select appropriate value. For example, you have selected ''Created By'' as an attribute, you have to select from ''Equals'' and ''Not Equals''. Then, type the appropriate value in the text box say Mr. Someone.

4.&nbsp;'''Click''' [[File:Add icon.jpeg|RTENOTITLE]] to add another condition.

5.&nbsp;'''Click''' [[File:Rl grp.jpg|RTENOTITLE]] to add another group of conditions. When you add a group, all the conditions in the group should be fulfilled to satisfy the Rule.

'''Click''' [[File:Select temprl.jpg|RTENOTITLE]] next to ''Select Contract Type'''''&nbsp;'''under ''Actions'' to select the Contract Type that you want to be selected by default (while creating a contract/agreement from request),&nbsp;that is if a request is Created By Mr. Someone, then while creating a Contract/Agreement from the request, the given Contract Type will be selected by default.

'''Validate'''

Based on the Contract Type you select in the ''Setup'' tab, relevant attributes appear in the ''Validate'' pane. The information you type in this pane validates the Rule that you create.

'''Click''' ''Next''. The ''Summary'' tab opens.<br/> '''Summary'''

Verify the summary of the Rule, and then '''click''' ''Create''. The ''Rule created successfully'' message appears.<br/> The Rule appears in the Rule list of the specific Contract Type.

= Create a Template Selection Rule =

You can select Templates to use them in the agreement creation process. Using Template Selection Rules, you can specify which Templates should appear under specific conditions. The Templates appear in the&nbsp;''Templates''&nbsp;tab in the Agreement Creation process.

You can&nbsp;create multiple sets of Template Selection Rules allowing you to manage similar Rules with ease.

To create a Template Selection Rule:

#'''Click''' ''Configuration'''''&nbsp;'''on [[My_Dashboard|My Dashboard]].&nbsp; 
#'''Click''' ''Rule''. The ''Rules'' page opens. 
#'''Click''' ''Create Rule''. The ''Create Rule'' page opens. 

The Create Rule page consists of the following&nbsp;tabs:

*Setup 
*Build 
*Summary 

=== '''1. Setup''' ===

#&nbsp;'''Select''' the Contract Type for which you want to create a Rule from the ''Contract Type'' list. 
#&nbsp;'''Type''' a name of the Rule in the ''Rule Name'' box.&nbsp;It must be a unique name. Two Rules or Rulesets cannot have the same name. 
#&nbsp;'''Type''' a description for the Rule in the ''Rule Description'' box. 
#&nbsp;'''Select''' ''Template Selection'''''&nbsp;'''in the ''Rule Type'' list. 
#&nbsp;'''Click''' ''Next''&nbsp;to go to the&nbsp;''Build'' tab. 

=== '''2. Build''' ===
<div class="image-green-border"><br/> The ''Build'' tab has the following tabs:</div> 
*&nbsp;Builder&nbsp;: You can add a Rule here. 
*Validate&nbsp;: You can type the information that is used to validate the Rule you create. 

Builder

#'''Click''' ''Add Rule''. 
#Under ''Conditions'', select from the following&nbsp;: 
<ul style="margin-left: 40px;">
<li>''And'': All the conditions have to be fulfilled to satisfy the Rule.</li>
<li>''Or'': One of the conditions have to be fulfilled to satisfy the Rule.</li>
</ul>
<ol start="3">
<li>In the ''Select Value'' drop-down list next to [[File:Rule min.jpg|RTENOTITLE]], select a condition. Based on the condition you have selected, select the subsequent effect in the next drop-down list. For example, you have selected ''Contract Type Name'', then you can select from ''Contains'', ''Equals'', ''Not Equals'', and ''Starts With''. Then, '''type''' the appropriate value in the text box say (name of the Contract Type).</li>
<li>'''Click''' [[File:Add icon.jpeg|RTENOTITLE]] to add another condition.</li>
<li>'''Click''' [[File:Rl grp.jpg|RTENOTITLE]] to add a group of conditions. When you add a group, all the conditions in the group should be fulfilled to satisfy the Rule.</li>
<li>Under ''Actions'', in the ''Select Action'' list, '''click''' ''Select Template'', and then '''click''' [[File:Select temprl.jpg|RTENOTITLE]] to select appropriate template. '''Click''' ''Select Template By Condition'' under ''Actions'' to select a Template based on certain metadata such as, Created By, Created On, and Effective From.</li>
<li>The ''Stop Processing More Rules'' option within a Ruleset allows you to stop evaluating further Rules for the Ruleset, if you select ''Yes'' for this option.</li>
</ol>
<div class="image-green-border">[[File:Template Selection Rule 1.PNG|RTENOTITLE]]&nbsp;</div> 
&nbsp;
<div class="note-box">Note:&nbsp;Once multiple Template Selection Rules are defined, ICM executes these Rules sequentially.</div> 
Validate

'''Click&nbsp;'''the ''Validate ''tab. Based on the Contract Type you select in the&nbsp;''Setup''&nbsp;tab, relevant attributes appear in this tab. You can type information that is relevant to the Rule(s) you just specified.

'''Click '''the ''Validate'' button to validate the Rule that you created. You can also&nbsp;see the preview of the selected Template and Template Variables values provided in the&nbsp;''Validation''&nbsp;tab.
<div class="image-green-border">[[File:Template Selection Rule Validate tab.PNG|RTENOTITLE]]<br/> '''Click''' ''Next''. The ''Summary'' tab opens.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:Template Selection Rule summary tab.PNG|RTENOTITLE]]</div> 
=== '''3. Summary''' ===

Verify the summary of the Rule, and then '''click''' ''Create''. The ''Rule created successfully''&nbsp;message appears.<br/> The Rule appears in the list of Rules of the specific Contract Type.

&nbsp;

&nbsp;

&nbsp;

&nbsp;

&nbsp;

&nbsp;

&nbsp;

&nbsp;

&nbsp;

&nbsp;

&nbsp;

&nbsp;