Text Document (DriveWorks Documentation)

Text Document

The Text Document will create a plain text (not formatted with font or color information) file that can be saved in the following formats:

.txt
.tab
.xml
.html
.bat
.md
A .md (Markdown) file can be used to create a PDF file using the PDF: Markdown File To PDF Task.

The Text Document is created by the Specification Flow task - Release Documents.

Ensure this task exists in your Specification Flow and the Documents property (of the task) is set to a value that will generate the Text Document.

In DriveWorks Administrator open the Project the Document is to be added to and go to Stage4: Output Rules then Documents - Files

Click the Add button on the command bar.
Choose the Text Document item from the Documents list in the Create Document wizard.
Enter a name for the Document in the field below the Document and Document Template list.
Click Finish.

When a Text Document is added the parameters that can be set will be shown in the Document Window.

By default the rule applied to this parameter is:

<DocumentName>&DWSpecification&".txt"

To change the default rule click the Build button at the end of the Document Name field.

If the Text Document creation is not required to be created for a Specification the rule must result in one of the following:

Rule	Meaning
"TextDoc " & DWSpecification & ".txt"	Will create the file TextDoc 9999.txt. 9999 is the value coming from the special variable DWSpecification.
"HTMLDoc " & DWSpecification & ".html"	Will create the file HTMLDoc 9999.html. 9999 represents the value coming from the special variable DWSpecification.
IF(CreateFileReturn=TRUE,"TextDoc " & DWSpecification & ".txt","delete")	Will create the file TextDoc 9999.txt when the value coming from the Form Control CreateFile is TRUE, otherwise the file will not be created (as determined by the result of the rule being delete). 9999 represents the value coming from the Special Variable DWSpecification.

By default there is no rule applied to this parameter. Therefore the resulting Document will be saved relative to the Specification Folder.

Please see Info: Where To Store DriveWorks Data for information on where to store the data associated to a DriveWorks implementation.

Rule	Meaning
DWSpecificationFullPath&"\Text File"	Will create the folder Text File in the Specification Folder and store the created Text Document in this location.

When this setting is enabled (by checking the box) the Document will be hidden from the Documents list in the Specification Explorer.

To add a line of text click the Add Line button from the command bar.

To remove a line of text click the Remove Line button from the command bar.

To recalculate the rules for each line click the Recalculate button from the command bar.

Lines of text can be rearranged by selecting the line to be rearranged and clicking the Move Up or Move down button from the command bar.

Once a line has been added to the Document, select the line and click the Build button from the command bar to launch the Rule Builder.

Rule	Meaning
"Order Number: " & OrderNumberReturn	Will create the text Order Number: 1234 in the text file. 1234 is the value coming from the Form Control OrderNumber.