Home Search

DriveWorks Pro 22
Delete Excel Sheets

Send Feedback

Delete Excel Sheets

This specification task deletes a specified list of Excel Worksheets from a provided Microsoft Excel Workbook.

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 array of sheet names to delete.

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"}{"";"sheet1";"sheet2"}This will delete the sheets specified, header is not included.

Sheet Names Property

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

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 deleted <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 Workbook at path <Path to Workbook> does not exist or cannot be accessed.
  • The Workbook path contains an unsupported file extension <file extension>. The supported file extensions are: .xls, .xlsx, .xlsm, .xlsb.
  • The property 'Sheet Names' contains an invalid amount of columns. Only single column arrays are accepted.
  • The property 'Sheet Names' contains too few rows.
  • One or more of sheet names provided is empty: <Sheet Names>.
  • The sheet names provided contains duplicates: <Sheet Names>.
  • One or more of the sheet names provided do not exist within the Workbook.
    • Provided sheet names: <Sheet Names>
    • Provided Excel sheet names: <Excel Sheet Names>
  • Failed to delete sheet(s) <Sheet Names> at path <Path to Workbook>.