Distributing iMacros

From iMacros
Jump to: navigation, search

The iMacros Player iMacros Browser IE Plug-in Firefox

If you plan to distribute your solution we highly recommend the iMacros Enterprise Edition which includes free unlimited player licenses for use inside your company.

Features of the iMacros Enterprise Player:

  • All features of Enterprise Edition, except the ability to record new macros
  • The option to install and run in the background (no visible user interface).
  • Unlimited number of installations within your company or organization.

The Enterprise Player license allows you to distribute macros, scripts and programs based on iMacros along with a copy of iMacros itself to your users *within* your company. Technically speaking this means that if iMacros is unlocked with the player license key your users have all the features of the ENTERPRISE EDITION available except the ability to record new macros.

For distributing macros outside your company you can purchase the iMacros Component for .NET separately. The iMacros Component for .NET license allows unlimited, royalty-free distribution to anyone (outside your company, web downloads, cloud-based service, etc.). For more information and pricing for the iMacros Component for .NET, please visit the product, Wiki, and purchasing pages.

Please see iMacros Player licensing examples for more information.

Distributing the iMacros setup

You can distribute the normal setup executable from http://imacros.net/download.

When installing your application on the end-user's computer, you can easily call the iMacros setup from your own custom installer and install the iMacros Trial version. You (or the end-user) can then either manually enter the license into iMacros or you can use one of the approaches described below.

Configuring the Player License

Please note: If you are distributing your application to external customers, you need to have also purchased the royalty-free distribution license that is provided by the iMacros WebBrowser Component for .NET, as explained here.

iMacros 10.1 and later

You need to distribute your Enterprise Player license file with your application and make an update to the registry. You can obtain your license file from your Ipswitch Community account as explained in this FAQ.

You can give the license file any name and store it in any appropriate folder on the machine. The iMacros LicenseKey registry setting needs to contain the full path to the license file.

[HKEY_CURRENT_USER\Software\Ipswitch\iMacros]
"LicenseKey"="C:\\MyCusomApp\\iMacrosEnterprisePlayerLicense.txt"

iMacros 10.02 and older

If you are using your own custom installer, you can write your old-style Player license key to the iMacros LicenseKey registry setting:

[HKEY_CURRENT_USER\Software\Ipswitch\iMacros]
"LicenseKey"="XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX"

For 10.00 and older the iMacros registry path is:

HKEY_CURRENT_USER\Software\iOpus\iMacros

As an alternative to writing the key in the registry, you can program your custom application to provide the key in the call to iimOpen (only with versions 10.02 and older):

iimOpen("-key XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX")

Additional Notes

  1. The registry settings mentioned above are on a per-user basis (they are stored in HKEY_CURRENT_USER). So if multiple users intend to run your iMacros application on the same machine, you need to make sure the LicenseKey setting is configured for each user account, as mentioned in this FAQ.
  2. If you never obtained your old-style Player license key, you can generate one using your (old-style) primary Enterprise key on this page.

Setup Command Line Switches

The installer program accepts the following optional command line parameters.

/SILENT
/VERYSILENT

These instruct Setup to be silent or very silent. When Setup is silent the Wizard and the background window are not displayed but the installation progress window is. When a setup is very silent this installation progress window is not displayed. Everything else is normal, so for example error messages during installation are displayed.

If a restart is necessary and the /NORESTART command isn't used (see below) and Setup is silent it will display a "Reboot now?" message box. If it's very silent it will reboot without asking.

/SUPPRESSMSGBOXES

Instructs Setup to suppress message boxes. Only has an effect when combined with /SILENT or /VERYSILENT.

The default response in situations where there's a choice is:

  • Yes in a 'Keep newer file?' situation.
  • No in a 'File exists, confirm overwrite.' situation.
  • Abort in Abort/Retry situations.
  • Cancel in Retry/Cancel situations.
  • Yes (=continue) in a DiskSpaceWarning/DirExists/DirDoesntExist/NoUninstallWarning/ExitSetupMessage/ConfirmUninstall situation.
  • Yes (=restart) in a FinishedRestartMessage/UninstalledAndNeedsRestart situation.
/SUPPRESSRUN

Prevents the browsers from launching after setup completes.

/NOCANCEL

Prevents the user from cancelling during a silent installation by disabling the Cancel button and ignoring clicks on the close button. Only works with /SILENT.

/NORESTART 

Instructs Setup not to reboot even if it's necessary. Note that installing iMacros does not require a reboot unless iMacros was already installed and running on the machine during the setup.

/GROUP="folder name" 

Overrides the default folder name displayed on the Select Start Menu Folder wizard page.

Fully Silent Install

For a completely silent installation, you would use the following combination of switches:

iMacrosSetup.exe /VERYSILENT /SUPPRESSMSGBOXES /SUPPRESSRUN

Uninstaller Command Line Switches

The uninstaller program (unins000.exe) also accepts the following optional command line parameters.

/SILENT 

When specified the uninstaller will not ask the user any questions or display a message stating that uninstall is complete. Shared files that are no longer in use are deleted automatically without prompting. Any critical error messages will still be shown on the screen.

/SUPPRESSRUN

Prevents the iMacros Uninstall Survey from launching after the uninstall completes.

Restricted User Accounts

iMacros runs well on restricted user accounts, locked down systems and systems that use Active Directory services.

If you install the software for users with restricted rights, please note:

  1. The software must be installed by a user with administrative rights
  2. iMacros folders (Macros, Datasources, Downloads and Logs) are personal, so each user will have his own %USERPROFILE%\Documents\iMacros folder. However only the user who installed iMacros will have the Demo macros in his User Profile folder.

Modify settings directly

All settings used by iMacros are stored in the registry. We do not recommend editing these settings manually unless you know what you are doing. If in doubt please contact the iMacros Support Team.

Changes in an existing installation

Edit Settings

All iMacros settings are stored in the registry (see also this forum post for some use cases for manipulating the registry directly). But since you can change most settings through the user interface editing the registry is not required or recommended for most users.


Note: The iMacros for Firefox settings are not stored in the registry. Here we follow the Firefox standard and store the addon settings in the Firefox user profile, so the iMacros for Firefox setting are per user. You can view and edit them by typing "about:config" in the address line. You can even select a certain user profile via the iimInit "-fxProfile" switch.

Enter about:config to access the iMacros for Firefox settings

Edit Paths

All iMacros paths can be changed directly in the user interface. To change them, go to the EDIT tab, click OPTIONS and open the PATH tab:

iMacros Paths