This document describes the use of the “File Writer” tool in Bizweaver. Information regarding the associated File Operations and File Reader tools is found in separate documents.

This document is intended for developers of Bizweaver workflows.

The following documents contain additional information that may be helpful with the development of Bizweaver workflows.

• Application Introduction
• Bizweaver – Looping Tool
• Using Variables
• Bizweaver – Webservice Tool
• File Operations Tool
• File Reader Tool

1. Each workflow step must have a unique Name.
   1. The application will assign a default name, but we recommend that you change the name to something that helps you understand the purpose of the step as it is used in other steps.
   2. The name cannot have spaces or special characters other than and underscore (_)
2. Enter an optional Description to provide any additional information that may be helpful to understanding the step.
3. Press <F4> to find and use values from previous workflow steps.

The File Writer tool is used to format data from any previous step in a Bizweaver workflow whose output can be processed to write the data in a delimited format, structured format (XML), Excel, or Base64 binary data. The resulting file can then be used as needed in subsequent workflow steps.

There are three output methods available: Datasource, Custom String, and Binary.

Note for Datasource and Binary outputs

If the same file name already exists in the target folder, it will automatically be over-written. The best way to address this situation if it might occur is to use a variable (such as a timestamp created with a VBScript step) to make the file name unique for each processing cycle.

The Datasource output option is used to write the input data set as it is received and create the file with data records only. Use the Custom String output method if header and footer sections, or custom column headings, are needed as well. No Bizweaver looping is required.

1. Enter the Filename (target folder and file name) for the output file.
   1. Press <F4> to show variables from previous steps that might be used to create the file name.
   2. The extension (e.g. csv, txt, etc.) must be included in the file name. The extension should be consistent with the File Type selected step 3 below. The extension is not automatically assigned based on the File Type selection.
2. Select the data Source from the drop-down list.
   1. Only SQL Command and File Reader workflow steps are listed.
3. Select the output File Type from the drop-down list.
   1. See step 1.2 above for additional information.
4. Enter the appropriate column separator character if the Custom Separated File Type option is selected in step 3.
5. Select the Include Column Headers checkbox if column headers should be included in the output file.
   1. The column header names are whatever is presented from the source workflow step.
   2. Column header names cannot be changed when using the Datasource output option.
   3. This option does not apply when XML output is selected.
6. XML output will create a basic XML structure based on the data presented. There is no provision to create hierarchical output, or to change the node names.
7. As of version 2.2, Excel must be installed on the Bizweaver server to write output as an Excel file.

The Custom String output option is used when it is necessary to manipulate the output file format. With the Custom String option, you can:

• Change the order of columns
• Change the column heading names
• Include header and footer records

1. Enter the Filename (target folder and file name) for the output file.
   1. Press <F4> to show variables from previous steps that can be used to create the file name.
   2. The extension (e.g. csv, txt, etc.) must be included in the file name.
   3. To create tab-delimited output, press Shift + Tab at the point where a delimiter is needed.
2. The Header section contains whatever values should be included in the first row(s) of the output file.
   1. This section is only written once when the file is created
   2. This section is optional but must be included if the output file must include column headers.
   3. The appropriate delimiter value must separate column headers.
3. The Body section contains the values for each data record coming from the input source.
   1. The appropriate delimiter value must separate columns.
   2. In most cases the values in this section will be variables from the input source step. This is shown in the example image above. Press <F4> to list available steps, then click on the step name to see & select the desired values.
4. The Footer section contains whatever values should be included as the last row(s) of the output file.
   1. This section is only written once when the file is created
   2. This section is optional.
   3. The appropriate delimiter value must separate columns, if appropriate.
   4. An example of the use of this section might be a summary record for the contents of the file.
5. The output data can be placed into one, or more, files based on the “Grouped By”, “Each Record,” and “Append” options.
   1. To create a single file, select the “Grouped By” option and leave the grouping value field blank, or use the “Append” option. See the notes below about the “Append” option.
   2. To create a unique file based on some value in the input data source, select “Grouped By.” Select a variable from the data source step and place it in the grouping value field. Press <F4> while in the field to see a list of data sources. Click on the appropriate data source to select the value.
      1. In this case, a variable from the data source must be used in the output file name to make each file unique. If this is not done, all records will be written into a single file.
   3. To create a unique file for each input record, select “Create file for each record.” A separate file will be created for each record.

The “Append” output option can be used in two ways. First, it can be used to create a single “custom” output file from the input data. Second, it can be used to write the output from multiple input steams into a single output file. When this option is used, the defined output file is not over-written as is done with the Datasource and the other two Custom options.

Care should be taken when using this option. If you do want a single output file, but you don’t want subsequent data to be written into the initial file, there are two options.

1. Add a timestamp value to the file name so that each time the workflow runs, the file name will be unique.
2. Add a “Move” File Operations step to move the file to a different location as part of the workflow process.

The Binary Output option is used to process a Base64 input string and write it out as the appropriate type of file. The primary use of this process is to convert images saved via a Versago form (uploads or signatures) and save them as a disk file of the original type.

Data files that are uploaded to Versago via a Versago Form are stored in the table “TWBS_VGO_FormAttachments,” which is found in whatever database is used to hold data captured in forms.

The image below illustrates the record structure. The column headings in yellow are used to obtain the needed data.

1. ID is the unique record ID in the table.
2. ObjectID is the ID number of the source form.
3. RecordID is the unique ID number of the record in the source table.
4. FileContent is the binary data that will be used to recreate the file.

To convert these files, we will need workflow steps to obtain the ID of each record to be converted. The SQL statement to create the list of records to feed into the loop will be:

Select ID from TWBS_VGO_FormAttachments where ObjectID = 26

This gives us a list of four records (5 – 8)

The selected records are processed through a loop to handle each one individually.

The first step within the loop is to gather the detail for each specific record. The SQL statement to do this is:

 SELECT FileName, FileContent FROM TWBS_VGO_FormAttachments WHERE [ID] =
 
WorkFlow(SQLCommand1).Get({FIELD_ID}) 

The two values are then used in the File Writer step.

• The Filename variable is used to name the file written to disk.
• The FileContent variable indicates what data is to be written out

This process occurs for each record passed into the loop. The recreated files are created in the designated folder using their original name.

In the SAP Business One environment these files can now be processed further as Attachments to an SAP Business One object such as a Business Partner, Sales Order, etc.

The Binary Output option can also be used to convert a signature captured in a Versago Form into a file on disk. The process is like the one described above but requires some additional pre-processing.

Signature data is stored in a column in the table used by the Versago Form. It is stored in a format that must be converted back to BASE64 before it can be used. This is done with a SQL Stored Procedure. The procedure does the conversion and stores the converted data in a new table. Following is a framework version of the procedure.

CREATE PROCEDURE [dbo].[SignatureImageConvert] @vgoRecNum INT AS
 
/*
12/AUG/2018 (R Unger / TWBS)
Used to convert a signature image from text to BASE64 Binary for use with Crystal Reports or to save as a disk file.
--
@vgoRecNum and vgoRecNum are the primary key of the table. Change as needed.
F2_SigCapture is the Versago table. Change name as needed.
*/
 
DECLARE @ConvString nvarchar(MAX)
--
-- Parse out image data from text string
SELECT @ConvString = SUBSTRING(Signature,23,999999)
FROM F2_SigCapture WHERE vgoRecNum = @vgoRecNum
--
/* Convert image data to BASE64 Binary and insert into holding table named SignatureCapture. Assumes a text field named “Name” is used to capture the signature name */
INSERT INTO SignatureConvert
(ObjectID, ControlID, RecordId, FileName, FileType, FileContent, CreateDateTime)
SELECT
1,'SigCapture',@vgoRecNum, isnull(Name,'None'), 'image/png',
CAST('' AS xml).value('xs:base64Binary(sql:variable("@convstring"))', 'varbinary(max)'), getdate()
FROM F2_SigCapture WHERE vgoRecNum = @vgoRecNum

The image below illustrates the record structure of the “SignatureCapture” table. The column headings in yellow are used to obtain the needed data.

The conversion to disk file is then the same as described in Uploaded Versago Data section above.