Sales Creatio, commerce edition
PDF
This documentation is valid for Creatio version 7.16.0. We recommend using the newest version of Creatio documentation.

Create new detail

A “detail” is an element of a page that displays records of a specific object that are linked to the current record. The detail records are filtered by their relation to the record, usually, a lookup column that uses the page record’s object (e.g., the section object) as a lookup.

For example, the [Activity participants] detail shows the list of participants of the current activity, the [Activities] detail (Fig. 1) shows the list of activities linked to the current account, contact, etc.

Fig. 1 The [Activities] detail on the contact page

scr_activities_detail_on_contact_page.png 

The detail records are filtered by their relation to the record where they are displayed. For example, the list of activity participants is filtered by the current activity, the [Activities] detail on the contact page is filtered by the currently opened contact (Fig. 2), etc.

Fig. 2 Record filtering on the [Activities] detail  

scr_record_filtering_on_activities_detail.png 

You can create new custom details via the [Detail wizard], based on a configuration object. If there are no suitable objects available for your detail, you will need to create such an object.

Case

Create a new custom detail for managing equipment related to internal requests in the custom [Requests] section.

Creating a new detail involves the following general steps:

1.Create a detail configuration object (if the needed object does not yet exist)

2.Register a new detail in the Detail Wizard

3.Add an existing detail on a record page

There are several recommended and optional steps that are similar to those for customizing section pages:

1.Add section pages for your detail

2.Setting up section pages

3.Add dashboards as page widgets (optional)

4.Add mini pages (optional)

5.Customize page business logic (optional)

Create a detail configuration object

You can create a detail based on any available object. For example, use an existing “Activity” object to add the [Activities] detail in a custom section. If there is no suitable configuration object to build your detail from, you need to create a new configuration object.

There are several ways of adding configuration objects in Creatio, including using the Section Wizard. This article covers creating a new detail object in the [Object designer].

To create a new object:

1.Click btn_system_designer00005.png –>[System designer].

2.In the [Admin area] block, click [Advanced settings] (Fig. 3). The [Tools] window will open in a new browser tab.

Fig. 3 Accessing advanced settings

scr_detail_wizard_advanced_settings.png 

3.In the [Packages] area of the [Tools] window, select the package, specified in the [Current package] system setting. By default, this is the “Custom” package.

4.On the [Schemas] tab in the workspace area on the right, click [Add] –> [Object] (Fig. 4). An [Object designer] window will open in a new browser tab.

Fig. 4 Accessing object properties

scr_add_object_in_advanced_settings.png 

5.In the [Structure] area on the left, click the root node (the topmost element) of your detail object (Fig. 5) to edit its properties.

Fig. 5 The root element of the object

scr_detail_wizard_edit_object_properties.png 

6.In the [Properties] area on the right, populate the [Name] and [Title] fields in the [General] group.

For example, specify “UsrRequestEquipment” and “Request Equipment” in the [Name] and [Title] fields respectively (Fig. 6).

Fig. 6 Specifying the [Name] and [Title] fields

scr_object_properties.png 

Attention

The object name must contain a prefix, which identifies the author of the configuration changes. The prefix is specified in the “Prefix for object name” system setting. By default, the “Usr” prefix is used.

7.In the [Parent object] field, select “Base object” (Fig. 7).

Fig. 7 Selecting the parent object

scr_object_inheritance.png 

8.Click btn_com_save_no_menu.png.

As a result, a new object will be added to the configuration.

After creating the detail object, you can register the detail based on this object using the [Detail wizard]. To find your object in the [Object] lookup, use the title that you specified in the [Title] field.

Register a new detail in the Detail Wizard

To register a new detail based on an existing object, you need to register it in the [Detail wizard]:

1.Click btn_system_designer00006.png –> [System designer].

2.In the [System setup] block, click [Detail wizard].

3.In the [Title] field on the [Detail] tab, specify the name of the detail.

4.Select the detail object in the [Object] field.

The field lets you select from existing objects. Start typing the name of the needed object to filter the drop-down list. If there is no readily available object for your detail, you will need to create a new detail object.

For example, select the custom “Request Equipment” object created earlier (Fig. 8).

Fig. 8 Main properties of the detail

scr_detail_wizard_step_1.png 

5.Click [Save]. Do not close the page.

As a result, the detail will be registered. However, if you are adding a new custom detail, or if you need to add a detail to a new custom section, the detail object may not have the columns that link it to the target section.

Link the detail object to the section object

To link a detail to a section, a detail object must have a lookup column that uses the needed section object as a lookup. For example, the object for the [Activity participant] detail has the [Activity] column that uses the [Activity] object as its lookup. Likewise, the new custom [Request equipment] detail needs to have a [Request] column to link its records to different requests.

To link a detail to a section:

1.While you are still in the [Detail wizard], click the [Page] tab (Fig. 9).

Fig. 9 Navigating to editing the page

scr_open_page_tab_in_detail_wizard.png 

2.Drag the [Lookup] field from the [New column] list on the left to the workspace area on the right (Fig. 10). A [New column] popup box will appear.

Fig. 10 Creating a lookup field

drag_loookup_in_detail_wizard.gif 

3.Populate the properties in the [New column] pop-up:

a.In the [Title in DB] field, specify the displayed name of the new field, e.g., “Request;”

b.In the [Name in DB] field, specify the unique name for the field in the database, preceded by a prefix, e.g., “UsrRequestsLookup;”

Attention

The [Name in DB] field must contain a prefix that identifies the author of the configuration changes. The prefix is specified in the “Prefix for object name” system setting. By default, the “Usr” prefix is used.

c.In the [Lookup] block, click [Select existing lookup] (Fig. 11).

d.In the [Lookup] field, select the object of the section, to which the detail should be linked. For example, to link the detail to the records of the custom [Requests] section, select the “Requests” object as the lookup.

Fig. 11 The settings of a lookup column that links a detail to a section

scr_lookup_detail.png 

e.If you want the detail records to be deleted along with the section record that they are linked to, select the [Cascade connection] checkbox (Fig. 12).

Fig. 12 Cascade connection

scr_cascade_connection.png 

4.Click [Save] in the [New column] popup box to save the lookup column.

5.Click [Save] on the [Page] tab to save the detail.

As a result, a new detail will become available for adding in the section. For example, a custom [Request equipment] detail will become available for adding in the custom [Requests] section.

Once the setup of the new detail is complete, you will need to add the detail to the section page.

See also

Add an existing detail on a record page

Setting up section pages

Customize page business logic

Did you find this information useful?

How can we improve it?