ICIHelp8.1 - User contributions [en]

Home

2020-08-04T07:37:55Z

IDT-4:

 

= Home =

The Home page is always the first screen you see when you log on to ICM. It presents a snapshot of your tasks - through the Home page tiles (also referred to as the Key Performance Indicators or KPI tiles) you chose to add - and let you access various features of ICM that you have the privileges for.

You can arrange the Home page tiles in an alphabetical order during initial provisioning i.e. when user logs in for the first time. The user can have 10 tiles pinned to the Home page. The ''Tasks'' tile, however, always remains first in the sequence since it is a very important KPI for every user. You can always manually reconfigure the position of the remaining 9 tiles on the Home page.
<div class="image-green-border">[[File:Home.PNG|720px|Home]]</div>
From the Home page you can:

*'''Launch '''a feature you have access to by clicking on any of the Feature tiles.
*'''Go '''to the ''Details'' page of a specific entity directly. Typing the first few letters of the entity name in the ''Search'' bar displays matching results in a chronological order. '''Click '''the required entity to view its ''Details'' page or navigate to the ''Advanced Search'' page by clicking the ''View all ''link.
*'''Refresh '''the Home page to ensure you have the most current view. The time the Home page was last refreshed is shown above the KPI tiles and is based on the time zone you have set in Preferences. See Navigating in ICM for details on setting preferences.
*'''Select''' the Home page tiles you would like to add and remove from the Home page. You can drag the tiles around to change their position. The ''Tasks'' tile is available by default and it can neither be moved nor deleted. Tasks are specific actions that the logged in user needs to perform. These actions taken depend on the role of the user, type of task it is and the state the record is in. 
<div class="image-green-border"> </div>
=== Editing Home page tiles ===

The Home page tiles show entities that are in various stages, for example, Templates and Clauses pending approval, Agreements pending execution or expiring in the next 90 days.

A saved search with Home page tile option selected, can be added on the Home page as a tile. Refer to Advanced Search for details on saving a search.

To select the tiles that should be displayed on the Home page:

1. '''Click '''''Edit Dashbaord''''' ''' to customize the Home page tiles as per your requirement. 
<div class="image-green-border">[[File:1080px-Dashboard 2 Home.png|720px|Dashboard 2]]</div>
2. '''Add '''a new Home page tile by selecting it from the drop-down list and move it to the ''Drag and Drop Here''''' '''box.The records that are shown in the list are marked as Home page tiles in your saved searches.

3. '''Remove''' an existing Home page tile by dragging it to the ''Drop here to Remove''''' '''box.

4. '''Click '''''<b>Save</b> ''or ''Cancel'':

*'''Click''' the ''Save'' [[File:Icon Save.JPG|Save icon]] icon to reflect the changes made on the Home page.
*'''Click''' the ''Cancel'' [[File:Icon Cancel-Cross.JPG|Cancel icon]] icon to exit to the Home page without saving.

=== User Tasks ===

The ''Tasks'' tile on the Home page allows you to:

*Ease of access to task level data by filtering and sorting it
*Driving tasks to timely closure
*Improved user experience for better understanding of the task level data
<div class="image-green-border">[[File:SP7 User Tasks - Grid View Home.png|720px|SP7 User Tasks - Grid View]]</div>
In ICM, tasks are generated for: 

*Approval
*Deviation Approval
*Internal Signature
*External Signature
*Internal Review
*External Review
*Contract Request Submitted

The Administrator configures the SLA for the following actions based on the Contract Type.

The following columns are displayed :

*Task (for example, Approval, External Signature)
*Entity Name
*Entity Code
*Entity Type
*Due By
*Primary Owner
*Task Created On
*Entity Created On

You can navigate to the Entity by clicking the Task. Each of the columns can be filtered and sorted.

 

== Widget-based Home page ==

A new layout has now been designed which allows users to switch to a widget-based Dashboard layout in view of providing a comprehensive look of business information on the Home page. This has improved the user experience and usability especially around complex navigation and performing multiple clicks to achieve a seemingly simple task. Users are now able to view recent activities, saved search, notifications upfront on the dashboard in addition to their list of tasks and KPIs/reports.
<div class="image-green-border">[[File:ICM Widget-based Dashboard 01.jpg|RTENOTITLE]]</div>
The widget-based Dashboard offers the following widgets:

#'''Performance Metric:''' displays all the KPIs to which the user has access. These include Saved Search KPIs and Report KPIs.
#'''My Tasks:''' displays a list of tasks assigned to the user. The total number of tasks is displayed at the top of the widget, followed by the task link and the date on which each task was received.
#'''Notification:''' displays notifications in the descending order of the date and time in which they have been received. Clicking a notification navigates the user to the ''Notifications'' page.
#'''My Recent Activities:''' displays a list of the latest activities performed by the user on Agreements, Contract Requests and Clauses. The activities are displayed in the descending order (latest first, oldest last).
#'''Saved Search:''' displays the searches saved on the ''Search'' page.

Default ''Dashboard'' settings will depend on the settings implemented in your organization.

To switch between the two dashboard layouts:

#'''Log on''' to ICM, the ''Home'' page opens.
#'''Click''' the arrow next to your username, a drop-down menu opens.
<div class="image-green-border">[[File:ICM Widget-based Dashboard 02.png|RTENOTITLE]]</div> <ol start="3">
<li>'''Click''' ''Preferences'', the ''My Preferences'' window opens.</li>
<li>On the ''My Settings'' tab, '''select''' the ''Widget'' option from the drop-down next to ''Dashboard Layout''.</li>
</ol>
<div class="image-green-border">[[File:ICM Widget-based Dashboard 03.png|RTENOTITLE]]</div> <ol start="5">
<li>'''Click''' ''Save''. The ''User Settings saved successfully'' message will be displayed.</li>
<li>You can now view the ''Dashboard'' as per your saved preferences.</li>
</ol>

=== Adding a widget to the Home page ===

To add a widget to the Home page:

#'''Click''' the ''Edit Dashboard'' button on the right-hand side of the page. The ''Dashboard'' switches to edit mode.
<div class="image-green-border">[[File:ICM Widget-based Dashboard 04.png|RTENOTITLE]]</div> <ol start="2">
<li>'''Click''' the ''Add Widget'' button. The ''Add Widgets to Dashboard'' window opens.</li>
</ol>
<ol start="3">
<li>From the list of widgets, '''select''' the one you want to add to the ''Dashboard''. For example, ''All Agreements, All Contract Requests, Approved Sales Orders''. A green tick appears next to the selected list items.</li>
</ol>
<div class="note-box">'''Note:''' 10 widgets can be added. In the example, as we have selected 5 widgets, the ''5 More widget(s) can be added'' message is being displayed. If 10 widgets were added, then the ''No more widgets can be added'' message is displayed.</div> <ol start="4">
<li>'''Click''' the ''Add'' button. The added widgets appears on the Home page.</li>
</ol>
<div class="image-green-border">[[File:ICM Widget-based Dashboard 07.png|RTENOTITLE]]</div> <ol start="5">
<li>'''Select''' a size of the widget. For example, ''Small, Medium Large''. By default, the ''Small'' widget size is displayed.</li>
</ol>

You can change the sequence of the widgets by dragging the tiles around to change their position on the Home page based on your requirement.

To remove a widget, '''click''' the X icon of that widget. The removed widget no longer appears on the Home page''.''

 

'''Related Topics:''' [[Agreement_Management|Agreement Management]] | [[Association_Management|Association Management]] | [[Compliance_Management|Compliance Management]] | [[Template_Management|Template Management]] | [[Clause_Management|Clause Management]] | [[Configuration|Configuration]] | [[Reports|Reports]] | [[Power_BI_Integration_with_ICM|Advanced Analytics]] | [[Bulk_Actions|Bulk Actions]] | [[User_Administration|User Administration]] |''' '''[[Using_Advanced_Search|Advanced Search]] | [[Agreement_Details_Page|Agreement Details]] | [[Notifications_Dashboard|Notifications]] | 

Home

2020-08-04T07:37:02Z

IDT-4:

 

= Home =

== Home page ==

The Home page is always the first screen you see when you log on to ICM. It presents a snapshot of your tasks - through the Home page tiles (also referred to as the Key Performance Indicators or KPI tiles) you chose to add - and let you access various features of ICM that you have the privileges for.

You can arrange the Home page tiles in an alphabetical order during initial provisioning i.e. when user logs in for the first time. The user can have 10 tiles pinned to the Home page. The ''Tasks'' tile, however, always remains first in the sequence since it is a very important KPI for every user. You can always manually reconfigure the position of the remaining 9 tiles on the Home page.
<div class="image-green-border">[[File:Home.PNG|720px|Home]]</div>
From the Home page you can:

*'''Launch '''a feature you have access to by clicking on any of the Feature tiles.
*'''Go '''to the ''Details'' page of a specific entity directly. Typing the first few letters of the entity name in the ''Search'' bar displays matching results in a chronological order. '''Click '''the required entity to view its ''Details'' page or navigate to the ''Advanced Search'' page by clicking the ''View all ''link.
*'''Refresh '''the Home page to ensure you have the most current view. The time the Home page was last refreshed is shown above the KPI tiles and is based on the time zone you have set in Preferences. See Navigating in ICM for details on setting preferences.
*'''Select''' the Home page tiles you would like to add and remove from the Home page. You can drag the tiles around to change their position. The ''Tasks'' tile is available by default and it can neither be moved nor deleted. Tasks are specific actions that the logged in user needs to perform. These actions taken depend on the role of the user, type of task it is and the state the record is in. 
<div class="image-green-border"> </div>

=== Editing Home page tiles ===

The Home page tiles show entities that are in various stages, for example, Templates and Clauses pending approval, Agreements pending execution or expiring in the next 90 days.

A saved search with Home page tile option selected, can be added on the Home page as a tile. Refer to Advanced Search for details on saving a search.

To select the tiles that should be displayed on the Home page:

1. '''Click '''''Edit Dashbaord''''' ''' to customize the Home page tiles as per your requirement. 
<div class="image-green-border">[[File:1080px-Dashboard 2 Home.png|720px|Dashboard 2]]</div>
2. '''Add '''a new Home page tile by selecting it from the drop-down list and move it to the ''Drag and Drop Here''''' '''box.The records that are shown in the list are marked as Home page tiles in your saved searches.

3. '''Remove''' an existing Home page tile by dragging it to the ''Drop here to Remove''''' '''box.

4. '''Click '''''<b>Save</b> ''or ''Cancel'':

*'''Click''' the ''Save'' [[File:Icon Save.JPG|Save icon]] icon to reflect the changes made on the Home page.
*'''Click''' the ''Cancel'' [[File:Icon Cancel-Cross.JPG|Cancel icon]] icon to exit to the Home page without saving.

=== User Tasks ===

The ''Tasks'' tile on the Home page allows you to:

*Ease of access to task level data by filtering and sorting it
*Driving tasks to timely closure
*Improved user experience for better understanding of the task level data
<div class="image-green-border">[[File:SP7 User Tasks - Grid View Home.png|720px|SP7 User Tasks - Grid View]]</div>
In ICM, tasks are generated for: 

*Approval
*Deviation Approval
*Internal Signature
*External Signature
*Internal Review
*External Review
*Contract Request Submitted

The Administrator configures the SLA for the following actions based on the Contract Type.

The following columns are displayed :

*Task (for example, Approval, External Signature)
*Entity Name
*Entity Code
*Entity Type
*Due By
*Primary Owner
*Task Created On
*Entity Created On

You can navigate to the Entity by clicking the Task. Each of the columns can be filtered and sorted.

 

== Widget-based Home page ==

A new layout has now been designed which allows users to switch to a widget-based Dashboard layout in view of providing a comprehensive look of business information on the Home page. This has improved the user experience and usability especially around complex navigation and performing multiple clicks to achieve a seemingly simple task. Users are now able to view recent activities, saved search, notifications upfront on the dashboard in addition to their list of tasks and KPIs/reports.
<div class="image-green-border">[[File:ICM Widget-based Dashboard 01.jpg|RTENOTITLE]]</div>
The widget-based Dashboard offers the following widgets:

#'''Performance Metric:''' displays all the KPIs to which the user has access. These include Saved Search KPIs and Report KPIs.
#'''My Tasks:''' displays a list of tasks assigned to the user. The total number of tasks is displayed at the top of the widget, followed by the task link and the date on which each task was received.
#'''Notification:''' displays notifications in the descending order of the date and time in which they have been received. Clicking a notification navigates the user to the ''Notifications'' page.
#'''My Recent Activities:''' displays a list of the latest activities performed by the user on Agreements, Contract Requests and Clauses. The activities are displayed in the descending order (latest first, oldest last).
#'''Saved Search:''' displays the searches saved on the ''Search'' page.

Default ''Dashboard'' settings will depend on the settings implemented in your organization.

To switch between the two dashboard layouts:

#'''Log on''' to ICM, the ''Home'' page opens.
#'''Click''' the arrow next to your username, a drop-down menu opens.
<div class="image-green-border">[[File:ICM Widget-based Dashboard 02.png|RTENOTITLE]]</div> <ol start="3">
<li>'''Click''' ''Preferences'', the ''My Preferences'' window opens.</li>
<li>On the ''My Settings'' tab, '''select''' the ''Widget'' option from the drop-down next to ''Dashboard Layout''.</li>
</ol>
<div class="image-green-border">[[File:ICM Widget-based Dashboard 03.png|RTENOTITLE]]</div> <ol start="5">
<li>'''Click''' ''Save''. The ''User Settings saved successfully'' message will be displayed.</li>
<li>You can now view the ''Dashboard'' as per your saved preferences.</li>
</ol>

=== Adding a widget to the Home page ===

To add a widget to the Home page:

#'''Click''' the ''Edit Dashboard'' button on the right-hand side of the page. The ''Dashboard'' switches to edit mode.
<div class="image-green-border">[[File:ICM Widget-based Dashboard 04.png|RTENOTITLE]]</div> <ol start="2">
<li>'''Click''' the ''Add Widget'' button. The ''Add Widgets to Dashboard'' window opens.</li>
</ol>
<ol start="3">
<li>From the list of widgets, '''select''' the one you want to add to the ''Dashboard''. For example, ''All Agreements, All Contract Requests, Approved Sales Orders''. A green tick appears next to the selected list items.</li>
</ol>
<div class="note-box">'''Note:''' 10 widgets can be added. In the example, as we have selected 5 widgets, the ''5 More widget(s) can be added'' message is being displayed. If 10 widgets were added, then the ''No more widgets can be added'' message is displayed.</div> <ol start="4">
<li>'''Click''' the ''Add'' button. The added widgets appears on the Home page.</li>
</ol>
<div class="image-green-border">[[File:ICM Widget-based Dashboard 07.png|RTENOTITLE]]</div> <ol start="5">
<li>'''Select''' a size of the widget. For example, ''Small, Medium Large''. By default, the ''Small'' widget size is displayed.</li>
</ol>

You can change the sequence of the widgets by dragging the tiles around to change their position on the Home page based on your requirement.

To remove a widget, '''click''' the X icon of that widget. The removed widget no longer appears on the Home page''.''

 

'''Related Topics:''' [[Agreement_Management|Agreement Management]] | [[Association_Management|Association Management]] | [[Compliance_Management|Compliance Management]] | [[Template_Management|Template Management]] | [[Clause_Management|Clause Management]] | [[Configuration|Configuration]] | [[Reports|Reports]] | [[Power_BI_Integration_with_ICM|Advanced Analytics]] | [[Bulk_Actions|Bulk Actions]] | [[User_Administration|User Administration]] |''' '''[[Using_Advanced_Search|Advanced Search]] | [[Agreement_Details_Page|Agreement Details]] | [[Notifications_Dashboard|Notifications]] | 

Home

2020-08-04T07:36:43Z

IDT-4:

 

= Home =

== Home page ==

The Home page is always the first screen you see when you log on to ICM. It presents a snapshot of your tasks - through the Home page tiles (also referred to as the Key Performance Indicators or KPI tiles) you chose to add - and let you access various features of ICM that you have the privileges for.

You can arrange the Home page tiles in an alphabetical order during initial provisioning i.e. when user logs in for the first time. The user can have 10 tiles pinned to the Home page. The ''Tasks'' tile, however, always remains first in the sequence since it is a very important KPI for every user. You can always manually reconfigure the position of the remaining 9 tiles on the Home page.
<div class="image-green-border">[[File:Home.PNG|720px|Home]]</div>
From the Home page you can:

*'''Launch '''a feature you have access to by clicking on any of the Feature tiles.
*'''Go '''to the ''Details'' page of a specific entity directly. Typing the first few letters of the entity name in the ''Search'' bar displays matching results in a chronological order. '''Click '''the required entity to view its ''Details'' page or navigate to the ''Advanced Search'' page by clicking the ''View all ''link.
*'''Refresh '''the Home page to ensure you have the most current view. The time the Home page was last refreshed is shown above the KPI tiles and is based on the time zone you have set in Preferences. See Navigating in ICM for details on setting preferences.
*'''Select''' the Home page tiles you would like to add and remove from the Home page. You can drag the tiles around to change their position. The ''Tasks'' tile is available by default and it can neither be moved nor deleted. Tasks are specific actions that the logged in user needs to perform. These actions taken depend on the role of the user, type of task it is and the state the record is in. 
<div class="image-green-border"> </div>
=== Editing Home page Tiles ===

The Home page tiles show entities that are in various stages, for example, Templates and Clauses pending approval, Agreements pending execution or expiring in the next 90 days.

A saved search with Home page tile option selected, can be added on the Home page as a tile. Refer to Advanced Search for details on saving a search.

To select the tiles that should be displayed on the Home page:

1. '''Click '''''Edit Dashbaord''''' ''' to customize the Home page tiles as per your requirement. 
<div class="image-green-border">[[File:1080px-Dashboard 2 Home.png|720px|Dashboard 2]]</div>
2. '''Add '''a new Home page tile by selecting it from the drop-down list and move it to the ''Drag and Drop Here''''' '''box.The records that are shown in the list are marked as Home page tiles in your saved searches.

3. '''Remove''' an existing Home page tile by dragging it to the ''Drop here to Remove''''' '''box.

4. '''Click '''''<b>Save</b> ''or ''Cancel'':

*'''Click''' the ''Save'' [[File:Icon Save.JPG|Save icon]] icon to reflect the changes made on the Home page.
*'''Click''' the ''Cancel'' [[File:Icon Cancel-Cross.JPG|Cancel icon]] icon to exit to the Home page without saving.

=== User Tasks ===

The ''Tasks'' tile on the Home page allows you to:

*Ease of access to task level data by filtering and sorting it
*Driving tasks to timely closure
*Improved user experience for better understanding of the task level data
<div class="image-green-border">[[File:SP7 User Tasks - Grid View Home.png|720px|SP7 User Tasks - Grid View]]</div>
In ICM, tasks are generated for: 

*Approval
*Deviation Approval
*Internal Signature
*External Signature
*Internal Review
*External Review
*Contract Request Submitted

The Administrator configures the SLA for the following actions based on the Contract Type.

The following columns are displayed :

*Task (for example, Approval, External Signature)
*Entity Name
*Entity Code
*Entity Type
*Due By
*Primary Owner
*Task Created On
*Entity Created On

You can navigate to the Entity by clicking the Task. Each of the columns can be filtered and sorted.

 

== Widget-based Home page ==

A new layout has now been designed which allows users to switch to a widget-based Dashboard layout in view of providing a comprehensive look of business information on the Home page. This has improved the user experience and usability especially around complex navigation and performing multiple clicks to achieve a seemingly simple task. Users are now able to view recent activities, saved search, notifications upfront on the dashboard in addition to their list of tasks and KPIs/reports.
<div class="image-green-border">[[File:ICM Widget-based Dashboard 01.jpg|RTENOTITLE]]</div>
The widget-based Dashboard offers the following widgets:

#'''Performance Metric:''' displays all the KPIs to which the user has access. These include Saved Search KPIs and Report KPIs.
#'''My Tasks:''' displays a list of tasks assigned to the user. The total number of tasks is displayed at the top of the widget, followed by the task link and the date on which each task was received.
#'''Notification:''' displays notifications in the descending order of the date and time in which they have been received. Clicking a notification navigates the user to the ''Notifications'' page.
#'''My Recent Activities:''' displays a list of the latest activities performed by the user on Agreements, Contract Requests and Clauses. The activities are displayed in the descending order (latest first, oldest last).
#'''Saved Search:''' displays the searches saved on the ''Search'' page.

Default ''Dashboard'' settings will depend on the settings implemented in your organization.

To switch between the two dashboard layouts:

#'''Log on''' to ICM, the ''Home'' page opens.
#'''Click''' the arrow next to your username, a drop-down menu opens.
<div class="image-green-border">[[File:ICM Widget-based Dashboard 02.png|RTENOTITLE]]</div> <ol start="3">
<li>'''Click''' ''Preferences'', the ''My Preferences'' window opens.</li>
<li>On the ''My Settings'' tab, '''select''' the ''Widget'' option from the drop-down next to ''Dashboard Layout''.</li>
</ol>
<div class="image-green-border">[[File:ICM Widget-based Dashboard 03.png|RTENOTITLE]]</div> <ol start="5">
<li>'''Click''' ''Save''. The ''User Settings saved successfully'' message will be displayed.</li>
<li>You can now view the ''Dashboard'' as per your saved preferences.</li>
</ol>

=== Adding a widget to the Home page ===

To add a widget to the Home page:

#'''Click''' the ''Edit Dashboard'' button on the right-hand side of the page. The ''Dashboard'' switches to edit mode.
<div class="image-green-border">[[File:ICM Widget-based Dashboard 04.png|RTENOTITLE]]</div> <ol start="2">
<li>'''Click''' the ''Add Widget'' button. The ''Add Widgets to Dashboard'' window opens.</li>
</ol>
<ol start="3">
<li>From the list of widgets, '''select''' the one you want to add to the ''Dashboard''. For example, ''All Agreements, All Contract Requests, Approved Sales Orders''. A green tick appears next to the selected list items.</li>
</ol>
<div class="note-box">'''Note:''' 10 widgets can be added. In the example, as we have selected 5 widgets, the ''5 More widget(s) can be added'' message is being displayed. If 10 widgets were added, then the ''No more widgets can be added'' message is displayed.</div> <ol start="4">
<li>'''Click''' the ''Add'' button. The added widgets appears on the Home page.</li>
</ol>
<div class="image-green-border">[[File:ICM Widget-based Dashboard 07.png|RTENOTITLE]]</div> <ol start="5">
<li>'''Select''' a size of the widget. For example, ''Small, Medium Large''. By default, the ''Small'' widget size is displayed.</li>
</ol>

You can change the sequence of the widgets by dragging the tiles around to change their position on the Home page based on your requirement.

To remove a widget, '''click''' the X icon of that widget. The removed widget no longer appears on the Home page''.''

 

'''Related Topics:''' [[Agreement_Management|Agreement Management]] | [[Association_Management|Association Management]] | [[Compliance_Management|Compliance Management]] | [[Template_Management|Template Management]] | [[Clause_Management|Clause Management]] | [[Configuration|Configuration]] | [[Reports|Reports]] | [[Power_BI_Integration_with_ICM|Advanced Analytics]] | [[Bulk_Actions|Bulk Actions]] | [[User_Administration|User Administration]] |''' '''[[Using_Advanced_Search|Advanced Search]] | [[Agreement_Details_Page|Agreement Details]] | [[Notifications_Dashboard|Notifications]] | 

File:Home.PNG

2020-08-04T07:35:39Z

IDT-4:

Self-Serve Tools

2020-08-04T07:25:35Z

IDT-4:

= Self-Serve Tools =

Self-Serve tools include tools and features of ICM that can be used out-of-the-box by authorized users. Besides serving ICM users with specific feature and performance goals, being self-sufficient is the primary goal of these tools. These tools are user-friendly and time-saving, enabling users to perform tasks by themselves instead of reaching out to Icertis Solutions Engineering, Database or Support teams based on the requirement. Sometimes, these changes were minor and of low complexity, but the turnaround time was substantial.

The ICM Self-Serve tools include:

*Search Sync Tool
*Translations Editor Tool
*Improved ICM Health Check Tool
*Configurations Key Editor Tool
*Promote to Production (P2P) Tool
<div class="image-caption">'''<span style="color:#008000;">Prerequisites</span>'''</div>
*The ICM application, version 7.11 and above
*The user must have valid credentials to access ICM and the ''User Administration'' tile.

 

== Search Sync Tool ==

The Search Sync tool gets data from Elastic Search (ES) for a given instance’s ''Sys Id ''and synchronizes it if required. Using the fetched ES value, the tool validates if the Sys Id is the latest for the respective instance or if a sync is required. This tool can be accessed by the Administrator from the ''Admin Task'' on ''User Administration'' tile.

If the key exists, the latest value from ES will be displayed. If the key does not exist, the system displays an error message indicating that the value could not be fetched for the provided Sys Id. The Sys Id can be provided as input CSV file or as comma separated. Either comma separated Sys Ids can be entered or a CSV file can be uploaded.

This helps to make the entity search more streamlined and efficient. Users can quickly refer to related agreements at the time of deals or audits.

'''Note''': Data can be fetched from only one instance at a time. A dedicated key must exist for ES sync to work with ''Sys ID''.

You can search the documents that an Agreement is linked to.

To use the Search Sync Tool:

1. '''Click''' Home > User Administration > ''Admin Task''. The ''Admin Task'' page opens.
<div class="image-green-border">[[File:Search Sync 1.png|720px|Search Sync 1]]</div>
2. '''Click''' the ''Search Sync ''task from the left pane.
<div class="image-green-border">[[File:Search Sync 2.png|720px|Search Sync 2]]</div>
4. '''Select''' the ''Entity Type ''from the drop-down to sync data to the Elastic Search. For example, Agreement.

5. '''Select''' the ''Contract Type ''from the drop-down''.''

5. '''Toggle '''''Skip Agreement Document Indexing ''to ''Yes/No'' as required.

6. To get the ''Sys Ids,'' '''click''' the ''Upload CSV button'' to upload the .CSV Agreement or enter the Sys Id using comma separated value in the box.

7. '''Click''' the ''Upload CSV'' button to upload the CSV document. The ''Upload Document'' window opens.
<div class="image-green-border">[[File:Search Sync 3.png|720px|Search Sync3]]</div>
8. '''Click''' ''SelectFile'' to upload a CSV file and add a note if required.
<div class="image-green-border">[[File:Search Sync 4.png|720px|Search Sync 4]]</div>
9. '''Click''' ''Upload File''. The file is uploaded to the ''File Path ''displayed.If the uploaded file format is incorrect, an alert message is displayed. The supported file formats will be also be displayed.

If the uploaded file format is incorrect, an alert message is displayed. The supported file formats will be also be displayed.
<div class="image-green-border">[[File:Search Sync 6.png|720px|Search Sync 6]]</div>
10. '''Click''' ''Sync''. The ''Sync Request Accepted'' message is displayed. 
<div class="image-green-border">[[File:Search Sync 7.png|720px|Search Sync7]]</div>
11. '''Click''' ''Ok''. Users can now get data from ES for a given instance’s SysId and can check if it has the latest value or if a sync is needed.

12. '''Select''' ''Get ES Value''.

13. Enter the SysId and '''click''' ''Go''. If the key exists, the latest value from ES will be displayed. If the key does not exist, the error message ''Please enter valid SysId'' is displayed.
<div class="note-box">'''Note''': Data can be fetched from only one instance at a time.</div> <div class="image-green-border">[[File:Search Sync 8.png|720px|Search Sync 8]]</div> <div class="image-caption"> </div> <div class="image-caption"> </div> <div class="image-caption"><span style="color:#008000;">'''''Elastic Search Sync'''''</span></div>
Users can now get data from Elastic search for a given instance’s ''SysId'' so that they can look up the value and identify whether it is the latest or if a sync is needed. If the key exists, the latest value from ES will be displayed. If the key does not exist, the system will display the error message “Could not fetch value for provided SysId”.
<div class="note-box">'''Note''': Data can be fetched from only one instance at a time.</div> <div class="image-green-border">[[File:Search Sync ES.png|720px|Search Sync ES.png]]</div> <div class="image-green-border"> </div>
== Translations Editor Tool ==

The ICM platform is available in different languages and different languages label text are available for localization. However, to make any changes to the localization values, users had to reach out to the Solutions Engineering or Database teams. Sometimes, these changes were minor and of low complexity, but the turnaround time was substantial.

Hence, a self-service ''Translations Editor'' tool has been introduced that contains all strings that are localized.

Users can now download all keys and their localization values as an Excel file, modify multiple values, and upload the modified changes to ICM. Once the values are updated in ICM, the caches are updated automatically to avoid the cache flush and server restart. This has significantly enhanced productivity as the turnaround time to update the Resource Key values has been eradicated.

Using this tool, users can now:

*Search for a specific string using the search bar and update the Resource Key value for Language and Locale.
*Update multiple language strings by selecting and saving the Resource Key value.
*Download and upload the localization key values using Microsoft Excel.
*View the modified values in the ICM instance immediately.

To use the Translations Editor Tool:

1. '''Click''' the ''User Administration'' tile on the ''Home'' page.

2. '''Select '''''Admin Task'' from the drop-down. The ''Admin Task'' page opens.
<div class="image-green-border">[[File:User Administration.PNG|720px|User Administration]]</div>
3. '''Select''' the ''Translation Editor ''task from the left pane.
<div class="image-green-border">[[File:Translation Editor 1.png|720px|Translation Editor 1]]</div>
Users can update translations in the following ways:

1. For selective editing, select a language and a resource key to update the translations.

2. For bulk editing and updation of multiple languages and resource keys, use the Download / Upload option to download an MS Excel sheet.

 
<div class="image-caption">'''''<span style="color:#008000;">Selective Editing to Update Translations</span>'''''</div>
For editing Resource Key values selectively:

1. From the ''Select Language'' drop-down, select a language in which you want to edit the labels.  For example, français (French).
<div class="image-green-border">[[File:Translation Editor 2.png|720px|Translation Editor 2]]</div>
The Resource Key and respective values of the selected language are displayed.
<div class="image-green-border">[[File:Translation Editor 3.png|720px|Translation Editor 3]]</div>
2. '''Ente'''r a ''ResourceKey ''value in the''Search'' field to edit. For example, default. All ResourceKey(s) with the ''Par défaut (default)'' values from the French language are displayed.

'''Note:''' ResourceKey is a unique key by which the application gets its label text for different languages.
<div class="image-green-border">[[File:Translation Editor 4.png|720px|Translation Editor 4]]</div>
3. '''Click '''the ''Edit this Resource Key for Multiple Languages '''''icon '''in the ''Actions'' column.

You can change the key for a single language or for multiple languages as required. For example, change ''Par défaut'' to ''défaut'' in French or ''Predeterminado'' in Español (Spanish) to ''Defecto''.
<div class="image-green-border">[[File:Translation Editor 5.png|720px|Translation Editor 5]]</div>
4. '''Click''' ''Update''. The ResourceKey value for ''default ''is updated to ''défaut ''for French and to ''Defecto'' in Spanish.

5. The ''Resources Updated Successfully'' message is displayed. '''Click''' ''Ok''.
<div class="image-green-border">[[File:Translation Editor 6.png|720px|Translation Editor 6]]</div>
You can select the respective languages (French or Spanish) to verify that the resources have been successfully updated.
<div class="image-green-border">[[File:Translation Editor 7.png|720px|Translation Editor 7]]</div> <div class="image-caption"> </div> <div class="image-caption"> </div> <div class="image-caption">'''<span style="color:#008000;">Bulk Editing in Multiple Languages</span>'''</div>
 For editing Resource Key values of multiple languages in bulk:

1. '''Click''' ''Download File''. A Microsoft Excel file (named BulkActionWorkBookStringResource) that contains all the Resource keys and values for all supported languages in ICM is downloaded.
<div class="image-green-border">[[File:Translation Editor 9.png|720px|Translation Editor 9]]</div>
2. '''Open''' the downloaded Microsoft Excel file.

3. '''Click''' ''Enable Editing''. All ICM supported language Resource keys and their respective values are displayed.

4. '''Edit''' the ResouceKey of multiple languages as required.

5. '''Save''' the Excel file.

6. '''Click''' ''Upload File''. The ''Upload Translations'' window opens.

7. '''Click''' ''SelectFile''. The ''Open ''window opens.

8. '''Select''' the updated Excel file.

9. '''Click''' ''Open''. A warning window opens indicating that this is a heavy operation and can potentially affect overall application performance.

10. '''Click''' ''Ok''. The ''Upload Summary'' displays the number ''of Records Uploaded, Records Processed, ''and''Records Updated Successfully ''values.

11. '''Click''' ''Close''. The label translations have been achieved for multiple languages in bulk.

 

== ICM Health Check Tool ==

The ICM platform hosted on Azure Cloud uses services such as Elastic Search, Redis along with internal components such as APIs and Task services. However, no services were used to provide an insight on the application health except for the ICM Health Check page that provided regular application health checks and application monitoring to be able to detect issues before they became full-fledged outages.

The ICM Health Check page has been further extended to cover additional parameters to help identify potential outages and diagnose issues. The health insights will provide information on how well the ICM Instance and its service is performing, its overall health, as well as its usefulness to users. Users will now be able to access a dashboard (without logging into ICM) that tracks application health alongside usage metrics and application crash data.

The health statuses are classified into three categories:

*''Warning ''- This is indicated with a yellow warning icon
*''Healthy ''- This is indicated with a green check mark icon
*''Unhealthy ''- This is indicated with a red warning icon

The following details are displayed in the Health Check:

*'''Elastic Search Health''': This displays the Status (yellow/green/red), the Elastic Search version and the Uptime, and so on.

*'''Redis Cache Health''': This displays the Redis version, Uptime In Days, CPU usage, Connections Received and Commands Processed, and so on.

*'''API Health''': This displays the API Response Time, Status and Issues and so on.

*'''Database Server Metrics''': This displays the CPU usage percentage, User Connections, Total Server Memory, Disk Read/Write IO/Sec and so on.

*'''IIS Server Metrics''': This displays % 404 HTTP Response Sent, % 500  HTTP Response Sent, percentage of CPU utilization per process, Requests/sec, and so on.
<div class="image-green-border">To view the Health Check, add "Health/ViewHealth" (without quotes) to your ICM URL. </div>
To check the health of your system:<br/> 1. Enter '''''/health/viewhealth''''' at the end of the URL of your ICM instance. For example, [https://apexorg.icertis.com/health/viewhealth https://apexorg.icertis.com/health/viewhealth]. The various tools and their health are displayed.
<div class="image-green-border">[[File:Health Check 1.png|720px|Health Check 1]]</div> <div class="image-green-border"><br/> 2. '''Click''' the + icon next to the tool to view details regarding its health. The details for each of the tools are displayed in 2 columns with the Keys and their respective values as shown below.</div>
'''Elastic Search Health'''<br/> The details for the Elastic Search Health include the status, node total, primary and relocating shards, version, heap percent, uptime, and so on. For example, the Status is green.
<div class="image-green-border">[[File:Health Check 2.png|720px|Health Check 2]]</div>
'''Redis Cache Health'''<br/> The details for the Redis Cache Health include the uptime in days. Connected or blocked clients, rejected connections, CPU usage, and so on. For example, the Uptime in Days is 28.
<div class="image-green-border">[[File:Health Check 3.png|720px|Health Check 3]]</div>
'''API Health'''<br/> The API Health provides the response time. For example, 94 ms.
<div class="image-green-border">[[File:Health Check 4.png|720px|Health Check 4]]</div>
'''Task Service Health    '''<br/> The Task Service Health provides the failed count for keys and when it was last successful. 
<div class="image-green-border">[[File:Health Check 5.png|720px|Health Check 5]]</div>
'''Database Server Metrics'''<br/> The details for the Database Server Metrics Health include the edition, SQL server resource pool stats, and so on.
<div class="image-green-border">[[File:Health Check 6.png|720px|Health Check 6]]</div>
'''IIS Server Metrics'''<br/> The details for the IIS Server Metrics Health include the total method requests/sec, number of seconds an IIS Worker process has been running, the percentage of CPU utilization per process, and so on.
<div class="image-green-border">[[File:Health Check 7.png|720px|Health Check 7]]</div>
 

== Configuration Key Editor Tool ==

The Configuration Key Editor tool facilitates a logged-in user (who has access to Azure subscription) to search and update configuration keys, as and when required. It has been introduced for easier instance management and improved productivity, thus reducing the dependency on the Engineering and DevOps teams.

It includes:

*The ''Config Editor''
*The ''Redis Flush''

The ''Config Editor'' is a self-service tool that allows teams to edit instance configurations without having to connect to the instance machines. Once the key values are changed, the cache is automatically updated to avoid the server restart. The tool only works for non-production environments. The production environment configuration changes are controlled by Operations team, and the tool would not be available for production environment.

The ''Redis Flush'' is a self-service tool which allows Administrators to flush the cache or look up a particular key for its value of ''Delete a Key''. The tool can also be used to perform ''Role Restart'' on the instances to which the user has access.
<div class="note-box">'''Note:'''  The user must have access privileges to an Environment CName in Config Editor.</div> <div class="image-green-border">[[File:Config Editor 1.png|720px|Config Editor 1]]</div>
To use the Configuration Key Editor Tool:<br/> 1. Login to the ICM Tools portal (icmtools.icertis.com) with your ICM credentials.
<div class="image-green-border">[[File:Config Editor 2.png|720px|Config Editor 2]]</div> <div class="image-green-border"> </div> <div class="image-green-border">2. '''Click '''the''Config Editor'' tab on the ''Home ''page.</div> <div class="image-green-border">[[File:Config Editor 3.png|720px|Config Editor 3]]</div>
3. '''Select '''the environment from the ''Environment CName'' drop-down that you need to access for configuration. All the instances that have you have access to will be displayed. 

4. '''Click '''Submit after selecting the environment. The configuration json files for the selected environment are displayed for all available features, security details, database connections, and so on related to the selected instance.
<div class="image-green-border">[[File:Config Editor 4.png|720px|Config Editor 4]]</div>
5. '''Select''' a Config Key from the list to change its value as required. For example, the Config Key AgreementAutoRenewReminderNotificationPeriod has the reminder period set at 3 days may be changes to 2 days.
<div class="image-green-border">[[File:Config Editor 5.png|720px|Config Editor 5]]</div>
6. '''Click '''''Save and Role Restart'' to save the new value of 2 days. The specific json file for the respective CName will be reset (i.e. perform a role restart). This means that the configuration is reset in the elastic search and the server is restarted, so that the new value is reflected on the instance.<br/> 7. '''Click''' ''Download'' to download the entire file so that you can edit it offline and then upload it directly to the instance.

 

== Promote Configurations (P2P) Tool ==

The Promote to Production (P2P) process of the ICM platform helps to move ICM Configuration from source (Config/UAT) environment to target (production) environment. P2P process enables to selectively move ICM configuration. The Promote Configuration Tool or P2P is designed to accomplish just that.

With the 7.11 release, the Promote to Production (P2P) tool to enable users with the following enhancements:

*Vulnerability and Penetration Testing (VAPT) fixes
*Testing open bugs in P2P engine
*Some new validations in the P2P engine
*Better user interface to provide support to P2P and DevOps teams

With the 7.12 release, changes have been made in ICM to support the P2P engine. This functionality, provided to Administrators, can promote ICM configurations/modifications that are made to ICM configurations in pre-production environments to production environments. This tool provides support for contract types, contract type attributes, clauses and templates (along with the documents), notification templates, rules, masterdata, users, user groups and security groups. The elastic search sync is also supported by the tool.
<div class="note-box">'''Note:''' UI changes on contract type, rule set, notification template are not included. Customers using ICM version before 7.12 need to upgrade for this capability.</div>
Here is an overview of the P2P process:
<div class="image-green-border">[[File:P2P 1.png|720px|P2P 1]]</div> <div class="image-caption"><span style="background-color:#008000;">Accessing P2P tool</span></div>
To access the P2P tool: 

1. '''Click '''''Home > ''''Configuration'''''<b>tile. The ''Configuration'' page opens.</b>

2. '''Click '''the ''Promote'' ''Configurations'' tile. The ''Promote Configuration'' page opens. The ''Promote Configurations ''displays the current status of PToP requests and their status.

'''Note: '''Users cannot edit a request that is in ''Completed'' state.
<div class="image-green-border">[[File:P2P 2.png|720px|P2P 2]]</div> <div class="image-caption"> </div> <div class="image-caption"> </div> <div class="image-caption"><span style="color:#008000;">'''''Creating a P2P Request'''''</span></div>
To create a P2P Request:

1. '''Click''' ''Configurations > Promote Configurations > Create Request''. The ''Create P2P Request'' page opens.
<div class="image-green-border">[[File:P2P 3.png|720px|P2P 3]]</div>
2. '''Enter''' a ''Request Name''. For example, ''Procurement''.

3. '''Select''' a ''Target'' from the drop-down. For example, ''Acme Dev''.

4. '''Select''' the ''P2P Request Start Date Time''.

5. '''Select '''the time to trigger an email to the recipient from the ''Intimation Email minutes before P2P Starts ''drop-down list. For example, ''15 Min''.

6. '''Enter''' the intimation recipient Email Id in the ''Notification Email – Intimation ''field.

7. '''Enter''' the notification recipient Email Id in the ''Notification Email – Success ''field.

8. '''Enter''' the notification recipient email Id in the ''Notification Email – Failure ''field.

9. '''Enter''' the notification recipient email Id in the ''Notification Email – Cancel ''field.

10. '''Click''' ''Next. ''The ''Contract Type'' tab opens.

11. '''Select''' the ''Contract Type ''from the ''Available Contract Types''. For example, ''Fiscal Year Master''. The selected Contract Type attributes are available in the ''Attributes Of Selected Contract Type'' columns.

12. '''Select '''the attributes for the selected contract type'''. '''For example, ''Created By''.

13. '''Click '''the right arrow to move the selected contract type and attribute to ''the Selected Contract Types'' and ''Attributes Of Selected Contract Type'' columns respectively.
<div class="image-green-border">[[File:P2P 4.png|720px|P2P 4]]</div>
14. '''Click''' ''Next''. The ''Templates and Clauses tab'' opens.

15. '''Select''' a template from the ''Available Templates'' columns. For example, ''Demo Template''.

16. '''Click '''the arrow key to move the selected template to the S''elected Templates'' column.

17. '''Select''' a clause from the'' Available Clauses'' columns. For example, ''Clause 1_Demo''.

18. '''Click '''the arrow key to move the selected clause to the S''elected Clauses'' column.
<div class="image-green-border">[[File:P2P 5.png|720px|P2P 5]]</div>
19. '''Click '''''Next. ''The ''Rules'' tab opens.

20. '''Select''' a Rule from the ''Available Rule Set Information'' column. For example, ''ICM_Master I Master_Exec Summary on Agr Add Association''.

21. '''Click '''the arrow key to move the selected rule to the S''elected Rule Set Information'' column.
<div class="image-green-border">[[File:P2P 6.png|720px|P2P 6]]</div>
22. '''Click '''''Next''. The ''Notifications ''tab opens.

23. '''Select '''the notification template from the ''Available Notification Template'' columns. For example, ''UserInformation I User Information Expired I UserInformationExpired I User Notifications''.

24. '''Click '''the arrow key to move the selected template to the S''elected Notification Templates'' column.
<div class="image-green-border">[[File:P2P 7.png|720px|P2P 7]]</div>
25. '''Click''' ''Next''. The ''Master Data & Core Seed Data'' tab opens.
<div class="note-box">'''''Note''''': Users can use the ''P2P tool Master Data'' tab for the faster transition of Master Data to production than the Bulk utility tool option.</div>
27. '''Click '''the arrow key to move the selected rule to the S''elected Master Data'' column.

28. '''Select '''the seed data from the ''Available Core Seed Data'' column.

29. '''Click '''the arrow key to move the selected master data to the S''elected Core Seed Data ''column.
<div class="image-green-border">[[File:P2P 8.png|720px|P2P 8]]</div>
30. '''Click '''''Next. ''The ''Users & User groups'' tab opens.

31. '''Select''' the users from the ''Available Users'' column.

32.'''Click '''the arrow key to move the selected user to the S''elected Users'' column.

33. '''Select '''the user group from the ''Available User Groups'' column. 

34. '''Click '''the arrow key to move the selected user to the S''elected User Groups'' column.
<div class="image-green-border">[[File:P2P 9.png|720px|P2P 9]]</div>
35. '''Click''''' Next'' if any or no user or user group is selected. The ''Security Groups'' tab opens.

36. '''Select '''the security group from the ''Available Security Groups'' columns.

37. '''Click '''the arrow key to move the selected security group to the S''elected Security Groups'' column.

38.'''Select '''the KPI from the ''Available KPI’s'' columns.

39.'''Click '''the arrow key to move the selected KPI to the S''elected SaveSearchKPIs'' column. For example, ''Product Authorization''.
<div class="image-green-border">[[File:P2P 10.png|720px|P2P 10]]</div>
40. '''Click''' ''Next''. The'' Verify'' tab opens.

41. '''Verify''' details of the contract types, attributes, templates, clauses, rule set information, notification templates, master data, core seed data, user and user groups, save search KPI and security groups that you have selected.
<div class="image-green-border">[[File:P2P 11.png|720px|P2P 11]]</div>
42. '''Click '''''Create''. The ''Please Confirm'' window opens indicating that downtime is required for this request.
<div class="note-box">'''''Note''''': The P2P tool verifies all the information entered by the user before creating a P2P request.</div>
43.'''Click '''''Yes ''if you wish to proceed. The ''Information ''window opens indicating that the P2P request created successfully.

44.'''Click''' ''Ok''. The P2P request status changes to ''ADDED''.

45. On completion of the P2P request, the status changes to ''Completed''.
<div class="note-box">'''Note''': Users cannot edit a request that is in ''Completed'' state.</div> <div class="image-green-border"> </div> <div class="image-green-border">[[File:P2P 12.png|720px|P2P 12]]</div>
 

 

 

'''Related Topics: '''[[Agreement_Management|Agreement Management]] | [http://int-wiki.cloudapp.net:8085/ICMHelp7.12/index.php?title=Association_Management Association Management] | [http://int-wiki.cloudapp.net:8085/ICMHelp7.12/index.php?title=Compliance_Management Compliance Management] | [http://int-wiki.cloudapp.net:8085/ICMHelp7.12/index.php?title=Template_Management Template Management] | [http://int-wiki.cloudapp.net:8085/ICMHelp7.12/index.php?title=Clause_Management Clause Management] | [http://int-wiki.cloudapp.net:8085/ICMHelp7.12/index.php?title=Configuration Configuration] | [http://int-wiki.cloudapp.net:8085/ICMHelp7.12/index.php?title=Reports Reports] | [http://int-wiki.cloudapp.net:8085/ICMHelp7.12/index.php?title=Localizing_ICM Localizing ICM]

Self-Serve Tools

2020-08-04T07:23:35Z

IDT-4:

= Self-Serve Tools =

Self-Serve tools include tools and features of ICM that can be used out-of-the-box by authorized users. Besides serving ICM users with specific feature and performance goals, being self-sufficient is the primary goal of these tools. These tools are user-friendly and time-saving, enabling users to perform tasks by themselves instead of reaching out to Icertis Solutions Engineering, Database or Support teams based on the requirement. Sometimes, these changes were minor and of low complexity, but the turnaround time was substantial.

The ICM Self-Serve tools include:

*Search Sync Tool
*Translations Editor Tool
*Improved ICM Health Check Tool
*Configurations Key Editor Tool
*Promote to Production (P2P) Tool
<div class="image-caption">'''<span style="color:#008000;">Prerequisites</span>'''</div>
*The ICM application, version 7.11 and above
*The user must have valid credentials to access ICM and the ''User Administration'' tile.

 

== Search Sync Tool ==

The Search Sync tool gets data from Elastic Search (ES) for a given instance’s ''Sys Id ''and synchronizes it if required. Using the fetched ES value, the tool validates if the Sys Id is the latest for the respective instance or if a sync is required. This tool can be accessed by the Administrator from the ''Admin Task'' on ''User Administration'' tile.

If the key exists, the latest value from ES will be displayed. If the key does not exist, the system displays an error message indicating that the value could not be fetched for the provided Sys Id. The Sys Id can be provided as input CSV file or as comma separated. Either comma separated Sys Ids can be entered or a CSV file can be uploaded.

This helps to make the entity search more streamlined and efficient. Users can quickly refer to related agreements at the time of deals or audits.

'''Note''': Data can be fetched from only one instance at a time. A dedicated key must exist for ES sync to work with ''Sys ID''.

You can search the documents that an Agreement is linked to.

To use the Search Sync Tool:

1. '''Click''' Home > User Administration > ''Admin Task''. The ''Admin Task'' page opens.
<div class="image-green-border">[[File:Search Sync 1.png|720px|Search Sync 1]]</div>
2. '''Click''' the ''Search Sync ''task from the left pane.
<div class="image-green-border">[[File:Search Sync 2.png|720px|Search Sync 2]]</div>
4. '''Select''' the ''Entity Type ''from the drop-down to sync data to the Elastic Search. For example, Agreement.

5. '''Select''' the ''Contract Type ''from the drop-down''.''

5. '''Toggle '''''Skip Agreement Document Indexing ''to ''Yes/No'' as required.

6. To get the ''Sys Ids,'' '''click''' the ''Upload CSV button'' to upload the .CSV Agreement or enter the Sys Id using comma separated value in the box.

7. '''Click''' the ''Upload CSV'' button to upload the CSV document. The ''Upload Document'' window opens.
<div class="image-green-border">[[File:Search Sync 3.png|720px|Search Sync3]]</div>
8. '''Click''' ''SelectFile'' to upload a CSV file and add a note if required.
<div class="image-green-border">[[File:Search Sync 4.png|720px|Search Sync 4]]</div>
9. '''Click''' ''Upload File''. The file is uploaded to the ''File Path ''displayed.If the uploaded file format is incorrect, an alert message is displayed. The supported file formats will be also be displayed.

If the uploaded file format is incorrect, an alert message is displayed. The supported file formats will be also be displayed.
<div class="image-green-border">[[File:Search Sync 6.png|720px|Search Sync 6]]</div>
10. '''Click''' ''Sync''. The ''Sync Request Accepted'' message is displayed. 
<div class="image-green-border">[[File:Search Sync 7.png|720px|Search Sync7]]</div>
11. '''Click''' ''Ok''. Users can now get data from ES for a given instance’s SysId and can check if it has the latest value or if a sync is needed.

12. '''Select''' ''Get ES Value''.

13. Enter the SysId and '''click''' ''Go''. If the key exists, the latest value from ES will be displayed. If the key does not exist, the error message ''Please enter valid SysId'' is displayed.
<div class="note-box">'''Note''': Data can be fetched from only one instance at a time.</div> <div class="image-green-border">[[File:Search Sync 8.png|720px|Search Sync 8]]</div> <div class="image-caption"> </div> <div class="image-caption"> </div> <div class="image-caption"><span style="color:#008000;">'''''Elastic Search Sync'''''</span></div>
Users can now get data from Elastic search for a given instance’s ''SysId'' so that they can look up the value and identify whether it is the latest or if a sync is needed. If the key exists, the latest value from ES will be displayed. If the key does not exist, the system will display the error message “Could not fetch value for provided SysId”.
<div class="note-box">'''Note''': Data can be fetched from only one instance at a time.</div> <div class="image-green-border">[[File:Search Sync ES.png|720px|Search Sync ES.png]]</div> <div class="image-green-border"> </div>
== Translations Editor Tool ==

The ICM platform is available in different languages and different languages label text are available for localization. However, to make any changes to the localization values, users had to reach out to the Solutions Engineering or Database teams. Sometimes, these changes were minor and of low complexity, but the turnaround time was substantial.

Hence, a self-service ''Translations Editor'' tool has been introduced that contains all strings that are localized.

Users can now download all keys and their localization values as an Excel file, modify multiple values, and upload the modified changes to ICM. Once the values are updated in ICM, the caches are updated automatically to avoid the cache flush and server restart. This has significantly enhanced productivity as the turnaround time to update the Resource Key values has been eradicated.

Using this tool, users can now:

*Search for a specific string using the search bar and update the Resource Key value for Language and Locale.
*Update multiple language strings by selecting and saving the Resource Key value.
*Download and upload the localization key values using Microsoft Excel.
*View the modified values in the ICM instance immediately.

To use the Translations Editor Tool:

1. '''Click''' the ''User Administration'' tile on the ''Home'' page.

2. '''Select '''''Admin Task'' from the drop-down. The ''Admin Task'' page opens.
<div class="image-green-border">[[File:User Administration.PNG|720px|User Administration]]</div>
3. '''Select''' the ''Translation Editor ''task from the left pane.
<div class="image-green-border">[[File:Translation Editor 1.png|720px|Translation Editor 1]]</div>
Users can update translations in the following ways:

1. For selective editing, select a language and a resource key to update the translations.

2. For bulk editing and updation of multiple languages and resource keys, use the Download / Upload option to download an MS Excel sheet.

 
<div class="image-caption">'''''<span style="color:#008000;">Selective Editing to Update Translations</span>'''''</div>
For editing Resource Key values selectively:

1. From the ''Select Language'' drop-down, select a language in which you want to edit the labels.  For example, français (French).
<div class="image-green-border">[[File:Translation Editor 2.png|720px|Translation Editor 2]]</div>
The Resource Key and respective values of the selected language are displayed.
<div class="image-green-border">[[File:Translation Editor 3.png|720px|Translation Editor 3]]</div>
2. '''Ente'''r a ''ResourceKey ''value in the''Search'' field to edit. For example, default. All ResourceKey(s) with the ''Par défaut (default)'' values from the French language are displayed.

'''Note:''' ResourceKey is a unique key by which the application gets its label text for different languages.
<div class="image-green-border">[[File:Translation Editor 4.png|720px|Translation Editor 4]]</div>
3. '''Click '''the ''Edit this Resource Key for Multiple Languages '''''icon '''in the ''Actions'' column.

You can change the key for a single language or for multiple languages as required. For example, change ''Par défaut'' to ''défaut'' in French or ''Predeterminado'' in Español (Spanish) to ''Defecto''.
<div class="image-green-border">[[File:Translation Editor 5.png|720px|Translation Editor 5]]</div>
4. '''Click''' ''Update''. The ResourceKey value for ''default ''is updated to ''défaut ''for French and to ''Defecto'' in Spanish.

5. The ''Resources Updated Successfully'' message is displayed. '''Click''' ''Ok''.
<div class="image-green-border">[[File:Translation Editor 6.png|720px|Translation Editor 6]]</div>
You can select the respective languages (French or Spanish) to verify that the resources have been successfully updated.
<div class="image-green-border">[[File:Translation Editor 7.png|720px|Translation Editor 7]]</div> <div class="image-caption"> </div> <div class="image-caption"> </div> <div class="image-caption">'''<span style="color:#008000;">Bulk Editing in Multiple Languages</span>'''</div>
 For editing Resource Key values of multiple languages in bulk:

1. '''Click''' ''Download File''. A Microsoft Excel file (named BulkActionWorkBookStringResource) that contains all the Resource keys and values for all supported languages in ICM is downloaded.
<div class="image-green-border">[[File:Translation Editor 9.png|720px|Translation Editor 9]]</div>
2. '''Open''' the downloaded Microsoft Excel file.

3. '''Click''' ''Enable Editing''. All ICM supported language Resource keys and their respective values are displayed.

4. '''Edit''' the ResouceKey of multiple languages as required.

5. '''Save''' the Excel file.

6. '''Click''' ''Upload File''. The ''Upload Translations'' window opens.

7. '''Click''' ''SelectFile''. The ''Open ''window opens.

8. '''Select''' the updated Excel file.

9. '''Click''' ''Open''. A warning window opens indicating that this is a heavy operation and can potentially affect overall application performance.

10. '''Click''' ''Ok''. The ''Upload Summary'' displays the number ''of Records Uploaded, Records Processed, ''and''Records Updated Successfully ''values.

11. '''Click''' ''Close''. The label translations have been achieved for multiple languages in bulk.

 

== ICM Health Check Tool ==

The ICM platform hosted on Azure Cloud uses services such as Elastic Search, Redis along with internal components such as APIs and Task services. However, no services were used to provide an insight on the application health except for the ICM Health Check page that provided regular application health checks and application monitoring to be able to detect issues before they became full-fledged outages.

The ICM Health Check page has been further extended to cover additional parameters to help identify potential outages and diagnose issues. The health insights will provide information on how well the ICM Instance and its service is performing, its overall health, as well as its usefulness to users. Users will now be able to access a dashboard (without logging into ICM) that tracks application health alongside usage metrics and application crash data.

The health statuses are classified into three categories:

*''Warning ''- This is indicated with a yellow warning icon
*''Healthy ''- This is indicated with a green check mark icon
*''Unhealthy ''- This is indicated with a red warning icon

The following details are displayed in the Health Check:

*'''Elastic Search Health''': This displays the Status (yellow/green/red), the Elastic Search version and the Uptime, and so on.

*'''Redis Cache Health''': This displays the Redis version, Uptime In Days, CPU usage, Connections Received and Commands Processed, and so on.

*'''API Health''': This displays the API Response Time, Status and Issues and so on.

*'''Database Server Metrics''': This displays the CPU usage percentage, User Connections, Total Server Memory, Disk Read/Write IO/Sec and so on.

*'''IIS Server Metrics''': This displays % 404 HTTP Response Sent, % 500  HTTP Response Sent, percentage of CPU utilization per process, Requests/sec, and so on.
<div class="image-green-border">To view the Health Check, add "Health/ViewHealth" (without quotes) to your ICM URL. </div>
To check the health of your system:<br/> 1. Enter '''''/health/viewhealth''''' at the end of the URL of your ICM instance. For example, [https://apexorg.icertis.com/health/viewhealth https://apexorg.icertis.com/health/viewhealth]. The various tools and their health are displayed.
<div class="image-green-border">[[File:Health Check 1.png|720px|Health Check 1]]</div> <div class="image-green-border"><br/> 2. '''Click''' the + icon next to the tool to view details regarding its health. The details for each of the tools are displayed in 2 columns with the Keys and their respective values as shown below.</div>
'''Elastic Search Health'''<br/> The details for the Elastic Search Health include the status, node total, primary and relocating shards, version, heap percent, uptime, and so on. For example, the Status is green.
<div class="image-green-border">[[File:Health Check 2.png|720px|Health Check 2]]</div>
'''Redis Cache Health'''<br/> The details for the Redis Cache Health include the uptime in days. Connected or blocked clients, rejected connections, CPU usage, and so on. For example, the Uptime in Days is 28.
<div class="image-green-border">[[File:Health Check 3.png|720px|Health Check 3]]</div>
'''API Health'''<br/> The API Health provides the response time. For example, 94 ms.
<div class="image-green-border">[[File:Health Check 4.png|720px|Health Check 4]]</div>
'''Task Service Health    '''<br/> The Task Service Health provides the failed count for keys and when it was last successful. 
<div class="image-green-border">[[File:Health Check 5.png|720px|Health Check 5]]</div>
'''Database Server Metrics'''<br/> The details for the Database Server Metrics Health include the edition, SQL server resource pool stats, and so on.
<div class="image-green-border">[[File:Health Check 6.png|720px|Health Check 6]]</div>
'''IIS Server Metrics'''<br/> The details for the IIS Server Metrics Health include the total method requests/sec, number of seconds an IIS Worker process has been running, the percentage of CPU utilization per process, and so on.
<div class="image-green-border">[[File:Health Check 7.png|720px|Health Check 7]]</div>
 

== Configuration Key Editor Tool ==

The Configuration Key Editor tool facilitates a logged-in user (who has access to Azure subscription) to search and update configuration keys, as and when required. It has been introduced for easier instance management and improved productivity, thus reducing the dependency on the Engineering and DevOps teams.

It includes:

*The ''Config Editor''
*The ''Redis Flush''

The ''Config Editor'' is a self-service tool that allows teams to edit instance configurations without having to connect to the instance machines. Once the key values are changed, the cache is automatically updated to avoid the server restart. The tool only works for non-production environments. The production environment configuration changes are controlled by Operations team, and the tool would not be available for production environment.

The ''Redis Flush'' is a self-service tool which allows Administrators to flush the cache or look up a particular key for its value of ''Delete a Key''. The tool can also be used to perform ''Role Restart'' on the instances to which the user has access.
<div class="note-box">'''Note:'''  The user must have access privileges to an Environment CName in Config Editor.</div> <div class="image-green-border">[[File:Config Editor 1.png|720px|Config Editor 1]]</div>
To use the Configuration Key Editor Tool:<br/> 1. Login to the ICM Tools portal (icmtools.icertis.com) with your ICM credentials.
<div class="image-green-border">[[File:Config Editor 2.png|720px|Config Editor 2]]</div> <div class="image-green-border"> </div> <div class="image-green-border">2. '''Click '''the''Config Editor'' tab on the ''Home ''page.</div> <div class="image-green-border">[[File:Config Editor 3.png|720px|Config Editor 3]]</div>
3. '''Select '''the environment from the ''Environment CName'' drop-down that you need to access for configuration. All the instances that have you have access to will be displayed. 

4. '''Click '''Submit after selecting the environment. The configuration json files for the selected environment are displayed for all available features, security details, database connections, and so on related to the selected instance.
<div class="image-green-border">[[File:Config Editor 4.png|720px|Config Editor 4]]</div>
5. '''Select''' a Config Key from the list to change its value as required. For example, the Config Key AgreementAutoRenewReminderNotificationPeriod has the reminder period set at 3 days may be changes to 2 days.
<div class="image-green-border">[[File:Config Editor 5.png|720px|Config Editor 5]]</div>
6. '''Click '''''Save and Role Restart'' to save the new value of 2 days. The specific json file for the respective CName will be reset (i.e. perform a role restart). This means that the configuration is reset in the elastic search and the server is restarted, so that the new value is reflected on the instance.<br/> 7. '''Click''' ''Download'' to download the entire file so that you can edit it offline and then upload it directly to the instance.

 

== Promote Configurations (P2P) Tool ==

The Promote to Production (P2P) process of the ICM platform helps to move ICM Configuration from source (Config/UAT) environment to target (production) environment. P2P process enables to selectively move ICM configuration. The Promote Configuration Tool or P2P is designed to accomplish just that.

With the 7.11 release, the Promote to Production (P2P) tool to enable users with the following enhancements:

*Vulnerability and Penetration Testing (VAPT) fixes
*Testing open bugs in P2P engine
*Some new validations in the P2P engine
*Better user interface to provide support to P2P and DevOps teams

With the 7.12 release, changes have been made in ICM to support the P2P engine. This functionality, provided to Administrators, can promote ICM configurations/modifications that are made to ICM configurations in pre-production environments to production environments. This tool provides support for contract types, contract type attributes, clauses and templates (along with the documents), notification templates, rules, masterdata, users, user groups and security groups. The elastic search sync is also supported by the tool.
<div class="note-box">'''Note:''' UI changes on contract type, rule set, notification template are not included. Customers using ICM version before 7.12 need to upgrade for this capability.</div>
Here is an overview of the P2P process:
<div class="image-green-border">[[File:P2P 1.png|720px|P2P 1]]</div> <div class="image-caption"><span style="background-color:#008000;">Accessing P2P tool</span></div>
To access the P2P tool: 

1. '''Click '''''Home > ''''Configuration'''''<b>tile. The ''Configuration'' page opens.</b>

2. '''Click '''the ''Promote'' ''Configurations'' tile. The ''Promote Configuration'' page opens. The ''Promote Configurations ''displays the current status of PToP requests and their status.

'''Note: '''Users cannot edit a request that is in ''Completed'' state.
<div class="image-green-border">[[File:P2P 2.png|720px|P2P 2]]</div> <div class="image-caption"> </div> <div class="image-caption"> </div> <div class="image-caption"><span style="color:#008000;">'''''Creating a P2P Request'''''</span></div>
To create a P2P Request:

1. '''Click''' ''Configurations > Promote Configurations > Create Request''. The ''Create P2P Request'' page opens.
<div class="image-green-border">[[File:P2P 3.png|720px|P2P 3]]</div>
2. '''Enter''' a ''Request Name''. For example, ''Procurement''.

3. '''Select''' a ''Target'' from the drop-down. For example, ''Acme Dev''.

4. '''Select''' the ''P2P Request Start Date Time''.

5. '''Select '''the time to trigger an email to the recipient from the ''Intimation Email minutes before P2P Starts ''drop-down list. For example, ''15 Min''.

6. '''Enter''' the intimation recipient Email Id in the ''Notification Email – Intimation ''field.

7. '''Enter''' the notification recipient Email Id in the ''Notification Email – Success ''field.

8. '''Enter''' the notification recipient email Id in the ''Notification Email – Failure ''field.

9. '''Enter''' the notification recipient email Id in the ''Notification Email – Cancel ''field.

10. '''Click''' ''Next. ''The ''Contract Type'' tab opens.

11. '''Select''' the ''Contract Type ''from the ''Available Contract Types''. For example, ''Fiscal Year Master''. The selected Contract Type attributes are available in the ''Attributes Of Selected Contract Type'' columns.

12. '''Select '''the attributes for the selected contract type'''. '''For example, ''Created By''.

13. '''Click '''the right arrow to move the selected contract type and attribute to ''the Selected Contract Types'' and ''Attributes Of Selected Contract Type'' columns respectively.
<div class="image-green-border">[[File:P2P 4.png|720px|P2P 4]]</div>
14. '''Click''' ''Next''. The ''Templates and Clauses tab'' opens.

15. '''Select''' a template from the ''Available Templates'' columns. For example, ''Demo Template''.

16. '''Click '''the arrow key to move the selected template to the S''elected Templates'' column.

17. '''Select''' a clause from the'' Available Clauses'' columns. For example, ''Clause 1_Demo''.

18. '''Click '''the arrow key to move the selected clause to the S''elected Clauses'' column.
<div class="image-green-border">[[File:P2P 5.png|720px|P2P 5]]</div>
19. '''Click '''''Next. ''The ''Rules'' tab opens.

20. '''Select''' a Rule from the ''Available Rule Set Information'' column. For example, ''ICM_Master I Master_Exec Summary on Agr Add Association''.

21. '''Click '''the arrow key to move the selected rule to the S''elected Rule Set Information'' column.
<div class="image-green-border">[[File:P2P 6.png|720px|P2P 6]]</div>
22. '''Click '''''Next''. The ''Notifications ''tab opens.

23. '''Select '''the notification template from the ''Available Notification Template'' columns. For example, ''UserInformation I User Information Expired I UserInformationExpired I User Notifications''.

24. '''Click '''the arrow key to move the selected template to the S''elected Notification Templates'' column.
<div class="image-green-border">[[File:P2P 7.png|720px|P2P 7]]</div>
25. '''Click''' ''Next''. The ''Master Data & Core Seed Data'' tab opens.
<div class="note-box">'''''Note''''': Users can use the ''P2P tool Master Data'' tab for the faster transition of Master Data to production than the Bulk utility tool option.</div>
27. '''Click '''the arrow key to move the selected rule to the S''elected Master Data'' column.

28. '''Select '''the seed data from the ''Available Core Seed Data'' column.

29. '''Click '''the arrow key to move the selected master data to the S''elected Core Seed Data ''column.
<div class="image-green-border">[[File:P2P 8.png|720px|P2P 8]]</div>
30. '''Click '''''Next. ''The ''Users & User groups'' tab opens.

31. '''Select''' the users from the ''Available Users'' column.

32.'''Click '''the arrow key to move the selected user to the S''elected Users'' column.

33. '''Select '''the user group from the ''Available User Groups'' column. 

34. '''Click '''the arrow key to move the selected user to the S''elected User Groups'' column.
<div class="image-green-border">[[File:P2P 9.png|720px|P2P 9]]</div>
35. '''Click''''' Next'' if any or no user or user group is selected. The ''Security Groups'' tab opens.

36. '''Select '''the security group from the ''Available Security Groups'' columns.

37. '''Click '''the arrow key to move the selected security group to the S''elected Security Groups'' column.

38.'''Select '''the KPI from the ''Available KPI’s'' columns.

39.'''Click '''the arrow key to move the selected KPI to the S''elected SaveSearchKPIs'' column. For example, ''Product Authorization''.
<div class="image-green-border">[[File:P2P 10.png|720px|P2P 10]]</div>
40. '''Click''' ''Next''. The'' Verify'' tab opens.

41. '''Verify''' details of the contract types, attributes, templates, clauses, rule set information, notification templates, master data, core seed data, user and user groups, save search KPI and security groups that you have selected.
<div class="image-green-border">[[File:P2P 11.png|720px|P2P 11]]</div>
42. '''Click '''''Create''. The ''Please Confirm'' window opens indicating that downtime is required for this request.
<div class="note-box">'''''Note''''': The P2P tool verifies all the information entered by the user before creating a P2P request.</div>
43.'''Click '''''Yes ''if you wish to proceed. The ''Information ''window opens indicating that the P2P request created successfully.

44.'''Click''' ''Ok''. The P2P request status changes to ''ADDED''.

45. On completion of the P2P request, the status changes to ''Completed''.
<div class="note-box">'''Note''': Users cannot edit a request that is in ''Completed'' state.</div> <div class="image-green-border">[[File:P2P 12.png|720px|P2P 12]]</div>
 

 

 

'''Related Topics: '''[[Agreement_Management|Agreement Management]] | [http://int-wiki.cloudapp.net:8085/ICMHelp7.12/index.php?title=Association_Management Association Management] | [http://int-wiki.cloudapp.net:8085/ICMHelp7.12/index.php?title=Compliance_Management Compliance Management] | [http://int-wiki.cloudapp.net:8085/ICMHelp7.12/index.php?title=Template_Management Template Management] | [http://int-wiki.cloudapp.net:8085/ICMHelp7.12/index.php?title=Clause_Management Clause Management] | [http://int-wiki.cloudapp.net:8085/ICMHelp7.12/index.php?title=Configuration Configuration] | [http://int-wiki.cloudapp.net:8085/ICMHelp7.12/index.php?title=Reports Reports] | [http://int-wiki.cloudapp.net:8085/ICMHelp7.12/index.php?title=Localizing_ICM Localizing ICM]

Self-Serve Tools

2020-08-04T07:23:06Z

IDT-4:

= Self-Serve Tools =

Self-Serve tools include tools and features of ICM that can be used out-of-the-box by authorized users. Besides serving ICM users with specific feature and performance goals, being self-sufficient is the primary goal of these tools. These tools are user-friendly and time-saving, enabling users to perform tasks by themselves instead of reaching out to Icertis Solutions Engineering, Database or Support teams based on the requirement. Sometimes, these changes were minor and of low complexity, but the turnaround time was substantial.

The ICM Self-Serve tools include:

*Search Sync Tool
*Translations Editor Tool
*Improved ICM Health Check Tool
*Configurations Key Editor Tool
*Promote to Production (P2P) Tool
<div class="image-caption">'''<span style="color:#008000;">Prerequisites</span>'''</div>
*The ICM application, version 7.11 and above
*The user must have valid credentials to access ICM and the ''User Administration'' tile.

 

== Search Sync Tool ==

The Search Sync tool gets data from Elastic Search (ES) for a given instance’s ''Sys Id ''and synchronizes it if required. Using the fetched ES value, the tool validates if the Sys Id is the latest for the respective instance or if a sync is required. This tool can be accessed by the Administrator from the ''Admin Task'' on ''User Administration'' tile.

If the key exists, the latest value from ES will be displayed. If the key does not exist, the system displays an error message indicating that the value could not be fetched for the provided Sys Id. The Sys Id can be provided as input CSV file or as comma separated. Either comma separated Sys Ids can be entered or a CSV file can be uploaded.

This helps to make the entity search more streamlined and efficient. Users can quickly refer to related agreements at the time of deals or audits.

'''Note''': Data can be fetched from only one instance at a time. A dedicated key must exist for ES sync to work with ''Sys ID''.

You can search the documents that an Agreement is linked to.

To use the Search Sync Tool:

1. '''Click''' Home > User Administration > ''Admin Task''. The ''Admin Task'' page opens.
<div class="image-green-border">[[File:Search Sync 1.png|720px|Search Sync 1]]</div>
2. '''Click''' the ''Search Sync ''task from the left pane.
<div class="image-green-border">[[File:Search Sync 2.png|720px|Search Sync 2]]</div>
4. '''Select''' the ''Entity Type ''from the drop-down to sync data to the Elastic Search. For example, Agreement.

5. '''Select''' the ''Contract Type ''from the drop-down''.''

5. '''Toggle '''''Skip Agreement Document Indexing ''to ''Yes/No'' as required.

6. To get the ''Sys Ids,'' '''click''' the ''Upload CSV button'' to upload the .CSV Agreement or enter the Sys Id using comma separated value in the box.

7. '''Click''' the ''Upload CSV'' button to upload the CSV document. The ''Upload Document'' window opens.
<div class="image-green-border">[[File:Search Sync 3.png|720px|Search Sync3]]</div>
8. '''Click''' ''SelectFile'' to upload a CSV file and add a note if required.
<div class="image-green-border">[[File:Search Sync 4.png|720px|Search Sync 4]]</div>
9. '''Click''' ''Upload File''. The file is uploaded to the ''File Path ''displayed.If the uploaded file format is incorrect, an alert message is displayed. The supported file formats will be also be displayed.

If the uploaded file format is incorrect, an alert message is displayed. The supported file formats will be also be displayed.
<div class="image-green-border">[[File:Search Sync 6.png|720px|Search Sync 6]]</div>
10. '''Click''' ''Sync''. The ''Sync Request Accepted'' message is displayed. 
<div class="image-green-border">[[File:Search Sync 7.png|720px|Search Sync7]]</div>
11. '''Click''' ''Ok''. Users can now get data from ES for a given instance’s SysId and can check if it has the latest value or if a sync is needed.

12. '''Select''' ''Get ES Value''.

13. Enter the SysId and '''click''' ''Go''. If the key exists, the latest value from ES will be displayed. If the key does not exist, the error message ''Please enter valid SysId'' is displayed.
<div class="note-box">'''Note''': Data can be fetched from only one instance at a time.</div> <div class="image-green-border">[[File:Search Sync 8.png|720px|Search Sync 8]]</div> <div class="image-caption"> </div> <div class="image-caption"> </div> <div class="image-caption"><span style="color:#008000;">'''''Elastic Search Sync'''''</span></div>
Users can now get data from Elastic search for a given instance’s ''SysId'' so that they can look up the value and identify whether it is the latest or if a sync is needed. If the key exists, the latest value from ES will be displayed. If the key does not exist, the system will display the error message “Could not fetch value for provided SysId”.
<div class="note-box">'''Note''': Data can be fetched from only one instance at a time.</div> <div class="image-green-border">[[File:Search Sync ES.png|720px|Search Sync ES.png]]</div> <div class="image-green-border"> </div>

== Translations Editor Tool ==

The ICM platform is available in different languages and different languages label text are available for localization. However, to make any changes to the localization values, users had to reach out to the Solutions Engineering or Database teams. Sometimes, these changes were minor and of low complexity, but the turnaround time was substantial.

Hence, a self-service ''Translations Editor'' tool has been introduced that contains all strings that are localized.

Users can now download all keys and their localization values as an Excel file, modify multiple values, and upload the modified changes to ICM. Once the values are updated in ICM, the caches are updated automatically to avoid the cache flush and server restart. This has significantly enhanced productivity as the turnaround time to update the Resource Key values has been eradicated.

Using this tool, users can now:

*Search for a specific string using the search bar and update the Resource Key value for Language and Locale.
*Update multiple language strings by selecting and saving the Resource Key value.
*Download and upload the localization key values using Microsoft Excel.
*View the modified values in the ICM instance immediately.

To use the Translations Editor Tool:

1. '''Click''' the ''User Administration'' tile on the ''Home'' page.

2. '''Select '''''Admin Task'' from the drop-down. The ''Admin Task'' page opens.
<div class="image-green-border">[[File:User Administration.PNG|720px|User Administration]]</div>
3. '''Select''' the ''Translation Editor ''task from the left pane.
<div class="image-green-border">[[File:Translation Editor 1.png|720px|Translation Editor 1]]</div>
Users can update translations in the following ways:

1. For selective editing, select a language and a resource key to update the translations.

2. For bulk editing and updation of multiple languages and resource keys, use the Download / Upload option to download an MS Excel sheet.

 
<div class="image-caption">'''''<span style="color:#008000;">Selective Editing to Update Translations</span>'''''</div>
For editing Resource Key values selectively:

1. From the ''Select Language'' drop-down, select a language in which you want to edit the labels.  For example, français (French).
<div class="image-green-border">[[File:Translation Editor 2.png|720px|Translation Editor 2]]</div>
The Resource Key and respective values of the selected language are displayed.
<div class="image-green-border">[[File:Translation Editor 3.png|720px|Translation Editor 3]]</div>
2. '''Ente'''r a ''ResourceKey ''value in the''Search'' field to edit. For example, default. All ResourceKey(s) with the ''Par défaut (default)'' values from the French language are displayed.

'''Note:''' ResourceKey is a unique key by which the application gets its label text for different languages.
<div class="image-green-border">[[File:Translation Editor 4.png|720px|Translation Editor 4]]</div>
3. '''Click '''the ''Edit this Resource Key for Multiple Languages '''''icon '''in the ''Actions'' column.

You can change the key for a single language or for multiple languages as required. For example, change ''Par défaut'' to ''défaut'' in French or ''Predeterminado'' in Español (Spanish) to ''Defecto''.
<div class="image-green-border">[[File:Translation Editor 5.png|720px|Translation Editor 5]]</div>
4. '''Click''' ''Update''. The ResourceKey value for ''default ''is updated to ''défaut ''for French and to ''Defecto'' in Spanish.

5. The ''Resources Updated Successfully'' message is displayed. '''Click''' ''Ok''.
<div class="image-green-border">[[File:Translation Editor 6.png|720px|Translation Editor 6]]</div>
You can select the respective languages (French or Spanish) to verify that the resources have been successfully updated.
<div class="image-green-border">[[File:Translation Editor 7.png|720px|Translation Editor 7]]</div> <div class="image-caption"> </div> <div class="image-caption"> </div> <div class="image-caption">'''<span style="color:#008000;">Bulk Editing in Multiple Languages</span>'''</div>
 For editing Resource Key values of multiple languages in bulk:

1. '''Click''' ''Download File''. A Microsoft Excel file (named BulkActionWorkBookStringResource) that contains all the Resource keys and values for all supported languages in ICM is downloaded.
<div class="image-green-border">[[File:Translation Editor 9.png|720px|Translation Editor 9]]</div>
2. '''Open''' the downloaded Microsoft Excel file.

3. '''Click''' ''Enable Editing''. All ICM supported language Resource keys and their respective values are displayed.

4. '''Edit''' the ResouceKey of multiple languages as required.

5. '''Save''' the Excel file.

6. '''Click''' ''Upload File''. The ''Upload Translations'' window opens.

7. '''Click''' ''SelectFile''. The ''Open ''window opens.

8. '''Select''' the updated Excel file.

9. '''Click''' ''Open''. A warning window opens indicating that this is a heavy operation and can potentially affect overall application performance.

10. '''Click''' ''Ok''. The ''Upload Summary'' displays the number ''of Records Uploaded, Records Processed, ''and''Records Updated Successfully ''values.

11. '''Click''' ''Close''. The label translations have been achieved for multiple languages in bulk.

 

== ICM Health Check Tool ==

The ICM platform hosted on Azure Cloud uses services such as Elastic Search, Redis along with internal components such as APIs and Task services. However, no services were used to provide an insight on the application health except for the ICM Health Check page that provided regular application health checks and application monitoring to be able to detect issues before they became full-fledged outages.

The ICM Health Check page has been further extended to cover additional parameters to help identify potential outages and diagnose issues. The health insights will provide information on how well the ICM Instance and its service is performing, its overall health, as well as its usefulness to users. Users will now be able to access a dashboard (without logging into ICM) that tracks application health alongside usage metrics and application crash data.

The health statuses are classified into three categories:

*''Warning ''- This is indicated with a yellow warning icon
*''Healthy ''- This is indicated with a green check mark icon
*''Unhealthy ''- This is indicated with a red warning icon

The following details are displayed in the Health Check:

*'''Elastic Search Health''': This displays the Status (yellow/green/red), the Elastic Search version and the Uptime, and so on.

*'''Redis Cache Health''': This displays the Redis version, Uptime In Days, CPU usage, Connections Received and Commands Processed, and so on.

*'''API Health''': This displays the API Response Time, Status and Issues and so on.

*'''Database Server Metrics''': This displays the CPU usage percentage, User Connections, Total Server Memory, Disk Read/Write IO/Sec and so on.

*'''IIS Server Metrics''': This displays % 404 HTTP Response Sent, % 500  HTTP Response Sent, percentage of CPU utilization per process, Requests/sec, and so on.
<div class="image-green-border">To view the Health Check, add "Health/ViewHealth" (without quotes) to your ICM URL. </div>
To check the health of your system:<br/> 1. Enter '''''/health/viewhealth''''' at the end of the URL of your ICM instance. For example, [https://apexorg.icertis.com/health/viewhealth https://apexorg.icertis.com/health/viewhealth]. The various tools and their health are displayed.
<div class="image-green-border">[[File:Health Check 1.png|720px|Health Check 1]]</div> <div class="image-green-border"><br/> 2. '''Click''' the + icon next to the tool to view details regarding its health. The details for each of the tools are displayed in 2 columns with the Keys and their respective values as shown below.</div>
'''Elastic Search Health'''<br/> The details for the Elastic Search Health include the status, node total, primary and relocating shards, version, heap percent, uptime, and so on. For example, the Status is green.
<div class="image-green-border">[[File:Health Check 2.png|720px|Health Check 2]]</div>
'''Redis Cache Health'''<br/> The details for the Redis Cache Health include the uptime in days. Connected or blocked clients, rejected connections, CPU usage, and so on. For example, the Uptime in Days is 28.
<div class="image-green-border">[[File:Health Check 3.png|720px|Health Check 3]]</div>
'''API Health'''<br/> The API Health provides the response time. For example, 94 ms.
<div class="image-green-border">[[File:Health Check 4.png|720px|Health Check 4]]</div>
'''Task Service Health    '''<br/> The Task Service Health provides the failed count for keys and when it was last successful. 
<div class="image-green-border">[[File:Health Check 5.png|720px|Health Check 5]]</div>
'''Database Server Metrics'''<br/> The details for the Database Server Metrics Health include the edition, SQL server resource pool stats, and so on.
<div class="image-green-border">[[File:Health Check 6.png|720px|Health Check 6]]</div>
'''IIS Server Metrics'''<br/> The details for the IIS Server Metrics Health include the total method requests/sec, number of seconds an IIS Worker process has been running, the percentage of CPU utilization per process, and so on.
<div class="image-green-border">[[File:Health Check 7.png|720px|Health Check 7]]</div>
 

== Configuration Key Editor Tool ==

The Configuration Key Editor tool facilitates a logged-in user (who has access to Azure subscription) to search and update configuration keys, as and when required. It has been introduced for easier instance management and improved productivity, thus reducing the dependency on the Engineering and DevOps teams.

It includes:

*The ''Config Editor''
*The ''Redis Flush''

The ''Config Editor'' is a self-service tool that allows teams to edit instance configurations without having to connect to the instance machines. Once the key values are changed, the cache is automatically updated to avoid the server restart. The tool only works for non-production environments. The production environment configuration changes are controlled by Operations team, and the tool would not be available for production environment.

The ''Redis Flush'' is a self-service tool which allows Administrators to flush the cache or look up a particular key for its value of ''Delete a Key''. The tool can also be used to perform ''Role Restart'' on the instances to which the user has access.
<div class="note-box">'''Note:'''  The user must have access privileges to an Environment CName in Config Editor.</div> <div class="image-green-border">[[File:Config Editor 1.png|720px|Config Editor 1]]</div>
To use the Configuration Key Editor Tool:<br/> 1. Login to the ICM Tools portal (icmtools.icertis.com) with your ICM credentials.
<div class="image-green-border">[[File:Config Editor 2.png|720px|Config Editor 2]]</div> <div class="image-green-border"> </div> <div class="image-green-border">2. '''Click '''the''Config Editor'' tab on the ''Home ''page.</div> <div class="image-green-border">[[File:Config Editor 3.png|720px|Config Editor 3]]</div>
3. '''Select '''the environment from the ''Environment CName'' drop-down that you need to access for configuration. All the instances that have you have access to will be displayed. 

4. '''Click '''Submit after selecting the environment. The configuration json files for the selected environment are displayed for all available features, security details, database connections, and so on related to the selected instance.
<div class="image-green-border">[[File:Config Editor 4.png|720px|Config Editor 4]]</div>
5. '''Select''' a Config Key from the list to change its value as required. For example, the Config Key AgreementAutoRenewReminderNotificationPeriod has the reminder period set at 3 days may be changes to 2 days.
<div class="image-green-border">[[File:Config Editor 5.png|720px|Config Editor 5]]</div>
6. '''Click '''''Save and Role Restart'' to save the new value of 2 days. The specific json file for the respective CName will be reset (i.e. perform a role restart). This means that the configuration is reset in the elastic search and the server is restarted, so that the new value is reflected on the instance.<br/> 7. '''Click''' ''Download'' to download the entire file so that you can edit it offline and then upload it directly to the instance.

 

== Promote Configurations (P2P) Tool ==

The Promote to Production (P2P) process of the ICM platform helps to move ICM Configuration from source (Config/UAT) environment to target (production) environment. P2P process enables to selectively move ICM configuration. The Promote Configuration Tool or P2P is designed to accomplish just that.

With the 7.11 release, the Promote to Production (P2P) tool to enable users with the following enhancements:

*Vulnerability and Penetration Testing (VAPT) fixes
*Testing open bugs in P2P engine
*Some new validations in the P2P engine
*Better user interface to provide support to P2P and DevOps teams

With the 7.12 release, changes have been made in ICM to support the P2P engine. This functionality, provided to Administrators, can promote ICM configurations/modifications that are made to ICM configurations in pre-production environments to production environments. This tool provides support for contract types, contract type attributes, clauses and templates (along with the documents), notification templates, rules, masterdata, users, user groups and security groups. The elastic search sync is also supported by the tool.
<div class="note-box">'''Note:''' UI changes on contract type, rule set, notification template are not included. Customers using ICM version before 7.12 need to upgrade for this capability.</div>
Here is an overview of the P2P process:
<div class="image-green-border">[[File:P2P 1.png|720px|P2P 1]]</div> <div class="image-caption"><span style="background-color:#008000;">Accessing P2P tool</span></div>
To access the P2P tool: 

1. '''Click '''''Home > ''''Configuration'''''<b>tile. The ''Configuration'' page opens.</b>

2. '''Click '''the ''Promote'' ''Configurations'' tile. The ''Promote Configuration'' page opens. The ''Promote Configurations ''displays the current status of PToP requests and their status.

'''Note: '''Users cannot edit a request that is in ''Completed'' state.
<div class="image-green-border">[[File:P2P 2.png|720px|P2P 2]]</div> <div class="image-caption"> </div> <div class="image-caption"> </div> <div class="image-caption"><span style="color:#008000;">'''''Creating a P2P Request'''''</span></div>
To create a P2P Request:

1. '''Click''' ''Configurations > Promote Configurations > Create Request''. The ''Create P2P Request'' page opens.
<div class="image-green-border">[[File:P2P 3.png|720px|P2P 3]]</div>
2. '''Enter''' a ''Request Name''. For example, ''Procurement''.

3. '''Select''' a ''Target'' from the drop-down. For example, ''Acme Dev''.

4. '''Select''' the ''P2P Request Start Date Time''.

5. '''Select '''the time to trigger an email to the recipient from the ''Intimation Email minutes before P2P Starts ''drop-down list. For example, ''15 Min''.

6. '''Enter''' the intimation recipient Email Id in the ''Notification Email – Intimation ''field.

7. '''Enter''' the notification recipient Email Id in the ''Notification Email – Success ''field.

8. '''Enter''' the notification recipient email Id in the ''Notification Email – Failure ''field.

9. '''Enter''' the notification recipient email Id in the ''Notification Email – Cancel ''field.

10. '''Click''' ''Next. ''The ''Contract Type'' tab opens.

11. '''Select''' the ''Contract Type ''from the ''Available Contract Types''. For example, ''Fiscal Year Master''. The selected Contract Type attributes are available in the ''Attributes Of Selected Contract Type'' columns.

12. '''Select '''the attributes for the selected contract type'''. '''For example, ''Created By''.

13. '''Click '''the right arrow to move the selected contract type and attribute to ''the Selected Contract Types'' and ''Attributes Of Selected Contract Type'' columns respectively.
<div class="image-green-border">[[File:P2P 4.png|720px|P2P 4]]</div>
14. '''Click''' ''Next''. The ''Templates and Clauses tab'' opens.

15. '''Select''' a template from the ''Available Templates'' columns. For example, ''Demo Template''.

16. '''Click '''the arrow key to move the selected template to the S''elected Templates'' column.

17. '''Select''' a clause from the'' Available Clauses'' columns. For example, ''Clause 1_Demo''.

18. '''Click '''the arrow key to move the selected clause to the S''elected Clauses'' column.
<div class="image-green-border">[[File:P2P 5.png|720px|P2P 5]]</div>
19. '''Click '''''Next. ''The ''Rules'' tab opens.

20. '''Select''' a Rule from the ''Available Rule Set Information'' column. For example, ''ICM_Master I Master_Exec Summary on Agr Add Association''.

21. '''Click '''the arrow key to move the selected rule to the S''elected Rule Set Information'' column.
<div class="image-green-border">[[File:P2P 6.png|720px|P2P 6]]</div>
22. '''Click '''''Next''. The ''Notifications ''tab opens.

23. '''Select '''the notification template from the ''Available Notification Template'' columns. For example, ''UserInformation I User Information Expired I UserInformationExpired I User Notifications''.

24. '''Click '''the arrow key to move the selected template to the S''elected Notification Templates'' column.
<div class="image-green-border">[[File:P2P 7.png|720px|P2P 7]]</div>
25. '''Click''' ''Next''. The ''Master Data & Core Seed Data'' tab opens.
<div class="note-box">'''''Note''''': Users can use the ''P2P tool Master Data'' tab for the faster transition of Master Data to production than the Bulk utility tool option.</div>
27. '''Click '''the arrow key to move the selected rule to the S''elected Master Data'' column.

28. '''Select '''the seed data from the ''Available Core Seed Data'' column.

29. '''Click '''the arrow key to move the selected master data to the S''elected Core Seed Data ''column.
<div class="image-green-border">[[File:P2P 8.png|720px|P2P 8]]</div>
30. '''Click '''''Next. ''The ''Users & User groups'' tab opens.

31. '''Select''' the users from the ''Available Users'' column.

32.'''Click '''the arrow key to move the selected user to the S''elected Users'' column.

33. '''Select '''the user group from the ''Available User Groups'' column. 

34. '''Click '''the arrow key to move the selected user to the S''elected User Groups'' column.
<div class="image-green-border">[[File:P2P 9.png|720px|P2P 9]]</div>
35. '''Click''''' Next'' if any or no user or user group is selected. The ''Security Groups'' tab opens.

36. '''Select '''the security group from the ''Available Security Groups'' columns.

37. '''Click '''the arrow key to move the selected security group to the S''elected Security Groups'' column.

38.'''Select '''the KPI from the ''Available KPI’s'' columns.

39.'''Click '''the arrow key to move the selected KPI to the S''elected SaveSearchKPIs'' column. For example, ''Product Authorization''.
<div class="image-green-border">[[File:P2P 10.png|720px|P2P 10]]</div>
40. '''Click''' ''Next''. The'' Verify'' tab opens.

41. '''Verify''' details of the contract types, attributes, templates, clauses, rule set information, notification templates, master data, core seed data, user and user groups, save search KPI and security groups that you have selected.
<div class="image-green-border">[[File:P2P 11.png|720px|P2P 11]]</div>
42. '''Click '''''Create''. The ''Please Confirm'' window opens indicating that downtime is required for this request.
<div class="note-box">'''''Note''''': The P2P tool verifies all the information entered by the user before creating a P2P request.</div>
43.'''Click '''''Yes ''if you wish to proceed. The ''Information ''window opens indicating that the P2P request created successfully.

44.'''Click''' ''Ok''. The P2P request status changes to ''ADDED''.

45. On completion of the P2P request, the status changes to ''Completed''.
<div class="note-box">'''Note''': Users cannot edit a request that is in ''Completed'' state.</div> <div class="image-green-border">[[File:P2P 12.png|720px|P2P 12]]</div>
 

 

 

'''Related Topics: '''[[Agreement_Management|Agreement Management]] | [http://int-wiki.cloudapp.net:8085/ICMHelp7.12/index.php?title=Association_Management Association Management] | [http://int-wiki.cloudapp.net:8085/ICMHelp7.12/index.php?title=Compliance_Management Compliance Management] | [http://int-wiki.cloudapp.net:8085/ICMHelp7.12/index.php?title=Template_Management Template Management] | [http://int-wiki.cloudapp.net:8085/ICMHelp7.12/index.php?title=Clause_Management Clause Management] | [http://int-wiki.cloudapp.net:8085/ICMHelp7.12/index.php?title=Configuration Configuration] | [http://int-wiki.cloudapp.net:8085/ICMHelp7.12/index.php?title=Reports Reports] | [http://int-wiki.cloudapp.net:8085/ICMHelp7.12/index.php?title=Localizing_ICM Localizing ICM]

Self-Serve Tools

2020-08-04T07:21:55Z

IDT-4:

= Self-Serve Tools =

Self-Serve tools include tools and features of ICM that can be used out-of-the-box by authorized users. Besides serving ICM users with specific feature and performance goals, being self-sufficient is the primary goal of these tools. These tools are user-friendly and time-saving, enabling users to perform tasks by themselves instead of reaching out to Icertis Solutions Engineering, Database or Support teams based on the requirement. Sometimes, these changes were minor and of low complexity, but the turnaround time was substantial.

The ICM Self-Serve tools include:

*Search Sync Tool
*Translations Editor Tool
*Improved ICM Health Check Tool
*Configurations Key Editor Tool
*Promote to Production (P2P) Tool
<div class="image-caption">'''<span style="color:#008000;">Prerequisites</span>'''</div>
*The ICM application, version 7.11 and above
*The user must have valid credentials to access ICM and the ''User Administration'' tile.

 

== Search Sync Tool ==

The Search Sync tool gets data from Elastic Search (ES) for a given instance’s ''Sys Id ''and synchronizes it if required. Using the fetched ES value, the tool validates if the Sys Id is the latest for the respective instance or if a sync is required. This tool can be accessed by the Administrator from the ''Admin Task'' on ''User Administration'' tile.

If the key exists, the latest value from ES will be displayed. If the key does not exist, the system displays an error message indicating that the value could not be fetched for the provided Sys Id. The Sys Id can be provided as input CSV file or as comma separated. Either comma separated Sys Ids can be entered or a CSV file can be uploaded.

This helps to make the entity search more streamlined and efficient. Users can quickly refer to related agreements at the time of deals or audits.

'''Note''': Data can be fetched from only one instance at a time. A dedicated key must exist for ES sync to work with ''Sys ID''.

You can search the documents that an Agreement is linked to.

To use the Search Sync Tool:

1. '''Click''' Home > User Administration > ''Admin Task''. The ''Admin Task'' page opens.
<div class="image-green-border">[[File:Search Sync 1.png|720px|Search Sync 1]]</div>
2. '''Click''' the ''Search Sync ''task from the left pane.
<div class="image-green-border">[[File:Search Sync 2.png|720px|Search Sync 2]]</div>
4. '''Select''' the ''Entity Type ''from the drop-down to sync data to the Elastic Search. For example, Agreement.

5. '''Select''' the ''Contract Type ''from the drop-down''.''

5. '''Toggle '''''Skip Agreement Document Indexing ''to ''Yes/No'' as required.

6. To get the ''Sys Ids,'' '''click''' the ''Upload CSV button'' to upload the .CSV Agreement or enter the Sys Id using comma separated value in the box.

7. '''Click''' the ''Upload CSV'' button to upload the CSV document. The ''Upload Document'' window opens.
<div class="image-green-border">[[File:Search Sync 3.png|720px|Search Sync3]]</div>
8. '''Click''' ''SelectFile'' to upload a CSV file and add a note if required.
<div class="image-green-border">[[File:Search Sync 4.png|720px|Search Sync 4]]</div>
9. '''Click''' ''Upload File''. The file is uploaded to the ''File Path ''displayed.If the uploaded file format is incorrect, an alert message is displayed. The supported file formats will be also be displayed.

If the uploaded file format is incorrect, an alert message is displayed. The supported file formats will be also be displayed.
<div class="image-green-border">[[File:Search Sync 6.png|720px|Search Sync 6]]</div>
10. '''Click''' ''Sync''. The ''Sync Request Accepted'' message is displayed. 
<div class="image-green-border">[[File:Search Sync 7.png|720px|Search Sync7]]</div>
11. '''Click''' ''Ok''. Users can now get data from ES for a given instance’s SysId and can check if it has the latest value or if a sync is needed.

12. '''Select''' ''Get ES Value''.

13. Enter the SysId and '''click''' ''Go''. If the key exists, the latest value from ES will be displayed. If the key does not exist, the error message ''Please enter valid SysId'' is displayed.
<div class="note-box">'''Note''': Data can be fetched from only one instance at a time.</div> <div class="image-green-border">[[File:Search Sync 8.png|720px|Search Sync 8]]</div> <div class="image-caption"> </div> <div class="image-caption"> </div> <div class="image-caption"><span style="color:#008000;">'''''Elastic Search Sync'''''</span></div>
Users can now get data from Elastic search for a given instance’s ''SysId'' so that they can look up the value and identify whether it is the latest or if a sync is needed. If the key exists, the latest value from ES will be displayed. If the key does not exist, the system will display the error message “Could not fetch value for provided SysId”.
<div class="note-box">'''Note''': Data can be fetched from only one instance at a time.</div> <div class="image-green-border">[[File:Search Sync ES.png|720px|Search Sync ES.png]]</div> <div class="image-green-border"> </div>
== Translations Editor Tool ==

The ICM platform is available in different languages and different languages label text are available for localization. However, to make any changes to the localization values, users had to reach out to the Solutions Engineering or Database teams. Sometimes, these changes were minor and of low complexity, but the turnaround time was substantial.

Hence, a self-service ''Translations Editor'' tool has been introduced that contains all strings that are localized.

Users can now download all keys and their localization values as an Excel file, modify multiple values, and upload the modified changes to ICM. Once the values are updated in ICM, the caches are updated automatically to avoid the cache flush and server restart. This has significantly enhanced productivity as the turnaround time to update the Resource Key values has been eradicated.

Using this tool, users can now:

*Search for a specific string using the search bar and update the Resource Key value for Language and Locale.
*Update multiple language strings by selecting and saving the Resource Key value.
*Download and upload the localization key values using Microsoft Excel.
*View the modified values in the ICM instance immediately.

To use the Translations Editor Tool:

1. '''Click''' the ''User Administration'' tile on the ''Home'' page.

2. '''Select '''''Admin Task'' from the drop-down. The ''Admin Task'' page opens.
<div class="image-green-border">[[File:User Administration.PNG|720px|User Administration]]</div>
3. '''Select''' the ''Translation Editor ''task from the left pane.
<div class="image-green-border">[[File:Translation Editor 1.png|720px|Translation Editor 1]]</div>
Users can update translations in the following ways:

1. For selective editing, select a language and a resource key to update the translations.

2. For bulk editing and updation of multiple languages and resource keys, use the Download / Upload option to download an MS Excel sheet.

'''<span style="color:#008000;">Selective Editing to Update Translations</span>'''

For editing Resource Key values selectively:

1. From the ''Select Language'' drop-down, select a language in which you want to edit the labels.  For example, français (French).
<div class="image-green-border">[[File:Translation Editor 2.png|720px|Translation Editor 2]]</div>
The Resource Key and respective values of the selected language are displayed.
<div class="image-green-border">[[File:Translation Editor 3.png|720px|Translation Editor 3]]</div>
2. '''Ente'''r a ''ResourceKey ''value in the''Search'' field to edit. For example, default. All ResourceKey(s) with the ''Par défaut (default)'' values from the French language are displayed.

'''Note:''' ResourceKey is a unique key by which the application gets its label text for different languages.
<div class="image-green-border">[[File:Translation Editor 4.png|720px|Translation Editor 4]]</div>
3. '''Click '''the ''Edit this Resource Key for Multiple Languages '''''icon '''in the ''Actions'' column.

You can change the key for a single language or for multiple languages as required. For example, change ''Par défaut'' to ''défaut'' in French or ''Predeterminado'' in Español (Spanish) to ''Defecto''.
<div class="image-green-border">[[File:Translation Editor 5.png|720px|Translation Editor 5]]</div>
4. '''Click''' ''Update''. The ResourceKey value for ''default ''is updated to ''défaut ''for French and to ''Defecto'' in Spanish.

5. The ''Resources Updated Successfully'' message is displayed. '''Click''' ''Ok''.
<div class="image-green-border">[[File:Translation Editor 6.png|720px|Translation Editor 6]]</div>
You can select the respective languages (French or Spanish) to verify that the resources have been successfully updated.
<div class="image-green-border">[[File:Translation Editor 7.png|720px|Translation Editor 7]]</div> <div class="image-caption"> </div> <div class="image-caption"> </div> <div class="image-caption"><span style="color:#008000;">Bulk Editing in Multiple Languages</span></div>
 For editing Resource Key values of multiple languages in bulk:

1. '''Click''' ''Download File''. A Microsoft Excel file (named BulkActionWorkBookStringResource) that contains all the Resource keys and values for all supported languages in ICM is downloaded.
<div class="image-green-border">[[File:Translation Editor 9.png|720px|Translation Editor 9]]</div>
2. '''Open''' the downloaded Microsoft Excel file.

3. '''Click''' ''Enable Editing''. All ICM supported language Resource keys and their respective values are displayed.

4. '''Edit''' the ResouceKey of multiple languages as required.

5. '''Save''' the Excel file.

6. '''Click''' ''Upload File''. The ''Upload Translations'' window opens.

7. '''Click''' ''SelectFile''. The ''Open ''window opens.

8. '''Select''' the updated Excel file.

9. '''Click''' ''Open''. A warning window opens indicating that this is a heavy operation and can potentially affect overall application performance.

10. '''Click''' ''Ok''. The ''Upload Summary'' displays the number ''of Records Uploaded, Records Processed, ''and''Records Updated Successfully ''values.

11. '''Click''' ''Close''. The label translations have been achieved for multiple languages in bulk.

 

== ICM Health Check Tool ==

The ICM platform hosted on Azure Cloud uses services such as Elastic Search, Redis along with internal components such as APIs and Task services. However, no services were used to provide an insight on the application health except for the ICM Health Check page that provided regular application health checks and application monitoring to be able to detect issues before they became full-fledged outages.

The ICM Health Check page has been further extended to cover additional parameters to help identify potential outages and diagnose issues. The health insights will provide information on how well the ICM Instance and its service is performing, its overall health, as well as its usefulness to users. Users will now be able to access a dashboard (without logging into ICM) that tracks application health alongside usage metrics and application crash data.

The health statuses are classified into three categories:

*''Warning ''- This is indicated with a yellow warning icon
*''Healthy ''- This is indicated with a green check mark icon
*''Unhealthy ''- This is indicated with a red warning icon

The following details are displayed in the Health Check:

*'''Elastic Search Health''': This displays the Status (yellow/green/red), the Elastic Search version and the Uptime, and so on.

*'''Redis Cache Health''': This displays the Redis version, Uptime In Days, CPU usage, Connections Received and Commands Processed, and so on.

*'''API Health''': This displays the API Response Time, Status and Issues and so on.

*'''Database Server Metrics''': This displays the CPU usage percentage, User Connections, Total Server Memory, Disk Read/Write IO/Sec and so on.

*'''IIS Server Metrics''': This displays % 404 HTTP Response Sent, % 500  HTTP Response Sent, percentage of CPU utilization per process, Requests/sec, and so on.
<div class="image-green-border">To view the Health Check, add "Health/ViewHealth" (without quotes) to your ICM URL. </div>
To check the health of your system:<br/> 1. Enter '''''/health/viewhealth''''' at the end of the URL of your ICM instance. For example, [https://apexorg.icertis.com/health/viewhealth https://apexorg.icertis.com/health/viewhealth]. The various tools and their health are displayed.
<div class="image-green-border">[[File:Health Check 1.png|720px|Health Check 1]]</div> <div class="image-green-border"><br/> 2. '''Click''' the + icon next to the tool to view details regarding its health. The details for each of the tools are displayed in 2 columns with the Keys and their respective values as shown below.</div>
'''Elastic Search Health'''<br/> The details for the Elastic Search Health include the status, node total, primary and relocating shards, version, heap percent, uptime, and so on. For example, the Status is green.
<div class="image-green-border">[[File:Health Check 2.png|720px|Health Check 2]]</div>
'''Redis Cache Health'''<br/> The details for the Redis Cache Health include the uptime in days. Connected or blocked clients, rejected connections, CPU usage, and so on. For example, the Uptime in Days is 28.
<div class="image-green-border">[[File:Health Check 3.png|720px|Health Check 3]]</div>
'''API Health'''<br/> The API Health provides the response time. For example, 94 ms.
<div class="image-green-border">[[File:Health Check 4.png|720px|Health Check 4]]</div>
'''Task Service Health    '''<br/> The Task Service Health provides the failed count for keys and when it was last successful. 
<div class="image-green-border">[[File:Health Check 5.png|720px|Health Check 5]]</div>
'''Database Server Metrics'''<br/> The details for the Database Server Metrics Health include the edition, SQL server resource pool stats, and so on.
<div class="image-green-border">[[File:Health Check 6.png|720px|Health Check 6]]</div>
'''IIS Server Metrics'''<br/> The details for the IIS Server Metrics Health include the total method requests/sec, number of seconds an IIS Worker process has been running, the percentage of CPU utilization per process, and so on.
<div class="image-green-border">[[File:Health Check 7.png|720px|Health Check 7]]</div>
 

== Configuration Key Editor Tool ==

The Configuration Key Editor tool facilitates a logged-in user (who has access to Azure subscription) to search and update configuration keys, as and when required. It has been introduced for easier instance management and improved productivity, thus reducing the dependency on the Engineering and DevOps teams.

It includes:

*The ''Config Editor''
*The ''Redis Flush''

The ''Config Editor'' is a self-service tool that allows teams to edit instance configurations without having to connect to the instance machines. Once the key values are changed, the cache is automatically updated to avoid the server restart. The tool only works for non-production environments. The production environment configuration changes are controlled by Operations team, and the tool would not be available for production environment.

The ''Redis Flush'' is a self-service tool which allows Administrators to flush the cache or look up a particular key for its value of ''Delete a Key''. The tool can also be used to perform ''Role Restart'' on the instances to which the user has access.
<div class="note-box">'''Note:'''  The user must have access privileges to an Environment CName in Config Editor.</div> <div class="image-green-border">[[File:Config Editor 1.png|720px|Config Editor 1]]</div>
To use the Configuration Key Editor Tool:<br/> 1. Login to the ICM Tools portal (icmtools.icertis.com) with your ICM credentials.
<div class="image-green-border">[[File:Config Editor 2.png|720px|Config Editor 2]]</div> <div class="image-green-border"> </div> <div class="image-green-border">2. '''Click '''the''Config Editor'' tab on the ''Home ''page.</div> <div class="image-green-border">[[File:Config Editor 3.png|720px|Config Editor 3]]</div>
3. '''Select '''the environment from the ''Environment CName'' drop-down that you need to access for configuration. All the instances that have you have access to will be displayed. 

4. '''Click '''Submit after selecting the environment. The configuration json files for the selected environment are displayed for all available features, security details, database connections, and so on related to the selected instance.
<div class="image-green-border">[[File:Config Editor 4.png|720px|Config Editor 4]]</div>
5. '''Select''' a Config Key from the list to change its value as required. For example, the Config Key AgreementAutoRenewReminderNotificationPeriod has the reminder period set at 3 days may be changes to 2 days.
<div class="image-green-border">[[File:Config Editor 5.png|720px|Config Editor 5]]</div>
6. '''Click '''''Save and Role Restart'' to save the new value of 2 days. The specific json file for the respective CName will be reset (i.e. perform a role restart). This means that the configuration is reset in the elastic search and the server is restarted, so that the new value is reflected on the instance.<br/> 7. '''Click''' ''Download'' to download the entire file so that you can edit it offline and then upload it directly to the instance.

 

== Promote Configurations (P2P) Tool ==

The Promote to Production (P2P) process of the ICM platform helps to move ICM Configuration from source (Config/UAT) environment to target (production) environment. P2P process enables to selectively move ICM configuration. The Promote Configuration Tool or P2P is designed to accomplish just that.

With the 7.11 release, the Promote to Production (P2P) tool to enable users with the following enhancements:

*Vulnerability and Penetration Testing (VAPT) fixes
*Testing open bugs in P2P engine
*Some new validations in the P2P engine
*Better user interface to provide support to P2P and DevOps teams

With the 7.12 release, changes have been made in ICM to support the P2P engine. This functionality, provided to Administrators, can promote ICM configurations/modifications that are made to ICM configurations in pre-production environments to production environments. This tool provides support for contract types, contract type attributes, clauses and templates (along with the documents), notification templates, rules, masterdata, users, user groups and security groups. The elastic search sync is also supported by the tool.
<div class="note-box">'''Note:''' UI changes on contract type, rule set, notification template are not included. Customers using ICM version before 7.12 need to upgrade for this capability.</div>
Here is an overview of the P2P process:
<div class="image-green-border">[[File:P2P 1.png|720px|P2P 1]]</div> <div class="image-caption"><span style="background-color:#008000;">Accessing P2P tool</span></div>
To access the P2P tool: 

1. '''Click '''''Home > ''''Configuration'''''<b>tile. The ''Configuration'' page opens.</b>

2. '''Click '''the ''Promote'' ''Configurations'' tile. The ''Promote Configuration'' page opens. The ''Promote Configurations ''displays the current status of PToP requests and their status.

'''Note: '''Users cannot edit a request that is in ''Completed'' state.
<div class="image-green-border">[[File:P2P 2.png|720px|P2P 2]]</div> <div class="image-caption"> </div> <div class="image-caption"> </div> <div class="image-caption"><span style="color:#008000;">'''''Creating a P2P Request'''''</span></div>
To create a P2P Request:

1. '''Click''' ''Configurations > Promote Configurations > Create Request''. The ''Create P2P Request'' page opens.
<div class="image-green-border">[[File:P2P 3.png|720px|P2P 3]]</div>
2. '''Enter''' a ''Request Name''. For example, ''Procurement''.

3. '''Select''' a ''Target'' from the drop-down. For example, ''Acme Dev''.

4. '''Select''' the ''P2P Request Start Date Time''.

5. '''Select '''the time to trigger an email to the recipient from the ''Intimation Email minutes before P2P Starts ''drop-down list. For example, ''15 Min''.

6. '''Enter''' the intimation recipient Email Id in the ''Notification Email – Intimation ''field.

7. '''Enter''' the notification recipient Email Id in the ''Notification Email – Success ''field.

8. '''Enter''' the notification recipient email Id in the ''Notification Email – Failure ''field.

9. '''Enter''' the notification recipient email Id in the ''Notification Email – Cancel ''field.

10. '''Click''' ''Next. ''The ''Contract Type'' tab opens.

11. '''Select''' the ''Contract Type ''from the ''Available Contract Types''. For example, ''Fiscal Year Master''. The selected Contract Type attributes are available in the ''Attributes Of Selected Contract Type'' columns.

12. '''Select '''the attributes for the selected contract type'''. '''For example, ''Created By''.

13. '''Click '''the right arrow to move the selected contract type and attribute to ''the Selected Contract Types'' and ''Attributes Of Selected Contract Type'' columns respectively.
<div class="image-green-border">[[File:P2P 4.png|720px|P2P 4]]</div>
14. '''Click''' ''Next''. The ''Templates and Clauses tab'' opens.

15. '''Select''' a template from the ''Available Templates'' columns. For example, ''Demo Template''.

16. '''Click '''the arrow key to move the selected template to the S''elected Templates'' column.

17. '''Select''' a clause from the'' Available Clauses'' columns. For example, ''Clause 1_Demo''.

18. '''Click '''the arrow key to move the selected clause to the S''elected Clauses'' column.
<div class="image-green-border">[[File:P2P 5.png|720px|P2P 5]]</div>
19. '''Click '''''Next. ''The ''Rules'' tab opens.

20. '''Select''' a Rule from the ''Available Rule Set Information'' column. For example, ''ICM_Master I Master_Exec Summary on Agr Add Association''.

21. '''Click '''the arrow key to move the selected rule to the S''elected Rule Set Information'' column.
<div class="image-green-border">[[File:P2P 6.png|720px|P2P 6]]</div>
22. '''Click '''''Next''. The ''Notifications ''tab opens.

23. '''Select '''the notification template from the ''Available Notification Template'' columns. For example, ''UserInformation I User Information Expired I UserInformationExpired I User Notifications''.

24. '''Click '''the arrow key to move the selected template to the S''elected Notification Templates'' column.
<div class="image-green-border">[[File:P2P 7.png|720px|P2P 7]]</div>
25. '''Click''' ''Next''. The ''Master Data & Core Seed Data'' tab opens.
<div class="note-box">'''''Note''''': Users can use the ''P2P tool Master Data'' tab for the faster transition of Master Data to production than the Bulk utility tool option.</div>
27. '''Click '''the arrow key to move the selected rule to the S''elected Master Data'' column.

28. '''Select '''the seed data from the ''Available Core Seed Data'' column.

29. '''Click '''the arrow key to move the selected master data to the S''elected Core Seed Data ''column.
<div class="image-green-border">[[File:P2P 8.png|720px|P2P 8]]</div>
30. '''Click '''''Next. ''The ''Users & User groups'' tab opens.

31. '''Select''' the users from the ''Available Users'' column.

32.'''Click '''the arrow key to move the selected user to the S''elected Users'' column.

33. '''Select '''the user group from the ''Available User Groups'' column. 

34. '''Click '''the arrow key to move the selected user to the S''elected User Groups'' column.
<div class="image-green-border">[[File:P2P 9.png|720px|P2P 9]]</div>
35. '''Click''''' Next'' if any or no user or user group is selected. The ''Security Groups'' tab opens.

36. '''Select '''the security group from the ''Available Security Groups'' columns.

37. '''Click '''the arrow key to move the selected security group to the S''elected Security Groups'' column.

38.'''Select '''the KPI from the ''Available KPI’s'' columns.

39.'''Click '''the arrow key to move the selected KPI to the S''elected SaveSearchKPIs'' column. For example, ''Product Authorization''.
<div class="image-green-border">[[File:P2P 10.png|720px|P2P 10]]</div>
40. '''Click''' ''Next''. The'' Verify'' tab opens.

41. '''Verify''' details of the contract types, attributes, templates, clauses, rule set information, notification templates, master data, core seed data, user and user groups, save search KPI and security groups that you have selected.
<div class="image-green-border">[[File:P2P 11.png|720px|P2P 11]]</div>
42. '''Click '''''Create''. The ''Please Confirm'' window opens indicating that downtime is required for this request.
<div class="note-box">'''''Note''''': The P2P tool verifies all the information entered by the user before creating a P2P request.</div>
43.'''Click '''''Yes ''if you wish to proceed. The ''Information ''window opens indicating that the P2P request created successfully.

44.'''Click''' ''Ok''. The P2P request status changes to ''ADDED''.

45. On completion of the P2P request, the status changes to ''Completed''.
<div class="note-box">'''Note''': Users cannot edit a request that is in ''Completed'' state.</div> <div class="image-green-border">[[File:P2P 12.png|720px|P2P 12]]</div>
 

 

 

'''Related Topics: '''[[Agreement_Management|Agreement Management]] | [http://int-wiki.cloudapp.net:8085/ICMHelp7.12/index.php?title=Association_Management Association Management] | [http://int-wiki.cloudapp.net:8085/ICMHelp7.12/index.php?title=Compliance_Management Compliance Management] | [http://int-wiki.cloudapp.net:8085/ICMHelp7.12/index.php?title=Template_Management Template Management] | [http://int-wiki.cloudapp.net:8085/ICMHelp7.12/index.php?title=Clause_Management Clause Management] | [http://int-wiki.cloudapp.net:8085/ICMHelp7.12/index.php?title=Configuration Configuration] | [http://int-wiki.cloudapp.net:8085/ICMHelp7.12/index.php?title=Reports Reports] | [http://int-wiki.cloudapp.net:8085/ICMHelp7.12/index.php?title=Localizing_ICM Localizing ICM]

File:Config Editor 5.png

2020-08-04T06:40:12Z

IDT-4:

File:Config Editor 4.png

2020-08-04T06:39:53Z

IDT-4:

File:Config Editor 3.png

2020-08-04T06:39:35Z

IDT-4:

File:Config Editor 2.png

2020-08-04T06:39:15Z

IDT-4:

File:Config Editor 1.png

2020-08-04T06:38:52Z

IDT-4:

Self-Serve Tools

2020-08-04T06:30:48Z

IDT-4: Created page with " = Self-Serve Tools ="

= Self-Serve Tools =

Outlook Add-in

2020-08-04T06:26:36Z

IDT-4:

= Outlook Add-in =

A .JS version of the ICM Outlook Plugin is available in ICM.. The overall turnaround time for the author is reduced as he no longer needs to download the documents received over email to the local machine, then switch applications and log in to ICM, search the Agreement and then upload the documents.<br/> The provisioned user can now:

*Upload the next version of the Agreement document received over an Email to the Agreement
*Upload the next version of the Associated document (supporting Attachments) received over an Email to the Agreement
*Create a new Association instance and then upload the Associated Document received over an Email to the Agreement

The configuration of the Outlook Add-in is driven by the Masterdata, whereas the list of Agreements and their details are configured by the Saved Searches. You can configure multiple saved searches.

The Outlook Add-in (.JS version) is supported on 2 different platforms:

*For MAC OS (Mojave): it is tested and verified on Microsoft Office 365 (2016 and above).
*For Windows 10: it is tested and verified on Microsoft Office Professional Plus 2013 (15.0.5007.1000) and 2016 (16.0.4849.1000) 64-bit and above.

 

== Uploading the next version of an Agreement received over MS Outlook Email ==

To add the the next version of the Agreement received over Outlook Email:<br/> 1. '''Open''' the Email with the next version of the Agreement.<br/> 2. '''Open''' the ICM Outlook Add-in.<br/> 3. On the ''Details ''tab, '''click '''''Select ICM Agreement / Association'' to look for the Agreement that you want to upload as the next version.
<div class="image-green-border">[[File:Email Outlook Plugin 1.png|820px|Email Outlook Plugin 1]]</div>
4. '''Click''' ''Select Email Attachment'' that you want to upload from the drop-down.<br/> 5. '''Click''' ''Upload''. The ''File(s) uploaded successfully ''message is displayed. If the Agreement fails to be attached, then a message will be displayed indicating that you can retry sending the Attachment.
<div class="image-green-border">[[File:Email Outlook Plugin 2.png|820px|Email Outlook Plugin 2]]</div>
You can ''Preview'' the Agreement in the ICM application on the Agreement ''Details ''page.
<div class="image-green-border">[[File:Email Outlook Plugin 03.png|720px|Email Outlook Plugin 03.png]]</div>
 

== Adding the next version of the Associated Document received over MS Outlook Email to the Agreement ==

<br/> To add the next version of the Associated Document received over Outlook Email to the Agreement :<br/> 1. '''Open '''the Email with the Associated Documents.<br/> 2. '''Open '''the ICM Outlook Add-in.

3. On the ''Details'' tab,'''click''' ''Select ICM Agreement / Association'' to add the next version of the Association. For example, ''Payment Details''.
<div class="image-green-border">[[File:Email Outlook Plugin 4.png|820px|Email Outlook Plugin 4]]</div> <div class="image-green-border"> </div> <div class="image-green-border">4. '''Click''' ''Select Email Attachment'' that you want to upload from the drop-down.<br/> 5. '''Click''' ''Upload''. The ''File(s) uploaded successfully ''message is displayed.</div> <div class="image-green-border"> </div> <div class="image-green-border">[[File:Email Outlook Plugin 5 gr actions.png|820px|Email Outlook Plugin 5]]</div>
6. '''Click''' the ''View Record'' icon to view the Attachment details. 
<div class="image-green-border">[[File:Email Outlook Plugin 6.png|820px|Email Outlook Plugin 6]]</div>
7. '''Click '''the ''Preview'' icon to view the Attachment. 
<div class="image-green-border">[[File:Email Outlook Plugin 7.png|820px|Email Outlook Plugin 7]]</div>
 

== Creating a new instance of an Association and adding an Associated Document received over MS Outlook Email ==

To create a new instance of an Association and add the Associated Document received over Outlook Email to the Agreement:<br/> 1. On the ''Details'' tab,'''click''' ''Select ICM Agreement / Association ''to create a new instance of the Association. For example, adding an Association to the''Payment Details A''ssociation.<br/> 2. Enter a name for the new instance of the Association.<br/> 3. '''Click''' the ''Add Association'' button to add the new instance of the Association.
<div class="image-green-border">[[File:Email Outlook Plugin 8.png|820px|Email Outlook Plugin 8]]</div> <div class="image-green-border"><br/> 4. '''Click '''the ''Select Email Attachment'' field to select the document that you want to attach to the newly created instance.</div> <div class="image-green-border"> </div> <div class="image-green-border">[[File:Email Outlook Plugin 9.png|820px|Email Outlook Plugin 9]]</div> <div class="image-green-border"><br/> 5.'''Click''' ''Upload''. The document is now attached to the newly created instance. The ''File(s) uploaded successfully'' message is displayed.</div> <div class="image-green-border"> </div> <div class="note-box">'''Note: '''The Association is only created with the name. The remaining mandatory fields need to be entered in the ICM application. </div> <div class="image-green-border"> </div> <div class="image-green-border"> </div> <div class="image-green-border">[[File:Email Outlook Plugin 10.png|820px|Email Outlook Plugin 10]]</div>
6. The document is now available on the ''Associations'' tab in the ICM application as the next version.

 

 

'''Related Topics:''' [http://int-wiki.cloudapp.net:8085/ICMHelp7.12/index.php?title=Icertis_Experience_for_Word Icertis Experience for Word] | [http://int-wiki.cloudapp.net:90/ICMHelp7.9/index.php?title=Template_Management Template Management] 

Bulk Actions

2020-08-02T12:20:25Z

IDT-4:

= Bulk Actions  =

Users can perform bulk actions using the ''Bulk Actions'' tile on the ''Home ''page to create and update multiple entities directly within ICM. When uploaded, these entities become part of the ICM workflow and can be managed within ICM itself. You can also perform these actions using Excel Add-in. With this utility, the overhead of installing and updating ICM Excel Add-in periodically on your machine can be avoided, besides, reducing the time taken to create and/or update records in ICM.
<div class="image-green-border">[[File:Bulk Actions.PNG|720px|Bulk Actions]]</div>
Using Bulk Action you can:

*Create new Agreements and Masterdata
*Update existing Amendments and Agreements.
*Create/update Associations with Agreements or Amendments.
*Process multiple batches in parallel, instead of sequentially processing them.
*Get drop-downs in the Workbook for static and dynamic lists to select from. For example, Type Of Paper, Workflow Action, Org Unit, Lookup/Cascade Attributes, etc.
*Easily differentiate each column in the Workbook for mandatory, user selected, Information fields due to the color-coding.

Feature highlights: 

*Optimal use of APIs and parallel processing for improved performance, thus allowing multiple users to add multiple batches of files simultaneously. 
*Eliminates the need of using a third party application such as Excel Add-in to upload entities in bulk.
*Ability to select Attributes from ICM user interface (which is not possible when using Excel Add-in).
*Ability to check the number of valid Templates for an Amendment when using ''Own ''Type of paper.
*Access control by showing the Bulk Actions tile only to users with ''Manage ''privileges.
*Provides error and status files for every batch processed. The status file indicates if the records passed or failed the validations. The error file indicates the specific validation errors while processing the batch.

You can enable the ''Bulk Actions ''tile through the Security Groups. 

To enable the ''Bulk Actions ''tile: 

#'''Click '''''User Administration > Security Groups > Security Groups ''on the ''Home ''page. The ''Security Groups ''index page opens. 
<div class="image-green-border">[[File:7.12 BulkActions 1.png|720px|7.12 BulkActions 1.png]]</div> <div class="image-green-border"> </div> <ol start="2">
<li>'''Click '''the ''View Record'' icon next to the ''Security Group'' you want to view. The ''Security Group Details'' page opens.</li>
</ol>
<div class="image-green-border">[[File:7.12 Edit Sec grp.png|720px|7.12 Edit Sec grp.png]]</div> <div class="image-green-border"> </div> <ol start="3">
<li>'''Click '''''Edit''. The ''Edit Security Groups'' page opens.</li>
</ol>
<div class="image-green-border">[[File:7.12 Edit Sec grp 2.png|720px|7.12 Edit Sec grp 2.png]]</div> <div class="image-green-border"> </div> <ol start="4">
<li><div class="image-green-border">'''Navigate '''to the ''Privileges ''section in the Security Group and search for ''Bulk Action ''under the ''Entity Name ''column. </div> </li>
</ol>
<div class="image-green-border"> </div> <div class="image-green-border">[[File:Edit Security Group.png|720px|Edit Security Group]]</div> <ol start="5">
<li>'''Select '''''Bulk Action ''option under ''Manage ''or ''View ''column depending on whether you want to provide ''Manage ''or ''View ''privileges to the ''Bulk Action ''tile. The ''Bulk Actions ''tile will be displayed on the ''Home ''page. </li>
</ol>

The Bulk Actions tile enables you to:

*Update Existing Entities. For example making changes to Agreements that are in ''Executed ''state
*Populate the Workbook.You can use the same Workbook to upload multiple Agreement records 
*Add a new Batch
*Process the Batch
*View the Status and Error files  

== Creating New Agreement using Bulk Actions ==

To create a new Agreement:

1. '''Click '''''Bulk Actions ''tile on the ''Home ''page. The ''Bulk Action Management ''page opens.

2. '''Click '''the ''Create New'' tile. The Create page opens with 2 tabs: Details and Attributes

3. In the Details section, '''select '''''Create Agreement'' from the ''Bulk Upload Action'' drop-down.
<div class="image-green-border">[[File:7.9 Bulk Actions - Create Agreement - User Provisioning home.png|720px|7.9 Bulk Actions - Create Agreement - User Provisioning.png]]</div> <div class="image-green-border"> </div> <div class="image-green-border">4. '''Select''' a ''Contract Type Name'' from the drop-down list. The respective Associations of the Contract Type are displayed. Mandatory Associations are auto-selected and can not be removed.</div> <div class="image-green-border">5. '''Select '''Association(s).</div> <div class="image-green-border"> </div> <div class="image-green-border">[[File:Bulk Actions Create New with Association - New 1 home.png|720px|Bulk Actions Create New with Association - New 1]]</div> <div class="image-green-border"> </div> <div class="image-green-border">6. '''Click '''''Next''. All Attributes related to the Contract Type and the Associations will be loaded on the Attributes page. User can select the Attributes. The mandatory Attributes may already be displayed. </div> <div class="image-green-border"> </div> <div class="image-green-border">[[File:Bulk Actions Create New with Association - New 2.PNG|720px|Bulk Actions Create New with Association - New 2]]</div> <div class="image-green-border"> </div> <div class="image-green-border">7. Similarly, you can select the Associations.</div> <div class="image-green-border">8. '''Click '''''Generate Workbook''. The Workbook will contain the users selected Agreement, Associations and the selected Attributes.</div> <div class="image-green-border"> </div> <div class="image-green-border">[[File:Bulk actions workbook 7.8 home.png|720px|RTENOTITLE]]</div> <div class="image-green-border"> </div> <div class="image-green-border">9. Download the Workbook. The downloaded Excel file will display:</div>
*The mandatory Attributes (such as Contract Value) are in red
*The non-mandatory Attributes (such as Name) are in white with a light green background
*The system Attributes are in white with a dark green background
*The information Attrbiutes are in white with a blue background
<div class="note-box">'''Note''': Do not edit the headers as well as system attributes. However, the mandatory Attribute values must be entered. </div>
 
<div class="image-green-border">[[File:Bulk actions excel sheet 7.8.png|720px|RTENOTITLE]]</div> <div class="image-green-border"> </div> <div class="image-green-border">10. '''Enter '''the ''Parent Agreement Name'' and the ''Name''; the child name properties are automatically displayed. The downloaded file will also contain an Information sheet which contains the information of the Actions (such as Create Agreement) selected by the user and the Sheet Names (Peer Association).</div> <div class="image-green-border"> </div> <div class="image-green-border">[[File:Bulk actions workbook 2 7.8.png|720px|RTENOTITLE]]</div> <div class="image-green-border"> </div> <div class="image-green-border"><div class="note-box">'''Note:''' The Sheet Names have a 30-character limit. ''Currency code, Third Party Paper, Organization Unit,'' etc. are dynamic values fetched from the Contract Type.</div>
[[File:Bulk Actions workbook 3 7.8.png|720px|RTENOTITLE]]

11. '''Upload '''the Workbook with all the sheets as a zip file.

12. '''Click '''''Add Batch''. The ''Add Batch'' window opens.
<ol style="list-style-type:lower-alpha;">
<li>'''Enter''' the ''Batch Name''</li>
<li>'''Select '''the ''Data File''</li>
<li>'''Select '''the ''Attached Zip File''</li>
</ol>

[[File:Bulk actions Add Batch Window.png|420px|RTENOTITLE]]

13. '''Click '''''Add''. The batch file is displayed on the ''Bulk Action Management'' ''Index'' page with a status''Added to Queue''. The status changes to''Completed'' when the batch is successfully uploaded.

[[File:Bulk actions batch added 7.8 home.png|720px|RTENOTITLE]]

14. '''Click''' the arrow in the ''Action ''column of the batch to download the status file. The ''Download Status File'' window opens.

[[File:Bulk Actions download status file 7.8.png|480px|RTENOTITLE]]

15. The ''Status File'' displays the status of the files that are uploaded successfully, partially or failed to upload. The Status column displays the status of the files and the reason for partial success or failure is displayed in the Reasons column. For example, if an Association fails but the Agreement is successfully uploaded, then it will be a partial success.

[[File:Bulk actions error file 7.8.png|720px|RTENOTITLE]]

16. '''Click''' the ''Error File'' button on the ''Download Status File'' window to download the error processing file to understand the reason for failure.

[[File:Bulk Actions error processiong file 7.8.png|720px|RTENOTITLE]]
<div class="note-box">'''Note''': Follow the same process to create new Masterdata.</div> </div>
== Adding an Amendment using Bulk Actions ==

1. '''Click '''''Bulk Actions ''tile on the ''Home ''page. The ''Bulk Action Management ''page opens where you can update the existing entities by adding Amendments using the ''Update Existing ''tile. 

2. '''Click '''''Update Existing ''on the ''Bulk Action Management ''page. The ''Update ''page opens. 
<div class="image-green-border">[[File:Update Existing Entities home.png|720px|Update_Existing_Entities]]</div>
3. '''Perform '''the following actions on this page:'' ''
<ul style="margin-left: 40px;">
<li>Bulk Upload Action: '''Select '''''Add Amendments ''from the drop-down. This helps in adding an Amendment to an existing Agreement.</li>
</ul>
<div class="note-box">'''Note''': You can add Amendments only to Agreements in ''Executed ''state. </div>
*Saved Search: You must have a Saved Search created before you can update any entity. '''Select '''the Saved Search from the drop-down, that shows all the Saved Searches by the logged in user, as well as Global Saved Searches. 
*Contract Type Name: '''Select '''the Contract Type name from the drop-down. The user can view only those Contract Types that are associated with the Saved Search, and to which the user has access to. 

4.'''Click '''''Next.''
<div class="image-green-border"> </div> <div class="image-green-border">[[File:7.9 Bulk Actions - Update Existing - User Provisioning home.png|640px|7.9 Bulk Actions - Update Existing - User Provisioning]]</div>
== Selecting Attributes  ==

When adding an Amendment to an existing Agreement, select only the Attributes that you want to modify.
<div class="note-box">'''Note''': Values for non-editable Attributes and system Attributes such as Agreement Code cannot be selected. The metadata for the remaining Attributes is copied as-is from the parent Agreement. </div>
This page displays only Attributes related to Contract Type you have selected. You can select only the editable Attributes. If you select a dependent Attribute, the primary Attribute also gets selected by default. The Attributes selected on this page will be visible in the Workbook you generate. For example, ''Effective Date'' and ''Expiry Date''. 

To select any additional Attributes: 

#'''Select '''the Attributes from the ''Available Attributes ''list and move it to the ''Selected Attribute ''column. For example, ''Use Amendment Template. '''''Click '''''Yes ''when prompted to add parent Attribute. 
#'''Click '''''Generate Workbook. ''This generates and downloads the Workbook with the system Attributes that are inherited as well the Attributes that you selected. 
<div class="note-box">'''Note''': The file name of the downloaded Workbook is the same as the Contract Type you selected on the ''Details ''page. </div> <div class="image-green-border"> </div> <div class="image-green-border">[[File:Generate Workbook.png|640px|Generate_Workbook]]</div> <ol start="3">
<li><div class="image-green-border">'''Open '''the Workbook that was downloaded  on your local drive. This Workbook contains the information about the selected Attributes and Contract Type. </div> </li>
</ol>
<div class="image-green-border">[[File:View Workbook 1 Bulk Action C7 SP7.png|720px|RTENOTITLE]]</div> <ol start="4">
<li>'''Click '''the ''Enable Editing ''button on the Excel Workbook to make changes as required.</li>
</ol>

== Populating the Workbook  ==

The Workbook that was generated in the previous step contains the Attributes you have selected as few additional system Attributes. You should see the following Attributes in this Workbook: 

*''Parent Agreement Code'': This is a system-generated field, the value of which should not be changed as it will result in an error. It contains the Agreement codes of the Agreements that are part of the Contract Type you selected. 
*''Effective and Expiry Dates'': These are user-editable fields that are included in the workbook because we selected them when generating the Workbook in the example above. 
*''Use Amendment Template'': This Attribute plays an important role in selection of the Template when creating the Amendment. The system will: 
**Either use the specified Template or,
**The last approved version of the Template in the parent Agreement or,
**Auto-select a Template based on various combinations of this Attribute such as ''Type Of Paper, Template Name ''and ''File Path ''Attributes''. ''

User must select this Attribute on the ''Attributes ''page to achieve the desired result as mentioned below: 
<ul style="margin-left: 40px;">
<li>If the ''Type Of Paper ''is ''Own ''and a valid Template name is specified in the ''Template Name ''column, then ICM attaches that valid Template to the Amendment. </li>
<li>If the ''Type Of Paper ''is ''Own, ''the ''Use Amendment Template ''is set to ''True, ''and the ''Template Name ''column is blank, then ICM automatically selects the valid Template. If there is exactly one Template applicable for the combination of the Attribute metadata, the ICM automatically selects that Template to create an Amendment. If there are several valid Templates that are applicable, the ICM generates an error and provides a list of Templates to select from.</li>
<li>If the ''Type Of Paper ''is ''Own,'' the ''Use Amendment Template'' is set to ''False,'' and the ''Template Name'' column is left blank, ICM selects the last approved version of the parent Agreement to create that Amendment.</li>
<li>If the ''Type Of Paper ''is ''Third Party ''and user specifies the file name in the ''File Path'' column, the specified file is used to create that Amendment.</li>
<li>If the ''Type Of Paper ''is ''Third Party ''and ''File Path'' column is left blank, ICM uses the last approved version of the parent Agreement to add that Amendment.</li>
</ul>

*''Parent Agreement Status'':This is a system-generated field, the value of which should not be changed as it will result in an error. It indicates the status of the Agreement to which you are adding the Amendment. When adding an Amendment, the parent Agreement status will always be ''Executed.'' 
*''Organization Unit'': This is a system-generated field, the value of which should not be changed as it will result in an error. 
*''Type of Paper'': This is mandatory and user-editable Attribute, the values of which may be ''Own ''or ''Third Party.''
*''Template Name'': This is a user-defined field. If the ''Type of Paper'' is ''Own'' ,the value in this field is considered when adding an Amendment.
*''File Path'': This is a user-defined (editable) field. If the Type Of Paper is ''Third Party'' the value in this field is considered when adding an Amendment. '''Specify '''the complete name of Agreement document, including the file extension such as .pdf, .docx. The file name mentioned here must be part of the zip file you upload to ICM when adding a new batch.
*''Actions'': This field is used to specify the workflow action. In this release, only ''Create'' action is supported.

== Understanding the Information Sheet ==
<div>
*ICM adds a default sheet named ''Information,'' where you can find general information about the ''Upload'' action you have selected as well as the mapping of Contract Type name with sheet names. 
*<u>'''Do not make any changes to this sheet.'''</u>
*When the records have been updated and the Workbook is populated, you must create a zip file that contains all the files mentioned in the Workbook, including the file names mentioned under ''File Path'' column, or the file names mentioned under Attributes with ''File'' data type. This zip file is required for performing the next step of ''Adding a new Batch''. 
*The zip file can contain all the file formats supported by ICM, and can be up to 100 MB in size. 
</div>
== Adding a new Batch ==

You must create a batch to update existing Entities in ICM, such as new set of Amendments. Creating a new batch enables the system to upload all the changes you made to the workbook and process them. The number of records in the batch is indicated in the ''Batch Size'' column.

You can create a batch using the following steps: 

#<div class="image-green-border">'''Click '''the ''Add Batch [[File:Add Batch icon.png|RTENOTITLE]] '' icon on the ''Bulk Action Management ''page. The ''Add Batch ''window opens from where you can upload the populated Workbook to ICM.</div>
<div class="image-green-border">[[File:Add Batch Details.PNG|480px|RTENOTITLE]]</div> <ol start="2">
<li>'''Enter '''the Batch Name. For example, ''AutomationAgreement.''</li>
<li>'''Click '''''Choose File ''next to the ''Data File ''field to select the Workbook to upload. You should upload the Workbook that you populated in the previous steps. </li>
<li>'''Click '''''Choose File ''next to the ''Attached Zip File ''field to select the zip file that contains all the files you have mentioned in the Workbook, either as a ''File Path ''or as '' File Type ''Attribute.</li>
<li>'''Click '''the ''Add ''button. The Workbook will be uploaded to ICM with a status of ''Added to Queue. ''The batch is added to the queue for automatic validation. </li>
</ol>

</div>

== Processing the Batch  ==

The Batch that you added in the ''Adding a Batch ''section will be processed by ICM. Multiple users can create multiple batches at the same time. These batches would be queued and ICM would pick them up for processing from the queue. The status of the batch can be as follows: 

*''Added to Queue: ''This is the status of the Batch when you upload the Workbook using the ''Add Batch ''button on the ''Bulk Action Management ''page. ICM validates the accuracy of the records in the batch. 
*''In Process: ''Indicates that the batch is being processed after the user has uploaded the batch. 
*''Completed: ''The status of the batch changes automatically to ''Completed ''after the batch is processed. 

While processing the Batch, every record is validated for:

*Correct data type for all records being uploaded. 
*Any Template that may have been selected is correctly added.
*All files specified in ''File Path ''column or ''File Type ''Attribute of the workbook are physically present in the uploaded zip file. 
*In case of ''Add Amendments Upload ''action, Agreements of the selected Contract Types are in ''Executed ''state.'''
*Lookup and Cascade Attributes validation:
**Lookup Attribute: Based on the Masterdata, specific values will be displayed for selection. For such Attributes, ICM checks if the value you have specified is present is the Masterdata or not.
**Cascade Attribute: Based on the value selected in the Lookup Attribute, specific values will be displayed for selection. For such Attributes, ICM checks if the value you have specified is valid for the combination of lookup value and the Masterdata associated with it.

== Bulk Action Management  ==

Clicking the ''Bulk Actions'' tile navigates you to the ''Bulk Action Management'' page.

The following tasks can be performed here:

*Adding a new batch 
*Viewing the status of a batch 
*Updating Existing Entities 
<div class="image-green-border">To view the status of the batch, '''click '''the   icon on ''Bulk Action Management ''page. </div> <div class="image-green-border"> </div> <div class="image-green-border">[[File:Batch Upload Success 1.PNG|720px|RTENOTITLE]]</div>
The following columns are displayed here:

*''Status:'' displays the following states of the batches that are processed.
**''Added to Queue: ''indicates that the user added a new batch for processing.
**''In Process: ''indicates that the batch is being processed after the user has uploaded the batch. 
**''Completed: ''indicates that processing of the batch is complete, even though errors might be encountered when validating the records. 

The ''Download Status Files ''icon appears in the ''Actions ''column after the status of the batch changes to ''Completed. ''Any errors during the processing of the batch are displayed in the ''Failure ''column on the ''Bulk Action Management ''page.

*''Success: ''displays the number of records that passed the validation process.
*''Failure: ''displays the number of records that failed the validation process.
*''Start Time: ''displays the Date and Time when the batch processing started.
*''End Time: ''displays the Date and Time when the batch processing concluded.
*''Execution Time: ''displays the Time taken to process the batch and change the status of the Batch to ''Completed.''
*''Created By: ''displays the name of the user who created the batch.
<div class="note-box">'''Note''': By default, users can view only the batches they have added to queue. The Administrator can view the batches for all users.</div>
== Viewing the Status and Error Files  ==

After a batch is processed, a ''Download Status Files'' icon is displayed in the ''Actions ''column.

To view the files: 

#'''Click '''the ''Download Status File ''icon. The ''Download Status Files''' '''''window opens'''. '''
#'''Click '''the ''Status File ''or ''Error File ''to download the applicable file of the batch. 
<div class="image-green-border">[[File:Download Status ErrorFiles.png|480px|RTENOTITLE]]</div>
*The ''Status File'' shows the status of the records that were processed in a batch along with any failures.
*The number of failed records in the file will correspond to the number in the ''Failure ''column on the ''Bulk Action Management ''page.
*The ''Warnings and Errors ''columns in the Error File indicates the specific issue. If the validation of a record fails for multiple reasons, then all such reasons are mentioned against that record.
*If you want to process the failed records, then you must create a new batch and upload a Workbook that contains corrected values of the failed record. You are not required to start the process from the beginning (select Upload action, select Attributes, and so on.) You can reuse the Workbook that was generated earlier. All records that have been successfully created in ICM can be viewed from the UI.

 

== Updating the Existing Entities ==

1. '''Select''' the ''Update Existing ''tile on the Bulk Action Management window. The Update page opens with the Details tab active.

2. '''Click '''the ''Bulk Upload Action'' drop-down. The following Bulk Upload Actions are available:

*''Add Amendment''
*''Update Agreement''
*''Update Amendment''
*''Update Executed Agreement''
*''Update Executed Amendment''
*''Add Association to Agreement''
*''Add Association to Amendment''
<div class="image-green-border">''[[File:Bulk actions update existing 7.8 home.png|720px|RTENOTITLE]]''</div> <div class="image-green-border"> </div> <div class="image-green-border">3.'' '''''Select''' '''Update Action''' from the drop-down list. For example, ''Update Agreement''.</div> <div class="image-green-border">
4. '''Select '''''Saved Search''. All saved searches that the user has access to get populated in the drop-down.

5. '''Select '''''Contract Type Name. ''This list will be populated based on the selected Saved Search.

6. '''Select '''''Association(s)'' that you want to update for this Agreement.

7. '''Click '''''Next''. The ''Attributes'' tab is active. You can now select the Attributes for the selected Agreement and the Associations.

''[[File:Bulk actions update esisting Details page 7.8 home.png|720px|RTENOTITLE]]''

8. '''Click '''''Generate Workbook''. The Workbook will contain the Agreement, Associations and the selected Attributes. You can make changes, upload the files to ICM and continue with the workflow.
<div class="note-box">'''Note''': Follow the same process to update other entities.</div>
 

 

 

'''Related Topics''': [[Agreement_Management|Agreement Management]] | [[Agreements_Page|Agreements Page]] | [[Add_Amendment_to_an_Agreement|Add Amendment to an Agreement]]
</div>

File:Bulk Actions.PNG

2020-08-02T12:18:40Z

IDT-4:

Agreement Management

2020-08-02T12:12:39Z

IDT-4:

= Agreement Management =

The Agreement Management section enables you to manage all aspects of creating and editing Agreements from a single page. From this page, you can do the following tasks:

*View and manage all your Agreements on the ''Agreements ''page.
*Create new Agreements on the Creating an Agreement.
*Search, view, and manage all your existing requests on the ''Requests'' page.
*Create new Requests on the ''Create Request'' page.
<div class="image-green-border">[[File:Agreement Mgmt.PNG|720px|Agreement Mgmt]]</div>
In ICM, the terms Agreement and Contract are used interchangeably and mean the same thing. In this Help, we will use the word ''Agreement'' when discussing Agreements, whereas Contracts will be discussed with reference to Contract Types.

While the actual workflow of an Agreement in ICM can be quite complex and involved, it is summarized in these five steps:
<div class="image-green-border">[[File:Agreement Management - Agreement Overview.png|720px|Agreement Management - Agreement Overview.png]]</div>
1. '''Create Contract Request:''' When someone in your organization, such as a department manager wants to engage a vendor for certain services over a length of time, the individual can raise that request with the procurement department that can then work on that Agreement. Depending on the workflow adopted, your organization may:

*Enforce this step so that all contracts are initiated and drafted only by one department, or
*Make this step completely optional, so it can be skipped by someone who is an expert at contracting and its process.

2. '''Create Agreement:''' In this step, the primary owner or the creator of the agreement select the contract type, selects attributes and template, and verifies the details that you entered in the agreement. See Create Agreement Page for complete details.

3. '''Review Agreement: '''After the primary owner has created an internal draft of the agreement, it is published. The published draft can be sent for reviews (optional, if decided by the Primary Owner of the Agreement) .

4. '''Approve Agreement: '''Once the Agreement is reviewed, it can be sent for approvals to the team of people that are working on this Agreement in various roles.

5. '''Execute Agreement:''' Several people can review and approve the Agreement before it is ready to be signed. After all approvals are obtained, the Agreement is sent to be signed by both the parties. With both parties signing (known as internal and external signatories in ICM), the Agreement is said to be executed and is now in force.

'''Notes:'''<br/> If an incorrect document was initially uploaded by a signatory, a user with the appropriate privilege can upload the correct document even after the agreement is executed. The uploaded document must be a PDF.''' '''The ''Executed'' state of the Agreement remains unchanged. Only the following roles have this privilege:<br/>    * Primary Owner<br/>    * Secondary Owner<br/>    * Contributor<br/> <br/> If changes are required in the Agreement that is in an ''Executed'' state, the Primary Owner of the Agreement can add an Amendment. Changes may be required due to any of the following business reasons:<br/>    * The payment terms of the Agreement have changed.<br/>    * The Statement of Work (SOW) in the Agreement has changed.<br/>    * The terms and conditions of the Agreement have changed due to the introduction of a new regulation.

6. '''Support Multi-party Agreements''': ICM offers full platform support for multi-party Agreements. You can now use a single system for managing all your Agreements and capture multiple other parties and divisions on an Agreement seamlessly. It allows you to search only metadata instead of searching multiple attributes, thus making it user-friendly. There is no limit on the number of parties that can be added. All parties can sign the Agreements either manually or electronically, based on the signing sequence set in ICM. It also supports parallel signatures independent of the status of either party.

Such Agreements include Non-Disclosure Agreements, Sell Agreements or business-specific Agreements. For example, A healthcare business group needs Contract Types for managing their contracts, but the Mergers and Acquisitions department needs their own Contract Types.<br/>  <br/> Key capabilities of Multi-Party:

*Captures multiple values of Attributes and/or Masterdata
*Tags these multiple instances in the Template
*Supports the signature workflow with these multiple instances of customer data
*Supports multiple Rules (say for approval workflow) based on the individual values selected. For example, in an Agreement, if 3 Divisions are selected, the approval process should support approvals from all 3 divisions.
*Supports visibility in such a one-to-many environment; For example, in the multi-division scenario, the Agreement visibility too should be enabled for multiple divisions.

== Contract Lifecycle Management, Artificial Intelligence, and Bulk Upload ==

For organizations looking to optimize their contract lifecycle management processes and digital transformation, this release includes capabilities to manage the bulk upload of larger volumes of legacy contracts, and Artificial Intelligence (AI) driven enhancements to improve discovery, identification, and digitization of third-party, legacy and federal contracts.

Using ICM, you have the:

*Ability to create US Federal Acquisition Regulations clause repository and to manage US Federal Contracts using ICM.
*Accelerate contract digitalization and management by quickly converting legacy contracts into live contracts with AI-enhanced contract digitization capabilities which also help in AI-powered clause and attribute discovery. Excel based bulk upload capability to do so at scale.
*Upload legacy Agreements in bulk supporting a larger volume of agreements and other entities using Excel utility.

 

 

 
<div class="related_topics">'''Related Topics:''' [[Searching_agreements_and_requests|Searching Agreements and Requests]] | [[Adding_Supporting_Documents_to_an_Agreement|Adding Supporting Documents to an Agreement]] | [[Setting_auto-expiry_for_an_Agreement|Setting auto-expiry for an Agreement]] | [[Bulk_Actions|Bulk Actions]] | [[User_Administration|User Administration]] | [[Association_Management|Association Management]] | [[Compliance_Management|Compliance Management]] | [[Template_Management|Template Management]] | [[Clause_Management|Clause Management]] | [[Configuration|Configuration]] | [[Reports|Reports]] | [[Localizing_ICM|Localizing ICM]]</div>

File:Create Request.PNG

2020-08-02T12:11:33Z

IDT-4:

File:Compliance Management.PNG

2020-08-02T12:11:08Z

IDT-4:

File:Template Management.PNG

2020-08-02T12:10:48Z

IDT-4:

File:Clause Management.PNG

2020-08-02T12:09:35Z

IDT-4:

File:Associations.PNG

2020-08-02T12:09:06Z

IDT-4:

File:Agreement Management.PNG

2020-08-02T12:08:48Z

IDT-4: IDT-4 uploaded a new version of File:Agreement Management.PNG

File:Agreement Management.PNG

2020-08-02T12:08:23Z

IDT-4: IDT-4 uploaded a new version of File:Agreement Management.PNG

File:Agreement Mgmt.PNG

2020-08-02T12:07:55Z

IDT-4:

Agreement Management

2020-08-02T11:50:17Z

IDT-4:

= Agreement Management =

The Agreement Management section enables you to manage all aspects of creating and editing Agreements from a single page. From this page, you can do the following tasks:

*View and manage all your Agreements on the ''Agreements ''page.
*Create new Agreements on the Creating an Agreement.
*Search, view, and manage all your existing requests on the ''Requests'' page.
*Create new Requests on the ''Create Request'' page.

In ICM, the terms Agreement and Contract are used interchangeably and mean the same thing. In this Help, we will use the word ''Agreement'' when discussing Agreements, whereas Contracts will be discussed with reference to Contract Types.

While the actual workflow of an Agreement in ICM can be quite complex and involved, it is summarized in these five steps:
<div class="image-green-border">[[File:Agreement Management - Agreement Overview.png|720px|Agreement Management - Agreement Overview.png]]</div>
1. '''Create Contract Request:''' When someone in your organization, such as a department manager wants to engage a vendor for certain services over a length of time, the individual can raise that request with the procurement department that can then work on that Agreement. Depending on the workflow adopted, your organization may:

*Enforce this step so that all contracts are initiated and drafted only by one department, or
*Make this step completely optional, so it can be skipped by someone who is an expert at contracting and its process.

2. '''Create Agreement:''' In this step, the primary owner or the creator of the agreement select the contract type, selects attributes and template, and verifies the details that you entered in the agreement. See Create Agreement Page for complete details.

3. '''Review Agreement: '''After the primary owner has created an internal draft of the agreement, it is published. The published draft can be sent for reviews (optional, if decided by the Primary Owner of the Agreement) .

4. '''Approve Agreement: '''Once the Agreement is reviewed, it can be sent for approvals to the team of people that are working on this Agreement in various roles.

5. '''Execute Agreement:''' Several people can review and approve the Agreement before it is ready to be signed. After all approvals are obtained, the Agreement is sent to be signed by both the parties. With both parties signing (known as internal and external signatories in ICM), the Agreement is said to be executed and is now in force.

'''Notes:'''<br/> If an incorrect document was initially uploaded by a signatory, a user with the appropriate privilege can upload the correct document even after the agreement is executed. The uploaded document must be a PDF.''' '''The ''Executed'' state of the Agreement remains unchanged. Only the following roles have this privilege:<br/>    * Primary Owner<br/>    * Secondary Owner<br/>    * Contributor<br/> <br/> If changes are required in the Agreement that is in an ''Executed'' state, the Primary Owner of the Agreement can add an Amendment. Changes may be required due to any of the following business reasons:<br/>    * The payment terms of the Agreement have changed.<br/>    * The Statement of Work (SOW) in the Agreement has changed.<br/>    * The terms and conditions of the Agreement have changed due to the introduction of a new regulation.

6. '''Support Multi-party Agreements''': ICM offers full platform support for multi-party Agreements. You can now use a single system for managing all your Agreements and capture multiple other parties and divisions on an Agreement seamlessly. It allows you to search only metadata instead of searching multiple attributes, thus making it user-friendly. There is no limit on the number of parties that can be added. All parties can sign the Agreements either manually or electronically, based on the signing sequence set in ICM. It also supports parallel signatures independent of the status of either party.

Such Agreements include Non-Disclosure Agreements, Sell Agreements or business-specific Agreements. For example, A healthcare business group needs Contract Types for managing their contracts, but the Mergers and Acquisitions department needs their own Contract Types.<br/>  <br/> Key capabilities of Multi-Party:

*Captures multiple values of Attributes and/or Masterdata
*Tags these multiple instances in the Template
*Supports the signature workflow with these multiple instances of customer data
*Supports multiple Rules (say for approval workflow) based on the individual values selected. For example, in an Agreement, if 3 Divisions are selected, the approval process should support approvals from all 3 divisions.
*Supports visibility in such a one-to-many environment; For example, in the multi-division scenario, the Agreement visibility too should be enabled for multiple divisions.

== Contract Lifecycle Management, Artificial Intelligence, and Bulk Upload ==

For organizations looking to optimize their contract lifecycle management processes and digital transformation, this release includes capabilities to manage the bulk upload of larger volumes of legacy contracts, and Artificial Intelligence (AI) driven enhancements to improve discovery, identification, and digitization of third-party, legacy and federal contracts.

Using ICM, you have the:

*Ability to create US Federal Acquisition Regulations clause repository and to manage US Federal Contracts using ICM.
*Accelerate contract digitalization and management by quickly converting legacy contracts into live contracts with AI-enhanced contract digitization capabilities which also help in AI-powered clause and attribute discovery. Excel based bulk upload capability to do so at scale.
*Upload legacy Agreements in bulk supporting a larger volume of agreements and other entities using Excel utility.

 

 

 
<div class="related_topics">'''Related Topics:''' [[Searching_agreements_and_requests|Searching Agreements and Requests]] | [[Adding_Supporting_Documents_to_an_Agreement|Adding Supporting Documents to an Agreement]] | [[Setting_auto-expiry_for_an_Agreement|Setting auto-expiry for an Agreement]] | [[Bulk_Actions|Bulk Actions]] | [[User_Administration|User Administration]] | [[Association_Management|Association Management]] | [[Compliance_Management|Compliance Management]] | [[Template_Management|Template Management]] | [[Clause_Management|Clause Management]] | [[Configuration|Configuration]] | [[Reports|Reports]] | [[Localizing_ICM|Localizing ICM]]</div>

File:Health Check 5.png

2020-08-01T19:10:42Z

IDT-4:

File:Health Check 7.png

2020-08-01T19:06:01Z

IDT-4:

File:Health Check 6.png

2020-08-01T19:05:44Z

IDT-4:

File:Health Check 4.png

2020-08-01T19:05:27Z

IDT-4:

File:Health Check 3.png

2020-08-01T19:05:11Z

IDT-4:

File:Health Check 2.png

2020-08-01T19:04:53Z

IDT-4:

File:Health Check 1.png

2020-08-01T19:04:35Z

IDT-4:

Admin Task

2020-08-01T18:51:02Z

IDT-4:

= Admin Task =

== Deleting an Agreement ==

An Admin has the authority to delete an Agreement. An Agreement may be deleted if it is no longer being used or it is terminated.

To delete an Agreement:

1. '''Click '''the ''Admin Task ''tile. 

2. '''Click''' the ''Delete Agreement'' button on the page.
<div class="image-green-border">[[File:Admin Task - Delete Agreement 7.8.PNG|720px|Admin Task Options 7.8.PNG]]</div>
3. You can search the Agreement to be deleted by providing any one of the fields listed below. The system automatically populates the data for the other field. Both the fields are mandatory to delete the Agreement from ICM.

*'''Agreement URL:''' Enter the URL of the Agreement that you want to delete.
*'''Sys Id: '''Enter the unique system ID for that Agreement.
<div class="image-green-border">''[[File:Admin Task - Delete Agreement - Execute 7.8.PNG|720px|Admin Task - Delete Agreement 7.8.PNG]]''</div>
4. '''Click '''''<i>Execute</i>. The Agreement will be deleted.''

 

== Search Sync ==

The Search Sync tool gets data from Elastic Search (ES) for a given instance’s ''Sys Id ''and synchronizes it if required. Using the fetched ES value, the tool validates if the Sys Id is the latest for the respective instance or if a sync is required. This tool can be accessed by the Administrator from the ''Admin Task'' on ''User Administration'' tile.

If the key exists, the latest value from ES will be displayed. If the key does not exist, the system displays an error message indicating that the value could not be fetched for the provided Sys Id. The Sys Id can be provided as input CSV file or as comma separated. Either comma separated Sys Ids can be entered or a CSV file can be uploaded.

This helps to make the entity search more streamlined and efficient. Users can quickly refer to related agreements at the time of deals or audits.
<div class="note-box">'''Note''': Data can be fetched from only one instance at a time. A dedicated key must exist for ES sync to work with ''Sys ID''.</div>
You can search the documents that an Agreement is linked to.

To use the Search Sync Tool:

1. '''Click''' Home > User Administration > ''Admin Task''. The ''Admin Task'' page opens.
<div class="image-green-border">[[File:Search Sync 1.png|720px|Search Sync 1]]</div>
2. '''Click''' the ''Search Sync ''task from the left pane.
<div class="image-green-border">[[File:Search Sync 2.png|720px|Search Sync 2]]</div> <div class="image-green-border"> </div> <div class="image-green-border"><div class="image-green-border">4. '''Select''' the ''Entity Type ''from the drop-down to sync data to the Elastic Search. For example, Agreement.</div> </div>
5. '''Select''' the ''Contract Type ''from the drop-down''.''

5. '''Toggle '''''Skip Agreement Document Indexing ''to ''Yes/No'' as required.

6. To get the ''Sys Ids,'' '''click''' the ''Upload CSV button'' to upload the .CSV Agreement or enter the Sys Id using comma separated value in the box.

7. '''Click''' the ''Upload CSV'' button to upload the CSV document. The ''Upload Document'' window opens.
<div class="image-green-border">[[File:Search Sync 3.png|720px|Search Sync3]]</div> <div class="image-green-border">
8. '''Click''' ''SelectFile'' to upload a CSV file and add a note if required.
</div> <div class="image-green-border">[[File:Search Sync 4.png|720px|Search Sync 4]]</div> <div class="image-green-border"> </div> <div class="image-green-border">9.'''Click''' ''Upload File''. The file is uploaded to the ''File Path ''displayed.If the uploaded file format is incorrect, an alert message is displayed. The supported file formats will be also be displayed.</div> <div class="image-green-border">
If the uploaded file format is incorrect, an alert message is displayed. The supported file formats will be also be displayed.

[[File:Search Sync 6.png|720px|Search Sync 6]]
</div>
10. '''Click''' ''Sync''. The ''Sync Request Accepted'' message is displayed. 
<div class="image-green-border">[[File:Search Sync 7.png|720px|Search Sync7]]</div>
11. '''Click''' ''Ok''. Users can now get data from ES for a given instance’s SysId and can check if it has the latest value or if a sync is needed.

12. '''Select''' ''Get ES Value''.

13. Enter the SysId and '''click''' ''Go''. If the key exists, the latest value from ES will be displayed. If the key does not exist, the error message ''Please enter valid SysId'' is displayed.

'''Note''': Data can be fetched from only one instance at a time.
<div class="image-green-border">[[File:Search Sync 8.png|720px|Search Sync 8]]</div>
=== Elastic Search Sync ===

Users can now get data from Elastic search for a given instance’s ''SysId'' so that they can look up the value and identify whether it is the latest or if a sync is needed. If the key exists, the latest value from ES will be displayed. If the key does not exist, the system will display the error message “Could not fetch value for provided SysId”.

'''Note''': Data can be fetched from only one instance at a time.
<div class="image-green-border">[[File:Search Sync ES.png|720px|Search Sync ES.png]]</div> <div class="image-green-border"> </div> <div class="image-green-border"> </div>
== Legacy Upload ==

Organizations may have a large number of existing Agreements that are created outside of ICM platform. These are henceforth referred to as Legacy Agreements. Organizations may want to import these Agreements to ICM to leverage its vast capabilities and manage all Agreements within a single platform.<br/> The Legacy Upload feature enables ICM Administrator to easily upload in bulk the legacy agreements that were created outside of ICM. This feature enhances productivity by allowing you to upload a large volume of existing Agreements and other entities using Excel.

The highlights of this feature are : 

*Uploading Agreements, Teams, Notes and Commitments in bulk.
*Uploading Associations, Masterdata, User Information and Amendments in bulk.
*Scheduled batch processing for improved performance.
*Enhanced validations, including the ability to exclude the specified attributes from being validated. 
*Ability to view logs and reporting of success and failure statuses for validations and uploads.

You can use the utility to upload the following entities: 

*Agreements 
*Amendments
*Associated Documents (with or without workflow)
*Masterdata (with or without workflow)
*Team, Notes, and Commitment
*User details

Click the Legacy Upload link in for more details.

== Translations Editor ==
<div class="image-green-border">
The ICM platform is available in different languages and different languages label text are available for localization. However, to make any changes to the localization values, users had to reach out to the Solutions Engineering or Database teams. Sometimes, these changes were minor and of low complexity, but the turnaround time was substantial.

Hence, a self-service ''Translations Editor'' tool has been introduced that contains all strings that are localized.

Users can now download all keys and their localization values as an Excel file, modify multiple values, and upload the modified changes to ICM. Once the values are updated in ICM, the caches are updated automatically to avoid the cache flush and server restart. This has significantly enhanced productivity as the turnaround time to update the Resource Key values has been eradicated.

Using this tool, users can now:

*Search for a specific string using the search bar and update the Resource Key value for Language and Locale.
*Update multiple language strings by selecting and saving the Resource Key value.
*Download and upload the localization key values using Microsoft Excel.
*View the modified values in the ICM instance immediately.
</div> <div class="image-green-border">
To use the Translations Editor Tool:

1. '''Click''' the ''User Administration'' tile on the ''Home'' page.

2. '''Select '''''Admin Task'' from the drop-down. The ''Admin Task'' page opens.

[[File:User Administration.PNG|720px|User Administration]]

3. '''Select''' the ''Translation Editor ''task from the left pane.

[[File:Translation Editor 1.png|720px|Translation Editor 1]]

Users can update translations in the following ways:

1. For selective editing, select a language and a resource key to update the translations.

2. For bulk editing and updation of multiple languages and resource keys, use the Download / Upload option to download an MS Excel sheet.

 

===== Selective Editing to Update Translations =====

For editing Resource Key values selectively:

1. From the ''Select Language'' drop-down, select a language in which you want to edit the labels.  For example, français (French).

[[File:Translation Editor 2.png|720px|Translation Editor 2]]

The Resource Key and respective values of the selected language are displayed.

[[File:Translation Editor 3.png|720px|Translation Editor 3]]

2. '''Ente'''r a ''ResourceKey ''value in the''Search'' field to edit. For example, default. All ResourceKey(s) with the ''Par défaut (default)'' values from the French language are displayed.
<div class="note-box">'''Note:''' ResourceKey is a unique key by which the application gets its label text for different languages.</div>
[[File:Translation Editor 4.png|720px|Translation Editor 4]]
</div> <div class="image-green-border">
3. '''Click '''the ''Edit this Resource Key for Multiple Languages '''''icon '''in the ''Actions'' column.

You can change the key for a single language or for multiple languages as required. For example, change ''Par défaut'' to ''défaut'' in French or ''Predeterminado'' in Español (Spanish) to ''Defecto''.

[[File:Translation Editor 5.png|720px|Translation Editor 5]]

4. '''Click''' ''Update''. The ResourceKey value for ''default ''is updated to ''défaut ''for French and to ''Defecto'' in Spanish.

5. The ''Resources Updated Successfully'' message is displayed. '''Click''' ''Ok''.

[[File:Translation Editor 6.png|720px|Translation Editor 6]]

You can select the respective languages (French or Spanish) to verify that the resources have been successfully updated.

[[File:Translation Editor 7.png|720px|Translation Editor 7]]
</div>
===== Bulk Editing in Multiple Languages =====

 For editing Resource Key values of multiple languages in bulk:

1. '''Click''' ''Download File''. A Microsoft Excel file (named BulkActionWorkBookStringResource) that contains all the Resource keys and values for all supported languages in ICM is downloaded.
<div class="image-green-border">[[File:Translation Editor 9.png|720px|Translation Editor 9]]</div>
2. '''Open''' the downloaded Microsoft Excel file.

3. '''Click''' ''Enable Editing''. All ICM supported language Resource keys and their respective values are displayed.

4. '''Edit''' the ResouceKey of multiple languages as required.

5. '''Save''' the Excel file.

6. '''Click''' ''Upload File''. The ''Upload Translations'' window opens.

7. '''Click''' ''SelectFile''. The ''Open ''window opens.

8. '''Select''' the updated Excel file.

9. '''Click''' ''Open''. A warning window opens indicating that this is a heavy operation and can potentially affect overall application performance.

10. '''Click''' ''Ok''. The ''Upload Summary'' displays the number ''of Records Uploaded, Records Processed, ''and''Records Updated Successfully ''values.

11. '''Click''' ''Close''. The label translations have been achieved for multiple languages in bulk.

 

 

 

'''Related Topics: '''[[Agreement_Management|Agreement Management]] | [[Managing_Organization|Managing Organization]] | [[Managing_Users|Managing Users]] | [[Managing_User_Groups|Managing User Groups]] | [[Managing_Security_Groups|Managing Security Groups]] | [[Application_Settings|Application Settings]] | [[Notification_Settings|Notification Settings]] | [[Currencies|Currencies]] | [[Reasons|Reasons]] | [[Deleting_an_Agreement|Deleting an Agreement]] |[[Legacy_Upload|Legacy Upload ]]|

Admin Task

2020-08-01T18:45:16Z

IDT-4:

= Admin Task =

== Deleting an Agreement ==

An Admin has the authority to delete an Agreement. An Agreement may be deleted if it is no longer being used or it is terminated.

To delete an Agreement:

1. '''Click '''the ''Admin Task ''tile. 

2. '''Click''' the ''Delete Agreement'' button on the page.
<div class="image-green-border">[[File:Admin Task - Delete Agreement 7.8.PNG|720px|Admin Task Options 7.8.PNG]]</div>
3. You can search the Agreement to be deleted by providing any one of the fields listed below. The system automatically populates the data for the other field. Both the fields are mandatory to delete the Agreement from ICM.

*'''Agreement URL:''' Enter the URL of the Agreement that you want to delete.
*'''Sys Id: '''Enter the unique system ID for that Agreement.
<div class="image-green-border">''[[File:Admin Task - Delete Agreement - Execute 7.8.PNG|720px|Admin Task - Delete Agreement 7.8.PNG]]''</div>
4. '''Click '''''<i>Execute</i>. The Agreement will be deleted.''

 

== Search Sync ==

The Search Sync tool gets data from Elastic Search (ES) for a given instance’s ''Sys Id ''and synchronizes it if required. Using the fetched ES value, the tool validates if the Sys Id is the latest for the respective instance or if a sync is required. This tool can be accessed by the Administrator from the ''Admin Task'' on ''User Administration'' tile.

If the key exists, the latest value from ES will be displayed. If the key does not exist, the system displays an error message indicating that the value could not be fetched for the provided Sys Id. The Sys Id can be provided as input CSV file or as comma separated. Either comma separated Sys Ids can be entered or a CSV file can be uploaded.

This helps to make the entity search more streamlined and efficient. Users can quickly refer to related agreements at the time of deals or audits.
<div class="note-box">'''Note''': Data can be fetched from only one instance at a time. A dedicated key must exist for ES sync to work with ''Sys ID''.</div>
You can search the documents that an Agreement is linked to.

To use the Search Sync Tool:

1. '''Click''' Home > User Administration > ''Admin Task''. The ''Admin Task'' page opens.
<div class="image-green-border">[[File:Search Sync 1.png|720px|Search Sync 1]]</div>
2. '''Click''' the ''Search Sync ''task from the left pane.
<div class="image-green-border">[[File:Search Sync 2.png|720px|Search Sync 2]]</div> <div class="image-green-border"> </div> <div class="image-green-border"><div class="image-green-border">4. '''Select''' the ''Entity Type ''from the drop-down to sync data to the Elastic Search. For example, Agreement.</div> </div>
5. '''Select''' the ''Contract Type ''from the drop-down''.''

5. '''Toggle '''''Skip Agreement Document Indexing ''to ''Yes/No'' as required.

6. To get the ''Sys Ids,'' '''click''' the ''Upload CSV button'' to upload the .CSV Agreement or enter the Sys Id using comma separated value in the box.

7. '''Click''' the ''Upload CSV'' button to upload the CSV document. The ''Upload Document'' window opens.
<div class="image-green-border">[[File:Search Sync 3.png|720px|Search Sync3]]</div> <div class="image-green-border">
8. '''Click''' ''SelectFile'' to upload a CSV file and add a note if required.
</div> <div class="image-green-border">[[File:Search Sync 4.png|720px|Search Sync 4]]</div> <div class="image-green-border"> </div> <div class="image-green-border">9.'''Click''' ''Upload File''. The file is uploaded to the ''File Path ''displayed.If the uploaded file format is incorrect, an alert message is displayed. The supported file formats will be also be displayed.</div> <div class="image-green-border">
If the uploaded file format is incorrect, an alert message is displayed. The supported file formats will be also be displayed.

[[File:Search Sync 6.png|720px|Search Sync 6]]
</div>
10. '''Click''' ''Sync''. The ''Sync Request Accepted'' message is displayed. 
<div class="image-green-border">[[File:Search Sync 7.png|720px|Search Sync7]]</div>
11. '''Click''' ''Ok''. Users can now get data from ES for a given instance’s SysId and can check if it has the latest value or if a sync is needed.

12. '''Select''' ''Get ES Value''.

13. Enter the SysId and '''click''' ''Go''. If the key exists, the latest value from ES will be displayed. If the key does not exist, the error message ''Please enter valid SysId'' is displayed.

'''Note''': Data can be fetched from only one instance at a time.
<div class="image-green-border">[[File:Search Sync 8.png|720px|Search Sync 8]]</div>
=== Elastic Search Sync ===

Users can now get data from Elastic search for a given instance’s ''SysId'' so that they can look up the value and identify whether it is the latest or if a sync is needed. If the key exists, the latest value from ES will be displayed. If the key does not exist, the system will display the error message “Could not fetch value for provided SysId”.

'''Note''': Data can be fetched from only one instance at a time.
<div class="image-green-border">[[File:Search Sync ES.png|720px|Search Sync ES.png]]</div> <div class="image-green-border"> </div> <div class="image-green-border"> </div>
== Legacy Upload ==

Organizations may have a large number of existing Agreements that are created outside of ICM platform. These are henceforth referred to as Legacy Agreements. Organizations may want to import these Agreements to ICM to leverage its vast capabilities and manage all Agreements within a single platform.<br/> The Legacy Upload feature enables ICM Administrator to easily upload in bulk the legacy agreements that were created outside of ICM. This feature enhances productivity by allowing you to upload a large volume of existing Agreements and other entities using Excel.

The highlights of this feature are : 

*Uploading Agreements, Teams, Notes and Commitments in bulk.
*Uploading Associations, Masterdata, User Information and Amendments in bulk.
*Scheduled batch processing for improved performance.
*Enhanced validations, including the ability to exclude the specified attributes from being validated. 
*Ability to view logs and reporting of success and failure statuses for validations and uploads.

You can use the utility to upload the following entities: 

*Agreements 
*Amendments
*Associated Documents (with or without workflow)
*Masterdata (with or without workflow)
*Team, Notes, and Commitment
*User details

Click the [[Legacy_Upload|Legacy Upload link]] in for more details.

== Translations Editor ==
<div class="image-green-border">
The ICM platform is available in different languages and different languages label text are available for localization. However, to make any changes to the localization values, users had to reach out to the Solutions Engineering or Database teams. Sometimes, these changes were minor and of low complexity, but the turnaround time was substantial.

Hence, a self-service ''Translations Editor'' tool has been introduced that contains all strings that are localized.

Users can now download all keys and their localization values as an Excel file, modify multiple values, and upload the modified changes to ICM. Once the values are updated in ICM, the caches are updated automatically to avoid the cache flush and server restart. This has significantly enhanced productivity as the turnaround time to update the Resource Key values has been eradicated.

Using this tool, users can now:

*Search for a specific string using the search bar and update the Resource Key value for Language and Locale.
*Update multiple language strings by selecting and saving the Resource Key value.
*Download and upload the localization key values using Microsoft Excel.
*View the modified values in the ICM instance immediately.
</div> <div class="image-green-border">
To use the Translations Editor Tool:

1. '''Click''' the ''User Administration'' tile on the ''Home'' page.

2. '''Select '''''Admin Task'' from the drop-down. The ''Admin Task'' page opens.

[[File:User Administration.PNG|720px|User Administration]]

3. '''Select''' the ''Translation Editor ''task from the left pane.

[[File:Translation Editor 1.png|720px|Translation Editor 1]]

Users can update translations in the following ways:

1. For selective editing, select a language and a resource key to update the translations.

2. For bulk editing and updation of multiple languages and resource keys, use the Download / Upload option to download an MS Excel sheet.

 

===== Selective Editing to Update Translations =====

For editing Resource Key values selectively:

1. From the ''Select Language'' drop-down, select a language in which you want to edit the labels.  For example, français (French).

[[File:Translation Editor 2.png|720px|Translation Editor 2]]

The Resource Key and respective values of the selected language are displayed.

[[File:Translation Editor 3.png|720px|Translation Editor 3]]

2. '''Ente'''r a ''ResourceKey ''value in the''Search'' field to edit. For example, default. All ResourceKey(s) with the ''Par défaut (default)'' values from the French language are displayed.
<div class="note-box">'''Note:''' ResourceKey is a unique key by which the application gets its label text for different languages.</div>
[[File:Translation Editor 4.png|720px|Translation Editor 4]]
</div> <div class="image-green-border">
3. '''Click '''the ''Edit this Resource Key for Multiple Languages '''''icon '''in the ''Actions'' column.

You can change the key for a single language or for multiple languages as required. For example, change ''Par défaut'' to ''défaut'' in French or ''Predeterminado'' in Español (Spanish) to ''Defecto''.

[[File:Translation Editor 5.png|720px|Translation Editor 5]]

4. '''Click''' ''Update''. The ResourceKey value for ''default ''is updated to ''défaut ''for French and to ''Defecto'' in Spanish.

5. The ''Resources Updated Successfully'' message is displayed. '''Click''' ''Ok''.

[[File:Translation Editor 6.png|720px|Translation Editor 6]]

You can select the respective languages (French or Spanish) to verify that the resources have been successfully updated.

[[File:Translation Editor 7.png|720px|Translation Editor 7]]
</div>
===== Bulk Editing in Multiple Languages =====

 For editing Resource Key values of multiple languages in bulk:

1. '''Click''' ''Download File''. A Microsoft Excel file (named BulkActionWorkBookStringResource) that contains all the Resource keys and values for all supported languages in ICM is downloaded.
<div class="image-green-border">[[File:Translation Editor 9.png|720px|Translation Editor 9]]</div>
2. '''Open''' the downloaded Microsoft Excel file.

3. '''Click''' ''Enable Editing''. All ICM supported language Resource keys and their respective values are displayed.

4. '''Edit''' the ResouceKey of multiple languages as required.

5. '''Save''' the Excel file.

6. '''Click''' ''Upload File''. The ''Upload Translations'' window opens.

7. '''Click''' ''SelectFile''. The ''Open ''window opens.

8. '''Select''' the updated Excel file.

9. '''Click''' ''Open''. A warning window opens indicating that this is a heavy operation and can potentially affect overall application performance.

10. '''Click''' ''Ok''. The ''Upload Summary'' displays the number ''of Records Uploaded, Records Processed, ''and''Records Updated Successfully ''values.

11. '''Click''' ''Close''. The label translations have been achieved for multiple languages in bulk.

 

 

 

'''Related Topics: '''[[Agreement_Management|Agreement Management]] | [[Managing_Organization|Managing Organization]] | [[Managing_Users|Managing Users]] | [[Managing_User_Groups|Managing User Groups]] | [[Managing_Security_Groups|Managing Security Groups]] | [[Application_Settings|Application Settings]] | [[Notification_Settings|Notification Settings]] | [[Currencies|Currencies]] | [[Reasons|Reasons]] | [[Deleting_an_Agreement|Deleting an Agreement]] |[[Legacy_Upload|Legacy Upload ]]|

Admin Task

2020-08-01T18:43:45Z

IDT-4:

= Admin Task =

== Search Sync ==

The Search Sync tool gets data from Elastic Search (ES) for a given instance’s ''Sys Id ''and synchronizes it if required. Using the fetched ES value, the tool validates if the Sys Id is the latest for the respective instance or if a sync is required. This tool can be accessed by the Administrator from the ''Admin Task'' on ''User Administration'' tile.

If the key exists, the latest value from ES will be displayed. If the key does not exist, the system displays an error message indicating that the value could not be fetched for the provided Sys Id. The Sys Id can be provided as input CSV file or as comma separated. Either comma separated Sys Ids can be entered or a CSV file can be uploaded.

This helps to make the entity search more streamlined and efficient. Users can quickly refer to related agreements at the time of deals or audits.
<div class="note-box">'''Note''': Data can be fetched from only one instance at a time. A dedicated key must exist for ES sync to work with ''Sys ID''.</div>
You can search the documents that an Agreement is linked to.

To use the Search Sync Tool:

1. '''Click''' Home > User Administration > ''Admin Task''. The ''Admin Task'' page opens.
<div class="image-green-border">[[File:Search Sync 1.png|720px|Search Sync 1]]</div>
2. '''Click''' the ''Search Sync ''task from the left pane.
<div class="image-green-border">[[File:Search Sync 2.png|720px|Search Sync 2]]</div> <div class="image-green-border"> </div> <div class="image-green-border"><div class="image-green-border">4. '''Select''' the ''Entity Type ''from the drop-down to sync data to the Elastic Search. For example, Agreement.</div> </div>
5. '''Select''' the ''Contract Type ''from the drop-down''.''

5. '''Toggle '''''Skip Agreement Document Indexing ''to ''Yes/No'' as required.

6. To get the ''Sys Ids,'' '''click''' the ''Upload CSV button'' to upload the .CSV Agreement or enter the Sys Id using comma separated value in the box.

7. '''Click''' the ''Upload CSV'' button to upload the CSV document. The ''Upload Document'' window opens.
<div class="image-green-border">[[File:Search Sync 3.png|720px|Search Sync3]]</div> <div class="image-green-border">
8. '''Click''' ''SelectFile'' to upload a CSV file and add a note if required.
</div> <div class="image-green-border">[[File:Search Sync 4.png|720px|Search Sync 4]]</div> <div class="image-green-border"> </div> <div class="image-green-border">9.'''Click''' ''Upload File''. The file is uploaded to the ''File Path ''displayed.If the uploaded file format is incorrect, an alert message is displayed. The supported file formats will be also be displayed.</div> <div class="image-green-border">
If the uploaded file format is incorrect, an alert message is displayed. The supported file formats will be also be displayed.

[[File:Search Sync 6.png|720px|Search Sync 6]]
</div>
10. '''Click''' ''Sync''. The ''Sync Request Accepted'' message is displayed. 
<div class="image-green-border">[[File:Search Sync 7.png|720px|Search Sync7]]</div>
11. '''Click''' ''Ok''. Users can now get data from ES for a given instance’s SysId and can check if it has the latest value or if a sync is needed.

12. '''Select''' ''Get ES Value''.

13. Enter the SysId and '''click''' ''Go''. If the key exists, the latest value from ES will be displayed. If the key does not exist, the error message ''Please enter valid SysId'' is displayed.

'''Note''': Data can be fetched from only one instance at a time.
<div class="image-green-border">[[File:Search Sync 8.png|720px|Search Sync 8]]</div>
=== Elastic Search Sync ===

Users can now get data from Elastic search for a given instance’s ''SysId'' so that they can look up the value and identify whether it is the latest or if a sync is needed. If the key exists, the latest value from ES will be displayed. If the key does not exist, the system will display the error message “Could not fetch value for provided SysId”.

'''Note''': Data can be fetched from only one instance at a time.
<div class="image-green-border">[[File:Search Sync ES.png|720px|Search Sync ES.png]]</div> <div class="image-green-border"> </div> <div class="image-green-border"> </div>
== Legacy Upload ==

Organizations may have a large number of existing Agreements that are created outside of ICM platform. These are henceforth referred to as Legacy Agreements. Organizations may want to import these Agreements to ICM to leverage its vast capabilities and manage all Agreements within a single platform.<br/> The Legacy Upload feature enables ICM Administrator to easily upload in bulk the legacy agreements that were created outside of ICM. This feature enhances productivity by allowing you to upload a large volume of existing Agreements and other entities using Excel.

The highlights of this feature are : 

*Uploading Agreements, Teams, Notes and Commitments in bulk.
*Uploading Associations, Masterdata, User Information and Amendments in bulk.
*Scheduled batch processing for improved performance.
*Enhanced validations, including the ability to exclude the specified attributes from being validated. 
*Ability to view logs and reporting of success and failure statuses for validations and uploads.

You can use the utility to upload the following entities: 

*Agreements 
*Amendments
*Associated Documents (with or without workflow)
*Masterdata (with or without workflow)
*Team, Notes, and Commitment
*User details

Click the [[Legacy_Upload|Legacy Upload ]]link in for more details.

== Translations Editor ==
<div class="image-green-border">
The ICM platform is available in different languages and different languages label text are available for localization. However, to make any changes to the localization values, users had to reach out to the Solutions Engineering or Database teams. Sometimes, these changes were minor and of low complexity, but the turnaround time was substantial.

Hence, a self-service ''Translations Editor'' tool has been introduced that contains all strings that are localized.

Users can now download all keys and their localization values as an Excel file, modify multiple values, and upload the modified changes to ICM. Once the values are updated in ICM, the caches are updated automatically to avoid the cache flush and server restart. This has significantly enhanced productivity as the turnaround time to update the Resource Key values has been eradicated.

Using this tool, users can now:

*Search for a specific string using the search bar and update the Resource Key value for Language and Locale.
*Update multiple language strings by selecting and saving the Resource Key value.
*Download and upload the localization key values using Microsoft Excel.
*View the modified values in the ICM instance immediately.
</div> <div class="image-green-border">
To use the Translations Editor Tool:

1. '''Click''' the ''User Administration'' tile on the ''Home'' page.

2. '''Select '''''Admin Task'' from the drop-down. The ''Admin Task'' page opens.

[[File:User Administration.PNG|720px|User Administration]]

3. '''Select''' the ''Translation Editor ''task from the left pane.

[[File:Translation Editor 1.png|720px|Translation Editor 1]]

Users can update translations in the following ways:

1. For selective editing, select a language and a resource key to update the translations.

2. For bulk editing and updation of multiple languages and resource keys, use the Download / Upload option to download an MS Excel sheet.

 

===== Selective Editing to Update Translations =====

For editing Resource Key values selectively:

1. From the ''Select Language'' drop-down, select a language in which you want to edit the labels.  For example, français (French).

[[File:Translation Editor 2.png|720px|Translation Editor 2]]

The Resource Key and respective values of the selected language are displayed.

[[File:Translation Editor 3.png|720px|Translation Editor 3]]

2. '''Ente'''r a ''ResourceKey ''value in the''Search'' field to edit. For example, default. All ResourceKey(s) with the ''Par défaut (default)'' values from the French language are displayed.
<div class="note-box">'''Note:''' ResourceKey is a unique key by which the application gets its label text for different languages.</div>
[[File:Translation Editor 4.png|720px|Translation Editor 4]]
</div> <div class="image-green-border">
3. '''Click '''the ''Edit this Resource Key for Multiple Languages '''''icon '''in the ''Actions'' column.

You can change the key for a single language or for multiple languages as required. For example, change ''Par défaut'' to ''défaut'' in French or ''Predeterminado'' in Español (Spanish) to ''Defecto''.

[[File:Translation Editor 5.png|720px|Translation Editor 5]]

4. '''Click''' ''Update''. The ResourceKey value for ''default ''is updated to ''défaut ''for French and to ''Defecto'' in Spanish.

5. The ''Resources Updated Successfully'' message is displayed. '''Click''' ''Ok''.

[[File:Translation Editor 6.png|720px|Translation Editor 6]]

You can select the respective languages (French or Spanish) to verify that the resources have been successfully updated.

[[File:Translation Editor 7.png|720px|Translation Editor 7]]
</div>
===== Bulk Editing in Multiple Languages =====

 For editing Resource Key values of multiple languages in bulk:

1. '''Click''' ''Download File''. A Microsoft Excel file (named BulkActionWorkBookStringResource) that contains all the Resource keys and values for all supported languages in ICM is downloaded.
<div class="image-green-border">[[File:Translation Editor 9.png|720px|Translation Editor 9]]</div>
2. '''Open''' the downloaded Microsoft Excel file.

3. '''Click''' ''Enable Editing''. All ICM supported language Resource keys and their respective values are displayed.

4. '''Edit''' the ResouceKey of multiple languages as required.

5. '''Save''' the Excel file.

6. '''Click''' ''Upload File''. The ''Upload Translations'' window opens.

7. '''Click''' ''SelectFile''. The ''Open ''window opens.

8. '''Select''' the updated Excel file.

9. '''Click''' ''Open''. A warning window opens indicating that this is a heavy operation and can potentially affect overall application performance.

10. '''Click''' ''Ok''. The ''Upload Summary'' displays the number ''of Records Uploaded, Records Processed, ''and''Records Updated Successfully ''values.

11. '''Click''' ''Close''. The label translations have been achieved for multiple languages in bulk.

 

 

 

'''Related Topics: '''[[Agreement_Management|Agreement Management]] | [[Managing_Organization|Managing Organization]] | [[Managing_Users|Managing Users]] | [[Managing_User_Groups|Managing User Groups]] | [[Managing_Security_Groups|Managing Security Groups]] | [[Application_Settings|Application Settings]] | [[Notification_Settings|Notification Settings]] | [[Currencies|Currencies]] | [[Reasons|Reasons]] | [[Deleting_an_Agreement|Deleting an Agreement]] |[[Legacy_Upload|Legacy Upload ]]|

Admin Task

2020-08-01T18:40:08Z

IDT-4:

= Admin Task =

== Search Sync ==

The Search Sync tool gets data from Elastic Search (ES) for a given instance’s ''Sys Id ''and synchronizes it if required. Using the fetched ES value, the tool validates if the Sys Id is the latest for the respective instance or if a sync is required. This tool can be accessed by the Administrator from the ''Admin Task'' on ''User Administration'' tile.

If the key exists, the latest value from ES will be displayed. If the key does not exist, the system displays an error message indicating that the value could not be fetched for the provided Sys Id. The Sys Id can be provided as input CSV file or as comma separated. Either comma separated Sys Ids can be entered or a CSV file can be uploaded.

This helps to make the entity search more streamlined and efficient. Users can quickly refer to related agreements at the time of deals or audits.
<div class="note-box">'''Note''': Data can be fetched from only one instance at a time. A dedicated key must exist for ES sync to work with ''Sys ID''.</div>
You can search the documents that an Agreement is linked to.

To use the Search Sync Tool:

1. '''Click''' Home > User Administration > ''Admin Task''. The ''Admin Task'' page opens.
<div class="image-green-border">[[File:Search Sync 1.png|720px|Search Sync 1]]</div>
2. '''Click''' the ''Search Sync ''task from the left pane.
<div class="image-green-border">[[File:Search Sync 2.png|720px|Search Sync 2]]</div> <div class="image-green-border"> </div> <div class="image-green-border"><div class="image-green-border">4. '''Select''' the ''Entity Type ''from the drop-down to sync data to the Elastic Search. For example, Agreement.</div> </div>
5. '''Select''' the ''Contract Type ''from the drop-down''.''

5. '''Toggle '''''Skip Agreement Document Indexing ''to ''Yes/No'' as required.

6. To get the ''Sys Ids,'' '''click''' the ''Upload CSV button'' to upload the .CSV Agreement or enter the Sys Id using comma separated value in the box.

7. '''Click''' the ''Upload CSV'' button to upload the CSV document. The ''Upload Document'' window opens.
<div class="image-green-border">[[File:Search Sync 3.png|720px|Search Sync3]]</div> <div class="image-green-border">
8. '''Click''' ''SelectFile'' to upload a CSV file and add a note if required.
</div> <div class="image-green-border">[[File:Search Sync 4.png|720px|Search Sync 4]]</div> <div class="image-green-border"> </div> <div class="image-green-border">9.'''Click''' ''Upload File''. The file is uploaded to the ''File Path ''displayed.If the uploaded file format is incorrect, an alert message is displayed. The supported file formats will be also be displayed.</div> <div class="image-green-border">
If the uploaded file format is incorrect, an alert message is displayed. The supported file formats will be also be displayed.

[[File:Search Sync 6.png|720px|Search Sync 6]]
</div>
10. '''Click''' ''Sync''. The ''Sync Request Accepted'' message is displayed. 
<div class="image-green-border">[[File:Search Sync 7.png|720px|Search Sync7]]</div>
11. '''Click''' ''Ok''. Users can now get data from ES for a given instance’s SysId and can check if it has the latest value or if a sync is needed.

12. '''Select''' ''Get ES Value''.

13. Enter the SysId and '''click''' ''Go''. If the key exists, the latest value from ES will be displayed. If the key does not exist, the error message ''Please enter valid SysId'' is displayed.

'''Note''': Data can be fetched from only one instance at a time.
<div class="image-green-border">[[File:Search Sync 8.png|720px|Search Sync 8]]</div>
=== Elastic Search Sync ===

Users can now get data from Elastic search for a given instance’s ''SysId'' so that they can look up the value and identify whether it is the latest or if a sync is needed. If the key exists, the latest value from ES will be displayed. If the key does not exist, the system will display the error message “Could not fetch value for provided SysId”.

'''Note''': Data can be fetched from only one instance at a time.
<div class="image-green-border">[[File:Search Sync ES.png|720px|Search Sync ES.png]]</div> <div class="image-green-border"> </div> <div class="image-green-border"> </div>

== Translations Editor ==
<div class="image-green-border">
The ICM platform is available in different languages and different languages label text are available for localization. However, to make any changes to the localization values, users had to reach out to the Solutions Engineering or Database teams. Sometimes, these changes were minor and of low complexity, but the turnaround time was substantial.

Hence, a self-service ''Translations Editor'' tool has been introduced that contains all strings that are localized.

Users can now download all keys and their localization values as an Excel file, modify multiple values, and upload the modified changes to ICM. Once the values are updated in ICM, the caches are updated automatically to avoid the cache flush and server restart. This has significantly enhanced productivity as the turnaround time to update the Resource Key values has been eradicated.

Using this tool, users can now:

*Search for a specific string using the search bar and update the Resource Key value for Language and Locale.
*Update multiple language strings by selecting and saving the Resource Key value.
*Download and upload the localization key values using Microsoft Excel.
*View the modified values in the ICM instance immediately.
</div> <div class="image-green-border">
To use the Translations Editor Tool:

1. '''Click''' the ''User Administration'' tile on the ''Home'' page.

2. '''Select '''''Admin Task'' from the drop-down. The ''Admin Task'' page opens.

[[File:User Administration.PNG|720px|User Administration]]

3. '''Select''' the ''Translation Editor ''task from the left pane.

[[File:Translation Editor 1.png|720px|Translation Editor 1]]

Users can update translations in the following ways:

1. For selective editing, select a language and a resource key to update the translations.

2. For bulk editing and updation of multiple languages and resource keys, use the Download / Upload option to download an MS Excel sheet.

 

===== Selective Editing to Update Translations =====

For editing Resource Key values selectively:

1. From the ''Select Language'' drop-down, select a language in which you want to edit the labels.  For example, français (French).

[[File:Translation Editor 2.png|720px|Translation Editor 2]]

The Resource Key and respective values of the selected language are displayed.

[[File:Translation Editor 3.png|720px|Translation Editor 3]]

2. '''Ente'''r a ''ResourceKey ''value in the''Search'' field to edit. For example, default. All ResourceKey(s) with the ''Par défaut (default)'' values from the French language are displayed.
<div class="note-box">'''Note:''' ResourceKey is a unique key by which the application gets its label text for different languages.</div>
[[File:Translation Editor 4.png|720px|Translation Editor 4]]
</div> <div class="image-green-border">
3. '''Click '''the ''Edit this Resource Key for Multiple Languages '''''icon '''in the ''Actions'' column.

You can change the key for a single language or for multiple languages as required. For example, change ''Par défaut'' to ''défaut'' in French or ''Predeterminado'' in Español (Spanish) to ''Defecto''.

[[File:Translation Editor 5.png|720px|Translation Editor 5]]

4. '''Click''' ''Update''. The ResourceKey value for ''default ''is updated to ''défaut ''for French and to ''Defecto'' in Spanish.

5. The ''Resources Updated Successfully'' message is displayed. '''Click''' ''Ok''.

[[File:Translation Editor 6.png|720px|Translation Editor 6]]

You can select the respective languages (French or Spanish) to verify that the resources have been successfully updated.

[[File:Translation Editor 7.png|720px|Translation Editor 7]]
</div>

===== Bulk Editing in Multiple Languages =====

 For editing Resource Key values of multiple languages in bulk:

1. '''Click''' ''Download File''. A Microsoft Excel file (named BulkActionWorkBookStringResource) that contains all the Resource keys and values for all supported languages in ICM is downloaded.
<div class="image-green-border">[[File:Translation Editor 9.png|720px|Translation Editor 9]]</div>
2. '''Open''' the downloaded Microsoft Excel file.

3. '''Click''' ''Enable Editing''. All ICM supported language Resource keys and their respective values are displayed.

4. '''Edit''' the ResouceKey of multiple languages as required.

5. '''Save''' the Excel file.

6. '''Click''' ''Upload File''. The ''Upload Translations'' window opens.

7. '''Click''' ''SelectFile''. The ''Open ''window opens.

8. '''Select''' the updated Excel file.

9. '''Click''' ''Open''. A warning window opens indicating that this is a heavy operation and can potentially affect overall application performance.

10. '''Click''' ''Ok''. The ''Upload Summary'' displays the number ''of Records Uploaded, Records Processed, ''and''Records Updated Successfully ''values.

11. '''Click''' ''Close''. The label translations have been achieved for multiple languages in bulk </div>

File:Translation Editor 9.png

2020-08-01T18:39:15Z

IDT-4:

Admin Task

2020-08-01T18:37:46Z

IDT-4:

= Admin Task =

== Search Sync ==

The Search Sync tool gets data from Elastic Search (ES) for a given instance’s ''Sys Id ''and synchronizes it if required. Using the fetched ES value, the tool validates if the Sys Id is the latest for the respective instance or if a sync is required. This tool can be accessed by the Administrator from the ''Admin Task'' on ''User Administration'' tile.

If the key exists, the latest value from ES will be displayed. If the key does not exist, the system displays an error message indicating that the value could not be fetched for the provided Sys Id. The Sys Id can be provided as input CSV file or as comma separated. Either comma separated Sys Ids can be entered or a CSV file can be uploaded.

This helps to make the entity search more streamlined and efficient. Users can quickly refer to related agreements at the time of deals or audits.
<div class="note-box">'''Note''': Data can be fetched from only one instance at a time. A dedicated key must exist for ES sync to work with ''Sys ID''.</div>
You can search the documents that an Agreement is linked to.

To use the Search Sync Tool:

1. '''Click''' Home > User Administration > ''Admin Task''. The ''Admin Task'' page opens.
<div class="image-green-border">[[File:Search Sync 1.png|720px|Search Sync 1]]</div>
2. '''Click''' the ''Search Sync ''task from the left pane.
<div class="image-green-border">[[File:Search Sync 2.png|720px|Search Sync 2]]</div> <div class="image-green-border"> </div> <div class="image-green-border"><div class="image-green-border">4. '''Select''' the ''Entity Type ''from the drop-down to sync data to the Elastic Search. For example, Agreement.</div> </div>
5. '''Select''' the ''Contract Type ''from the drop-down''.''

5. '''Toggle '''''Skip Agreement Document Indexing ''to ''Yes/No'' as required.

6. To get the ''Sys Ids,'' '''click''' the ''Upload CSV button'' to upload the .CSV Agreement or enter the Sys Id using comma separated value in the box.

7. '''Click''' the ''Upload CSV'' button to upload the CSV document. The ''Upload Document'' window opens.
<div class="image-green-border">[[File:Search Sync 3.png|720px|Search Sync3]]</div> <div class="image-green-border">
8. '''Click''' ''SelectFile'' to upload a CSV file and add a note if required.
</div> <div class="image-green-border">[[File:Search Sync 4.png|720px|Search Sync 4]]</div> <div class="image-green-border"> </div> <div class="image-green-border">9.'''Click''' ''Upload File''. The file is uploaded to the ''File Path ''displayed.If the uploaded file format is incorrect, an alert message is displayed. The supported file formats will be also be displayed.</div> <div class="image-green-border">
If the uploaded file format is incorrect, an alert message is displayed. The supported file formats will be also be displayed.

[[File:Search Sync 6.png|720px|Search Sync 6]]
</div>
10. '''Click''' ''Sync''. The ''Sync Request Accepted'' message is displayed. 
<div class="image-green-border">[[File:Search Sync 7.png|720px|Search Sync7]]</div>
11. '''Click''' ''Ok''. Users can now get data from ES for a given instance’s SysId and can check if it has the latest value or if a sync is needed.

12. '''Select''' ''Get ES Value''.

13. Enter the SysId and '''click''' ''Go''. If the key exists, the latest value from ES will be displayed. If the key does not exist, the error message ''Please enter valid SysId'' is displayed.

'''Note''': Data can be fetched from only one instance at a time.
<div class="image-green-border">[[File:Search Sync 8.png|720px|Search Sync 8]]</div>
=== Elastic Search Sync ===

Users can now get data from Elastic search for a given instance’s ''SysId'' so that they can look up the value and identify whether it is the latest or if a sync is needed. If the key exists, the latest value from ES will be displayed. If the key does not exist, the system will display the error message “Could not fetch value for provided SysId”.

'''Note''': Data can be fetched from only one instance at a time.
<div class="image-green-border">[[File:Search Sync ES.png|720px|Search Sync ES.png]]</div> <div class="image-green-border"> </div> <div class="image-green-border"> </div>

== Translations Editor ==
<div class="image-green-border">
The ICM platform is available in different languages and different languages label text are available for localization. However, to make any changes to the localization values, users had to reach out to the Solutions Engineering or Database teams. Sometimes, these changes were minor and of low complexity, but the turnaround time was substantial.

Hence, a self-service ''Translations Editor'' tool has been introduced that contains all strings that are localized.

Users can now download all keys and their localization values as an Excel file, modify multiple values, and upload the modified changes to ICM. Once the values are updated in ICM, the caches are updated automatically to avoid the cache flush and server restart. This has significantly enhanced productivity as the turnaround time to update the Resource Key values has been eradicated.

Using this tool, users can now:

*Search for a specific string using the search bar and update the Resource Key value for Language and Locale.
*Update multiple language strings by selecting and saving the Resource Key value.
*Download and upload the localization key values using Microsoft Excel.
*View the modified values in the ICM instance immediately.
</div> <div class="image-green-border">
To use the Translations Editor Tool:

1. '''Click''' the ''User Administration'' tile on the ''Home'' page.

2. '''Select '''''Admin Task'' from the drop-down. The ''Admin Task'' page opens.

[[File:User Administration.PNG|720px|User Administration]]

3. '''Select''' the ''Translation Editor ''task from the left pane.

[[File:Translation Editor 1.png|720px|Translation Editor 1]]

Users can update translations in the following ways:

1. For selective editing, select a language and a resource key to update the translations.

2. For bulk editing and updation of multiple languages and resource keys, use the Download / Upload option to download an MS Excel sheet.

 

===== Selective Editing to Update Translations =====

For editing Resource Key values selectively:

1. From the ''Select Language'' drop-down, select a language in which you want to edit the labels.  For example, français (French).

[[File:Translation Editor 2.png|720px|Translation Editor 2]]

The Resource Key and respective values of the selected language are displayed.

[[File:Translation Editor 3.png|720px|Translation Editor 3]]

2. '''Ente'''r a ''ResourceKey ''value in the''Search'' field to edit. For example, default. All ResourceKey(s) with the ''Par défaut (default)'' values from the French language are displayed.
<div class="note-box">'''Note:''' ResourceKey is a unique key by which the application gets its label text for different languages.</div>
[[File:Translation Editor 4.png|720px|Translation Editor 4]]
</div> <div class="image-green-border">
3. '''Click '''the ''Edit this Resource Key for Multiple Languages '''''icon '''in the ''Actions'' column.

You can change the key for a single language or for multiple languages as required. For example, change ''Par défaut'' to ''défaut'' in French or ''Predeterminado'' in Español (Spanish) to ''Defecto''.

[[File:Translation Editor 5.png|720px|Translation Editor 5]]

4. '''Click''' ''Update''. The ResourceKey value for ''default ''is updated to ''défaut ''for French and to ''Defecto'' in Spanish.

5. The ''Resources Updated Successfully'' message is displayed. '''Click''' ''Ok''.

[[File:Translation Editor 6.png|720px|Translation Editor 6]]

You can select the respective languages (French or Spanish) to verify that the resources have been successfully updated.

[[File:Translation Editor 7.png|720px|Translation Editor 7]]
</div>
===== Bulk Editing in Multiple Languages =====

 For editing Resource Key values of multiple languages in bulk:

1. '''Click''' ''Download File''. A Microsoft Excel file (named BulkActionWorkBookStringResource) that contains all the Resource keys and values for all supported languages in ICM is downloaded.

2. '''Open''' the downloaded Microsoft Excel file.

3. '''Click''' ''Enable Editing''. All ICM supported language Resource keys and their respective values are displayed.

4. '''Edit''' the ResouceKey of multiple languages as required.

5. '''Save''' the Excel file.

6. '''Click''' ''Upload File''. The ''Upload Translations'' window opens.

7. '''Click''' ''SelectFile''. The ''Open ''window opens.

8. '''Select''' the updated Excel file.

9. '''Click''' ''Open''. A warning window opens indicating that this is a heavy operation and can potentially affect overall application performance.

10. '''Click''' ''Ok''. The ''Upload Summary'' displays the number ''of Records Uploaded, Records Processed, ''and''Records Updated Successfully ''values.

11. '''Click''' ''Close''. The label translations have been achieved for multiple languages in bulk </div>

File:Translation Editor 7.png

2020-08-01T18:35:31Z

IDT-4:

File:Translation Editor 6.png

2020-08-01T18:35:11Z

IDT-4:

Admin Task

2020-08-01T18:34:43Z

IDT-4:

= Admin Task =

== Search Sync ==

The Search Sync tool gets data from Elastic Search (ES) for a given instance’s ''Sys Id ''and synchronizes it if required. Using the fetched ES value, the tool validates if the Sys Id is the latest for the respective instance or if a sync is required. This tool can be accessed by the Administrator from the ''Admin Task'' on ''User Administration'' tile.

If the key exists, the latest value from ES will be displayed. If the key does not exist, the system displays an error message indicating that the value could not be fetched for the provided Sys Id. The Sys Id can be provided as input CSV file or as comma separated. Either comma separated Sys Ids can be entered or a CSV file can be uploaded.

This helps to make the entity search more streamlined and efficient. Users can quickly refer to related agreements at the time of deals or audits.
<div class="note-box">'''Note''': Data can be fetched from only one instance at a time. A dedicated key must exist for ES sync to work with ''Sys ID''.</div>
You can search the documents that an Agreement is linked to.

To use the Search Sync Tool:

1. '''Click''' Home > User Administration > ''Admin Task''. The ''Admin Task'' page opens.
<div class="image-green-border">[[File:Search Sync 1.png|720px|Search Sync 1]]</div>
2. '''Click''' the ''Search Sync ''task from the left pane.
<div class="image-green-border">[[File:Search Sync 2.png|720px|Search Sync 2]]</div> <div class="image-green-border"> </div> <div class="image-green-border"><div class="image-green-border">4. '''Select''' the ''Entity Type ''from the drop-down to sync data to the Elastic Search. For example, Agreement.</div> </div>
5. '''Select''' the ''Contract Type ''from the drop-down''.''

5. '''Toggle '''''Skip Agreement Document Indexing ''to ''Yes/No'' as required.

6. To get the ''Sys Ids,'' '''click''' the ''Upload CSV button'' to upload the .CSV Agreement or enter the Sys Id using comma separated value in the box.

7. '''Click''' the ''Upload CSV'' button to upload the CSV document. The ''Upload Document'' window opens.
<div class="image-green-border">[[File:Search Sync 3.png|720px|Search Sync3]]</div> <div class="image-green-border">
8. '''Click''' ''SelectFile'' to upload a CSV file and add a note if required.
</div> <div class="image-green-border">[[File:Search Sync 4.png|720px|Search Sync 4]]</div> <div class="image-green-border"> </div> <div class="image-green-border">9.'''Click''' ''Upload File''. The file is uploaded to the ''File Path ''displayed.If the uploaded file format is incorrect, an alert message is displayed. The supported file formats will be also be displayed.</div> <div class="image-green-border">
If the uploaded file format is incorrect, an alert message is displayed. The supported file formats will be also be displayed.

[[File:Search Sync 6.png|720px|Search Sync 6]]
</div>
10. '''Click''' ''Sync''. The ''Sync Request Accepted'' message is displayed. 
<div class="image-green-border">[[File:Search Sync 7.png|720px|Search Sync7]]</div>
11. '''Click''' ''Ok''. Users can now get data from ES for a given instance’s SysId and can check if it has the latest value or if a sync is needed.

12. '''Select''' ''Get ES Value''.

13. Enter the SysId and '''click''' ''Go''. If the key exists, the latest value from ES will be displayed. If the key does not exist, the error message ''Please enter valid SysId'' is displayed.

'''Note''': Data can be fetched from only one instance at a time.
<div class="image-green-border">[[File:Search Sync 8.png|720px|Search Sync 8]]</div>
=== Elastic Search Sync ===

Users can now get data from Elastic search for a given instance’s ''SysId'' so that they can look up the value and identify whether it is the latest or if a sync is needed. If the key exists, the latest value from ES will be displayed. If the key does not exist, the system will display the error message “Could not fetch value for provided SysId”.

'''Note''': Data can be fetched from only one instance at a time.
<div class="image-green-border">[[File:Search Sync ES.png|720px|Search Sync ES.png]]</div> <div class="image-green-border"> </div> <div class="image-green-border"> </div>

== Translations Editor ==
<div class="image-green-border">
The ICM platform is available in different languages and different languages label text are available for localization. However, to make any changes to the localization values, users had to reach out to the Solutions Engineering or Database teams. Sometimes, these changes were minor and of low complexity, but the turnaround time was substantial.

Hence, a self-service ''Translations Editor'' tool has been introduced that contains all strings that are localized.

Users can now download all keys and their localization values as an Excel file, modify multiple values, and upload the modified changes to ICM. Once the values are updated in ICM, the caches are updated automatically to avoid the cache flush and server restart. This has significantly enhanced productivity as the turnaround time to update the Resource Key values has been eradicated.

Using this tool, users can now:

*Search for a specific string using the search bar and update the Resource Key value for Language and Locale.
*Update multiple language strings by selecting and saving the Resource Key value.
*Download and upload the localization key values using Microsoft Excel.
*View the modified values in the ICM instance immediately.
</div> <div class="image-green-border">
To use the Translations Editor Tool:

1. '''Click''' the ''User Administration'' tile on the ''Home'' page.

2. '''Select '''''Admin Task'' from the drop-down. The ''Admin Task'' page opens.

[[File:User Administration.PNG|720px|User Administration]]

3. '''Select''' the ''Translation Editor ''task from the left pane.

[[File:Translation Editor 1.png|720px|Translation Editor 1]]

Users can update translations in the following ways:

1. For selective editing, select a language and a resource key to update the translations.

2. For bulk editing and updation of multiple languages and resource keys, use the Download / Upload option to download an MS Excel sheet.

 

===== Selective Editing to Update Translations =====

For editing Resource Key values selectively:

1. From the ''Select Language'' drop-down, select a language in which you want to edit the labels.  For example, français (French).

[[File:Translation Editor 2.png|720px|Translation Editor 2]]

The Resource Key and respective values of the selected language are displayed.

[[File:Translation Editor 3.png|720px|Translation Editor 3]]

2. '''Ente'''r a ''ResourceKey ''value in the''Search'' field to edit. For example, default. All ResourceKey(s) with the ''Par défaut (default)'' values from the French language are displayed.
<div class="note-box">'''Note:''' ResourceKey is a unique key by which the application gets its label text for different languages.</div>
[[File:Translation Editor 4.png|720px|Translation Editor 4]]
</div> <div class="image-green-border">
3. '''Click '''the ''Edit this Resource Key for Multiple Languages '''''icon '''in the ''Actions'' column.

You can change the key for a single language or for multiple languages as required. For example, change ''Par défaut'' to ''défaut'' in French or ''Predeterminado'' in Español (Spanish) to ''Defecto''.

[[File:Translation Editor 5.png|720px|Translation Editor 5]]

4. '''Click''' ''Update''. The ResourceKey value for ''default ''is updated to ''défaut ''for French and to ''Defecto'' in Spanish.

5. The ''Resources Updated Successfully'' message is displayed. '''Click''' ''Ok''.

 

You can select the respective languages (French or Spanish) to verify that the resources have been successfully updated.

 
</div>
===== Bulk Editing in Multiple Languages =====

 For editing Resource Key values of multiple languages in bulk:

1.'''Click''' ''Download File''. A Microsoft Excel file (named BulkActionWorkBookStringResource) that contains all the Resource keys and values for all supported languages in ICM is downloaded.

2.'''Open''' the downloaded Microsoft Excel file.

3. '''Click''' ''Enable Editing''. All ICM supported language Resource keys and their respective values are displayed.

4.'''Edit''' the ResouceKey of multiple languages as required.

5. '''Save''' the Excel file.

6.'''Click''' ''Upload File''. The ''Upload Translations'' window opens.

7. '''Click''' ''SelectFile''. The ''Open ''window opens.

8. '''Select''' the updated Excel file.

9.'''Click''' ''Open''. A warning window opens indicating that this is a heavy operation and can potentially affect overall application performance.

10.'''Click''' ''Ok''. The ''Upload Summary'' displays the number ''of Records Uploaded, Records Processed, ''and''Records Updated Successfully ''values.

11.'''Click''' ''Close''. The label translations have been achieved for multiple languages in bulk </div>

Admin Task

2020-08-01T18:27:18Z

IDT-4:

= Admin Task =

== Search Sync ==

The Search Sync tool gets data from Elastic Search (ES) for a given instance’s ''Sys Id ''and synchronizes it if required. Using the fetched ES value, the tool validates if the Sys Id is the latest for the respective instance or if a sync is required. This tool can be accessed by the Administrator from the ''Admin Task'' on ''User Administration'' tile.

If the key exists, the latest value from ES will be displayed. If the key does not exist, the system displays an error message indicating that the value could not be fetched for the provided Sys Id. The Sys Id can be provided as input CSV file or as comma separated. Either comma separated Sys Ids can be entered or a CSV file can be uploaded.

This helps to make the entity search more streamlined and efficient. Users can quickly refer to related agreements at the time of deals or audits.
<div class="note-box">'''Note''': Data can be fetched from only one instance at a time. A dedicated key must exist for ES sync to work with ''Sys ID''.</div>
You can search the documents that an Agreement is linked to.

To use the Search Sync Tool:

1. '''Click''' Home > User Administration > ''Admin Task''. The ''Admin Task'' page opens.
<div class="image-green-border">[[File:Search Sync 1.png|720px|Search Sync 1]]</div>
2. '''Click''' the ''Search Sync ''task from the left pane.
<div class="image-green-border">[[File:Search Sync 2.png|720px|Search Sync 2]]</div> <div class="image-green-border"> </div> <div class="image-green-border"><div class="image-green-border">4. '''Select''' the ''Entity Type ''from the drop-down to sync data to the Elastic Search. For example, Agreement.</div> </div>
5. '''Select''' the ''Contract Type ''from the drop-down''.''

5. '''Toggle '''''Skip Agreement Document Indexing ''to ''Yes/No'' as required.

6. To get the ''Sys Ids,'' '''click''' the ''Upload CSV button'' to upload the .CSV Agreement or enter the Sys Id using comma separated value in the box.

7. '''Click''' the ''Upload CSV'' button to upload the CSV document. The ''Upload Document'' window opens.
<div class="image-green-border">[[File:Search Sync 3.png|720px|Search Sync3]]</div> <div class="image-green-border">
8. '''Click''' ''SelectFile'' to upload a CSV file and add a note if required.
</div> <div class="image-green-border">[[File:Search Sync 4.png|720px|Search Sync 4]]</div> <div class="image-green-border"> </div> <div class="image-green-border">9.'''Click''' ''Upload File''. The file is uploaded to the ''File Path ''displayed.If the uploaded file format is incorrect, an alert message is displayed. The supported file formats will be also be displayed.</div> <div class="image-green-border">
If the uploaded file format is incorrect, an alert message is displayed. The supported file formats will be also be displayed.

[[File:Search Sync 6.png|720px|Search Sync 6]]
</div>
10. '''Click''' ''Sync''. The ''Sync Request Accepted'' message is displayed. 
<div class="image-green-border">[[File:Search Sync 7.png|720px|Search Sync7]]</div>
11. '''Click''' ''Ok''. Users can now get data from ES for a given instance’s SysId and can check if it has the latest value or if a sync is needed.

12. '''Select''' ''Get ES Value''.

13. Enter the SysId and '''click''' ''Go''. If the key exists, the latest value from ES will be displayed. If the key does not exist, the error message ''Please enter valid SysId'' is displayed.

'''Note''': Data can be fetched from only one instance at a time.
<div class="image-green-border">[[File:Search Sync 8.png|720px|Search Sync 8]]</div>
=== Elastic Search Sync ===

Users can now get data from Elastic search for a given instance’s ''SysId'' so that they can look up the value and identify whether it is the latest or if a sync is needed. If the key exists, the latest value from ES will be displayed. If the key does not exist, the system will display the error message “Could not fetch value for provided SysId”.

'''Note''': Data can be fetched from only one instance at a time.
<div class="image-green-border">[[File:Search Sync ES.png|720px|Search Sync ES.png]]</div> <div class="image-green-border"> </div> <div class="image-green-border"> </div>
== Translations Editor ==
<div class="image-green-border">
The ICM platform is available in different languages and different languages label text are available for localization. However, to make any changes to the localization values, users had to reach out to the Solutions Engineering or Database teams. Sometimes, these changes were minor and of low complexity, but the turnaround time was substantial.

Hence, a self-service ''Translations Editor'' tool has been introduced that contains all strings that are localized.

Users can now download all keys and their localization values as an Excel file, modify multiple values, and upload the modified changes to ICM. Once the values are updated in ICM, the caches are updated automatically to avoid the cache flush and server restart. This has significantly enhanced productivity as the turnaround time to update the Resource Key values has been eradicated.

Using this tool, users can now:

*Search for a specific string using the search bar and update the Resource Key value for Language and Locale.
*Update multiple language strings by selecting and saving the Resource Key value.
*Download and upload the localization key values using Microsoft Excel.
*View the modified values in the ICM instance immediately.
</div> <div class="image-green-border">
To use the Translations Editor Tool:

1. '''Click''' the ''User Administration'' tile on the ''Home'' page.

2. '''Select '''''Admin Task'' from the drop-down. The ''Admin Task'' page opens.

3.'''Select''' the ''Translation Editor ''task from the left pane.

Users can update translations in the following ways:

1. For selective editing, select a language and a resource key to update the translations.

2. For bulk editing and updation of multiple languages and resource keys, use the Download / Upload option to download an MS Excel sheet.

 

===== Selective Editing to Update Translations =====

For editing Resource Key values selectively:

1. From the ''Select Language'' drop-down, select a language in which you want to edit the labels.  For example, français (French).

The Resource Key and respective values of the selected language are displayed.

2. '''Ente'''r a ''ResourceKey ''value in the''Search'' field to edit. For example, default. All ResourceKey(s) with the ''Par défaut (default)'' values from the French language are displayed.

'''Note:''' ResourceKey is a unique key by which the application gets its label text for different languages.
</div> <div class="image-green-border">
3. '''Click '''the ''Edit this Resource Key for Multiple Languages '''''icon '''in the ''Actions'' column.

You can change the key for a single language or for multiple languages as required. For example, change ''Par défaut'' to ''défaut'' in French or ''Predeterminado'' in Español (Spanish) to''Defecto''.

4. '''Click''' ''Update''. The ResourceKey value for ''default ''is updated to ''défaut ''for French and to ''Defecto'' in Spanish.

5. The ''Resources Updated Successfully'' message is displayed. '''Click''' ''Ok''.
You can select the respective languages (French or Spanish) to verify that the resources have been successfully updated.</div>
===== Bulk Editing in Multiple Languages =====

 For editing Resource Key values of multiple languages in bulk:

1.'''Click''' ''Download File''. A Microsoft Excel file (named BulkActionWorkBookStringResource) that contains all the Resource keys and values for all supported languages in ICM is downloaded.

2.'''Open''' the downloaded Microsoft Excel file.

3. '''Click''' ''Enable Editing''. All ICM supported language Resource keys and their respective values are displayed.

4.'''Edit''' the ResouceKey of multiple languages as required.

5. '''Save''' the Excel file.

6.'''Click''' ''Upload File''. The ''Upload Translations'' window opens.

7. '''Click''' ''SelectFile''. The ''Open ''window opens.

8. '''Select''' the updated Excel file.

9.'''Click''' ''Open''. A warning window opens indicating that this is a heavy operation and can potentially affect overall application performance.

10.'''Click''' ''Ok''. The ''Upload Summary'' displays the number ''of Records Uploaded, Records Processed, ''and''Records Updated Successfully ''values.

11.'''Click''' ''Close''. The label translations have been achieved for multiple languages in bulk </div>

File:Translation Editor 8.png

2020-08-01T18:13:49Z

IDT-4: IDT-4 uploaded a new version of File:Translation Editor 8.png

File:Translation Editor 8.png

2020-08-01T18:12:34Z

IDT-4:

File:Translation Editor 5.png

2020-08-01T18:11:54Z

IDT-4:

File:Translation Editor 4.png

2020-08-01T18:11:36Z

IDT-4:

File:Translation Editor 3.png

2020-08-01T18:11:16Z

IDT-4:

File:Translation Editor 2.png

2020-08-01T18:10:54Z

IDT-4: