Oracle Web Services On Demand Guide > Web Services On Demand API Calls > Administrative Services API Calls >

HomeTabCustomWebAppletUpsert

Updates an existing My Homepage tab Web applet or inserts a new Web applet.

Usage

Use the HomeTabCustomWebAppletUpsert method to insert or update an existing My Homepage tab Web applet or custom report.

If the Enable Language Translation Support for Web Applets check box is selected in the company profile, then you can use the <LanguageCode> and <DisplayName> child elements of the <Translation> element to insert or update translations of the Web applet display name in each language for your company.

The apData:HomeTabCustomWebApplet argument contains the following elements containing My Homepage tab Web applet data:

• DisplayName. The name of the Web applet. Required.
• DisplayNameCurrentUserLang. The name of the Web applet in the language of the currently logged-in user.
• Description. A description for the Web applet.
• Width. The column width of the applet: 1 for Single, 2 for Double.
• Height. The height of the applet in pixels.
• FeedType. Settings for an RSS feed applet:
  • URL. The URL that is invoked when the user clicks the hyperlink.
  • OverrideURLFlag. Whether or not the user can override the URL.
  • TargetWindow. The window in which the Web applet opens: Current Window or New Window.
• HTMLType. Settings for an HTML Web applet:
  • HTMLHeader. HTML code used in an <iframe> element within the HTML header of the page to which you add the Web applet.
  • HTMLBody. HTML code used in an <iframe> element within the HTML body of the page to which you add the Web applet.
• URLType. Settings for a URL Web applet:
  • URL. The URL that is invoked when the user clicks the hyperlink.
• ReportType. Settings for a custom report:
  • ReportPath. The path for the report.
  • ReportFlag. Whether the report will run automatically, and users will not have to click a link to update the report.

    NOTE:  Reports in the V3 catalog are not supported. Although you can update or insert a My Homepage custom report that contains a link to a report from the V2 catalog in Release 37 of Oracle CRM On Demand, the custom report will be read-only in the UI, and the report will not display on My Homepage even if the custom report is added to a My Homepage layout.

• ListOfTranslation. The display names in the languages activated for your company:
  • LanguageCode. The three-letter language code for the language.
  • DisplayName. The display name of the custom Web applet in the language identified by the language code.

See Oracle Migration Tool On Demand Guide for reference tables about the following:

• Mappings of three-letter language codes to languages.

See Oracle CRM On Demand Online Help for more information about creating Web applets and custom reports.

Arguments

Table 128 describes the arguments taken by the HomeTabCustomWebAppletUpsert method.

Return Value of the Call

The status is returned.