Open Documentation Menu

Configuring contract types

In the Contract types area, you can configure the contract types. You can use the configuration interface and make extended configurations in a JSON file.

In the Existing contract types area, created contract types including term IDs are listed. You can use the created contract types for further configuration. You can find information about creating contract types under Creating contract types.

Using the configuration interface for contract types

You can make the following settings for each contract type:

  • Defining individual lists

  • Add additional columns to be displayed in the document list

  • Sort the documents in the document list

You have two options for configuration. You can choose between the configuration interface and the advanced configuration (JSON file).

This is how it works

  1. Click New or select an existing configuration and click Edit.

  2. From the Select contract types drop-down menu, select the contract types to which this configuration will apply.

  3. Use Select custom lists to define the additional lists that will be available for contracts of this type.

  4. Use Additional fields for document list to select the additional columns to display in the document list.

  5. Select the Column for sorting drop-down menu and Sorting the document list to sort the documents in the document list.

  6. Click Save.

Parameter for configuring contract types

You can make the following settings for each contract type:

  • applyToContractTypeTermIds: The expression IDs (Term IDs) of the contract types to which customLists are added. You can find the ID of the expression in the terminology memory management.

  • customLists:

    • listName: The name of the list without the number at the end.

      Create the following lists for the sample configuration:

      • CustomNotes0

      • CustomNotes1

      • ecsCosts0

      • ecsCosts1

    • isList: The value true must always be defined for this parameter.

  • documentDetails: This section refers to the document list within the contract view.

    • additionalFields: Additional columns for the document list are configured here.

      • name: Internal field name for the column to be displayed in addition.

    • orderby: Can be optionally specified to customize the default sorting of documents in a contract.

      • fieldname: Internal field name for the column according to which sorting is performed.

      • direction: Specifies whether to sort in ascending ("asc") or descending ("desc") order.

Further information: Including additional lists.

Example of configuring contract types

In this sample configuration for the contract types, you will learn how to add more lists to the contract types. These lists are displayed when viewing the contract.

Example configuration for contract types 

[
    {
        "applyToContractTypeTermIds": [
            "c607e213-fbe1-40f2-test-3ebee18dfbd8",
            "0ebfda0f-046a-479c-test-eca81328c367"
        ],
        "customLists": [
            {
                "listName": "ecsCosts",
                "isList": true
            }
        ]
    },
    {
        "applyToContractTypeTermIds": [
            "6a2fbb47-56b3-4649-test-c182b9b0863c"
        ],
        "customLists": [
            {
                "listName": "CustomNotes",
                "isList": true
            }
        ],
                "documentDetails": {
            "additionalFields": [
                {
                    "name": "Created"
                },
                {
                    "name": "Modified"
                }
            ],
            "orderby": {
                "fieldname": "Modified",
                "direction": "ascending"
            }
                }
    }
]
Using templates to create contract types

In the Contract type templates area under Contract types, you can add pre-defined contract types to your contract management instance.

This is how it works: 

  1. Select the desired contract type.

  2. Click Details. A detailed view opens that shows all the columns that are created with this contract type.

  3. Click Add to instance to add these contract types to your instance.

The contract type is then created in the background. You can close the page if you wish. The contract type will be available to you after a short time.

Grouping of the columns in the details pane

You can group and arrange the columns in the details pane for the different contract types. By default, columns in the details pane that are not assigned to any group are displayed in two columns underneath the created groups.

This is how it works

  1. Enable grouping in the details pane. 

    Note

    If you disable grouping, the details pane of the contract file is displayed in the standard view. The configured groups are not deleted.

  2. In the dropdown menu, select the contract type for which you want to create or edit the groupings.

  3. Click New to create a group. Alternatively, select an existing group and click Edit.

  4. Enter an English name for the group.

    Note

    The English group name is a mandatory field, as English is the default system language. If the system supports other languages but no group name has been entered in other languages, the English group name is displayed.

  5. Click Add group name for another language to add a row for another language. Select a language and enter the group name in the relevant language. Repeat the process for further languages as required.

  6. Use the Single column option to define whether the row is to contain one or two columns. Note the following:

    • If you enable Single column, you can select one column that is assigned to the contract type. The column is displayed in its entire width in the contract file.

    • If you disable Single column, you can select two columns that are assigned to the contract type. The columns are displayed in the selected arrangement in a two-column view in the form of a left and a right dropdown menu.

  7. Use Add another row to add any number of additional rows to the group and configure them.

  8. Click Save to save your changes and to finish editing the group. If you click Cancel, your changes will be discarded.

  9. Create or edit further groups as needed.

  10. Under Enable grouping click Save to save all groups that you have previously created and edited. If you do not click Save and you leave the page, your changes will be discarded.