Mail Merge
Description
Mail merge plugin step creates multiple documents in bulk at once based on a template as a reference. These documents have identical layout, formatting, text, and graphics. The template has fieldnames (tags) which are replaced in each document. Hence, the documents vary for personalization. You may import variable / personalized data from external sources such as database, excel or CSV file and other sources in Process Studio that can be passed as fields to this step to replace placeholders in the template file.
Note: This step should be preceded with a row generating step (e.g. Generate rows etc.)
Configurations
| No. | Field Name | Description |
|---|---|---|
| 1 | Step Name | Name of the step. This name has to be unique in a single workflow. |
| Input Fields | ||
| 1 | Word File (.docx) | Specify the full path of a Template word document containing data in the form of Field Names as placeholders (${fieldname}). Alternatively choose a field in the input stream or a variable containing the file path. Following is a sample word file template. Test --> ${Test} ${PageNo} This is regarding your confirmation of ${Designation} position in vyom labs on ${Date}Your DOJ is ${DOJ} and Employee Id : ${Employee ID} You will receive promotion letter by post at your address as follows, ${Address} ¬ Regards, HR Communication. Note: sometimes the format of placeholder is not applied to the replaced text. |
| 2 | Button: Browse… | Browse the Template word document containing Field Name placeholders. |
| Tabular Fields | ||
| 1 | Button: Get Fields | Click on Get Fields button to populate ‘Field Name’ column with the placeholders from the template word document. |
| 2 | Field Name | Displays name of placeholders in the template word file populated using the Get Fields button. This is a read only column. The data type is String. This field is mandatory. |
| 3 | Field Value | Provide Valid values for the field associated with the field name. Alternately, choose a field name in the input stream from the drop down list or specify a variable containing a value for the Field Name. The input stream is usually populated from data sources such as database, excel or CSV, which will usually be the start step of a workflow containing Mail Merge step. Following is a sample Microsoft Excel Input step data.  The data type is String. This field is mandatory. |
| 4 | Destination Directory | Specify a directory to store the generated output files. The data type is String. This field is mandatory. |
| 5 | Destination Directory | Specify a directory to store the generated output files. The data type is String. This field is mandatory. |
| 6 | Button: Browse | Click button to browse a destination directory to store the generated files. |
| 7 | Destination File Name | Specify the base name of the output files to be generated. The destination files base name can also be based on field name in the input stream or a variable. - If there are more than one files generated they are appended with _1, _2 and so on incrementally. - If the destination folder already contains one or more files with the same base name all the new files are appended incrementally. Generated files will always have the extension .docx, even if the file name is provided without any extension or with an extension other than .docx. The data type is String. This field is mandatory. Note: If user specifies filename as Sample, then the actual file generated could be Sample.docx. (In case file already exists, then it will append _1 (1, 2, 3... are incremental numbers) to the file name i.e. Sample_1.docx.) |