OpenDocument Spreadsheet - Insert cell(s)
Declaration
<AMODS ACTIVITY="insert_cell" 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" CELLREF="text" INSERTTYPE="text (options)" CELLROW="text" CELLCOLUMNS="text" WORKSHEET="text" />
Description
Inserts an individual cell, a row of cells or a column of cells in a worksheet. This activity can be executed individually or with a group of other OpenDocument Spreadsheet activities linked to an established session.
Practical usage
Used to insert new rows and/or columns into a worksheet. You can insert a cell above or to the left of the active cell on a worksheet and specify whether to shift other cells in the same column down or cells in the same row to the right to accommodate the new cells.
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 |
---|---|---|---|---|---|
Set cell by |
--- | --- | --- | --- | Determines
how the cell in which to insert should be identified. This is
a visual parameter only used during design-time, therefore, contains
no properties or markups. The available options are:
|
Cell reference | Text | Yes, if Set cell by is set to Reference | A1 | CELLREF="B3" | The reference of the cell in which to insert (for example, A1 or B4). This parameter is active only if the Set cell by parameter is set to Reference. |
Insert type | Text (options) | Yes | Shift cells right |
|
Dictates
how the workbook should react as a result of the inserted cell.
The available options
are:
|
Row | Number | Yes, if Set cell by is set to Position | 1 | CELLROW="10" | The row position of the cell in which to insert. This value along with the Column position value specified below will determine the exact location of the cell (for example, 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 is set to Position | 1 | CELLCOLUMN="11" | The column position of the cell in which to insert. This value along with the Row position value specified above will determine the exact location of the cell (for example, Row 12, Column 2). This parameter is active only if the Set cell by parameter is set to Position. |
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 file name of an existing worksheet in which this activity will be performed. If this parameter is enabled, the Use active worksheet parameter is ignored. |
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 inserts a cell and shifts cells down in a worksheet.
<AMODS ACTIVITY="insert_cell" WORKBOOK="C:\temp\Employees.xls" OPENPASSWORD="AM4MiC+/q78kvkj1tBCMUj17vHtl3ScyfLoaME" SAVETYPE="save_as" DESTINATION="C:\temp3\newFile.xls" OVERWRITEDESTINATION="YES" CELLREF="A1" WORKSHEET="mySheet" />