Home Search

DriveWorks Pro 22
Export All Control Names To Named Sheet In Excel

Send Feedback

Version: 22-SP0-25 and onwards

Please note this version now supports the following control types:

Earlier versions of the Specification PowerPack did not export the above control types.

If any of the above controls are in use and this version (or newer) of the PowerPack is installed the exported file will include this information.

Export All Control Names To Named Sheet in Excel

This Specification Flow Task recurses all the Forms in a Project and all of the Controls within each form.

The following information is exported:

  • Form Name

    The name of the form the control exists on.

  • Control Name

    The name of the control.

  • Control Type

    The type of the control (for example CheckBox, TextBox, etc.).

    Each control type is prefixed with DriveWorks.Forms.

  • Control Value

    The value at the time of export for each control that supports value export, see below.

    Controls that do not support value export will have all other information exported.

  • Left

    The value of the left position on the form.

  • Top

    The value of the top position on the form.

  • Height

    The height value of the control.

  • Width

    The width value of the control.

Microsoft Office

  • Ensure Microsoft Office is installed on all DriveWorks machines that will process this Task.

Microsoft Office and DriveWorks Live running as a service through IIS

Services (IIS) do not have access to many applications, especially COM programs such as Microsoft Word and Excel.

When using DriveWorks Live and IIS please read the following articles for information on where to place this Task.

Supported Controls

This task will export the current value of the following control types:

All other control types will be exported without the Control Value field being populated.

Multi-line Controls

Control values that span multiple lines will place the value in a single cell in the exported file.

This applies to the following control types:

  • Text Box that has its Multiline property set to True
  • TinyMCE Control

Properties

Property NameDescription
Source File NameFile Name of the source (template) spreadsheet.
Target File NameFile Name of the target (new) spreadsheet.
Target Sheet NameThe Sheet name in the spreadsheet that will have the data exported to.
ShowExcelWorkbook will be visible if set to TRUE.
Extension for Saving FilePipe-bar (|) delimited list of extensions to save the file as (e.g. .pdf, .xps, .txt).

The following extensions are supported for saving the file:

.pdf, .xps, .txt, .xml, .htm, .html, .csv, .dif, .slk, .ods, .xlsm, .xlsb, .xls, .xltx, .xltm, .xlt, .xla and .xlam

Example

When this Task is added the properties are static. To be able to build rules on a static property see How To: Change A Static Property To A Dynamic Property.

Property NameExample RuleExample ResultMeaning
Source File Name"C:\MyDocuments\Templates\Template.xlsx"C:\MyDocuments\Templates\Template.xlsxThis is the location where the source (your template) spreadsheet is stored.
Target File Name"C:\MyDocuments\Exports\SpecInfo.xlsx"C:\MyDocuments\Exports\SpecInfo.xlsxThis is the location where the file will be created.
Target Sheet Name"Sheet1"Sheet1This is the name of the sheet on your exported spreadsheet that the data will be written to.
ShowExcelTRUETRUETRUE will show the Excel workbook opening when you run the Task.
Extension For Saving File".CSV".CSVThis will produce a CSV file of the exported data that has been exported to Excel.

Example Data

TypeNameValue
Text Box ControlTextBox1ABC
Macro ButtonMacroButton1
Slider ControlSlider143
Text Box ControlTextBox2XYZ

Example Export File

Form NameControl NameControl TypeControl ValueLeftTopHeightWidth
DetailsTextBox1DriveWorks.Forms.TextBoxABC255020200
DetailsNumericTextBox1DriveWorks.Forms.MacroButton2510020200
DetailsSlider1DriveWorks.Forms.Slider432515020200
DetailsTextBox2DriveWorks.Forms.TextBoxXYZ2520020200

Status Outputs

This task supports Status Outputs. These can be used to perform different actions depending on what the status outcome of the task is. For more information see Status Outputs in the Task Node Outputs section of Specification Macros Task Node.

The status output navigation is as follows:

Success

  • Control names were successfully written to Excel

Success with Warnings

  • N/A - Should never be fulfilled.

Failed (one of the following occurred).

  • Target sheet name is empty
  • Target file name is empty
  • Couldn't find transition or status name
  • Source file name is empty
  • Source file not found or could not be accessed
  • Source file extension is invalid
  • Unable to copy source file
  • Could not find target sheet name
  • Unknown error occurred