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 of the different versions of iMacros can be found here
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 | |
DISPLAY | |
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 | |
!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 | |
!X_PERM_NEW_WINDOW_BEHAVIOR |
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 works with the iMacros Browser, Internet Explorer, Firefox and Chrome (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())
- iimGetStopwatch (Old: iimGetLastPerformance)
- iimGetPerformance
- iimPlay and iimPlayCode()
- iimSet
- iimSetWindowTitle()
- iimTakeBrowserScreenshot
- iimClose (old: iimExit)
- Error handling: Scripting Interface Return Codes
Refer to the iMacros Editions Comparison Table to see which editions support the scripting interface (API)
Command Line Interface Overview
- -delay
- -help
- -kioskmode
- -logfile
- -loop
- -macro
- -noexit
- -profiler
- -silent
- -title
- -tray
- -variables (deprecated: -var_varname)
In addition to the switches above, the following switches can be used with the iMacros Sidebar for IE:
Refer to the iMacros Editions Comparison Table to see which iMacros editions support the command-line interface (CLI)
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.