Home Search

DriveWorks Pro 22
Add Excel Sheets

Send Feedback

Add Excel Sheets

This Specification Flow Task adds sheets to a Microsoft Excel workbook from a given table of sheet names.

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.

Properties

Property NameDescription
TitleChanges the title (not the name) of the task.
Path to WorkbookThe path to the workbook (including the workbook file).
Sheet NamesA single columned table of sheet names that will be inserted into the workbook, header is not included. (Maximum character length of each sheet name is 31).
Insert at StartTrue to insert the specified sheets before the pre-existing sheets, false to insert after.

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
Path to Workbook"D:\Book1.xlsx"D:\Book1.xlsxThis will modify the workbook located at D:\Book1.xlsx.
Sheet Names{"";"sheet1";"sheet2";"sheet3"}{"";"sheet1";"sheet2";"sheet3"}This will insert the three sheets specified, header is not included.
Insert at StartFalseFALSEWill insert the sheets after any pre-existing sheets.

Sheet Names Property

An easy method of creating a single column array is to use the TableFromList function.

This function allows a blank header to be returned as the result.

Result

The worksheets tab at the bottom of the Microsoft Excel workbook looks like the image below before the Task is run.

The worksheets tab at the bottom of the Microsoft Excel workbook will look like the image below after the Task is run.

Using the Task in a Specification Macro

This task has different types of Outputs. For more information about Outputs see Specification Macros Task Node.

Outputs are only available within Specification Macros. Currently Outputs are not available for Specification Flow.

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

  • Successfully added <number of sheets> sheet(s) to the Workbook <specified workbook>.

Success with Warnings

  • N/A - Should never be fulfilled.

Failed (one of the following occurred).

  • The property 'Path to Workbook' cannot be left empty.
  • The property 'Sheet Names' contains too few rows.
  • The property 'Sheet Names' contains too many columns. Only single column arrays are accepted.
  • The property 'Sheet Names' contains too few columns. Only single column arrays are accepted.
  • One or more sheets provided is empty: <sheets specified>.
  • Failed to insert sheet(s) <specified sheets> at path <specified path>.
© DriveWorks Ltd 2024 - All rights reserved.
Privacy Policy | Terms & Conditions