Migrating List Access and Order Layouts

This chapter describes how to migrate your list access and order layouts using the Oracle Migration Tool On Demand client. It contains the following topics:

List Access and Order Layouts

For many record types (objects), you can specify which lists of records of that type are available for each role, and the order in which the lists are displayed on the record type's homepage. For each record type, you can create one list access and order layout for each role. For more information about list access and order layouts, see Oracle CRM On Demand Online Help.

The following table describes the Oracle Migration Tool On Demand client commands used with list access and order layouts. These commands are case sensitive.

Table Commands Used with List Access and Order Layouts in Oracle Migration Tool On Demand

Command Description

Command	Description
`Read ListAccessAndOrder SystemNameOfObject RoleName`	This command extracts the list access and order layouts for a specific record type (object), for one role. The parameters for the command are as follows: SystemNameOfObject is the system name of the record type. The system names for the record types are listed in System Names for Record Types. RoleName is the language-independent name of the role. For a custom role, the language-independent name of the role is generated from the role name provided by the user who creates the role. Note: You can determine the system names of the roles by extracting the roles, as described in Extracting All Roles.
`ReadAll ListAccessAndOrder`	This command extracts the list access and order layouts for all record types, and for all roles.
`Upsert ListAccessAndOrder ListAccessAndOrderXML`	This command updates or inserts a list access and order layout for one record type, for one role.

Read ListAccessAndOrder SystemNameOfObject RoleName

This command extracts the list access and order layouts for a specific record type (object), for one role. The parameters for the command are as follows:

SystemNameOfObject is the system name of the record type. The system names for the record types are listed in System Names for Record Types.
RoleName is the language-independent name of the role. For a custom role, the language-independent name of the role is generated from the role name provided by the user who creates the role.

Note: You can determine the system names of the roles by extracting the roles, as described in Extracting All Roles.

ReadAll ListAccessAndOrder

This command extracts the list access and order layouts for all record types, and for all roles.

Upsert ListAccessAndOrder ListAccessAndOrderXML

This command updates or inserts a list access and order layout for one record type, for one role.

Privileges Required for Migrating List Access and Order Layouts

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 command: Enable Web Services Access, Customize Application, Manage Public Lists, 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 List Access and Order Layout XML Output File

The following table describes the elements and sections in the list access and order layout XML output file.

Table Elements and Sections in the List Access and Order Layout XML File

Description	Element or Section
The <ListAccessAndOrder> section contains all of the information for one list access and order layout for one record type, for one role.	<data:ListAccessAndOrder> . . . </data:ListAccessAndOrder>
<ObjectName> contains the system name of the record type (object), which never changes.	<data:ListAccessAndOrder> <data:ObjectName>Account</data:ObjectName> . . . </data:ListAccessAndOrder>
<RoleName> contains the language-independent name of the role.	<data:ListAccessAndOrder> . . . <data:RoleName>TestRole</data:RoleName> . . . </data:ListAccessAndOrder>
<ModifiedBy> contains the username of the user who last updated the layout, and the date and time the layout was last updated.	<data:ListAccessAndOrder> . . . <data:ModifiedBy>AB User 10/26/2012 10:12:40</data:ModifiedBy> . . . </data:ListAccessAndOrder>
The <ListOfListAccessAndOrderList> section contains details of the list layout for one record type, for one role.	<data:ListAccessAndOrder> . . . <data:ListOfListAccessAndOrderList> . . . </data:ListOfListAccessAndOrderList> </data:ListAccessAndOrder>
The <ListAccessAndOrderList> section contains details of one list, for one record type, for one role. It includes the following elements: <ListName> contains the name of the list <Order> indicates the order of the list within the layout, as follows: A value of 2 or higher indicates that the list is in the Show in Short List section. The order number also indicates the position of the list within the short list of lists. The list with the lowest order number appears at the top of the short list of lists. A value of -1 indicates that the list is in the Lists Available for this Role section. A value of -2 indicates that the list is in the All Lists section.	<data:ListAccessAndOrder> . . . <data:ListOfListAccessAndOrderList> <data:ListAccessAndOrderList> <data:ListName>My Active Accounts </data:ListName> <data:Order>2</data:Order> . . . </data:ListAccessAndOrderList> . . . </data:ListOfListAccessAndOrderList> . . . </data:ListAccessAndOrder>

Migrating List Access and Order Layouts

The following topics describe how to use the Oracle Migration Tool On Demand client to migrate list access and order layouts:

Extracting List Access and Order Layouts for a Single Object and Role

This topic describes how to extract the list access and order layout for a single object and role 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 follow:

migration tool install/repository/ListAccessAndOrder/RecordType/RoleName.xml

Syntax

The following is the syntax for using the Oracle Migration Tool On Demand client to extract the list access and order layout for a single object and role:

migrationtool -u UserID -s ServerURL Read ListAccessAndOrder SystemNameOfObject RoleName

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) to which the list access and order layout applies, for example, Account. The system names for the record types are listed in System Names for Record Types.
RoleName is the language-independent name of the role.

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 List Access and Order Layouts for a Single Object and Role

The following is an example of extracting the list access and order layout for single object and role:

migrationtool -u UserID -s ServerURL Read ListAccessAndOrder Account ExpertRole

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

Extracting List Access and Order Layouts for All Objects and Roles

This topic describes how to extract the list access and order layouts for all objects, for all roles from the Oracle CRM On Demand server for your environment; that is, a customer test environment or production environment.

Syntax

The following is the syntax for using the Oracle Migration Tool On Demand client to extract the list access and order layouts for all objects, for all roles:

migrationtool -u UserID -s ServerURL ReadAll ListAccessAndOrder

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 or Inserting List Access and Order Layouts (Upsert)

This topic describes how to update a list access and order layout for a single object and role (if the layout already exists), or insert a layout (if it does not exist) on your Oracle CRM On Demand environment (customer test environment or production).

About the Upsert Operation

The Upsert command inserts or updates list access and order layouts based on the user key: <RoleName> and <ObjectName>.

Oracle CRM On Demand attempts to locate the list access and order layout specified in the input file based on the user key. If a match is located, then the layout is updated. If Oracle CRM On Demand cannot locate a list access and order layout based on the user key, then a new layout is created for the specified record type and role.

If the layout includes public lists that were created and assigned in the source environment, and if those lists do not exist in the target environment where you are updating and inserting the list access and order layouts, then those lists are not included in the layout in the target environment.

Syntax

The following is the syntax for using the Oracle Migration Tool On Demand client to insert or update the list access and order layout for one object, for one role:

migrationtool -u UserID -s ServerURL Upsert ListAccessAndOrder ListAccessAndOrderXML

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.
ListAccessAndOrderXML is the fully qualified path name of the list access and order layout XML file, for example:
```
C:\My Files\ExpertRole.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 ListAccessAndOrder "C:\My Files\ExpertRole.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 List Access and Order Layout

The following is an example of updating a list access and order layout (if it exists) or inserting the list access and order layout layout (if it does not exist) in your Oracle CRM On Demand server:

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

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