Operations are also described in the supplied file uc4.wsd.
Description | Operation | Parameters | Return code |
---|---|---|---|
Logon |
logon
|
Client, user nameName of the Automation Engine user., departmentDepartment name to which the Automation Engine user belongs., passwordA secret combination of characters for a Automation Engine user., language Allowed values for the language: "68" (German), "69" (English) and "70" (French) |
Session ID |
Logoff | logoff | Session ID | - |
Description | Operation | Parameters | Return code |
---|---|---|---|
Retrieving the Automation EngineThis component drives an Automation Engine system and consists of different types of server processes. version including the hotfix number | getVersion | - |
Automation Engine version Example: 8.00A909-001 |
Retrieving databaseA database is an organized collection of data including relevant data structures. information (see System Overview - Database) | getDatabaseInfo | - |
Type DatabaseInformation Use this type to query individual information such as the database name. |
System 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. 0000 supplies a listShows entities in a grid view of all the AE system's users, agents etc. If you log on to 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.-defined client, only this client's objects will be supplied. This list corresponds to the content of the System Overview.
Description | Operation | Parameters | Return code |
---|---|---|---|
List of server processes | getServerList | - |
List of type ServerListItem Use this type to query individual information such as the server processThe core of the component Automation Engine. Different types are available: communication, work and dialog processes, as well as nonstop processes. name. |
Server process workload list | getSystemWorkload | - |
List of type WorkLoadItem Use this type to query individual information such as the average. |
List of clients | getClientList | - |
List of type ClientListItem Use this type to query individual information such as the TimeZone. |
List of users | getUserList | - |
List of type UserListItem Use this type to query individual information such as the name. |
List of agents | getAgentList | - |
List of type AgentListItem Use this type to query individual information such as the roles. |
List of agent groups | getAgentGroupList | - |
List of type AgentGroupListItem Use this type to query individual information such as the mode. |
Content of the Activity Window | getActivityList |
Filters The parameter is of type TaskFilter. |
List of type Task Use this type to query individual tasks. |
Top priority of active notifications | getHighestNotificationPriority | - |
Top priority of all running notifications. Possible values: "LOW" - Low |
Description | Operation | Parameters | Return code |
---|---|---|---|
Starting a client | resumeClient | - | - |
Stopping a client | suspendClient | - | - |
Description | Operation | Parameters | Return code |
---|---|---|---|
Starting an objectAutomation Engine controlled activities and processes are structured in the form of objects. See also: Task | executeObject |
Object name, TimeZone, Input parameter for READ masks, Start time, Waiting for manual 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. See also Filling :Read masks The parameter "Waiting for manual release" is of type boolean. |
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 started taskAn executable object that is running. Tasks are also referred to as activities. |
Starting a recurring task | executeRecurring |
Object name, TimeZone, Frequency, Time frame, Days, Range The parameter "Frequency" is of type ExecuteFrequency. The parameter "Time frame" is of type ExecuteTimeFrame. The parameter "Days" is of type ExecuteDays. The parameter "Range" is of type ExecuteRange. |
RunID of the started period containerControls the execution of periodical tasks. |
Repeating a task | restartTask |
Reference RunID, Restart point, Keep start type, Waiting for manual release, Restart for canceled childA subordinate task (such as a task that runs in a workflow). tasks only The 3rd, 4th and 5th parameters are of type boolean. |
- |
Stopping a task | suspendTask |
RunID, Recursive The parameter "Recursive" is of type boolean. |
- |
Setting a stopped task to active | resumeTask |
RunID, Recursive The parameter "Recursive" is of type boolean. |
- |
Ending a task | quitTask | RunID | - |
Canceling a task | cancelTask |
RunID, Recursive The parameter "Recursive" is of type boolean. |
- |
Deactivating a task | deactivateTask | RunID | - |
Adopting a task | adoptTask | RunID | - |
Description | Operation | Parameters | Return code |
---|---|---|---|
Reloading a Schedule at the next period turnaround | setReloadNextTurnaround | Schedule name | - |
Ignoring Sync conditions | ignoreTaskSyncCondition | RunID | - |
Unregistering a reservation | unregisterTask | RunID | - |
Setting a task's start time | setTaskStartTime |
RunID, Start time, TimeZone |
- |
Setting a task's statusThis represents the condition of a task (such as active, blocked, generating). | setTaskState |
RunID, Old status, New status In both status parameters, indicate the system return code. |
- |
Starting a task immediately | startTaskImmediately | RunID | - |
Reading a task's Detail Window | getTaskDetails | RunID |
List of type DetailGroup Use this type to query individual information such as the status. |
Description | Operation | Parameters | Return code |
---|---|---|---|
Setting a breakpoint in a workflowAn object of the Automation Engine that can include several executable objects and which runs them in a specified order. [Formerly called "ProcessFlow" and "JobPlan."] | setWorkflowBreakPoint | RunID | - |
Removing a breakpoint from a workflow | removeWorkflowBreakPoint | RunID | - |
Unblocking a task in a workflow | unblockWorkflowTask | RunID | - |
Activating a task in a workflow | setWorkflowTaskActive | RunID | - |
Deactivating a task in a workflow | setWorkflowTaskInactive | RunID | - |
See also:
Automic Documentation - Tutorials - Automic Blog - Resources - Training & Services - Automic YouTube Channel - Download Center - Support |
Copyright © 2016 Automic Software GmbH |