Home Search

DriveWorks Pro 21
Documents - Files

Send Feedback

Documents - Files

DriveWorks has the ability to create Documents such as Microsoft Word, Microsoft Excel, or HTML Documents.

The Documents - Files Task provides you with the ability to add 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 - Files.
  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.

To Preview a Document

  1. Select the Document to be previewed from the Documents list.
  2. Click the Preview button on the command bar to delete the Document.

The following Document types cannot be previewed from the Documents stage:

  • Copied File
  • Referenced File
  • Email

Document - Files Types

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

TypeDescription
Copied FileA Copied File is used to copy an existing file as-is into the same folder as the Specification. This Document type has no rules.
DriveWorks 3D FileA DriveWorks 3D File (*.drive3d) can be driven as a Document.
Email

DriveWorks Autopilot has the ability to send Emails, and optionally include attachments. Rules for the Email parameters (To, Cc, Bcc, Subject, Body, Attachments) are applied in DriveWorks Administrator.

Excel Workbook

This Document type is used to export data directly in to a Sheet in a Microsoft Excel Workbook from the DriveWorks project.

Export FormA snapshot image of a single user Form, along with the data entered onto it can be taken (*.png format) by using the Export Form Document.
JSON DocumentCreates a new JSON document which allows you to construct a generated JSON object, with rule driven properties, from a reference schema.
Referenced FileA Referenced File is used to reference any file where you know the location and the name of that file.
Text DocumentThis Document type creates a text file.
Word Document

This Document type is used to export data directly in to a Microsoft Word Document from the DriveWorks project.

XML Document (Advanced)

This Document type is used to export data directly in to all nodes of a XML Document from the DriveWorks project.

XML Document (Simple)

This Document type is used to export data directly in to a XML Document from the DriveWorks project.

TemplateDescription
BOM Document

DriveWorks contains a BOM (Bill Of Materials) Document template in XML format. This enables the user to quickly set up a customizable BOM.

Covering Letter

DriveWorks contains a Cover Letter Document template in XML format. This enables the user to quickly set up a customizable covering letter.

HTML Email DocumentCreates an Email Document from a template.
HTML Quotation LetterCreates a customizable letter and quote.
Proposal DocumentCreates a proposal Document from a template.
Quote DocumentDriveWorks contains a Quote Document template in XML format. This enables the user to quickly set up a customizable quote.
Quote Document (Français)Creates a customizable quote Document in French.

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.

The sending of Emails is triggered by the Release Emails 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.

Email Document

Emails are sent by Autopilot as soon as all information is available for the Email to be sent.

For example when an email has attachments, that are generated by DriveWorks, it will be sent as soon as all files are available.

© DriveWorks Ltd 2024 - All rights reserved.
Privacy Policy | Terms & Conditions