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

   1. Implement an object schema of the detail. Instructions: Implement an object.
   2. Implement a view model schema of the detail. Instructions: View model schema.
   3. Add custom styles of the detail (optional).
   4. 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.

   1. Go to the mixins property.

   2. Add the LookupMultiAddMixin mixin.

   3. Go to the methods property.

   4. Implement the following methods.

      Method	Method description
      init()	Implements the logic that Creatio executes when loading the module. Initialize the LookupMultiAddMixin mixin in the method. Learn more: Module types.
      getAddRecordButtonVisible()	Displays the Add button.
      onCardSaved()	Saves the detail page. Use the openLookupWithMultiSelect() method to call the multiple selection dialog box in the overloaded method.
      addRecord()	Adds a record to the detail. Use the openLookupWithMultiSelect() method in the overloaded method, similar to the onCardSaved() method. Set to true to check if the record is new.
      getMultiSelectLookupConfig()	Configures the dialog box and returns the configuration object of the box. The getMultiSelectLookupConfig() method 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