Application Integration Guide > ApplicationInterface > Introduction

Introduction

The ApplicationInterface is an interface that facilitates access to the AE system.

The ApplicationInterface is available for Java and .NET programming languages.

The interface comprises hundreds of classes and methods which can be used to call many of the UserInterface's functions such as creating and editing objects, accessing statistical records, accessing the System Overview, reading reports, starting tasks, etc. All actions are kept for the Revision Reports and can be listed using the utility AE Revision.

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

File Description
uc4.jar ApplicationInterface Java library
*.dll ApplicationInterface .NET library (for .NET programming languages such as C# and VisualBasic)
*.zip

Archive with IKVM runtime libraries which are required for using the .NET library. The DLL files in the archive must be added to the respective .NET project.

doc.zip

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

The names of the Java library classes/methods are the same as those in the .NET library.

examples.zip Sample Programs

All sample codes in the following documents work with the programming languages Java and C#. For other programming languages, the syntax in the examples should be adapted as appropriate.

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

Access via the ApplicationInterface must be made with an AE user and are subject to the authorization system.

The ApplicationInterface functions may vary depending on the Automation Engine version in use. Automic recommends reconverting your projects when you install a new version.

It is important that you do not confuse the ApplicationInterface with the CallAPI for Java, which serves to execute an AE Script in the AE system.

Note that the ApplicationInterface cannot be called from Enterprise JavaBeans. For this, use the ResourceAdapter.

 

Also see:

Using this Interface