Migrating Field Audit Setup Information

This chapter describes how to migrate your field audit setup information using the Oracle Migration Tool On Demand client. It contains the following topics:

Field Audit Setup

The audit trail functionality allows your company to track changes to certain fields on records, and to track the creation, deletion, and restoration of records. The field audit setup for a record type determines which fields are audited for that record type, and whether the creation, deletion, and restoration of records of that type are tracked. For some record types, certain fields are audited by default. For other record types, no fields are audited by default. Your administrator can configure the audit trail for each record type that supports the audit trail functionality. For more information about field audit setup and the record types that can be audited, see Oracle CRM On Demand Online Help.

The following table describes the Oracle Migration Tool On Demand client commands used with field audit setup. These commands are case sensitive.

Table Commands Used with Field Audit Setup in Oracle Migration Tool On Demand

Command Description

Command	Description
`Read FieldAuditSetUp SystemNameOfObject`	This command extracts the field audit setup information 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 FieldAuditSetUp`	This command extracts the field audit setup information for all objects.
`Upsert FieldAuditSetUp FieldAuditSetUpXML`	This command updates or inserts the field audit setup information for an object.

Read FieldAuditSetUp SystemNameOfObject

This command extracts the field audit setup information 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 FieldAuditSetUp

This command extracts the field audit setup information for all objects.

Upsert FieldAuditSetUp FieldAuditSetUpXML

This command updates or inserts the field audit setup information for an object.

Privileges Required for Migrating Field Audit Setup Information

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, Administer Field Audit, 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 the Upsert command: Enable Web Services Access, Administer Field Audit, 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 Field Audit Setup XML Output File

The following table describes the elements and sections in the field audit setup XML output file.

Table Elements and Sections in the Field Audit Setup XML File

Description	Element or Section
<ObjectName> contains the system name of the record type (object), which never changes.	<data:ObjectName>Account</data:ObjectName>
<AuditRecordCreation> specifies whether the creation of records of this record type is tracked (true) or is not tracked (false).	<data:AuditRecordCreation>true </data:AuditRecordCreation>
<AuditRecordDeletionOrRestore> specifies whether the deletion and restoration of records of this record type are tracked (true) or are not tracked (false).	<data:AuditRecordDeletionOrRestore>true </data:AuditRecordDeletionOrRestore>
The <ListOfFields> section contains details of the fields that can be audited for the record type.	<data:ListOfFields> . . . </data:ListOfFields>
The <Field> section contains the details for one field. It contains the following elements: <Name> contains the system name of the field, which never changes. <IsAudited> specifies whether changes to the field are tracked (true) or are not tracked (false).	<data:ListOfFields> <data:Field> <data:Name>Furigana Name</data:Name> <data:IsAudited>true</data:IsAudited> </data:Field> . . . </data:ListOfFields>

Migrating Field Audit Setup Information

The following topics describe how to use the Oracle Migration Tool On Demand client to migrate field audit setup information:

Extracting Field Audit Setup Information for a Single Object

This topic describes how to extract the field audit setup information for a single object from your Oracle CRM On Demand environment.

Syntax

The following is the syntax for using the Oracle Migration Tool On Demand client to extract the field audit setup information for a single object:

migrationtool -u UserID -s ServerURL Read FieldAuditSetUp 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 field audit setup information you want to extract, for example, Account Contact. 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 Field Audit Setup Information for a Single Object

The following is an example of extracting the field audit setup information for the Account object:

migrationtool -u UserID -s ServerURL Read FieldAuditSetUp Account

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

Extracting Field Audit Setup Information for All Objects

This topic describes how to extract the field audit setup information for all objects from your Oracle CRM On Demand environment.

Syntax

The following is the syntax for using the Oracle Migration Tool On Demand client to extract the field audit setup for all objects:

migrationtool -u UserID -s ServerURL ReadAll FieldAuditSetUp

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 Field Audit Setup Information (Upsert)

This topic describes how to update the field audit setup information for a single object 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 the field audit setup information for an object:

migrationtool -u UserID -s ServerURL Upsert FieldAuditSetUp FieldAuditSetUpXML

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.
FieldAuditSetUpXML is the fully qualified path name of the field audit setup 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 FieldAuditSetUp "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.