32Migrating Lead Conversion Mapping Data

Migrating Lead Conversion Mapping Data

This chapter describes how to migrate lead conversion mapping data using the command-line interface of the Oracle Migration Tool On Demand client. It contains the following topics:

Lead Conversion Mapping Data

Users at your company can convert lead records to account, contact, and opportunity records. If your company is set up to use Oracle CRM On Demand Partner Relationship Management Edition, users can also convert lead records to deal registration records. In the standard application, some information from the lead record is carried over to the relevant fields in the account, contact, opportunity, and deal registration records that are created or linked to the lead during the conversion process. You can determine what information is carried over by configuring the mappings between the fields on the Lead record type and the Account, Contact, Deal Registration, and Opportunity record types.

The following table describes the Oracle Migration Tool On Demand client commands used with lead conversion mapping data.

Command Description

Read LeadConversionMapping LeadFieldName

This command exports the lead conversion mapping data for a single field on the Lead record type. LeadFieldName is the system name of the lead field for which you want to export the lead conversion mapping data.

ReadAll LeadConversionMapping

This command exports the lead conversion mapping data for all of the fields on the Lead record type.

Upsert LeadConversionMapping LeadConversionMappingXML

This command updates or inserts the lead conversion mapping data specified in the XML file.

Privileges Required for Migrating Lead Conversion Mapping Data

The following privileges are required for the user account running the Oracle Migration Tool On Demand client commands:

  • For the Read and ReadAll commands: Enable Web Services Access, and Data Rules and Assignment. To extract mappings for the Deal Registration record type, the Manage PRM Access privilege is also required.

  • For the Upsert command: Enable Web Services Access, and Data Rules and Assignment. To insert or update mappings for the Deal Registration record type, the Manage PRM Access privilege is also required.

For information about setting and checking privileges, see Oracle CRM On Demand Online Help.

Elements and Sections in the Lead Conversion Mapping XML Output File

The following table describes the elements and sections in the lead conversion mapping XML output file.

Table Elements and Sections in the Lead Conversion Mapping XML File

Description Element or Section

The <FieldMapping> section contains the details of the mappings for a single field on the Lead record type.

<data:FieldMapping>
. . .
</data:FieldMapping>

<LeadFieldName> contains the system name of a field on the Lead record type.

<data:FieldMapping>
  <data:LeadFieldName>TEXTSM_001</data:LeadFieldName>
. . .
</data:FieldMapping>

<ContactFieldName> contains the system name of the field on the Contact record type that the field on the Lead record type is mapped to, if a mapping exists.

<data:FieldMapping>
. . .
  <data:ContactFieldName>TEXTSM_001</data:ContactFieldName>
. . .
</data:FieldMapping>

<OpportunityFieldName> contains the system name of the field on the Opportunity record type that the field on the Lead record type is mapped to, if a mapping exists.

<data:FieldMapping>
. . .
  <data:OpportunityFieldName>TEXTSM_001</data:OpportunityFieldName>
. . .
</data:FieldMapping>

<AccountFieldName> contains the system name of the field on the Account record type that the field on the Lead record type is mapped tp, if a mapping exists.

<data:FieldMapping>
. . .
  <data:AccountFieldName>TEXTSM_01</data:AccountFieldName>
</data:FieldMapping>

<DealRegistrationFieldName> contains the system name of the field on the Deal Registration record type that the field on the Lead record type is mapped to, if a mapping exists.

<data:FieldMapping>
. . .
  <data:DealRegistrationFieldName>TEXTSM_01</data:DealRegistrationFieldName>
</data:FieldMapping>

Migrating Lead Conversion Mapping Data

The following topics describe how to use the Oracle Migration Tool On Demand client to migrate lead conversion mapping data:

Note: Back up your configuration data and all other relevant data before running the Oracle Migration Tool On Demand client.

Extracting Lead Conversion Mapping Data for a Single Field

This topic describes how to extract the lead conversion mappings for a single field on the Lead record type from your Oracle CRM On Demand environment. To extract mappings for the Deal Registration record type, the Manage PRM Access privilege is also required.

Syntax

The following is the syntax for using the Oracle Migration Tool On Demand client to extract the lead conversion mappings for a single field on the Lead record type:

migrationtool -u UserID -s ServerURL Read LeadConversionMapping LeadFieldName

where:

  • UserID is the user sign-in ID that has the appropriate privileges to run the Oracle Migration Tool On Demand client commands.

  • ServerURL is the URL for the Oracle CRM On Demand server where your company resides.

  • LeadFieldName is the system name of the field on the Lead record type.

The output XML file is named with the name of the field on the Lead record type.

Note: The Oracle Migration Tool On Demand client requests your Oracle CRM On Demand password, which can be redirected (using the pipe command) to the client program from standard input; that is, from a file, from the command line, or from another program.

Example of Extracting the Lead Conversion Mapping Data for a Single Field on the Lead Record Type

The following is an example of extracting the lead conversion mappings for the Email field on the Lead record type.

migrationtool -u UserID -s ServerURL Read LeadConversionMapping Email
Note: If the name of the field contains spaces, then it must be enclosed with quotation marks.

Extracting All Lead Conversion Mapping Data

This topic describes how to extract the lead conversion mappings between the fields on the Lead record type and the fields on the Account, Contact, Deal Registration, and Opportunity record types from your Oracle CRM On Demand environment.

Syntax

The following is the syntax for using the Oracle Migration Tool On Demand client to extract all of the lead conversion mappings between the fields on the Lead record type and the fields on the Account, Contact, Deal Registration, and Opportunity record types:

migrationtool -u UserID -s ServerURL ReadAll LeadConversionMapping

where:

  • UserID is the user sign-in ID that has the appropriate privileges to run the Oracle Migration Tool On Demand client commands.

  • ServerURL is the URL for the Oracle CRM On Demand server where your company resides.

Each of the output XML files is named with the name of the field on the Lead record type. If no mapping exists for a field on the Lead record type, then no data is extracted for that field.

Note: The Oracle Migration Tool On Demand client requests your Oracle CRM On Demand password, which can be redirected (using the pipe command) to the client program from standard input; that is, from a file, from the command line, or from another program.

Updating or Inserting Lead Conversion Mapping Data

This topic describes how to update the lead conversion mappings between one or more fields on the Lead record type and the fields on another record type (if any mappings exist) or insert the lead conversion mappings (if none exist) on your Oracle CRM On Demand environment (customer test environment or production).

About the Upsert Operation

The Upsert command inserts or updates lead conversion mappings based on the user key: Field Name.

Oracle CRM On Demand attempts to locate the lead conversion mappings specified in the input file based on the user key. If a match is located, then the lead conversion mappings are updated. If the system name is blank for a field on a record type (for example, the Contact record type) in the XML input file, and if the field on the Lead record type was previously mapped to a field on that record type, then the mapping is deleted. If Oracle CRM On Demand cannot locate any existing mapping for the field on the Lead record type, then the mapping is created for the first time.

Syntax

The following is the syntax for using the Oracle Migration Tool On Demand client to insert or update lead conversion mappings:

migrationtool -u UserID -s ServerURL Upsert LeadConversionMapping LeadConversionMappingXML

where:

  • UserID is the user sign-in ID that has the appropriate privileges to run the Oracle Migration Tool On Demand client commands.

  • ServerURL is the URL for the Oracle CRM On Demand server where your company resides.

  • LeadConversionMappingXML is the fully qualified path name of the lead conversion mappings XML file, for example:

    C:\My Files\Date of Birth.xml
    

    If the fully qualified path name contains any spaces, then it must be enclosed with quotation marks, for example:

    migrationtool -u UserID -s ServerURL Upsert LeadConversionMapping "C:\My Files\Date of Birth.xml"
    
Note: The Oracle Migration Tool On Demand client requests your Oracle CRM On Demand password, which can be redirected (using the pipe command) to the client program from standard input; that is, from a file, from the command line, or from another program.

Example of Updating or Inserting Lead Conversion Mapping Data

The following is an example of updating lead conversion mappings (if any exist) or inserting the lead conversion mapping data (if none exist) in your Oracle CRM On Demand server:

migrationtool -u UserID -s ServerURL Upsert LeadConversionMapping "C:\Oracle Migration Tool On Demand\windows\repository\LeadConversionMapping\Company.xml"
Note: Quotation marks are required only if the fully qualified path name contains spaces.