Application Integration Guide > ApplicationInterface > Using this Interface

Using this Interface

The classes and methods of the AE ApplicationInterface can be used as soon as the library has been integrated in your program.

Data between the program and the AE system is exchanged via "Requests". Keep in mind that you should establish a connection to the AE system and log on to a clientA closed environment within an Automation Engine system where you can create and run objects. A client name consists of a 4-digit number that must be indicated when a user logs on to the Automation Engine system. Users and their rights are also defined in clients. A particular Automation Engine object type., as otherwise requests cannot be sent or received.

Procedure

The following steps are always required, regardless of how your program is used:

  1. Establish a connection to the AE system:
    Connection uc4 = Connection.open("PC01", 2217);

  2. Log on to the AE system with a 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.:
    uc4.loginAn Automation Engine object type that stores account credentials used by agents on target systems.(98,"SMITH","UC4",null,'D');

  3. Any number of requests can be sent now (e.g., searching for an objectAutomation Engine controlled activities and processes are structured in the form of objects. See also: Task). These requests are sent synchronously or asynchronously using the methods "sendRequestAndWait" and "sendRequest".
    uc4.sendRequestAndWait(WinJobs);
    uc4.sendRequest(WinJobs, Handle);
    Now access the request result (e.g., search result).

  4. Finally, terminate the connection
    uc4.close();

Requests are used for retrieving information from or executing an actionActions are predefined building blocks for recurring activities. They are commonly used for managing third party systems or in deployment scenarios. in the AE system. The supplied packageA Package is an instance (a version, a revision, a tag, …) of your application and defines the content which you want to deploy. Here you decide, if you want to deploy the entire application or just a few specified components. includes several examples which describe how the AE.ApplicationInterface is best used. Additionally, the documents shown below provide information about the most important classes.

 

See also:

Classes for Objects
Classes for Workflows and Schedules

Classes for Activities

Classes for Statistics and Reports

Classes for the System Overview

 


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

Copyright © 2016 Automic Software GmbH