18Migrating Dynamic Page Layouts
Migrating Dynamic Page Layouts
This chapter describes how to migrate dynamic page layouts using the Oracle Migration Tool On Demand client. It contains the following topics:
Dynamic Page Layouts
Dynamic page layouts are page layouts that show different sets of fields for different records of the same record type, depending on the picklist value that you select in a certain field on the record.
The following table describes the Oracle Migration Tool On Demand client commands used with dynamic page layouts. For more information about running these commands, see Migrating Dynamic Page Layouts.
Table Commands Used with Dynamic Page Layouts in Oracle Migration Tool On Demand
Command | Description |
---|---|
|
This command extracts the configuration data for the dynamic page layouts 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. |
|
This command extracts the configuration data for the dynamic page layouts for all objects. |
|
This command updates or inserts a dynamic page layout, as required. |
Privileges Required for Migrating Dynamic Page Layouts
The following privileges are required for the user account running the Oracle Migration Tool On Demand client commands:
For the
Read
andReadAll
command: Enable Web Services Access.For the
Upsert
command: Enable Web Services Access and Customize Application - Manage Dynamic Layout.
For information about setting and checking privileges, see Oracle CRM On Demand Online Help.
Elements and Sections in the Dynamic Page Layout XML Output File
The following table describes the elements and sections in the dynamic page layout XML output file.
Table Elements and Sections in the Dynamic Page Layout XML File
Description | Element or Section |
---|---|
<ObjectName> contains the system name of the record type (object), which never changes. |
<data:ObjectName>Opportunity</data:ObjectName> |
<DrivingPicklist> contains the name of the dynamic page layout driving picklist. For more information about driving picklists, see Oracle CRM On Demand Online Help. |
<data:DrivingPicklist>Sales Type</data:DrivingPicklist> |
The <ListOfDynamicLayouts> section contains the details of the dynamic page layouts for the object. |
<data:ListOfDynamicLayouts> . . . </data:ListOfDynamicLayouts> |
The <DynamicLayout> section contains the details of one dynamic page layout. |
<data:ListOfDynamicLayouts> <data:DynamicLayout> . . . </data:DynamicLayout> . . . </data:ListOfDynamicLayouts> |
<Name> contains the name of the dynamic page layout. |
<data:ListOfDynamicLayouts> <data:DynamicLayout> <data:Name>dynamic</data:Name> . . . </data:ListOfDynamicLayouts> |
<DefaultLayout> contains the name of the default page layout with which the driving picklist values are associated. |
<data:ListOfDynamicLayouts> <data:DynamicLayout> . . . <data:DefaultLayout>Opportunity Page Standard Layout</data:DefaultLayout> . . . </data:DynamicLayout> . . . </data:ListOfDynamicLayouts> |
<ModifiedBy> contains the name of the user who last updated the dynamic page layout. |
<data:ListOfDynamicLayouts> <data:DynamicLayout> . . . <data:ModifiedBy>sales10</data:ModifiedBy> . . . </data:DynamicLayout> . . . </data:ListOfDynamicLayouts> |
<Description> contains the description of the dynamic page layout. |
<data:ListOfDynamicLayouts> <data:DynamicLayout> . . . <data:Description>Dynamic Layout Description </data:Description> . . . </data:DynamicLayout> . . . </data:ListOfDynamicLayouts> |
The <ListofPicklistValueMapping> section contains the mappings of the driving picklist values to the page layouts:
|
<data:ListOfDynamicLayouts> <data:DynamicLayout> . . . <data:ListOfPicklistValueMapping> <data:DrivingPicklist> <data:Value>New Business</data:Value> <data:AssignedLayout>test2</data:AssignedLayout> </data:DrivingPicklist> </data:ListOfPicklistValueMapping> . . . </data:DynamicLayout> . . . </data:ListOfDynamicLayouts> |
Migrating Dynamic Page Layouts
The following topics provide examples of how to use the Oracle Migration Tool On Demand client to migrate dynamic page layout field information:
Extracting Dynamic Page Layouts for a Single Object
This topic describes how to extract the dynamic page layouts for a single object from the Oracle CRM On Demand server for your environment; that is, a customer test environment or production environment.
Read
command.
Syntax
The following is the syntax for using the Oracle Migration Tool On Demand client to extract the dynamic page layouts for a single object:
migrationtool -u UserID -s ServerURL Read DynamicLayout 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 read a set of dynamic page layouts, for example, Account. The system names for the record types are listed in System Names for Record Types.
Example of Extracting Dynamic Page Layouts for a Single Object
The following is an example of extracting the dynamic page layouts for the Opportunity record type:
migrationtool -u UserID -s ServerURL Read DynamicLayout Opportunity
Extracting Dynamic Page Layouts for All Objects
This topic describes how to extract all dynamic page layouts 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 dynamic page layouts:
migrationtool -u UserID -s ServerURL ReadAll DynamicLayout
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 Dynamic Page Layouts for All Objects
The following is an example of extracting all dynamic page layouts from your Oracle CRM On Demand server:
migrationtool -u UserID -s ServerURL ReadAll DynamicLayout
Updating or Inserting Dynamic Page Layouts (Upsert)
This topic describes how to update dynamic page layout information for a single object (if it exists) or insert this information (if it does not exist) 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 dynamic page layout information (if it exists) for a single object or insert this information (if it does not exist):
migrationtool -u UserID -s ServerURL Upsert DynamicLayout DynamicLayoutXML
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.
DynamicLayoutXML is the fully qualified path name of the dynamic page layout XML file, for example:
C:\My Files\DynamicLayout.xml
Example of Updating or Inserting a Dynamic Page Layout
The following is an example of updating a dynamic page layout (if it exists) or inserting this information (if it does not exist) in your Oracle CRM On Demand server:
migrationtool -u UserID -s ServerURL Upsert DynamicLayout "C:\My Files\DynamicLayout.xml"