Attribute[edit]



= Attribute =

Attributes or metadata are the key components of an Agreement. Attribute data is displayed&nbsp;on contracts and associated documents.

Attributes are of two types:

*Global: These Attributes are used for all Contract Types. 
*Local: These Attributes are used for specific Contract Types. 

To view available Attributes:

1.&nbsp;'''Click''' ''Home >&nbsp;''''Configuration'' . The ''Atrributes''&nbsp;page opens. On this page you can view a list of all the available attributes, Edit, or Add Attributes.
<div class="image-green-border">[[File:Attribute Page.PNG|720px|RTENOTITLE]]</div> 
== Adding and Editing an Attribute ==

With ICM, you can create an attribute and use it while creating a Contract Type.

To create an attribute:

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

2.&nbsp;'''Click'''&nbsp;the&nbsp;''Attribute ''tile.

3.&nbsp;'''Click'''&nbsp;the&nbsp;''Add ''icon on the ''Attribute'' Library page. The ''Add Attribute'' page opens. The Attribute Code is displayed by default.
<div class="image-green-border">[[File:Add Attribute.jpg|720px|RTENOTITLE]]</div> 
*Display Name:&nbsp;'''Type&nbsp;'''the appropriate name of the attribute. For example, corporate office.&nbsp; 
*Data Type list:&nbsp;'''Select&nbsp;'''the appropriate option from the list.&nbsp; 
*Help Message:&nbsp;'''Type&nbsp;'''the appropriate help message of the attribute. For example, enter the address of the corporate office.&nbsp; 
*Source List:&nbsp;'''Select&nbsp;'''from the following:&nbsp; 
**User 
**Integrated 
**Script&nbsp;   

For example,&nbsp;'''select&nbsp;'''''Integrated&nbsp;''if source is inherited.&nbsp;
<div class="note-box">'''Note''': If you select the source as Integrated: ''Is Editable, Is Mandatory, Defined By Rule, Is Inherit ''and''Is Conditional'' fields become unavailable.&nbsp;</div> 
*Default Value:&nbsp;'''Type'''&nbsp;the default value of the attribute. The value that you type will be displayed on creating a&nbsp;new agreement. 
*Is Default:&nbsp;'''Click'''&nbsp;''On''&nbsp;to enable rules to be set on the attribute. 
*Is Editable:&nbsp;'''Click'''&nbsp;''On''&nbsp;to make the attribute editable in the Agreement, else&nbsp;'''select'''&nbsp;''Off''. 
<div class="note-box">&nbsp;'''Note''':&nbsp;If you select&nbsp;''On''&nbsp;in the&nbsp;''Is Editable&nbsp;''field''', '''the&nbsp;''Tracking Attribute''&nbsp;and the&nbsp;''Is Unique''&nbsp;fields are available.</div> 
*Is Mandatory:&nbsp;'''Click'''&nbsp;''On''&nbsp;to make the attribute mandatory. 
*Tracking Attribute:&nbsp;'''Click&nbsp;'''''On''&nbsp;to make the attribute editable throughout the Agreement lifecycle. 
*Is Unique:&nbsp;'''Click'''&nbsp;''On''&nbsp;to make the attribute unique for a Contract Type. 
*Defined by Rule:&nbsp;'''Click'''&nbsp;''On''&nbsp;to make the attribute editable throughout the Agreement lifecycle. 
*Is Inherit:&nbsp;'''Click'''&nbsp;''On''&nbsp;if you want the attribute to inherit the data from Associated Documents. 
*Is Searchable:&nbsp;'''Click'''&nbsp;''On''&nbsp;to make the attribute easy to search. 
*Is Supersedable:&nbsp;'''Click&nbsp;'''''On&nbsp;''to make the updated or amended attribute supersede the earlier one.&nbsp; 
*Is Conditional:&nbsp;'''Click'''&nbsp;''On''&nbsp;to make the attribute dependent on another attribute. The ''Conditional ''section opens. In the&nbsp;''Depend on Attribute''&nbsp;list, select the attribute on which the new attribute is dependent. In the&nbsp;''Depends On Value''&nbsp;box, type the value of the selected attribute.&nbsp;'''Select '''the values from the ''Depends on Value ''field which are automatically fetched based on the attribute selected in ''Depends On Attribute'' field, if the data type of that attribute is Lookup, Choice, MultiChoice, or Boolean. 
<div class="image-green-border">[[File:SP7 Conditional Attributes & Rules 1.png|720px|SP7 Conditional Attributes & Rules 1]]</div> 
&nbsp;
<div class="image-green-border">[[File:SP7 Conditional Attributes & Rules 2.png|720px|SP7 Conditional Attributes & Rules 2]]</div> 
4. '''Click''' ''Save''. The attribute&nbsp;is displayed in the ''Available Attribute'' list.
<div class="image-green-border">[[File:AttributeCreationSuccessful.jpg|720px|RTENOTITLE]]<br/> &nbsp;</div> 
=== Editing an Attribute ===

In ICM, you can edit an existing attribute. Editing the attribute doesn't have any effect on the Contract Types where it is used.<br/> You can use the edited attribute to create new contract types. &nbsp;

'''Note:&nbsp;'''To edit an attribute in all the entities where it is used (Clauses, Templates, Agreements), go to the ''Attributes''&nbsp;tab of appropriate Contract Type, edit the attribute, and then publish it.

To edit an attribute:

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

2. '''Click''' ''Attribute&nbsp;&nbsp;''on the ''Configuration'' page. In the ''Available Attribute'' list, select an attribute that you want to edit.

Alternatively, you can type the name of the attribute in the ''Search'' box, and then '''select''' the attribute. The ''Edit Attribute'' page opens.

3. Modify the existing information as required, and then '''click''' ''Save''. The ''Success! Attribute updated successfully''&nbsp;message is displayed at the bottom of the page. You can modify all the field values except attribute code and attribute name.

== Arithmetic Operations and Logical Validations on Attributes ==

=== Configuring Arithmetic Operations&nbsp; ===

To configure arithmetic calculations and logical validations for attributes at the contract type level (agreement, contract request, association and masterdata):

1.&nbsp;'''Click&nbsp;'''the&nbsp;''Configuration&nbsp;''tile on the Dashboard. The&nbsp;''Configuration&nbsp;''page opens.&nbsp;
<div class="image-green-border">[[File:7.10 Arithmatic 1.png|720px|7.10 Arithmatic 1.png]]</div> 
2.&nbsp;'''Click&nbsp;'''''Create Contract Type&nbsp;''tile. The&nbsp;''Create Contract Type&nbsp;''page opens.&nbsp;
<div class="image-green-border">[[File:7.10 Arithmatic 2.png|360px|7.10 Arithmatic 2.png]]</div> 
3.&nbsp;'''Select&nbsp;'''the agreement contract type you want to create.&nbsp;
<div class="image-green-border">[[File:7.10 Arithmatic 3.png|720px|7.10 Arithmatic 3.png]]</div> 
4.&nbsp;'''Click&nbsp;'''''Next.&nbsp;''The&nbsp;''Create Contract Type&nbsp;''page opens.&nbsp;<br/> 5.&nbsp;'''Enter&nbsp;'''a name in the&nbsp;''Contract Type Name&nbsp;''field.&nbsp;<br/> 6.&nbsp;'''Enter&nbsp;'''all the details on the&nbsp;''Details&nbsp;''tab.&nbsp;<br/> 7.&nbsp;'''Click&nbsp;'''''Next.&nbsp;''The&nbsp;''Attributes&nbsp;''tab opens.&nbsp;
<div class="note-box">'''Note''':&nbsp;The arithmetic calculations are supported for attributes like Currency, Date, Number and Percentage data types.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.10 Arithmatic 4.png|720px|7.10 Arithmatic 4.png]]</div> 
For example, if you want to calculate the ''Total Price'' of a commodity, you need to multiply the attribute values in the fields ''Product Price'' and ''No Of Units''. You can also set validation messages on its outcome so that the ''Total Price'' value must be greater than 100.

8.&nbsp;'''Select '''the attribute ''Total Price ''from the ''Available Attribute ''list and move it to the ''Selected Attribute'' list.<br/> 9.&nbsp;'''Toggle''' the ''Enable Expressions'' flag ''On'' for the attribute Total Price. The ''Expressions'' tab opens.&nbsp;

Calculations are performed through the default expression field denoted as ''EXPR1''.&nbsp;

'''Note''': The ''Expression'' field&nbsp;cannot be removed. The new expression can be added or removed by ''NEW ROW'' and ''REMOVE ROW'' buttons. Each expression such as ''EXPR1, EXPR2, EXPR3, ''and so on contains ''Function ''and ''Parameters ''fields. Based on arithmetic and logical operators selected through the ''Function ''field, parameters are set in the ''Parameters ''field.

10. '''Select''' an expression (for example, ''MULTIPLY'') from the ''Function'' drop-down of ''EXPR1''.&nbsp;<br/> 11.&nbsp;'''Select''' ''Product Price'' and ''No Of Units'' from the Parameters field to multiply product price and no of units attribute values to get the total price.<br/> 12.&nbsp;'''Click''' ''NEW ROW'' to add a new expression. For example, ''EXPR2 ''and ''EXPR3''.<br/> 13.&nbsp;'''Select''' a Function (for example, ''CONSTANT'') from the ''Function'' drop-down of ''EXPR2'' if you want that to be a constant value.<br/> 14.&nbsp;'''Enter''' a value (for example, 100) in the Parameters field to set the value of ''Total Price''. A validation message will be displayed if this value is greater than the total price.<br/> 15. '''Select''' another function (''GREATER THAN'') from the ''Function ''drop-down of ''EXPR3''.<br/> 16.&nbsp;'''Select''' ''Total Price'' and ''EXPR2 ''in the ''Parameters ''drop-down of ''EXPR3''.<br/> The ''Result Expression'' field is used to reflect the result of the selected expression field (''EXPR1, EXPR2, EXPR3,'' and so on).&nbsp;

The ''Validate Expression'' field is used to validate the evaluation based on the selected expression (''EXPR1, EXPR2, EXPR3,'' and so on). The ''Validate Message'' field is linked to the ''Validate Expression'' field and triggers a user-entered message in case of an invalid expression.
<div class="image-green-border">17.&nbsp;'''Select''' ''EXPR1 ''in the Result Expression drop-down.<br/> 18.&nbsp;'''Select''' ''EXPR3'' in the Validate Expression drop-down.<br/> 19.&nbsp;'''Enter''' ''Total price'' ''must be greater than 100'' in the ''Validate Message ''field.<br/> 20.&nbsp;'''Click''' ''Save''.<br/> <br/> [[File:7.10 Arithmatic 5.png|720px|7.10 Arithmatic 5.png]]<br/> &nbsp;</div> <div class="note-box">'''Note''': Arithmetic calculations and logical validations for attribute values are supported at the following contract type levels: agreement, contract request, associated document, and masterdata.</div> <div class="image-green-border">21.&nbsp;'''Enter''' the details in the remaining tabs (''Association'', ''Display Preference'', ''Team'' and ''Verify'') to move the contract type to the ''Approved'' state.&nbsp;<br/> 22. '''Click''' ''Publish'' on the ''Contract Type Details'' page to publish the agreement contract type.<br/> <br/> [[File:7.10 Arithmatic 6.png|720px|7.10 Arithmatic 6.png]]</div> 
== Arithmetic Operations Evaluation at Agreement level ==

1. '''Click''' the ''Agreement Management'' tile on the ''Dashboard''. The ''Agreement Management'' page opens.&nbsp;<br/> 2. '''Click''' the ''Create Agreement'' tab. The ''Create Agreement'' page opens.<br/> 3.&nbsp;'''Enter '''all the details in the ''Create Agreement'' page.<br/> 4.&nbsp;'''Enter''' a name in the ''Contract Type Name'' field.<br/> 5.&nbsp;'''Select''' ''Own'' in the Type Of Paper drop-down.&nbsp;<br/> 6.&nbsp;'''Click''' ''Next''. The ''Attributes'' tab opens.<br/> 7.&nbsp;'''Enter''' the value in the attribute ''Product Price''. For example, 9.<br/> 8.&nbsp;'''Enter''' the value in the attribute ''No Of Units''. For example, 10. ''Total Price'' is calculated as 90 by multiplying the ''Product Price'' (9) and ''No Of Units'' (10).
<div class="image-green-border">Since the ''Total Price'' is less than 100, a validation message will be displayed indicating that ''Total Price'' must be greater than 100.<br/> <br/> [[File:7.10 Arithmatic 7.png|720px|7.10 Arithmatic 7.png]]<br/> &nbsp;</div> 
=== Configuring Event Rule for Reverse-sync in Word Add-in ===

You need to create an event rule to evaluate the Arithmetic calculation, where users have made changes in the tagged attribute value of the document. For example, the following steps help you to set an event rule at the agreement document upload level.

'''Creating an Event Rule'''
<div class="image-green-border">1. '''Click''' ''Configuration'' tile on the ''Dashboard''. The ''Attributes'' page opens.<br/> 2.&nbsp;'''Click''' ''Rule''. The ''Rules'' page opens.<br/> 3.&nbsp;'''Click''' ''Create Rule''. The ''Create Rule'' page opens.<br/> <br/> [[File:7.10 Arithmatic 8.png|720px|7.10 Arithmatic 8.png]]</div> 
4.&nbsp;'''Select''' the ''Contract Type'' for which you want to create a rule in the ''Contract Type'' list. For example, ''Purchase Agreement''.<br/> 5.&nbsp;'''Enter''' a name of the Rule in the ''Rule Name'' field.&nbsp;<br/> 6.&nbsp;'''Enter''' a description for the Rule in the ''Rule Description'' box.<br/> 7.&nbsp;'''Select''' the ''Event Rule'' in the ''Rule Type'' drop-down.&nbsp;<br/> 8.&nbsp;'''Select''' an appropriate category in the ''Event ''drop-down. For example, ''Agreement Document Uploaded''.&nbsp;<br/> 9.&nbsp;'''Click''' ''Next''. The ''Build'' tab opens.<br/> 10.'''Click''' ''Add Rule'' in the ''Builder'' tab.<br/> 11. '''Select''' ''And'' from the ''Conditions'' drop-down.&nbsp;<br/> 12.&nbsp;'''Select''' an appropriate attribute value in the ''S''''elect Value'''''<b>drop-down. For example, ''Created Date''.<br/> 13.&nbsp;</b>Select'''an appropriate attribute value in the ''Select Value'' drop-down. For example, ''Is After''.<br/> 14.&nbsp;'''Enter'''a value in the ''Enter Value'' field. For example, ''01-Nov-19''.<br/> 15.&nbsp;'''Select'''''Calculate Expression'' in the ''Select Action'' drop-down in the Actions tab.<br/> 16.&nbsp;'''Click'''''Next''.&nbsp;<br/> 17.&nbsp;'''Click'''''Create''.'''
<div class="image-green-border">[[File:7.10 Arithmatic 9.png|720px|7.10 Arithmatic 9.png]]</div> 
The event rule gets triggered to calculate the value that will be displayed in the ''Expression ''section of the Contract Type ''Purchase Agreement'' when the ''Created Date'' is after ''1-Nov-19''.

== Arithmetic Operations Evaluation through Reverse Sync in Word Add-in ==

1. '''Click''' the ''Agreement Management'' tile on the ''Dashboard''. The ''Agreement Management'' page opens.&nbsp;<br/> 2.&nbsp;'''Click''' the ''Create Agreement'' tab. The ''Create Agreement'' page opens.<br/> 3.&nbsp;'''Enter''' all the details on the ''Create Agreement'' page.<br/> 4.&nbsp;'''Select''' ''Purchase Agreement'' for Contract Type Name.<br/> 5.&nbsp;'''Select''' ''Own'' in the ''Type Of Paper'' drop-down.&nbsp;<br/> 6.&nbsp;'''Click''' ''Next''. The ''Attributes'' tab opens.<br/> 7.&nbsp;'''Enter''' the value in the attribute ''Unit Price''. For example, ''2''.<br/> 8.&nbsp;'''Enter''' the value in the attribute ''No Of Units''. For example, 100. ''Total Price'' is calculated as 200, by multiplying the ''Unit Price'' and ''No Of Units'' as per the Contract&nbsp;Type configuration.<br/> 9.&nbsp;'''Select''' a date in the Effective Date field. For example, ''1-Nov-19''.<br/> 10. '''Enter''' ''Duration In Days''. For example, ''2''.<br/> 11.&nbsp;The ''Expiry date'' is calculated as per contract type configuration. For example, ''4-Nov-19''.<br/> 12.&nbsp;'''Click''' ''Next''. The ''Select Template'' page opens.<br/> 13.&nbsp;'''Select''' a template. For example, ''Purchase Template''.<br/> 14.&nbsp;'''Click''' ''Next''.&nbsp;<br/> 15. '''Click''' ''Create and Publish''. The ''Purchase Agreement'' state becomes ''Draft''.
<div class="image-green-border">[[File:7.10 Arithmatic 10.png|720px|7.10 Arithmatic 10.png]]<br/> <br/> 16.&nbsp;'''Click''' ''Download''. The ''Purchase Agreement'' gets downloaded.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.10 Arithmatic 11.png|720px|7.10 Arithmatic 11.png]]</div> 
Now, change the tagged attribute values of ''No of Units'' to ''3'' and ''Effective Date'' to ''03-Nov-19''.

17.&nbsp;'''Click''' ''Save'' to save the Word document.
<div class="image-green-border">[[File:7.10 Arithmatic 12.png|720px|7.10 Arithmatic 12.png]]</div> 
18.&nbsp;'''Click''' the ''Select File'' to select the updated document.<br/> 19.&nbsp;'''Click''' ''Upload File''.<br/> 20.&nbsp;'''Click''' the ''Details'' tab. The attribute values of ''No Of Units'' and ''Effective Date'' are changed through reverse sync (from the Word Add-in to ICM) and also calculations are evaluated accordingly.
<div class="image-green-border">[[File:7.10 Arithmatic 13.png|720px|7.10 Arithmatic 13.png]]</div> 
21.&nbsp;'''Click''' ''Assemble Contract'' to be able to view the updated values in the document.
<div class="image-green-border">[[File:7.10 Arithmatic 14.png|720px|7.10 Arithmatic 14.png]]</div> 
&nbsp;

'''Related Topics''':&nbsp;[[Agreement_Management|Agreement Management]] |&nbsp;[[Configuration|Configuration]]&nbsp;|&nbsp;[[Contract_Type|Contract Type]]&nbsp;|[[Template_Management|Template Management]]