Contract settings

In contract settings, you add source apps and create properties, define access rights, customize the contract name, and so on.

начало внимание

Only users included in the Administrators group can make changes to contract settings.

конец внимание

To access the contract settings menu, click on the gear icon next to the contract name and select the desired item:

  • Access Settings. By default, access permissions for each contract item are inherited from the rights set in its source apps. Additionally, you can restrict access for the contract and its items. Read more about this in the Access to app data article.
  • Source Settings. Add sources to the contract, i. e. select from existing ones or create apps whose items will be shown on the contract page. On this page, you can also match the contract fields with the fields of the added source. Read more about this in the Add a source app article.
  • Contract Fields. View existing contract fields and create new properties. Fields with the same types as each of its source apps must be added to the contract. Otherwise, it will not be possible to connect the app to the contract. Read more about this in the Work with contract fields article.
  • Contract Settings. Managing contract settings is similar to managing app settings. You can change the contract name and its icon in the left menu, add a description, select the mode of displaying records in the search bar, etc., and enable bulk actions with items.
  • Access to Contract. Identify the user groups for which the contract will be displayed in the left menu of the section in which it is created. They will be able to view the contract page and work with the contract items. Access settings are configured in the same way as for system apps. Read more about this in the Access to an app article.
  • API. Use API methods to manage a contract using web requests. For example, you can create, edit, or retrieve data from items added to a contract. It is done in the same way as with API in apps. Read more about API methods in BRIX Web API.
  • Version History. Becomes available in the contract settings menu if structure versioning is enabled. Contains a list of versions of the contract and its page, which are created whenever specific contract or source settings are changed. You can then restore a previous version and make it current. The table below explains which settings trigger the creation of a new version of the contract or page.

Contract settings

A new contract version is created

A new contract page version is created

Contract name

Yes

Yes

Description

-

Yes

App icon

-

Yes

Bulk actions

Yes

-

Show

-

Yes

Additional parameters

-

-

Display number of app items

Yes

-

Contract fields

Yes

-