Description:

This step replaces the Word document with variables & globals.

Usage:

Example:

Let’s build and execute the “wordDocReplacerDef” example.          

• Create a new definition called “wordDocReplacerDef.”
• Select the definition and click the “design” button
• Drag an “updateVariablesWithSQL, wordDocReplacer” steps to the canvas
• Connect the Start with other steps as above
• Define a few variables/globals to store the SQL result and output document file path

• Click the "updateVariablesWithSQL" step to configure its "Required" properties. Provide a name to the step. Select the Connection String from the drop-down list. Provide the SQL Select statement. Click the button to assign the SQL column values to the process variables/globals. Click the Save button.  

• Click the button to assign the SQL column values to the process variables/globals.  A popup window is displayed for configuration. Click on the Add Row button to insert a blank row. As shown below, provide the SQL column names and map them to the process variables/globals. Click the Save button. 

• Open Microsoft Word and prepare a docx template file, as shown below. The template file includes the process variables/globals, which are replaced with actual values when the document is created during the process instance. Provide a name and save the template docx file in your local folder.  

• Click the "wordDocReplacer" step to configure its "Required" properties. Give the step a name. Click the file icon and upload the DOCX report template file. Provide the variable/global to store the output file path. 

• Click the "wordDocReplacer" step to configure its "Optional" properties. Provide a name for the output docx file. Click the Save button. 

• The “Logging” setting configuration is necessary for documentation and also measures the workflow progress and the percent complete. This is achieved by configuring the step state and percent fields individually, as shown in the images below. Configure the “Logging” using the following properties.

• Save the process definition, create a new instance, and execute. The process instance is completed without any human intervention. 

• Render the process instance. Click on the “wordDocReplacer” process step to view the properties.

•  The step should generate a DOCX file using the variables/global values provided during the run time. The output variable holds the file name path, as shown below. 

• Use the AppURI to the output file path and download the DOC file. The word document is replaced with the variable values during the process instance. 

Definition Sample:

You may download the ZIP file and extract the sample definition(s) from the link here. Then, you can later import it (drag-drop) to your FlowWright Process Definition (XML file) or Form Definition (HTML file) page.

NOTE: Please verify and complete the process steps for any missing configurations, such as file path references and database connections after import. Then, save the definition to confirm the changes.

Click here to download the sample file.