Skip to main content
Version: 8.1

Customize mini pages

Level: beginner

A mini page is a short version of a record page with a limited number of fields. Use mini pages to view or edit the record data quickly without opening the full page. The purpose of a mini page is to streamline adding, editing, and viewing records. The set of fields is configured separately and therefore is different for each mini page type.

The contact mini page
The contact mini page

You can create a mini page for any Creatio object.

Learn more about working with mini pages in user documentation: Work with mini pages.

View model schema of a mini page​

Creato IDE uses view model schemas to implement mini pages.

The view model schema of a mini page lets you set up:

  • the content of the mini page
  • the position of the mini page's UI elements
  • the behavior of the mini page's UI elements

For example, the ContactMiniPage schema configures the contact mini page and the AccountMiniPage schema configures the account mini page. The mini page schemas inherit from the BaseMiniPage schema of the NUI package.

The structure of the mini page's view model schema is the same as the general structure of the client view model schema.

The required properties of the mini page schema structure include:

  • entitySchemaName, the name of the object schema to bind the mini page
  • diff, the array of mini page's visual element modifications

The optional properties of the mini page schema structure include:

  • attributes, schema attributes
  • methods, schema methods
  • mixins, schema mixins
  • messages, schema messages

The optional properties let you:

  • add custom management elements
  • register messages
  • set up the mini page business logic

You can use custom styles to modify the appearance of mini page visual elements.

Important

Mini page business logic cannot be set up using business rules.

Mini page operations​

Add a mini page to a section​

  1. Add the view model schema of a page to a custom package.
  2. Select the BaseMiniPage schema as a parent object.
  3. Add the needed mini page functionality to the schema source code. Make sure to specify the name of the object schema to bind the mini page in the entitySchemaName element and perform at least one modification in the diff array.
  4. Modify the [SysModuleEdit] system database table via an SQL query.
  5. Add the [HasSectionCodeMiniPageAddMode] system setting. Learn more about adding system settings in user documentation: Manage system settings.
Important

The execution of an erroneous SQL query may corrupt existing data and render Creatio inoperable.

Add a mini page to a module​

You might need to connect a mini page to a Creatio module to solve a business problem. Modules let you create links to specific Creatio objects. As such, a mini page connected to a module enables users to view the object data without opening the object section.

The following Creatio modules are connected to mini pages out-of-the-box:

  • telephony in the communication panel
  • email in the communication panel
  • notification center in the communication panel
  • the Feed section in the communication panel
  • list in the dashboards section

To add a mini page to a module:

  1. Create a module schema.
  2. Create a module view and view model. Enable the Terrasoft.MiniPageUtilities utility class in the mixins view model property. The class lets you use the mini page call methods.
  3. Add the module styles.
  4. Create a container to display the module view.

See also​

Work with mini pages (user documentation)

Develop configuration elements

Packages basics

Manage system settings (user documentation)

Resources​

Client schema Creatio documentation