You do not have permission to edit this page, for the following reason:
You can view and copy the source of this page:
Return to Legacy Upload.
Organizations may have a large number of existing Agreements that are created outside of ICM platform. These are henceforth referred to as Legacy Agreements. Organizations may want to import these Agreements to ICM to leverage its vast capabilities and manage all Agreements within a single platform.
The Legacy Upload feature enables ICM Administrator to easily upload in bulk the legacy agreements that were created outside of ICM. This feature enhances productivity by allowing you to upload a large volume of existing Agreements and other entities using Excel.
The highlights of this feature are :
You can use the utility to upload the following entities:
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. Hovering over the Failed Co… on the Legacy Upload page, is displayed as Failed Count. After the batch is uploaded, click the Batch Name to view the history of the processes performed on a particular batch.
This section demonstrates with an example how to upload plain Agreements for a particular Contract Type.
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.
1.Create a Contract Type named as Legacy Contract 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.
2. Copy the Agreement PDF at the location accessible by the task server.
Important things to note for the metadata file:
To create a metadata file for ICMLegacyContract Contract Type:
1. Create an Excel file with .xlsx extension and save it with the appropriate name, for example ICMLegacy_Contract_single .
2. 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 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.
3. 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.
The following screenshots are of the same metadata file ICMLegacy_Contract_single, broken down into 2 images to capture all the columns:
You can add Team members, Notes, and Commitments along with the legacy Agreements from within the same metadata file.
Edit the same Agreements metadata file ICMLegacy_Contract_single to add more sheets for Team, Notes, and Commitments.
1. Add a sheet and name it as AgreementTeamMember.
2. Edit the sheet to create columns as below and provide their values as appropriate:
The following screenshot of the ICMLegacy_Contract_single shows the Team sheet and the columns.
To create the Notes metadata:
1. Add a sheet and name it as AgreementNote.
2. Edit the sheet to create columns as below and provide their values as appropriate:
The following screenshot of the ICMLegacy_Contract_single shows the Note sheet and the columns.
1. Add a sheet and name it as AgreementCommitment.
2. Edit the sheet to create columns as below and provide their values as appropriate:
3. Create an additional column named Parent_FK and provide the value of the Primary Key (Legacy Ref Id) of the parent Agreement.
The following screenshot of the ICMLegacy_Contract_single shows the Commitment sheet and the data.
Important things to note for the mapping file:
To create a mapping file:
1.Create an Excel file with .xlsx extension and save it with the name, Mappings_Acme_agreements.
2.Edit the file to create columns and provide their details/values as specified below:
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.
To upload the Legacy Agreements:
1.Click the User Administration tile on the Dashboard.
2.Click the Admin Task tile.
3.Click Legacy Upload.
4.Click Add Batch and provide details of the batch on the next screen that opens.
Select Defer Workflow checkbox only if you need to add any pre-requisite Associations for the Legacy Agreement. See uploading Agreements with mandatory Associations.
5. Click Upload Integration Files icon and provide the details of the mapping file on the next screen that opens.
6. Click Upload to upload the mapping file.
7. 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.
8. Click Upload to upload the metadata file.
9. After the metadata file is successfully uploaded, click New Validate and Initiate icon to validate the data and initiate the batch upload.
A window opens showing the status of validation, and count or summary of errors or warnings, if any.
Legacy Upload tool validates whether the type of paper is Third Party or Own. If the Type of Paper is Third Party, ICM will validate if the uploaded document is in .pdf format. If you upload a document in .docx format, Legacy Upload tool the batch validation process fails and the error messages are captured in the error file.
The message in the above screen is interpreted as one agreement record is successfully validated for ICMLegacyContract Contract Type.
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.
The following screenshot, broken down in 2 images, is of the same screen that displays overall status and progress of the batches.
Click the batch name on 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.
You can view the error details by clicking the error message on the Batch Activity Logs window.
When the batch processing is complete a third icon called Download Integration Files appears under the Actions column.
Click 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.
In the following screenshot, the Status File shows that there were no errors or warnings for AcmeCorplegacyagreements batch that was uploaded.
To view the uploaded Agreements in ICM, go to Agreement Management in ICM and Click View Record icon to open the recently added legacy Agreement.
If you have added any Notes, Team, or Commitments, they will be displayed under the respective tabs in the Agreement Summary.
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.
Whether an Association is mandatory or not can be seen in ICM in the following 2 ways:
If Is Mandatory flag is set to Yes while adding an Association for a particular Agreement Contract Type, an Association is mandatory.
1. Follow the same steps to create metadata and mapping file for the Agreement as described in the Uploading Agreements section.
2. 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.
4. Initiate the batch processing by clicking New Validate and Initiate icon.
5. 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.
6. Follow the steps to upload the required Associations as described in the relevant section.
7. 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.
Before uploading the Associations, the parent Agreement must be uploaded first.
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.
There can be 2 scenarios for uploading Associations: With Workflow and Without Workflow.
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.
To create the metadata file for ICMLegacyAssocDocWF1 Contract Type:
1. Create an Excel file with .xlsx extension and save it with the name ICMLegacy_AcmeAssociation.
2. 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.
3. 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).
The following screenshot of the Association’s metadata file ICMLegacy_AcmeAssociation shows the attributes and highlights the Primary Key of the parent Agreement.
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.
Add another row as highlighted in the above screenshot:
Follow the same steps on the UI for uploading the associations as they are for uploading the agreements.
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.
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.
1. Create the metadata file for an Association as described in the respective section.
2. 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.
3. Proceed to upload the mapping file and metadata file.
4. Initiate the batch processing by clicking New Initiate and Validate icon.
5. After the batch processing is successful and the data is uploaded, the Status of the batch shows as Completed, WF Deferred.
6. Then you can click on the Enable Workflow icon anytime to attach the approval workflow. See the screenshot below:
The process to upload the Amendments for an Agreement is the same as for uploading the Associations.
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.
To create the metadata file for ICMLegacyContractAmendment Contract Type:
1. Create an Excel file with .xlsx extension and save it with the name – ICMLegacy_AcmeAmendment.
2. Edit the same file to create columns that are essentially the ICM attributes for ICMLegacyContract (parent) Contract Type, and enter their values as required.
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.
3. Ensure that the Amendment has a unique Primary Key. If not, create it as an ICM attribute (for example, Legacy Ref Id).
4. 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).
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.
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.
Add another row as described below:
Follow the same steps on the UI for uploading the associations as they are for uploading the agreements.
Only, ensure that you select the Amendment Contract Type while creating the batch. In the current example, select the Contract Type Name as ICMLegacyContractAmendment.
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.
There can be 2 scenarios for uploading Masterdata – With Workflow and Without Workflow.
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.
To create the metadata file for ICMLegacyMasterData Contract Type:
1. Create an Excel file with .xlsx extension and save it with the name ICMLegacy_AcmeMasterdata.
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.
Follow the same steps on the UI for uploading the Masterdata as they are for uploading the agreements.
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.
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.
1. Create the metadata file for the Masterdata as described in the respective section.
2. 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.
3. Proceed to upload the metadata file.
4. Initiate the batch processing by clicking New Initiate and Validate icon.
5. After the batch processing is successful and the data is uploaded, the Status of the batch shows as Completed, WFDeffered.
6. Then you can click on the Enable Workflow icon anytime to attach the approval workflow.
When the Masterdata uploaded without workflow is viewed in ICM, it will not have any buttons visible on the UI.
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.
You can also upload additional user information by uploading a separate metadata file with the relevant data, after a user is provisioned.
To create the metadata file for UserInformation Contract Type:
1. Create an Excel file with .xlsx extension and save it with the name ICMLegacy_AcmeUserInformation .
2. Edit the same file to create columns as below:
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.
Ensure that you select the UserInformation Contract Type while creating the batch.
The relevant Contract Type needs to be created in ICM. For the current example, create a Contract Type named ExtendedUserInformation with the required attributes.
To create the metadata file for ExtendedUserInformation Contract Type:
1. Create an Excel file with .xlsx extension and save it with the name – ICMLegacy_AcmeExtendedUserInfo.
2. Edit the same file to create columns as below:
3. 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.
When validating the batch, it displayed Object Reference 'not set to an instance of an object error message.
When uploading the data file and mappping file and creating a batch, if the type of paper is Third Party, ICM validates whether the document is .docx or .pdf format. Uploading a document in .docx format does not display the document preview correctly.
Related Topics: Agreement Management | Managing Organization | Managing Users | Managing User Groups | Managing Security Groups | Application Settings | Notification Settings | Currencies | Reasons | Deleting an Agreement | Search Sync |
You do not have permission to edit this page, for the following reason:
The action you have requested is limited to users in one of the groups: Users, User.
You can view and copy the source of this page:
Return to Legacy Upload.