Custom Code APIs

InstallAnywhere 2017

InstallAnywhere includes several APIs that enable you to extend its functionality and automate most IDE and GUI tasks.

InstallAnywhere APIs

API

Description

General API

Encapsulated in com.zerog.ia.api.pub, this API provides a collection of interfaces that support custom code actions, panels, consoles, and rules, as well as access to build settings, build distribution settings, and more.

See the com.zerog.ia.api.pub package-summary page in the javadocs.

Note • The General API javadocs are found by opening the \javadoc\com\zerog\ia\api\pub\package-summary.html page in the InstallAnywhere installation directory.

Product Registry API

A subset of the general, public API, the Product Registry API provides a way to query (read-only) the product registry file (registry.xml) used by InstallAnywhere. The product registry contains information about installed products (version, install date, components, features, and so on).

See the package summary page for the Product Registry API (com.zerog.ia.api.pub.registry) for more information.

Note • The Product Registry API javadocs are found by opening the \javadoc\com\zerog\ia\api\pub\registry\package-summary.html page in the InstallAnywhere installation directory.

Services API

This API provides services such as File, Security, System, Win32, Win32 Registry, and Windows Account Privileges. Specific service support and service packages are listed on the javadocs index.html page.

Note • The Services API javadocs are found by opening the \javadoc\index.html page in the InstallAnywhere installation directory.

Project Automation API

This API supports the ability to edit projects programmatically.

Although this API does support projects with existing references to Merge Modules (dynamic and static), it does not support importing, editing, or removing Merge Modules, nor does it support adding plugins.

For more information on using the Project Automation APIs, see the following:

Project Automation API Code Samples
Project Automation APIs for Maintenance Mode and Instance Management
Project Automation javadocs, which are found by opening the \project‑auto\javadocs\index.html page in the InstallAnywhere installation directory.

Test Automation API

This API is a framework for automated testing of InstallAnywhere GUI installers.

See test automation readme.txt and javadocs for more information.

Note • The Test Automation API javadocs can be found by opening the \gui‑test‑auto\javadocs\index.html page in the InstallAnywhere installation directory. The readme.txt file can be found in the \gui-test-auto directory of the InstallAnywhere installation directory.

Note • For more information about working with custom code, see Packaging and Executing Custom Code and Packaging Custom Code as a Plug-in.

See Also