OpenDocument Spreadsheet - List worksheet(s)

OpenDocument Spreadsheet - List Worksheet(s)

Declaration

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.

NOTE: Unlike 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 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. This is a design mode parameter used only during task construction and configuration, thus, comprises no markup. The available options are: File (default) - The source document derives from a file located on the system. This option is normally selected if only a single activity is required to complete the operation. Session - The source document is obtained from a pre-configured session created in an earlier step with the use of the Open/Create workbook activity. This option is normally selected if a combination of related activities are required to complete an operation. Consolidating several activities to a single session can eliminate redundancy. Moreover, a single task supports multi-session executions which can improve efficiency and speed up production.
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	CONNECTBY="open_workbook" CONNECTBY="create_workbook"	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: Open (default) - This activity will be performed on an existing document that will be opened during runtime. Create - This activity will be performed on a new document to be created during runtime.
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= "C:\Temp\file.xls"	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	SAVETYPE="save" SAVETYPE="save_as" SAVETYPE="do_not_save"	Specifies what to do with the document upon completion of this activity. The available options are: Save - Save changes to the default location. If this activity is performed on an existing document, changes will be saved to its current location. If performed on a new document, changes will be saved to the location specified under the File name parameter. Save as - Save changes to the specified path and filename. Do not save changes - Changes will not be saved.
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 in order 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

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 Additional Notes below.

Description

Error Causes

On Error

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

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

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.

<AMSHOWDIALOG WINDOWTITLE="Worksheet Information">Worksheet Name: %theSheets.WorksheetName%

Worksheet Index: %theSheets.WorksheetIndex%

Is worksheet visible?: %theSheets.IsVisible%

Is worksheet active?: %theSheets.IsActive%</AMSHOWDIALOG>

</AMLOOP>

This help file is for the Advanced Workflow Engine v10. For other versions, please refer to http://help.globalscape.com/help/index.html

(If the Index and Contents are hidden, click the icon in the top left corner.)

If this help topic did not help you, try searching the Knowledgebase.
For the most up-to-date information, to view version history, updates, and activation instructions, visit the Support Center at http://www.globalscape.com/support-home.
For information about Globalscape, visit www.globalscape.com.

Last modified: 28-Jun-19 at 14:01:27