Excel - Set cell(s)

Declaration

<AMEXCEL ACTIVITY="set_cell" SESSION="text" SETTERTYPE="text (options)" DATASET="text" CELLREF="text" WORKSHEET="text" />

Description

Sets the text of one or more cells in an established Excel session.

IMPORTANT: Excel activities rely on Microsoft's Excel engine to perform their work,therefore, MS Excel must be licensed and installed on the system in order for these activities to function properly.

Practical Usage

Used to set or modify the contents of a new or existing Microsoft Excel worksheet.

Parameters

Resource

Property

Type

Required

Default

Markup

Description

Resource

---

---

---

---

Indicates where the source Excel 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 derives from an Excel file located on the system. This option is normally selected if only a single activity is required to complete the operation.

  • Session - The source Excel document is obtained from a pre-configured session created in an earlier step with the use of the Excel - 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

Excelsession1

SESSION="mySession"

The name of an existing session to associate this activity with. 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 Excel 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 Excel document in which to open. If the Get document by parameter is set to Create, specifies the path and filename of the Excel document in which to create.

Application is invisible

Yes/No

No

No

VISIBLE="NO"

If set to YES, specifies that the Excel window will not be displayed and all processing will occur in the background. This option should be set to NO during task construction and debugging but can be set to YES for production. The workbook is visible by default.

Password to open (optional)

Text

No

(Empty)

OPENPASSWORD="encrypted"

The password required to open the Excel document if it is password protected. This parameter is active only if the Get document by parameter is set to Open.

Password to modify (optional)

Text

No

(Empty)

MODIFYPASSWORD="encrypted"

The password required to modify the Excel 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

No

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, formulas, macros and custom toolbars. 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.

  • Save as - Save 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. 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

Data source

Text (options)

Yes

Single value

  1. SETTERTYPE="single_value"

  2. SETTERTYPE="dataset"

  3. SETTERTYPE="list"

The data source to set. Subsequent parameters vary depending on which option is selected. The available options are:

  • Single value (default) - A single value will be set.

  • Dataset - The data to set derives from a dataset.

  • List - The data to set derives from a list.

New value

Text

Yes if data source is from Single value

(Empty)

NEWVALUE="text"

The value to set. This parameter is active only if the Data source parameter is set to Single value.

Dataset

Text

Yes if data source is from 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.

List value

Text

Yes if data source is from 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 is from List

Comma

  1. DELIMITER="comma"

  2. DELIMITER="new_line"

  3. DELIMITER="semi_colon"

  4. DELIMITER="space"

  5. DELIMITER="tab"

  6. DELIMITER="custom"

The character to delimit each value in the list. This parameter is active only if the Data source parameter is set to List.

Get

Text (options)

Yes

Cell by reference

  1. ACTION="rangeByReference"

  2. ACTION="cellByPosition"

  3. ACTION="rangeByReference"

  4. ACTION="rangeByPosition"

Specifies the method in which to retrieve the cell(s). The available options are:

  • Cell by reference (default) - Gets a single cell specified by its cell reference, such as A1 or B3.

  • Cell by position - Gets a single cell specified by its row and column position, such as Row 2, Column F.

  • Range of cells by reference - Gets a range of cells specified by the cell reference for the upper left and lower right cells in the range, such as Upper left cell = A1, Lower right cell = C3.

  • Range of cells by position - Gets a range of cells specified by the row and column positions of the upper left and lower right cells in the range (e.g., Upper left cell row = 1, Upper left cell column = 1, Lower right cell row = 14, Lower right cell column = 3).

Cell reference

Text

Yes if get method set to Cell by Reference

(Empty)

CELLREF="B3"

The reference of the cell to retrieve (e.g., A1 or B4). This parameter is active only if the Get parameter is set to Cell by reference.

Row

Number

Yes if get method set to Cell by position

1

CELLROW="3"

The row number of the cell to retrieve. This value will be used along with the value entered in the Column parameter to reference a specific cell. This parameter is active only if the Get parameter is set to Cell by position.

Column

Number

Yes if selection method set to Cell by position

1

CELLCOLUMN="2"

The column number of the cell to retrieve. This value will be used along with the value entered in the Row parameter to reference a specific cell. This parameter is active only if the Get parameter is set to Cell by position.

Upper left cell

Text

Yes if selection method set to Range of cells by reference

(Empty)

UPPERLEFTREF="A1"

The reference of the upper left cell in the range of cells to retrieve (e.g., A1 or B4). This value will be used along with the value entered in the Lower left cell parameter to reference a specific cell. This parameter is active only if the Select parameter is set to Cell by reference.

Populate variable with result

Text

Yes

(Empty)

RESULTVARIABLE="text"

The name of an existing variable in which to populate with the contents of the individual cell. This parameter is active only if the Get parameter is set to Cell by reference or Cell by position.

Lower right cell

Text

Yes if selection method set to Range of cells by reference

(Empty)

LOWERRIGHTREF="C5"

Specifies the reference of the lower right cell in the range of cells to retrieve (e.g., A1 or B4). This parameter is active only if the Get parameter is set to Cell by reference or Cell by position.

Upper left cell row

Number

Yes if selection method set to Range of cells by position

(Empty)

UPPERLEFTROW="1"

Specifies the row of the upper left cell in the range of cells to retrieve. This parameter is active only if the Select parameter is set to Range of cells by position.

Upper left cell column

Number

Yes if selection method set to Range of cells by position

(Empty)

UPPERLEFTCOLUMN="1"

Specifies the column of the upper left cell in the range of cells to retrieve. This parameter is active only if the Select parameter is set to Range of cells by position.

Lower right cell row

Number

Yes if selection method set to Range of cells by position

(Empty)

LOWERRIGHTROW="14"

The row of the lower right cell in the range of cells to retrieve. This parameter is active only if the Select parameter is set to Range of cells by position.

Lower right cell column

Number

Yes if selection method set to Range of cells by position

(Empty)

LOWERRIGHTCOLUMN="3"

The column of the lower right cell in the range of cells to retrieve. This parameter is active only if the Select parameter is set to Range of cells by position.

Create and populate dataset

Text

Yes

(Empty)

RESULTDATASET="text"

The name of the dataset in which to populate with the contents of the range of cells. This parameter is active only if the Get parameter is set to Cell by reference or Cell by position or Cells by position.

Auto detect

Yes/No

No

No

AUTODETECT="YES"

If set to YES, the end cell references is automatically detected by determining which bottom right most cell is populated with data (if Get parameter is set to Range of cells by reference) or by determining which end row/end column is populated with data (if Get parameter is set to Range of cells by position). Set to NO by default. This parameter is active only if the Get parameter is set to Cell by reference or Cell by position or Cells by position.

Use active worksheet

---

---

---

---

If enabled, specifies that this action 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 the data will be retrieved from a specific worksheet instead of the currently active worksheet. Enter the name of the appropriate worksheet in the provided text box. If left blank or omitted, the current active worksheet will be used.

Use formatted value

Yes/No

No

No

FORMATTEDVALUE="YES"

If set to YES, formatted values will be retrieved, such as when formulas are used to calculate a specific value. If set to NO, the value will be retrieved as literal text.

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.

This sample task demonstrates the use of various Excel actions. Below describes each step of the task, including the action used and details about that action.

  1. Create Workbook Action - Create new Excel workbook "C:\Temp\sampledoc.xls".  Overwrite file if it already exists.  

  2. Add Worksheet Action - Add new Excel worksheet "My New Sheet" to workbook open in session "ExcelSess1".  New worksheet will be the last one of the workbook.  

  3. Activate Worksheet Action - Activate Excel worksheet "My New Sheet" in workbook open in session "ExcelSess1".  

  4. Set Cell Action - Write text "Set this data here" in Excel cell located at row:1 and column:1.  

  5. Pause Action - Pause task for 3 seconds.  

  6. Set Cell Action - Write text "and this here" in Excel cell located at row:2 and column:1.  

  7. Pause Action - Pause task for 3 seconds.  

  8. Close Workbook Action - Close Excel workbook.  Do not save workbook before closing.  

<AMEXCELCREATEWORKBOOK WORKBOOK="c:\sampledoc.xls" OVERWRITE="YES" />

<AMEXCELADDWORKSHEET WORKSHEETNAME="My New Sheet" LASTWORKSHEET="YES" />

<AMEXCELACTIVATEWORKSHEET WORKSHEET="My New Sheet" />

<AMEXCELSETCELL NEWVALUE="Set this data here" CELLROW="1" CELLCOLUMN="1" />

<AMPAUSE ACTION="waitfor" SCALAR="3" />

<AMEXCELSETCELL NEWVALUE="and this here" CELLROW="2" CELLCOLUMN="1" />

<AMPAUSE ACTION="waitfor" SCALAR="3" />

<AMEXCELCLOSEWORKBOOK SAVE="NO" />