Related Data area (Header Info Areas)
Learn about the Related Data area.
The Infoareas area of the ExpandChildren
and
SearchSubList
header definition defines the Related
Data area. It determines which sub-lists containing records from linked info
areas or other related information displayed via forms are displayed at the bottom of
Expand and Search pages.
The Related Data area is displayed using the DashboardPanel
widget (with
default layout = Tab) with each sub-info area configured in the
Infoareas area as a DashboardPanelItem
. For
further details, see Dashboards. The
settings for these items are defined directly in the ExpandChildren
and
SearchSubList
header configurations.
To define the Related Data area:
- Click Info Areas on the CRM.Designer main page
(Views area) and select an info area.
Or
Click Headers (either on the CRM.Designer main page (Navigation area) and select an info area. - Point at the header you want to configure, the Copy Header From Parent Configuration () button appears.
- Click . The edit and delete buttons appear.
- Click Edit . The configuration
page displays.
The following screenshot shows the Expand Children related data area configuration page.
-
Related View Layout: Determine the initial layout of the Related
Data area: Tabs, One columns, Two columns. This setting is used as initial default and
is overruled by the user's settings.Note: The display settings for the Related Data area are stored in the browser cache. Therefore to reset the initial layout, make sure users clear their browser cache.
- Add/edit the desired sub-info areas:
- Select an info area from the drop-down list and click (Add).
- Use the / buttons to rearrange the order of sub-info areas.
- For each sub-info area you can define the following:
- Link: Check Link to select another than the default link, see Link IDs. For the Document Link info area (D3) you need to specify the generic link (ID 127).
- CRM Proc: Assign one or more CRM processes to the sub-info area. For further details, see Roles & CRM Processes.
-
Fieldgroup: Defines the layout of the child records. The
List
control of the specified field group is used. For further details, see Field Groups. If undefined, the default field group<infoAreaId>
is used. -
Header: Defines the header used for the sub-info area. The
SubList
header of the specified header group is used. For further details, see SubList. If undefined, theSubList
header of the header group<infoAreaId>
of the sub-info area is used. - Text: Defines a label for the sub-info area. If undefined, the info area name (plural) is used. Use this for filtered sub-lists or for a special relation like displaying "sub-projects" of a project.
-
Filter: You can specify a filter to filter the child
records.Alternatively, you can enter a link name, see Link Names in JavaScript. Example: If you specify
$Link[FI]
for the MA sub-info area of the PRExpandChildren
header, the Activity sub-list contains all activities linked to the company and not just those linked to the current offer record.Note: You can either specify a filter or a link name. A combination of both is not possible. -
Tab Style: Defines display options for the sub-info areas
(i.e.
DashboardPanelItems
) using the JSON syntax, e.g.{allowRemove: false,allowCollapse: true}
.The following options are available:-
allowCollapse:
If set totrue
, the user can collapse the item (default:true
). -
allowRemove:
If set totrue
, the user can remove the item (default:true
). -
collapsed:
Determines the initial state (collapsed | expanded) of the item (default:false
). -
visible:
Determines whether the item is initially visible (default:true
).
Tab Style also allows you to specify a CSS class to color-code a tab. Multiple CSS classes can be separated by a space.
To ensure that the assigned style is always visible (and not just when the tab is active), add!important
to the style elements, for example:.tab_MyRedText { font-weight: bold !important; color: #b40202 !important; }
Note: The TabStyle field is limited to 50 characters. -
-
SubListParams: Defines the appearance and behavior of the
sub-list. For further details, see ListParams.Note: SubListParams defined in the header are overridden by the corresponding
subListParams
defined in the Search
action. For further details, see Search. - Menu: Defines the context menu displayed for the records in the sub-list. For further details, see Context Menus. If undefined, the context menu specified in the respective Search&List configuration is used.
- Search: The name of the Search&List configuration used for the sub-info area. For further details, see Search&List Configuration.
-
Form Name: A form or widget to be displayed. You can enter
one of the following:
- a form's name, e.g.
RecordHistory
. For further details, see Displaying a Record's History - a JavaScript object specifying a form with at least a property
formName
, e.g.{formName: "MyForm",<more properties>}
- a JavaScript object specifying a widget, e.g.
{type: "RecordMap", options: {size: {height: 400}}}
In addition you can specify under which conditions the Related Data area displays records using the
infoAreaID
property, e.g.{formName: "SerialEntry.Offer.RelatedForm", infoAreaId: "+"}
- this displays the Related Data area of the generic Offer quick add page (BTB) regardless of which record is selected in the list.For more information, syntax and examples, see the article “How to define related view” at https://support.aurea.com.
- a form's name, e.g.
-
Flags: Defines additional settings. The following options
are available:
-
ENABLECONFIG (1)
: Allows the user to configure the sub-list. -
COMPANYRELATED (2)
: Only for sub-lists of a linked company. If this flag is set, only records that are directly linked to the company are displayed, records linked to a person in that company are not displayed. (Use this e.g. for a MA sub-list to only display company-related activities). -
CHILDRELATION (4)
: Lists all children of an info area that has a hierarchy defined. Example in UPDATE_DEFAULT: TheExpandChildren
header for A1 contains a tab listing sub-tasks.Flags can be combined by adding them. 5 would mean that flags 1 and 4 are set.
-
The following screenshot shows the resulting headers in the Search Companies page. In the Related Data area it is displaying the google map showing the location of the selected company.