ActionBarLayoutUpsert

Updates an existing action bar and global header layout or inserts a new layout.

Usage

Use the ActionBarLayoutUpsert method to insert or update an existing action bar and global header layout.

The abldata:ActionBarLayout argument contains the following elements containing layout data:

  • LayoutName. The name of the layout.

  • Description. A description of the layout.

  • ListOfSections. Contains all of the available sections for the layout. The data for a particular section is contained in the following elements:

  • Name. The name of the section, which can be a custom Web applet configured for the action bar, or one of the following:

    • Calendar Action Applet

    • Global Search Multi Field

    • Quick Create

    • Quick Favorite Lists

    • Quick Favorite Records

    • Quick History

    • Quick Message Center

  • Displayed. Whether the section is displayed in the action bar.

  • Sequence. The position of the section within the action bar layout. This corresponds to step 2 in the Action Bar and Global Header Layouts wizard in the UI. The integer value can be one of the following:

    • -3. The section is in the Global Header Available Sections list.

    • -2. The section is in the Not Available Sections list.

    • -1. The section is in the Action Bar Available Sections list.

    • Positive integers. The section is in the Action Bar Displayed Sections list. The integer value indicates the location of the section within the list, with 0 (zero) meaning the section is located at the top of the list.

  • GlobalHeaderSection. Whether the section is a global header section.

  • ListOfGlobalHeaders. Contains the details for the global header section, and the data for a global header section is contained in the following elements:

    • Order. The order in which the section is displayed in the global header (required).

    • Icon. The name of the icon for the section (required).

    • Applet. The name of the section (required).

    • AppletWidth. The width of the section (required).

    • AppletDescription. A description.

See Oracle Migration Tool On Demand Guide for information about mappings of action bar section names to the display names for the sections in the Oracle CRM On Demand user interface.

Arguments

The following table describes the arguments taken by the ActionBarLayoutUpsert method.

Table Arguments Taken by the ActionBarLayoutUpsert Method

Name Description Required Default I/O

ablData:ActionBarLayout

The layout 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.