From ICIHelp7.15
Jump to: navigation, search
 
(70 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 +
 +
 
  
 
= Template Management =
 
= Template Management =
Line 4: Line 6:
 
Template is a framework that represents a standard layout for an Agreement. The ''Template Management'' tile enables you to manage all aspects of creating and editing Templates from a single page. From here, you can:
 
Template is a framework that represents a standard layout for an Agreement. The ''Template Management'' tile enables you to manage all aspects of creating and editing Templates from a single page. From here, you can:
  
−
*View and manage all your Templates on [[Templates|Templates]] page.  
+
*View and manage all your Templates on Templates page.  
−
*Create and upload a Template through [[Creating_a_Template|Create Template]] page.  
+
*Create and upload a Template through Create Template page.  
−
*Create Template through [[Working_with_ICM_Add-ins|Word Add-ins]].  
+
*Create Template through Word Add-ins.
 +
<div class="image-green-border">[[File:7.12 Template Management.PNG|720px|7.12 Template Management]]</div>
 +
== Templates ==
 +
 
 +
Navigate to the&nbsp;''Templates''&nbsp;page by clicking on the&nbsp;''Template Management''&nbsp;tile. This page displays all the Templates&nbsp;that you are associated with- you may have created a Template or are a&nbsp;part of the team working on it. This page displays the most current version of a Template regardless of its status.
 +
<div class="image-green-border">[[File:Templates page 1 gr action.png|720px|Templates page 1 gr action.png]]</div>
 +
From this page you can:
 +
 
 +
*search templates in a variety of ways. You can search templates from this page or use the Advanced Search.
 +
*view details of a template&nbsp;by clicking on the&nbsp;''View Record&nbsp;''icon. The details are displayed in the Template ''Details ''page.
 +
*view the template in word document format by clicking on the ''View Document&nbsp;''icon.
 +
 
 +
== Template Access Management ==
 +
 
 +
Template Access Management is now enhanced and is available through a technical configuration. When turned On, the access control for Templates is driven by the Organization Unit (OU) or the Team.&nbsp;
 +
 
 +
OU can be configured in 2 ways:
 +
 
 +
*Template access is dependent on the highest level of the OU and since everyone belongs to the OU so they have access by default, if they are part of the team.
 +
*Through a technical configuration, you now have the ability to change the access based on the OU of the user who is creating the Template. For example, if user John Doe is part of the Sales OU and the team, then Templates created by John Doe can be accessed by all users in the Sales OU and those belonging to the Template team.
 +
 
 +
Additionally, you can add members to the Template team through Event Rules, thus saving time of manually adding users to the Team. The support for the Observer role is extended to the Template Library as well through Role Action Mapping.&nbsp;
 +
<div class="note-box">Note: This feature is applicable to ICI Web UI and the .JS version of Word Add-in.&nbsp;</div>
 +
== Searching Templates ==
 +
 
 +
You can search for templates either from&nbsp;advanced search&nbsp;page or from Templates Page&nbsp;to:
 +
 
 +
*view its details
 +
*check the status
 +
*edit it
 +
 
 +
You can find a specific template you are looking for from the ''Templates'' page&nbsp;using one of these 3 methods:
 +
 
 +
*Category Search
 +
*Saved Searches
 +
*Searches pinned as Favorites
 +
<div class="image-green-border">&nbsp;</div>
 +
=== Category Search ===
 +
 
 +
Follow these steps to search for templates&nbsp;using the Category drop down:
 +
 
 +
1.&nbsp;'''Click''' the&nbsp;''Template'''&nbsp;'''Management'' tile on Home page. This opens the Templates Page&nbsp;displaying all the existing Templates.
 +
 
 +
2. Use the ''Categories'' drop down to narrow down the templates&nbsp;and find the exact one you are looking for. For example, search by status, created by or the status changed,&nbsp;date, among many other options. This displays all the options that match the selected category.
 +
 
 +
3. Select the desired criteria by marking the&nbsp;boxes next to that option. Only the templates matching this specified criteria are displayed.
 +
 
 +
4. Narrow your search further by typing specific keywords in the ''Custom Keyword'' field and then '''click''' ''Apply''. You can use Boolean operators such as AND/OR or search by wildcards to filter the results. For example:&nbsp;
 +
 
 +
*APP*: displays agreements only in the APPROVED and WAITING FOR APPROVAL states
 +
*?PP*&nbsp;: displays agreements only in the APPROVED and WAITING FOR APPROVAL states
 +
*APP*:&nbsp;OR DRA* - displays agreements only in the APPROVED, WAITING FOR APPROVAL and DRAFT states &nbsp; &nbsp;&nbsp;
 +
 
 +
5. You can also type free text in the ''Refine Search Here...'' search box. A list of relevant agreements are displayed.
 +
 
 +
=== Saved Searches ===
 +
 
 +
Follow these steps to use your saved searches:
 +
 
 +
1.&nbsp;'''Click''' the ''Template Management&nbsp;''tile on Home page. This opens the Templates page displaying all the existing templates.
 +
 
 +
2.&nbsp;'''Click''' the ''Saved Searches'' drop down and select the desired saved search. Refer to Using Advanced Search for details on saving a search. This displays the templates matching the criteria defined in the saved search.
 +
 
 +
Refer to Saved Searches for details on saving a search.
 +
 
 +
=== Searches pinned as Favorites ===
 +
 
 +
Follow these steps to search using a favorite search:
 +
 
 +
1.&nbsp;'''Click''' the ''Template Management'' tile on the Home page. This opens the Templates page displaying all the existing templates.
 +
 
 +
2.&nbsp;'''Click''' one of the searches defined as favorite, just below the feature tiles. Refer to Using Advanced Search for details on adding searches as favorites. This displays the templates&nbsp;matching the criteria defined in favorite search.
  
 
&nbsp;
 
&nbsp;
 +
 +
=== Searching Templates based on the extended template metadata ===
 +
 +
Users have flexibility to use attributes of masterdata as extensions to any template, agreement or associated document while creating or editing the instance.
 +
 +
Users can search and retrieve required templates using these extended attributes as search parameters through ''Template'' index page search, ''Advanced Search'', ''Global Search'' and ''Saved Search''. Extended attributes are available in search facets drop-downs along with regular attributes. This considerably improves the efficiency of search facility.
 +
 +
To search templates on ''Template'' Index page:
 +
 +
#'''Click''' ''Template Management > Templates'' on the ''Home ''page. The ''Templates'' page opens with all existing templates.
 +
#'''Type''' extended attribute in the ''Refine Search here…'' search box. The list of relevant ''Templates'' opens.
 +
#'''Select''' extended attribute as search parameter in the ''Categories'' drop-down. All matching ''Templates ''are displayed. For example, select extended attribute ''MSL Country Name'' and attribute value containing ''Canada ''in ''Categories''. All ''Templates ''with ''MSL Country Name'' containing ''Canada'' are displayed on template index page.
 +
#'''Filter''' your search further by selecting and typing specific extended attribute value in the ''Custom keyword'' field and then '''click '''''Apply''. For example, select ''Custom keyword as India'' with operator ''Exactly''. Only ''Templates'' containing ''MSL Country Names as Canada'' and ''India'' are displayed.
 +
<div class="image-green-border">[[File:7.12 Template Management Search 1 gr action.png|720px|7.12 Template Management Search 1 gr action.png]]</div>
 +
Users can search templates by extended attributes using the ''Advanced Search'' and ''Saved Search''.<br/> On ''Advanced Search'' page, '''select '''''Template ''in ''Entity ''drop-down and '''type '''extended attribute in the ''Refine Search here…'' search box. Refer to ''Using Advanced Search'' for details on using search filters, operators, and options.<br/> Users can save the search criteria with extended attributes as search parameters and use as ''global or local Saved Search''. Refer to ''Saved Searches'' for details on saving a search. Refer to ''Using Advanced Search'' for details on retrieving a ''Saved Search''.
 +
<div class="image-green-border">[[File:7.12 Template Management Search 2 gr action.png|720px|7.12 Template Management Search 2 gr action.png]]</div>
 +
== Creating a Template in ICI ==
 +
 +
To create a Template in ICI:
 +
 +
1.&nbsp;'''Click'''&nbsp;the&nbsp;''Template Management''&nbsp;tile on the Home page. The Templates page opens.
 +
 +
2. '''Click '''the&nbsp;''Create Template''&nbsp;tile.&nbsp;The&nbsp;''Create Template'' page. Type the required details in the following sections:
 +
 +
*Details
 +
*Template Variable&nbsp;
 +
*Team
 +
*Verify
 +
 +
'''Note''': (*) denotes a mandatory field. ICI displays an error message if a mandatory field is left empty.
  
 
&nbsp;
 
&nbsp;
 +
 +
=== Details ===
 +
 +
The&nbsp;''Details''&nbsp;section&nbsp;consists of some mandatory fields, while rest of the sections are optional.&nbsp;The extended attributes are available under ''Template Additional Attributes'' if configured in your instance.
 +
 +
Enter the basic details in the following fields:
 +
 +
*Contract Type Name: '''Select''' a ''Contract type'' from the drop-down list for which you want to create a Template.
 +
*Name: '''Type''' an appropriate name for the Template.
 +
*Template Code: The Template Code is auto-generated.
 +
*Template Language: '''Select''' the language for the Template.
 +
*Primary Template: '''Select''' ''Yes'' if this is the Primary Template. '''Select''' ''No'' if it is not a Primary Template.&nbsp;This feature helps define the primary Template in a specific language, and you can define secondary Templates in other languages if needed.
 +
*Linked Primary Template: This section opens when you '''select''' ''No'' for Primary Template option.&nbsp;'''Select''' a ''Primary Template'' from the drop-down menu to link this Template to it.
 +
*Effective From: '''Type''' or '''select''' the ''E­ffective From'' date using the calendar window.
 +
*Effective To: '''Type''' or '''select''' the ''E­ffective To'' date using the calendar window.
 +
*Description: '''Type''' a description for the Template.
 +
*Version Comments: '''Type'''&nbsp;relevant comments for this version, such as what changes were made and why, who they were approved by or any other comments you may wish to add specific to this version.
 +
*File: '''Click''' ''Select File'' to upload a Template from your local folder.
 +
 +
'''Click''' ''Next'' to go to the ''Template Variables'' tab.
 +
 +
&nbsp;
 +
 +
=== Template Variable ===
 +
 +
Template Variables are the attributes that are part of the template.&nbsp;
 +
 +
On this tab, you can either select the attributes from the Available Attribute&nbsp;section or Add new Attributes. The user can also set a Template Variable as conditional to the value of the Contract Type Attributes by setting ''Is Conditional'' flag ''On''. For further information on Is Conditional flag, please refer the section Adding conditional&nbsp;dependency on Template Variables.
 +
 +
To select the attributes from the already existing attributes:
 +
 +
1.&nbsp;'''&nbsp;Select '''a desired attribute from the Available Attributes section then '''click '''the&nbsp;[[File:Arrow 1.PNG|20px|Arrow 1.PNG]]&nbsp;icon.
 +
 +
2. The attribute&nbsp;is added to the ''Selected Attribute'' section.
 +
 +
3. '''Click '''the attribute that is added to the&nbsp;''Selected Attributes'' section. The details of that attribute are populated in the ''Edit Attribute'' section.
 +
 +
4. '''Edit '''the details of the attribute if required. For example, Display Name, Help Message etc.
 +
<div class="image-green-border">[[File:Template Management Template Variables 7.8.PNG|720px|RTENOTITLE]]</div>
 +
5. '''Define '''the attribute with the help of flags such as ''Is Default, Is Editable'' etc.
 +
<div class="note-box">'''Note''':&nbsp;By default, the ''Is Inherit On Amendments'' property is On for attributes. Configurator should consider the behavior of the rest of the attribute properties along with ''Is Inherit On Amendments'' before setting it to Off while creating or updating templates.</div>
 +
6. '''Click '''''Save. ''The Template Variable is added in the Template that you are creating.
 +
<div class="image-green-border">[[File:Template Management attribute flags 7.8.PNG|560px|RTENOTITLE]]</div> <div class="image-green-border"><br/> To add the new attribute:&nbsp;</div>
 +
1.&nbsp;'''Click '''''Add&nbsp;''icon. The&nbsp;''Add Attributes&nbsp;''section opens.&nbsp;
 +
 +
2.&nbsp;'''Enter&nbsp;'''the&nbsp;''Display Name.&nbsp;''For example,&nbsp;''Gender.''
 +
 +
3.&nbsp;'''Select''' the ''Data Type''. Additional related fields are displayed based on the selected ''Data Type'' option.
 +
 +
For example, when the data type is selected as ''Choice'', the field to enter and arrange option values and the field to choose ''UI Control Type'' between ''Dropdown'' and ''Radio'' button (for values less than eight) are displayed. When Data Type is selected as ''MultiSelectChoice'', options ''Dropdown'' and ''Checkbox'' (for values less than eight) are displayed.
 +
<div class="image-green-border">[[File:573336-TemplateVariables-1.png|720px|573336-TemplateVariables-1.png]]</div>
 +
4.&nbsp;'''Enter''' details in ''Group'', ''Help Message'', ''Source'', ''Default Value'' and other relevant fields.<br/> 5.&nbsp;Set the appropriate Boolean fields.<br/> 6.&nbsp;'''Click''' ''Save''. The attribute is added to the Template.
 +
<div class="image-green-border">7. '''Click '''''Next''. The ''Team ''tab opens.</div>
 +
=== Team&nbsp; ===
 +
 +
This section helps you in selecting different roles for your Template. You can add 3 roles which are:
 +
 +
*'''Approver'''&nbsp;: approves or rejects the Template after reviewing it.
 +
*'''Secondary Owner ''': works with the Primary owner or alone if the Primary owner is not available. Both these roles have the same privileges.
 +
*'''Contributor'''&nbsp;: can review the Template, but can’t make any changes or take action. Any comments related to it are sent to the Primary owner or Secondary owner.
 +
 +
To add different roles:
 +
 +
*'''Click''' the ''Add''&nbsp;&nbsp;icon.&nbsp;This opens the&nbsp;''Add User''&nbsp;window.
 +
*Select the role from the drop down, and the users for that specific role.
 +
*Selecting&nbsp;a role of an approver, displays a&nbsp;''step number''&nbsp;field. This step number is mandatory and controls the sequence of approvals if there are multiple approvers. The&nbsp;approval flows sequentially according to the step number.
 +
*'''Click'''&nbsp;''Add'''''. '''The users just added will be seen under Team.
 +
 +
=== Verify ===
 +
 +
Here you can review and verify all the information for the Template before clicking on ''Create''. If you wish to edit anything, click&nbsp;''Previous''. Once created the template gets into Draft state.
 +
 +
After that click on ''Send for Approval''''',''' to send it further for approvals, or click ''Edit''&nbsp;if you want to update any field.
 +
 +
The Approver gets a notification about the Template, who can then review and approve it. Once approved, the Template is ready for use.
 +
 +
&nbsp;
 +
 +
== Adding conditional&nbsp;dependency on Template Variables ==
 +
 +
The functionality of the&nbsp;conditional dependency on Template Variables for Agreement Attributes can be achieved by any user with Manage access on Template Management tile by enabling the ''Is Conditional'' flag for each Template Variable when creating or editing a Template.&nbsp;When Is Conditional is On, a user is able to set a dependent condition on the Template Variable by using ''Depends on Contract Type Attribute'' flag ''On ''and its related ''Depends On Attribute'' drop-down and ''Depends On Value'' field.
 +
 +
The following conditions decide the dependency between the Template Variable and Contract Type Attribute: &nbsp;
 +
 +
*When ''Depends on Contract Type Attribute'' is ''On'' then it displays the Contract Type Attribute in the ''Depends On Attribute'' drop-down list.&nbsp;
 +
*When ''Depends on Contract Type Attribute'' is ''Off'' then it displays the Template Variable in the ''Depends On Attribute'' drop-down list.&nbsp;
 +
 +
For each selected Attribute from ''Depends On Attribute'' drop-down list, the user can then enter the ''Depends On Value'' that will drive the dependency.
 +
 +
&nbsp;
 +
 +
=== Adding the dependency between Contract Type Attributes and Template Variables ===
 +
 +
To add dependency between Contract Type Attributes and Template Variables:<br/> <br/> 1.&nbsp; '''Click '''the ''Template Management'' tile on the Home page. The ''Template Management'' page opens.&nbsp;<br/> 2.&nbsp; '''Click '''the ''Create Template'' tile. The ''Create Template'' page opens.<br/> 3.&nbsp; '''Select''' the Contract Type from the ''Contract Type Name'' drop-down list. For example, ''Teaming Agreement''. &nbsp;&nbsp;<br/> 4.&nbsp; '''Enter '''a Template name in the ''Name'' field. For example, ''Purchase''.<br/> 5.&nbsp; The ''Template Code'' is auto-generated.&nbsp;<br/> 6.&nbsp; '''Select''' the ''Template Language'' from the drop-down list. For example, ''English (United States)''.<br/> 7.&nbsp; '''Click''' ''Yes'' to make it ''Primary Template''.<br/> 8.&nbsp; '''Enter''' all the details on ''Create Template Details'' page.&nbsp;<br/> 9.&nbsp; '''Click''' ''Next''. The ''Template Variables'' section opens. &nbsp;<br/> 10.&nbsp; '''Select '''the desired Variables from the ''Available Attribute'' section. For example, ''A Boolean'', ''A Choice'', ''A Currency'', ''A Date'', ''A Percentage'', ''A Number'', and ''A MultiSelectChoice''.&nbsp;<br/> 11.&nbsp; '''Click '''the arrow to move Variable to the ''Selected Attribute'' section.<br/> 12.&nbsp; '''Click '''the Variable that is added to the ''Selected Attribute'' section. The details of the Variable are populated in the ''Edit Attribute'' section. For example, ''A Choice''.&nbsp;<br/> &nbsp;
 +
<div class="image-green-border">[[File:12-Tem.PNG|720px|12-Tem.PNG]]</div>
 +
13.&nbsp; '''Toggle '''the ''Is Conditional'' flag ''On'' for the selected Variable to add the conditional dependence between the Template Variable and Contract Type Attribute.&nbsp;<br/> 14.&nbsp; '''Toggle''' the ''Depends on Contract Type Attribute'' flag On to view the Contract Type Attributes in the ''Depends On Attribute'' drop-down list.&nbsp;<br/> 15.&nbsp; '''Select '''the Attribute from the ''Depends On Attribute'' drop-down list where you want to add Contract Type Attribute level dependency for a Template Variable. For example, ''Choice1''.
 +
<div class="note-box">'''Note''': For each selected Attribute, the user can enter the Depends On Value which will drive the dependency.</div>
 +
16.&nbsp; '''Enter '''the dependent value in the ''Depends On Value'' field or '''toggle '''the ''Depends On Value'' flag ''On'' based on the selected Attribute ''Data Type''. For example, ''Choice 1, Choice 2, ''and ''Choice 3''. This means the ''A Choice'' Template Variable depends on Contract Type Attribute ''Choice1'' with the following dependent values: ''Choice 1'', ''Choice 2'', and ''Choice 3''.<br/> 17.&nbsp; '''Click '''''Save''. The ''Attribute updated successfully'' message is displayed.&nbsp;
 +
<div class="note-box">'''Note''': If you want to change the Contract Type after saving a Template Variable by going back to the Details tab of Create Template page, a message is displayed indicating that Template Variables are conditional on the selected Contract Type and changing the Contract types will clear Template related date.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:17-Tem.PNG|RTENOTITLE]]</div>
 +
<br/> 18.&nbsp; '''Click '''''Next''. The Team tab opens.&nbsp;<br/> 19.&nbsp; '''Click '''''Create''. The Template gets created.&nbsp;<br/> 20.&nbsp; '''Click '''''Send For Approval'' to initiate the approval process.&nbsp;
 +
<div class="note-box">'''Note''': While editing a Contract Type, if you remove a Parent Attribute on which a Template Variable is dependent, a message is displayed indicating that if the attribute is removed it may impact rules, templates, template variables, and clauses etc.&nbsp;</div>
 +
When defining the Template Variables, a user needs to consider the following rendering conditions:
 +
<div class="image-green-border">[[File:20-Tem.PNG|720px|20-Tem.PNG]]<br/> &nbsp;</div>
 +
=== <br/> The dependency of Template Variables on an Agreement&nbsp; ===
 +
 +
To view the dependency of Template Variables on an Agreement:<br/> 1.&nbsp; '''Click '''the ''Agreement Management'' tile on the Home page. The ''Agreement Management'' page opens.<br/> 2.&nbsp; '''Click''' the ''Create Agreement'' tile. The ''Create Agreement'' page opens.<br/> 3.&nbsp; '''Select''' the Contract Type ''Category ''from the drop-down list. For example, ''Default''.<br/> 4.&nbsp; '''Select''' the Contract Type from the ''Contract Type Name'' drop-down list. For example, ''Teaming Agreement''.<br/> 5.&nbsp; '''Select''' the ''Type Of Paper ''from the drop-down list. For example, ''Own''.<br/> 6.&nbsp; '''Click''' ''Next''. The ''Create Agreement – Teaming Agreement'' Attribute page opens, which displays all Contract Type Attributes.<br/> 7.&nbsp; '''Select '''the ''Choice 1'' option from the drop-down list as defined in the ''Purchase''.&nbsp;
 +
<div class="image-green-border"><br/> [[File:7-Tem-dep.PNG|720px|7-Tem-dep.PNG]]</div> <div class="image-green-border">&nbsp;</div> <div class="note-box">'''Note''': When an inherited Attribute is used, the visibility of Template Variable, depends on the inherited values of the Agreement Attribute.</div>
 +
8.&nbsp; '''Enter''' all the details on ''Page1'' of ''Create Agreement – Teaming Agreement'' page.&nbsp;<br/> 9.&nbsp; '''Click '''''Next''. The ''Select Template'' page opens.<br/> 10.&nbsp; '''Select '''the ''Template'' from the ''Select Template'' page. For example, ''Purchase''.
 +
<div class="image-green-border">[[File:10-Tem-dep.PNG|720px|10-Tem-dep.PNG]]<br/> &nbsp;<br/> 11.&nbsp; '''Click '''''Next''. The ''Template Variables'' section opens displaying the values of the Attribute ''A Choice'' defined while creating the Template ''Purchase''.<br/> &nbsp;</div> <div class="note-box">'''Note''': The Template Variables are displayed based on the Contract Type Attribute you selected and when the condition is satisfied. The variables in Purchase are visible, and this is enabled by Is Conditional flag, which determines the Template Variable dependency at the Agreement level Attributes.&nbsp;</div>
 +
&nbsp;
 +
<div class="image-green-border">[[File:11-Tem-dep.PNG|720px|11-Tem-dep.PNG]]</div>
 +
== Editing a Template in ICI ==
 +
 +
You can edit a template at any state, to make changes to the effective date, team, and so on.&nbsp;However, when you edit an approved Template, you have to get it approved again.
 +
 +
To edit the existing Template:
 +
 +
1. On the&nbsp;''Template Management''&nbsp;page''', Click&nbsp;'''the&nbsp;''View Record''&nbsp; icon next to the Template. The ''Template Details''&nbsp;page opens providing the summary of the template.
 +
<div class="image-green-border">[[File:Template management editing a template 7.8.PNG|720px|RTENOTITLE]]</div>
 +
2.&nbsp;'''Click&nbsp;'''''Edit.&nbsp;''The&nbsp;''Edit Template&nbsp;''wizard with the&nbsp;''Details&nbsp;''tab opens.&nbsp;'''Edit&nbsp;'''the desired fields.&nbsp;You can edit the existing description or version comments information. You can upload a new template file or replace an existing template as well.
 +
 +
3.&nbsp;'''Click'''&nbsp;''Next''. The&nbsp;''Team''&nbsp;tab opens. Add or delete the team members, if required.
 +
 +
4.&nbsp;'''Click&nbsp;'''''Next.&nbsp;''The&nbsp;''Verify&nbsp;''tab opens.&nbsp;Verify the changes made to the Template.
 +
 +
5.&nbsp;'''Click&nbsp;'''''Save&nbsp;''to save the changes made to the Template.&nbsp;
 +
 +
6. Choose one of the following:
 +
 +
*'''Click'''&nbsp;''Previous''&nbsp;to go back and make changes to the information that you have entered.
 +
*'''Click'''&nbsp;''Update''&nbsp;to update the Template.
 +
<div class="image-green-border">[[File:Template Management Update Template 7.8.PNG|450px|RTENOTITLE]]</div>
 +
The details of the updated Templates are displayed. Preview of the Template opens on the right side of the page.
 +
 +
Choose from the following options that open below the contract summary and details:
 +
 +
*Download Document:&nbsp;'''Click'''&nbsp;to save the Template to your local computer.
 +
*Edit:&nbsp;'''Click'''&nbsp;to make changes to the Template.
 +
*Send For Approval:&nbsp;'''Click'''&nbsp;to send the Template to the approver.
 +
 +
'''Note''': The options that are displayed vary according to the type of Template and privileges assigned to your user id.&nbsp;
 +
 +
== Tagging Attributes inside another Attribute value in Templates ==
 +
 +
You can authorize&nbsp;users to tag an Attribute inside another choice or multi-select Attribute, so that the same Attribute tag can be used within the Agreement or Template.&nbsp;
 +
 +
<br/> In ICI, you can:
 +
 +
*Tag&nbsp;an Attribute inside the values of choice and multi-select type of Attributes
 +
*Tag&nbsp;Attributes at the Template Variable, Contract Type and Attribute Library levels
 +
*Search&nbsp;for other Attribute types that can be nested or tagged and have been configured for the selected Contract Type
 +
*Append&nbsp;prefix and postfix text to the tagged Attribute
 +
*Tag&nbsp;for nested Attributes using Bulk Upload and Excel Add-in.
 +
*Tag&nbsp;for nested attributes is resolved during Document Assembly using Word Add-in
 +
*Reverse sync&nbsp;which is driven by the same flag that is currently used for tagged Attributes
 +
*Have only one level nesting<br/> &nbsp;
 +
 +
<u>'''Remember:'''</u>
 +
 +
*In ICI, the internal name ($abc) for the choice Attribute will be displayed and this value will not get resolved.
 +
*When this field is used in the Agreement/ Template as a tagged Attribute, the tagging is resolved during document assembly and the mapped variable is displayed in the document. The document will always display the actual value of the referred Attribute.&nbsp;
 +
*If the referred Attribute has no available value and it is selected from the choice list, then no value will be displayed in the document during document assembly.
 +
*If the referred Attribute is removed from the Contract Type, a notification message is displayed stating that the Attribute may be tagged somewhere else.
 +
 +
== Sending a Template for Approval&nbsp; ==
 +
 +
After you create a Template, it is in ''Draft'' state. The Template must be approved to be able to use it to create an agreement.
 +
 +
To send a Template for approval:
 +
 +
1. '''Click '''the ''View Record'' icon on next to the template you want to send for approval. The ''Template Details'' page opens.
 +
 +
2. '''Scroll down''' the page and click the&nbsp;''Send for Approval''&nbsp;button to send the Template for approval. The status of the Template changes to ''Waiting for Approval''.
 +
<div class="image-green-border">[[File:Template Management send for approval 7.8.PNG|450px|RTENOTITLE]]</div> <div class="image-green-border">&nbsp;</div> <div class="note-box">'''Note''': Ensure that you have added an approver from the team tab before sending the Template for approval. You can add one of multiple approvers.</div>
 +
&nbsp;
 +
 +
&nbsp;
 +
 +
&nbsp;
 +
 +
'''Related Topics:&nbsp;'''[[Create_a_Template_in_ICM_Word_Add-in|Create a Template in ICI Word Add-in]]&nbsp;| [[Approve/Reject_a_Template|Approve/Reject a Template]] |&nbsp;[[Rule|Rule]]&nbsp;|&nbsp;[[Agreement_Management|Agreement Management]]&nbsp;|&nbsp;[[Clause_Management|Clause Management]]&nbsp;| [[Bilingual_Templates|Bilingual Templates]]&nbsp;| [[ICI_Add-ins|ICI Add-ins ]]| [[Release_Notes|Release_Notes]]&nbsp;|

Latest revision as of 16:42, 27 January 2021

 

Template Management

Template is a framework that represents a standard layout for an Agreement. The Template Management tile enables you to manage all aspects of creating and editing Templates from a single page. From here, you can:

  • View and manage all your Templates on Templates page.
  • Create and upload a Template through Create Template page.
  • Create Template through Word Add-ins.
7.12 Template Management

Templates

Navigate to the Templates page by clicking on the Template Management tile. This page displays all the Templates that you are associated with- you may have created a Template or are a part of the team working on it. This page displays the most current version of a Template regardless of its status.

Templates page 1 gr action.png

From this page you can:

  • search templates in a variety of ways. You can search templates from this page or use the Advanced Search.
  • view details of a template by clicking on the View Record icon. The details are displayed in the Template Details page.
  • view the template in word document format by clicking on the View Document icon.

Template Access Management

Template Access Management is now enhanced and is available through a technical configuration. When turned On, the access control for Templates is driven by the Organization Unit (OU) or the Team. 

OU can be configured in 2 ways:

  • Template access is dependent on the highest level of the OU and since everyone belongs to the OU so they have access by default, if they are part of the team.
  • Through a technical configuration, you now have the ability to change the access based on the OU of the user who is creating the Template. For example, if user John Doe is part of the Sales OU and the team, then Templates created by John Doe can be accessed by all users in the Sales OU and those belonging to the Template team.

Additionally, you can add members to the Template team through Event Rules, thus saving time of manually adding users to the Team. The support for the Observer role is extended to the Template Library as well through Role Action Mapping. 

Note: This feature is applicable to ICI Web UI and the .JS version of Word Add-in. 

Searching Templates

You can search for templates either from advanced search page or from Templates Page to:

  • view its details
  • check the status
  • edit it

You can find a specific template you are looking for from the Templates page using one of these 3 methods:

  • Category Search
  • Saved Searches
  • Searches pinned as Favorites
 

Category Search

Follow these steps to search for templates using the Category drop down:

1. Click the Template Management tile on Home page. This opens the Templates Page displaying all the existing Templates.

2. Use the Categories drop down to narrow down the templates and find the exact one you are looking for. For example, search by status, created by or the status changed, date, among many other options. This displays all the options that match the selected category.

3. Select the desired criteria by marking the boxes next to that option. Only the templates matching this specified criteria are displayed.

4. Narrow your search further by typing specific keywords in the Custom Keyword field and then click Apply. You can use Boolean operators such as AND/OR or search by wildcards to filter the results. For example: 

  • APP*: displays agreements only in the APPROVED and WAITING FOR APPROVAL states
  • ?PP* : displays agreements only in the APPROVED and WAITING FOR APPROVAL states
  • APP*: OR DRA* - displays agreements only in the APPROVED, WAITING FOR APPROVAL and DRAFT states     

5. You can also type free text in the Refine Search Here... search box. A list of relevant agreements are displayed.

Saved Searches

Follow these steps to use your saved searches:

1. Click the Template Management tile on Home page. This opens the Templates page displaying all the existing templates.

2. Click the Saved Searches drop down and select the desired saved search. Refer to Using Advanced Search for details on saving a search. This displays the templates matching the criteria defined in the saved search.

Refer to Saved Searches for details on saving a search.

Searches pinned as Favorites

Follow these steps to search using a favorite search:

1. Click the Template Management tile on the Home page. This opens the Templates page displaying all the existing templates.

2. Click one of the searches defined as favorite, just below the feature tiles. Refer to Using Advanced Search for details on adding searches as favorites. This displays the templates matching the criteria defined in favorite search.

 

Searching Templates based on the extended template metadata

Users have flexibility to use attributes of masterdata as extensions to any template, agreement or associated document while creating or editing the instance.

Users can search and retrieve required templates using these extended attributes as search parameters through Template index page search, Advanced Search, Global Search and Saved Search. Extended attributes are available in search facets drop-downs along with regular attributes. This considerably improves the efficiency of search facility.

To search templates on Template Index page:

  1. Click Template Management > Templates on the Home page. The Templates page opens with all existing templates.
  2. Type extended attribute in the Refine Search here… search box. The list of relevant Templates opens.
  3. Select extended attribute as search parameter in the Categories drop-down. All matching Templates are displayed. For example, select extended attribute MSL Country Name and attribute value containing Canada in Categories. All Templates with MSL Country Name containing Canada are displayed on template index page.
  4. Filter your search further by selecting and typing specific extended attribute value in the Custom keyword field and then click Apply. For example, select Custom keyword as India with operator Exactly. Only Templates containing MSL Country Names as Canada and India are displayed.
7.12 Template Management Search 1 gr action.png

Users can search templates by extended attributes using the Advanced Search and Saved Search.
On Advanced Search page, select Template in Entity drop-down and type extended attribute in the Refine Search here… search box. Refer to Using Advanced Search for details on using search filters, operators, and options.
Users can save the search criteria with extended attributes as search parameters and use as global or local Saved Search. Refer to Saved Searches for details on saving a search. Refer to Using Advanced Search for details on retrieving a Saved Search.

7.12 Template Management Search 2 gr action.png

Creating a Template in ICI

To create a Template in ICI:

1. Click the Template Management tile on the Home page. The Templates page opens.

2. Click the Create Template tile. The Create Template page. Type the required details in the following sections:

  • Details
  • Template Variable 
  • Team
  • Verify

Note: (*) denotes a mandatory field. ICI displays an error message if a mandatory field is left empty.

 

Details

The Details section consists of some mandatory fields, while rest of the sections are optional. The extended attributes are available under Template Additional Attributes if configured in your instance.

Enter the basic details in the following fields:

  • Contract Type Name: Select a Contract type from the drop-down list for which you want to create a Template.
  • Name: Type an appropriate name for the Template.
  • Template Code: The Template Code is auto-generated.
  • Template Language: Select the language for the Template.
  • Primary Template: Select Yes if this is the Primary Template. Select No if it is not a Primary Template. This feature helps define the primary Template in a specific language, and you can define secondary Templates in other languages if needed.
  • Linked Primary Template: This section opens when you select No for Primary Template option. Select a Primary Template from the drop-down menu to link this Template to it.
  • Effective From: Type or select the E­ffective From date using the calendar window.
  • Effective To: Type or select the E­ffective To date using the calendar window.
  • Description: Type a description for the Template.
  • Version Comments: Type relevant comments for this version, such as what changes were made and why, who they were approved by or any other comments you may wish to add specific to this version.
  • File: Click Select File to upload a Template from your local folder.

Click Next to go to the Template Variables tab.

 

Template Variable

Template Variables are the attributes that are part of the template. 

On this tab, you can either select the attributes from the Available Attribute section or Add new Attributes. The user can also set a Template Variable as conditional to the value of the Contract Type Attributes by setting Is Conditional flag On. For further information on Is Conditional flag, please refer the section Adding conditional dependency on Template Variables.

To select the attributes from the already existing attributes:

1.  Select a desired attribute from the Available Attributes section then click the Arrow 1.PNG icon.

2. The attribute is added to the Selected Attribute section.

3. Click the attribute that is added to the Selected Attributes section. The details of that attribute are populated in the Edit Attribute section.

4. Edit the details of the attribute if required. For example, Display Name, Help Message etc.

RTENOTITLE

5. Define the attribute with the help of flags such as Is Default, Is Editable etc.

Note: By default, the Is Inherit On Amendments property is On for attributes. Configurator should consider the behavior of the rest of the attribute properties along with Is Inherit On Amendments before setting it to Off while creating or updating templates.

6. Click Save. The Template Variable is added in the Template that you are creating.

RTENOTITLE

To add the new attribute: 

1. Click Add icon. The Add Attributes section opens. 

2. Enter the Display Name. For example, Gender.

3. Select the Data Type. Additional related fields are displayed based on the selected Data Type option.

For example, when the data type is selected as Choice, the field to enter and arrange option values and the field to choose UI Control Type between Dropdown and Radio button (for values less than eight) are displayed. When Data Type is selected as MultiSelectChoice, options Dropdown and Checkbox (for values less than eight) are displayed.

573336-TemplateVariables-1.png

4. Enter details in Group, Help Message, Source, Default Value and other relevant fields.
5. Set the appropriate Boolean fields.
6. Click Save. The attribute is added to the Template.

7. Click Next. The Team tab opens.

Team 

This section helps you in selecting different roles for your Template. You can add 3 roles which are:

  • Approver : approves or rejects the Template after reviewing it.
  • Secondary Owner : works with the Primary owner or alone if the Primary owner is not available. Both these roles have the same privileges.
  • Contributor : can review the Template, but can’t make any changes or take action. Any comments related to it are sent to the Primary owner or Secondary owner.

To add different roles:

  • Click the Add  icon. This opens the Add User window.
  • Select the role from the drop down, and the users for that specific role.
  • Selecting a role of an approver, displays a step number field. This step number is mandatory and controls the sequence of approvals if there are multiple approvers. The approval flows sequentially according to the step number.
  • Click Add. The users just added will be seen under Team.

Verify

Here you can review and verify all the information for the Template before clicking on Create. If you wish to edit anything, click Previous. Once created the template gets into Draft state.

After that click on Send for Approval, to send it further for approvals, or click Edit if you want to update any field.

The Approver gets a notification about the Template, who can then review and approve it. Once approved, the Template is ready for use.

 

Adding conditional dependency on Template Variables

The functionality of the conditional dependency on Template Variables for Agreement Attributes can be achieved by any user with Manage access on Template Management tile by enabling the Is Conditional flag for each Template Variable when creating or editing a Template. When Is Conditional is On, a user is able to set a dependent condition on the Template Variable by using Depends on Contract Type Attribute flag On and its related Depends On Attribute drop-down and Depends On Value field.

The following conditions decide the dependency between the Template Variable and Contract Type Attribute:  

  • When Depends on Contract Type Attribute is On then it displays the Contract Type Attribute in the Depends On Attribute drop-down list. 
  • When Depends on Contract Type Attribute is Off then it displays the Template Variable in the Depends On Attribute drop-down list. 

For each selected Attribute from Depends On Attribute drop-down list, the user can then enter the Depends On Value that will drive the dependency.

 

Adding the dependency between Contract Type Attributes and Template Variables

To add dependency between Contract Type Attributes and Template Variables:

1.  Click the Template Management tile on the Home page. The Template Management page opens. 
2.  Click the Create Template tile. The Create Template page opens.
3.  Select the Contract Type from the Contract Type Name drop-down list. For example, Teaming Agreement.   
4.  Enter a Template name in the Name field. For example, Purchase.
5.  The Template Code is auto-generated. 
6.  Select the Template Language from the drop-down list. For example, English (United States).
7.  Click Yes to make it Primary Template.
8.  Enter all the details on Create Template Details page. 
9.  Click Next. The Template Variables section opens.  
10.  Select the desired Variables from the Available Attribute section. For example, A Boolean, A Choice, A Currency, A Date, A Percentage, A Number, and A MultiSelectChoice. 
11.  Click the arrow to move Variable to the Selected Attribute section.
12.  Click the Variable that is added to the Selected Attribute section. The details of the Variable are populated in the Edit Attribute section. For example, A Choice. 
 

12-Tem.PNG

13.  Toggle the Is Conditional flag On for the selected Variable to add the conditional dependence between the Template Variable and Contract Type Attribute. 
14.  Toggle the Depends on Contract Type Attribute flag On to view the Contract Type Attributes in the Depends On Attribute drop-down list. 
15.  Select the Attribute from the Depends On Attribute drop-down list where you want to add Contract Type Attribute level dependency for a Template Variable. For example, Choice1.

Note: For each selected Attribute, the user can enter the Depends On Value which will drive the dependency.

16.  Enter the dependent value in the Depends On Value field or toggle the Depends On Value flag On based on the selected Attribute Data Type. For example, Choice 1, Choice 2, and Choice 3. This means the A Choice Template Variable depends on Contract Type Attribute Choice1 with the following dependent values: Choice 1, Choice 2, and Choice 3.
17.  Click Save. The Attribute updated successfully message is displayed. 

Note: If you want to change the Contract Type after saving a Template Variable by going back to the Details tab of Create Template page, a message is displayed indicating that Template Variables are conditional on the selected Contract Type and changing the Contract types will clear Template related date.
 
RTENOTITLE


18.  Click Next. The Team tab opens. 
19.  Click Create. The Template gets created. 
20.  Click Send For Approval to initiate the approval process. 

Note: While editing a Contract Type, if you remove a Parent Attribute on which a Template Variable is dependent, a message is displayed indicating that if the attribute is removed it may impact rules, templates, template variables, and clauses etc. 

When defining the Template Variables, a user needs to consider the following rendering conditions:

20-Tem.PNG
 


The dependency of Template Variables on an Agreement 

To view the dependency of Template Variables on an Agreement:
1.  Click the Agreement Management tile on the Home page. The Agreement Management page opens.
2.  Click the Create Agreement tile. The Create Agreement page opens.
3.  Select the Contract Type Category from the drop-down list. For example, Default.
4.  Select the Contract Type from the Contract Type Name drop-down list. For example, Teaming Agreement.
5.  Select the Type Of Paper from the drop-down list. For example, Own.
6.  Click Next. The Create Agreement – Teaming Agreement Attribute page opens, which displays all Contract Type Attributes.
7.  Select the Choice 1 option from the drop-down list as defined in the Purchase. 


7-Tem-dep.PNG
 
Note: When an inherited Attribute is used, the visibility of Template Variable, depends on the inherited values of the Agreement Attribute.

8.  Enter all the details on Page1 of Create Agreement – Teaming Agreement page. 
9.  Click Next. The Select Template page opens.
10.  Select the Template from the Select Template page. For example, Purchase.

10-Tem-dep.PNG
 
11.  Click Next. The Template Variables section opens displaying the values of the Attribute A Choice defined while creating the Template Purchase.
 
Note: The Template Variables are displayed based on the Contract Type Attribute you selected and when the condition is satisfied. The variables in Purchase are visible, and this is enabled by Is Conditional flag, which determines the Template Variable dependency at the Agreement level Attributes. 

 

11-Tem-dep.PNG

Editing a Template in ICI

You can edit a template at any state, to make changes to the effective date, team, and so on. However, when you edit an approved Template, you have to get it approved again.

To edit the existing Template:

1. On the Template Management page, Click the View Record  icon next to the Template. The Template Details page opens providing the summary of the template.

RTENOTITLE

2. Click Edit. The Edit Template wizard with the Details tab opens. Edit the desired fields. You can edit the existing description or version comments information. You can upload a new template file or replace an existing template as well.

3. Click Next. The Team tab opens. Add or delete the team members, if required.

4. Click Next. The Verify tab opens. Verify the changes made to the Template.

5. Click Save to save the changes made to the Template. 

6. Choose one of the following:

  • Click Previous to go back and make changes to the information that you have entered.
  • Click Update to update the Template.
RTENOTITLE

The details of the updated Templates are displayed. Preview of the Template opens on the right side of the page.

Choose from the following options that open below the contract summary and details:

  • Download Document: Click to save the Template to your local computer.
  • Edit: Click to make changes to the Template.
  • Send For Approval: Click to send the Template to the approver.

Note: The options that are displayed vary according to the type of Template and privileges assigned to your user id. 

Tagging Attributes inside another Attribute value in Templates

You can authorize users to tag an Attribute inside another choice or multi-select Attribute, so that the same Attribute tag can be used within the Agreement or Template. 


In ICI, you can:

  • Tag an Attribute inside the values of choice and multi-select type of Attributes
  • Tag Attributes at the Template Variable, Contract Type and Attribute Library levels
  • Search for other Attribute types that can be nested or tagged and have been configured for the selected Contract Type
  • Append prefix and postfix text to the tagged Attribute
  • Tag for nested Attributes using Bulk Upload and Excel Add-in.
  • Tag for nested attributes is resolved during Document Assembly using Word Add-in
  • Reverse sync which is driven by the same flag that is currently used for tagged Attributes
  • Have only one level nesting
     

Remember:

  • In ICI, the internal name ($abc) for the choice Attribute will be displayed and this value will not get resolved.
  • When this field is used in the Agreement/ Template as a tagged Attribute, the tagging is resolved during document assembly and the mapped variable is displayed in the document. The document will always display the actual value of the referred Attribute. 
  • If the referred Attribute has no available value and it is selected from the choice list, then no value will be displayed in the document during document assembly.
  • If the referred Attribute is removed from the Contract Type, a notification message is displayed stating that the Attribute may be tagged somewhere else.

Sending a Template for Approval 

After you create a Template, it is in Draft state. The Template must be approved to be able to use it to create an agreement.

To send a Template for approval:

1. Click the View Record icon on next to the template you want to send for approval. The Template Details page opens.

2. Scroll down the page and click the Send for Approval button to send the Template for approval. The status of the Template changes to Waiting for Approval.

RTENOTITLE
 
Note: Ensure that you have added an approver from the team tab before sending the Template for approval. You can add one of multiple approvers.

 

 

 

Related Topics: Create a Template in ICI Word Add-in | Approve/Reject a Template | Rule | Agreement Management | Clause Management | Bilingual Templates | ICI Add-ins | Release_Notes |

Retrieved from "https://iciwikiapac.icertis.com:15443/ICIHelp7.15/index.php?title=Template_Management&oldid=16086"