Elements and Sections in the Related Information Layout XML Output File

The following table describes the elements and sections in the related information layout XML output file.

Table Elements and Sections in the Related Information Layout XML File

Description Element or Section

<IncludeAll> specifies whether the preconfigured related information layouts are returned in addition to the customized layouts (true), or if only the customized layouts are returned. The default setting is false.

<data:IncludeAll>false</data:IncludeAll>

<CurrentUserOnly> specifies whether the output must contain only the related information layouts that are associated with the current user's role. If it is set to true, then only the layouts that are associated with the current user’s role are included. If it is set to false or null, then the output is not restricted to the layouts that are associated with the current user’s role. The default setting is false.

<data:CurrentUserOnly>false
</data:CurrentUserOnly>

<ObjectName> contains the system name of the parent record type (object), which never changes.

<data:ObjectName>Account</data:ObjectName>

<RelatedInformationName> contains the child applet ID of the related information section. For information about child applet IDs and their mappings to the names of the related information sections as they appear in the UI, see Child Applet IDs and Their Corresponding Names.

<data:RelatedInformationName>
 OptyChildList
</data:RelatedInformationName>

<Name> contains the name given to the related information layout.

<data:Name>Opportunities</data:Name>

<Description> contains the description of the layout.

<data:Description>Test Related Opportunities
</data:Description>

For certain record types only, you can specify how the related records are sorted in the related information section when a user opens the parent record detail page, as follows:

  • <SortField> corresponds to the Sort By field in the Page Layout wizard. It displays the name of the field that is used to sort the related records in the related information section when the parent record detail page opens.

  • <SortDir> specifies the sort order for the records in the related information section. The valid values are Ascending and Descending.

For a list of the related information sections that support the sort feature, and the valid values for the <SortField> element, see Support for the Sort Feature in Related Information Sections.

<data:RelatedInformationLayout>
. . .
  <data:SortField>Primary Revenue Close DateName</data:SortField>
  <data:SortDir>Ascending</data:SortDir>
. . .
<data:RelatedInformationLayout>

<EnableListAdd> is available for certain related information sections only. It determines whether the List Add feature is enabled for the related information section (true) or is not enabled (false). 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.

<data:EnableListAdd>true</data:EnableListAdd>

The <ListOfSelectedField> section contains a <SelectedField> child section for each field that appears in the Selected Fields list in the related information layout.

<data:ListOfSelectedField>
. . .
</data:ListOfSelectedField>

The <SelectedField> section contains the details of one field in the Selected Fields list in the related information layout:

  • <FieldName> contains the name of the field.

  • <Sequence> specifies the sequence of the field in the Selected Fields list. The valid values are the integers 0 through 19.

<data:ListOfSelectedField>
  <data:SelectedField>
    <data:FieldName>Contact Full Name</data:FieldName>
    <data:Sequence>0</data:Sequence>
  </data:SelectedField>
. . .
</data:ListOfSelectedField>