From ICIHelp8.1
Jump to: navigation, search
Line 19: Line 19:
 
#'''Click '''''[[User_Administration|User_Administration]] ''on the [[Dashboard|Dashboard]]. The ''[[User_Administration|User_Administration]] ''page opens.   
 
#'''Click '''''[[User_Administration|User_Administration]] ''on the [[Dashboard|Dashboard]]. The ''[[User_Administration|User_Administration]] ''page opens.   
 
#'''Click '''''Security Groups ''on the ''User Administration ''page. The ''Security Group ''page opens.   
 
#'''Click '''''Security Groups ''on the ''User Administration ''page. The ''Security Group ''page opens.   
−
#'''Click '''the  icon next to the Security Group to open it.   
+
<div class="image-green-border">[[File:Enable Bulk Action Tile.png|Enable_Bulk_Action]]</div> <ol start="3">
−
#'''Navigate&nbsp;'''to the&nbsp;''Privileges&nbsp;''section in the Security Group and search for&nbsp;''Bulk Action&nbsp;''under the&nbsp;''Entity Name&nbsp;''column.&nbsp;  
+
<li>'''Click&nbsp;'''the&nbsp; icon next to the Security Group to open it.&nbsp;</li>
−
#'''Select&nbsp;'''''Bulk Action&nbsp;''option under&nbsp;''Manage&nbsp;''or&nbsp;''View&nbsp;''column depending on whether you want to provide&nbsp;''Manage&nbsp;''or&nbsp;''View&nbsp;''privileges to the&nbsp;''Bulk Action&nbsp;''tile. The&nbsp;''Bulk Action&nbsp;''tile will be displayed on the Dashboard.&nbsp;  
+
<li><div class="image-green-border">'''Navigate&nbsp;'''to the&nbsp;''Privileges&nbsp;''section in the Security Group and search for&nbsp;''Bulk Action&nbsp;''under the&nbsp;''Entity Name&nbsp;''column.&nbsp;[[File:Edit Security Group.png|Edit-_Security_Group]]</div> </li>
 +
<li>'''Select&nbsp;'''''Bulk Action&nbsp;''option under&nbsp;''Manage&nbsp;''or&nbsp;''View&nbsp;''column depending on whether you want to provide&nbsp;''Manage&nbsp;''or&nbsp;''View&nbsp;''privileges to the&nbsp;''Bulk Action&nbsp;''tile. The&nbsp;''Bulk Action&nbsp;''tile will be displayed on the Dashboard.&nbsp;</li>
 +
</ol>
  
 
The Bulk Action tile enables you to:
 
The Bulk Action tile enables you to:
Line 34: Line 36:
  
 
1. '''Click&nbsp;'''''Bulk Actions&nbsp;''tile on the Dashboard. The&nbsp;''Bulk Action Management&nbsp;''page opens where you can update the existing entities by adding Amendments using the&nbsp;''Update Existing&nbsp;''tile.&nbsp;
 
1. '''Click&nbsp;'''''Bulk Actions&nbsp;''tile on the Dashboard. The&nbsp;''Bulk Action Management&nbsp;''page opens where you can update the existing entities by adding Amendments using the&nbsp;''Update Existing&nbsp;''tile.&nbsp;
−
 
−
[[File:Bulk Actions Tile.png|RTENOTITLE]]
 
  
 
To add an Amendment:&nbsp;
 
To add an Amendment:&nbsp;
  
−
#'''Click&nbsp;'''''Update Existing&nbsp;''on the&nbsp;''Bulk Action Management&nbsp;''page. The&nbsp;''Update&nbsp;''page opens.&nbsp;  
+
#<div class="image-green-border">'''Click&nbsp;'''''Update Existing&nbsp;''on the&nbsp;''Bulk Action Management&nbsp;''page. The&nbsp;''Update&nbsp;''page opens.&nbsp;\[[File:Update Existing Entities.PNG|Update_Existing_Entities]]</div> 
 
#'''Perform&nbsp;'''the following actions on this page and&nbsp;'''click&nbsp;'''''Next.&nbsp;''  
 
#'''Perform&nbsp;'''the following actions on this page and&nbsp;'''click&nbsp;'''''Next.&nbsp;''  
 
<ul style="margin-left: 40px;">
 
<ul style="margin-left: 40px;">
Line 45: Line 45:
 
<li>Saved Search: You must have a Saved Search created before you can update any entity.&nbsp;'''Select&nbsp;'''the Saved Search from this drop-down, which shows all the Saved Searches by the logged on user and the global Saved Searches.&nbsp;</li>
 
<li>Saved Search: You must have a Saved Search created before you can update any entity.&nbsp;'''Select&nbsp;'''the Saved Search from this drop-down, which shows all the Saved Searches by the logged on user and the global Saved Searches.&nbsp;</li>
 
<li>Contract Type Name:&nbsp;'''Select&nbsp;'''the Contract Type name from this drop-down. The user can view only those Contract Types that are associated with the Saved Search and to which the user has access.&nbsp;</li>
 
<li>Contract Type Name:&nbsp;'''Select&nbsp;'''the Contract Type name from this drop-down. The user can view only those Contract Types that are associated with the Saved Search and to which the user has access.&nbsp;</li>
−
<li>[[File:Update Existing Tile.PNG|RTENOTITLE]]</li>
 
 
</ul>
 
</ul>
−
 
+
<div class="image-green-border">[[File:Update Existing Entities 1.PNG]]</div>
 
== Selecting the Attributes&nbsp; ==
 
== Selecting the Attributes&nbsp; ==
  
Line 58: Line 57:
 
#'''Select&nbsp;'''the Attributes from the&nbsp;''Available Attributes&nbsp;''list and move it to the&nbsp;''Selected Attribute&nbsp;''column. For example,&nbsp;''Use Amendment Template.&nbsp;'''''Click&nbsp;'''''Yes&nbsp;''when prompted to add parent Attribute.&nbsp;  
 
#'''Select&nbsp;'''the Attributes from the&nbsp;''Available Attributes&nbsp;''list and move it to the&nbsp;''Selected Attribute&nbsp;''column. For example,&nbsp;''Use Amendment Template.&nbsp;'''''Click&nbsp;'''''Yes&nbsp;''when prompted to add parent Attribute.&nbsp;  
 
#'''Click&nbsp;'''''Generate Workbook.&nbsp;''This generates and downloads the workbook with the system Attributes that are inherited as well the Attributes that you selected.&nbsp;  
 
#'''Click&nbsp;'''''Generate Workbook.&nbsp;''This generates and downloads the workbook with the system Attributes that are inherited as well the Attributes that you selected.&nbsp;  
−
 
+
<div class="note-box">'''Note''': The file name of the downloaded workbook is the same as the Contract Type you selected on the&nbsp;''Details&nbsp;''page.&nbsp;</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:Generate Workbook.png|Generate_Workbook]]</div> <ol start="3">
−
'''Note''': The file name of the downloaded workbook is the same as the Contract Type you selected on the&nbsp;''Details&nbsp;''page.&nbsp;
+
<li><div class="image-green-border">'''Open&nbsp;'''the workbook that is downloaded and saved on your local drive. This workbook contains the information about the selected Attributes and Contract Type.&nbsp;[[File:View Workbook.png]]</div> </li>
−
<ol start="3">
+
−
<li>'''Open&nbsp;'''the workbook that is downloaded and saved on your local drive. This workbook contains the information about the selected Attributes and Contract Type.&nbsp;</li>
+
 
<li>'''Click&nbsp;'''the&nbsp;''Enable Editing&nbsp;''button on the Excel workbook (if required) to make changes as required.</li>
 
<li>'''Click&nbsp;'''the&nbsp;''Enable Editing&nbsp;''button on the Excel workbook (if required) to make changes as required.</li>
 
</ol>
 
</ol>
Line 84: Line 81:
 
<li>If the&nbsp;''Type of Paper&nbsp;''is&nbsp;''Third Party&nbsp;''and ''File path'' column is left blank, the system uses the last approved version of the parent Agreement to add that Amendment.</li>
 
<li>If the&nbsp;''Type of Paper&nbsp;''is&nbsp;''Third Party&nbsp;''and ''File path'' column is left blank, the system uses the last approved version of the parent Agreement to add that Amendment.</li>
 
</ul>
 
</ul>
−
 
−
&nbsp;
 
  
 
*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. While adding an Amendment, the parent Agreement status will always be ''Executed.''&nbsp;  
 
*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. While adding an Amendment, the parent Agreement status will always be ''Executed.''&nbsp;  
Line 98: Line 93:
 
&nbsp;
 
&nbsp;
  
−
&nbsp;
+
<br/> &nbsp;
−
 
+
−
&nbsp;
+
−
<div class="image-green-border">[[File:Update Existing Details.PNG|RTENOTITLE]]</div>
+
−
5. '''Select&nbsp;'''the Attributes from the ''Available Attribute'' list and move to the ''Selected Attribute'' column to be displayed in the workbook you generate. For example, Effective Date, Expiry Date, and so on.
+
−
 
+
−
6. '''Click '''''Generate Workbook.&nbsp;''This generates the workbook with the Attributes selected.&nbsp;
+
−
 
+
−
7. '''Open '''the Excel workbook that is downloaded and saved to your local drive. This workbook contains information about the selected Attributes and Contract Type. The file name of this workbook is same as the Contract Type that you selected.&nbsp;
+
−
<div class="image-green-border">[[File:View Batch.png|RTENOTITLE]]</div>
+
−
8. '''Click '''the ''Enable Editing'' button on the Excel workbook to make changes as required. For example, changing the Expiry Date for Agreements.
+
−
 
+
−
9. '''Click&nbsp;'''''Save&nbsp;''to save your edits.&nbsp;
+
−
 
+
−
10.'''Click '''the ''Add Batch'' [[File:Add Batch icon.png|RTENOTITLE]]''&nbsp;''icon on the&nbsp;''Bulk Action Management ''page. This opens the ''Add Batch&nbsp;''window and you can upload the edited Excel workbook to ICM.
+
−
 
+
−
11.'''Enter''' the ''Batch Name''. For example, AutomationAgreementsDec2018.
+
−
 
+
−
12.'''Click '''the ''Choose File'' button next to the Data File field to select and upload the workbook file to ICM.
+
−
 
+
−
13. '''Click '''the ''Choose File ''button next to the ''Attached Zip File'' field to select and upload all the records for the batch to ICM. The maximum size of the zip file supported is 100 MB.&nbsp;
+
−
 
+
−
14. '''Click '''the ''Add'' button. The Excel workbook is uploaded to ICM with a status of ''Added to Queue.&nbsp;''This batch is added to the queue for automatic validation.
+
−
 
+
−
When ICM starts processing the batch, the status of the batch changes to ''In Progress.'' ICM validates the accuracy of the records in the batch while processing and the records are processed.
+
−
 
+
−
&nbsp;While processing the batch, every record is validated for:&nbsp;
+
−
 
+
−
*Correct data type for all Attributes being uploaded
+
−
*Selected Template if any is correctly added
+
−
*Files specified in the workbook are available in the uploaded zip file
+
−
*Agreements of the selected Contract Types are in&nbsp;''Executed&nbsp;''state
+
−
 
+
−
15.&nbsp; '''Click&nbsp;'''the [[File:Bulk Action Refresh icon.png|RTENOTITLE]]on the&nbsp;''Bulk Action Management&nbsp;''page to refresh this page and view the status of the batch you uploaded.&nbsp;When the batch is successfully uploaded, the status changes to&nbsp;''Completed.&nbsp;''
+
−
<div class="image-green-border">''[[File:Batch Upload Success.PNG|RTENOTITLE]]''</div>
+
−
Additional information about columns:&nbsp;
+
−
 
+
−
*Status: Shows the following statuses of the batches that are processed.&nbsp;
+
−
**''Added to Queue:&nbsp;''indicates that user added a new batch for processing
+
−
**''Completed:&nbsp;''indicates that processing of the batch is complete 
+
−
*Success: shows the number of records that passed the validation process&nbsp;
+
−
*Failure: shows the number of records that failed the validation process&nbsp;
+
−
*Start Time: shows the date and time when batch processing started&nbsp;
+
−
*End Time: shows the date and time when batch processing ended&nbsp;
+
−
*Created By: shows the name of the user who created the batch
+
−
<div class="note-box">'''Note''': Users can view only the batches that are created by themselves. However administrator can view the batches created by all users.&nbsp;</div>  
+
−
== Viewing the error&nbsp;and status files&nbsp; ==
+
−
 
+
−
After the batch is processed, a&nbsp;''Download Status Files&nbsp;''icon appears under&nbsp;''Actions&nbsp;''column.&nbsp;
+
−
 
+
−
1. '''Click&nbsp;'''the icon. The&nbsp;''Download Status Files&nbsp;''window opens.&nbsp;
+
−
 
+
−
2. '''Click&nbsp;'''the&nbsp;''Status File&nbsp;''to download the status file of the batch.&nbsp;
+
−
 
+
−
3. '''Click&nbsp;'''''Error File&nbsp;''to download the error file that displays errors if any while creating the batch.&nbsp;
+
−
 
+
−
&nbsp;
+

Revision as of 06:30, 5 February 2019

Bulk Actions 

Users can perform bulk actions using the Bulk Actions tile on the Dashboard to create and update multiple entities directly within ICM. You can also perform these actions using Excel Add-in. When uploaded, these entities become part of the ICM workflow and can be managed within ICM itself.

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 providing visibility to the 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 validation. The error file indicates the specific validation errors while processing the batch

You can enable the Bulk Action tile through the Security Groups. 

To enable the Bulk Action tile: 

  1. Click User_Administration on the Dashboard. The User_Administration page opens. 
  2. Click Security Groups on the User Administration page. The Security Group page opens. 
Enable_Bulk_Action
  1. Click the  icon next to the Security Group to open it. 
  2. Navigate to the Privileges section in the Security Group and search for Bulk Action under the Entity Name column. Edit-_Security_Group
  3. 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 Action tile will be displayed on the Dashboard. 

The Bulk Action tile enables you to:

  • Update Existing Entities, for example make 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.  

To perform Bulk Actions: 

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

To add an Amendment: 

  1. Click Update Existing on the Bulk Action Management page. The Update page opens. \Update_Existing_Entities
  2. Perform the following actions on this page and click Next. 
  • Bulk Upload Action: Select Add Amendments from this drop-down. This helps in adding an Amendment to an existing Agreement. You can add Amendments only to Agreements in Executed state. 
  • Saved Search: You must have a Saved Search created before you can update any entity. Select the Saved Search from this drop-down, which shows all the Saved Searches by the logged on user and the global Saved Searches. 
  • Contract Type Name: Select the Contract Type name from this drop-down. The user can view only those Contract Types that are associated with the Saved Search and to which the user has access. 
Update Existing Entities 1.PNG

Selecting the Attributes 

While adding an Amendment to existing Agreement, you can select only the Attributes which you want to modify. Note that, values for non-editable as well as system Attributes such as Agreement Code cannot be selected. The metadata of the rest of Attributes is copied as is from the parent Agreement. 

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. 

Follow these steps to select additional Attributes: 

  1. 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. 
  2. Click Generate Workbook. This generates and downloads the workbook with the system Attributes that are inherited as well the Attributes that you selected. 
Note: The file name of the downloaded workbook is the same as the Contract Type you selected on the Details page. 
 
Generate_Workbook
  1. Open the workbook that is downloaded and saved on your local drive. This workbook contains the information about the selected Attributes and Contract Type. View Workbook.png
  2. Click the Enable Editing button on the Excel workbook (if required) to make changes as required.

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 while generating the workbook in the example above. 
  • Use Amendment Template: This Attribute plays an important role in selection of the Template while 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 Attribute Selection page to achieve the desired result as mentioned below: 

  • If the Type of Paper is Own and a valid Template name is specified in the Template Name column, then system attaches that valid Template to the Amendment. 
  • If the Type of Paper is Own and Use Amendment Template is set to True and the Template Name column is blank, then the system automatically selects the valid Template. If there is exactly one Template applicable for the combination of the attribute metadata, the system automatically selects that Template to create an Amendment. If there are several valid Templates that are applicable, the system generates an error and provides a list of Templates to select from.
  • If the Type of Paper is Own and Use Amendment Template is set to False and Template name column is left blank, the system selects the last approved version of the parent Agreement to create that Amendment.
  • If the Type of Paper is Third Party and user specifies the file name in the File path column, that file is used to create that Amendment.
  • If the Type of Paper is Third Party and File path column is left blank, the system uses the last approved version of the parent Agreement to add that Amendment.
  • 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. While 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. It indicates the organization unit.
    • Type of Paper: This is a mandatory and user editable Attribute. It can have either Own or Third Party as values.
  • Template Name: This is a user-defined field. If the Type of Paper is Own ,the value in this field is considered while 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 while 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 while adding a new batch.
  • Action: You can use this field to specify the workflow action. In this release, only Create action is supported.

Information Sheet: System adds a default sheet named Information where you can find the general information about the upload action you have selected as well as the mapping of Contract Type name with sheet names. You should not make any changes to this sheet. After 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.

 


 

Retrieved from "https://iciwikiapac.icertis.com:443/ICIHelp8.1/index.php?title=Bulk_Actions&oldid=7950"