OpenDocument Spreadsheet - List worksheet(s)
Declaration
<AMODS ACTIVITY="list_worksheet" SESSION="text" CONNECTBY="create_workbook" WORKBOOK="text" WORKBOOKTEMPLATE="text" TEMPLATEPASSWORD="text (encrypted)" OVERWRITE="YES/NO" OPENPASSWORD="text (encrypted)" SAVETYPE="text (options)" DESTINATION="text" OVERWRITEDESTINATION="YES/NO" RESULTDATASET="text" />
Description
Retrieves information about the worksheets contained in a workbook and populates a dataset with results. 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.
Parameters
Resource
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
Resource | --- | --- | --- | --- | Indicates where the source
workbook document should originate from. The available options are:
NOTE: This parameter does not contain markup and is only displayed in visual mode for task construction and configuration purposes. |
Resource - File
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
Get document by | Text (options) | Yes, if Resource is set to File | Open |
|
Specifies
whether to perform this activity on an existing document
or a new one. This parameter is only active if the Resource parameter is set to File. The available options
are:
|
File name | Text | Yes | (Empty) | WORKBOOK="C:\Temp\fileName.xls" | If Get document by is set to Open, specifies the path and file name of the document to open. If Get document by is set to Create, specifies the path and file name in which to save the newly created document. |
Password to open (optional) | Text | No | (Empty) | OPENPASSWORD="encrypted" | The password required to open the document if it is password protected. This parameter is only active if Get document by is set to Open, or if Get document by is set to Create and Create from template is selected. |
On completion | Text (options) | No | Save |
|
Specifies
what to do with the document upon completion of this activity.
The available options are:
|
File | Text | No | (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 only active if On completion is set to Save as. |
Overwrite if workbook already exists | Yes/No | No | 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 only active if On completion is set to Save as, and/or if Get document by is set to Create. |
Create from template | Text | No | 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 Get document by parameter is set to Create. This parameter is disabled by default. |
Overwrite if workbook already exists | Yes/No | No | No | OVERWRITEDESTINATION="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 only active if Get document by is set to Create. |
Resource - Session
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
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 Resource is set to Session. |
Worksheet
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
Create and populate dataset | Text | Yes | (Empty) | WORKSHEETNAMEVARIABLE="theName" | Specifies the name of a dataset to create and populate with information regarding the list of worksheets. For more details, see Datasets. |
Additional notes
Datasets
A dataset is a multiple column, multiple row container object. This activity creates and populates a dataset with the following fields (rows).
Name | Type | Return Value |
---|---|---|
theDataset.isVisible | True/False | Returns TRUE if the worksheet is visible. Returns FALSE if the worksheet is hidden. |
theDataset.isActive | True/False | Returns TRUE if the worksheet is the active worksheet. Returns FALSE if it is not. |
theDataset.WorksheetIndex | Number | Returns the index number of the worksheet. This is determined by the worksheet's tab position (the left-most tab being index 1). |
theDataset.WorksheetName | Text | Returns the name of the worksheet. |
Example
- Copy and paste the sample AML code below directly into the Task Builder Steps Panel.
- To successfully run the sample code, update parameters containing user credentials, files, file paths, or other information specific to the task to match your environment.
Description
This sample task opens a workbook, populates a dataset with data regarding the spreadsheets that it contains. The dataset is then looped. During each iteration, information about the current spreadsheet is displayed in a message dialog. The last step closes the workbook, ths ending the session.
<AMODS SESSION="OPENDOCSession1" WORKBOOK="C:\temp\Employees.xls" />
<AMODS ACTIVITY="list_worksheet" SESSION="OPENDOCSession1" RESULTDATASET="theSheets" />
<AMLOOP ACTIVITY="dataset" DATASET="theSheets" />
<AMSHOWDIALOG WINDOWTITLE="Worksheet Information">Worksheet Name: %theSheets.WorksheetName%Worksheet Index: %theSheets.WorksheetIndex%Is worksheet visible?: %theSheets.IsVisible%Is worksheet active?: %theSheets.IsActive%</AMSHOWDIALOG>
<AMLOOP ACTIVITY="end" />
<AMODS ACTIVITY="close_workbook" SESSION="OPENDOCSession1" />