Customize Detail

Download as docx, pdf, or txt
Download as docx, pdf, or txt
You are on page 1of 4

VERSION: 8.

Customize detail
LEVEL: BEGINNER
NOTE

The functionality is relevant to Classic UI.

A detail is a UI element on the record page that displays additional data


relevant to the main section object. For example, the details of contact page
stores data about contact activities, addresses, documents, etc. Most details
have a dedicated list. Some details, for example, Communication options,
are not displayed as a list. Visually, a detail and a field group are different in
that the former has a data management toolbar. The available actions include
adding and editing records, sorting, filtering, setting up the detail, and more.

Creatio displays section details on tabs of the record page in the tab container.

Detail structure
View the structural items of the detail in the table below.

Structural Element to
Setup example
item set up
The ContactAddress object schema of
the Base package corresponds to
Detail object Section
the Addresses detail of the contact page. The
schema object
detail is connected to the section object via the
required Contact column of the detail object.
Detail view Structure, Set up the Addresses detail on the contact page in
model position, and the ContactAddressDetailV2 view model schema of
behavior of the detail that inherits
schema
detail the BaseAddressDetailV2 schema of the Uiv2 package.
View model Set up the properties of the Addresses detail page
schema of the on the contact page in the ContactAddressPageV2 view
Detail page
detail record model schema of the detail that inherits
page the BaseAddressPageV2 schema of the Uiv2 package.

Implement a detail
The BaseDetailV2 schema of the NUI package implements the functionality of a
base detail.

Implement a detail using the following tools:

 Detail Wizard
 Creatio IDE

Implement a detail using the Detail Wizard


1. Create a custom detail. Instructions: Create a detail (user
documentation).
2. Add the custom detail to a record page. Instructions: Add an existing
detail to a record page (user documentation).
3. Set up the appearance of the custom detail (optional).
Instructions: Add an existing detail on a record page (user
documentation).

Implement a detail using the Creatio IDE


1. Create a custom detail.
i. Implement an object schema of the detail. Instructions: Implement
an object.
ii. Implement a view model schema of the detail. Instructions: View
model schema.
iii. Add custom styles of the detail (optional).
iv. Register the detail in the database (optional).
2. Add the custom detail to a record page.

Implement a replacing view model schema of the record page to place


the detail. Instructions: Implement a replacing module.

3. Set up the appearance of the custom detail (optional).


Instructions: Add an existing detail on a record page (user
documentation).
Implement bulk addition of records to a
detail
Out of the box, only one record can be added to a detail.
The LookupMultiAddMixin mixin lets you expand the action that adds a record to
the detail and enable users to select multiple lookup records at once.

To implement the bulk addition of records to a detail:

1. Create a replacing view model schema of the detail.


Instructions: Implement a replacing module.
2. Implement the business logic that lets you select multiple lookup
records at once.
i. Go to the mixins property.
ii. Add the LookupMultiAddMixin mixin.
iii. Go to the methods property.
iv. Implement the following methods.

Method Method description


Implements the logic that Creatio
executes when loading the module.
init()
Initialize the LookupMultiAddMixin mixin in
the method. Learn more: Module types.
getAddRecordButtonVisibl
Displays the Add button.
e()
Saves the detail page. Use
the openLookupWithMultiSelect() method
onCardSaved()
to call the multiple selection dialog box
in the overridden method.
Adds a record to the detail. Use
the openLookupWithMultiSelect() method
addRecord() in the overloaded method, similar to
the onCardSaved() method. Set to true to
check if the record is new.
Configures the dialog box and returns
the configuration object of the box.
getMultiSelectLookupConfi
The getMultiSelectLookupConfig() method
g()
is connected to
the openLookupWithMultiSelect() method.

Delete a detail
IMPORTANT
To delete a detail, make sure you have the Can manage configuration
elements (CanManageSolution code) system operation permission and database
access.

To delete a detail:

1. Unlock the files of the detail to delete in the SVN repository.


2. Delete the records from the database. To do this, execute the
following SQL query.

SQL query

DECLARE @Caption nvarchar(max);


SET @Caption = 'UsrDetailSchemaName';
DECLARE @UId UNIQUEIDENTIFIER;
select @UId = EntitySchemaUId from SysDetail
where Caption = @Caption
delete from SysDetail where EntitySchemaUId = @UId

3. Open the Configuration section. Instructions: Open


the Configuration section.
4. Select a user-made package to delete the view model schema of the
detail and schema of the detail object.

See also
Create a detail (user documentation)

Add an existing detail on a record page (user documentation)

Configuration elements

Module types

Creatio IDE overview

You might also like