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 UserInterfaceThis is the Automation Engine's graphical user interface. [Formerly called the "Rich Client", "RichGUI" and "Dialog Client."]'s functions such as creating and editing objects, accessing statistical records, accessing the System OverviewThe UserInterface window that contains information about the Automation Engine system., 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 runtimeThe duration of a task's execution. It refers to the period between a task's start and end. It does not include its activation period (see also: activation and start). 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 listShows entities in a grid view 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 releaseReleases combine a set of activities and a set of packages as well as other release artifacts under a timeline (a plan including milestones and phases), which can be planned, baselined and tracked. 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 userIn the Automation Engine, a user is an instance of a User object, and generally the user is a specific person who works with Automic products. The User object is assigned a user ID and then a set of access rights to various parts of the Automation Engine system and product suite. These access rights come in the form of Automation Engine authorizations and privileges, Decision user roles and EventBase rights and ARA web application object rights. You can manage all these centrally in the ECC user management functions. See also, Unified user management. and are subject to the authorization system.

The ApplicationInterface functions may vary depending on the Automation EngineThis component drives an Automation Engine system and consists of different types of server processes. 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

 


Automic Documentation - Tutorials - Automic Blog - Resources - Training & Services - Automic YouTube Channel - Download Center - Support

Copyright © 2016 Automic Software GmbH