1. Web Services On Demand Guide
  2. RelatedInformationLayoutUpsert

RelatedInformationLayoutUpsert

Updates existing related information layout data or inserts new related information layout data.

Usage

Use the RelatedInformationLayoutUpsert method to insert or update related information layout data for an object.

The apdata:RelatedInformationLayout argument contains the following elements containing related information layout data:

  • ObjectName. The name of the object.

  • RelatedInformationName. A child object ID, equivalent to the name of a related information section. See Oracle Migration Tool On Demand Guide for reference tables about the mapping of child object IDs to UI display names for the child objects.

  • Name. The name of the related information layout.

  • Description. A description of the related information layout.

  • SortField. The field used for sorting records. The <SortField> element, together with the <SortDir> element, defines the sort order for the related records in the related information section when a user opens the parent record detail page. It is available for certain related information sections only. Details of the related information sections that support the sort feature and the valid values for the SortField element are provided later in this topic.

  • SortDir. The sort order, which can be Ascending or Descending. The <SortDir> element is applicable only for the related information sections that support a default sort order.

  • EnableListAdd. Whether the List Add feature is enabled (true) or is not enabled (false). Available for certain record types only. The List Add feature allows users to add multiple records to the related information section at one time. For a list of the related information sections that support the List Add feature, see Oracle CRM On Demand Online Help.

  • ListOfSelectedField. Contains all of the selected fields for the related information layouts. The field data for a particular related information layout is contained in the following child elements of <SelectedFieldData>:

    • FieldName. The name of the selected field. Required.

    • Sequence. An integer with the range of values 0 through 19, specifying the sequence of the field in the Selected Fields list.

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

  • Mappings of object names to the display names for the objects in the Oracle CRM On Demand user interface.

Support for the Sort Feature in Related Information Sections

The following table shows the parent object and related information combinations for which you can optionally configure a sort field and sort order. The table also shows the valid values for the <SortField> element for each of the listed related information sections.

Parent Object Related Inormation Sort Fields

Account

Assets

  • Product Name

  • Serial Number. Corresponds to the Serial # field.

  • Product Status. Corresponds to the Status field.

Completed Activities

Due Date

Contacts

  • Last Name.

  • Primary Contact Flag. Corresponds to the Primary Contact check box.

Open Appointments

Planned. Corresponds to the Start Time field.

Opportunities

  • Primary Revenue Close Date. Corresponds to the Close Date field.

  • Created. Corresponds to the Created: Date field.

  • Name. Corresponds to the Opportunity Name field.

  • Updated. Corresponds to the Modified: Date field.

Service Requests

  • Created. Corresponds to the Created: Date field.

  • SR Number. Corresponds to the Service Number field.

Campaign

Opportunities

  • Primary Revenue Close Date. Corresponds to the Close Date field.

  • Created. Corresponds to the Created: Date field.

  • Name. Corresponds to the Opportunity Name field.

  • Updated. Corresponds to the Modified: Date field.

Contact

Accounts

  • Last Name

  • Primary Contact Flag. Corresponds to the Primary Contact check box.

Assets

  • Product Name

  • Serial Number. Corresponds to the Serial # field.

  • Product Status. Corresponds to the Status field.

Completed Activities

Due Date

Open Appointments

Planned. Corresponds to the Start Time field.

Opportunities

  • Primary Revenue Close Date. Corresponds to the Close Date field.

  • Created. Corresponds to the Created: Date field.

  • Name. Corresponds to the Opportunity Name field.

  • Updated. Corresponds to the Modified: Date field.

Service Requests

  • Created. Corresponds to the Created: Date field.

  • SR Number. Corresponds to the Service Number field.

Custom Objects 01 through 03

Assets

  • Product Name

  • Serial Number. Corresponds to the Serial # field.

  • Product Status. Corresponds to the Status field.

Opportunities

  • Primary Revenue Close Date. Corresponds to the Close Date field.

  • Created. Corresponds to the Created: Date field.

  • Name. Corresponds to the Opportunity Name field.

  • Updated. Corresponds to the Modified: Date field.

Custom Objects 04 through 40

Assets

  • Product Name

  • Serial Number. Corresponds to the Serial # field.

  • Product Status. Corresponds to the Status field.

Dealer

Contacts

  • Last Name.

  • Primary Contact Flag. Corresponds to the Primary Contact check box.

Opportunities

  • Primary Revenue Close Date. Corresponds to the Close Date field.

  • Created. Corresponds to the Created: Date field.

  • Name. Corresponds to the Opportunity Name field.

  • Updated. Corresponds to the Modified: Date field.

Objective

Opportunities

  • Primary Revenue Close Date. Corresponds to the Close Date field.

  • Created. Corresponds to the Created: Date field.

  • Name. Corresponds to the Opportunity Name field.

  • Updated. Corresponds to the Modified: Date field.

Opportunity

Assets
  • Product Name
  • Serial Number. Corresponds to the Serial # field.
  • Product Status. Corresponds to the Status field.

Completed Activities

Due Date

Contacts

Last Name

Open Appointments

Planned. Corresponds to the Start Time field.

Sub-Opportunities

  • Primary Revenue Close Date. Corresponds to the Close Date field.

  • Created. Corresponds to the Created: Date field.

  • Name. Corresponds to the Opportunity Name field.

  • Updated. Corresponds to the Modified: Date field.

Partner

Contacts

  • Last Name.

  • Primary Contact Flag. Corresponds to the Primary Contact check box.

Partner Program

Opportunities

  • Primary Revenue Close Date. Corresponds to the Close Date field.

  • Created. Corresponds to the Created: Date field.

  • Name. Corresponds to the Opportunity Name field.

  • Updated. Corresponds to the Modified: Date field.

Service Request

Completed Activities

Due Date

Open Appointments

Planned. Corresponds to the Start Time field.

Arguments

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

Table Arguments Taken by the RelatedInformationLayoutUpsert Method

Name Description Required Default I/O

apData:RelatedInformationLayout

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