Migrating Modification Tracking Settings

This chapter describes how to migrate your modification tracking settings using the Oracle Migration Tool On Demand client. It contains the following topics:

Modification Tracking Settings

The modification tracking feature allows you to track run-time modifications to records of certain record types. You can use the Oracle Migration Tool On Demand client to migrate your modification tracking settings, and to enable or disable modification tracking for record types.

Objects Supported for Modification Tracking

In addition to tracking run-time modifications to record types such as Acccount, Contact, and so on, the modification tracking feature can also track changes to the lists of values for picklist fields. For more information about modification tracking, see Oracle CRM On Demand Online Help, which also provides a list of the record types that support modification tracking.

The following table describes the Oracle Migration Tool On Demand client commands used with modification tracking settings. These commands are case sensitive.

Table Commands Used with Modification Tracking Settings in Oracle Migration Tool On Demand

Command Description

Command	Description
`Read EnableModificationTracking SystemNameOfObject`	This command extracts the modification tracking setting 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. Note: The system name of the Picklist object is Picklist.
`ReadAll EnableModificationTracking`	This command extracts the modification tracking settings for all objects.
`Upsert EnableModificationTracking EnableModificationTrackingXML`	This command updates or inserts the modification tracking settings for one or more objects.

Read EnableModificationTracking SystemNameOfObject

This command extracts the modification tracking setting 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.

Note: The system name of the Picklist object is Picklist.

ReadAll EnableModificationTracking

This command extracts the modification tracking settings for all objects.

Upsert EnableModificationTracking EnableModificationTrackingXML

This command updates or inserts the modification tracking settings for one or more objects.

Privileges Required for Migrating Modification Tracking Settings

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 Manage Modification Tracking.
For the Upsert command: Enable Web Services Access, Manage Modification Tracking, Manage Roles and Access, 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 Modification Tracking Settings XML Output File

The following table describes the elements and sections in the modification tracking settings XML output file.

Table Elements and Sections in the Modification Tracking Settings XML File

Description	Element or Section
The <EnableModificationTracking> section contains the details of the modification tracking setting for one record type (object). It includes the following elements: <Object> contains the system name of the record type (object), which never changes. <Enabled> contains the setting for modification tracking for the object. Valid values are true (modification tracking is enabled for the object) and false (modification tracking is not enabled for the object).	<data:ListOfEnableModificationTracking> <data:EnableModificationTracking> <data:Object>Account</data:Object> <data:Enabled>true</data:Enabled> </data:EnableModificationTracking> . . . </data:ListOfEnableModificationTracking>

Description

Element or Section

The <EnableModificationTracking> section contains the details of the modification tracking setting for one record type (object). It includes the following elements:

<Object> contains the system name of the record type (object), which never changes.
<Enabled> contains the setting for modification tracking for the object. Valid values are true (modification tracking is enabled for the object) and false (modification tracking is not enabled for the object).

<data:ListOfEnableModificationTracking>
  <data:EnableModificationTracking>
    <data:Object>Account</data:Object>
    <data:Enabled>true</data:Enabled>
  </data:EnableModificationTracking>
. . .
</data:ListOfEnableModificationTracking>

Migrating Modification Tracking Settings

The following topics describe how to use the Oracle Migration Tool On Demand client to migrate modification tracking settings:

Extracting Modification Tracking Settings for a Single Object

This topic describes how to extract the modification tracking settings for a single object from the Oracle CRM On Demand server for your environment; that is, a customer test environment or production environment. The output from the extract is saved to a file and directory as follows:

migration tool install/repository/EnableModificationTracking/RecordType.xml

Syntax

The following is the syntax for using the Oracle Migration Tool On Demand client to extract the modification tracking settings for a single object:

migrationtool -u UserID -s ServerURL Read EnableModificationTracking 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) whose modification tracking settings 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 Modification Tracking Settings for a Single Object

The following is an example of extracting the modification tracking settings for a single object:

migrationtool -u UserID -s ServerURL Read EnableModificationTracking Account

Note: If the object name contains spaces, then it must be enclosed with quotation marks.

Extracting Modification Tracking Settings for All Objects

This topic describes how to extract the modification tracking settings for all objects from the Oracle CRM On Demand server for your environment; that is, a customer test environment or production environment. The output from the extract is saved to a single file in the following directory:

migration tool install/repository/EnableModificationTracking/

Syntax

The following is the syntax for using the Oracle Migration Tool On Demand client to extract the modification tracking settings for all objects:

migrationtool -u UserID -s ServerURL ReadAll EnableModificationTracking

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.

Updating Modification Tracking Settings (Upsert)

This topic describes how to update the modification tracking settings in 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 the modification tracking settings:

migrationtool -u UserID -s ServerURL Upsert EnableModificationTracking EnableModificationTrackingXML

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.
EnableModificationTrackingXML is the fully qualified path name of the modification tracking settings XML file, for example:
```
C:\My Files\Account.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 EnableModificationTracking "C:\My Files\Account.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 Modification Tracking Settings

The following is an example of updating the modification tracking settings in your Oracle CRM On Demand server:

migrationtool -u UserID -s ServerURL Upsert EnableModificationTracking "C:\Oracle Migration Tool On Demand\repository\EnableModificationTracking\Account.xml"

Note: Quotation marks are required only if the fully qualified path name contains spaces.