OpenDocument Spreadsheet - Insert Rows/Columns

Declaration

<AMODS ACTIVITY="insert_row_column" SESSION="text" 
ROWCOLUMNTYPE="text (options)" INDEX="number" 
TOTALCOUNT="number" WORKSHEET="text" />

Description: Inserts an individual cell, a cell row or cell column in a worksheet. This activity can be executed individually or with a group of other OpenDocument Spreadsheet activities linked to an established session.  

IMPORTANT: 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 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 insert new rows and columns into a worksheet.

Resource Parameters

Property

Type

Required

Default

Markup

Description

Resource

---

---

---

---

Indicates where the source 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

  1. CONNECTBY="open_workbook"

  2. 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

  1. SAVETYPE="save"

  2. SAVETYPE="save_as"

  3. 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 to navigate to the desired file or simply enter the path and filename in the provided text box.

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 newly created 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 Get document by parameter is set to Create.

Row Column Parameters

Property

Type

Required

Default

Markup

Description

Insert

---

---

---

---

If enabled, specifies that one or more rows/columns will be cleared of its contents. If this parameter is enabled, the Delete parameter is ignored. This is a design-time parameter, therefore, contains no markups.

Delete

Text

Yes

(Empty)

CONTENTTYPE="Delete"

If enabled, specifies that one or more cell rows/columns will be deleted. If this parameter is enabled, the Clear content(s) parameter is ignored.

Delete

Text (options)

No

Row

ROWCOLUMNTYPE="Column"

Specifies how the group of cells or cell contents to delete are ordered. The available options are:

  • Row - The group of cells are ordered by row which run from the left to right of a page.

  • Column - The group of cells are ordered by column which run from the top to the bottom of a page.

Start index or column

Number

Yes

(Empty)

INDEX="A1"

If deleting rows, specifies the index of the row from where the rows will be deleted (e.g., 1= the first row from the top, 2 = the second row from the top, etc.). If deleting columns, specifies the index of the column from where the columns will be deleted  (e.g., 1= the first column from the left, 2 = the second column from the left, etc.). This parameter works in tandem with the Total count parameter. For example, if you want to delete the first 10 rows of the spreadsheet, set this parameter to 1 and the Total count parameter to 10.

Total count

Number

Yes

(Empty)

TOTALCOUNT="10"

If deleting rows, specifies the total number of rows that need to be deleted. If deleting columns, specifies the total number of columns that need to be deleted. For example if you want to delete the first 10 columns of the spreadsheet, set the Start index or column parameter to 1 and set this parameter to 10.

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.

Example

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

Description: Insert "10" column(s) at index "10". Use worksheet "mySheet". Excel file "C:\temp\Employees.xls".

<AMODS ACTIVITY="insert_row_column" WORKBOOK="C:\temp\Employees.xls" 
OPENPASSWORD="AM41LqdfXIjPCId7fpke4vUNrQPAgd/3/ZfaME" 
SAVETYPE="save_as" DESTINATION="C:\temp3\newFile.xls" 
OVERWRITEDESTINATION="YES" ROWCOLUMNTYPE="Column" INDEX="10" 
TOTALCOUNT="10" WORKSHEET="mySheet"  />