Open Documentation Menu

Configuring contractual partner management

In the Contractual partner area, you can configure the contractual partner management. You can choose between the configuration interface or the extended configuration based on a JSON file.

Configuration options in the configuration interface 

You can make the configurations in the areas Contractual partners and Contact persons.

Contractual partners 

  • Enable creation and editing: Enable the option for users to create new contractual partners and edit existing contractual partners.

  • Allow multiple selections: Enable the option for users to assign multiple contractual partners to a contract file.

    Warning

    If you use contractual partners in your permission rule set and you allow multiple selection, you must adjust the permission rule set for multiple selection. Otherwise the permission rules will no longer work.

  • Activate external link: If you enable this option, a link to an external website will be displayed next to the contractual partner in the contract view. Enter the URL under Link URL.

  • Search description field during selection: Enable the option for users to search the description field in addition to the title when searching for a contractual partner. If you enable this option, you must index the Description field (ecsCPDescription).

    Warning

    Enable this option only if there are less than 1,000 contractual partners in the contractual partner list.

  • Number of contractual partner proposals to be displayed: Define the maximum number of results displayed in the contractual partner selection feature when creating the contract. The default value is 10. Values below 10 are ignored. The value should not be higher than 50.

  • Enable open in 9-dot menu: Enable the option for users to switch from the 9-point menu to contractual partner management in the SharePoint list.

Contact persons 

  • Enable: Allow users to configure contact persons.

  • Display as: Configure how the contact person selection feature is displayed. You have the following options:

    • Selection: Users can select the contact person from the ecsContactPersons list.

    • Text field: Users can enter the contact person in a simple text box.

  • Enable creation and editing: Enable the option for users to create new contacts and edit existing contacts.

  • Enable open in 9-dot menu: Enable the option for users to switch from the 9-point menu to contact person management in the SharePoint list.

Parameters for the extended configuration in the JSON file

  • creationAllowed: Use the values true and false to define whether users can create new contractual partners.

  • contactPersonEnabled: Use the values true and false to define whether users can configure contact persons for contract files.

  • multiplePartnersAllowed: Use the values true and false to define whether multiple selection of contractual partners is active.

  • contactPersonManagementType: The parameter defines the options for selecting contact persons. If you enter lookup, users can select the contact persons from the ecsContactPersons list. If you enter textfield, users can enter the contact persons using a simple text box.

  • contactPersonManagementAllowed: Use the values true and false to define whether users can create and edit contact persons.

    Note

    You can only enable the parameter if contactPersonManagementType has the value lookup.

  • searchInDescriptionField: Use the values true and false to define whether users can search the description field in addition to the title when searching for a contractual partner.

  • numberOfContractualPartnerProposal: The parameter defines the maximum number of results displayed in the contract partner selection of the contract creation. The default value is 10. Values below 10 are ignored. The value should not be higher than 50.

  • externalLink: This parameter defines whether a link to an external website is displayed next to the contract partner in the contract view.

    • enabled: Use the values true and false to define whether the external link is displayed in the contract view.

    • linkTemplate: The parameter contains the URL. You can use the contractual partner’s metadata with the placeholder ${$Item.internalFieldname}.

Sample JSON file configuration for contractual partners

{
    "creationAllowed": true,
    "contactPersonEnabled": true,
    "multiplePartnersAllowed": true,
    "contactPersonManagementType": "lookup",
    "contactPersonManagementAllowed": true,
    "searchInDescriptionField": true,
    "numberOfContractualPartnerProposal": 20
    "externalLink": {
        "enabled": true,
        "linkTemplate": "https://integrator.d-velop365.com/navigate?target=contractPartner&PartnerId=${Item.ecsCPId}"
    }
}