Latest revision as of 07:20, 16 June 2021

Legacy Upload

Organizations may have a large number of existing Agreements that are created outside of ICI platform. These are henceforth referred to as Legacy Agreements. Organizations may want to import these Agreements to ICI to leverage its vast capabilities and manage all Agreements within a single platform.

ICI Legacy Upload tool helps in migrating these large volumes of legacy Contracts from the Customer system to ICI Application with accuracy and efficiency which helps in creating a central repository. This in turn helps in a shift from Paper base to digitalization.

The highlights of the ICI Legacy Upload Tool are:

Uploading entities such as Agreements and their respective Teams, Notes, and Commitments in bulk.
Uploading Associations, Masterdata, User Information and Amendments in bulk.
Bulk Clause and Template creation, with the power of Attribute/metadata tagging.
Enhanced validations, including the ability to exclude the specified attributes from being validated.
Ability to view logs and report of success and failure statuses on legacy UI.
Record level email notification trigger capability as per customer requirement.
Reporting capabilities on the uploaded legacy records.
Email Notifications for batch initiation and completion.
Support of Peer Association & Linkage types, ensuring no manual work post legacy upload.
Enabling legacy upload of Agreements with Status as Expired, Terminated.
Support uploading of files from Sub folder from Task server and blob storage repository.

Important Considerations

Only an Administrator can perform a Legacy Upload of the entities.
The absolute path where the Agreements and other entities documents are saved must be accessible by the task service of the ICI instance. This must be ensured while configuring the ICI instance.
The Data files created in Excel can only have .xlsx extension.
For Agreements, only .pdf files are supported. For Associations, several file formats such as .pdf, .docx, .doc, .xlsx, .jpeg, .png and .zip are supported.
Contract types for the Agreements and other entities that you are trying to upload must be present in Published state in ICI.
To upload any Associations, ensure that the relevant contract type has been added in the Associations tab in the parent contract type.
An attribute which will always have unique value must be present in ICI so that the relevant value can be used as a Primary Key to map other entities with that Agreement. If such an attribute does not already exist, you must create it. The unique value attribute can be a backend attribute which may not be visible on the UI. However, Agreement Code attribute, though unique, contains a system-generated value that is generated only after an Agreement has been created thus, cannot be used as a Primary Key for the contract type.
When adding batches for uploading, it is advisable not to schedule too many batches at close intervals and configure schedules to line-up batches to be uploaded at different times to optimize the processing speed.
Since this is only a provisioning tool, as such any sort of updates to uploaded records are not supported.

Uploading entities using Legacy Upload

You can use the utility to upload the following entities:

Agreements with Team, Notes, and Commitment
Amendments with Team, Notes, and Commitment
Associated Documents (with or without workflow)
Masterdata (with or without workflow)
User Information (with or without Extended Attributes)
Clauses (with or without Extended Attributes)
Templates (with or without Extended Attributes)

The Legacy Upload tool follows a simple workflow to upload the aforementioned entities.

The workflow for Legacy Upload process at a glance:

Creating a contract type entity for Legacy Upload

To upload legacy records in ICI, there must be a relevant contract type configured in the ICI as per the specific entity type need of legacy records.

If the contract type does not exist in ICI, you must create the contract type for the entity of legacy records. You must configure the details of legacy records as the attributes in ICI contract type.

Configuring contract type with or without approval workflow

You can upload entities such as associations, masterdata with or without approval workflow using the Legacy Upload tool.

You can automatically attach the approval workflow to an entity while processing the legacy upload batch. All you have to do is enable the approval workflow in the contract type by setting the Enable Approval Workflow attribute value to Yes.

For entities that have the Enable Approval Workflow attribute value set to No in their contract type, the approval workflow will not follow automatically. You can enable the workflow manually, whenever needed, by clicking the Resume WF icon.

When an entity that has been uploaded without workflow is viewed in ICI, it will not have any buttons visible on the UI.

To create a contract type:

Click Configuration > Create Contract Type on the Home page. The Create Contract Type page opens.
Select the Contract Type of the entity for which you want to upload legacy records. For example, AGREEMENT Contract Type.
Click Next. The Details tab opens.
Enter the Contract Type Name and other required details.
Toggle the Enable Approval Workflow to Yes if you want to enable the workflow for approval for this contract type with the creation.

Click Next. The Attributes tab opens.
Select and add the Attributes which are required for the legacy records you are uploading, to map them to the ICI Contract Type.

Click Next and enter the details on the Associations, Display Preference and Team tabs to complete the contract type creation following the standard ICI workflow.

Refer the Creating a Contract Type for further details on how to configure contract types.

Note: You do not need to create a contract type for amendments as the required contract type is already available when the parent agreement records were created.

Configuring contract type with mandatory Associations

There may be cases where any associated documents are required before an Agreement can move to the Executed, Expired or Terminated state. In that case, you can defer the workflow for the Agreement while uploading, then upload the required Association with workflow attached, and then enable the workflow for the Agreement when needed.
Whether an Association is mandatory or not can be seen in ICI in the following 2 ways:
If Is Mandatory flag is set to Yes while adding an Association for a particular Agreement Contract Type then the Association is mandatory.

If Prerequisite or Post requisite is selected in the Constraint drop-down list while creating an Associated Document Contract Type then the Association is mandatory.

Creating a batch for an entity

Once the relevant contract type is present in the ICI, you can create a new batch to upload the legacy records in the ICI from the Legacy Upload page.

Creating a batch for agreements

Click the User Administration tile on the Home page. The sub menu tiles dropdown opens.
Click the Admin Task tile. The Admin Task page opens.

Click the Legacy Upload option. The Legacy Upload page opens.

Click the Create Batch icon. The Create Batch page’s Details tab opens.

Identify the entity for legacy records and select the Legacy Upload Action accordingly from the dropdown. For example, select Create Agreement when you are creating a batch of agreements.

Select the Contract Type Name. The dropdown will show all agreement contract types configured in ICI. For example, ICMMSA.

Click Next. The Attributes tab opens. The Available Attribute section shows all attributes from the selected agreement contract type in the left column. The mandatory attributes like Name is already populated in the Selected Attribute list.
Select the attributes for which you want to upload the legacy data in the current batch from the Available Attribute section and add to the Selected Attribute section using the action arrows. For example, select attributes Name, Contract Description and Effective Date.

Note: Mandatory and Dependent attributes will be automatically included in the generated workbook.

Click Generate Workbook. The workbook template is generated in the MS Excel format and downloaded at the pre-set download location on your system.

Creating a batch for Amendments

The agreement contract type for uploading Amendments is already available in the ICI when the parent agreements were created or unloaded. You can create a set of agreements that you want to upload amendments to, using the Saved Search capability.

To create an amendment batch:

Click User Administration > Admin Task on the Home page. The Admin Task page opens.
Click the Legacy Upload option. The Legacy Upload page opens.
Click the Create Batch icon. The Create Batch page’s Details tab opens.
Select the Legacy Upload Action from the dropdown. For example, Create Amendment. The fields to select Saved Search and Contract Type name are displayed.
Select a Saved Search. For example, All Executed Agreements.

You must create a saved search beforehand to group the agreement records to which you want to add the amendments through Legacy Upload. For example, here, configure the Saved Search for all Executed Agreements. The system would ignore all statuses other than Executed.

Select the Contract Type Name. The dropdown will show all agreement contract types from the selected Saved Search. For example, select ICMMSA.

Click Next and complete the batch creation for Amendments following the same process as for the creation of the agreement batch.

Creating a batch for Associations

Before you proceed to upload Associations using the Legacy Upload, ensure that the parent Agreements are already uploaded. Also ensure that the Associated Document Contract Type has been added in the Associations tab in the parent Agreement Contract Type.

You can upload Associations with or without Approval Workflow using Legacy Upload in the ICI.

Associations can be mapped with their parent agreements using a Saved Search capability. A set of agreements can be created for which you want to upload peer associations by configuring a Saved Search beforehand. The auto-generated workbook will contain the agreements details from the selected saved search as the parent agreements. These details would help users to find the records in the ICI and map them with the Association agreement code in the workbook.

To create an Association batch:

Click User Administration > Admin Task on the Home page. The Admin Task page opens.
Click the Legacy Upload option. The Legacy Upload page opens.
Click the Create Batch icon. The Create Batch page’s Details tab opens.
Select the Legacy Upload Action from the dropdown. For example, Create Association. The fields to select a Saved Search and parent Contract Type are displayed.
Select a Saved Search to pick a set of parent agreements. For example, All MSA Draft Status.
Select the Contract Type Name for which you want to upload the legacy associations. This dropdown field displays the contract types from the selected Saved Search. For example, select ICMMasterServicesAgreement.

The Association field is displayed to select the associated document contract type for the legacy associations you are uploading in this batch.

This dropdown field displays all Associated Document Contract Types configured under the Association tab for the Contract Type that you have selected in the Contract Type Name field.

Select the Association contract type. For example, ICMStatementOfWork.

Click Next and complete the batch creation for Association following the same process as for creation of agreement batch.

The auto generated workbook will contain the pre-filled details for the selected agreement contract type from the selected saved search as parent agreements.

Creating a batch for Peer Associations

You can upload associated documents as peer associations to agreements using Legacy Upload.

Follow the same process explained in the section above for creating a batch for Associations till the selection of Associated Document Contract Type on the Details tab of the Create Batch page.
Select the Association contract type. For example, ICMMutualNDA.

When you select the peer Associated Document Contract Type in the Association field, the Association field will reflect this relationship for the selected parent Contract Type and Associated Document Contract Type combination.

Note: When the Self-Linkage is enabled for the selected parent contract type, you can select the same contract type to link as peer association in the Association field.

Click Generate Workbook. The workbook is auto generated with the pre-filled details of parent records for the selected contract type from the selected saved search in the “Parent Agreement Name | Agreement Code | SysId” format.

The workbook for peer associations also contains the Linkage Type column with the values as Parent, Child, and Peer. When there is the Linkage Type Masterdata configured in the ICI, the Linkage Type column will reflect the values from that masterdata.

Creating a batch for Peer Associations with Create wizard flow.

You can create associated documents as peer associations to agreements using Legacy Upload.

Follow the same process explained in the section above for creating a batch for Associations till the selection of Associated Document Contract Type on the Details tab of the Create Batch page.
Select the Association contract type. For example, ICMMasterServicesAgreement.

When you select the peer Associated Document Contract Type in the Association field, the Association field will reflect this relationship for the selected parent Contract Type and Associated Document Contract Type combination.

Note: When the Self-Linkage is enabled for the selected parent contract type, you can select the same contract type to link as peer association in the Association field.

Click Generate Workbook. The workbook is auto generated with the pre-filled details of parent records for the selected contract type from the selected saved search in the “Parent Agreement Name | Agreement Code | SysId” format, along with the Peer Association attributes as system would create Peer association like agreement creation and it would get linked to the Parent Agreement.

The workbook for peer associations also contains the Linkage Type column with the values as Parent, Child, and Peer. When there is the Linkage Type Masterdata configured in the ICI, the Linkage Type column will reflect the values from that masterdata.

Creating a batch for Masterdata

You can upload Masterdata with or without Approval Workflow using Legacy Upload.

To create batch for masterdata:

Click User Administration > Admin Task on the Home page. The Admin Task page opens.
Click the Legacy Upload option. The Legacy Upload page opens.
Click the Create Batch icon. The Create Batch page’s Details tab opens.
Select the Legacy Upload Action from the dropdown. For example, Create Masterdata. The fields to select Saved Search and Contract Type name are displayed.
Select the masterdata in the Contract Type Name field. The dropdown will show all masterdata contract types configured in ICI. For example, select ICMSupplierMasterdata.

Click Next and complete the batch creation for Masterdata following the same process as for creation of agreement batch.

Creating a batch for User information

You can provision the users in ICI using the Legacy Upload utility. User information is uploaded independently as it is not related to any other entities.

To create a User Provisioning batch:

Click User Administration > Admin Task on the Home page. The Admin Task page opens.
Click the Legacy Upload option. The Legacy Upload page opens.
Click the Create Batch icon. The Create Batch page’s Details tab opens.
Select the Legacy Upload Action from the dropdown. For example, User Provisioning.

When the Extended User Entity masterdata is configured in the system, the Next button is displayed to select the attributes from the extended masterdata, else the Generate Workbook button is displayed.

Click Next. The Attributes tab opens.

The Available Attribute section displays all attributes from the Extended User Entity masterdata contract type.

Select the attributes for which you want to upload the legacy data in the current batch from the Available Attribute section and add to the Selected Attribute section using the action arrows.
Click Generate Workbook. The workbook template is generated in the MS Excel format and downloaded at the pre-set download location on your system.

Creating a batch for Clauses

You can import bulk clauses into ICI with the help of Legacy Upload Tool. User can migrate their existing clause repository from their previous system with lot of easy, along with it the tool also supports attributes tagging capability. An XML specification document is also released which can be used for creating tags in the input document files of Clauses.

To create Clauses batch:

Click User Administration > Admin Task on the Home page. The Admin Task page opens.
Click the Legacy Upload option. The Legacy Upload page opens.
Click the Create Batch icon. The Create Batch page’s Details tab opens.
Select the Legacy Upload Action from the dropdown. For example, Clauses.

When the Extended Clause Entity masterdata is configured in the system, the Next button is displayed to select the Clause Additional Attributes from the extended masterdata, else the Generate Workbook button is displayed.

Click Next. The Attributes tab opens.

The Available Attribute section displays all attributes from the Extended Clause Entity.

Select the attributes for which you want to upload the legacy data in the current batch from the Available Attribute section and add to the Selected Attribute section using the action arrows.
Click Generate Workbook. The workbook template is generated in the MS Excel format and downloaded at the pre-set download location on your system.

Creating a batch for Template

You can import bulk Templates into ICI with the help of Legacy Upload Tool. User upload relevant templates with capability of Attribute tagging in it. This helps in reducing the implementation duration and achieve faster efficiency. Along with the tool, an XML specification document is also released which can be used for creating tags in the input document files of templates.

To create Templates batch:

Click User Administration > Admin Task on the Home page. The Admin Task page opens.
Click the Legacy Upload option. The Legacy Upload page opens.
Click the Create Batch icon. The Create Batch page’s Details tab opens.
Select the Legacy Upload Action from the dropdown. For example, Template.

When the Extended Template Entity masterdata and template variables are configured in the system, the Next button is displayed to select the Template Additional Attributes from the extended masterdata, else the Generate Workbook button is displayed.

Click Next. The Attributes tab opens.

The Available Attribute section displays all attributes from the Extended Template Entity.

Select the attributes for which you want to upload the legacy data in the current batch from the Available Attribute section and add to the Selected Attribute section using the action arrows.
Click Generate Workbook. The workbook template is generated in the MS Excel format and downloaded at the pre-set download location on your system.

Accessing Legacy Upload Page

The Legacy Upload page displays the details of uploaded batches in a table format. The batch details include Actions, Status, Error details, Batch Passed count, Failed count and so on. User can filter and search legacy upload batch with column filter capability.

You can view the status of the batch by clicking the Refresh button in the top right hand corner to refresh the status of the batch. If you encounter any error while processing the batch, it is highlighted in red color and displayed under the Failed Count column. After the batch is uploaded, click the batch Name to view the history of the processes performed on a particular batch.

To access the Legacy Upload page:

Click the User Administration tile on the Home page. The sub menu tiles dropdown opens.
Click the Admin Task tile. The Admin Task page opens.

Click the Legacy Upload option.

The Legacy Upload page opens.

The page displays the complete statistics for all created and uploaded batches. The page also displays the options to Create Batch and Upload Batch.

Some of the columns on the Legacy Upload page are explained below:

Preparing the workbook with legacy records data

Once the workbook is generated through the Create Batch process, you need to fill the legacy records data in the respective worksheets to prepare the workbook for uploading the batch.

Accessing the Workbook

Click the arrow beside the file in the Download bar to display available actions.
Click Open. The pre-configured workbook for the selected contract type opens.

Alternatively, you can browse and open the downloaded Workbook from the pre-set download location on your system.

Click Enable Editing to allow entering of data in the workbook.

Enter the legacy data in the appropriate worksheets.
Save and close the workbook.

Specifications of a workbook

The Workbook is generated based on the selected contract type.
The name of the workbook is constructed as the ICI name of the selected Contract Type Name amended with the date timestamp.
The mapping sheet is configured automatically and is part of the workbook.
The metadata of the workbook is also auto populated in the Information sheet to avoid any manual efforts.
The column order in workbook sheet is maintained same as the sequence of attributes on the UI to maintain the consistency.
Mandatory fields are highlighted in red.
The lookup fields are provided that display the values from reference entities to avoid wrong data entry errors.
All related worksheets for an entity, such as Team members, Notes, and Commitments, are available in a single workbook.
The attributes necessary for processing are provided as lookup attributes to avoid errors due to manually entering values.

The peer association worksheet also contains the Linkage Type column with the values as Parent, Child and Peer. When there is the Linkage Type Masterdata configured in the ICI, the Linkage Type column will reflect the values from that masterdata.

Preparing the Mapping Sheet

The mapping sheet is a part of the generated workbook. You need to provide below mentioned details required to process the Legacy Upload batch.

Apart from these Batch processing details, you also need to provide the entity details.

Note: Ensure that you enter attribute’s ICI name, spelled exactly as they are present in ICI, in the Mapping sheet and do not mention attribute’s display name. The ICI names are case-sensitive.

The snapshot of the sample mapping sheet for Agreement is:

Preparing the data sheet for ICI entities

The data sheet in the auto generated workbook contains the entity and contract type specific details. Also, the data sheet is named after the selected entity contract type. For example, the data sheet for the Masterdata- ICIStateMaster, is named as same as contract type name which is ICIStateMaster.

Note: The data sheet reflects the attributes as they are present on the UI for creating the respective entity.

Preparing the data sheet for Agreement, Amendment, Associated Documents and Masterdata

The data sheet for Entities- Agreement, Amendment, Associated Documents and Masterdata, contains the attributes you selected from the contract type when creating the batch. These attributes will appear in the data sheet in the order of their selection.

The data sheet for these entities also contain the necessary backend attributes required for processing which may or may not be visible on the UI such as Business Status, Org Unit, Type Of Paper and File Name. The Type Of Paper attribute has the default value as Third Party. The data sheet for Amendment has additional attributes Is Amendment and Use Amendment Template.

The contract type data sheet for Amendment and Peer Association contains prefilled details for the parent agreements of selected contract type from the selected saved search. The details will comprise of pipe delimited values of Parent Agreement Name, Agreement Code and Sysid within a single column, which would help system to easily find parent records in the ICI.

The snapshot of the sample auto generated data sheet for Amendment is:

You can add the legacy records details in the respective columns to prepare the data sheet.

Linkage type support for peer associations

The data sheet for uploading peer associations also contains the Linkage Type column with the values as Parent, Child and Peer. When there is the Linkage Type Masterdata configured in the ICI, the Linkage Type column will reflect the values from that masterdata.

After the successful batch upload for peer associations, the appropriate linkage type relationship is automatically established for the legacy records based on their contract types.

For self-linkage type, the associations will be linked as peer to the agreements of same contract type. For example, the SOW agreement instance will be linked to another instance of SOW with linkage type as peer.
For two-way linkage type, the base agreement and association will be linked as parent and child respectively. For example, when user selects the linkage type as Child while uploading SOW legacy record, the linked MSA record will be automatically updated as parent based on the two-way linkage type configuration.

Adding Team members, Notes, and Commitments

You can also add Team members, Notes, and Commitments if applicable to the legacy record using the same workbook by adding the details in the respective sheets at the same time when uploading the legacy records.

The worksheets for adding the details for Team members, Notes, and Commitments are part of the workbook.

The snapshot of the auto generated Team Members worksheet is:

The snapshot of the auto generated Notes worksheet is:

The snapshot of the auto generated Commitments worksheet is:

Note: Uploading the team, notes or commitments must be done at the first time when uploading the Agreements. Updating these entities later after Agreements are uploaded is not supported.

Preparing the data sheet for User Provisioning, Clauses and Templates

The data sheet for entities User Provisioning, Clauses and Templates reflects all attributes from the selected entity contract type in the same display sequence as they appear on the UI for that entity.

In addition to contact type attributes, the data sheet for these entities also contains the user selected attributes from the respective extended entity masterdata at the time of batch creation.

Here is the snapshot of the auto generated User Information worksheet with the sample legacy record details that is ready for upload:

Here is the snapshot of the auto generated Clauses worksheet with the sample legacy record details that is ready for upload:

Here is the snapshot of the auto generated Templates worksheet with the sample legacy record details that is ready for upload:

Observations and assumptions for clauses batch

The following observations and assumptions need to be taken into consideration while bulk uploading clauses using the Legacy Upload tool:

A Primary Clause and a Linked Primary Clause should not be a part of same batch. The Primary Clause must be created first and then it should be used as a Linked Primary Clause.
A clause with Is Alternate Clause value marked as TRUE and the clause that it is the Alternate of should not be part of same batch.
A clause with Is Dependent Clause value marked as TRUE and the clause which it Depends On should not be part of same batch.
Tags must be on the same line in the template document. Tagging will not function if the tags are on separate lines. For example, if the closing tag </cta> is on the next line, tagging does not work.
There should be no non-breaking spaces (ASCII value xA0) within XML tags. Ensure to replace them with regular spaces in XML tags. Using deactivated clause groups is allowed.
Template Variables cannot be tagged in a clause. If tagged, the template variable will be treated as plain text and no exceptions are triggered.
The user importing templates and clauses must have permissions on the respective tiles, otherwise they will not be able to view them in Icertis Experience for Word.
Only creation of clause is supported. Bulk edits and updating edited clause text in templates where the clause is referred are currently not supported.

Observations and Assumptions for templates batch

The following observations and assumptions need to be taken into consideration while uploading templates using the Legacy Upload tool:

If tagging fails for a part of the batch, only the Passed count gets updated while the Failed count is not updated. However, the failed count can be inferred.
The entire XML should be on the same line. Tagging will not function if the tags are split on separate lines.
There should be no non-breaking spaces (ASCII value is xA0) within XML tags. Ensure to replace them with regular spaces in XML tags.
Primary and alternate templates cannot be a part of same batch.
Threading causes some issues. Further, if there has been any error in tagging, it is not possible to rollback or delete instances created using batch upload.
Ensure each template is given a unique name. If two templates are uploaded with the same name, then one of the entries fails. However, the Error file does not show any corresponding error message.

Mandatory tags for clause document

The mandatory attributes tags are available in the Xml format for tagging inside clauses and templates.

Below table provides the details for xml tags:

To further understand tag properties, refer the below table:

Uploading the batch

Click the Upload Batch icon on the Legacy Upload page. The Upload Batch window opens.

Enter the Batch Name for the current batch to refer to it later. For example, MSA Batch.
Select the Contract Type Name. For example, ICMMSA. The dropdown field will show all configured contract types in ICI.
Click Choose File button to browse and select a file in the File Path field. For example, ICMMSA_20210524044518.xlsx.

Note:
System validates the data upon file selection. The errors found, if any, will be highlighted so that the user can make corrections.
You can only upload Excel files, the Create button will be enabled only when you upload the correct file format.

Select the Defer Workflow check box so that the workflow is not attached to the agreements while uploading. This check box controls the attachment of approval workflow to a particular batch.

Note: Do not select the check box for Defer Workflow while creating the batch for an entity with enabled approval workflow.

Click Create. The batch will be added to the queue for processing and the status will move to Schedule on the successful validation of the file.

If there are any errors encountered during validation, the batch will be created in the Draft state.

Note:
The data will be picked up for processing when the task service runs on the backend every day. When the task is triggered, the status updates to Processing.
The Task can be configured as per customer requirements from the ICM Tools. The data records in a batch are processed and uploaded based on the State they are in.

Uploading Agreements with mandatory Associations

In case of mandatory associations for agreements, you can first upload the agreements batch with the deferred workflow by selecting the checkbox for Defer Workflow on the Upload Batch window. After the successful processing of agreements batch, the Status of the batch will move to Completed, WF Deferred, indicating that the agreement will not follow the workflow automatically.
Once the Agreements are successfully uploaded in the ICI with the deferred workflow, upload the mandatory Associations following the steps:

</ol>

i. Search or create the contract type for Associations you want to upload.

ii. Create a batch for Associations.

iii. Prepare the workbook by entering the legacy records data.

iv. Upload the batch with the attached Workflow.

Once the mandatory associations are successfully uploaded in the ICI, you can click on the Resume WF icon available beside the agreement batch which is in Completed, WF Deferred status and complete the processing for agreements.

After the successful processing, the agreements batch status moves to Workflow Processed with the attached workflow.

Uploading Peer association with the create Wizard flow along with Linkage Type.

In case of Peer associations for with create wizard flow, you can first upload the association batch with all the details input in the workbook on the Upload Batch window. System would process the Association by creating the instance on the ICI Application, the status of the batch would show as Workflow Processed.
Once the Peer Association are successfully uploaded in the ICI the system would automatically process with linking with its Parent agreement with linkage type defined in the workbook. Once the batch is processed the status of the batch would show as Completed.

Uploading clauses and template batch

To upload the batch for clauses and templates, follow the same process as for uploading batch for other entities.

The ICI will auto initiate the tagging of attributes in clauses and templates upon the batch creation to avoid the manual efforts.

Status changes for the processed batch

The entities which support uploading with or without attached approval workflow, are processed based on their approval workflow configuration by following the deferred workflow steps. The status of the batch processing for such entities goes form Completed, WF Differed to Workflow processed.

For entities that do not need approval workflow, the batch status will move to Completed on successful processing.

Viewing the batch Activity Log

To access the processing logs for a specific batch:

Click the batch name on the Legacy Upload page to view the activity log of a particular batch. The activity log shows the operations performed while processing the batch and also displays the errors if any in Red color.
Click on the error message highlighted in Red to expand and view the details of the encountered error.

Click Download icon beside the error in Red to download all the details of the specific record with the errors or warnings.

Checking Integration Files

You can check the errors and warnings encountered during processing for failed records for the processed batch after the batch or workflow processing is complete.

To download integration files:

Click the Download Integration Files icon corresponding to the processed Batch that you want to review, on the Legacy Upload page. For example, May MSA Batch.

The Download Integration Files window opens offering below file options to download:

Status File and Error File for batches in Completed status
WF Status File and WF Error File for batches in Workflow Processed status

Select WF Error File. The error file is downloaded in the Excel format. The file contains the details about Errors and Warnings encountered while processing for the failed records along with the details of each failed record in each of the data worksheet in the uploaded workbook.

Select WF Status File to view the workflow processing status for all records in the batch file. The Excel file is downloaded on the pre-set download location on your system.

Re-uploading of a batch

You can correct the errors in the data file and re-upload the batch a specific batch which is in the draft state from the Legacy Upload page itself.

To upload the batch in draft for processing

Open the downloaded Integration file. It contains details on Integration Status, Validation Status, Errors, Warnings, Contract Type Name, Name (of the uploaded file), and so on.
Check the message in the Errors column and correct that record accordingly in the batch workbook that you uploaded before, by referring to the entity code provided in the integration file.
Click the Upload Integration Files icon beside the batch in Draft state for which you want to upload the workbook. The Upload Batch window opens.

The Batch Name, Contract Type Name andDefer Workflow will be pre-selected with respect to the batch you are uploading.

Click Choose File to browse and select the revised workbook from its location on your system.
Click Upload. The batch will be added to the queue for processing.

Note: The data will be picked up for processing when the task service runs on the backend every day. When the task is triggered, the status updates to Processing. After the processing is complete, the status changes to Completed. The Task can be configured as per customer requirements from the ICM Tools.

Accessing Integrated batches report

You can view the consolidated status report for all the batches run for the current date. To access the report, click the Download Report icon on the Legacy Upload page.

The consolidated report will be downloaded on the pre-set default download location on your system.

The report contains the following details for the batches run on the particular date:

Accessing Notifications

The user will get the notification on the batch initiation and completion informing the processing status of records by the Legacy Upload tool as success or failure. The notification template for the Legacy Upload Notification can be configured as per the requirements.

To access Legacy Upload Notification:

Click Notifications on the Home page. The Notification Dashboard opens.
Select Legacy Upload Notification Category. The respective notifications under the events for Legacy Upload Batch Initiation and Legacy Upload Batch Completion are displayed.
Select the notification to view. The notification details are displayed in the right pane.

Accessing the uploaded entities in the ICI

After you upload the legacy records into the ICI, you can view and access the records on the entity’s respective pages and tabs.

You can view uploaded legacy Agreements from the Agreements index page. Click Agreement Management > Agreements to open the Agreement index page.
Click the View Record icon beside the agreement to open its Details page. If you have added any Notes, Team, or Commitments, they will be displayed under the respective tabs in the left navigation pane.
After the Amendments are successfully uploaded, you can view them under the Amendments tab in the previously uploaded parent Agreement.
After the Associations are successfully uploaded, you can view them under the Associations tab in the previously uploaded Agreement. You can also access Associations from the Association Management > Associations on the Home page.

When an Association uploaded without workflow is viewed in ICI, it will not have any buttons visible on the UI.

You can view uploaded legacy masterdata records on the Masterdata index page. Click Configuration > Masterdata on the Home page to open the Masterdata index page.
You can view the user information it under the Users tab in User Administration.
You can view uploaded legacy Templates on the Templates index page. Click Template Management > Templates on the Home page to open the Template index page.
You can view uploaded legacy Clauses on the Clauses index page. Click Clause Management > Clauses on the Home page to open the Clause index page.

@@ Line 2: / Line 2: @@
 = Legacy Upload&nbsp; =
-Organizations may have a large number of existing Agreements that are created outside of ICM platform. These are henceforth referred to as Legacy Agreements.&nbsp;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.
+&nbsp;
-The highlights of this feature are&nbsp;:&nbsp;
+Organizations may have a large number of existing Agreements that are created outside of ICI platform. These are henceforth referred to as Legacy Agreements.&nbsp;Organizations may want to import these Agreements to ICI to leverage its vast capabilities and manage all Agreements within a single platform.
-*Uploading Agreements, Teams, Notes and Commitments in bulk.
+ICI Legacy Upload tool helps in migrating these large volumes of legacy Contracts from the Customer system to ICI Application with accuracy and efficiency which helps in creating a central repository. This in turn helps in a shift from Paper base to digitalization.
-*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.&nbsp;
-*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:&nbsp;
+The highlights of the ICI Legacy Upload Tool are:
+<ul style="margin-left: 40px;">
+<li>Uploading entities such as Agreements and their respective Teams, Notes, and Commitments in bulk.</li>
+<li>Uploading Associations, Masterdata, User Information and Amendments in bulk.</li>
+<li>Bulk Clause and Template creation, with the power of Attribute/metadata tagging.</li>
+<li>Enhanced validations, including the ability to exclude the specified attributes from being validated.</li>
+<li>Ability to view logs and report of success and failure statuses on legacy UI.</li>
+<li>Record level email notification trigger capability as per customer requirement.</li>
+<li>Reporting capabilities on the uploaded legacy records.</li>
+<li>Email Notifications for batch initiation and completion.</li>
+<li>Support of Peer Association & Linkage types, ensuring no manual work post legacy upload.</li>
+<li>Enabling legacy upload of Agreements with Status as Expired, Terminated.</li>
+<li>Support uploading of files from Sub folder from Task server and blob storage repository.</li>
+</ul>
-*Agreements&nbsp;
+&nbsp;
-*Amendments
-*Associated Documents (with or without workflow)
-*Masterdata (with or without workflow)
-*Team, Notes, and Commitment
-*User details
 == Important Considerations&nbsp; ==
+<ul style="margin-left: 40px;">
+<li>Only an Administrator can perform a Legacy Upload of the entities.&nbsp;</li>
+<li>The absolute path where the Agreements and other entities documents are saved must be accessible by the task service of the ICI instance. This must be ensured while configuring the ICI instance.&nbsp;</li>
+<li>The Data files created in Excel can only have .xlsx extension.&nbsp;</li>
+<li>For Agreements, only .pdf files are supported. For Associations, several file formats such as .pdf, .docx, .doc, .xlsx, .jpeg, .png and .zip are supported.&nbsp;</li>
+<li>Contract&nbsp;types for the Agreements and other entities that you are trying to upload must be present in Published state in ICI.</li>
+<li>To upload any Associations, ensure that the relevant contract type has been added in the Associations tab in the parent contract type.</li>
+<li>An attribute which will always have unique value must be present in ICI so that the relevant value can be used as a Primary Key to map other entities with that Agreement. If such an attribute does not already exist, you must create it. The unique value attribute can be a backend attribute which may not be visible on the UI. However, Agreement Code attribute, though unique, contains a system-generated value that is generated only after an Agreement has been created thus, cannot be used as a Primary Key for the contract type.</li>
+<li>When adding batches for uploading, it is advisable not to schedule too many batches at close intervals and configure schedules to line-up batches to be uploaded at different times to optimize the processing speed.</li>
+<li>Since this is only a provisioning tool, as such any sort of updates to uploaded records are not supported.</li>
+</ul>
-*Only an Administrator can perform Legacy Upload of the entities.&nbsp;
+&nbsp;
-*The absolute path where the Agreements and other entities documents are saved must be accessible by the task service of the ICM instance. This must be ensured while configuring the ICM instance.&nbsp;
-*The mapping and data files created in Excel can only have an .xlsx extension.&nbsp;
-*For Agreements, only PDF files are supported. For Associations, several file formats such as Pdf, docx, doc, xls, jpeg, png, zip are supported.&nbsp;
-*Contract&nbsp;Types for the Agreements and other entities that you are trying to upload must be present in Published state in ICM.
-*To upload any Associations, ensure that the relevant Contract Type has been added in the Associations tab in the parent Contract Type.
-*An attribute which will always have unique value must be present in ICM so that the relevant value can be used as a Primary Key to map other entities with that Agreement. If such an attribute does not already exist, you must create it. The unique value attribute can be a backend attribute which may not be visible on the UI. Also, Agreement Code attribute which contains a system-generated value only after an Agreement has been created, cannot be used as a Primary Key for the Contract Type.
-*When adding batches for uploading, it is advisable not to schedule too many batches at close intervals and configure schedules to line-up batches to be uploaded at different times to optimize the processing speed.
-*Since this is a provisioning tool, any sort of updates to uploaded records are not supported.
-== Uploading Agreements&nbsp; ==
+== Uploading entities using Legacy Upload ==
-This section demonstrates with an example how to upload plain Agreements for a particular Contract Type.
+You can use the utility to upload the following entities:&nbsp;
+<ul style="margin-left: 40px;">
+<li>Agreements&nbsp;with Team, Notes, and Commitment</li>
+<li>Amendments with Team, Notes, and Commitment</li>
+<li>Associated Documents (with or without workflow)</li>
+<li>Masterdata (with or without workflow)</li>
+<li>User Information (with or without Extended Attributes)</li>
+<li>Clauses (with or without Extended Attributes)</li>
+<li>Templates (with or without Extended Attributes)</li>
+</ul>
-=== Searching or Creating&nbsp;a Contract Type for the Agreements with Workflow&nbsp; ===
+The Legacy Upload tool follows a simple workflow to upload the aforementioned entities.
-Identify an existing Contract Type in ICM for which to upload the Agreements. If that Contract Type does not exist, you need to create it using ''Create Contract Type'' on ''Configuration'' page in ICM. If the ''Enable Approval Workflow'' flag is set to ''Yes'', it means that the workflow is enabled for that Contract Type.
+The workflow for Legacy Upload process at a glance:
+<div class="image-green-border">[[File:7.16 Legacy 1.png|720px|7.16 Legacy 1.png]]</div>
+&nbsp;
-. Create a Contract Type named as ''Legacy Contract''&nbsp;with the attributes as can be seen under the ''Selected Attribute'' tab in the screenshot. The ICM name for this Contract Type is ''ICMLegacyContract''.Create a ''Legacy Ref Id'' attribute which will be used as a Primary Key in the metadata file for this Contract Type.
+=== Creating a contract type entity for Legacy Upload ===
-<div class="image-green-border">[[File:CreateContractType LegacyUpload C7SP6.png|LegacyUpload_CreateContractType.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:LegacyUpload Create Attribute.png|LegacyUpload Create Attribute.png]]</div>
-. Copy the Agreement PDF at the location accessible by the task server.
-=== Creating a&nbsp;Metadata File for Agreements&nbsp; ===
+To upload legacy records in ICI, there must be a relevant contract type configured in the ICI as per the specific entity type need of legacy records.
-Important things to note for the metadata file:&nbsp;
+If the contract type does not exist in ICI, you must create the contract type for the entity of legacy records. You must configure the details of legacy records as the attributes in ICI contract type.
-*The metadata file must contain the display names of the attributes spelled exactly as they are present in ICM. The display names are case-sensitive.&nbsp;
+==== Configuring contract type with or without approval workflow ====
-*It is not necessary to include all the ICM attributes in the metadata file. However, the following attributes and their values must be provided in the data file- ''Name, File Path, Business Status,&nbsp;''and&nbsp;''Type of Paper.&nbsp;''Some of these may be backend attributes that are not visible on the UI.&nbsp;
-'''To create a&nbsp;metadata file for ICMLegacyContract Contract Type:'''
+You can upload entities such as associations, masterdata with or without approval workflow using the Legacy Upload tool.
-.&nbsp;&nbsp;Create an Excel file with .''xlsx'' extension and save it with the appropriate name, for example ''ICMLegacy_Contract_single .''
+You can automatically attach the approval workflow to an entity while processing the legacy upload batch. All you have to do is enable the approval workflow in the contract type by setting the ''Enable Approval Workflow'' attribute value to ''Yes''.
-.&nbsp;&nbsp;Edit the same file to create columns that are essentially the ICM attributes for ICMLegacyContract Contract Type, and enter their values for the legacy Agreement that you want to upload. To ensure that you use the attributes correctly, switch to ICM and navigate to Configurations and then to&nbsp;Contract Types, and '''Click''' ''View Record'' to view the details of ICMLegacyContract. Then go to Attributes tab to see all the Selected Attributes for that CT.
+For entities that have the ''Enable Approval Workflow'' attribute value set to ''No'' in their contract type, the approval workflow will not follow automatically. You can enable the workflow manually, whenever needed, by clicking the ''Resume WF'' icon.
-.&nbsp;In the metadata file the first row is a header row wherein you need to provide the exact Display Names of all or the desired attributes from ICM in consecutive columns.&nbsp;
+When an entity that has been uploaded without workflow is viewed in ICI, it will not have any buttons visible on the UI.
-The following screenshots are&nbsp;of the same metadata file&nbsp;ICMLegacy_Contract_single, broken down into 2 images to capture all the columns:
+To create a contract type:
-<div class="image-green-border">[[File:SP6 LegacyUpload Metadata 1.png|950px|LegacyUpload Metadata 1.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SP6 LegacyUpload Metadata 2.png|LegacyUpload Metadata 2.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">The following section describes the column names (ICM attributes) and their values provided in the data file:</div>
-*'''Name''':&nbsp;String data type, provide name of the Agreement. For example, Acme Corp Legacy Contract.
-*'''File Path''':&nbsp;FileSelection data type, provide exact file name of the document that you copied to the accessible location after creating the Contract Type, append the file name with .PDF. For example, test.pdf.&nbsp;
-*'''Legacy Ref Id''':&nbsp;String data type, user-defined value, must be unique, used as a Primary Key that you created while creating the Contract Type ''ICMLegacyContract.''
-*'''Contract Value''':&nbsp;Currency data type, value of the contract in USD for this example, accepts value up to 2 decimals as configured for the data type. For example, 1000.&nbsp;
-*'''Effective Date''':Date data type in MM/DD/YY, format depends upon how it is configured for the ICM instance, invalid format will not be accepted while uploading the metadata file. For example, 3/9/2018.&nbsp;
-*'''Signature Type''':&nbsp;Choice data type, another choice for this example is Electronic Signature. For example, Manual Signature.&nbsp;
-*'''External Signatory''':&nbsp;Email data type, enter valid email ID with FQDN only. For example,clmadmin@gmail.com.&nbsp;
-*'''Item List''':&nbsp;MultiSelectChoice data type, provide list of multiple values separated by ‘|’ without any spaces. For example, Item1|Item2|Item3.
-*'''LegacyDate''':Date data type in MM/DD/YY, format depends upon how it is configured for the ICM instance, invalid format will not be accepted while uploading the metadata file. For example,&nbsp;5/9/2018.&nbsp;
-*'''Primary Owner Email'''&nbsp;:&nbsp;Email data type, enter valid email ID with FQDN only. For example,&nbsp;acmeadmin@acmecorp.com.&nbsp;
-*'''CompanyUrl''':&nbsp;URL data type, enter a valid URL exactly in the same format as shown. For example,&nbsp;<a target="_blank"href="[http://acmecorp.com/ http://acmecorp.com/]">[http://acmecorp.com http://acmecorp.com]</a>.&nbsp;
-*'''Country Name'''&nbsp;:Lookup field, case-sensitive, enter the exact value. For example, USA.&nbsp;
-*'''Is Amendment''':&nbsp;Boolean data type, values Yes/No. For example, No.&nbsp;
-*'''Is Assigned''':&nbsp;Boolean data type, values Yes/No. For example, No.&nbsp;
-*'''Is Assignment''':&nbsp;Boolean data type, values Yes/No. For example, No.&nbsp;
-*'''Is Termination''':&nbsp;Boolean data type, values Yes/No. For example, No.&nbsp;
-*'''Type of Paper''':&nbsp;Not visible on UI, value must always be Third Party, case-sensitive. For example, Third Party.
-*'''Business Status''':&nbsp;Not visible on UI, value can optionally be Executed, case-sensitive.&nbsp;For example, Draft.&nbsp;
-== Uploading Agreements with Team, Notes and Commitments ==
+#'''Click '''''Configuration'' > ''Create Contract Type'' on the ''Home'' page. The ''Create Contract Type'' page opens.
+#'''Select''' the ''Contract Type'' of the entity for which you want to upload legacy records. For example, ''AGREEMENT'' Contract Type.
+#'''Click''' ''Next''. The ''Details'' tab opens.
+#'''Enter''' the ''Contract Type Name'' and other required details.
+#'''Toggle''' the ''Enable Approval Workflow''&nbsp;to ''Yes'' if you want to enable the workflow for approval for this contract type with the creation.
+<div class="image-green-border">[[File:7.16 Legacy 2.png|720px|7.16 Legacy 2.png]]</div> <ol start="6">
+<li>'''Click''' ''Next''. The ''Attributes'' tab opens.</li>
+<li>'''Select''' and '''add''' the ''Attributes'' which are required for the legacy records you are uploading, to map them to the ICI Contract Type.</li>
+</ol>
+<div class="image-green-border">[[File:7.16 Legacy 3.png|720px|7.16 Legacy 3.png]]</div> <ol start="8">
+<li>'''Click''' ''Next'' and enter the details on the ''Associations'', ''Display'' ''Preference'' and ''Team'' tabs to complete the contract type creation following the standard ICI workflow.</li>
+</ol>
-You can add Team members, Notes, and Commitments along with the legacy Agreements from within the same metadata file.
+Refer the [[Create_a_Contract_Type|Creating a Contract Type]]&nbsp;for further details on how to configure contract types.
-<div class="note-box">'''Note''': Uploading the team, notes or commitments must be done at the first time when uploading the Agreements. Updating these entities later after Agreements are uploaded is not supported.</div>
+<div class="note-box">'''Note:''' You do not need to create a contract type for amendments as the required contract type is already available when the parent agreement records were created.</div>
-=== Creating a&nbsp;Metadata File with Team, Notes, and Commitments&nbsp; ===
+&nbsp;
-Edit the same Agreements metadata file ICMLegacy_Contract_single to add more sheets for Team, Notes, and Commitments.
+==== Configuring contract type with mandatory Associations ====
-<div class="note-box">'''Note''': The sheets always must be named and formatted (irrespective of the client instance environment) as specified in the respective steps below.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SP6 LegacyUpload CreateMetadata.png|LegacyUpload CreateMetadata.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">'''To create the Team metadata:'''</div>
-#Add a sheet and name it as&nbsp;''AgreementTeamMember''.&nbsp;
-#Edit the sheet to create columns as below and provide their values as appropriate:
-<div class="image-green-border">[[File:SP6 LegacyUpload Create Team Metadata.PNG|LegacyUpload Create Team Metadata.PNG]]</div>
-The following screenshot of the ''ICMLegacy_Contract_single'' shows the Team sheet and the columns.
-<div class="image-green-border">[[File:SP6 LegacyUpload Create Team Metadata 1.PNG|LegacyUpload_Create_Team_Metadata]]</div>
-'''To create the Notes metadata:'''
-. Add a sheet and name it as&nbsp;''AgreementNote.''
+There may be cases where any associated documents are required before an Agreement can move to the&nbsp;Executed, Expired or Terminated&nbsp;state. In that case, you can defer the workflow for the Agreement while uploading, then upload the required Association with workflow attached, and then enable the workflow for the Agreement when needed.<br/> Whether an Association is mandatory or not can be seen in ICI in the following 2 ways:<br/> If&nbsp;''Is Mandatory&nbsp;''flag is set to&nbsp;''Yes''&nbsp;while adding an Association for a particular Agreement Contract Type then the&nbsp;Association is mandatory.&nbsp;
+<div class="image-green-border">[[File:7.16 Legacy Upload.png|720px|7.16 Legacy Upload.png]]</div>
+If ''Prerequisite'' or ''Post requisite'' is selected in the ''Constraint&nbsp;''drop-down list while creating an Associated Document Contract Type then the&nbsp;Association is mandatory.
+<div class="image-green-border">[[File:7.16 Legacy 5.png|720px|7.16 Legacy 5.png]]</div> <div class="image-green-border">&nbsp;</div>
+== Creating a batch for an entity ==
-''2. Edit the sheet to create columns as below and provide their values as appropriate:''
+Once the relevant contract type is present in the ICI, you can create a new batch to upload the legacy records in the ICI from the Legacy Upload page.
-The following screenshot of the ''ICMLegacy_Contract_single'' shows the Note sheet and the columns.
+=== Creating a batch for agreements ===
-<div class="image-green-border">[[File:SP6 LegacyUpload Create Note Metadata2.PNG|LegacyUpload Create Note Metadata2.PNG]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">'''To create the Commitments metadata:'''</div>
-. Add a sheet and name it as&nbsp;''AgreementCommitment''.
-. Edit the sheet to create columns as below and provide their values as appropriate:&nbsp;
+#'''Click'''&nbsp;the&nbsp;''User Administration''&nbsp;tile on the ''Home'' page.&nbsp; The sub menu tiles dropdown opens.
-<div class="image-green-border">[[File:SP6 LegacyUpload Create Commitments Metadata 1.PNG|LegacyUpload Create Commitments Metadata 1.PNG]]</div>
+#'''Click'''&nbsp;the&nbsp;''Admin ''Task&nbsp;tile.&nbsp;The ''Admin'' ''Task'' page opens.
-. Create an additional column named Parent_FK and provide the value of the Primary Key (Legacy Ref Id) of the parent Agreement.&nbsp;
+<div class="image-green-border">[[File:7.16 Legacy 6.png|720px|7.16 Legacy 6.png]]</div> <ol start="3">
+<li>'''Click''' the ''Legacy Upload'' option. The ''Legacy Upload'' page opens.</li>
+</ol>
+<div class="image-green-border">[[File:7.16 Legacy 7.png|720px|7.16 Legacy 7.png]]</div> <ol start="4">
+<li>'''Click''' the ''Create Batch'' icon. The ''Create Batch'' page’s ''Details'' tab opens.</li>
+</ol>
+<div class="image-green-border">[[File:7.16 Legacy 8.png|720px|7.16 Legacy 8.png]]</div> <ol start="5">
+<li>'''Identify''' the entity for legacy records and select the ''Legacy Upload'' ''Action'' accordingly from the dropdown. For example, select ''Create Agreement ''when you are creating a batch of agreements.</li>
+</ol>
+<div class="image-green-border">[[File:7.16 Legacy 9.png|720px|7.16 Legacy 9.png]]</div> <ol start="6">
+<li>'''Select''' the ''Contract Type Name''. The dropdown will show all agreement contract types configured in ICI. For example, ''ICMMSA''.</li>
+</ol>
+<div class="image-green-border">[[File:7.16 Legacy 10.png|720px|7.16 Legacy 10.png]]</div> <ol start="7">
+<li>'''Click''' ''Next''. The ''Attributes'' tab opens. The ''Available Attribute'' section shows all attributes from the selected agreement contract type in the left column. The mandatory attributes like ''Name'' is already populated in the ''Selected Attribute'' list.</li>
+<li>'''Select''' the attributes for which you want to upload the legacy data in the current batch from the ''Available Attribute'' section and add to the ''Selected Attribute'' section using the action arrows. For example, select attributes ''Name,'' ''Contract Description'' and ''Effective'' ''Date''.</li>
+</ol>
+<div class="image-green-border">[[File:7.16 Legacy 11.png|720px|7.16 Legacy 11.png]]</div> <div class="note-box">'''Note:''' ''Mandatory'' and ''Dependent'' attributes will be automatically included in the generated workbook.</div> <ol start="9">
+<li>'''Click''' ''Generate Workbook''. The workbook template is generated in the MS Excel format and downloaded at the pre-set download location on your system.</li>
+</ol>
-The following screenshot of&nbsp;the ''ICMLegacy_Contract_single'' shows the Commitment sheet and the data.
+&nbsp;
-<div class="image-green-border">[[File:SP6 LegacyUpload Create Commitments Metadata 2.PNG|950px|LegacyUpload Create Commitments Metadata 2.PNG]]</div> <div class="image-green-border">&nbsp;</div>
-=== Creating a&nbsp;Mapping File ===
-Important things to note for the mapping file:
+=== Creating a batch for Amendments ===
-*Mapping file must contain the ICM names (not display names) of the attributes spelled exactly as they are present in ICM. The ICM names are case-sensitive.
+The agreement contract type for uploading Amendments is already available in the ICI when the parent agreements were created or unloaded. You can create a set of agreements that you want to upload amendments to, using the Saved Search capability.
-*You can bypass validations for mandatory attributes in the mapping file by providing their ICM names in the Exclude Mandatory Validations column. However, it cannot skip generic validations for data types.
-'''To create a mapping file:&nbsp;'''
+To create an amendment batch:
-.Create an Excel file with .xlsx extension and save it with the name, ''Mappings_Acme_agreements.''
+#'''Click'''&nbsp;''User Administration''&nbsp;> ''Admin Task''&nbsp;on the ''Home'' page.&nbsp;The ''Admin Task'' page opens.
+#'''Click''' the ''Legacy Upload'' option. The ''Legacy Upload'' page opens.
+#'''Click''' the ''Create Batch'' icon. The ''Create Batch'' page’s ''Details'' tab opens.
+#'''Select''' the ''Legacy Upload Action'' from the dropdown. For example, ''Create Amendment''. The fields to select Saved Search and Contract Type name are displayed.
+#'''Select''' a ''Saved Search''. For example, ''All Executed Agreements''.
-''2.Edit the file to create columns and provide their details/values as specified below:''
+You must create a saved search beforehand to group the agreement records to which you want to add the amendments through Legacy Upload. For example, here, configure the Saved Search for all Executed Agreements. The system would ignore all statuses other than Executed.
-<div class="image-green-border">[[File:SP6 LegacyUpload CreateMappingFile1.PNG|LegacyUpload CreateMappingFile1.PNG]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">''Mappings_Acme_agreements'' file created for ''ICMLegacyContract'' Contract Type.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SP6 LegacyUpload Create MappingFile 2.png|LegacyUpload Create MappingFile 2.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">In the above example,&nbsp;</div>
+<ol start="6">
-*''C:\Integration'' is the UNCFolderpath where you uploaded the legacy agreement PDF.
+<li>'''Select''' the ''Contract Type Name''. The dropdown will show all agreement contract types from the selected Saved Search. For example, select ''ICMMSA''.</li>
-*''ICMLegacyContract'' is the Contract Type Name.
+</ol>
-*''ICMLegacyRefId'' under the ''Primary Key'' column is the unique attribute that you created in for ''ICMLegacyContract'' Contract Type.
+<div class="image-green-border">[[File:7.16 Legacy 12.png|720px|7.16 Legacy 12.png]]</div> <ol start="7">
+<li>'''Click''' ''Next'' and complete the batch creation for Amendments following the same process as for the creation of the agreement batch.</li>
+</ol>
-=== Uploading the Legacy Agreements ===
+&nbsp;
-Now that the metadata and mapping files are created for ''ICMLegacyContract'' Contract Type, the relevant Agreements can be uploaded using the Legacy Upload feature on the ICM UI.
+=== Creating a batch for Associations ===
-'''To upload the Legacy Agreements''':&nbsp;
+Before you proceed to upload Associations using the Legacy Upload, ensure that the parent Agreements are already uploaded. Also ensure that the&nbsp;Associated Document Contract Type has been added in the Associations tab in the parent Agreement Contract Type.
-.'''Click&nbsp;'''the&nbsp;''User Administration&nbsp;''tile on the Dashboard.&nbsp;
+You can upload Associations with or without Approval Workflow using Legacy Upload in the ICI.
-.'''Click&nbsp;'''the&nbsp;''Admin Task&nbsp;''tile.&nbsp;
+Associations can be mapped with their parent agreements using a Saved Search capability. A set of agreements can be created for which you want to upload peer associations by configuring a Saved Search beforehand. The auto-generated workbook will contain the agreements details from the selected saved search as the parent agreements. These details would help users to find the records in the ICI and map them with the Association agreement code in the workbook.
-.&nbsp;'''Click&nbsp;'''''Legacy Upload.''
+To create an Association batch:
-<div class="image-green-border">''[[File:SP6 LegacyUpload.png|LegacyUpload.png]]''</div>
-.&nbsp;'''Click '''''Add Batch&nbsp;''and provide details of the batch on the next screen that opens.&nbsp;
-<div class="image-green-border">[[File:SP6 LegacyUpload AddBatch.png|LegacyUpload AddBatch.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SP6 LegacyUpload AddBatch 1.png|LegacyUpload AddBatch 1.png]]</div>
-*'''Batch/API Name''':&nbsp;Provide unique name for the Batch as ''AcmeCorp_legacy_agreements .''
-*'''Integration Type''': '''Select&nbsp;'''''Legacy Contract Management.&nbsp;''
-*'''Contract Type Name''':&nbsp;'''Select&nbsp;'''the Contract Type as&nbsp;''ICMLegacyContract.&nbsp;''
-*'''Use mapping from''': '''Select&nbsp;'''''None&nbsp;''since you are uploading a new mapping file.&nbsp;
-*Optionally, '''select '''from the list if using mappings from any previously uploaded batch for&nbsp;''ICMLegacyContract ''Contract Type.&nbsp;
-*'''Defer Workflow''': Leave this checkbox unselected for the current example.&nbsp;
-'''Select&nbsp;'''''Defer Workflow&nbsp;''checkbox only if you need to add any pre-requisite Associations for the Legacy Agreement. See uploading Agreements with mandatory Associations.&nbsp;
+#'''Click'''&nbsp;''User Administration''&nbsp;> ''Admin Task''&nbsp;on the ''Home'' page.&nbsp;The ''Admin Task'' page opens.
+#'''Click''' the ''Legacy Upload'' option. The ''Legacy Upload'' page opens.
+#'''Click''' the ''Create Batch'' icon. The ''Create Batch'' page’s ''Details'' tab opens.
+#'''Select''' the ''Legacy Upload Action'' from the dropdown. For example, ''Create Association''. The fields to select a Saved Search and parent Contract Type are displayed.
+#'''Select''' a ''Saved Search'' to pick a set of parent agreements. For example, ''All MSA Draft Status''.
+#'''Select''' the ''Contract Type Name'' for which you want to upload the legacy associations. This dropdown field displays the contract types from the selected Saved Search. For example, select ''ICMMasterServicesAgreement''.
-*A row with your newly created batch will be added to the list with ''Draft'' status.
+The ''Association'' field is displayed to select the associated document contract type for the legacy associations you are uploading in this batch.
-<div class="image-green-border">[[File:SP6 LegacyUpload Batch Upload.png|LegacyUpload Batch Upload.png]]</div>
-.&nbsp;'''Click&nbsp;'''''Upload Integration Files&nbsp;''icon and provide the details of the mapping file on the next screen that opens.&nbsp;
-<div class="image-green-border">[[File:SP6 LegacyUpload UploadIntegrationFiles.png|LegacyUpload UploadIntegrationFiles.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SP6 LegacyUpload UploadIntegrationFiles 1.png|LegacyUpload UploadIntegrationFiles 1.png]]</div>
-*'''File Type''':&nbsp;'''Select&nbsp;'''''MappingFile&nbsp;''option from the drop-down.&nbsp;
-*'''File Path''':&nbsp;'''Click&nbsp;'''''Choose File&nbsp;''to browse and select the mappings file&nbsp;''Mappings_Acme_agreements'' that was created earlier.&nbsp;
-.&nbsp;'''Click&nbsp;'''''Upload&nbsp;''to upload the mapping file.&nbsp;
+This dropdown field displays all Associated Document Contract Types configured under the ''Association'' tab for the Contract Type that you have selected in the ''Contract Type Name'' field.
+<ol start="7">
+<li>'''Select''' the ''Association'' contract type. For example, ''ICMStatementOfWork''.</li>
+</ol>
+<div class="image-green-border">[[File:7.16 Legacy 13.png|720px|7.16 Legacy 13.png]]</div> <ol start="8">
+<li>'''Click''' ''Next'' and complete the batch creation for Association following the same process as for creation of agreement batch.</li>
+</ol>
-. After the mapping file is uploaded successfully, '''click''' ''Upload Integration Files'' icon again to upload the metadata file. '''Select''' ''DataFile'' option to browse and upload the batch file saved locally, and '''click''' ''Upload''.
+The auto generated workbook will contain the pre-filled details for the selected agreement contract type from the selected saved search as parent agreements.
-<div class="image-green-border">[[File:SP6 LegacyUpload UploadIntegrationFiles.png|LegacyUpload UploadIntegrationFiles.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SP6 LegacyUpload UploadIntegrationFiles 2.png|LegacyUpload UploadIntegrationFiles 2.png]]</div>
-*'''File Type''':&nbsp;'''Select&nbsp;'''''DataFile&nbsp;''option from the drop-down.&nbsp;
-*'''File Path''':&nbsp;'''Click&nbsp;'''''Choose File&nbsp;''to browse and select the metadata file&nbsp;''ICMLegacy_Contract_single'' that was created earlier.
-.&nbsp;'''Click''' ''Upload'' to upload the metadata file.
+&nbsp;
-. After the metadata file is successfully uploaded, '''click''' ''New Validate and Initiate'' icon to validate the data and initiate the batch upload.
+==== Creating a batch for Peer Associations ====
-<div class="image-green-border">[[File:SP6 LegacyUpload NewValidateand Initiate.png|LegacyUpload NewValidateand Initiate.png]]</div> <div class="image-green-border">&nbsp;</div>
-A&nbsp;window opens showing the status of validation, and count or summary of errors or warnings, if any.
-<div class="image-green-border">[[File:SP6 LegacyUpload ScheduleBatch.png|LegacyUpload ScheduleBatch.png]]</div>
-The message in the above screen is interpreted as one agreement record is successfully validated for ''ICMLegacyContract'' Contract Type.<br/> You can upload a large number of agreement records using the same metadata file. Once all the records are validated without any errors, '''click''' ''OK'' to schedule the batch for processing. Then the batch is lined up for processing and the Status changes to Scheduled. Finally, the Status changes to Workflow Processed indicating that the batch is successfully uploaded and the workflow is triggered.<br/> The following screenshot,&nbsp;broken down in 2 images, is of the same screen that displays overall status and progress of the batches.
-<div class="image-green-border">[[File:SP6 LegacyUpload ViewBatchProgress.png|950px|LegacyUpload ViewBatchProgress.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SP6 LegacyUpload ViewBatchProgress1.png|LegacyUpload ViewBatchProgress1.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">Some of the columns in the screen are explained below:&nbsp;</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SP6 LegacyUpload ViewBatchProgress2.png|LegacyUpload_ViewBatchProgress2]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">It can be seen in the screenshot below that the batch AcmeCorplegacyagreements that was created for the ''ICMLegacyContract'' Contract Type, with a single agreement record and with workflow, is successfully uploaded.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SP6 LegacyUpload ViewBatchProgress3.png|LegacyUpload_ViewBatchProgress3]]</div>
-=== Viewing the status and error files&nbsp; ===
-When the batch processing is complete a third icon&nbsp;[[File:SP6 LegacyUpload DownloadIcon.png|RTENOTITLE]]&nbsp;called ''Download Integration Files'' appears under the Actions column. '''Click''' on the icon to download the Status and/or Error files. If there are any errors, correct those in the metadata file and try uploading the batch again.
+You can upload associated documents as peer associations to agreements using Legacy Upload.
-In the following screenshot, the Status File shows that there were no errors or warnings for ''AcmeCorplegacyagreements'' batch that was uploaded.
+#'''Follow''' the same process explained in the section above for creating a batch for Associations till the selection of Associated Document Contract Type on the ''Details'' tab of the ''Create Batch'' page.
-<div class="image-green-border">[[File:SP6 LegacyUpload ViewStatus and ErrorFiles.png|LegacyUpload_ViewStatus_and_ErrorFiles]]</div>
+#'''Select''' the ''Association'' contract type. For example, ''ICMMutualNDA''.
-=== Viewing the uploaded Agreements in ICM ===
-To view the uploaded Agreements in ICM, go to Agreement Management in ICM and Click on View Record icon to open the recently added legacy Agreement.<br/> If you have added any Notes, Team, or Commitments, they will be displayed under the respective tabs in the Agreement Summary.
+When you select the peer Associated Document Contract Type in the ''Association'' field, the ''Association'' field will reflect this relationship for the selected parent Contract Type and Associated Document Contract Type combination.
-<div class="image-green-border">[[File:SP6 LegacyUpload View Uploaded Agreement.png|LegacyUpload_View_Uploaded_Agreement]]</div> <div class="image-green-border">&nbsp;</div>
+<div class="note-box">'''Note: '''When the Self-Linkage is enabled for the selected parent contract type, you can select the same contract type to link as peer association in the Association field.</div>
-=== Uploading Agreements with mandatory Associations ===
+&nbsp;
+<div class="image-green-border">[[File:7.16 Legacy 14.png|720px|7.16 Legacy 14.png]]</div> <ol start="3">
+<li>'''Click''' ''Generate Workbook''. The workbook is auto generated with the pre-filled details of parent records for the selected contract type from the selected saved search in the “Parent Agreement Name | Agreement Code | SysId” format.</li>
+</ol>
-There may be cases where any associated documents are required before an Agreement can move to the ''Executed'' state. In that case, you can defer the workflow for the Agreement while uploading, then upload the required Association with workflow attached, and then enable the workflow for the Agreement when needed.<br/> Whether an Association is mandatory or not can be seen in ICM in the following 2 ways:<br/> If ''Is Mandatory'' flag is set to Yes while adding an Association for a particular Agreement Contract Type, an Association is mandatory. See the screenshot below:
+The workbook for peer associations also contains the Linkage Type column with the values as Parent, Child, and Peer. When there is the Linkage Type Masterdata configured in the ICI, the Linkage Type column will reflect the values from that masterdata.
-<div class="image-green-border">[[File:SP6 LegacyUpload Upload Agreement with MandatoryAssociation.png|LegacyUpload_Upload_Agreement_with_MandatoryAssociation]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">If Prerequisite or Postrequisite is selected in the Constraints drop-down list while creating an Associated Document Contract Type, an Association is mandatory. See the screenshot below:</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SP6 LegacyUpload Upload Agreement with MandatoryAssociation Prerequisites.png|LegacyUpload_Upload_Agreement_with_MandatoryAssociation_Prerequisites]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">'''To upload Agreements that require mandatory Associations:&nbsp;'''</div>
-. Follow the same steps&nbsp;to create metadata and mapping file for the Agreement as described in the Uploading Agreements section.
-. While creating the batch for uploading the Agreement, '''select''' the ''Defer Workflow'' check box so that the workflow is not attached to the Agreements while uploading. This check box controls the attachment of approval workflow to a particular batch.
+&nbsp;
-<div class="image-green-border">[[File:SP6 LegacyUpload DeferWorkflow.png|LegacyUpload_DeferWorkflow]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">3. Proceed with uploading the mapping and metadata files.&nbsp;</div>
-. Initiate the batch processing by clicking ''New Validate and Initiate&nbsp;''icon.&nbsp;
-. After the batch processing is successful and the Agreement is uploaded, the Status of the batch shows as ''Completed'', ''WF Deferred''. This indicates that the Agreement will not follow the workflow automatically.
+==== Creating a batch for Peer Associations with Create wizard flow. ====
-&nbsp;6. Follow the steps to upload the required Associations as described in the relevant section.&nbsp;
+You can create associated documents as peer associations to agreements using Legacy Upload.
-. After the Association’s workflow is successfully processed, you can click on the ''Enable Workflow'' icon for the Agreement batch to attach the approval workflow.&nbsp;
+#'''Follow''' the same process explained in the section above for creating a batch for Associations till the selection of Associated Document Contract Type on the ''Details'' tab of the ''Create Batch'' page.
-<div class="image-green-border">[[File:SP6 LegacyUpload EnableWorkflow.png|LegacyUpload_EnableWorkflow]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">In the following sections for uploading other entities, the same notes and considerations for the Metadata and Mapping Files, and data validations apply as detailed in the above section for uploading the Agreements.</div>
+#'''Select''' the ''Association'' contract type. For example, ''ICMMasterServicesAgreement''.
-= Uploading Associations&nbsp; =
-Before uploading the Associations, the parent Agreement must be uploaded first.<br/> You need to create separate metadata file for Associations, and one such file can contain Associations for one Association Contract type. This section demonstrates with an example how to upload an Association for the previously uploaded Agreement that is seen in ICM as ''Acme Corp Legacy Contract'' – ''ICMLegacyContract_1''.<br/> There can be 2 scenarios for uploading Associations:&nbsp;With Workflow and Without Workflow.
+When you select the peer Associated Document Contract Type in the Association field, the ''Association'' field will reflect this relationship for the selected parent Contract Type and Associated Document Contract Type combination.
+<div class="note-box">'''Note: '''When the Self-Linkage is enabled for the selected parent contract type, you can select the same contract type to link as peer association in the Association field.</div>
+&nbsp;
+<div class="image-green-border">[[File:7.16 Legacy 15.png|720px|7.16 Legacy 15.png]]</div> <ol start="3">
+<li>'''Click''' ''Generate Workbook''. The workbook is auto generated with the pre-filled details of parent records for the selected contract type from the selected saved search in the “Parent Agreement Name | Agreement Code | SysId” format, along with the Peer Association attributes as system would create Peer association like agreement creation and it would get linked to the Parent Agreement.</li>
+</ol>
-=== Searching or Creating&nbsp;a Contract Type for Associations with Workflow ===
+The workbook for peer associations also contains the Linkage Type column with the values as Parent, Child, and Peer. When there is the Linkage Type Masterdata configured in the ICI, the Linkage Type column will reflect the values from that masterdata.
-Search an existing Associated Document Contract Type in ICM for which to upload the Associations. If that Contract Type does not exist, you need to create it using Create Contract Type on Configuration page in ICM. If the Enable Approval Workflow flag is set to Yes, it means that the workflow is enabled for that Contract Type.
+&nbsp;
-<div class="image-green-border">[[File:SP6 LegacyUpload EnableApprovalWorkflow.png|LegacyUpload_EnableApprovalWorkflow]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">In this example, we have an Associated Document Contract Type named as ''LegacyAssocDocWF1''&nbsp;with the attributes as can be seen under the ''Selected Attribute'' tab. The ICM name for this Contract Type is ''ICMLegacyAssocDocWF1.&nbsp;''</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SP6 LegacyUpload Create Metadata file for Associations.png|LegacyUpload_Create_Metadata_file_for_Associations]]</div> <div class="image-green-border">&nbsp;</div> <div class="note-box">'''Note''':&nbsp;Ensure that the ''ICMLegacyAssocDocWF1'' Contract Type has been added in the Associations tab in the parent Contract Type ''ICMLegacyContract''.</div>
-=== Creating a&nbsp;Metadata File for Associations&nbsp; ===
-'''To create the metadata file for ''ICMLegacyAssocDocWF1'' Contract Type:'''
+=== Creating a batch for Masterdata ===
-. Create an Excel file with .xlsx extension and save it with the name ''ICMLegacy_AcmeAssociation''.
+You can upload Masterdata with or without Approval Workflow using Legacy Upload.
-. Edit the same file to create columns that are essentially the ICM attributes for ''ICMLegacyAssocDocWF1'' Contract Type, and enter their values for the associated document that you want to upload.
+To create batch for masterdata:
-. Create an additional column named ''ParentInstance_PK'' and provide the value of the Primary Key of the parent Agreement (''Legacy Ref Id'' for ''ICMLegacyContract Contract Type'').
+#'''Click'''&nbsp;''User Administration''&nbsp;> ''Admin Task''&nbsp;on the ''Home'' page.&nbsp;The ''Admin Task'' page opens.
+#'''Click''' the ''Legacy Upload'' option. The ''Legacy Upload'' page opens.
+#'''Click''' the ''Create Batch'' icon. The ''Create Batch'' page’s ''Details'' tab opens.
+#'''Select''' the ''Legacy Upload Action'' from the dropdown. For example, ''Create Masterdata''. The fields to select Saved Search and Contract Type name are displayed.
+#'''Select''' the masterdata in the ''Contract Type Name'' field. The dropdown will show all masterdata contract types configured in ICI. For example, select ''ICMSupplierMasterdata''.
+<div class="image-green-border">[[File:7.16 Legacy 16.png|720px|7.16 Legacy 16.png]]</div> <ol start="6">
+<li>'''Click''' ''Next'' and complete the batch creation for Masterdata following the same process as for creation of agreement batch.</li>
+</ol>
-The following screenshot of the Association’s metadata file ''ICMLegacy_AcmeAssociation'' shows the attributes and highlights the Primary Key of the parent Agreement.
+&nbsp;
-<div class="image-green-border">[[File:SP6 LegacyUpload Create Metadata file for Associations.png|LegacyUpload Create Metadata file for Associations.png]]</div>
-=== Making changes to the mapping file for Associations ===
-Open the same mapping file (''Mappings_Acme_agreements'') created while uploading the Agreement, and edit it to provide details for binding the Associated Document Contract Type with the parent Contract Type.
+=== Creating a batch for User information ===
-<div class="image-green-border">[[File:SP6 LegacyUpload MappingFile WithAssociations.png|LegacyUpload MappingFile WithAssociations.png]]</div>
-Add another row as highlighted in the above screenshot:
-*'''ICMLegacyAssocDocWF1''' is the ''Contract Type Name&nbsp;''for the Associated Document Contract Type.
+You can provision the users in ICI using the Legacy Upload utility. User information is uploaded independently as it is not related to any other entities.
-*'''ICMLegacyRefId''' under the Primary Key column is the mapping attribute for ''ICMLegacyAssocDocWF1'' Contract Type.
-*'''ICMLegacyContract''' under the Parent Entity Name is the parent Contract Type name.
-*'''ICMLegacyRefId''' under the ''Parent Primary Key'' column is the mapping attribute for ''ICMLegacyContract'' Contract Type (parent).
-<div class="note-box">'''Note''':&nbsp;Ensure that the associated documents are also stored at the same ''UNCFolderPath'' location as the agreements.</div>
-=== Uploading the Associations and viewing&nbsp;in ICM&nbsp; ===
-Follow the same steps on the UI for uploading the associations as they are for uploading the agreements.
+To create a User Provisioning batch:
-Only, ensure that you select the Associated Document Contract Type while creating the batch and do not select the check box for ''Defer Workflow''. In the current example, '''select''' the Contract Type Name as ''ICMLegacyAssocDocWF1''.
+#'''Click'''&nbsp;''User Administration''&nbsp;> ''Admin Task''&nbsp;on the ''Home'' page.&nbsp;The ''Admin Task'' page opens.
-<div class="image-green-border">[[File:SP6 LegacyUpload MappingFile WithAssociations1.png|LegacyUpload MappingFile WithAssociations1.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">The following screenshot shows the batch successfully uploaded, with the workflow attached and processed.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SP6 LegacyUpload WorkflowProcessed.png|950px|LegacyUpload WorkflowProcessed.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">After the Associations are successfully uploaded, you can view them under the ''Associations'' tab in the previously uploaded Agreement.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SP6 LegacyUpload Assocations.png|LegacyUpload Assocations.png]]</div>
+#'''Click''' the ''Legacy Upload'' option. The ''Legacy Upload'' page opens.
-=== Uploading Associations without Workflow&nbsp; ===
+#'''Click''' the ''Create Batch'' icon. The ''Create Batch'' page’s ''Details'' tab opens.
+#'''Select''' the ''Legacy Upload Action'' from the dropdown. For example, ''User Provisioning''.
-You can create the Associations for which the approval workflow is not enabled in ICM. This is configured in ICM by setting the ''Enable Approval Workflow'' flag to No for the relevant Contract Type. It means that the Associations for that Contract Type will not follow the approval workflow automatically.
+When the ''Extended User Entity'' masterdata is configured in the system, the ''Next'' button is displayed to select the attributes from the extended masterdata, else the ''Generate Workbook'' button is displayed.
-<div class="image-green-border">[[File:SP6 LegacyUpload EnableApprovalWorkflow2.png|LegacyUpload EnableApprovalWorkflow2.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">You can upload these Associations using the Legacy Upload utility and enable the workflow manually, when needed. The overall process to create the metadata file for an association and upload remains the same, except that the workflow is not automatically attached during the batch processing.</div> <div class="image-green-border">'''To upload Associations without workflow:'''</div>
+<div class="image-green-border">[[File:7.16 Legacy 17.png|720px|7.16 Legacy 17.png]]</div> <ol start="5">
-. Create the metadata file for an Association as described in the respective section.&nbsp;
+<li>'''Click''' ''Next''. The ''Attributes'' tab opens.</li>
+</ol>
-. Begin upload by creating a batch using the utility. At this point, it does not matter if you select the ''Defer Workflow'' check box or not, because the workflow is not enabled to begin with.
+The ''Available Attribute'' section displays all attributes from the ''Extended User Entity'' masterdata contract type.
+<ol start="6">
+<li>'''Select''' the attributes for which you want to upload the legacy data in the current batch from the ''Available Attribute'' section and add to the ''Selected Attribute'' section using the action arrows.</li>
+<li>'''Click''' ''Generate Workbook''. The workbook template is generated in the MS Excel format and downloaded at the pre-set download location on your system.</li>
+</ol>
-. Proceed to upload the mapping file and metadata file.
+&nbsp;
-. Initiate the batch processing by clicking ''New Initiate and Validate'' icon.
+=== Creating a batch for Clauses ===
-. After the batch processing is successful and the data is uploaded, the Status of the batch shows as ''Completed'', ''WF Deferred''.
+You can import bulk clauses into ICI with the help of Legacy Upload Tool. User can migrate their existing clause repository from their previous system with lot of easy, along with it the tool also supports attributes tagging capability. An XML specification document is also released which can be used for creating tags in the input document files of Clauses.
-. Then you can click on the Enable Workflow icon anytime to attach the approval workflow. See the screenshot below:
+To create Clauses batch:
-<div class="image-green-border">[[File:SP6 LegacyUpload EnableWorkflow.png|LegacyUpload EnableWorkflow.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">When an Association uploaded without workflow is viewed in ICM, it will not have any buttons visible on the UI. See the representational screenshot below:</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SP6 LegacyUpload Assocations without workflow.png|LegacyUpload Assocations without workflow.png]]</div> <div class="image-green-border">&nbsp;</div>
-= Uploading Amendments =
-The process to upload the Amendments for an Agreement is the same as for uploading the Associations.<br/> Except that you do not need to create the Contract Type for the Amendments as it is automatically created when you create the Contract Type for Agreements.
+#'''Click'''&nbsp;''User Administration''&nbsp;> ''Admin Task''&nbsp;on the ''Home'' page.&nbsp;The ''Admin Task'' page opens.
+#'''Click''' the ''Legacy Upload'' option. The ''Legacy Upload'' page opens.
+#'''Click''' the ''Create Batch'' icon. The ''Create Batch'' page’s ''Details'' tab opens.
+#'''Select''' the ''Legacy Upload Action'' from the dropdown. For example, ''Clauses''.
-=== Creating&nbsp;Metadata File for Amendments ===
+When the ''Extended Clause Entity'' masterdata is configured in the system, the ''Next'' button is displayed to select the Clause Additional Attributes from the extended masterdata, else the ''Generate Workbook'' button is displayed.
+<div class="image-green-border">[[File:7.16 Legacy 18.png|720px|7.16 Legacy 18.png]]</div> <ol start="5">
+<li>'''Click''' ''Next''. The ''Attributes'' tab opens.</li>
+</ol>
-'''To create the metadata file for ICMLegacyContractAmendment Contract Type''':
+The ''Available Attribute'' section displays all attributes from the ''Extended Clause Entity''.
+<ol start="6">
+<li>'''Select''' the attributes for which you want to upload the legacy data in the current batch from the ''Available Attribute'' section and add to the ''Selected Attribute'' section using the action arrows.</li>
+<li>'''Click''' ''Generate Workbook''. The workbook template is generated in the MS Excel format and downloaded at the pre-set download location on your system.</li>
+</ol>
-. Create an Excel file with .''xlsx'' extension and save it with the name – ''ICMLegacy_AcmeAmendment.''
+&nbsp;
-. Edit the same file to create columns that are essentially the ICM attributes for ''ICMLegacyContract'' (parent) Contract Type, and enter their values as required.
+=== Creating a batch for Template ===
-You may refer to the metadata file for the parent Agreement to create the Amendments metadata file, and add/remove columns or change their values as required. Name, File Path, Legacy Ref Id (or any other existing unique attribute), Business Status, and Type of Paper are mandatory attributes for Amendments as well.
+You can import bulk Templates into ICI with the help of Legacy Upload Tool. User upload relevant templates with capability of Attribute tagging in it. This helps in reducing the implementation duration and achieve faster efficiency. Along with the tool, an XML specification document is also released which can be used for creating tags in the input document files of templates.
-. Ensure that the Amendment has a unique Primary Key. If not, create it as an ICM attribute (for example, ''Legacy Ref Id'').
+To create Templates batch:
-. Create an additional column named ''ParentInstance_PK'' and provide the value of the Primary Key of the parent Agreement (previously uploaded for ''ICMLegacyContract'' Contract Type).
+#'''Click'''&nbsp;''User Administration''&nbsp;> ''Admin Task ''on the ''Home'' page.&nbsp;The ''Admin Task'' page opens.
+#'''Click''' the ''Legacy Upload'' option. The ''Legacy Upload'' page opens.
+#'''Click''' the ''Create Batch'' icon. The ''Create Batch'' page’s ''Details'' tab opens.
+#'''Select''' the ''Legacy Upload Action'' from the dropdown. For example, ''Template''.
-The following screenshot of the Amendment metadata file ''ICMLegacy_AcmeAmendment'' shows the attributes and highlights the Primary Key of the parent Agreement (''ParentInstance_PK''), and of the Amendment (''Legacy Ref Id'') that is being uploaded. The Primary Key of the Amendment (''Legacy Ref Id'') can be used as a mapping attribute for the relevant associations, and other entities that may be dependent upon the Amendment.
+When the ''Extended Template Entity'' masterdata and template variables are configured in the system, the ''Next'' button is displayed to select the ''Template Additional'' A''ttributes'' from the extended masterdata, else the ''Generate Workbook'' button is displayed.
-<div class="image-green-border">[[File:SP6 LegacyUpload Create Metadata file for Amendments.png|950px|LegacyUpload Create Metadata file for Amendments.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="note-box">'''Note''': Ensure that the amendment documents, if any, are also stored at the same ''UNCFolderPath'' location as the Agreements.</div>
+<div class="image-green-border">[[File:7.16 Legacy 19.png|720px|7.16 Legacy 19.png]]</div> <ol start="5">
-=== Making changes to the mapping file for Amendments&nbsp; ===
+<li>'''Click''' ''Next''. The ''Attributes'' tab opens.</li>
+</ol>
-Open the same mapping file (''Mappings_Acme_agreements'') created while uploading the Agreement, and edit it to provide details for binding the Amendment Contract Type with the parent Agreement Contract Type.<br/> Add another row as described below:
+The ''Available Attribute'' section displays all attributes from the ''Extended Template Entity''.
+<ol start="6">
+<li>'''Select''' the attributes for which you want to upload the legacy data in the current batch from the ''Available Attribute'' section and add to the ''Selected Attribute'' section using the action arrows.</li>
+<li>'''Click''' ''Generate Workbook''. The workbook template is generated in the MS Excel format and downloaded at the pre-set download location on your system.</li>
+</ol>
-*'''ICMLegacyContractAmendment''' is the ''Contract Type Name'' for the Amendment.
+&nbsp;
-*'''ICMLegacyRefId''' under the ''Primary Key'' column is the unique attribute for '''ICMLegacyContractAmendment''' Contract Type.
-*'''ICMLegacyContract''' under the ''Parent Entity Name'' is the parent Contract Type name.
-*'''ICMLegacyRefId''' under the ''Parent Primary Key'' column is the unique attribute for '''ICMLegacyContract''' Contract Type (parent).
-=== Uploading the Amendments and viewing in ICM ===
+== Accessing Legacy Upload Page ==
-Follow the same steps on the UI for uploading the associations as they are for uploading the agreements.<br/> Only, ensure that you select the Amendment Contract Type while creating the batch. In the current example, select the Contract Type Name as ''ICMLegacyContractAmendment''.
+The Legacy Upload page displays the details of uploaded batches in a table format. The batch details include Actions, Status, Error details, Batch Passed count, Failed count and so on. User can filter and search legacy upload batch with column filter capability.
-<div class="image-green-border">[[File:SP6 LegacyUpload UploadAmendments.png|LegacyUpload UploadAmendments.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">After the Amendments are successfully uploaded, you can view them under the Amendments tab in the previously uploaded parent Agreement.</div>
-= Uploading Masterdata =
-This section demonstrates with an example how to upload the Masterdata. Masterdata is uploaded independently as it is not related to any other entities. So there is no need for the mapping file.<br/> There can be 2 scenarios for uploading Masterdata – With Workflow and Without Workflow.
+You can view the status of the batch by clicking the&nbsp;Refresh&nbsp;button in the top right hand corner to refresh the status of the batch.&nbsp;If you encounter any error while processing the batch, it is highlighted in red color and displayed under the&nbsp;Failed Count&nbsp;column.&nbsp;After the batch is uploaded,&nbsp;click&nbsp;the&nbsp;batch Name&nbsp;to view the history of the processes performed on a particular batch.
-=== Searching or Creating&nbsp;a Contract Type for the Masterdata with workflow ===
+To access the Legacy Upload page:
-Search an existing Masterdata Contract Type in ICM for which to upload the data. If that Contract Type does not exist, you need to create it using Create Contract Type on ''Configuration'' page in ICM. If the ''Enable Approval Workflow'' flag is set to ''Yes'', it means that the workflow is enabled for that Contract Type.
+#'''Click'''&nbsp;the&nbsp;''User Administration''&nbsp;tile on the ''Home'' page.&nbsp; The sub menu tiles dropdown opens.
-<div class="image-green-border"><br/> [[File:SP6 LegacyUpload Create Masterdata.png|LegacyUpload Create Masterdata.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">In this example, we have a Masterdata Contract Type named as ''Acme Legacy Master Data''&nbsp;with the attributes as can be seen under the Selected Attribute tab. The ICM name for this Contract Type is ''ICMLegacyMasterData''.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SP6 LegacyUpload Create Masterdata 1.png|950px|LegacyUpload Create Masterdata 1.png]]</div> <div class="image-green-border">&nbsp;</div>
+#'''Click'''&nbsp;the&nbsp;''Admin Task''&nbsp;tile.&nbsp;The ''Admin Task'' page opens.
-=== Creating &nbsp;Metadata file for Masterdata ===
+<div class="image-green-border">[[File:7.16 Legacy 6.png|720px|7.16 Legacy 6.png]]</div> <ol start="3">
+<li>'''Click''' the ''Legacy Upload'' option.</li>
+</ol>
+<div class="image-green-border">[[File:7.16 Legacy 7.png|720px|7.16 Legacy 7.png]]</div>
+The ''Legacy Upload'' page opens.
-'''To create the metadata file for ICMLegacyMasterData Contract Type''':
+The page displays the complete statistics for all created and uploaded batches. The page also displays the options to ''Create Batch'' and ''Upload Batch''.
+<div class="image-green-border">[[File:7.16 Legacy 20.png|720px|7.16 Legacy 20.png]]</div>
+Some of the columns on the Legacy Upload page are explained below:
-&nbsp;1. Create an Excel file with .xlsx extension and save it with the name ''ICMLegacy_AcmeMasterdata''.
+[[File:7.16 Legacy Table 1.JPG|720px|7.16 Legacy Table 1.JPG]]
-&nbsp;2. Edit the same file to create columns that are essentially the ICM attributes for ''ICMLegacyMasterData'' Contract Type, and enter their values for the master data that you want to upload.
+== Preparing the workbook with legacy records data ==
-<div class="image-green-border">[[File:SP6 LegacyUpload Create MetadataFile for Masterdata.png|LegacyUpload Create MetadataFile for Masterdata.png]]</div> <div class="image-green-border">&nbsp;</div>
-=== Uploading Masterdata&nbsp; ===
-Follow the same steps on the UI for uploading the Masterdata as they are for uploading the agreements.<br/> Only, ensure that you select the relevant Masterdata Contract Type while creating the batch and do not select the check box for ''Defer Workflow''. In the current example, select the Contract Type Name as ''ICMLegacyMasterData''.
+Once the workbook is generated through the Create Batch process, you need to fill the legacy records data in the respective worksheets to prepare the workbook for uploading the batch.
-<div class="image-green-border">[[File:SP6 LegacyUpload Upload Masterdata.png|LegacyUpload_Upload_Masterdata]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">After the Masterdata is successfully uploaded, you can view them under the Masterdata tile on ''Configuration'' page.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SP6 LegacyUpload Upload Masterdata 1.png|LegacyUpload Upload Masterdata 1.png]]</div> <div class="image-green-border">&nbsp;</div>
-=== Uploading Masterdata without Workflow ===
-You can create the Masterdata for which the approval workflow is not enabled in ICM. This is configured in ICM by setting the ''Enable Approval Workflow'' flag to ''No'' for the relevant Masterdata Contract Type. It means that the Masterdata for that Contract Type will not follow the approval workflow automatically.
+=== Accessing the Workbook ===
-<div class="image-green-border">[[File:SP6 LegacyUpload Upload Masterdata.png|LegacyUpload Upload Masterdata.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">You can upload this Masterdata using the Legacy Upload utility and enable the workflow manually, when needed. The overall process to create the metadata file for the Masterdata and upload remains the same, except that the workflow is not auomatically attached during the batch processing.&nbsp;</div>
-. Create'''&nbsp;'''the metadata file for the Masterdata as described in the respective section.&nbsp;
-. Begin upload by creating a batch using the utility. At this point, it does not matter if you select the ''Defer Workflow'' check box or not, because the workflow is not enabled to begin with.
+#'''Click''' the arrow beside the file in the Download bar to display available actions.
+#'''Click''' ''Open''. The pre-configured workbook for the selected contract type opens.
-. Proceed to upload the metadata file.&nbsp;
+Alternatively, you can browse and open the downloaded Workbook from the pre-set download location on your system.
+<div class="image-green-border">[[File:7.16 Legacy 21.png|720px|7.16 Legacy 21.png]]</div> <ol start="3">
+<li>'''Click''' ''Enable Editing'' to allow entering of data in the workbook.</li>
+</ol>
+<div class="image-green-border">[[File:7.16 Legacy 22.png|720px|7.16 Legacy 22.png]]</div> <ol start="4">
+<li>'''Enter''' the legacy data in the appropriate worksheets.</li>
+<li>'''Save''' and close the workbook.</li>
+</ol>
-. Initiate the batch processing by clicking ''New Initiate and Validate'' icon.
+&nbsp;
-. After the batch processing is successful and the data is uploaded, the Status of the batch shows as ''Completed'', WF''Deffered''.
+=== Specifications of a workbook ===
-. Then you can click on the ''Enable Workflow'' icon anytime to attach the approval workflow.
+*The Workbook is generated based on the selected contract type.
+*The name of the workbook is constructed as the ICI name of the selected Contract Type Name amended with the date timestamp.
+*The mapping sheet is configured automatically and is part of the workbook.
+*The metadata of the workbook is also auto populated in the Information sheet to avoid any manual efforts.
+*The column order in workbook sheet is maintained same as the sequence of attributes on the UI to maintain the consistency.
+*Mandatory fields are highlighted in red.
+*The lookup fields are provided that display the values from reference entities to avoid wrong data entry errors.
+*All related worksheets for an entity, such as Team members, Notes, and Commitments, are available in a single workbook.
+*The attributes necessary for processing are provided as lookup attributes to avoid errors due to manually entering values.
+<div class="image-green-border">[[File:7.16 Legacy 23.png|720px|7.16 Legacy 23.png]]</div>
+*The peer association worksheet also contains the Linkage Type column with the values as Parent, Child and Peer. When there is the Linkage Type Masterdata configured in the ICI, the Linkage Type column will reflect the values from that masterdata.
+<div class="image-green-border">[[File:7.16 Legacy 24.png|720px|7.16 Legacy 24.png]]</div>
+&nbsp;
-When the Masterdata uploaded without workflow is viewed in ICM, it will not have any buttons visible on the UI.
+=== Preparing the Mapping Sheet ===
-= User Provisioning =
+The mapping sheet is a part of the generated workbook. You need to provide below mentioned details required to process the Legacy Upload batch.
-This section demonstrates with an example how to provision the users in ICM using the utility. User information is uploaded independently as it is not related to any other entities. The relevant Contract Type UserInformation is created when ICM is configured.<br/> You can also upload additional user information by uploading a separate metadata file with the relevant data, after a user is provisioned.
+[[File:7.16 Legacy Table 2.JPG|720px|7.16 Legacy Table 2.JPG]]
-=== Creating&nbsp;Metadata file for User Information&nbsp; ===
+Apart from these Batch processing details, you also need to provide the entity details.
+<div class="note-box">'''Note: '''Ensure that you enter attribute’s ICI name, spelled exactly as they are present in ICI, in the Mapping sheet and do not mention attribute’s display name. The ICI names are case-sensitive.</div>
+[[File:7.16 Legacy Table 3.JPG|720px|7.16 Legacy Table 3.JPG]]
-'''To create the metadata file for UserInformation Contract Type''':
+The snapshot of the sample mapping sheet for Agreement is:
+<div class="image-green-border">[[File:7.16 Legacy 25.png|720px|7.16 Legacy 25.png]]</div>
+&nbsp;
-. Create an Excel file with .''xlsx ''extension and save it with the name&nbsp;''ICMLegacy_AcmeUserInformation .''
+=== Preparing the data sheet for ICI entities ===
-. Edit the same file to create columns as below:
+The data sheet in the auto generated workbook contains the entity and contract type specific details. Also, the data sheet is named after the selected entity contract type. For example, the data sheet for the Masterdata- ''ICIStateMaster'', is named as same as contract type name which is ''ICIStateMaster''.
-<div class="image-green-border">[[File:LegacyUpload CreateMetadata File for UserInformation.png|LegacyUpload CreateMetadata File for UserInformation.png]]&nbsp;</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SP6 LegacyUpload CreateMetadata File for UserInformation1.png|LegacyUpload CreateMetadata File for UserInformation1.png]]</div> <div class="image-green-border">&nbsp;</div>
+<div class="note-box">'''Note:''' The data sheet reflects the attributes as they are present on the UI for creating the respective entity.</div>
-=== Uploading the User Information ===
+&nbsp;
-Follow the same steps on the UI for uploading the user information as they are for uploading the agreements, except for uploading the mapping file.<br/> Ensure that you select the ''UserInformation'' Contract Type while creating the batch.
+==== Preparing the data sheet for Agreement, Amendment, Associated Documents and Masterdata ====
-<div class="image-green-border">[[File:SP6 LegacyUpload Upload UserInformation.png|LegacyUpload Upload UserInformation.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">Then upload the metadata file ''ICMLegacy_AcmeUserInformation''.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SP6 LegacyUpload Upload IntegrationFiles.png|LegacyUpload Upload IntegrationFiles.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">'''Click''' on ''New Validate and Initiate'' icons to validate the data and schedule the batch for processing.<br/> After the user information is successfully uploaded, you can view it under the ''Users'' tab in ''User Administration''.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SP6 LegacyUpload Upload UserInformation1.png|LegacyUpload Upload UserInformation1.png]]</div> <div class="image-green-border">&nbsp;</div>
-=== Creating&nbsp;Metadata File for extended user information&nbsp; ===
-The relevant Contract Type needs to be created in ICM. For the current example, create a Contract Type named ExtendedUserInformation with the required attributes.<br/> To create the metadata file for ExtendedUserInformation Contract Type:
+The data sheet for Entities- Agreement, Amendment, Associated Documents and Masterdata, contains the attributes you selected from the contract type when creating the batch. These attributes will appear in the data sheet in the order of their selection.
-. Create an Excel file with .xlsx extension and save it with the name – ''ICMLegacy_AcmeExtendedUserInfo''.
+The data sheet for these entities also contain the necessary backend attributes required for processing which may or may not be visible on the UI such as ''Business Status, Org Unit, Type Of'' ''Paper'' and ''File Name''. The ''Type Of Paper'' attribute has the default value as ''Third Party''. The data sheet for Amendment has additional attributes ''Is Amendment'' and ''Use Amendment Template''.
-. Edit the same file to create columns as below:&nbsp;
+The contract type data sheet for Amendment and Peer Association contains prefilled details for the parent agreements of selected contract type from the selected saved search. The details will comprise of pipe delimited values of ''Parent Agreement Name, Agreement Code'' and ''Sysid'' within a single column, which would help system to easily find parent records in the ICI. &nbsp;
-<div class="image-green-border">[[File:LegacyUpload CreateMetadata File for ExtendedUserInformation.PNG|RTENOTITLE]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SP6 LegacyUpload CreateMetadata File for ExtendedUserInformation1.png|LegacyUpload CreateMetadata File for ExtendedUserInformation1.png]]</div>
-. Follow the same steps on the UI for uploading the extended user information as they are for uploading the user information. Only, ensure that you select the ''ExtendedUserInformation'' Contract Type while creating the batch.
-'''Related Topics:&nbsp;'''[[User_Administration|User Administration]]&nbsp;|
+The snapshot of the sample auto generated data sheet for Amendment is:
+<div class="image-green-border">[[File:7.16 Legacy 26.png|720px|7.16 Legacy 26.png]]</div>
+You can add the legacy records details in the respective columns to prepare the data sheet.
+<div class="image-green-border">[[File:7.16 Legacy 27.png|720px|7.16 Legacy 27.png]]</div>
+&nbsp;
+===== Linkage type support for peer associations =====
+The data sheet for uploading peer associations also contains the ''Linkage Type'' column with the values as ''Parent, Child'' and ''Peer''. When there is the ''Linkage Type'' ''Masterdata'' configured in the ICI, the ''Linkage Type'' column will reflect the values from that masterdata.
+After the successful batch upload for peer associations, the appropriate linkage type relationship is automatically established for the legacy records based on their contract types.
+*For self-linkage type, the associations will be linked as peer to the agreements of same contract type. For example, the SOW agreement instance will be linked to another instance of SOW with linkage type as peer.
+*For two-way linkage type, the base agreement and association will be linked as parent and child respectively. For example, when user selects the linkage type as Child while uploading SOW legacy record, the linked MSA record will be automatically updated as parent based on the two-way linkage type configuration.
+<div class="image-green-border">[[File:7.16 Legacy 24.png|720px|7.16 Legacy 24.png]]</div>
 &nbsp;
+'''Adding Team members, Notes, and Commitments'''
+You can also add ''Team members, Notes,'' and ''Commitments'' if applicable to the legacy record using the same workbook by adding the details in the respective sheets at the same time when uploading the legacy records.
+The worksheets for adding the details for ''Team members, Notes'', and ''Commitments'' are part of the workbook.
+The snapshot of the auto generated Team Members worksheet is:
+<div class="image-green-border">[[File:7.16 Legacy 28.png|720px|7.16 Legacy 28.png]]</div>
+The snapshot of the auto generated Notes worksheet is:
+<div class="image-green-border">[[File:7.16 Legacy 29.png|720px|7.16 Legacy 29.png]]</div>
+The snapshot of the auto generated Commitments worksheet is:
+<div class="image-green-border">[[File:7.16 Legacy 30.png|720px|7.16 Legacy 30.png]]</div>
+&nbsp;
+<div class="note-box">'''Note:''' Uploading the team, notes or commitments must be done at the first time when uploading the Agreements. Updating these entities later after Agreements are uploaded is not supported.</div>
+&nbsp;
+==== Preparing the data sheet for User Provisioning, Clauses and Templates ====
+The data sheet for entities User Provisioning, Clauses and Templates reflects all attributes from the selected entity contract type in the same display sequence as they appear on the UI for that entity.
+In addition to contact type attributes, the data sheet for these entities also contains the user selected attributes from the respective extended entity masterdata at the time of batch creation.
+Here is the snapshot of the auto generated User Information worksheet with the sample legacy record details that is ready for upload:
+<div class="image-green-border">[[File:7.16 Legacy 31.png|720px|7.16 Legacy 31.png]]</div>
+Here is the snapshot of the auto generated Clauses worksheet with the sample legacy record details that is ready for upload:
+<div class="image-green-border">[[File:7.16 Legacy 32.png|720px|7.16 Legacy 32.png]]</div>
+Here is the snapshot of the auto generated Templates worksheet with the sample legacy record details that is ready for upload:
+<div class="image-green-border">[[File:7.16 Legacy 33.png|720px|7.16 Legacy 33.png]]</div>
+&nbsp;
+===== Observations and assumptions&nbsp;for clauses batch =====
+The following observations and assumptions need to be taken into consideration while bulk uploading clauses using the Legacy Upload tool:
+*A&nbsp;Primary Clause&nbsp;and a&nbsp;Linked Primary Clause&nbsp;should not be a part of same batch. The Primary Clause must be created first and then it should be used as a&nbsp;Linked Primary Clause.
+*A clause with&nbsp;Is Alternate Clause&nbsp;value marked as&nbsp;TRUE&nbsp;and the clause that it is the&nbsp;Alternate of&nbsp;should not be part of same batch.
+*A clause with&nbsp;Is Dependent Clause&nbsp;value marked as&nbsp;TRUE&nbsp;and the clause which it&nbsp;Depends On&nbsp;should not be part of same batch.&nbsp;
+*Tags must be on the same line in the template document. Tagging will not function if the tags are on separate lines. For example, if the closing tag </cta> is on the next line, tagging does not work.
+*There should be no non-breaking spaces (ASCII value xA0) within XML tags. Ensure to replace them with regular spaces in XML tags. Using deactivated clause groups is allowed.
+*Template Variables cannot be tagged in a clause. If tagged, the template variable will be treated as plain text and no exceptions are triggered.
+*The user importing templates and clauses must have permissions on the respective tiles, otherwise they will not be able to view them in Icertis Experience for Word.
+*Only creation of clause is supported. Bulk edits and updating edited clause text in templates where the clause is referred are currently not supported.
+&nbsp;
+===== Observations and Assumptions&nbsp;for templates batch =====
+The following observations and assumptions need to be taken into consideration while uploading templates using the Legacy Upload tool:
+*If tagging fails for a part of the batch, only the Passed count gets updated while the Failed count is not updated. However, the failed count can be inferred.
+*The entire XML should be on the same line. Tagging will not function if the tags are split on separate lines.
+*There should be no non-breaking spaces (ASCII value is xA0) within XML tags. Ensure to replace them with regular spaces in XML tags.&nbsp;
+*Primary and alternate templates cannot be a part of same batch.
+*Threading causes some issues. Further, if there has been any error in tagging, it is not possible to rollback or delete instances created using batch upload.
+*Ensure each template is given a unique name. If two templates are uploaded with the same name, then one of the entries fails. However, the Error file does not show any corresponding error message.
+&nbsp;
+===== Mandatory tags for clause document =====
+The mandatory attributes tags are available in the Xml format for tagging inside clauses and templates.
+Below table provides the details for xml tags:
+[[File:7.16 Legacy Table 4.JPG|720px|7.16 Legacy Table 4.JPG]]
+&nbsp;
+[[File:7.16 Legacy Table 5.png|720px|7.16 Legacy Table 5.png]]
+To further understand tag properties, refer the below table:
+[[File:7.16 Legacy Table 6.JPG|720px|7.16 Legacy Table 6.JPG]]
+&nbsp;
+== Uploading the batch ==
+#'''Click''' the ''Upload Batch'' icon on the ''Legacy Upload'' page. The ''Upload Batch'' window opens.
+<div class="image-green-border">[[File:7.16 Legacy 34.png|720px|7.16 Legacy 34.png]]</div> <ol start="2">
+<li>'''Enter''' the ''Batch Name'' for the current batch to refer to it later. For example, ''MSA Batch''.</li>
+<li>'''Select''' the ''Contract Type Name''. For example, ''ICMMSA''. The dropdown field will show all configured contract types in ICI.</li>
+<li>'''Click''' ''Choose File'' button to browse and select a file in the ''File Path'' field. For example, ''ICMMSA_20210524044518.xlsx''.</li>
+</ol>
+<div class="note-box">'''Note:&nbsp;'''<br/> System validates the data upon file selection. The errors found, if any, will be highlighted so that the user can make corrections.&nbsp;<br/> You can only upload Excel files, the Create button will be enabled only when you upload the correct file format.</div> <ol start="5">
+<li>'''Select'''&nbsp;the&nbsp;''Defer Workflow''&nbsp;check box so that the workflow is not attached to the agreements while uploading. This check box controls the attachment of approval workflow to a particular batch.</li>
+</ol>
+<div class="note-box">'''Note:''' Do not select the check box for&nbsp;Defer Workflow while creating the batch for an entity with enabled approval workflow.</div>
+&nbsp;
+<div class="image-green-border">[[File:7.16 Legacy 35.png|720px|7.16 Legacy 35.png]]</div> <ol start="6">
+<li>'''Click '''''Create''. The batch will be added to the queue for processing and the status will move to Schedule on the successful validation of the file.</li>
+</ol>
+If there are any errors encountered during validation, the batch will be created in the Draft state.
+<div class="note-box">'''Note:'''&nbsp;<br/> The data will be picked up for processing when the task service runs on the backend every day. When the task is triggered, the status updates to Processing.<br/> The Task can be configured as per customer requirements from the ICM Tools.&nbsp;The data records in a batch are processed and uploaded based on the State they are in.</div>
+&nbsp;
+=== Uploading Agreements with mandatory Associations ===
+#In case of mandatory associations for agreements, you can first upload the agreements batch with the deferred workflow by selecting the checkbox for ''Defer Workflow'' on the Upload Batch window. After the successful processing of agreements batch, the ''Status'' of the batch will move to&nbsp;''Completed,&nbsp;WF Deferred'', indicating that the&nbsp;agreement will not follow the workflow automatically.
+#Once the Agreements are successfully uploaded in the ICI with the deferred workflow, upload the mandatory Associations following the steps: <ol style="list-style-type:upper-roman;">
+</ol>  </ol>
+</ol>
+</ol>
+i. '''Search''' or create the contract type for Associations you want to upload.
+ii. '''Create''' a batch for Associations.
+iii. '''Prepare''' the workbook by entering the legacy records data.
+iv. '''Upload''' the batch with the attached Workflow.
+<ol start="3">
+<li>Once the mandatory associations are successfully uploaded in the ICI, you can click on the&nbsp;''Resume WF''&nbsp;icon available beside the agreement batch which is in ''Completed, WF'' ''Deferred'' status and complete the processing for agreements.</li>
+</ol>
+<div class="image-green-border">[[File:7.16 Legacy 36.png|720px|7.16 Legacy 36.png]]</div>
+After the successful processing, the agreements batch status moves to ''Workflow Processed'' with the attached workflow.
+<div class="image-green-border">[[File:7.16 Legacy 37.png|720px|7.16 Legacy 37.png]]</div>
+Uploading Peer association with the create Wizard flow along with Linkage Type.
+*In case of Peer associations for with create wizard flow, you can first upload the association batch with all the details input in the workbook on the Upload Batch window. System would process the Association by creating the instance on the ICI Application, the status of the batch would show as ''Workflow Processed''.
+*Once the Peer Association are successfully uploaded in the ICI the system would automatically process with linking with its Parent agreement with linkage type defined in the workbook. Once the batch is processed the status of the batch would show as ''Completed''.
+<div class="image-green-border">[[File:7.16 Legacy 38.png|720px|7.16 Legacy 38.png]]</div>
+&nbsp;
+=== Uploading clauses and template batch ===
+To upload the batch for clauses and templates, follow the same process as for uploading batch for other entities.
+The ICI will auto initiate the tagging of attributes in clauses and templates upon the batch creation to avoid the manual efforts.
+&nbsp;
+=== Status changes for the processed batch ===
+The entities which support uploading with or without attached approval workflow, are processed based on their approval workflow configuration by following the deferred workflow steps. The status of the batch processing for such entities goes form ''Completed, WF Differed'' to ''Workflow'' ''processed''.
+For entities that do not need approval workflow, the batch status will move to ''Completed'' on successful processing.
+&nbsp;
+== Viewing the batch Activity Log ==
+To access the processing logs for a specific batch:
+#'''Click'''&nbsp;the batch name on&nbsp;the ''Legacy Upload''&nbsp;page to view the activity log of a particular batch. The activity log shows the operations performed while processing the batch and also displays the errors if any in Red color.
+#'''Click''' on the error message highlighted in Red to expand and view the details of the encountered error.
+<div class="image-green-border">[[File:7.16 Legacy 39.png|720px|7.16 Legacy 39.png]]</div> <ol start="3">
+<li>'''Click''' ''Download'' icon beside the error in Red to download all the details of the specific record with the errors or warnings.</li>
+</ol>
+<div class="image-green-border">[[File:7.16 Legacy 40.png|720px|7.16 Legacy 40.png]]</div>
+&nbsp;
+== Checking Integration Files ==
+You can check the errors and warnings encountered during processing for failed records for the processed batch after the batch or workflow processing is complete.
+To download integration files:
+#'''Click''' the ''Download Integration Files'' icon corresponding to the processed Batch that you want to review, on the ''Legacy Upload'' page. For example, ''May MSA Batch''.
+<div class="image-green-border">[[File:7.16 Legacy 41.png|720px|7.16 Legacy 41.png]]</div>
+The ''Download Integration Files'' window opens offering below file options to download:
+*''Status File'' and ''Error File'' for batches in ''Completed'' status
+*''WF Status File'' and ''WF Error File'' for batches in ''Workflow Processed'' status
+<div class="image-green-border">[[File:7.16 Legacy 42.png|720px|7.16 Legacy 42.png]]</div> <ol start="2">
+<li>'''Select''' ''WF Error File''. The error file is downloaded in the Excel format. The file contains the details about ''Errors'' and ''Warnings'' encountered while processing for the failed records along with the details of each failed record in each of the data worksheet in the uploaded workbook.</li>
+</ol>
+<div class="image-green-border">[[File:7.16 Legacy 43.png|720px|7.16 Legacy 43.png]]</div> <ol start="3">
+<li>'''Select '''''WF Status File'' to view the workflow processing status for all records in the batch file. The Excel file is downloaded on the pre-set download location on your system.</li>
+</ol>
+<div class="image-green-border">[[File:7.16 Legacy 44.png|720px|7.16 Legacy 44.png]]</div>
+&nbsp;
+== Re-uploading of a batch ==
+You can correct the errors in the data file and re-upload the batch a specific batch which is in the draft state from the Legacy Upload page itself.
+&nbsp;To upload the batch in draft for processing
+#'''Open'''&nbsp;the downloaded Integration file. It contains details on Integration Status, Validation Status, Errors, Warnings, Contract Type Name, Name (of the uploaded file), and so on.
+#'''Check'''&nbsp;the message in the ''Errors'' column and correct that record accordingly in the batch workbook that you uploaded before, by referring to the entity code provided in the integration file.
+#'''Click''' the ''Upload Integration Files'' icon beside the batch in ''Draft'' state for which you want to upload the workbook. The ''Upload Batch'' window opens.
+<div class="image-green-border">[[File:7.16 Legacy 45.png|720px|7.16 Legacy 45.png]]</div>
+The ''Batch Name, Contract Type Name ''and''Defer Workflow'' will be pre-selected with respect to the batch you are uploading.
+<ol start="4">
+<li>'''Click''' ''Choose File'' to browse and select the revised workbook from its location on your system.</li>
+<li>'''Click''' ''Upload''. The batch will be added to the queue for processing.</li>
+</ol>
+<div class="image-green-border">[[File:7.16 Legacy 46.png|720px|7.16 Legacy 46.png]]</div>
+&nbsp;
+<div class="note-box">'''Note:&nbsp;'''The data will be picked up for processing when the task service runs on the backend every day. When the task is triggered, the status updates to ''Processing''. After the processing is complete, the status changes to ''Completed''. The Task can be configured as per customer requirements from the ICM Tools.</div>
+&nbsp;
+== Accessing Integrated batches report ==
+You can view the consolidated status report for all the batches run for the current date. To access the report, click the ''Download Report'' icon on the ''Legacy Upload'' page.
+<div class="image-green-border">[[File:7.16 Legacy 47.png|720px|7.16 Legacy 47.png]]</div>
+The consolidated report will be downloaded on the pre-set default download location on your system.
+The report contains the following details for the batches run on the particular date:
+<div class="image-green-border">[[File:7.16 Legacy 48.png|720px|7.16 Legacy 48.png]]</div>
+&nbsp;
+== Accessing Notifications ==
+The user will get the notification on the batch initiation and completion informing the processing status of records by the Legacy Upload tool as success or failure. The notification template for the Legacy Upload Notification can be configured as per the requirements.
+To access Legacy Upload Notification:
+#'''Click''' ''Notifications'' on the ''Home'' page. The ''Notification'' ''Dashboard'' opens.
+#'''Select''' ''Legacy Upload Notification Category''. The respective notifications under the events for ''Legacy Upload Batch Initiation'' and ''Legacy Upload Batch Completion'' are displayed.
+#'''Select''' the notification to view. The notification details are displayed in the right pane.
+<br/> &nbsp;&nbsp;
+== Accessing the uploaded entities in the ICI ==
+After you upload the legacy records into the ICI, you can view and access the records on the entity’s respective pages and tabs.
+*You can view uploaded legacy Agreements from the ''Agreements'' index page. Click ''Agreement Management'' > ''Agreements'' to open the ''Agreement'' index page.
+*Click the ''View Record'' icon beside the agreement to open its ''Details'' page. If you have added any ''Notes, Team, ''or ''Commitments'', they will be displayed under the respective tabs in the left navigation pane.
+*After the Amendments are successfully uploaded, you can view them under the ''Amendments'' tab in the previously uploaded parent Agreement.
+*After the Associations are successfully uploaded, you can view them under the&nbsp;''Associations''&nbsp;tab in the previously uploaded Agreement. You can also access Associations from the ''Association Management'' > ''Associations'' on the ''Home'' page.
+When an Association uploaded without workflow is viewed in ICI, it will not have any buttons visible on the UI.
+*You can view uploaded legacy masterdata records on the Masterdata index page. Click ''Configuration'' > ''Masterdata'' on the ''Home'' page to open the ''Masterdata'' index page.
+*You can view the user information it under the&nbsp;''Users''&nbsp;tab in&nbsp;''User Administration''.
+*You can view uploaded legacy Templates on the Templates index page. Click ''Template'' ''Management'' > ''Templates'' on the ''Home'' page to open the ''Template'' index page.
+*You can view uploaded legacy Clauses on the ''Clauses'' index page. Click ''Clause'' ''Management'' > ''Clauses'' on the ''Home'' page to open the ''Clause'' index page.
+&nbsp;
+&nbsp;
+&nbsp;
+'''Related Topics: '''[[Agreement_Management|Agreement Management]] |&nbsp;[[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]] | [[Search_Sync|Search Sync]]&nbsp;|

Contents

Legacy Upload [edit]

Important Considerations [edit]

Uploading Agreements [edit]

Searching or Creating a Contract Type for the Agreements with Workflow [edit]

Creating a Metadata File for Agreements [edit]

Uploading Agreements with Team, Notes and Commitments[edit]

Creating a Metadata File with Team, Notes, and Commitments [edit]

Creating a Mapping File[edit]

Uploading the Legacy Agreements[edit]

Viewing the status and error files [edit]

Viewing the uploaded Agreements in ICM[edit]

Uploading Agreements with mandatory Associations[edit]

Uploading Associations [edit]

Searching or Creating a Contract Type for Associations with Workflow[edit]

Creating a Metadata File for Associations [edit]

Making changes to the mapping file for Associations[edit]

Uploading the Associations and viewing in ICM [edit]

Uploading Associations without Workflow [edit]

Uploading Amendments[edit]

Creating Metadata File for Amendments[edit]

Making changes to the mapping file for Amendments [edit]

Uploading the Amendments and viewing in ICM[edit]

Uploading Masterdata[edit]

Searching or Creating a Contract Type for the Masterdata with workflow[edit]

Creating Metadata file for Masterdata[edit]

Uploading Masterdata [edit]

Uploading Masterdata without Workflow[edit]

User Provisioning[edit]

Creating Metadata file for User Information [edit]

Uploading the User Information[edit]

Creating Metadata File for extended user information [edit]