Revision as of 08:31, 9 December 2021

Bulk Actions 

Users can perform bulk actions using the "Bulk Actions" from the main navigation menu on the top to create and update multiple entities directly within ICI. When uploaded, these entities become part of the ICI workflow and can be managed within ICI itself. You can also perform these actions using Excel Add-in. With this utility, the overhead of installing and updating ICI Excel Add-in periodically on your machine can be avoided, besides, reducing the time taken to create and/or update records in ICI.

• 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 ICI user interface (which is not possible when using Excel Add-in).
• Ability to check the number of valid Templates for an Amendment when using your "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.

Enabling Bulk Actions Menu

You can enable the "Bulk Actions" menu or tile through the Security Groups. 

To enable the Bulk Actions: 

1. Click Admin > Security Groups on the main navigation menu at the top. The "Security Groups" index page opens. 

2. Click the "View Details" eye icon on the extreme right for the Security Group you want to view. The "Security Groups" Details page opens.

3. Click "Edit" on the far-right in the title bar. The "Edit Security Groups" page opens.

4. Navigate to the "Privileges" tab in the Security Group and search for "Bulk Action" under the "Entity Name" column. 

5. Select the "Bulk Action" option under the "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 main navigation menu on the top. 

The Bulk Actions tile enables you to:

• Update Existing Entities. For example, making changes to Agreements that are in an "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" main navigation menu on the top. 

2. Click "Create New". The Create page opens with 2 tabs: Details and Attributes

3. In the "Details" tab or section, select "Create Agreement" from the "Bulk Upload Action" drop-down.

4. Select a "Contract Type Name" from the drop-down list, for example, "ICMAutomationBasicAgreement". The respective Associations of the Contract Type are displayed. Mandatory Associations are auto-selected and can not be removed.

• 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 Attributes are in white with a blue background

Adding an Amendment using Bulk Actions

Enabling Attribute inheritance for amendments

1. Click "Contract Types" under the "Configure" main navigation menu on top. The "Contract Types" index page opens.

2. Click the "View Details" eye icon corresponding to the contract type you want open on the last column. For example, "ICMAutomationBasicAgreement". The "Contract Types" Details page opens.

3. Click "Edit". The "Edit Contract Type" page opens with the "Details" tab.

5. Select the Attribute in the "Selected Attributes" pane. For example, "Use Amendment Template". The respective Attribute's details appear on the right.

6. Toggle the "Is Inherit On Amendments" field at the bottom and click "Save" on the top right corner for the Attribute to get updated. 

Note: By default, the "Is Inherit On Amendments" property is "On" for attributes. The configurator should consider the behavior of the rest of the attribute properties along with "Is Inherit On Amendments" before setting it to "Off".

Bulk Action - Add Amendment

1. Click "Bulk Actions" tile on the main navigation menu at the top. 

2. Click "Update Existing". The "Update Bulk Action WorkBook" page opens. 

• Bulk Upload Action: Select "Add Amendments" from the drop-down. This helps in adding an Amendment to an existing Agreement.

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

4. Click "Next".

Selecting Attributes 

When adding an Amendment to an existing Agreement, select only the Attributes that you want to modify.

This page displays only Attributes related to the 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: 

1. Select the Attributes from the Available Attributes list and move them to the Selected Attribute column. For example, Account Owner. 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. 

3. Open the Workbook that was downloaded on your local drive. This Workbook contains information about the selected Attributes and Contract Type. 

The attributes which have inheritance enabled for amendments will have their values copied from the base agreement and are auto-filled in the workbook. For example, attribute Contract Value has its values copied from the base agreement ICM Automation Basic Agreement.

• The "Is Inherit On Amendments" attribute property is only available for Agreement contract types.
• When the "Is Inherit On Amendments" is set to "Off" for an attribute, its value will not be inherited to its amendment.
• The technical configuration settings for excluding base agreement attributes from its amendments will always take preference over the settings at the agreement contract type and template level. For example, if the attribute Contract value has Is Inherit On Amendments set to On at the contract type level, but set to be excluded in a config key, the value for Contract Type will not be inherited to its amendment.

4. Click the "Enable Editing" button on the Excel Workbook to make changes as required.

Populating the Workbook 

The Workbook that was generated in the previous step contains the Attributes you have selected as a 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 the 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: 

• If the "Type Of Paper" is "Own" and a valid Template name is specified in the Template Name column, then ICI attaches that valid Template to the Amendment. 
• If the "Type Of Paper" is "Own", the "Use Amendment Template" is set to True, and the Template Name column is blank, then ICI automatically selects the valid Template. If there is exactly one Template applicable for the combination of the Attribute metadata, the ICI automatically selects that Template to create an Amendment. If there are several valid Templates that are applicable, the ICI generates an error and provides a list of Templates to select from.
• If the "Type Of Paper" is "Own", the Use Amendment Template is set to "False", and the Template Name column is left blank, ICI selects the last approved version of the parent Agreement to create that Amendment.
• If the "Type Of Paper" is "Third Party" and the user specifies the file name in the "File Path" column, the specified file is used to create that Amendment.
• If the "Type Of Paper" is Third Party and the "File Path" column is left blank, ICI 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. 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 a 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 the 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 ICI when adding a new batch.
• Actions: This field is used to specify the workflow action. In this release, only the "Create" action is supported.

Understanding the Information Sheet

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 

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.

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: 

1. Click the Download Status File icon. The Download Status Files window opens. 
2. Click the Status File or Error File to download the applicable file of the batch. 

• 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 ICI 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
• Initiate Termination