1. Oracle Migration Tool On Demand Guide
  2. What's New in This Release

3Migrating Customized Record Types

Migrating Customized Record Types

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

Customized Record Types

You can customize record types by changing the display name and associated icons. These changes are reflected in most areas of the user interface. In the case of record types that support teams, you can also customize the record type to specify whether the previous owner of a record is retained in the team for the record after a new owner is assigned to the record.

The following table describes the Oracle Migration Tool On Demand client commands used with customized record types. For more information about running these commands, see Migrating Customized Record Types.

Table Oracle Migration Tool On Demand Commands for Customized Record Types

Command Description

Read CustomRecordType SystemNameOfObject

This command exports the configuration information for a customized 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 CustomRecordType

This command exports the configuration information for all customized record types.

Upsert CustomRecordType CustomizedRecordTypeXML

This command updates or inserts configuration information for a specified record type.
Note: Nonadministrative Oracle CRM On Demand users can run the Read and ReadAll commands.

Privileges Required for Migrating Customized Record Types

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

  • For the Read and ReadAll command: Enable Web Services Access.

  • For the Upsert command: 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 Customized Record Types XML Output File

The following table describes the elements and sections in the XML output file for customized record types.

Table Elements and Sections in the Customized Record Types XML File

Description Element or Section

<IncludeAll> specifies whether the preconfigured configuration information is returned in addition to the customized configuration information (true), or if only the customized configuration information is returned. The default setting is false.

 
<data:IncludeAll></data:IncludeAll>

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

 
<data:Name>Account</data:Name>

<SupportDisplayImage> corresponds to the Display Image check box in the UI, and is applicable for the Account, Contact, and Product record types only. It specifies whether an image can be displayed on the detail page for the record type (true) or an image cannot be displayed on the detail page for the record type.

 
<data:SupportDisplayImage></data:SupportDisplayImage>

<IconName> contains the file name of the classic theme icon used for the record type. For the list of available classic theme icon file names, see Classic Theme Icons. 

<data:IconName>1801.gif</data:IconName>

<ModernIconName> contains the file name of the modern theme icon used for the record type. For the list of available modern theme icon file names, see Modern Theme Icons. 

<data:ModernIconName>mod_servicehistory_25.png
</data:ModernIconName>

<AccessObjName> contains the access object name of the record type that is being referenced, for example, Account.

Note: This element is read-only. 
<data:AccessObjName>Account</data:AccessObjName>

<CustomizePreviousOwnerChannel> specifies the circumstances in which the previous owner of a record is retained in the team on the record after a new owner is assigned to the record. The possible values include:

  • Never Retain Owner. The default value. The previous owner of the record will not be retained in the team.

  • Always Retain Owner. The previous owner of the record will be retained in the team, except when the owner is changed using the assignment manager.

  • All Interactive Operations. The previous owner of the record will be retained in the team, except when the owner is changed using the Import Assistant, the assignment manager, the mass update feature, or Web services.

 
<data:CustomizePreviousOwnerChannel>
All Interactive Operations
</data:CustomizePreviousOwnerChannel>

<CustomizePreviousOwnerAccessProfileId> contains the ID of the access profile that is given to the previous owner for the record, if the previous owner is retained in the team after a new owner is assigned to the record.

 
<data:CustomizePreviousOwnerAccessProfileId>
1QA2-HRM9N
</data:CustomizePreviousOwnerAccessProfileId>

<CustomizePreviousOwnerAccessProfile> contains the name of the access profile that is given to the previous owner for the record, if the previous owner is retained in the team after a new owner is assigned to the record.

 
<data:CustomizePreviousOwnerAccessProfile>Full
</data:CustomizePreviousOwnerAccessProfile>

The <ListOfCustomRecordTypeTranslations> section contains the translation values for the record type.

 
<data:ListOfCustomRecordTypeTranslations>
. . . 
</data:ListOfCustomRecordTypeTranslations>

The <CustomRecordTypeTranslation> section contains the translation values for one language:

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

  • <SingularName> contains the singular name for the record type in the language identified by the language code.

  • <PluralName> contains the plural name for the record type in the language identified by the language code.

  • <ShortName> contains the short name for the record type in the language identified by the language code.

In this example, for English-American (ENU), the singular name is Account, the plural name is Accounts, and the short name is Acct.

The precedence for determining the display name is as follows:

  1. The translation definition, if it is defined.

  2. The corresponding name element (<SingularName>, <PluralName>, <ShortName>) for the record type, if it is defined and if the translation definition is not defined.

  3. The system name, if the translation definition and the corresponding name element for the record type are not defined.

 
<data:ListOfCustomRecordTypeTranslations>
  <data:CustomRecordTypeTranslation> 
    <data:LanguageCode>ENU</data:LanguageCode>
    <data:SingularName>Account</data:SingularName>
    <data:PluralName>Accounts</data:PluralName>
    <data:ShortName>Acct</data:ShortName>
  </data:CustomRecordTypeTranslation>
. . .
</data:ListOfCustomRecordTypeTranslations>

Migrating Customized Record Types

The following topics provide examples of how to use the Oracle Migration Tool On Demand client with customized record types:

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

    Extracting a Single Customized Record Type

    This topic describes how to extract a single customized record type 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 a single customized record type:

    migrationtool -u UserID -s ServerURL Read CustomRecordType 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) that you want to extract, 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 a Single Customized Record Type

    The following is an example of extracting the customized record type for which the system name is Account:

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

      Extracting All Customized Record Types

      This topic describes how to extract all customized record types from 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 extract all customized record types:

      migrationtool -u UserID -s ServerURL ReadAll CustomRecordType

      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.

      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 All Customized Record Types

      The following is an example of extracting all customized record types from your Oracle CRM On Demand server:

      migrationtool -u UserID -s ServerURL ReadAll CustomRecordType

        Updating or Inserting a Customized Record Type (Upsert)

        This topic describes how to update a customized record type (if it exists) or insert a customized record type (if it does 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 a customized record type (if it exists) or insert a customized record type (if it does not exist):

        migrationtool -u UserID -s ServerURL Upsert CustomRecordType CustomizedRecordTypeXML

        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.

        • CustomizedRecordTypeXML is the fully qualified path name of the customized record type XML file, for example:

          C:\My Files\MyAccount.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 a Customized Record Type

        The following is an example of updating an Account customized record type (if it exists) or inserting an Account customized record type (if it does not exist) in your Oracle CRM On Demand server:

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