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

DetailPageCustomWebAppletUpsert


Updates an existing detail page Web applet or inserts a new Web applet.

Usage

Use the DetailPageCustomWebAppletUpsert method to insert or update an existing detail page Web applet.

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:DetailPageCustomWebApplet argument contains the following elements containing detail page Web applet data:

  • ObjectName. The record type. Required.
  • 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.
  • 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.
    • AlwaysRun. Whether the Web applet will be executed if the applet is minimized.
  • URLType. Settings for a URL Web applet:
    • URL. The URL that is invoked when the user clicks the hyperlink.
    • AlwaysRun. Whether the Web applet will be executed if the applet is minimized.
  • ModernIconName. The file name of the modern theme icon for the Web applet.
  • 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.

Arguments

Table 107 describes the arguments taken by the DetailPageCustomWebAppletUpsert method.

Table 107. Arguments Taken by the DetailPageCustomWebAppletUpsert Method
Name
Description
Required
Default
I/O

apData:DetailPageCustomWebApplet

The Web applet data to be inserted or updated.

Yes

Not applicable

Input

Status

The status of the call.

Not applicable

Not applicable

Output

Return Value of the Call

The status is returned.

Oracle Web Services On Demand Guide, Version 25.0 (Oracle CRM On Demand Release 37) Copyright © 2018, Oracle and/or its affiliates. All rights reserved. Legal Notices.