Macro >

Macro Properties


Macro properties include these fields:

Macro name
The macro name is shown in the list of macros in the main window if the name column is enabled in program settings. The macro name is also used in:

Macro menus
Macro menu shows up if multiple macros have the same trigger and the trigger is fired (such as multiple macros have Ctrl+Alt+T hot key assigned and the this hot key was hit).
Macro menu also shows up when <macromenu> command is executed.

Macro toolbars as button text or tooltip

          For these two purposes above the macro name can:

Contain macro variables (application global variable or system variable - learn more here). For example, the macro name can be this: "Clipboard: %_vClpText%". The variable %_vClpText% in the macro name is in macro menu or toolbar expanded to text currently in clipboard.

Be empty. In such case in the macro menus or toolbars either macro description is displayed (if not empty either) or the macro text (script). This can be handy if the macro text (script) is just a simple text (text insertion macro).

Disable macro
If checked then macro triggers do not work and macro is removed from all macro tool bars (and menus).

Add to tray menu
If checked, the macro will be added to the tray menu (menu that appears when the program’s tray icon is right-clicked) for quick macro start.

Use this macro as template 
If checked, this macro will be available in “Add macro” drop down list. When a new macro is created from template then it means that a copy of template macro is simply created.

Run macro in separate process
See * below.  

Run this macro when macro file is loaded 
If checked, the macro is automatically executed when the macro file is loaded.

Lock keyboard and mouse while macro is running 
If checked, the keyboard and mouse is locked during macro execution.  This means that user cannot affect macro execution by moving mouse to other position or by hitting keys on the keyboard.  From other hand, when this option is checked, it is not possible to stop macro execution by pressing "Shift+Esc" key combination.  In a case macro is running and it is necessary to unlock mouse and keyboard again in order to stop macro execution then press Ctrl+Alt+Del, return back to desktop and use "Shift+Esc".

Macro playback speed
There are several options how fast the macro should be executed.  This option makes only sense when the macro plain text is being sent as keystrokes and there is desire to slow up or speed down the keystrokes sending. Typically, this option can be useful for recorded macros

Repeat macro
How many times the macro should be subsequently run.

Unique identifier of the macro assigned automatically to the macro by program. The ID can be used to reference the macro.

Macro description
Free form text. Can be used for notes, description, TODO's etc.


* Run macro In Separate Process

During a macro execution no other macro can start.  This is not convenient for macros that can take very long to finish (for example, FTP download).  In such case there is an option to start time consuming macro in separate process so that it doesn't block other macros from starting.

Starting macro in separate process means, that a new process to run the macro is loaded to computer memory and the macro execution continues within this process.  When macro execution is finished, the process is released from the computer memory again.  There are three ways how the program can be started:

1.Normal (as currently logged user) - this is the default option.

2.Run as different user - this option allows user to start macro on other user's account.  It is necessary to specify user name and password (and, optionally, domain).  In addition, this option requires specific user rights to be set in Windows: Act as part of the operating system (SE_TCB_NAME), Bypass traverse checking (SE_CHANGE_NOTIFY_NAME) , Replace a process level token (SE_ASSIGNPRIMARYTOKEN_NAME), Increase quotas (SE_INCREASE_QUOTA_NAME). 
There is "WhoAmI.exe" utility that is part of the program distribution.  You can create simple macro consisting just from <execappex>("whoami.exe","","",0,0) command.  When the macro is started a WhoAmI.exe dialog box shows user name of the account under which the WhoAmI.exe program was started.  This can be used to verify the macro is started on right account. 

3."As administrator" - this allows to run macro "as administrator" (with higher priority).