This page describes the setup and every dialog of the add-in. If you would rather have an answer sooner, write to us – we usually reply within 24 hours on business days.

1. Overview

The vTiger Word Add-In connects Microsoft Word directly to your vTiger CRM. It reads data through vTiger’s official REST API and uses it to fill the merge fields in your Word templates. Nothing is installed or changed on the vTiger server.

After installation the add-in appears as its own ribbon tab in Word. While no connection is established, the buttons for record selection stay disabled.

2. Installation and activation

1. Download the installer from the Downloads area and run it. Close Word while it installs.
2. Start Word. The add-in’s ribbon appears as a new tab.
3. Purchased full version only: enter your access code. You receive it with the order confirmation. The trial runs without a code – after installing you can go straight to step 3.

The full version’s licence key is bound to hardware characteristics. If you change machines permanently, write to helpdesk@etis-gmbh.de and we will release the key for the new hardware.

3. Setting up the CRM connection

You only need to set the connection up once. Open the settings from the ribbon and enter three values:

After saving, the add-in verifies the connection. On success the ribbon shows the connected state and the record selection buttons become active.

This requires API access to be enabled in your vTiger. If the connection fails, check the URL and token first, then whether a proxy or firewall is blocking access.

4. Field selection: which columns you see

Field selection determines which fields of a vTiger module appear as columns in the selection dialogs. Choose the fields that let you recognise the right record – for organizations typically name, city and customer number.

The setting applies per module and affects only the display, not the data written into the document.

5. Merge fields in the Word template

The add-in works with Microsoft Word’s merge fields. You create them in Word, not in the add-in. Microsoft provides instructions in its help centre.

Naming recommendations

• Use descriptive names that match the target field – for exampleCompany, Salutation, Street.
• Do not use the same name twice within one template, otherwise the mapping is ambiguous.
• Avoid accented characters and spaces in field names – it saves trouble when moving templates between machines.
• Keep the naming scheme consistent across all templates. A single preset then covers every document type.

6. Field mapping and presets

In the Merge Field Presets dialog you connect each merge field in your template to a field of a vTiger module. On the left is the field from the template; on the right you pick the module and field from the CRM.

The mapping is stored centrally and applies to every template that uses the same field names. When a field is added in vTiger or a field name changes, you adjust the mapping in one place.

Rules

• Each merge field is mapped to exactly one CRM field.
• Unmapped fields stay empty in the generated document – that is not an error but deliberately allows optional entries.
• Mapping happens per module. One document may contain fields from several modules (see section 7).

7. Assign Data: one document, several modules

The Assign Data dialog fills the currently open document with the values of a specific record. It is the right route for individual letters, quotes and contracts.

1. Open the template in Word.
2. Choose Assign Data in the ribbon.
3. Select the module and find the record. Filtering, sorting and search help even with large data volumes.
4. If needed, pick another module and assign a record there too – for example organization, then contact, then opportunity.
5. Confirm the assignment. The document is filled.

This is exactly what the feature is built for: a quote typically needs fields from several modules at once.

8. Mail merge: one template, many records

The mail merge dialog produces personalised documents for multiple records from one template in a single pass.

1. Open the template in Word.
2. Choose Mail Merge in the ribbon.
3. Select the module.
4. Select the records – filtered and sorted. There is no fixed limit on the number.
5. Choose the output mode and start.

Output modes

• Print directly: all documents go to the default printer as one print job.
• Generate separate documents: one file per record – useful if you want to send the documents by email or archive them.

For larger batches, run a test with two or three records before starting the full pass.

9. Interface language

The interface is available in German, English and French. On start-up the add-in follows your system settings; you can change it at any time in the general settings.

10. When something does not work

If you get stuck, write to helpdesk@etis-gmbh.de and state your vTiger version, your Word version and – if available – the relevant log files.

11. Requirements

Back to the home page