From ICIHelp8.2
Jump to: navigation, search
Line 48: Line 48:
 
'''Note''': Data can be fetched from only one instance at a time.
 
'''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">&nbsp;</div> <div class="image-green-border">&nbsp;</div>  
 
<div class="image-green-border">[[File:Search Sync ES.png|720px|Search Sync ES.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">&nbsp;</div>  
 +
 
== Translations Editor ==
 
== Translations Editor ==
 
<div class="image-green-border">
 
<div class="image-green-border">
Line 69: Line 70:
 
2. '''Select '''''Admin Task''&nbsp;from the drop-down. The ''Admin Task'' page opens.
 
2. '''Select '''''Admin Task''&nbsp;from the drop-down. The ''Admin Task'' page opens.
  
3.'''Select'''&nbsp;the&nbsp;''Translation Editor ''task from the left pane.
+
[[File:User Administration.PNG|720px|User Administration]]
 +
 
 +
3.&nbsp;'''Select'''&nbsp;the&nbsp;''Translation Editor ''task from the left pane.
 +
 
 +
[[File:Translation Editor 1.png|720px|Translation Editor 1]]
  
 
Users can update translations in the following ways:
 
Users can update translations in the following ways:
Line 84: Line 89:
  
 
1. From the ''Select Language'' drop-down, select a language in which you want to edit the labels.&nbsp; For example, français (French).
 
1. From the ''Select Language'' drop-down, select a language in which you want to edit the labels.&nbsp; 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.
 
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.
+
[[File:Translation Editor 3.png|720px|Translation Editor 3]]
  
'''Note:''' ResourceKey is a unique key by which the application gets its label text for different languages.
+
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">
 
</div> <div class="image-green-border">
 
3.&nbsp;'''Click '''the ''Edit this Resource Key for Multiple Languages&nbsp;'''''icon '''in the ''Actions'' column.
 
3.&nbsp;'''Click '''the ''Edit this Resource Key for Multiple Languages&nbsp;'''''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''.
+
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&nbsp;''Defecto''.
 +
 
 +
[[File:Translation Editor 5.png|720px|Translation Editor 5]]
  
 
4.&nbsp;'''Click''' ''Update''. The ResourceKey value for ''default ''is updated to ''défaut ''for French and to ''Defecto'' in Spanish.
 
4.&nbsp;'''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''.
 
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>  
+
 
 +
&nbsp;
 +
 
 +
You can select the respective languages (French or Spanish) to verify that the resources have been successfully updated.
 +
 
 +
&nbsp;
 +
</div>  
 
===== Bulk Editing in Multiple Languages =====
 
===== Bulk Editing in Multiple Languages =====
  

Revision as of 18:34, 1 August 2020

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.

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.

Search Sync 1

2. Click the Search Sync task from the left pane.

Search Sync 2
 
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.

Search Sync3

8. Click SelectFile to upload a CSV file and add a note if required.

Search Sync 4
 
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.

Search Sync 6

10. Click Sync. The Sync Request Accepted message is displayed. 

Search Sync7

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.

Search Sync 8

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.

Search Sync ES.png
 
 

Translations Editor

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.

User Administration

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

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).

Translation Editor 2

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

Translation Editor 3

2. Enter a ResourceKey value in theSearch 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.

Translation Editor 4

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.

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.

 

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, andRecords Updated Successfully values.

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