Home Search

DriveWorks Pro 22
Documents - Data

Send Feedback

Documents - Data

DriveWorks has the ability to create Data Documents (no physical file is created) such as writing data to a DriveWorks table or external database.

The Documents - Data Task provides you with the ability to add Data Documents to your Project.

The Documents list can be filtered by using the filter at the top of the list.

Please see the topic How To Use Filters for more advanced filtering information.

To Add a Document

Open the project and go to Stage4: Output Rules.

  1. Select Document - Data.
  2. Click the Add button on the command bar to launch the Create Document wizard
  3. Choose the required document type from the Documents list in the Create Document wizard.
  4. Enter a name for the Document in the field below the Documents list.
  5. The next step depends on the Document type being created:
    • For some Document types this is all the information that is required, and the Finish button will be available in the wizard to complete the set up process.
    • For other Document types a next step will be required and the Next button will be available in the wizard to complete the set up process.

    Please refer to the Document Types section below for information specific to the Document being added.

Once a Document has been added the properties of the Document that can be driven will be available in the Document editor.

To Edit a Document

  1. Select the Document to be edited from the listed Documents.
  2. Click the Edit button on the command bar to open the Document Properties window.

Please refer to the Document Types section below for information specific to the Document being edited.

The name of the document is displayed at the top of the edit window.

The Notification Area also displays the name of the document, its status and how many elements the document contains.

Document Edit Notification

When performing a Task that saves the Project you are notified if an item within another Task is currently being edited.

Tasks that will cause the notification to appear include:

  • Creating a new Specification.
  • Opening, closing or creating a Project.
  • Opening, closing or creating a Group.

The message displays the name of the item under edit and the Task it can be found in.

  • Click Yes to save and close the open Document and proceed with the Specification.
  • Click No to continue with the Specification without saving and closing the open Document.
  • Click Cancel to abort the new Specification.

All items currently in edit mode will be listed.

Document Cancel

When changes made to a document are cancelled the following prompt will appear:

This gives the option to commit the changes if Cancel was mistakenly selected.

The options available on the Cancel dialog are:

  • Yes - closes the document without saving
  • No - returns to the document
  • Cancel - returns to the document
  • X - returns to the document
  • Don't Show Again - Prevents the dialog from being displayed again

    This selection is reset when DriveWorks is closed and reopened.

To Rename a Document

  1. Select the Document to be renamed from the Documents listed.
  2. Click the Rename button on the command bar to rename the Document.

Alternatively, double click the Document name to begin editing.

To Delete a Document

  1. Select the Document to be deleted from the Documents listed.
  2. Click the Delete button on the command bar to delete the Document.
Deleting a Document will remove all rules. This action can be reversed by clicking the Undo button.

Document - Data Types

The types of Document - Files that can be driven are listed in the table below:

Documents - Data

TypeDescription
Export to Calculation TableExports rows to an existing Calculation Table in the Project.
Export To Group TableExports data to a Group Table.
Export To Simple TableExports data to a Simple Table that will be available for the existing Specification only.
ODBC Data Export

DriveWorks has the ability to export data to an external database (using a Microsoft Windows ODBC connection) as part of running a DriveWorks Project.

SQL Server Data Export

DriveWorks has the ability to export data directly to a SQL Server database as part of running a DriveWorks Project.

Triggered ActionA Triggered Action allows a Specification to Transition to a State once a specified file has been created.

Document Creation Order

The order Documents are created for a new Specification can be controlled by modifying the Default Specification Flow, see example of this here How To: Change Document Generation Order.

The generation of Documents in the Specification Flow is triggered by the Release Documents Task.

See How To: Modify Specification Flow for information on adding a Task sequence to a State.

Multiple Documents are added to the Task sequence by using a pipebar delimited list (DocName1|DocName2|etc..).

The order the Documents appear in the string is the order they will be generated.

Alternatively the order each Task sequence appears in the list of Task sequences for a given State is the order that Task will be performed.

ODBC Data Export Document

DriveWorks treats any ODBC Data Export as a Document, but the timing of this taking place is set independently of the Document generation timing. The Time to Export setting applied in the ODBC Data Export wizard is the time the export is done.

Take care the Time to Export setting for the data export does not conflict with any settings applied to a customized Specification Flow.