15Migrating Action Bar Layouts
Migrating Action Bar Layouts
This chapter describes how to migrate Action bar layouts using the command-line interface of the Oracle Migration Tool On Demand client. It contains the following topics:
Action Bar Layouts
An Action bar layout is the arrangement of the Action bar components, which appear on the left side of all Oracle CRM On Demand pages. Components typically include sections, such as the following: the Message Center, Search, Communication Tools, Create, Recently Viewed, Favorite Records, Favorite Lists, and Calendar.
The following table describes the Oracle Migration Tool On Demand client commands used with Action bar layouts. For more information about running these commands, see Migrating Action Bar Layouts.
Table Commands Used with Action Bar Layouts in Oracle Migration Tool On Demand
Command | Description |
---|---|
|
This command exports all Action bar layouts for all objects. |
|
This command updates or inserts an Action bar layout, as required. |
Privileges Required for Migrating Action Bar Layouts
The following privileges are required for the user account running the Oracle Migration Tool On Demand client commands:
For the
Read
andReadAll
commands: Enable Web Services Access and Customize Application.For the
Upsert
command: Enable Web Services Access and Customize Application.
For information about setting and checking privileges, see Oracle CRM On Demand Online Help.
Elements and Sections in the Action Bar Layout XML Output File
The following table describes the elements and sections in the Action bar layout XML output file.
Table Elements and Sections in the Action Bar Layout XML File
Description | Element or Section |
---|---|
The <LayoutName> element contains the name of the Action bar layout. |
<data:LayoutName>My Custom Action Bar Layout </data:LayoutName> |
The <Description> element contains the description of the Action bar layout. |
<data:Description>Custom Action Bar Layout Description </data:Description> |
The <ListOfSections> section contains the details of the Action bar sections. |
<data:ListOfSections> . . . </data:ListOfSections> |
The <Section> section contains the details of one section in the Action bar, as follows:
|
<data:ListOfSections> <data:Section> <data:Name>Global Search Multi Field </data:Name> <data:Displayed>true</data:Displayed> <data:Sequence>-2</data:Sequence> <data:GlobalHeaderSection>false <data:GlobalHeaderSection> </data:Section> <data:Section> <data:Name>Quick Message Center </data:Name> <data:Displayed>true</data:Displayed> <data:Sequence>-2</data:Sequence> <data:GlobalHeaderSection>false </data:GlobalHeaderSection> </data:Section> <data:Section> <data:Name>Calendar Action Applet </data:Name> <data:Displayed>false</data:Displayed> <data:Sequence>-1</data:Sequence> <data:GlobalHeaderSection>false </data:GlobalHeaderSection> </data:Section> <data:Section> <data:Name>Quick Favorite Lists</data:Name> <data:Displayed>true</data:Displayed> <data:Sequence>3</data:Sequence> <data:GlobalHeaderSection>false </data:GlobalHeaderSection> </data:Section> <data:Section> <data:Name>Quick History</data:Name> <data:Displayed>true</data:Displayed> <data:Sequence>1</data:Sequence> <data:GlobalHeaderSection>true </data:GlobalHeaderSection> </data:Section> <data:Section> <data:Name>Quick Favorite Records </data:Name> <data:Displayed>true</data:Displayed> <data:Sequence>2</data:Sequence> <data:GlobalHeaderSection>true </data:GlobalHeaderSection> </data:Section> <data:Section> <data:Name>Quick Create</data:Name> <data:Displayed>true</data:Displayed> <data:Sequence>0</data:Sequence> <data:GlobalHeaderSection>false </data:GlobalHeaderSection> </data:Section> </data:ListOfSections> |
The <ListOfGlobalHeaders> section contains the specification for the global header for the Action bar layout. |
<data:ListOfGlobalHeaders> . . . </data:ListOfGlobalHeaders> |
The <GlobalHeader> section contains details of one section in the global header, as follows:
|
<data:ListOfGlobalHeaders> <data:GlobalHeader> <data:Order>1</data:Order> <data:Icon>202</data:Icon> <data:Applet>Global Header Create </data:Applet> <data:AppletWidth>0</data:AppletWidth> <data:AppletDescription/> </data:GlobalHeader> <data:GlobalHeader> <data:Order>3</data:Order> <data:Icon>205</data:Icon> <data:Applet>Quick Favorite Records</data:Applet> <data:AppletWidth>160</data:AppletWidth> <data:AppletDescription/> </data:GlobalHeader> <data:GlobalHeader> <data:Order>2</data:Order> <data:Icon>202</data:Icon> <data:Applet>Quick History</data:Applet> <data:AppletWidth>160</data:AppletWidth> <data:AppletDescription/> </data:GlobalHeader> </data:ListOfGlobalHeaders> |
Name Element Value to UI Value Mapping for Applets
The following table maps the <Name> element values in the XML to the values in the Oracle CRM On Demand UI for the preconfigured applets. See the preceding table for more information about the <Name> element.
Table Name Element Value to UI Value Mapping for Oracle CRM On Demand Applets
Name Element Value in XML File | UI Value |
---|---|
Calendar Action Applet |
Calendar |
Enhanced Text Search |
Enhanced Keyword Search |
Global Search Multi Field |
Search |
Quick Create |
Create |
Quick Favorite Lists |
Favorite Lists |
Quick Favorite Records |
Favorite Records |
Quick History |
Recently Viewed |
Quick Message Center |
Message Center |
Migrating Action Bar Layouts
The following topics provide examples of how to use the Oracle Migration Tool On Demand client to migrate Action bar layouts:
Extracting All Action Bar Layouts
This topic describes how to extract all Action bar 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 Action bar layouts:
migrationtool -u UserID -s ServerURL ReadAll ActionBarLayout
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 All Action Bar Layouts
The following is an example of extracting all Action bar layouts from your Oracle CRM On Demand server:
migrationtool -u UserID -s ServerURL ReadAll ActionBarLayout
Updating or Inserting an Action Bar Layout (Upsert)
This topic describes how to update an Action bar layout (if it exists) or insert a custom Action bar layout (if it does not exist) in your Oracle CRM On Demand environment (customer test environment or production).
About the Upsert Operation
The Upsert
command inserts or updates an Action bar layout based on the <LayoutName> value. If an Action bar layout already exists with the same <LayoutName> value, then an update occurs, otherwise, a new Action bar layout is created.
The matching of the Action bar layout names is case sensitive. For example, <LayoutName>My Custom Action Bar Layout</LayoutName> and <LayoutName>MY Custom Action Bar Layout</LayoutName> are considered two different layouts (because the first layout name contains My, while the second layout name contains MY).
Syntax
The following is the syntax for using the Oracle Migration Tool On Demand client to update an Action bar layout (if it exists) or insert an Action bar layout (if it does not exist):
migrationtool -u UserID -s ServerURL Upsert ActionBarLayout ActionBarLayoutXML
where:
UserID is the user sign-in ID that has the appropriate privileges to run the Oracle Migration Tool On Demand client commands, for example, CompanyABC/jdoe
.
ServerURL is the URL for the Oracle CRM On Demand server where your company resides.
ActionBarLayoutXML is the fully qualified path name of the Action bar layout XML file, for example:
C:\My Files\MyActionBarLayout.xml
Example of Updating or Inserting an Action Bar Layout
The following is an example of updating an Action bar layout (if it exists) or inserting the action bar layout (if it does not exist) in your Oracle CRM On Demand server:
migrationtool -u UserID -s ServerURL Upsert ActionBarLayout "C:\My Files\MyActionBarLayout.xml"