Application Integration Guide > CallAPI > CallAPI and your own program > Visual Basic

 Visual Basic

The CallAPIA programming interface that processes a script in the Automation Engine system. It can be called directly from within the program itself or from a different program. can be used to process scripts in the AE system from your own VB programs.

This functionPre-defined run book template in the Automation Engine. One single step only, e.g. Start Windows Service, Copy file,… is found in the COM objectAutomation Engine controlled activities and processes are structured in the form of objects. See also: Task AE.Call3 which must be registeredThis is the status of a task that runs within a group and is waiting for its start..

Example: regsvr32 c:\AUTOMIC\callapi\windows\bin\ucxbwi3c.dll

The delivery directory contains a sample program that provides a detailed description of how a scriptA particular Automation Engine object type. activation can be implemented.

General

  1. Scripts are always activated with the following steps:
    1. Log on to the AE system.
    2. Transfer the script to the AE system.
    3. Log off from the AE system.

You can log on to several AE systems at the same time and process various scripts. In this case, a Dialog license is used for each connection.

Methods

In your program, you can use the functions listed below. They supply return codeThe value that represents the result of tasks and script functions. 0 if the actionActions are predefined building blocks for recurring activities. They are commonly used for managing third party systems or in deployment scenarios. was successful, or a message number if an error occurred.

Description

Method

Logging on to the AE system

LogonclientA 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., 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., [departmentDepartment name to which the Automation Engine user belongs., [passwordA secret combination of characters for a Automation Engine user.]]

Specifying INI file

SetIniFile path and name of INI file

Logging on using INI-file data

LogonAsDefault

Activating a script

ActivateScript script

Logging off the AE system

Logoff

Attributes

Information about script execution is automatically stored in variables.

Data type

Variable

Description

Long

lRunNr

RunIDShort for "run number". It is a number that provides unique information about a task's execution. The RunID can include 7 to 10 digits. It is assigned by the Automation Engine component . of the script

Long

lRetCode

Return code of script execution

String

cRetText

Variable message part which explains the return code value

 

See also:

About the CallAPI

 


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

Copyright © 2016 Automic Software GmbH