The renewal maintenance has officially ended for Progress iMacros effective November 30, 2023.
This Wiki site will also no longer be moderated from the Progress side.
Thank you again for your business and support.
Sincerely, The Progress Team
Command Reference
A high-level overview on the different versions of iMacros can be found here
Note: With iMacros Version 8 we adapted our iMacros Edition names and license structure to better suit the needs of our growing numbers of enterprise customers.
Old: iMacros Scripting Edition => New: iMacros Enterprise Edition
Old: iMacros PRO Edition => New: iMacros Standard Edition
We will update the naming in the wiki over time. With regards to Scripting API features, the new Enterprise Edition has all the features of the previous Scripting Edition and is 100% compatible to all existing iMacros 7 scripts.
The browser icons listed below and on each command detail page denote browser compatibility. Commands that are supported in all browsers work exactly the same in each browser, so macros created in the iMacros Browser (or Internet Explorer) can be replayed in iMacros for Firefox and vice versa. Browser specific differences are automatically handled by iMacros.
iMacros Commands Reference
' (Comment) | |
ADD | |
BACK | |
CLEAR | |
CLICK | |
DS | |
EVAL | |
EVENT | |
EXTRACT (Part of the TAG command) | |
FILEDELETE | |
FILTER | |
FRAME | |
IMAGECLICK | |
IMAGESEARCH | |
ONCERTIFICATEDIALOG | |
ONDIALOG | |
ONDOWNLOAD | |
ONERRORDIALOG | |
ONINSECURECONNECTION Version 10.3 and above | |
ONLOGIN | |
ONPRINT | |
ONSECURITYDIALOG | |
ONWEBPAGEDIALOG | |
PAUSE | |
PROMPT | |
PROXY | |
REFRESH | |
SAVEAS | |
SAVEITEM | |
SCREENSHOT | |
SEARCH | |
SET | |
SIZE | |
STOPWATCH | |
TAB | |
TAG | |
TRAY | |
URL | |
VERSION | |
WAIT | |
Error Codes | |
Tip: How to make if/then decisions with iMacros. |
Built-In Variables
Built-in variable names always start with an exclamation mark ("!"). See also this iMacros variable types overview.
!CLIPBOARD | |
!COLn | |
!DATASOURCE | |
!DATASOURCE_COLUMNS | |
!DATASOURCE_DELIMITER | |
!DATASOURCE_LINE | |
!DOWNLOADED_FILE_NAME Version 10.3 and above | |
!DOWNLOADED_SIZE Version 10.3 and above | |
!ENCRYPTION | |
!ENDOFPAGE | |
!ERRORIGNORE | |
!EXTRACT | |
!EXTRACT_TEST_POPUP | |
!EXTRACTDIALOG | |
!FAIL_ON_ALL_NAVIGATEERRORS | |
!FILELOG | |
!FILESTOPWATCH | |
!FILE_PROFILER | |
!FOLDER_DATASOURCE | |
!FOLDER_DOWNLOAD | |
!FOLDER_LOG | |
!FOLDER_MACROS | |
!FOLDER_STOPWATCH | |
!HTTP_ERRORCODE Version 11.5 and above | |
!IMAGEX | |
!IMAGEY | |
!LOOP | |
!MARKOBJECT | |
!NOW | |
!PLAYBACKDELAY | |
!POPUP_ALLOWED | |
!REPLAYSPEED | |
!REGION_BOTTOM | |
!REGION_LEFT | |
!REGION_RIGHT | |
!REGION_TOP | |
!SINGLESTEP | |
!STOPWATCHTIME | |
!STOPWATCH_HEADER | |
!TAGSOURCEINDEX | |
!TAGX | |
!TAGY | |
!TIMEOUT | |
!TIMEOUT_DOWNLOAD Version 10.3 and above | |
!TIMEOUT_MACRO | |
!TIMEOUT_PAGE | |
!TIMEOUT_STEP | |
!URLCURRENT | |
!USE_DOWNLOADMANAGER Version 10.3 and above | |
!USERAGENT | |
!VAR0...!VAR9 | |
!WAITPAGECOMPLETE | |
!WINDOW_TITLE Version 11.5 and above | |
!X_PERFLOG_NOTARGETPATH Version 10.3 and above |
User-defined Variables
User-defined variables are created with the SET and iimSet commands. Use iimSet to pass variables from script code to a macro. See also this iMacros variable types overview.
Scripting Interface Command Overview
The Scripting Interface is part of the iMacros EnterpriseEditon and works with the iMacros Browser, Internet Explorer and Firefox (see iimOpen for details on how to switch between the browsers).
- iimOpen (old: iimInit())
- iimGetBrowserPid (iMacros 10.4)
- iimDisplay
- iimGetInterfaceVersion()
- iimGetErrorText (old: iimGetLastError())
- iimGetExtract (old: iimGetLastExtract())
- iimPlay and iimPlayCode()
- iimSet
- iimSetWindowTitle() (iMacros 11.5)
- iimTakeBrowserScreenshot
- iimGetStopwatch (Old: iimGetLastPerformance)
- iimGetPerformance (new method!)
- iimClose (old: iimExit)
- Error handling: Scripting Interface Return Codes
Note that we made some API enhancements and name changes in iMacros V7.4. All old commands are still 100% supported, there is no need to change existing scripts and programs.
Command Line Switches
The command line interface is part of the iMacros Browser (iMacros.exe) and the iMacros Sidebar for IE (iMacros.Sidebar.exe) in the Standard and Enterprise Editons.
In addition to the switches above, the following switches can be used with the iMacros Sidebar for IE:
Error Handling
iMacros includes detailed error handling.
iMacros Error Codes
Please see the list of general iMacros Error-Codes.
Scripting Interface Error Codes
Even a web browser crash or freeze does not stop the Scripting Interface. Instead, it will simply return an error code and you can start a new instance. Please see the list of Scripting Interface Return Codes.
Component for .NET
For details on the new iMacros Component for .NET, please the Component wiki page.