side menu

Create a contract

You can create a Contract in two ways:

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

Only users included in the Administrators group can create and configure Contracts.

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

Import a contract from a .e365 file

A contract can only be imported from another company as part of a workspace or solution. To add a contract, you must export the workspace or solution in which it is created as a .e365 file, and then import the entire contents of the file into your company. This will upload the contract with only the source apps that are part of the imported file.

Let’s look at an example of importing a contract. Suppose that in the Orders workspace you have created a Documents contract with the following sources:

Contracts app included in the Orders workspace.

Invoices app from another workspace, All Documents.

To add a contract to another company, we export the entire workspace that includes the contract. When you export the Orders workspace you will see a warning that the contract has sources from workspaces that are not exported. Continue to export the workspace by selecting export to .e365 file format.

create_contract01

When importing the Orders workspace, the Documents contract will also be added to the company. In the list of its sources, only the Contracts app will be displayed, because the source of the Invoice has not been exported to the file.

Read more about the process of exporting and importing system components in the articles:

Create a contract from scratch

Contracts are created in workspaces. You can add a new contract the same way as a standard BRIX app:

  1. Open the workspace and click the Add button in the left menu.
  2. Select the Contract option.

create-contract-01

  • Contract name*. Enter the contract’s name that will be displayed in the left menu.
  • Contract URL. The link is formed automatically based on the contract’s name. While you’re creating a contract, you can edit this link. It is used to access the contract quickly.
  • Visibility. Specify who can see the contract in the left menu of the workspace:
    • Visible to everyone. The contract will be available to all users.
    • Only to administrators. The contract will be available only to users included in the Administrators group.
  • Contract icon. A small image assigned to the contract that is displayed in the left menu of the workspace. It helps users find the right app faster.
  • Show. Choose the way items will be displayed on the contract’s page: Tiles or Table. The view you choose will be automatically applied for all users.
  1. Click Create.

The Fields Settings window will display the system fields of the contract, added by default. These are used to link the contract to source apps whose data will appear on its page.

You can add custom properties to the contract context to pass values from other source fields. When creating a contract for the first time, you can skip this step by clicking Save in the upper-right corner of the window. To edit the contract context later, go to its settings and select Fields Settings.

The created contract will appear in the left menu of the workspace. You can now proceed to configure its sources.

contract.html contract-settings.html