Package com.uc4.api.objects

This package contains classes related to objects in the Automation Engine.

See: Description

Interface Summary

Interface	Description
Action	Action on the Pre-Condition or Post-Condition tab of an Automation Engine Workflow task.
Authorizations.Entry	Represents a single authorization for a client.
Condition	Condition of a JobPlan task (PreCondition or PostCondition).
ICallOperatorCondition	This class represents a row in the Operator assignments of a Notification.
IFolder	This interface represents a folder.
IHostAttributes	Interface for host attributes of a Job.
ITaskItem	Contains common methods of tasks in a Workflow and Schedule.
LifecycleSaveAware	This interface allows objects that implemented to be notified after save operations were executed on the object.
Rights	Interface for Rights.
WorkflowInterfaces	Interfaces for all workflow related classes
WorkflowInterfaces.IUpdatable	Indicates that a class can be updated

Class Summary

Class	Description
AbortAction	Condition action that aborts the workflow.
AbstractDocumentation	This class is the base class of text and xml documentations.
AgentAssignment	This class represents an HSTA object (agent assignment).
AgentAssignmentFilter	This class represents the filter tab of an HSTA object.
AgentAssignmentFilter.Item	This class represents a row in the filter table.
AttributesBS2000	Host attributes for BS2000 Jobs.
AttributesGCOS8	Host attributes for GCOS 8.
AttributesJMX	Host attributes for JMX Jobs.
AttributesMPE	Host attributes for MPE.
AttributesNSK	Host attributes for NSK Jobs.
AttributesOA	Host attributes for Oracle Applications Jobs.
AttributesOS390	Host attributes for OS/390.
AttributesOS400	Host attributes for OS/400 Jobs.
AttributesPS	Host attributes for PeopleSoft Jobs.
AttributesRA	Host attributes for RA Jobs.
AttributesSAP	Host attributes for SAP Jobs.
AttributesSiebel	Host attributes for Siebel Jobs.
AttributesSLO	This class represents information of the attributes tab of an object.
AttributesSQL	Host attributes for SQL Jobs.
AttributesUnix	Host attributes for UNIX Jobs.
AttributesVMS	Host attributes for VMS Jobs.
AttributesWin	Host attributes for Windows Jobs.
Authorizations	Authorizations of Agents.
BackendCommand	This class represents a Command (row) on the Variable of the type BACKEND.
BackendVariable	Backend Variable.
BlockAction	Blocks the according branch in the ProcessFlow (as 'else block' in V8 or lower) without checking of further conditions.
Calendar	Calendar object.
CalendarCondition	This class represents a calendar condition.
CalendarKeyword	Calendar Keyword.
CancelProcessFlowAction	Cancels a ProcessFlow without checking of further conditions.
ChangeQueueAction	Changes the Queue defined in the task.
CheckActivitiesCondition	Checks the status of an activity.
CheckConnectionCondition	Checks the connection to a remote system, if the tasks has a connection.
CheckFileCondition	Checks if a file exists.
CheckHistoryCondition	Checks if the last execution of an object satisfies the defined status and the defined satisfaction lead time.
CheckProcessCondition	Checks if a particular process is running on the host system.
ClearVariableAction	Deletes the content of a static variable.
Client	This class represents a UC4 CLNT object.
Cockpit	Represents the Cockpit object CPIT.
CockpitBar	Represents the Bar control of the Cockpit.
CockpitBox	Represents the Box control of the Cockpit.
CockpitControl	CockpitControl.
CockpitControlDataSource	Represents the data source of a CockpitControl object.
CockpitDesign	Represents the Cockpit tab of the Cockpit object.
CockpitFrame	Represents the Frame control of the Cockpit.
CockpitLamp	Represents the Lamp control of the Cockpit.
CockpitPie	Represents the Pie control of the Cockpit.
CockpitThresholds	Represents the Threshold values for the CockpitControl Pie, Bar and TrafficLight.
CockpitTrafficLights	Represents the Traffic light control of the Cockpit.
CockpitValueControl	Basis for all Cockpit control with values.
CodeTable	This class represents a Automic CodeTable object.
CompositeVariable	This class represents the panel "Variable" of an VARA Object with the source "Composite".
ConditionOrAction	Base class of all Conditions or Actions.
ConditionsSet	Container for conditions.
ConsoleBS2000	Console settings for BS2000.
ConsoleEvent	Console Event.
ConsoleEventSetting	Sub classes contain additional fields that are specific for a certain Operating System.
ConsoleOS390	Console Event settings for OS/390.
ConsoleOS390.ConsoleOS390Filter	This class represents a single filter entry for OS/390 Console Events.
ConsoleOS400	Settings for OS/400.
ConsoleOS400.ConsoleOS400Filter	This class represents a single filter for a OS/400 Console Event.
ConsoleSAP	SAP Console Event.
ConsoleSAP.EventHistoryFilter	This clas represents a single entry in the SAP ConsoleEvent of DataSource Event History.
ConsoleSAP.JavaEventHistoryFilter	This class represents a single entry in the SAP ConsoleEvent of DataSource Java Event History.
ConsoleSAP.XIChannelFilter	An instance of this class represents a single entry in the list of filter for XI Communication channels.
ConsoleWindows	Console Event Settings for Windows.
ConsoleWindows.ConsoleWindowsFilter	An instance of this class reprensents a single filter line.
CurrentQueueCondition	Checks the Queue the task will run in.
CurrentTimeCondition	Checks the (physical) time in the timezone the object was started in.
CustomAttribute	Custom Attribute.
CustomAttributeFilter
Dashboard	Dashboard object.
DatabaseConnection	This class represents a CONN.DB Object.
DatabaseEvent	Database event.
DatabaseEventSettings	This class provides acccess to Database Event settings.
DatabaseEventValue	Represents a value in the database event.
DeactivateCondition	This class contains deactivate condititions.
Deployment	This class represents the deployment tab of a ProcessFlow.
DocuContainer	This class represents the documentation tab of an Automation Engine object.
Documentation	This class represents a DOCU Object.
DynamicExecVariable	Dynamic Executable Variable.
DynamicSQLVariable	Dynamic Database Variable.
DynamicSQLVariableIntern	Internal database variable.
EstimatedRuntime	Estimated Runtime.
EventAttributes	Attributes of this event object.
EventCalendar	This class represents the calendar tab on an Event object.
EventCalendarItem	This class represents a single line in the "Calendar" tab of an Event object.
EventSettings	This class represents the "Event" tab of an Event object.
ExecuteObjectAction	Starts any Automation Engine object.
ExecuteRecurring	Recurring definition of a task.
FileEvent	FileEvent.
FileListVariable	This class represents the panel "Variable" of an VARA Object with the source "Filelist".
FileSystem	This class represents the "FileSystem" tab of an file event object.
FileTransfer	This class represents a FileTransfer Object.
FileTransferAttributes	Filetransfer attributes.
FileTransferSettings	This class contains settings for the FileTransfer object ("FileTransfer")-Tab.
ForecastTaskState	List of valid status values for a forecast.
Group	This class represents a UC4 JOBG object.
GroupAttributes	JobGroup attributes.
GroupCalendarKeyword	This class represents a group calendar keyword.
Header	This class represents information of the header tab of an object.
Host	An instance of this class represents a single HOST object.
HostAttributes	This class represents the "Attributes" tab in HOST objects.
HostGroup	Hostgroup object.
HostGroupItem	This class represents a single filter entry in HOSTG objects.
Include	This class represents Include objects.
JCL	This class represents the JCL tab of JOBS monitor.
Job	This is the base class for all jobs.
JobAttributes	This class represents the attributes of a job.
JobPlan	This class represents a standard Workflow object.
JobPlanAttributes	This class repesents JobPlan attributes.
JobPlanCheckpoint	Deprecated Use ProcessFlowGeneral instead, this class will be removed in the next main release
JobPlanDependencies	JobPlan task dependencies.
JobPlanEarliest	This class can be used to specify the earliest starting time for a task in a JobPlan.
JobPlanExternal	External Dependency.
JobPlanTask	Task in the JobPlan.
JobPlanTaskDependency	This class represents a single JobPlan dependency.
Login	Login object.
LoginDefinition	This class represents a single entry a Login object.
LoopDataSource	This class represents the datasource in a ProcessFlow loop.
MaximumRuntime	This class represents the maximum runtime settings.
MaxParallel	This class contains information about the maximum number of parallel tasks.
MinimumRuntime	This class represents the settings for Minimum Runtime.
ModifyStateAction	Sets return code without checking of further conditions.
MonthlyCalendarKeyword	This class represents a monthly calendar keyword.
Notification	Notification Object.
NotificationAttributes	Notification attributes.
NotificationSettings	This class represents the "Notification" tab within a Notification object.
ObjectAuthorizations	This class serves to define access rights for a UC4Objects.
ObjectFactory	Creates new tasks in Workflow without a check if there is an existing definition in the Automation Engine.
ObjectRight	This class represents a row on the authorizations tab of an object.
ObjectValues	This class contains values and PromptSets of executable Objects.
OCVPanel	This class provides access to the values of Connection Objects and Rapid Automation Jobs.
OCVPanel.CITValue	This class represents a single row in this panel.
Operator	Operator settings of an Nofitication.
OutputFiles	This class represents the "Output" tab of Job objects.
OutputFilter	Output Filter.
OutputFilter.Entry	This class represents a single filter definition in an OutputFilter object.
OutputScan	This class represents the Output-Scan tab in AE-Object definitions.
OutputScanFilter	This class represents a single row Output-Scan tab of an Automation Engine Object.
Period	An object that holds settings that may be used for periodic execution of tasks.
ProcessFlowGeneral	This class can be used to access the "General" tab of a task in a ProcessFlow.
PromptDesigner	This class is used to design Prompt Elements.
PromptElement	Basis class of all prompt elements.
PromptSet	This class represents a PromptSet Object in the Automation Engine.
PromptSetDefinition	This class is created using the request com.uc4.communication.AddPromptSet An instance of this class can be added to executable Objects (for example Jobs) and default values for PromptElements can be set.
PSRemoteTaskManager	RemoteTaskManager for PeopleSoft.
PSRemoteTaskManagerFilter	Filter for PeopleSoft RemoteTaskManager objects.
PublishValueAction	Publish a value.
Queue	Queue Object.
QueueAttributes	This class represents the "Queue" tab of a Queue object.
QueueExceptionCondition	This class represents a single line in the Exception table of a Queue object.
QueueManagerAttributes	Attributes of JOBQ Objects.
RAConnection	This class represents an RA Connection Object.
ReEvaluateAtAction	Exits current evaluation cycle.
ReEvaluateInAction	Exits current evaluation cycle.
ResourceItem	This class represents Storage resource items.
ResourceItems	This class represents Storage resource items.
RestartTaskAction	Restarts the task and exits current evaluation cycle.
ReturnCodeCondition	Checks the return code of the task.
Rollback	This class represents the rollback tab on executable Automation Engine objects.
RollbackAction	Rollback Action.
RollCalendarCollision	This class represents a reaction to a collision for roll calendar keywords.
RollCalendarKeyword	This class represents a Roll Calendar Keyword.
RuleEvent	IA Event.
RuleEventSetting	Settings of an IAEvent
RunPathAction	Run Path.
RunTaskAction	Starts the task without checking of further conditions.
Runtime	The "Runtime" tab is an object class-specific tab that is found in every executable object in UC4.
SAPAgentPanel	This provides access to the values on the "SAP" tab of a host object.
SAPConnection	This class represents an SAP Connection object.
SAPConnectionHTTP	This class can be used to read or set the HTTP connection data for SAP Connection objects (PI, SLD, JXBP).
SAPConnectionRFC	This class can be used to read or set the RFC connection data for SAP Connection objects.
SAPQueueManager	RemoteTaskManager for SAP ABAP Jobs.
SAPQueueManagerFilter	Filter for SAP RemoteTaskManager objects.
Schedule	Schedule.
ScheduleAttributes	This class represents attributes of a Schedule.
ScheduleTask	This class represents a task in a Schedule.
Script	This class represents a SCRI object.
ScriptAttributes	Attributes of SCRI objects.
SecureSQLVariable	Dynamic Database Variable Secure.
SecureSQLVariableIntern	Secure SQL Variables.
Server	This class represents Server objects (type SERV).
ServerAttributes	This class represents the "Attributes" tab of server objects.
ServiceLevelObjective	This class represents SLO objects.
SetValueAction	Sets or creates an object value which will be available for restarts.
SetVariableAction	Sets the content of a static variable.
SkipTaskAction	Skips the task (as 'else skip' in V8 or lower) without checking of further conditions..
SloFulfillment	Represents the fulfillment sheet of SLO objects.
SloSelection	Selection criteria of SLO objects.
SloSelection.Beneficiary	Beneficiary of a service.
StaticCalendarKeyword	This class represents a static calendar keyword.
StatusCondition	Checks the 'ENDED' status of the task.
StepListItem	Item in a Step List for OS/390 Jobs.
Storage	This class represents a STORE Object.
Stylesheet	This class represents Stylesheet objects.
Sync	Sync object.
SyncAction	This class represents an action of an Sync object.
SyncAttributes	This class represents the attributes of Sync objects.
SyncItem	This class represents a single row of the sync tab.
SyncList	This class represents the SYNC tab of an executable object.
SyncState	This class represents the state of a Sync object.
TaskCalendar	Task calendar conditions.
TaskResult	With the TaskResult you can define a reaction to the end status of a task.
TaskRuntime	Task runtime.
TaskState	Task states.
TaskValues	This class represents task values and PromptSets.
TextDocumentation	This class represents a documentation tab of type "text".
TimeEvent	Time Event.
TimeSinceActivationCondition	Checks time that has passed since the activation of the task.
TimeZone	Represents a TimeZone object.
TimeZoneAttributes	Represents the attributes tab of a TimeZone object.
TimeZoneAttributes.TimeChangeRule	Defines the point in time for a time change.
UC4Object	This is the base class of all the Automation Engine objects.
User	This class represents a USER Object in the Automation Engine.
UserAssignment	This class enables the assignment of single users to this User Group.
UserAttributes	This class stores user attributes like first name, last name and email address.
UserAuthorizations	This class serves to define access rights for objects, files, statistics and reports.
UserDefinedCondition	Compares two values.
UserGroup	This class represents a User Group in the Automation Engine.
UserGroupAssignment	This class enables the assignment of single users to user groups.
UserPrivileges	This class represents the privileges of a user.
UserRight	This class represents a row on the authorizations tab of an USER object.
ValidityKeywordType	This class represents the scope of a variable.
Variable	This class represents UC4 Variable objects.
VariableAttributes	This class represents variable attributes.
VariableValues	This class represents the "Variables" tab of a STATIC and XML VARA object.
WeeklyCalendarKeyword	This class represents a weekly calendar keyword.
WorkflowIF	This class represents an IF in a ProcessFlow.
WorkflowLoop	This class represents Workflow of type FOREACH.
XHeader	This class represents information of the header tab of an executable Automation Engine object and SYNC.
XMLDocumentation	This class represents a structured documenation.
XMLDocuNode	This class represents one node in the structured documentation.
XRequest	XREQ Object : Each X-request has an according X-request object XREQ available in the the AE database that specifies how a request is processed.
YearlyCalendarKeyword	This class represents a yearly Calendar Keyword.

Enum Summary

Enum	Description
CancelProcessFlowAction.Scope	Scope.
CheckProcessCondition.ProcessStatus	Process status.
CockpitValueControl.ValueFormat	Format of the 2nd caption of the CockpitControl.
CompositeVariable.Operation	Operation.
CurrentTimeCondition.When	When operator.
DatabaseConnection.DatabaseType	Type of the database.
DeactivateCondition.Type	Type of the deactivate condition.
ErtUsage	The Enum represent ERT usage value for a Variables.
ExtendedReports	Extended Reports.
NotificationSettings.ReportSource	Report source.
OutputFilter.Operator	Operator.
OutputScan.Inherit	Inherit setting.
ProcessFlowGeneral.DeploymentDependency	DeploymentDependency.
PromptSetDefinition.PromptElementTable	Enum for all the various tables where prompt values can be stored
RollbackAction.Task	Task.
SAPConnection.ConnectionTyp	Type of the connection object.
SAPConnectionRFC.BIExtendedMonitoring	SAP BW Extended Monitoring.
SAPConnectionRFC.XALVersion	XAL version.
SAPConnectionRFC.XBPVersion	XBP version.
SetValueAction.Scope	Scope.
TimeSinceActivationCondition.TimeOperator	Operator.
UserPrivileges.Privilege	Enumeration of all Privileges.
UserRight.Type	User rights.
VariableAttributes.Source	Variable source.

Exception Summary

Exception	Description
CyclicException	A CyclicException is thrown if a JobPlan contains cycles.

Package com.uc4.api.objects Description

This package contains classes related to objects in the Automation Engine.