OpenDocument Spreadsheet - Activate worksheet |
Declaration
<AMODS ACTIVITY="activate_worksheet" CONNECTBY="text (optoins)" WORKBOOK="text" SAVETYPE="text (options)" DESTINATION="text" OVERWRITEDESTINATION="YES/NO" WORKSHEET="text" /> |
Description
Activates a specific worksheet from a workbook. The worksheet to activate can be specified by its name or current index. Performing this activity is equivalent to manually clicking the sheet's tab.
NOTE: Unlike Automate's Excel activities, the OpenDocument Spreadsheet activities do not rely on Microsoft's Excel engine to perform their work, therefore, Microsoft Excel does not need to be installed on the system in order to use these activities. Supported file types include Excel (*.xls, *.xlsx, *.xlsb, *.xlsm ), Open document spreadsheet (*.ods) and CSV (Comma Separated Value) files (*.csv). |
Practical Usage
Used to activate an existing worksheet inside a workbook. For example, your workbook may contain 5 worksheets and you need actions to be performed on Sheet3. You must first activate Sheet3 in order to enable other ODS related activities to be performed on that sheet during subsequent steps.
Parameters
Resource
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 file name of the document in which to open. If the Get document by parameter is set to Create, specifies the path and file name 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="C:\Temp\file.xls" |
If enabled, specifies the path and file name 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 file name of the file in which changes will be saved. Click the folder icon to open a standard Explorer dialog in order to navigate to the desired file or simply enter the path and file name 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 selected, the saved workbook will overwrite any workbook with the same name that exists in the destination. If disabled (default), an existing workbook with the same name will not be overwritten, however, an error will occur during runtime as a result of matching file names. This parameter is active only if the On completion parameter is set to Save as. |
Worksheet
Property |
Type |
Required |
Default |
Markup |
Description |
Activate worksheet by name |
--- |
--- |
--- |
--- |
If enabled, specifies that the worksheet to activate will be based on its name (i.e. sheet1. sheet2, etc.). If this parameter is enabled, the Activate worksheet by index parameter is ignored. This is a design time parameter, therefore, contains no markups. |
Activate worksheet by index |
Number |
Yes |
No |
BYINDEX="YES" |
If enabled, denotes that the worksheet to activate will be based on its current index. If this parameter is enabled, the Activate worksheet by name parameter is ignored. |
Name/Index | Text/Number |
Yes |
(Empty) |
|
Specifies the name of the worksheet or current index of the worksheet in which to activate. If specifying an index, the left-most worksheet would be index 1 and the worksheet to its right would be index 2, etc. |
Example
- The sample AML code below can be copied and pasted directly into the Steps Panel of the Task Builder.
- Parameters containing user credentials, files, file paths, and/or other information specific to the task must be customized before the sample code can run successfully.
Description
Activate Excel worksheet "Sheet2". Excel file "C:\temp\Employees.xls".
<AMODS ACTIVITY="activate_worksheet" WORKBOOK="C:\temp\Employees.xls" OPENPASSWORD="AM4qtc/jTVVL5x0GuYG8glS4XW69yJT2FQXaME" WORKSHEET="Sheet2" /> |