1. Oracle Migration Tool On Demand Guide
  2. What's New in This Release

11Migrating Custom Web Applets

Migrating Custom Web Applets

This chapter describes how to migrate custom Web applets by using the Oracle Migration Tool On Demand client. It contains the following topics:

Custom Web Applets

A custom Web applet embeds external Web content, a report, or a dashboard in Oracle CRM On Demand record-type homepages or detail pages, in the Action bar, or in the Home tab (My Homepage). Typically, the content is embedded by creating a custom Web applet that is added to the page layout for a homepage or detail page. For more information, see the topics about custom Web applets in Oracle CRM On Demand Online Help.

The following table describes the Oracle Migration Tool On Demand client commands used with custom Web applets. For more information about running these commands, see Migrating Custom Web Applets.

Table Commands Used with Custom Web Applets in Oracle Migration Tool On Demand

Command Description

Read HomepageCustomWebApplet SystemNameOfObject [HomePageWebAppletName]

This command exports all the homepage custom Web applets for a specified object, such as Account, or a specific homepage custom Web applet for a specified record type (object), where:

  • SystemNameOfObject is the specified record type. The system names for the record types are listed in System Names for Record Types.

  • HomePageWebAppletName is the name of a homepage custom Web applet.

Read DetailPageCustomWebApplet SystemNameOfObject [DetailPageWebAppletName]

This command exports all the detail page custom Web applets for a specified object, such as Account, or a specific detail page custom Web applet for a specified object, where:

  • SystemNameOfObject is the specified record type.

  • DetailPageWebAppletName is the name of a detail page custom Web applet.

Read ActionBarCustomWebApplet ActionBarWebAppletName

This command exports the specified Action bar custom Web applet from Oracle CRM On Demand.

Read HomeTabCustomWebApplet HomeTabCustomWebAppletName

This command exports the specified Home tab custom Web applet from Oracle CRM On Demand.

ReadAll WebAppletType

This command exports all custom Web applets of WebAppletType from Oracle CRM On Demand, where WebAppletType is one of the following:

  • HomepageCustomWebApplet

  • DetailPageCustomWebApplet

  • ActionBarCustomWebApplet

  • HomeTabCustomWebApplet

Upsert WebAppletType MyWebAppletXML

This command updates or inserts a custom Web applet into Oracle CRM On Demand, where WebAppletType is one of the following:

  • HomepageCustomWebApplet

  • DetailPageCustomWebApplet

  • ActionBarCustomWebApplet

  • HomeTabCustomWebApplet
Note: Nonadministrative Oracle CRM On Demand users can run the ReadAll command.

Privileges Required for Migrating Custom Web Applets

The following privileges are required for the user account running the Oracle Migration Tool On Demand client commands:

  • For the Read and ReadAll command: Enable Web Services Access.

  • For the Upsert command: Enable Web Services Access, Manage Custom Web Applets, and Customize Application. In addition, detail page custom Web applets and homepage custom Web applets also require Manage Object Access for custom objects that have been set up in the company tenant, for example, Customize Application - Manage Custom Object 01, and so on.

For information about setting and checking privileges, see Oracle CRM On Demand Online Help.

Elements and Sections in the Web Applet XML Output File

The following topics describe the elements and sections for various types of custom Web applet:

    Detail Page Custom Web Applets

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

    Table Elements and Sections in the Detail Page 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 Detail Page 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 Detail Page Applet
</data:DisplayNameCurrentUserLang>

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

    		 
    <data:Description></data:Description>

    <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 filters that are to be applied at runtime. For information about specifying filters for embedded dashboards, see Oracle CRM On Demand Online Help.

    • <AlwaysRun> determines whether the custom Web applet will be executed if the applet is minimized (true) or will not be executed if the applet is minimized (false).

    		 
    <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:AlwaysRun>false</data:AlwaysRun>
</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.

    • <AlwaysRun> determines whether the custom Web applet will be executed if the applet is minimized (true) or will not be executed if the applet is minimized (false).

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

    If the custom Web applet is a Report applet, 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.

    • <ReportParameters> specifies any filters that are to be applied at runtime. For information about specifying filters 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).

    • <AlwaysRun> determines whether the custom Web applet will be executed if the applet is minimized (true) or will not be executed if the applet is minimized (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:AlwaysRun>false</data:AlwaysRun>
</data:ReportType>

    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, as follows:

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

    • <AlwaysRun> determines whether the custom Web applet will be executed if the applet is minimized (true) or will not be executed if the applet is minimized (false).

    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:AlwaysRun>false</data:AlwaysRun>
</data:URLType>

    <ModernIconName> contains the file name of the modern theme icon for the custom Web applet. For more information about modern theme icons, see Classic and Modern Theme Icons. 

    <data:ModernIconName>mod_account_25.png
</data:ModernIconName>

    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 Detail PageApplet
    </data:DisplayName>
  </data:Translation>
. . .
</data:ListOfTranslation>

      Action Bar Custom Web Applets

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

      Table Elements and Sections in the Action Bar Custom Web Applet XML File

      Description Element or Section

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

      		 
      <data:DisplayName>My Action Bar Applet
</data:DisplayName>

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

      		 
      <data:DisplayNameCurrentUserLang>
 My Action Bar Applet
</data:DisplayNameCurrentUserLang>

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

      		 
      <data:Description></data:Description>

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

      		 
      <data:Height>200</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 filters that are to be applied at runtime. For information about specifying filters for embedded dashboards, see Oracle CRM On Demand Online Help.

      • <AlwaysRun> determines whether the custom Web applet will be executed if the applet is minimized (true) or will not be executed if the applet is minimized (false).

      		 
      <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:AlwaysRun>false</data:AlwaysRun>
</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.

      • <AlwaysRun> determines whether the custom Web applet will be executed if the applet is minimized (true) or will not be executed if the applet is minimized (false).

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

      If the custom Web applet is a Report applet, 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.

      • <ReportParameters> specifies any filters that are to be applied at runtime. For information about specifying filters for embedded analyses, see Oracle CRM On Demand Online Help.

      • <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).

        Note: Displaying prompts for an analysis is not supported for Report applets in the Action bar, therefore the <ReportPrompts> element is not applicable for a Report applet in the Action bar.

      • <AlwaysRun> determines whether the custom Web applet will be executed if the applet is minimized (true) or will not be executed if the applet is minimized (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:RefreshLink>true</data:RefreshLink>
  <data:PrintLink>true</data:PrintLink>
  <data:ExportLink>true</data:ExportLink>
  <data:AlwaysRun>false</data:AlwaysRun>
</data:ReportType>

      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, as follows:

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

      • <AlwaysRun> determines whether the custom Web applet will be executed if the applet is minimized (true) or will not be executed if the applet is minimized (false).

      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:AlwaysRun>false</data:AlwaysRun>
</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 Action Bar Applet
    </data:DisplayName>
  </data:Translation>
. . .
</data:ListOfTranslation>

        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 filters that are to be applied at runtime. For information about specifying filters 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 filters that are to be applied at runtime. For information about specifying filters 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>

          Home Tab Custom Web Applets

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

          Table Elements and Sections in the Home Tab Custom Web Applet XML File

          Description Element or Section

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

          		 
          <data:DisplayName>MyHomepage Applet
</data:DisplayName>

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

          		 
          <data:DisplayNameCurrentUserLang>
 MyHomepage Applet
</data:DisplayNameCurrentUserLang>

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

          		 
          <data:Description>This is my MyHomepage 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 filters that are to be applied at runtime. For information about specifying filters 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 My 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>false</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 filters that are to be applied at runtime. For information about specifying filters 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:Translation>
    <data:LanguageCode>ENU</data:LanguageCode>
    <data:DisplayName>MyHomepage Applet
    </data:DisplayName>
  </data:Translation>
. . .
</data:ListOfTranslation>

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

          		 
          <data:ListOfTranslation>
  <data:Translation>
    <data:LanguageCode>ENU</data:LanguageCode>
    <data:DisplayName>MyHomepage Applet
    </data:DisplayName>
  </data:Translation>
. . .
</data:ListOfTranslation>

            Migrating Custom Web Applets

            The following topics provide examples of how to use the Oracle Migration Tool On Demand client to migrate custom Web applets:

            Note: Back up your configuration data and all other relevant data before running the Oracle Migration Tool On Demand client.

              Extracting a Single Custom Web Applet

              This topic describes how to extract a single custom Web applet from the Oracle CRM On Demand server for your environment (customer test environment or production).

              Note: Users require the Enable Web Services Access privilege to run the Read operation. The Oracle Migration Tool On Demand client requests your Oracle CRM On Demand password, which can be redirected (by using the pipe command) to the client program from standard input; that is, from a file, from the command line, or from another program.

              Syntax for Extracting a Single Detail Page Custom Web Applet

              The following is the syntax for using the Oracle Migration Tool On Demand client to extract a single detail page custom Web applet:

              migrationtool -u UserID -s ServerURL Read DetailPageCustomWebApplet SystemNameOfObject DetailPageWebAppletName

              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 extract the custom Web applet, for example, Account.

              • DetailPageWebAppletName is the name of the detail page custom Web applet that you want to extract.

              Syntax for Extracting a Single Action Bar Custom Web Applet

              The following is the syntax for using the Oracle Migration Tool On Demand client to extract a single Action bar custom Web applet:

              migrationtool -u UserID -s ServerURL Read ActionBarCustomWebApplet ActionBarWebAppletName

              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.

              • ActionBarWebAppletName is the name of the Action bar custom Web applet that you want to extract.

              Syntax for Extracting a Single Homepage Custom Web Applet

              The following is the syntax for using the Oracle Migration Tool On Demand client to extract a single homepage custom Web applet:

              migrationtool -u UserID -s ServerURL Read HomepageCustomWebApplet SystemNameOfObject HomePageWebAppletName

              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 extract the custom Web applet, for example, Account. The system names for the record types are listed in System Names for Record Types.

              • HomepageWebAppletName is the name of the homepage custom Web applet that you want to extract.

              Syntax for Extracting a Single Home Tab Custom Web Applet

              The following is the syntax for using the Oracle Migration Tool On Demand client to extract a single Home tab custom Web applet:

              migrationtool -u UserID -s ServerURL Read HomeTabCustomWebApplet HomeTabWebAppletName

              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.

              • HomeTabWebAppletName is the name of the Home tab custom Web applet that you want to extract.

                Extracting a Set of Custom Web Applets for a Single Object

                This topic describes how to extract a set of custom Web applets for a specified object (record type) from the Oracle CRM On Demand server for your environment (customer test environment or production).

                Note: Users require the Enable Web Services Access privilege to run the Read operation. The Oracle Migration Tool On Demand client requests your Oracle CRM On Demand password, which can be redirected (by using the pipe command) to the client program from standard input; that is, from a file, from the command line, or from another program.

                Syntax for Extracting All Detail Page Custom Web Applets for a Single Object

                The following is the syntax for using the Oracle Migration Tool On Demand client to extract all detail page custom Web applets for a specified record type:

                migrationtool -u UserID -s ServerURL Read DetailPageCustomWebApplet 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 custom Web applets, for example, Account.

                Syntax for Extracting All Homepage Custom Web Applets for a Single Object

                The following is the syntax for using the Oracle Migration Tool On Demand client to extract all homepage custom Web applets for a specified record type:

                migrationtool -u UserID -s ServerURL Read HomepageCustomWebApplet 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 custom Web applets, for example, Account. The system names for the record types are listed in System Names for Record Types.

                  Extracting All Custom Web Applets

                  This topic describes how to extract all custom Web applets from your Oracle CRM On Demand environment; that is, a customer test environment or production environment.

                  Note: The Manage Custom Web Applets privilege is required to run the ReadAll command.

                  Syntax

                  The following is the syntax for using the Oracle Migration Tool On Demand client to extract all custom Web applets for Oracle CRM On Demand homepages, detail pages, the Action bar, and the Home tab:

                  migrationtool -u UserID -s ServerURL ReadAll HomepageCustomWebApplet
migrationtool -u UserID -s ServerURL ReadAll DetailPageCustomWebApplet
migrationtool -u UserID -s ServerURL ReadAll ActionBarCustomWebApplet
migrationtool -u UserID -s ServerURL ReadAll HomeTabCustomWebApplet

                  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.

                  Note: The Oracle Migration Tool On Demand client requests your Oracle CRM On Demand password, which can be redirected (by using the pipe command) to the client program from standard input; that is, from a file, from the command line, or from another program.

                  The output from the Oracle Migration Tool On Demand client is located in the following directories:

                  migration tool install/repository/WebAppletType/Object/WebApplet.xml

                  where:

                  • WebAppletType is one of the following:

                    • HomepageCustomWebApplet

                    • DetailPageCustomWebApplet

                    • ActionBarCustomWebApplet

                    • HomeTabCustomWebApplet

                  • Object is the Oracle CRM On Demand object or record, for example, Account.

                  • WebApplet.xml is the series of XML files where the Web applet configuration data is stored, for example, first Web Applet.xml file, second Web Applet.xml file, and so on.

                  The following is an example of extracting all custom Web applets in all homepages from your Oracle CRM On Demand server:

                  migrationtool -u UserID -s ServerURL ReadAll HomepageCustomWebApplet

                    Updating or Inserting a Custom Web Applet Definition (Upsert)

                    This topic describes how to update a custom Web applet definition (if it exists) or insert the Web applet definition (if it does not exist) in your Oracle CRM On Demand environment; that is, a customer test environment or production environment.

                    Note: The Enable Web Services Access and Customize Application privileges are required to run the Upsert operation.

                    The configuration data is updated when the Web applet name exists in the target company for the object or record for which the Upsert operation is being run; otherwise the Web applet is inserted.

                    The following table shows the result of an Upsert operation if the target company has a Web applet called My Custom Applet for the Account object on the detail page.

                    Table Result of an Upsert Operation on a Target Company

                    If the XML definition contains... Then the result is ...

                    Name: My Custom Applet

                    Object: Account

                    Location: Detail Page

                    The existing My Custom Web Applet is updated for the Account object, which is on the detail page.

                    Name: MY Custom Applet

                    Object: Account

                    Location: Detail Page

                    MY Custom Applet is inserted into the target company. The company now contains the following Account Web Applets:

                    • My Custom Applet

                    • MY Custom Applet

                    Name: My Custom Applet

                    Object: Opportunity

                    Location: Detail Page

                    My Custom Applet is inserted into the target company for the Opportunity object. The company now contains:

                    • For the Account object: My Custom Applet

                    • For the Opportunity object: My Custom Applet

                    Name: My Custom Applet

                    Object: Global

                    Location: Action Bar

                    My Custom Applet is inserted into the target company for the Global Web Applet section. The company now contains:

                    • For the Account object: My Custom Applet

                    • For the Global Web Applet section: My Custom Applet

                    Syntax

                    The following is the syntax for using the Oracle Migration Tool On Demand client to update a custom Web applet (if it exists) or inserting the custom Web applet (if it does not exist):

                    migrationtool -u UserID -s ServerURL Upsert WebAppletType MyWebAppletXML

                    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.

                    • WebAppletType is one of the following:

                      • HomepageCustomWebApplet

                      • DetailPageCustomWebApplet

                      • ActionBarCustomWebApplet

                      • HomeTabCustomWebApplet

                    • MyWebAppletXML is the fully qualified path name of the customized Web applet XML file, for example: 

                      C:\My Files\MyWebApplet.xml
                    Note: The Oracle Migration Tool On Demand client requests your Oracle CRM On Demand password, which can be redirected (by using the pipe command) to the client program from standard input; that is, from a file, from the command line, or from another program.

                    Examples of Updating or Inserting a Custom Web Applet

                    The following are examples of updating a custom Web applet (if it exists) or inserting the Web applet (if it does not exist) in your Oracle CRM On Demand server:

                    • For homepage custom Web applets:

                      migrationtool -u UserID -s ServerURL Upsert HomepageCustomWebApplet "C:\My Files\MyHomepageCustomWebApplet.xml"

                    • For Detail page custom Web applets:

                      migrationtool -u UserID -s ServerURL Upsert DetailPageCustomWebApplet "C:\My Files\MyDetailPageCustomWebApplet.xml"

                    • For Action bar custom Web applets:

                      migrationtool -u UserID -s ServerURL Upsert ActionBarCustomWebApplet "C:\My Files\MyActionBarCustomWebApplet.xml"

                    • For Home tab custom Web applets:

                      migrationtool -u UserID -s ServerURL Upsert HomeTabCustomWebApplet "C:\My Files\MyHomeTabCustomWebApplet.xml"
                      Note: Quotation marks are required if the file name or path contains spaces.