All Available Actions List

The left pane in Task Builder contains all available actions categorized into folders. Each action has its own purpose and set of properties. Following is an alphabetical list of all available actions with links to the topics describing them.

Action

Description

AD Object to Dataset

Creates a dataset that contains all the properties of the specified Active Directory object (i.e. user, group, computer, etc.). Each property of the object becomes a column of the dataset, with the first row containing the property value.

AS2

 

Activate Cell

Activates a cell or range of cells within the currently active worksheet in an established Excel session.

Activate Worksheet

Activates a worksheet in a workbook from an established Excel session.

Add Worksheet

Activates a worksheet in a workbook from an established Excel session.

Append to Environment Variable

Appends text to a system or user-level environment variable. Optionally, this action can populate a variable with the resulting value.

Authenticate

Stops task execution at a specific line until the user authenticates himself/herself in the specified manner.

BASIC Script

Runs an embedded or external BASIC script or creates a user defined function which may be called in subsequent expressions or BASIC scripts. BASIC scripting can be used for advanced flow, COM objects, API calls and the creation of custom dialog boxes.

Backup AutoMate

Saves a backup copy of managed tasks, triggers, and system data onto an AutoMate archive (.AMA) file. This file may later be used to restore lost data in case an accidental deletion, file corruption or catastrophic system event occurs.

Block Input

Blocks user input from the keyboard and mouse. Also used to unblock input that was previously blocked.

Break

Breaks out of a Loop or If statement.

CD Player

Controls the CD drive on the computer. This is only used for audio CD's. To specify multiple tracks when using the "Play Tracks" option, separate the tracks with a dash (i.e. 2-5 will play tracks 2 through 5)  or a comma (i.e. 1,5 will play tracks 1 and 5).

Calculate File Checksum

Generates a hash (checksum) value for a file and places it into the specified AutoMate variable. While CRC is the default algorithm, this action also supports MD5 and several SHA variants (in order from quickest but least efficient to slowest but most efficient).

Call Function

Calls a function defined in the task. If the function returns a value or variable, you can specify the name of the variable in which to place the function results.

Case

Executes the steps following this step if the Case matches the expression result of an enclosing Select step.

Cells to Dataset

Populates a dataset with a selected range of cells in an established Excel session.

Change Folder

Changes the current folder for the running task. Useful in eliminating the need to specify folder locations in subsequent file related steps.

Change Printer

Changes the default printer. Be aware that some applications check for the default printer on start up, so simply using this action may not change the default printer for applications that are already running. In this case you may need to restart the application.

Check

Checks a check-box or radio control on a window. To select an object from an existing window, either use the Browse... button or drag the AutoMate hand icon to the desired object on the screen.

Choice

Displays an auto-generated multiple choice dialog box based the options you specify. Choice is useful when a multiple-choice selection is needed or the user must make a decision that will affect which subsequent actions should be executed by the task. The value associated with the item that the user selects is placed into a variable where it can be evaluated and acted on.

Clear (Clipboard)

Clears the clipboard of its contents.

Click Mouse

Clicks the mouse according to the parameters you specify.

Close SQL Connection

Closes a previously established connection created by an Open SQL Connection step and ends the session.

Close Window

Closes an open window. If the window specified is the main window of an application, that application will be closed. Window title, class, handle and associated objects may be used to specify the window.

Close Workbook 

Closes a Microsoft Excel workbook previously created or opened in an established Excel session. If modifications have been made, the document will be saved when closed.

Common Dialogs

Displays a standard Windows 'Open', 'Save As', or 'Browse for Folder' dialogs. The file or folder selected is stored in a variable for use in subsequent steps. Execution is paused while the user makes a selection.

Compress Files

Compresses one or more files into the file specified. To specify more than one file to compress use wildcards (i.e. * or ?). To specify multiple files or wildcard masks, separate them with the "|" symbol. Example: c:\*.txt|*.bak

Concatenate Files

Concatenates the contents of two or more files and outputs the result to a single destination file. If the destination file does not exist, it will be created. You can specify more than one file name with the use of wildcard characters (i.e. * or ?). To specify multiple files or wildcard masks, separate them with a pipe symbol (i.e. c:\*.txt|c:\*.bak). If entering a list of file names, the files will be concatenated in the order they are entered.

Connect Terminal

 

Connect to Network

 

Control Terminal

 

Convert Case

 

Copy (Clipboard)

 

Copy File

 

Create AD Group

 

Create AD Object

 

Create AD User

 

Create Array

 

Create Folder

 

Create Key Container

 

Create Object

 

Create Variable

 

Create Workbook

 

Create XML Node

 

Cut (To Clipboard)

 

DDE

 

Dataset to Cells

 

Dataset to XML

 

Decompress Files

 

Decrement Variable

 

Decrypt

 

Define Type

 

Delete AD Object

 

Delete File

 

Delete Key Container

 

Delete XML Node or Attribute

 

Disconnect Terminal

 

Display

 

EC2

 

Edit XML Node

 

Else

 

Empty Recycle Bin

 

Enable/Disable Task

 

Encrypt

 

End Case

 

End If

 

End Loop

 

End Process

 

End Select

 

End XML Session

 

Environment Variables

 

Evaluate XPath Expression

 

Exchange

 

Execute DLL Function

 

Execute Web Service

 

Extract XML Fragment

 

FTP

 

Find Text

 

Focus Window

 

Format Date Time

 

Generate Key File

 

Generate Password

 

Get AD Group Members

 

Get AD Object Path

 

Get AD Object Property

 

Get Active Cell

 

Get Active Worksheet

 

Get Cell

 

Get Clipboard

 

Get E-Mail

 

Get File(s) Information

 

Get Process Information

 

Get Selected List Item

 

Get Selected Tree Item

 

Get Sub text

 

Get Terminal Text

 

Get Text

 

Get Volume Information

 

Goto

 

Guest OS Operations

 

HTTP

 

Hide Window

 

Hold Down Key

 

If

 

If AD Object Exists

 

If Compare Files

 

If File Exists

 

If Folder Exists

 

If Last Step

 

If Pixel Exists

 

If Process Running

 

If Text Contains

 

If Window Exists

 

Increment Variable

 

Information Dialogs

 

Input Box

 

Insert Text

 

Join File

 

Label

 

List AD Object Paths

 

Lock Workstation

 

Log Event

 

Log Off

 

Loop

 

Loop Array

 

Loop Dataset

 

Loop Expression

 

Loop File Contents

 

Loop Files

 

Loop List

 

Loop List Control

 

Loop Processes

 

Loop Tree Control

 

Loop Windows

 

MSMQ

 

Map Drive

 

Maximize Window

 

Merge XML Files

 

Minimize Window

 

Modify AD Group

 

Modify AD User

 

Move AD Object

 

Move File

 

Move Mouse

 

Move Mouse to Object

 

Move Window

 

Open SQL Connection

 

Open Workbook

 

Output XML

 

Pad Text

 

Paste

 

Pause Task

 

Ping Machine

 

Play Audio

 

Press

 

Print

 

RDS

 

ReDim Array

 

Read Timer

 

Read XML Node

 

Read from File

 

Registry

 

Release Key

 

Remove Folder

 

Rename AD Object

 

Rename File

 

Rename Folder

 

Replace Text

 

Resize Window

 

Restart

 

Restore Window

 

Return

 

Run

 

S3

 

SNMP Get

 

SNMP Get Bulk

 

SNMP Get Next

 

SNMP Send Trap

 

SNMP Set

 

SNMP Walk

 

SQL Query

 

SQS

 

Select

 

Select Item

 

Select List Item

 

Select Tree Item

 

Send E-mail

 

Send IM

 

Send Keystrokes

 

Send Terminal Text

 

Set AD Object Property

 

Set Attributes

 

Set Cell

 

Set Clipboard

 

Set Date and Time

 

Set Environment Variable

 

Set Text

 

Set Variable

 

Shut Down (Computer)

 

Shut Down AutoMate

 

Sign

 

Sign XML Document

 

Speak

 

Split File

 

Start Task

 

Start Timer

 

Start XML Session

 

Stop Task

 

Stop Timer

 

Stored Procedure

 

Suspend/Hibernate

 

Synchronize Folders

 

Touch File

 

Transform XML

 

Trigger Task

 

Trim Text

 

Twitter

 

Unhide Window

 

VM Operations

 

Validate XML File

 

Verify

 

Verify XML Document

 

Volume

 

Wait Terminal

 

Wait for File

 

Wait for Pixel

 

Wait for Pointer

 

Wait for Process

 

Wait for Window

 

Web Browser

 

Write to File

 

Write to Log

Logs the specified data to the AutoMate Event Log. Also supports categorization of log entries, including User Message, Verbose information, Warning and Error. Logs will appear in the AutoMate Event Log as

XML Node to Dataset

 

XML Node to Dataset

 

See Also

About Actions

Finding Actions