OpenDocument Spreadsheet - Set cell(s)
Declaration
<AMODS ACTIVITY="set_cell" SESSION="text" SETTERTYPE="text (options)" DATASET="text" CELLREF="text" INCLUDECOLUMNNAMES="YES/NO" WORKSHEET="text" />
Description
Sets text onto one or more cells in a workbook.
NOTE: Unlike Automate Desktop's Excel activities,
the OpenDocument Spreadsheet activities do not require Microsoft's
Excel engine to run. Supported file types include Excel (*.xls, *.xlsx,
*.xlsb, *.xlsm ), Open document spreadsheet (*.ods) and CSV (Comma
Separated Value) files (*.csv).
Practical usage
Used to set or modify the contents of an individual cell or group of cells contained in a workbook that was previously created or opened using the OpenDocument Spreadsheet - 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. |
Cell
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
Data source | Text (options) | Yes | Single value |
|
The
data source to set. Subsequent parameters vary depending on which
option is selected. The available options are:
|
New value | Text | Yes, if Data source is set to Single value | (Empty) | NEWVALUE="text" | The value to set. This parameter can be left blank to denote a cell with no value. This parameter is active only if the Data source parameter is set to Single value. |
Dataset | Text | Yes , if Data source is set to Dataset | (Empty) | DATASET="theDataset" | The name of the dataset to set values from. This parameter is active only if the Data source parameter is set to Dataset. |
Set cell by | --- | --- | --- | --- | Dictates
how the cells to set should be identified. The available options are:
NOTE: This parameter does not contain markup and is only displayed in visual mode for task construction and configuration purposes. |
Cell reference | Text | See Description | (Empty) |
|
The location reference of the cell in which text should be set (for example, A1 or B4). This parameter is active only if the Data source parameter is set to Single cell and the Set cell by parameter is set to Reference. |
Upper left cell reference | Text | See Description | (Empty) | UPPERLEFTREF="A1" | The upper left cell reference in the range of cells to set (for example, A1 or B4). This parameter is available only if the Data source parameter is set to Dataset or List and the Set cell by parameter is set to Reference. |
Row | Number | See Description | 1 | CELLROW="3" | The location reference of the cell in which text should be set (for example, A1 or B4). This parameter is active only if the Data source parameter is set to Single cell and the Set cell by parameter is set to Position. |
Column | Number | See Description | 1 | CELLCOLUMN="2" | The location reference of the cell in which text should be set (for example, A1 or B4). This parameter is active only if the Data source parameter is set to Single cell and the Set cell by parameter is set to Position. |
Upper left cell row | Number | Yes, if selection method set to Range of cells by position | (Empty) | UPPERLEFTROW="1" | The row of the upper left cell in the range of cells to set. This parameter is available only if the Data source parameter is set to Dataset or List and the Set cell by parameter is set to Position. |
Upper left cell column | Number | Yes, if selection method set to Range of cells by position | (Empty) | UPPERLEFTCOLUMN="1" | The column of the upper left cell in the range of cells to set. This parameter is available only if the Data source parameter is set to Dataset or List and the Set cell by parameter is set to Position. |
List value | Text | Yes, if Data source set to List | (Empty) | List="text" | The list to set values from. This parameter is active only if the Data source parameter is set to List. |
Delimiter |
Text (options) |
Yes, if Data source set to List | Comma |
|
The
character to delimit each value in the list. This parameter is
active only if the Data source
parameter is set to List.
The available options are:
|
Custom delimiter text | Text | Yes, if Delimiter parameter set to Custom | (Empty) | CUSTOMDELIMITER="text" | The
character to define as a delimiter. This parameter is available
only if the Delimiter parameter
is set to Custom. NOTE: A percent
(%) sign is a special character in Automate Desktop used to indicate the
beginning and end of a variable or expression. Therefore, if you
wish to use the percent sign as a delimiter, you must escape the
character in order to invoke an alternative interpretation. To
escape the percent sign, simply duplicate the character (that is, %%). This way, Automate Desktop will view it as a literal (single) percent
sign. See Percent
signs in Automate Desktop for more details. |
Insert list | Text (options) | No | Horizontally | TRAVERSBY="vertical" | Determines
how the list should be aligned. This parameter is active
only if the Data source
parameter is set to List.
The available options are:
|
Upper left cell | Text | Yes, if Get parameter set to Range of cells by reference | (Empty) | UPPERLEFTREF="A1" | The reference of the upper left cell in the range of cells to retrieve (for example, A1 or B4). This value will be used along with the value entered in the Lower left cell parameter in order to reference a specific cell. This parameter is active only if the Get parameter is set to Cell by reference. |
Use active worksheet | --- | --- | --- | --- | If enabled, specifies that this activity will be performed on the currently active worksheet. This is a design time parameter, therefore, contains no markup or parameters. |
Use specific worksheet | Text | No | Sheet1 | WORKSHEET="Sheet3" | If enabled, indicates that this activity will be performed on a specific worksheet instead of the currently active one. Enter the name of the appropriate worksheet in the provided text box. If left blank or omitted, the currently active worksheet will take precedence. |
Include column names | Yes/No | No | No | INCLUDECOLUMNNAMES="YES" | If selected, specifies that column names will be set as well. If disabled (default), column names will not be set. This parameter is available only if the Data source parameter is set to Dataset. |
Example
NOTE:
- 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 writes text into a cell in a worksheet.
Copy
<AMODS ACTIVITY="set_cell" CONNECTBY="create_workbook" WORKBOOK="C:\temp\Employees.xls" SAVETYPE="save_as" DESTINATION="C:\temp3\newFile.xls" OVERWRITEDESTINATION="YES" NEWVALUE="theValue" CELLROW="1" CELLCOLUMN="1" WORKSHEET="Sheet1" />