AE.ApplicationInterface (Java API)

The AE.ApplicationInterface is an interface that allows you to access to the Automic System. It is available in Java. This interface comprises hundreds of classes and methods which can be used to call many of the Automic Web Interface functions such as creating and editing objects, accessing execution lists, accessing the Administration perspective, reading reports, starting tasks, etc. All actions are kept for the Revision Reports and can be listed using the AE Revision utility.

The Automation Engine and the Java components, such as AWI, communicate using TLS/SSL. These components establish a connection with the Java communication process (JCP), which uses trusted certificates to prove its identity to other communication partners.

When you used certificates signed by a CA, the certificates are stored in the respective Java or OS store by default; that is the Java trust store for Java components. In this case, you only have to check that the root certificates already are in the respective store.

If you do not want to use the default locations for the relevant component, make sure you use the trustedCertFolder= parameter in the respective configuration (INI) file to define the path to the folder where the trusted certificates are stored.

For more information, see TLS/SSL Considerations for Automic Automation and Securing Connections to the AE (TLS/SSL).

The AE.ApplicationInterface files are provided in the directory IMAGE:\APPLICATIONINTERFACE.

  • uc4.jar

    AE.ApplicationInterface Java library

  • doc.zip

    Javadoc (Java documentation) which contains a list and description of all classes and methods.

  • examples.zip

    Sample Programs

There are numerous ways of using the AE.ApplicationInterface. For example, you can automatically create many objects simultaneously or release only a relevant processing selection to users. This interface is an ideal addition to extend your existing programs, as it allows you to access your Automic System.

Notes:

  • Accessing the Automic System through the AE.ApplicationInterface requires an AE user and is subject to the authorization system.
  • The AE.ApplicationInterface functions may vary depending on the Automation Engine version you are using. It is recommended to reconvert your projects when you install a new version.
  • This integration capability, like all integrations of the Automic system, can support service orchestration workflows. Such workflows orchestrate automated processes that run across multiple platforms, domains, and applications to deliver a specific IT service. For more information, see About Service Orchestration.  

Important! You must distinguish the AE.ApplicationInterface from the CallAPI for Java, which serves to execute an AE Script in the Automic System.

See also: