Command Reference

From iMacros
Revision as of 04:23, 27 November 2017 by Kg (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

A high-level overview on the different versions of iMacros can be found here


The browser icons iMacros Browser IE Plug-in Firefox Chrome 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

iMacros Browser IE Plug-in Firefox Chrome ' (Comment)
iMacros Browser IE Plug-in Firefox Chrome ADD
iMacros Browser IE Plug-in Firefox Chrome BACK
iMacros Browser IE Plug-in Firefox Chrome CLEAR
Firefox CLICK
iMacros Browser IE Plug-in DISPLAY
iMacros Browser IE Plug-in DS
iMacros Browser IE Plug-in Firefox Chrome EVAL
iMacros Browser IE Plug-in Firefox Chrome EVENT
EXTRACT (Part of the TAG command)
iMacros Browser IE Plug-in Firefox FILEDELETE
iMacros Browser Firefox FILTER
iMacros Browser IE Plug-in Firefox Chrome FRAME
iMacros Browser IE Plug-in IMAGECLICK
iMacros Browser IE Plug-in Firefox Chrome IMAGESEARCH
iMacros Browser IE Plug-in ONCERTIFICATEDIALOG
iMacros Browser IE Plug-in Firefox ONDIALOG
iMacros Browser IE Plug-in Firefox Chrome ONDOWNLOAD
iMacros Browser IE Plug-in Firefox Chrome ONERRORDIALOG
iMacros Browser ONINSECURECONNECTION Version 10.3 and above
iMacros Browser IE Plug-in Firefox Chrome ONLOGIN
iMacros Browser IE Plug-in ONPRINT
iMacros Browser IE Plug-in ONSECURITYDIALOG
iMacros Browser IE Plug-in ONWEBPAGEDIALOG
iMacros Browser IE Plug-in Firefox Chrome PAUSE
iMacros Browser IE Plug-in PRINT
iMacros Browser IE Plug-in Firefox Chrome PROMPT
iMacros Browser IE Plug-in Firefox Chrome PROXY
iMacros Browser IE Plug-in Firefox Chrome REFRESH
iMacros Browser IE Plug-in Firefox Chrome SAVEAS
iMacros Browser IE Plug-in Firefox Chrome SAVEITEM
iMacros Browser IE Plug-in Firefox Chrome SCREENSHOT
iMacros Browser IE Plug-in Firefox SEARCH
iMacros Browser IE Plug-in Firefox Chrome SET
iMacros Browser IE Plug-in Chrome SIZE
iMacros Browser IE Plug-in Firefox Chrome STOPWATCH
iMacros Browser IE Plug-in Firefox Chrome TAB
iMacros Browser IE Plug-in Firefox Chrome TAG
iMacros Browser IE Plug-in TRAY
iMacros Browser IE Plug-in Firefox Chrome URL
iMacros Browser IE Plug-in Firefox Chrome VERSION
iMacros Browser IE Plug-in Firefox Chrome 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.

iMacros Browser IE Plug-in Firefox Chrome !CLIPBOARD
iMacros Browser IE Plug-in Firefox Chrome !COLn
iMacros Browser IE Plug-in Firefox Chrome !DATASOURCE
iMacros Browser IE Plug-in Firefox Chrome !DATASOURCE_COLUMNS
Firefox !DATASOURCE_DELIMITER
iMacros Browser IE Plug-in Firefox Chrome !DATASOURCE_LINE
iMacros Browser IE Plug-in !DOWNLOADED_FILE_NAME Version 10.3 and above
iMacros Browser IE Plug-in !DOWNLOADED_SIZE Version 10.3 and above
iMacros Browser IE Plug-in Firefox Chrome !ENCRYPTION
iMacros Browser IE Plug-in !ENDOFPAGE
iMacros Browser IE Plug-in Firefox Chrome !ERRORIGNORE
iMacros Browser IE Plug-in Firefox Chrome !EXTRACT
iMacros Browser IE Plug-in Firefox Chrome !EXTRACT_TEST_POPUP
iMacros Browser IE Plug-in !EXTRACTDIALOG
iMacros Browser IE Plug-in !FAIL_ON_ALL_NAVIGATEERRORS
iMacros Browser IE Plug-in !FILELOG
iMacros Browser IE Plug-in Firefox Chrome !FILESTOPWATCH
iMacros Browser IE Plug-in Firefox Chrome !FILE_PROFILER
iMacros Browser IE Plug-in Firefox !FOLDER_DATASOURCE
iMacros Browser IE Plug-in Chrome !FOLDER_DOWNLOAD
iMacros Browser IE Plug-in !FOLDER_LOG
iMacros Browser IE Plug-in Chrome !FOLDER_MACROS
iMacros Browser IE Plug-in Firefox !FOLDER_STOPWATCH
iMacros Browser IE Plug-in !HTTP_ERRORCODE Version 11.5 and above
iMacros Browser IE Plug-in Chrome !IMAGEX
iMacros Browser IE Plug-in Chrome !IMAGEY
iMacros Browser IE Plug-in Firefox Chrome !LOOP
iMacros Browser IE Plug-in !MARKOBJECT
iMacros Browser IE Plug-in Firefox Chrome !NOW
iMacros Browser IE Plug-in Chrome !PLAYBACKDELAY
Firefox !POPUP_ALLOWED
iMacros Browser IE Plug-in Firefox Chrome !REPLAYSPEED
iMacros Browser IE Plug-in !REGION_BOTTOM
iMacros Browser IE Plug-in !REGION_LEFT
iMacros Browser IE Plug-in !REGION_RIGHT
iMacros Browser IE Plug-in !REGION_TOP
iMacros Browser IE Plug-in Firefox !SINGLESTEP
iMacros Browser IE Plug-in Firefox Chrome !STOPWATCHTIME
iMacros Browser IE Plug-in !STOPWATCH_HEADER
iMacros Browser IE Plug-in !TAGSOURCEINDEX
iMacros Browser IE Plug-in !TAGX
iMacros Browser IE Plug-in !TAGY
iMacros Browser IE Plug-in Firefox Chrome !TIMEOUT
iMacros Browser IE Plug-in !TIMEOUT_DOWNLOAD Version 10.3 and above
iMacros Browser IE Plug-in Firefox Chrome !TIMEOUT_MACRO
iMacros Browser IE Plug-in Firefox Chrome !TIMEOUT_PAGE
iMacros Browser IE Plug-in Firefox Chrome !TIMEOUT_STEP
iMacros Browser IE Plug-in Firefox Chrome !URLCURRENT
iMacros Browser !USE_DOWNLOADMANAGER Version 10.3 and above
iMacros Browser Firefox Chrome !USERAGENT
iMacros Browser IE Plug-in Firefox Chrome !VAR0...!VAR9
iMacros Browser IE Plug-in !WAITPAGECOMPLETE
iMacros Browser IE Plug-in !WINDOW_TITLE Version 11.5 and above
iMacros Browser IE Plug-in !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 iMacros Browser IE Plug-in Firefox Chrome

The Scripting Interface works with the iMacros Browser, Internet Explorer, Firefox and Chrome (see iimOpen for details on how to switch between the browsers).

  1. iimOpen (old: iimInit())
  2. iimGetBrowserPid (iMacros 10.4)
  3. iimDisplay
  4. iimGetInterfaceVersion()
  5. iimGetErrorText (old: iimGetLastError())
  6. iimGetExtract (old: iimGetLastExtract())
  7. iimPlay and iimPlayCode()
  8. iimSet
  9. iimSetWindowTitle() (iMacros 11.5) iMacros Browser IE Plug-in
  10. iimTakeBrowserScreenshot
  11. iimGetStopwatch (Old: iimGetLastPerformance)
  12. iimGetPerformance (new method!)
  13. iimClose (old: iimExit)
  14. Error handling: Scripting Interface Return Codes

Refer to the iMacros Editions Comparison Table to see which editions support the scripting interface (API)

Command Line Switches iMacros Browser IE Plug-in

  1. -key
  2. -kioskmode
  3. -loop
  4. -macro
  5. -noexit
  6. -silent
  7. -tray
  8. -profiler
  9. -var_varname
  10. -title Version 11.5 and above

In addition to the switches above, the following switches can be used with the iMacros Sidebar for IE:

  1. -timeout IE Plug-in
  2. -iePrivate IE Plug-in

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.