4Migrating Custom Web Tabs
Migrating Custom Web Tabs
This chapter describes how to migrate custom Web tabs using the Oracle Migration Tool On Demand client. It contains the following topics:
Custom Web Tabs
A custom Web tab allows you to display Web content, a report, or a dashboard in a tab in Oracle CRM On Demand.
The following table describes the Oracle Migration Tool On Demand client commands used with custom Web tabs. For more information about running these commands, see Migrating Custom Web Tabs.
Table Commands Used with Custom Web Tabs in Oracle Migration Tool On Demand
Command | Description |
---|---|
|
This command exports a single custom Web tab. The generated SystemNameOfCustomWebTab is derived from the custom Web tab name provided by a user. |
|
This command exports all custom Web tabs. |
|
This command updates or inserts a custom Web tab, as required. |
|
This command deletes a single custom Web tab from the Oracle CRM On Demand server. The generated SystemNameOfCustomWebTab is derived from the custom Web tab name provided by a user. |
Privileges Required for Migrating Custom Web Tabs
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, and Manage Roles and Access.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 Custom Web Tabs XML Output File
The following table describes the elements and sections in the custom Web tabs XML output file.
Table Elements and Sections in the Custom Web Tabs XML File
Description | Element or Section |
---|---|
<DisplayName> contains the name of the Web tab. This name is used in the user interface if no translated display names are provided. |
<data:DisplayName>test</data:DisplayName> |
<Description> contains the description for the custom Web tab. |
<data:Description></data:Description> |
<Type> defines the type of the custom Web tab, which is one of the following:
|
<data:Type></data:Type> |
<HTMLHeadAdditions> specifies the HTML code that is included in the source of a rendered Oracle CRM On Demand Web page in the <head> tags at the top of the page (for custom Web tabs of the HTML type only). |
<data:HTMLHeadAdditions> </data:HTMLHeadAdditions> |
<WebTabHTML> specifies the HTML code that is rendered in a custom Web tab (for custom Web tabs of the HTML type only). |
<data:WebTabHTML></data:WebTabHTML> |
<URL> contains the URL information for the custom Web tab (for custom Web tabs of the URL type only).
Note: Although it is possible to update or insert a custom Web tab of the URL type that contains a URL for an analysis or dashboard, this functionality is not fully supported, and the URL might not work after an upgrade.
|
<data:Url></data:Url> |
<FrameHeight> specifies the frame height of the custom Web tab. |
<data:FrameHeight></data:FrameHeight> |
<FrameWidth> specifies the frame width of the custom Web tab. |
<data:FrameWidth></data:FrameWidth> |
<IconName> contains the file name of the icon used for this custom Web tab. In this example, icon_custtab.gif is the graphic file that is used. For the list of available icon file names, see Classic and Modern Theme Icons. |
<data:IconName>icon_custtab.gif</data:IconName> |
For custom Web tabs of the Dashboard type only, the <DashboardType> section contains the following elements:
|
<data:DashboardType> <data:DashboardPath> Company Wide Shared Folder : Dashboards : Accounts Dashboard </data:DashboardPath> <data:DashboardParameters> P0=1&P1=eq&P2="Account"."Account ID"&P3=%%%Row_Id%%% </data:DashboardParameters> </data:DashboardType> |
For custom Web tabs of the Report type only, the <ReportType> section contains the following elements:
|
<data:ReportType> <data:ReportPath> Company Wide Shared Folder : My Company Account Custom Analyses : Account Custom Analysis </data:ReportPath> <data:ReportParameters> P0=1&P1=eq&P2="Account"."Account ID"&P3=%%%Row_Id%%% </data:ReportParameters> <data:ReportPrompts>false</data:ReportPrompts> <data:RefreshLink>true</data:RefreshLink> <data:PrintLink>true</data:PrintLink> <data:ExportLink>true</data:ExportLink> </data:ReportType> |
The <ListOfCustomWebTabTranslations> section contains the translation values for the custom Web tab. |
<data:ListOfCustomWebTabTranslations> . . . </data:ListOfCustomWebTabTranslations> |
The <CustomWebTabTranslation> section contains the translation values for one language:
In this example, for English-American (ENU), the display name is My Custom Web Tab. The precedence for determining the display name is as follows:
|
<data:ListOfCustomWebTabTranslations> <data:CustomWebTabTranslation> <data:LanguageCode>ENU</data:LanguageCode> <data:DisplayName>My Custom Web Tab </data:DisplayName> </data:CustomWebTabTranslation> . . . </data:ListOfCustomWebTabTranslations> |
Migrating Custom Web Tabs
The following topics provide examples of how to use the Oracle Migration Tool On Demand client to migrate custom Web tabs:
Extracting a Single Custom Web Tab
This topic describes how to extract a custom Web tab from your Oracle CRM On Demand server for your environment (customer test environment or production).
Syntax
The following is the syntax for using the Oracle Migration Tool On Demand client to extract a custom Web tab:
migrationtool -u UserID -s ServerURL Read CustomWebTab SystemNameOfCustomWebTab
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.
SystemNameOfCustomWebTab is the system name of the Custom Web tab that you want to extract, for example, My Custom Web Tab.
Example of Extracting a Single Custom Web Tab
The following is an example of extracting a single custom Web tab:
migrationtool -u UserID -s ServerURL Read CustomWebTab "My Custom Web Tab"
Extracting All Custom Web Tabs
This topic describes how to extract all custom Web tabs 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 customized record types:
migrationtool -u UserID -s ServerURL ReadAll CustomWebTab
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 Custom Web Tabs
The following is an example of extracting all custom Web tabs from your Oracle CRM On Demand server:
migrationtool -u UserID -s ServerURL ReadAll CustomWebTab
Updating or Inserting a Custom Web Tab (Upsert)
This topic describes how to update a custom Web tab (if it exists) or insert a custom Web tab (if it does not exist) 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 a custom Web tab (if it exists) or insert a custom Web tab (if it does not exist):
migrationtool -u UserID -s ServerURL Upsert CustomWebTab CustomWebTabXML
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.
CustomWebTabXML is the fully qualified path name of the custom Web tab XML file, for example:
C:\My Files\MyCustomWwebTab.xml
Example of Updating or Inserting a Custom Web Tab
The following is an example of updating a custom Web tab (if it exists) or inserting the custom Web tab (if it does not exist) in your Oracle CRM On Demand server:
migrationtool -u UserID -s ServerURL Upsert CustomWebTab "C:\My Files\MyCustomWebTab.xml"
Deleting a Single Custom Web Tab
This topic describes how to delete a custom Web tab from your Oracle CRM On Demand server for your environment (customer test environment or production).
Syntax
The following is the syntax for using the Oracle Migration Tool On Demand client to delete a custom Web tab:
migrationtool -u UserID -s ServerURL Delete CustomWebTab SystemNameOfCustomWebTab
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.
SystemNameOfCustomWebTab is the system name of the custom Web tab that you want to delete, for example, My Custom Web Tab.
Example of Deleting a Single Custom Web Tab
The following is an example of deleting a single custom Web tab:
migrationtool -u UserID -s ServerURL Delete CustomWebTab "My Custom Web Tab"