1. Oracle Migration Tool On Demand Guide
  2. Homepage Custom Web Applets

Homepage Custom Web Applets

The following table describes the elements and sections in the homepage custom Web applet XML output file.

Table Elements and Sections in the Homepage Custom Web Applet XML File

Description Element or Section

<ObjectName> contains the system name of the record type (object), which never changes.

 
<data:ObjectName>Account</data:ObjectName>

<DisplayName> contains the name of the custom Web applet.

 
<data:DisplayName>My Account Homepage Applet
</data:DisplayName>

<DisplayNameCurrentUserLang> contains the name of the custom Web applet in the language of the currently logged-in user.

 
<data:DisplayNameCurrentUserLang>
 My Account Homepage Applet
</data:DisplayNameCurrentUserLang>

<Description> contains the description of the custom Web applet.

 
<data:Description>
 This is my Account Homepage applet
</data:Description>

<Width> specifies the column width of the custom Web applet, as follows:

  • 1. Specifies single-column width.

  • 2. Specifies double-column width.

 
<data:Width>1</data:Width>

<Height> specifies the height of the custom Web applet, in pixels.

 
<data:Height>700</data:Height>

If the custom Web applet is a Dashboard applet, then the details appear in the <DashboardType> section, as follows:

  • <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 applet 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>

If the custom Web applet is an HTML applet, then the details appear in the <HTMLType> section, as follows:

  • <HTMLHeader> contains the HTML code used in an <iframe> element within the HTML header of the page to which the custom Web applet is added.

  • <HTMLBody> contains the HTML code used in an <iframe> element within the HTML body of the page to which the custom Web applet is added.

 
<data:HTMLType>
  <data:HTMLHeader></data:HTMLHeader>
  <data:HTMLBody></data:HTMLBody>
</data:HTMLType>

If the custom Web applet is a record-type homepage custom report, then the details appear in the <ReportType> section, as follows:

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

  • <ReportFlag> specifies whether the report will run automatically (true) or if users will have to click a link to refresh the report (false).

  • <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:ReportFlag>true</data:ReportFlag>
  <data:ReportPrompts>false</data:ReportPrompts>
  <data:RefreshLink>true</data:RefreshLink>
  <data:PrintLink>true</data:PrintLink>
  <data:ExportLink>true</data:ExportLink>
  </data:ReportType>

If the custom Web applet is a Report applet, then the details appear in the <WebAppletReportType> section, as follows:

  • <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 applet 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:WebAppletReportType>
  <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:WebAppletReportType>

If the custom Web applet is an RSS feed applet, then the details appear in the <FeedType> section, as follows:

  • <URL> contains the URL that is invoked when the user clicks the hyperlink.

  • <OverrideURLFlag> determines whether the user can override the URL (true) or the user cannot override the URL (false).

  • <TargetWindow> specifies the window in which the custom Web applet opens. The valid values are as follows:

  • Current Window. The custom Web applet opens in the current window.

  • New Window. The custom Web applet opens in a new window.

 
<data:FeedType>
  <data:URL></data:URL> 
  <data:OverrideURLFlag>false</data:OverrideURLFlag>
  <data:TargetWindow>New Window</data:TargetWindow>
</data:FeedType>

If the custom Web applet is a URL applet, then the details appear in the <URLType> section.

<URL> contains the URL that is invoked when the user clicks the hyperlink.

Note: Although it is possible to update or insert a custom Web applet 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:URLType>
  <data:URL>http://www.oracle.com</data:URL>
</data:URLType>

The <ListOfTranslation> section contains the translation values for the custom Web applet.

 
<data:ListOfTranslation>
. . .
</data:ListOfTranslation>

The <Translation> section contains the translation values for one language:

 
<data:ListOfTranslation>
  <data:Translation>
    <data:LanguageCode>ENU</data:LanguageCode>
    <data:DisplayName>My Account Homepage Applet
    </data:DisplayName>
  </data:Translation>
. . .
</data:ListOfTranslation>