Revision as of 08:52, 13 September 2019

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 :

Uploading Agreements, Teams, Notes and Commitments in bulk.
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.
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:

Agreements
Amendments
Associated Documents (with or without workflow)
Masterdata (with or without workflow)
Team, Notes, and Commitment
User details

Important Considerations

Only an Administrator can perform 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 ICM instance. This must be ensured while configuring the ICM instance.
The mapping and data files created in Excel can only have an .xlsx extension.
For Agreements, only PDF files are supported. For Associations, several file formats such as Pdf, docx, doc, xls, jpeg, png, zip are supported.
Contract 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.

Viewing Legacy Upload Dashboard

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.

Uploading Agreements

This section demonstrates with an example how to upload plain Agreements for a particular Contract Type.

Searching or Creating a Contract Type for the Agreements with Workflow

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.

Creating a Metadata File for Agreements

Important things to note for the metadata file:

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.
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, and Type of Paper. Some of these may be backend attributes that are not visible on the UI.

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:

The following section describes the column names (ICM attributes) and their values provided in the data file:

Name: String data type, provide name of the Agreement. For example, Acme Corp Legacy Contract.
File Path: 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.
Legacy Ref Id: 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: 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.
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.
Signature Type: Choice data type, another choice for this example is Electronic Signature. For example, Manual Signature.
External Signatory: Email data type, enter valid email ID with FQDN only. For example,clmadmin@gmail.com.
Item List: 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, 5/9/2018.
Primary Owner Email : Email data type, enter valid email ID with FQDN only. For example, acmeadmin@acmecorp.com.
CompanyUrl: URL data type, enter a valid URL exactly in the same format as shown. For example, <a target="_blank"href="http://acmecorp.com/">http://acmecorp.com</a>.
Country Name :Lookup field, case-sensitive, enter the exact value. For example, USA.
Is Amendment: Boolean data type, values Yes/No. For example, No.
Is Assigned: Boolean data type, values Yes/No. For example, No.
Is Assignment: Boolean data type, values Yes/No. For example, No.
Is Termination: Boolean data type, values Yes/No. For example, No.
Type of Paper: Not visible on UI, value must always be Third Party, case-sensitive. For example, Third Party.
Business Status: Not visible on UI, value can optionally be Executed, case-sensitive. For example, Draft.

Uploading Agreements with Team, Notes and Commitments

You can add Team members, Notes, and Commitments along with the legacy Agreements from within the same metadata file.

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.

Creating a Metadata File with Team, Notes, and Commitments

Edit the same Agreements metadata file ICMLegacy_Contract_single to add more sheets for Team, Notes, and Commitments.

Note: The sheets always must be named and formatted (irrespective of the client instance environment) as specified in the respective steps below.

To create the Team metadata:

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:

Parent_FK: Provide the value of the Primary Key (Legacy Ref Id) of the Parent Agreement for which to add the team members.
User Name: String data type, enter a user's name
Reason Code: Numeric data type, enter a valid reason code that can be found under User Administration and then the Reasons tile. It is not a mandatory column.

The following screenshot of the ICMLegacy_Contract_single shows the Note sheet and the columns.

To create the Commitments metadata:

1. Add a sheet and name it as AgreementCommitment.

2. Edit the sheet to create columns as below and provide their values as appropriate:

LegacyUpload Create Commitments Metadata 1.PNG

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.

Creating a Mapping File

Important things to note for the mapping file:

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

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:

Mappings_Acme_agreements file created for ICMLegacyContract Contract Type.

In the above example,

C:\Integration is the UNCFolderpath where you uploaded the legacy agreement PDF
ICMLegacyContract is the Contract Type Name
ICMLegacyRefId under the Primary Key column is the unique attribute that you created in for ICMLegacyContract Contract Type
Data Processing allows you to configure the number of records that will be processed simultaneously. Degree of Parallelism (DOP) is the number of records to be processed simultaneously
Workflow processing allows you to configure the number of records that will be processed simultaneously

Uploading the Legacy Agreements

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.

Batch/API Name: Provide unique name for the Batch as AcmeCorp_legacy_agreements .
Integration Type: Select Legacy Contract Management.
Contract Type Name: Select the Contract Type as ICMLegacyContract.
Use mapping from: Select None since you are uploading a new mapping file.
Optionally, select from the list if using mappings from any previously uploaded batch for ICMLegacyContract Contract Type.
Defer Workflow: Leave this checkbox unselected for the current example.

Select Defer Workflow checkbox only if you need to add any pre-requisite Associations for the Legacy Agreement. See uploading Agreements with mandatory Associations.

A row with your newly created batch will be added to the list with Draft status.

5. Click Upload Integration Files icon and provide the details of the mapping file on the next screen that opens.

File Type: Select MappingFile option from the drop-down.
File Path: Click Choose File to browse and select the mappings file Mappings_Acme_agreements that was created earlier.

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.

File Type: Select DataFile option from the drop-down.
File Path: Click Choose File to browse and select the metadata file ICMLegacy_Contract_single that was created earlier.

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.

Some of the columns in the screen are explained below:

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.

Viewing the Batch Activity Log

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.

Viewing the status and error files

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.

Viewing the uploaded Agreements in ICM

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.

Uploading Agreements with mandatory Associations

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.

If Prerequisite or Postrequisite is selected in the Constraints drop-down list while creating an Associated Document Contract Type, an Association is mandatory.

To upload Agreements that require mandatory Associations:

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.

3. Proceed with uploading the mapping and metadata files.

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.

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.

Uploading Associations

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.

Searching or Creating a Contract Type for Associations with 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.

In this example, we have an Associated Document Contract Type named as LegacyAssocDocWF1 with the attributes as can be seen under the Selected Attribute tab. The ICM name for this Contract Type is ICMLegacyAssocDocWF1.

Note: Ensure that the ICMLegacyAssocDocWF1 Contract Type has been added in the Associations tab in the parent Contract Type ICMLegacyContract.

Creating a Metadata File for Associations

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.

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.

Add another row as highlighted in the above screenshot:

ICMLegacyAssocDocWF1 is the Contract Type Name for the Associated Document Contract Type.
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).

Note: Ensure that the associated documents are also stored at the same UNCFolderPath location as the agreements.

Uploading the Associations and viewing in ICM

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.

LegacyUpload MappingFile WithAssociations1.png

The following screenshot shows the batch successfully uploaded, with the workflow attached and processed.

After the Associations are successfully uploaded, you can view them under the Associations tab in the previously uploaded Agreement.

Uploading Associations without Workflow

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.

LegacyUpload EnableApprovalWorkflow2.png

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.

To upload Associations without workflow:

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:

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:

Uploading Amendments

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.

Creating Metadata File for Amendments

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.

Note: Ensure that the amendment documents, if any, are also stored at the same UNCFolderPath location as the Agreements.

Making changes to the mapping file for Amendments

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:

ICMLegacyContractAmendment is the Contract Type Name for the Amendment.
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

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.

After the Amendments are successfully uploaded, you can view them under the Amendments tab in the previously uploaded parent Agreement.

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.
There can be 2 scenarios for uploading Masterdata – With Workflow and Without Workflow.

Searching or Creating a Contract Type for the Masterdata with 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.

In this example, we have a Masterdata Contract Type named as Acme Legacy Master Data with the attributes as can be seen under the Selected Attribute tab. The ICM name for this Contract Type is ICMLegacyMasterData.

Creating Metadata file for Masterdata

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.

Uploading Masterdata

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.

After the Masterdata is successfully uploaded, you can view them under the Masterdata tile on Configuration page.

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.

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.

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.

User Provisioning

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.

Creating Metadata file for User Information

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:

Uploading the User Information

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.

Then upload the metadata file ICMLegacy_AcmeUserInformation.

Click on New Validate and Initiate icons to validate the data and schedule the batch for processing.
After the user information is successfully uploaded, you can view it under the Users tab in User Administration.

Creating Metadata File for extended user information

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.

Error Handling

When validating the batch, it displayed Object Reference 'not set to an instance of an object error message.

Limitations

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.

@@ Line 36: / Line 36: @@
 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 ''Failed Count'' column. Hovering over the Failed Co… on the ''Legacy Upload'' page, is displayed as ''Failed Count''.&nbsp;After the batch is uploaded, '''click '''the ''Batch Name ''to view the history of the processes performed on a particular batch.
-<div class="image-green-border">[[File:Legacy Upload-Dashboard-7.8.png|RTENOTITLE]]</div>
+<div class="image-green-border">[[File:Legacy Upload-Dashboard-7.8.png|720px|RTENOTITLE]]</div>
 == Uploading Agreements&nbsp; ==
@@ Line 46: / Line 46: @@
 .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.
-<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>
+<div class="image-green-border">[[File:CreateContractType LegacyUpload C7SP6.png|560px|LegacyUpload_CreateContractType.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:LegacyUpload Create Attribute.png|720px|LegacyUpload Create Attribute.png]]</div>
 . Copy the Agreement PDF at the location accessible by the task server.
@@ Line 65: / Line 65: @@
 The following screenshots are&nbsp;of the same metadata file&nbsp;ICMLegacy_Contract_single, broken down into 2 images to capture all the columns:
-<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>
+<div class="image-green-border">[[File:SP6 LegacyUpload Metadata 1.png|720px|LegacyUpload Metadata 1.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SP6 LegacyUpload Metadata 2.png|720px|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;
@@ Line 92: / Line 92: @@
 Edit the same Agreements metadata file ICMLegacy_Contract_single to add more sheets for Team, Notes, and Commitments.
-<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>
+<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|720px|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>
+<div class="image-green-border">[[File:SP6 LegacyUpload Create Team Metadata.PNG|360px|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>
+<div class="image-green-border">[[File:SP6 LegacyUpload Create Team Metadata 1.PNG|720px|LegacyUpload_Create_Team_Metadata]]</div>
 '''To create the Notes metadata:'''
@@ Line 110: / Line 110: @@
 The following screenshot of the ''ICMLegacy_Contract_single'' shows the Note sheet and the columns.
-<div class="image-green-border">[[File:Legacy Upload CreateNoteMetadata-7.8.png|RTENOTITLE]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">'''To create the Commitments metadata:'''</div>
+<div class="image-green-border">[[File:Legacy Upload CreateNoteMetadata-7.8.png|360px|RTENOTITLE]]</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;
-<div class="image-green-border">[[File:SP6 LegacyUpload Create Commitments Metadata 1.PNG|LegacyUpload Create Commitments Metadata 1.PNG]]</div>
+<div class="image-green-border">[[File:SP6 LegacyUpload Create Commitments Metadata 1.PNG|360px|LegacyUpload Create Commitments Metadata 1.PNG]]</div>
 . Create an additional column named Parent_FK and provide the value of the Primary Key (Legacy Ref Id) of the parent Agreement.&nbsp;
 The following screenshot of&nbsp;the ''ICMLegacy_Contract_single'' shows the Commitment sheet and the data.
-<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">[[File:SP6 LegacyUpload Create Commitments Metadata 2.PNG|720px|LegacyUpload Create Commitments Metadata 2.PNG]]</div>
 === Creating a&nbsp;Mapping File ===
@@ Line 131: / Line 131: @@
 ''2.Edit the file to create columns and provide their details/values as specified below:''
-<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:LegacyUpload Create MappingFile 7.8.png|RTENOTITLE]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">In the above example,&nbsp;</div>
+<div class="image-green-border">[[File:SP6 LegacyUpload CreateMappingFile1.PNG|360px|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:LegacyUpload Create MappingFile 7.8.png|720px|RTENOTITLE]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">In the above example,&nbsp;</div>
 *''C:\Integration'' is the UNCFolderpath where you uploaded the legacy agreement PDF
 *''ICMLegacyContract'' is the Contract Type Name
@@ Line 149: / Line 149: @@
 .'''Click&nbsp;'''''Legacy Upload.''
-<div class="image-green-border">''[[File:SP6 LegacyUpload.png|LegacyUpload.png]]''</div>
+<div class="image-green-border">''[[File:SP6 LegacyUpload.png|360px|LegacyUpload.png]]''</div>
 .'''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:Legacy Upload-7.8-Add Batch1.png|RTENOTITLE]]</div>
+<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:Legacy Upload-7.8-Add Batch1.png|360px|RTENOTITLE]]</div>
 *'''Batch/API Name''':&nbsp;Provide unique name for the Batch as ''AcmeCorp_legacy_agreements .''
 *'''Integration Type''': '''Select&nbsp;'''''Legacy Contract Management.&nbsp;''
@@ Line 162: / Line 162: @@
 *A row with your newly created batch will be added to the list with ''Draft'' status.
-<div class="image-green-border">[[File:SP6 LegacyUpload Batch Upload.png|LegacyUpload Batch Upload.png]]</div>
+<div class="image-green-border">[[File:SP6 LegacyUpload Batch Upload.png|720px|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>
+<div class="image-green-border">[[File:SP6 LegacyUpload UploadIntegrationFiles.png|360px|LegacyUpload UploadIntegrationFiles.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SP6 LegacyUpload UploadIntegrationFiles 1.png|360px|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;
@@ Line 171: / Line 171: @@
 . 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''.
-<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>
+<div class="image-green-border">[[File:SP6 LegacyUpload UploadIntegrationFiles.png|360px|LegacyUpload UploadIntegrationFiles.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SP6 LegacyUpload UploadIntegrationFiles 2.png|360px|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.
@@ Line 178: / Line 178: @@
 . After the metadata file is successfully uploaded, '''click''' ''New Validate and Initiate'' icon to validate the data and initiate the batch upload.
-<div class="image-green-border">[[File:SP6 LegacyUpload NewValidateand Initiate.png|LegacyUpload NewValidateand Initiate.png]]</div>
+<div class="image-green-border">[[File:SP6 LegacyUpload NewValidateand Initiate.png|360px|LegacyUpload NewValidateand Initiate.png]]</div>
 A&nbsp;window opens showing the status of validation, and count or summary of errors or warnings, if any.
 *&nbsp;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.&nbsp; 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.
+<div class="image-green-border">[[File:SP6 LegacyUpload ScheduleBatch.png|360px|LegacyUpload ScheduleBatch.png]]</div>
-&nbsp;
-<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> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">
+<div class="image-green-border">[[File:SP6 LegacyUpload ViewBatchProgress.png|720px|LegacyUpload ViewBatchProgress.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SP6 LegacyUpload ViewBatchProgress1.png|720px|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|360px|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|720px|LegacyUpload_ViewBatchProgress3]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">
 === Viewing the Batch Activity Log ===
@@ Line 193: / Line 191: @@
 You can view the error details by clicking the error message on the ''Batch Activity Logs ''window.
-[[File:Legacy Upload-7.8-BatchActivityLogs.png|RTENOTITLE]]
+[[File:Legacy Upload-7.8-BatchActivityLogs.png|720px|RTENOTITLE]]
 &nbsp;
@@ Line 204: / Line 202: @@
 In the following screenshot, the Status File shows that there were no errors or warnings for ''AcmeCorplegacyagreements'' batch that was uploaded.
-<div class="image-green-border">[[File:SP6 LegacyUpload ViewStatus and ErrorFiles.png|LegacyUpload_ViewStatus_and_ErrorFiles]]</div>
+<div class="image-green-border">[[File:SP6 LegacyUpload ViewStatus and ErrorFiles.png|720px|LegacyUpload_ViewStatus_and_ErrorFiles]]</div>
 === Viewing the uploaded Agreements in ICM ===
 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.<br/> If you have added any Notes, Team, or Commitments, they will be displayed under the respective tabs in the Agreement Summary.
-<div class="image-green-border">[[File:SP6 LegacyUpload View Uploaded Agreement.png|LegacyUpload_View_Uploaded_Agreement]]</div>
+<div class="image-green-border">[[File:SP6 LegacyUpload View Uploaded Agreement.png|720px|LegacyUpload_View_Uploaded_Agreement]]</div>
 === Uploading Agreements with mandatory Associations ===
 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.&nbsp;
-<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.</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>
+<div class="image-green-border">[[File:SP6 LegacyUpload Upload Agreement with MandatoryAssociation.png|720px|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.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SP6 LegacyUpload Upload Agreement with MandatoryAssociation Prerequisites.png|360px|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.
@@ Line 224: / Line 222: @@
 . 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;
-<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>
+<div class="image-green-border">[[File:SP6 LegacyUpload EnableWorkflow.png|720px|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>
 == Uploading Associations&nbsp; ==
@@ Line 232: / Line 230: @@
 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.
-<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>
+<div class="image-green-border">[[File:SP6 LegacyUpload EnableApprovalWorkflow.png|560px|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|560px|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; ===
@@ Line 244: / Line 242: @@
 The following screenshot of the Association’s metadata file ''ICMLegacy_AcmeAssociation'' shows the attributes and highlights the Primary Key of the parent Agreement.
-<div class="image-green-border">[[File:SP6 LegacyUpload Create Metadata file for Associations.png|LegacyUpload Create Metadata file for Associations.png]]</div>
+<div class="image-green-border">[[File:SP6 LegacyUpload Create Metadata file for Associations.png|720px|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.
-<div class="image-green-border">[[File:SP6 LegacyUpload MappingFile WithAssociations.png|LegacyUpload MappingFile WithAssociations.png]]</div>
+<div class="image-green-border">[[File:SP6 LegacyUpload MappingFile WithAssociations.png|720px|LegacyUpload MappingFile WithAssociations.png]]</div>
 Add another row as highlighted in the above screenshot:
@@ Line 261: / Line 259: @@
 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''.
-<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>
+<div class="image-green-border">[[File:SP6 LegacyUpload MappingFile WithAssociations1.png|560px|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|720px|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|720px|LegacyUpload Assocations.png]]</div>
 === Uploading Associations without Workflow&nbsp; ===
 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.
-<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">&nbsp;</div> <div class="image-green-border">'''To upload Associations without workflow:'''</div>
+<div class="image-green-border">[[File:SP6 LegacyUpload EnableApprovalWorkflow2.png|720px|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">&nbsp;</div> <div class="image-green-border">'''To upload Associations without workflow:'''</div>
 . Create the metadata file for an Association as described in the respective section.&nbsp;
@@ Line 277: / Line 275: @@
 . Then you can click on the Enable Workflow icon anytime to attach the approval workflow. See the screenshot below:
-<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">[[File:SP6 LegacyUpload EnableWorkflow.png|720px|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|720px|LegacyUpload Assocations without workflow.png]]</div>
 == Uploading Amendments ==
@@ Line 297: / Line 295: @@
 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.
-<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:SP6 LegacyUpload Create Metadata file for Amendments.png|720px|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>
 === Making changes to the mapping file for Amendments&nbsp; ===
@@ Line 310: / Line 308: @@
 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''.
-<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>
+<div class="image-green-border">[[File:SP6 LegacyUpload UploadAmendments.png|360px|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 ==
@@ Line 318: / Line 316: @@
 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.
-<div class="image-green-border">[[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>
+<div class="image-green-border">[[File:SP6 LegacyUpload Create Masterdata.png|560px|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|720px|LegacyUpload Create Masterdata 1.png]]</div> <div class="image-green-border">&nbsp;</div>
 === Creating &nbsp;Metadata file for Masterdata ===
@@ Line 326: / Line 324: @@
 &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.
-<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">[[File:SP6 LegacyUpload Create MetadataFile for Masterdata.png|720px|LegacyUpload Create MetadataFile for Masterdata.png]]</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''.
-<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">[[File:SP6 LegacyUpload Upload Masterdata.png|360px|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|560px|LegacyUpload Upload Masterdata 1.png]]</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.
-<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>
+<div class="image-green-border">[[File:SP6 LegacyUpload Upload Masterdata.png|360px|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;
@@ Line 360: / Line 358: @@
 . Edit the same file to create columns as below:
-<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">[[File:LegacyUpload CreateMetadata File for UserInformation.png|360px|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|720px|LegacyUpload CreateMetadata File for UserInformation1.png]]</div>
 === Uploading the User Information ===
 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.
-<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">[[File:SP6 LegacyUpload Upload UserInformation.png|360px|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|360px|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|720px|LegacyUpload Upload UserInformation1.png]]</div>
 === Creating&nbsp;Metadata File for extended user information&nbsp; ===
@@ Line 372: / Line 370: @@
 . Edit the same file to create columns as below:&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>
+<div class="image-green-border">[[File:LegacyUpload CreateMetadata File for ExtendedUserInformation.PNG|360px|RTENOTITLE]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SP6 LegacyUpload CreateMetadata File for ExtendedUserInformation1.png|720px|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.
@@ Line 382: / Line 380: @@
 When uploading the data file and mappping file and creating a batch, if the type of paper is&nbsp;''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.&nbsp;
+&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]

Viewing Legacy Upload Dashboard[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 Batch Activity Log[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]

Error Handling [edit]

Limitations[edit]

Revision as of 08:52, 13 September 2019

Contents

Legacy Upload

Important Considerations

Viewing Legacy Upload Dashboard

Uploading Agreements

Searching or Creating a Contract Type for the Agreements with Workflow

Creating a Metadata File for Agreements

Uploading Agreements with Team, Notes and Commitments

Creating a Metadata File with Team, Notes, and Commitments

Creating a Mapping File

Uploading the Legacy Agreements

Viewing the Batch Activity Log

Viewing the status and error files

Viewing the uploaded Agreements in ICM

Uploading Agreements with mandatory Associations

Uploading Associations

Searching or Creating a Contract Type for Associations with Workflow

Creating a Metadata File for Associations

Making changes to the mapping file for Associations

Uploading the Associations and viewing in ICM

Uploading Associations without Workflow

Uploading Amendments

Creating Metadata File for Amendments

Making changes to the mapping file for Amendments

Uploading the Amendments and viewing in ICM

Uploading Masterdata

Searching or Creating a Contract Type for the Masterdata with workflow

Creating Metadata file for Masterdata

Uploading Masterdata

Uploading Masterdata without Workflow

User Provisioning

Creating Metadata file for User Information

Uploading the User Information

Creating Metadata File for extended user information

Error Handling

Limitations

Navigation menu

Search