OpenDocument Spreadsheet - Get Active Worksheet
Declaration
<AMODS ACTIVITY="get_worksheet" WORKBOOK="text" OPENPASSWORD="text (encrypted)" SAVETYPE="text (options)" DESTINATION="text" OVERWRITEDESTINATION="YES/NO" WORKSHEETINDEXVARIABLE="text" WORKSHEETNAMEVARIABLE="text" />
Description: Retrieves the name or index of the currently active worksheet and populates either or both of two variables, one for the worksheet name and the other for the index. This activity can be executed individually or with a group of other OpenDocument Spreadsheet activities linked to an established session.
Practical Usage
Used to find the currently active worksheet in a workbook that was opened or created in a previous step by the Open/Create workbook activity.
Resource Parameters
Property |
Type |
Required |
Default |
Markup |
Description |
---|---|---|---|---|---|
Resource |
--- |
--- |
--- |
--- |
Indicates where the source workbook document should originate from. This is a design mode parameter used only during task construction and configuration, thus, comprises no markup. The available options are:
|
Session |
Text |
Yes if Resource is set to Session |
OPENDOCSession1 |
SESSION="mySession" |
The name of an existing session to associate this activity with. The default session name is OPENDOCSession1. This parameter is active only if the Resource parameter is set to Session. |
Get document by |
Text (options) |
Yes if Resource is set to File |
Open |
|
Specifies whether this activity will be performed on an existing document or on a new one. This parameter is active only if the Resource parameter is set to File. The available options are:
|
File name |
Text |
Yes |
(Empty) |
WORKBOOK="C:\Temp\fileName.xls" |
If the Get document by parameter is set to Open, specifies the path and filename of the document in which to open. If the Get document by parameter is set to Create, specifies the path and filename in which to save the newly created document. |
Password to open (optional) |
Text |
Yes if Get document by parameter is set to Open |
(Empty) |
OPENPASSWORD="encrypted" |
The password required to open the document if it is password protected. This parameter is active only if the Get document by parameter is set to Open. |
Create from template |
Text |
Yes if Get document by parameter is set to Create |
No |
WORKBOOKTEMPLATE=
|
If enabled, specifies the path and filename of a template file that already has preferred formatting in which to base the new workbook on. A template can include formatting, styles, standardized text such as page headers and row and column labels. This parameter is active only if the Get document by parameter is set to Create. It is disabled by default. |
On completion |
Text (options) |
No |
Save |
|
Specifies what to do with the document upon completion of this activity. The available options are:
|
File |
Text |
Yes if On completion parameter is set to Save as |
(Empty) |
DESTINATION="c:\temp\dest.xls" |
The path and filename of the file in which changes will be saved. Click the folder icon to open a standard Explorer dialog to navigate to the desired file or simply enter the path and filename in the provided text box. This parameter is active only if the On completion parameter is set to Save as. |
Overwrite if workbook already exists |
Yes/No |
Yes if On completion parameter is set to Save as |
No |
OVERWRITE="YES" |
If set to YES, the saved workbook will overwrite any workbook with the same name that exists in the destination. If set to NO (default), an existing workbook with the same name will not be overwritten, however, an error will occur during runtime as a result of matching filenames. This parameter is active only if the On completion parameter is set to Save as. |
Worksheet Parameters
Property |
Type |
Required |
Default |
Markup |
Description |
---|---|---|---|---|---|
Populate variable with worksheet name |
Text |
No |
(Empty) |
WORKSHEETNAMEVARIABLE= "theName" |
If enabled, specifies the name of an existing variable to be populated with the name of the active worksheet. If this parameter is disabled, a value is required in the Populate variable with worksheet index parameter. |
Populate variable with worksheet index |
Number |
No |
(Empty)
|
WORKSHEETINDEXVARIABLE= "theIndex" |
If enabled, specifies the name of an existing variable to be populated with the index of the active worksheet. An index is a sequential number assigned to a sheet, based on the position of its sheet tab (counting from the left) among sheets of the same type. If this parameter is disabled, a value is required in the Populate variable with worksheet name parameter. |
Description tab - A custom description can be provided on the Description tab to convey additional information or share special notes about a task step.
Error Causes tab - Specify how this step should behave upon the occurrence of an error. (Refer to Task Builder > Error Causes Tab for details.)
On Error tab - Specify what AWE should do if this step encounters an error as defined on the Error Causes tab. (Refer to Task Builder > On Error Tab for details.)
Example
The sample AML code below can be copied and pasted directly into the Steps panel of the Task Builder.
Description: Get active worksheet in workbook open in session "mySession". Populate variable "theName" with the worksheet name. Populate variable "theIndex" with the worksheet index.
<AMEXCELGETACTIVEWORKSHEET SESSION="mySession" WORKSHEETNAMEVARIABLE="theName" WORKSHEETINDEXVARIABLE="theIndex" />