Open Documentation Menu

Managing and configuring document templates

In the Document templates area, you can define whether new documents can be added to contracts from templates.

The following template modules are supported:

  • spcopy 

  • dox42 

  • docgen (default)

Managing spcopy document templates

You can use document templates from a SharePoint library

Creating templates in the SharePoint library - This is how it works 

  1. Navigate to the Microsoft SharePoint website of your d.velop contracts for Microsoft 365 instance.

  2. Open the ecsContractDocumentTemplates document library under Site contents.

  3. Upload a document or create a new document. Please note the following information:

    • Uploading a document: Edit the document’s metadata and ensure that the ecsContractDocumentTemplateContentType content type is selected.

    • Creating a new document: Select the ecsContractDocumentTemplateContentType content type.

  4. Optional: In the document template metadata, define for which contract types the template will be available. If the list of contract types is empty, the document template is enabled for all contract types.

  5. Clear the cache on the start page of the d.velop contracts for Microsoft 365 administration interface. Your changes will then be applied in the contract management interface.

Configure the created templates to make the templates available in d.velop contracts for Microsoft 365. You can carry out the configuration on the configuration interface and create extended configurations in the JSON file

Configuring in the configuration interface - This is how it works 

  1. Enable the document templates with Enable document templates.

  2. Under Template module, select spcopy.

  3. Click Save.

Extended configuration in the JSON file - This is how it works 

  1. Enter the value true for the active parameter to make the document templates available.

  2. Enter the value spcopy for the engine parameter.

Managing dox42 document templates

You can generate document templates with dox42. For setup and configuration of your dox42 server, contact your dox42 partner.

Configure the created templates to make the templates available in d.velop contracts for Microsoft 365. You can carry out the configuration on the configuration interface and create extended configurations in the JSON file

Configuring in the configuration interface - This is how it works 

  1. Enable the document templates with Enable document templates.

  2. Under Template module, select dox42.

  3. Under Server URL, enter the URL to your dox42 installation.

  4. Click Save. The dox42 templates are then displayed in a table.

  5. Alternatively, click Create or select an existing template and click Edit.

  6. Use the Title text field to define the title displayed in the application interface.

  7. Use the URL text field to define the URL to the document in the Microsoft SharePoint library.

  8. Use the File extension text field to define the file extension of the file to be generated. The extension must be supported by dox42.

  9. Click Save.

Extended configuration in the JSON file - This is how it works 

  1. Enter the value true for the active parameter to make the document templates available.

  2. Enter the value dox42 for the engine parameter. 

  3. Navigate to config > dox42 to enter the configurations for the template module.

  4. Under serverURL, enter the URL to your dox42 installation.

  5. Under templates, enter the following information for each template:

    • title: Title in the application interface

    • url: URL to the document in the Microsoft SharePoint library

    • targetExtension: File extension of the file to be generated. The extension must be supported by dox42.

dox42 example configuration 

{
    "active": true,
    "engine": "dox42",
    "config": {
        "dox42": {
            "serverUrl": "https://demo.dox42.online",
            "templates": [
                 {
                    "title": "NDA",
                    "url": "https://demo.sharepoint.com/sites/dvelopcontracts365/dox42Templates/NDA-Template.docx",
                    "targetExtension": "pdf"
                },
                {
                    "title": "Customer Agreement",
                    "url": "https://demo.sharepoint.com/sites/dvelopcontracts365/dox42Templates/Customer-Agreement.docx",
                    "targetExtension": "docx"
                }
            ]
        }
    }
}
Managing docgen document templates

With docgen, you can have documents generated based on an individual Microsoft Word template. You can use document templates from a Microsoft SharePoint library.

Information on creating templates 

  • Create a file in DOCX format. 

  • Write exchangeable information in curly brackets, e.g. subject of the contract or address of the contractual partner. Enter the internal name of the corresponding site column, e.g. {ecsSubjectOfContract} between the curly brackets.

  • Site columns of the type lookup and managed metadata: For example, in the site column Contractual partner (ecsContractState), enter {#ecsContractState} as the start of the loop and {/ecsContractState} as the end of the loop. In this way, the properties of the contractual partner can be entered, e.g. {name}. Examples:

{#ecsContractState} {name} {/ecsContractState}
{#ecsContractType} {name} {/ecsContractType}
{#ecsCPLookup} {title} {additionalFields.ecsCPAddress} {additionalFields.ecsCPCity} {additionalFields.ecsCPZipCode} {additionalFields.ecsCPCountry.name} {#contactPersons} {eMail} {salutation} {firstName} {title} {phone} {/contactPersons} {/ecsCPLookup}
{#ecsResponsible} {text} {/ecsResponsible}

  • Site columns of the type date and time: In addition to the column name, enter the filter | date, e.g. {ecsContractStart | date}.

  • Site columns of the type number: In addition to the column name, enter the filter | number , e.g. {ecsRentableArea | number}.

  • Site columns of the type currency: In addition to the column name, enter the filter | currency , e.g. {ecsTotalSum | currency}.

  • For the site columns listed above, you can also enter language codes, e.g. {ecsContractStart | date:"de-DE"} or {ecsTotalSum | currency:"de-DE":"EUR"}.

Uploading templates in the Microsoft SharePoint library - This is how it works 

  1. Open the ecsContractDocumentTemplates document library under Site contents.

  2. Upload a template document in DOCX format.

Configure the created templates to make the templates available in d.velop contracts for Microsoft 365. You can carry out the configuration on the configuration interface and create extended configurations in the JSON file

Configuring in the configuration interface - This is how it works 

  1. Enable the document templates with Enable document templates.

  2. Under Template module, select Default.

  3. Click Save.

Extended configuration in the JSON file - This is how it works

  1. Enter the value true for the active parameter to make the document templates available.

  2. Enter the value standard for the engine parameter.