1. Oracle Migration Tool On Demand Guide
  2. Elements and Sections in the Custom Web Tabs XML Output File

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:

  • Dashboard

  • HTML

  • Report

  • URL

 
<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:

  • <DashboardPath> contains the path to the dashboard. The dashboard must be located directly in the Dashboards folder under Shared Folders and not at a deeper level.

  • <DashboardParameters> specifies any parameters that are to be applied at runtime. If any filter parameters are present, then the syntax of those parameters is validated when you insert or update a custom Web tab of the Dashboard type. For information about specifying parameters for embedded dashboards, see Oracle CRM On Demand Online Help.

 
<data:DashboardType>
  <data:DashboardPath>
Company Wide Shared Folder : Dashboards : Accounts Dashboard
  </data:DashboardPath>
  <data:DashboardParameters>
P0=1&amp;P1=eq&amp;P2="Account"."Account ID"&amp;P3=%%%Row_Id%%%
  </data:DashboardParameters>
</data:DashboardType>

For custom Web tabs of the Report type only, the <ReportType> section contains the following elements:

  • <ReportPath> contains the path to the analysis. The analysis must be located under Shared Folders.

  • <ReportParameters> specifies any parameters that are to be applied at runtime. If any filter parameters are present, then the syntax of those parameters is validated when you insert or update a custom Web tab of the Report type. For information about specifying parameters for embedded analyses, see Oracle CRM On Demand Online Help.

    Note: If the <ReportPrompts> element is set to true, then any filters that are specified in the <ReportParameters> element are ignored at runtime, even if no prompts are defined for the analysis.

  • <ReportPrompts> corresponds to the Display Report Prompts check box in the UI. It determines whether any prompts that are defined for the analysis are displayed at runtime (true) or are not displayed (false).

  • <RefreshLink> determines whether the Refresh link that allows users to refresh the data in the analysis is displayed at runtime (true) or is not displayed (false).

  • <PrintLink> determines whether the Print link that allows users to print the analysis is displayed at runtime (true) or is not displayed (false).

  • <ExportLink> determines whether the Export link that allows users to download the analysis is displayed at runtime (true) or is not displayed (false).

 
<data:ReportType>
  <data:ReportPath>
Company Wide Shared Folder : My Company Account Custom Analyses : Account Custom Analysis
  </data:ReportPath>
  <data:ReportParameters>
P0=1&amp;P1=eq&amp;P2="Account"."Account ID"&amp;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:

  1. The translation definition, if it is defined.

  2. The information contained in the <DisplayName> element, if it is defined and if the translation definition is not defined.

  3. The system name, if the translation definition and the <DisplayName> element are not defined.

 
<data:ListOfCustomWebTabTranslations>
  <data:CustomWebTabTranslation>
    <data:LanguageCode>ENU</data:LanguageCode> 
    <data:DisplayName>My Custom Web Tab
    </data:DisplayName>
  </data:CustomWebTabTranslation>
. . .
</data:ListOfCustomWebTabTranslations>