Operations are also described in the supplied file uc4.wsd.
Logon/Logoff
| Description | Operation | Parameters | Return code |
|---|---|---|---|
| Logon |
logon
|
Client, user name, department, password, language Allowed values for the language: "68" (German), "69" (English) and "70" (French) |
Session ID |
| Logoff | logoff | Session ID | - |
AE System Information
| Description | Operation | Parameters | Return code |
|---|---|---|---|
| Retrieving the Automation EngineDiese Komponente steuert ein Automation Engine-System. Besteht aus verschiedenen Serverprozessen. version including the hotfix number | getVersion | - |
Automation Engine version Example: 8.00A909-001 |
| Retrieving database information (see System Overview - Database) | getDatabaseInfo | - |
Type DatabaseInformation Use this type to query individual information such as the database name. |
Client Information
System client 0000 supplies a list of all the AE system's users, agents etc. If you log on to a user-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 process 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 |
Starting and Stopping Clients
| Description | Operation | Parameters | Return code |
|---|---|---|---|
| Starting a client | resumeClient | - | - |
| Stopping a client | suspendClient | - | - |
Starting, Ending etc. Tasks
| Description | Operation | Parameters | Return code |
|---|---|---|---|
| Starting an object | executeObject |
Object name, TimeZone, Input parameter for READ masks, Start time, Waiting for manual release See also Filling :Read masks The parameter "Waiting for manual release" is of type boolean. |
RunID"Kurzform für ""laufende Nummer"". Hierbei handelt es sich genauer um eine Zahl, welche die Durchführung einer Aufgabe eindeutig kennzeichnet. Die RunID kann zwischen 7 und 10 Stellen aufweisen. Sie wird von der Komponente Automation Engine vergeben." of the started task |
| 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 container |
| Repeating a task | restartTask |
Reference RunID, Restart point, Keep start type, Waiting for manual release, Restart for canceled child 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 | - |
Tasks During Execution
| Description | Operation | Parameters | Return code |
|---|---|---|---|
| Reloading a ScheduleStartet in periodischen Abständen aktivierbare Objekte. Auch ein eigener Objekttyp in der Automation Engine. at the next period turnaround | setReloadNextTurnaround | Schedule name | - |
| Ignoring SyncSynchronisiert aktivierbare Objekte auf der Grundlage definierter Zustände und Aktionen. Auch ein eigener Objekttyp in der Automation Engine. conditions | ignoreTaskSyncCondition | RunID | - |
| Unregistering a reservation | unregisterTask | RunID | - |
| Setting a task's start time | setTaskStartTime |
RunID, Start time, TimeZone |
- |
| Setting a task's status | 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. |
Workflow and Workflow Tasks
| Description | Operation | Parameters | Return code |
|---|---|---|---|
| Setting a breakpoint in a workflow | 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: