OpenDocument Spreadsheet

OpenDocument Spreadsheet - Add hyperlink

Declaration

Description:

Adds a hyperlink to a cell in a worksheet. 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 doesn't need to be installed on the system in order to use these activities.

Practical Usage

Adds hyperlinks to cells in a spreadsheet. A hyperlink is a word or phrase that you can click on to jump to a new document, usually the address of a specific website or URL.

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.

Cell

Property	Type	Required	Default	Markup	Description
Set cell by	---	---	---	---	Determines how the cell in which to add a hyperlink should be identified. This is a visual parameter only used during design-time, therefore, contains no properties or markups. The available options are: Reference (default) - The cell will be identified by its reference (e.g.,A1, B3). Position - The cell will be identified by its row/column position (e.g., Row 2, Column 4).
Cell reference	Text	Yes if Set cell by parameter set to Reference	A1	CELLREF="B3"	The reference of the cell in which to add a hyperlink (e.g.,A1 or B4). This parameter is active only if the Set cell by parameter is set to Reference.
Row	Number	Yes if Set cell by parameter set to Position	1	CELLROW="10"	The row position of the cell in which to add a hyperlink. This value along with the Column position value specified below will determine the exact location of the cell (e.g.,Row 10, Column 12). This parameter is active only if the Set cell by parameter is set to Position.
Column	Number	Yes if Set cell by parameter set to Position	1	CELLCOLUMN="11"	The column position of the cell in which to add a hyperlink. This value along with the Row position value specified above will determine the exact location of the cell (e.g.,Row 12, Column 2). This parameter is active only if the Set cell by parameter is set to Position.
URL	Text	Yes	(Empty)	URL="www.helpsystems.com"	The URL to link to when clicking the hyperlink (e.g.,www.helpsystems.com).
Text to display	Text	Yes	(Empty)	EXTDISPLAY="text"	The text to represent the hyperlink. This can be the URL itself or any text that represents the URL.
Tooltips to display	Text	No	(Empty)	TEXTTOOLTIPDISPLAY="text"	The text message that appears when the cursor is positioned directly over the hyperlink.
Use active worksheet	---	---	---	---	If enabled, specifies that this activity will be performed on the currently active worksheet. If this parameter is enabled, the Use specific worksheet parameter is ignored. This is a design-time parameter, therefore, contains no markups.
Use specific worksheet	Text	No	Save	WORKSHEET="Sheet1"	If enabled, specifies the path and filename of an existing worksheet in which this activity will be performed. If this parameter is enabled, the Use active worksheet parameter is ignored.

Description

Error Causes

On Error

Example

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

Description: Add URL "http://example_employee_list.com" as hyperlink. Use worksheet "Sheet2". Excel file "C:\temp\Employees.xls".

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:10