Create Workbook Action

Declaration

<AMEXCELCREATEWORKBOOK WORKBOOK="text" SESSIONNAME="text" VISIBLE="yes/no" OVERWRITE="yes/no" TEMPLATENAME="text">

See Also

 Open Workbook, Close Workbook, Add Worksheet, Activate Worksheet, Get Cell, Set Cell, Cells to Dataset, Dataset to Cells

Description

Creates a Microsoft Excel workbook and attaches a session name for use in other Excel actions. The file is not saved to the hard disk until the Close Workbook action is used.

Practical Usage

To create a new Microsoft Excel document and associated session. This action is only useful in conjunction with the other Excel actions found in AutoMate.

IMPORTANT: The Excel actions in AutoMate use the Microsoft Excel automation engine to perform their work. Because of this, Microsoft Excel must be licensed and installed on the system to use the Excel actions.

Parameters

General Tab

Workbook

Text, Required
MARKUP: WORKBOOK="c:\file.xls"

Specifies the name of the Excel file that should be created. The file will not be actually created on the hard disk until the file is saved either manually or using the Close Workbook action.

Session Name

Text, Optional - Default "Default"
MARKUP: SESSION="YES"

Specifies the session name to identify this document in subsequent Excel steps. This allows several Excel files to be open simultaneously. If only working with one document at a time, this value should not be changed from it's default.

Template Name

Text, Optional Default= ""
MARKUP: TEMPLATE="c:\mytemplate.xlt"

Specifies the file name of a template that should be used when creating the file. Excel Templates have the file extension .xlt.

Workbook is invisible

Yes/No, Optional - Default NO
MARKUP:
a) VISIBLE="no"

When enabled, specifies that when working with the workbook the Microsoft Excel Window will not be displayed (processing will occur in the background). Usually this option should be left unchecked when building/debugging, but enabled for production.

Overwrite if workbook already exists

Yes/No, Optional - Default NO
MARKUP:
a) OVERWRITE="yes"

When enabled, specifies that if the file specified in the Workbook parameter already exists, it will be overwritten.

Notes

Custom Description

This action includes the Description tab for entering a custom step description.

More on setting custom step description

Standard Error Handling Options

This action also includes the standard Error Causes and On Error failure handling options/tabs.

More on Error Handling Options

Variables and Expressions

All text fields allow the use of expressions, which can be entered by surrounding the expression in percentage signs (example: %MYVARIABLE%, %Left('Text',2)%). To help construct these expressions, you can open Expression Builder from these fields by pressing F2.

More on variables
More on expressions

More on the expression builder

Example

NOTE: The code below can be copied and pasted directly into the Steps pane of the Task Builder.

<AMEXCELCREATEWORKBOOK WORKBOOK="c:\myexceldocument.xls">

     <AMEXCELSETCELL NEWVALUE="Set this data here" CELLROW="1" CELLCOLUMN="1">

     <AMEXCELSETCELL NEWVALUE="and this here" CELLROW="2" CELLCOLUMN="1">

<AMEXCELCLOSEWORKBOOK>