10Migrating Concatenated Fields

Migrating Concatenated Fields

This chapter describes how to migrate concatenated fields using the Oracle Migration Tool On Demand client. It contains the following topics:

Concatenated Fields

Concatenated fields allow you to create a field that can display the values from multiple fields and can also display text.

The following table describes the Oracle Migration Tool On Demand client commands used with concatenated fields. For more information about running these commands, see Migrating Concatenated Fields.

Table Commands Used with Concatenated Fields in Oracle Migration Tool On Demand

Command Description

Read ConcatenatedField SystemNameOfObject

This command exports all concatenated fields for a specific record type (object).

SystemNameOfObject is the system name of the record type. The system names for the record types are listed in System Names for Record Types.

ReadAll ConcatenatedField

This command exports all concatenated fields for all objects.

Upsert ConcatenatedField ConcatenatedFieldXML

This command updates or inserts a concatenated field, as required.

Privileges Required for Migrating Concatenated Fields

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.

  • For the Upsert and Create commands: Enable Web Services Access, Customize Application, and Manage Object Access for custom objects that have been set up in the company tenant, for example, Customize Application - Manage Custom Object 01, and so on.

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

Elements and Sections in the Concatenated Fields XML Output File

The following table describes the elements and sections in the concatenated fields XML output file.

Table Elements and Sections in the Concatenated Fields XML File

Description Element or Section

<ObjectName> contains the system name of the record type (object), which never changes.

<data:ObjectName>Account</data:ObjectName>

The <ListOfConcatenatedFields> section contains details of the concatenated fields.

<data:ListOfConcatenatedFields>
. . .
</data:ListOfConcatenatedFields

The <ConcatenatedField> section contains details of one concatenated field.

<data:ConcatenatedField>
. . .
</data:ConcatenatedField>

<Name> contains the system name of the concatenated field.

<data:ConcatenatedField>
  <data:Name>ConcatenatedField</data:Name>
. . .
</data:ConcatenatedField>

<IntegrationTag> contains the custom language-independent integration tag for the concatenated field.

<data:ConcatenatedField>
  <data:IntegrationTag>MyConcatenatedField
  </data:IntegrationTag>
. . .
</data:ConcatenatedField>

<DisplayText> contains the specification for the content of the concatenated field.

<data:ConcatenatedField>
  <data:DisplayText>MyDisplayText</data:DisplayText>
. . .
</data:ConcatenatedField>

The <ListOfConcatenatedFieldTranslations> section contains the translation values for the concatenated field.

<data:ConcatenatedField>
  <data:ListOfConcatenatedFieldTranslations>
. . .
  </data:ListOfConcatenatedFieldTranslations>
. . .
</data:ConcatenatedField>

The <ConcatenatedFieldTranslation> section contains the translation values for one language.

  • <DisplayName> contains the name for the concatenated field in the language identified by the language code.

  • <DisplayText> contains the specification for the content of the concatenated field, with the text that appears in the field in the language identified by the language code.

  • <LangCode> contains the three-letter code for the language. For the list of language codes, see Language Codes and Their Corresponding Language and Country.

<data:ConcatenatedField>
  <data:ListOfConcatenatedFieldTranslations>
    <data:ConcatenatedFieldTranslation>
      <data:DisplayName>MyConcatenatedField
      </data:DisplayName> 
      <data:DisplayText>Field 1 Field 2.
      </data:DisplayText> 
      <data:LangCode>ENU</data:LangCode> 
    </data:ConcatenatedFieldTranslation> 
. . .
  </data:ListOfConcatenatedFieldTranslations>
. . .
</data:ConcatenatedField>

Migrating Concatenated Fields

The following topics provide examples of how to use the Oracle Migration Tool On Demand client to migrate concatenating fields:

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

    Extracting Concatenated Fields for a Single Object

    This topic describes how to extract the concatenated fields for a single object (for example, the Account object) from your Oracle CRM On Demand server for your environment (customer test environment or production).

    Syntax

    The following is the syntax for using the Oracle Migration Tool On Demand client to extract the concatenated fields for a single object:

    migrationtool -u UserID -s ServerURL Read ConcatenatedField SystemNameOfObject 
    

    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.

    • SystemNameOfObject is the system name of the object (record type) for which you want to extract all concatenated fields, for example, Account. The system names for the record types are listed in System Names for Record Types.

    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 Concatenated Fields for a Single Object

    The following is an example of extracting the concatenated fields for an object:

    migrationtool -u UserID -s ServerURL Read ConcatenatedField Account
    
    Note: If the object name contains spaces, then it must be enclosed with quotation marks.

      Extracting Concatenated Fields for All Objects

      This topic describes how to extract all concatenated fields from your Oracle CRM On Demand environment (customer test environment or production) for all objects.

      Syntax

      The following is the syntax for using the Oracle Migration Tool On Demand client to extract all concatenated fields for all objects:

      migrationtool -u UserID -s ServerURL ReadAll ConcatenatedField 
      

      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.

      Example of Extracting All Concatenated Fields

      The following is an example of extracting all concatenated fields from your Oracle CRM On Demand server:

      migrationtool -u UserID -s ServerURL ReadAll ConcatenatedField
      

        Updating or Inserting Concatenated Fields (Upsert)

        This topic describes how to update concatenated fields (if they exist) or insert concatenated fields (if they do not exist) on your Oracle CRM On Demand environment (customer test environment or production).

        Syntax

        The following is the syntax for using the Oracle Migration Tool On Demand client to update concatenated fields (if they exist) or insert concatenated fields (if they do not exist):

        migrationtool -u UserID -s ServerURL Upsert ConcatenatedField ConcatenatedFieldXML

        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.

        • ConcatenatedFieldXML is the fully qualified path name of the concatenated field XML file, for example:

          C:\My Files\MyConcatenatedField.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 Concatenated Fields

        The following is an example of updating concatenated fields (if they exist) or inserting concatenated fields (if they do not exist) in your Oracle CRM On Demand server:

        migrationtool -u UserID -s ServerURL Upsert ConcatenatedField "C:\My Files\MyConcatenatedField.xml"
        
        Note: Quotation marks are required only if the name contains spaces.