Package com.uc4.communication.requests

This package contains request classes that can be sent using the Connection class.

See: Description

Class Summary

Class	Description
ActivateLDAPConnection	Activates the LDAP connection of a user.
ActivateObject	Sets an object active or inactive.
ActivatorStatistics	Reads the activator statistics of a specified RunID.
ActiveNotifications	Returns a list of active notifications.
ActiveNotifications.Entry	This class represents a row in the table of active notifications.
ActivityList	Returns a list of tasks according to the TaskFilter.
ActivityNotificationOn	Enables activity Kicks.
AddComment	Adds a comment to a task.
AddJobPlanTask	Returns a JobPlan Task.
AddPromptSet	Returns a PromptSet definition.
AddScheduleMonitorTask	Adds a task to a started schedule via its monitor.
AddScheduleTask	Reads a task description.
AdoptTask	Taskes over a task in the activity window.
AgentAndGroupList	Retrieves a list of agents and agentgroups in the current client matching the specified filter.
AgentAndGroupList.AgentAndGroupListFilter	Cut the result of the list by using this filter.
AgentAndGroupList.AgentOrGroupListItem	Represents an agent or an agentgroup in the list.
AgentAssignmentList	List of Agent Assignments in the system overview.
AgentGroupList	Get a list of host groups.
AgentGroupMonitor	Reads monitor of an Agent Group.
AgentGroupSimulation	Simulation view of an AgentGroup.
AgentList	Gets a list of Agents.
AgentList.Filter	Filter in the Agent list.
AuthenticateAgent	This request represents the menu item "Authenticate Agent" in the system overview of client zero.
AutoForecastRange	Returns the date/time range for which the Auto Forecast has been calculated.
CacheList	Cache list.
CalculateForecast	Creates a new Forecast.
CalendarList	Lists CALE object names or keywords of a specified calendar.
CalendarList.CalendarListItem	Stores the name of a calendar/keyword its unique id.
CancelForm	Cancels a pending Read Request.
CancelTask	Cancels a task.
CauDeploy	Upgrades agents to a specific version via Central Agent Upgrade (CAU) functionality.
CauSkipWaiting	Host that are registered for CAU can be skipped with this class.
ChangeLogging	Change Server or Agent/AgentGroup logging.
ChangePassword	Changes the password of the currently logged on user.
ChangeServerMode	Switches a Server processes between WP, Dialog and Primary.
CheckAuthorizations	Checks object or execution authorizations of the currently logged on UC4 user.
CheckAuthorizations.Candidate	This class represents a candidate to test.
CheckILMPartition	Checks whether the specified partition includes active objects.
CheckUserPrivileges	Checks privileges of users.
CheckUserPrivileges.Candidate	Stores the name of the user, a privilege to check and the result of the check after the request has been sent.
ChildStatistics	Reads the child statistics of a specified RunID.
ClearTransportCase	Removes all objects from the transport folder.
ClientList	Client list of the system overview.
CloseObject	Closes an open UC4 Objekt.
CloseProcessFlowModification	Commits or resets the changes of a ProcessFlow monitor which is open for modification.
ClosePrompt	Close a prompt window.
CockpitMonitorDefiniton	Gets the design of the Cockpit monitor.
ConfirmQuarantineMessage	Flags a quarantine message as noted.
CreateObject	Creates a new UC4 Object.
CreateSession	Login to UC4.
DeactivateLDAPConnection	Deactivates the LDAP connection of a user.
DeactivateTask	Deactivates a task in the UC4 Activity window.
DeepRename	Rename an object including all objects in the same folder and below.
DeleteAgentAssignment	This class is used to delete the AgentAssignment from the SystemOverview in Client Zero.
DeleteForecast	Deletes an existing Forecast.
DeleteLink	Deletes links of UC4 object(s).
DeleteMQMemList	Request to delete one or more entries in the MQMEM table.
DeleteObject	Deletes an UC4 object.
DeleteQuarantineMessage	Removes a message from the quarantine list of the system overview.
DeleteStaticVaraRow	Deletet a list of variable rows, specified by their keys.
DeleteStorageEntry	DeleteStorageEntry is used to delete the resource item in the storage Storage object.
DisconnectAgentGroup	Disconnects all Agents in the specified AgentGroup.
DisconnectHost	Disconnects the specified Agent.
DisconnectUser	Disconnects a user.
DownloadBinary	Downloads a file from a STORE object.
DropILMPartition	Deletes the specified ILM partition.
DuplicateObject	Duplicates an UC4 Object.
EnforcePreConditionEvaluation	Enforeces the evaluation of Pre-Conditions.
ExecuteAgentAssignment	Executes an Agent Assignment (HSTA).
ExecuteObject	Executes an UC4 Object.
ExecuteObjects	Executes list of UC4Objects and returns the corresponding response list
ExitList	List of password exits.
ExportAuthenticationPackage	Export authentication package of an agent.
ExportCompanyKey	Exports the company key.
ExportObject	Exports an UC4 Object.
ExportWithReferences	Exports an object and all its referenced objects.
FindReferencedObjects	Returns a list of objects that are used within an executable object.
FolderList	Lists the content of a folder.
FolderTree	Returns the folder structure of the UC4 client.
ForceMemoryTrace
ForecastList	Returns the Forecast list of the current client.
ForecastTree	Returns the Tree Structure of the specified ForecastItem.
GenericStatistics	Generic Statistics search.
GetActivitiesFilter	Returns a list of objects types which can be used to filter tasks.
GetAgentGroupMonitorProperties	This class is used to get AgentGroup options of a RunID.
GetAgentGroupProperties	Returns the properties of an Agent Group.
GetAgentProperties	Returns the properties of an Agent.
GetCAUAgentVersions	Returns an ordered list of available CAU versions for an agent platform, starting with the latest version.
GetChangeLog	Returns a list of recent changes in the current client.
GetChangeLog.Entry	Represents a row in the result of the change list.
GetComments	Returns the comments of a task.
GetComments.Comment	This class represents a single comment from one user.
GetComponentTemplates	Creates a list of objects which are templates for Component Workflows of a specific component type.
GetComponentWorkflows	Creates a list of existing Component Workflows for a specific application or all applications.
GetCPProperties	Returns the trace options for a Communication Process using existing XREQ
GetDatabaseInfo	Reads information about the UC4 Database.
GetDatabaseInfo.MQEntry	This class stores information about a message queue table.
GetDeploymentProperties	read the deployment properties (Deployment Tab) after the task was activated (EH).
GetDeployObjectProperties	Returns the name of an Application Release Automation ProcessFlow based on the Application and Workflow name.
GetDynamicComboList	Returns a list of elements for a combo element, radio list or checklist in a PromptSet.
GetExecuteOnce	Reads the settings of a task that is or will be started with "Execute - Once..."
GetExecutePeriod	Reads Properties of a periodical Task.
GetGroupMonitorProperties	This class is used to get Group options of a RunID.
GetLastRuntimes	Returns real runtimes (RRT) and estimated runtimes (ERT) of the last 25 runs of an activatable object.
GetModifyQueue	Class to fetch the modify queue data for a particular Queue.
GetObjectDocu	Provides read only access to the documentation of an UC4 object.
GetObjectProperties	Returns information about an UC4 object.
GetOutputDirectory	Returns a list of reports (external and in UC4 DB) of a Job.
GetOutputDirectory.OutputDirectoryItem	This class represents a single row in the Output directory.
GetQuarantineMessage	Gets quarantine message trace options.
GetRAAgentNames	Returns a list of RA Agent names.
GetRAConnectionNames	Used to return the names of connection objects.
GetRAConnectionValues	Returns the content of an CONN object.
GetRAJobNames	Returns names of RA Jobs.
GetReplaceList	Returns list of UC4 Objects in which the specified UC4 Object is used.
GetReplaceList.ReplaceListItem	Represents an item in the replace list.
GetRestartInformation	Returns restart information of the specified task.
GetRestEndpoints	Requests all available REST endpoints of a running AE.
GetRestEndpoints.RestEndpoint	Represents one REST endpoint which consists of a URL.
GetSessionTZ	Request that gets the used TimeZone of the Session.
GetStaticVaraRows	Returns a list of rows according to the specified key-filters supplied by the constructor.
GetStorageItems	Lists all resources from a storage object.
GetSyncMonitor	This request can be used to read the current state and value of a SYNC object.
GetSyncUsage	Returns a list of SYNC Object names that are currently used.
GetUnreadMessages	Returns a list of unread messages.
GetWPProperties	Returns the trace options for a Work Process using existing XREQ
GroupMonitor	Reads a Group monitor.
GroupMonitor.Task	This class represents a task in the Group monitor.
IgnoreAgentResources	Ignores Agent Resources
IgnoreConditions	Ignores a Pre-Condition.
IgnoreQueueLimit	Ignores the Queue Limit.
IgnoreTaskSyncCondition	Ignores the sync condition of Job.
ILMList	Represents the ILM menu item in the system overview.
ImportObject	Imports UC4 Objects.
JobPlanMonitor	Reads a JobPlan Monitor.
JobPlanMonitor.JobPlanMonitorExternal	Deprecated Do not use it.
JobPlanMonitor.JobPlanMonitorRuntime	Deprecated Do not use it.
JobPlanMonitor.Task	Task in the ProcessFlow monitor.
JWPRequest	Base class of all requests that are sent to a JWP.
LatestReport	Returns the latest RunID for the specified UC4 Object name or UC4 Object Id.
LicenseList	Deprecated the license check has been removed in version 12.2 and higher
LinkTo	Creates a link to an UC4 object.
MessageList	Find messages in the Automation Engine.
ModifyNotificationMonitor	This class can be used to modify the monitor of a notification (Accept, Reject, Done, Yes, No, Ok).
ModifyProcessFlowMonitor	Adds a task or changes an existing task in a ProcessFlow monitor which is opened for modification.
ModifyQueue	Modifies a queue.
ModifyQueueStatus	Sets the status of a Queue to Stop or Go.
ModifyRecurringTask	Modifies a recurring task.
ModifyStartTime	Modifies the start time of a task was executed once and is waiting for its start time.
ModifyTaskPriority	Modifies the UC4 priority of task.
ModifyTaskState	Modifies an UC4 Object state manually.
ModifyUISettings	Saves User Interface settings of the current logged on user.
MoveAgentAssignment	This class is used to move the AgentAssignment from the active to inactive list.
MoveObject	Moves objects.
MoveUserToClient	Moves a user from client 0 to another client.
MQMemList	Class for a list of MQMEM entries
NavigatorAgentTree	Represents the agent tree in the activity window navigator.
NavigatorAgentTree.AgentLeaf	Represents a leaf in the NavigatorAgentTree.
NavigatorAgentTree.AgentNode	Represents a node in the NavigatorAgentTree.
NavigatorCATree	Represents the Custom Attributes tree in the activity window navigator.
NavigatorCATree.CustomAttributeLeaf	Represents a leaf in the NavigatorCATree.
NavigatorCATree.CustomAttributeNode	Represents a node in the NavigationCATree.
NavigatorQueueTree	Represents the queue tree in the activity window navigator.
NavigatorQueueTree.QueueLeaf	Represents a leaf in the NavigatorQueueTree.
NavigatorQueueTree.QueueNode	Represents a node in the NavigatorQueueTree.
NavigatorStatusTree	Represents the status tree in the activity window navigator.
NavigatorZDUTree	Returns the Zero Downtime Upgrade tree.
NavigatorZDUTree.ZDUNode	Represents a node in the NavigationZDUTree.
NotificationMonitor	Reads the monitor of a notification.
NotificationMonitor.CallStatus	This inner class represents a row in the calling status table of this notification monitor.
NotificationState	Finds the highest Notification priority for current user.
ObjectStatistics	Reads the statistics of a single UC4 object.
OpenObject	Opens an existing UC4 Object.
OpenProcessFlowModification	Sets the modification mode of a ProcessFlow.
ParentStatistics	Reads the parent statistics of a specified RunID.
PreviewAssignment	Preview of an AgentAssignment AgentAssignment.
PreviewVariable	Preview of an SQL and Backend Variables.
PromptInputHelp	Returns a table with values for input help in PromptElements.
QuarantineList	List of invalid messages which caused a failure in the server process.
QueryAutoforecast	Queries the Autoforecast.
QueryData	Returns exactly one table based on query parameters.
QueryData.Row	This class represents a row in the returned result set.
QueueList	Returns the list of Queue.
QuickSearch	Gets a list of object names which contain a defined pattern.
QuitTask	Quits an active task.
RecalculateAutoForecast	Starts a recalculation of the Auto Forecast for the current client.
RefreshCockpitMonitor	Refreshes the values of the Cockpit monitor.
RefreshServiceManagerScan	Refreshes the Service Manager Scan for the specified Agent.
ReleaseManually	Releases a task manually.
ReleaseQuarantineMessage	Releases a quarantine message.
ReloadNextTurnaround	Register a Schedule for reloading from definition at period turnaround.
RemoteRestart	Restarts a remote Task (type JOBD).
RemoveJobPlanBreakPoint	Removes a Breakpoint in a JobPlan.
RenameForecast	Renames an existing forecast.
RenameObject	Renames an existing UC4 Object.
RenewTransferKey	Renew transfer key or withdraw the authentication of an Agent.
ReplaceObject	Replaces UC4 objects.
Report	Gets a page of a report.
ReportTypeList	Gets a list of report types for a specified RunID.
RerunWorkflow	Rerun a rollbacked task.
ResetLastRuntimes	Resets real runtimes (RRT) and estimated runtimes (ERT) of an activatable object.
ResetOpenFlag	Resets the Reservation of an UC4 Object.
ResetScheduleTask	This class represents the menu item "Reset task" in the schedule monitor.
RestartTask	Restarts a task.
RestoreObject	Restores deleted UC4 Object.
RestoreObjectVersion	Restores an Object from Version Management.
ResumeClient	Starts the automatic processing for the current client.
ResumeTask	Sets stopped tasks active again.
RollbackTask	Rollback the entire task.
RollbackTo	Rollback to a specific task.
RunJobPlanTask	Executes a task in a JobPlan immediately.
RunScheduledTask	Runs a task which is waiting for its start time.
SaveAgentAssignment	Used to modify the Agent assignments.
SaveObject	Saves an open UC4 Object.
ScheduleMonitor	Reads a Schedule monitor.
ScheduleMonitor.Task	This class represents a task in the Schedule monitor.
SearchIndex	This class can be used to find objects based on name or title.
SearchIndex.Result	This class represents one result of a index based search.
SearchObject	Finds UC4 Objects.
ServerList	Reads a list of UC4 Servers independent of their states (running or not running).
ServiceFulfillmentList	Reads the list of service fulfillments.
ServiceFulfillmentList.Filter	Filter in the service fulfillments list.
ServiceLevelObjectiveList	Reads the list of service level objectives.
ServiceLevelObjectiveList.Filter	Filter in the service level objective list.
SetAgentGroupMonitorProperties	This class is used to change settings in the AgentGroup monitor.
SetAgentGroupProperties	Sets properties of agent group
SetAgentProperties
SetCPProperties	Sets the trace options for a Communication Process using existing XREQ
SetGroupMonitorProperties	This class is used to change settings in the Group monitor.
SetHostAuthorizations	Sets the authorizations of one or many hosts in one request.
SetHostAuthorizations.ModificationStatus	This class stores the modification status of a single HOST object.
SetJobPlanBreakPoint	Sets a breakpoint in a JobPlan.
SetJobPlanTaskActive	Sets a skipped task in the JobPlan active again.
SetJobPlanTaskInactive	Skips a task in an active JobPlan which is not yet executed.
SetObjectProperties	Sets Object Authentication for an UC4 object.
SetStaticVaraRows	Modify a list of variable rows, specified by their keys.
SetSyncMonitor	Sets the value and state of a SYNC object.
SetWPProperties	Sets the trace options for a Work Process using existing XREQ
SetZDUStep
ShowQuarantineMessage	Shows a quarantine message.
StartHost	Starts a host which is linked to the Service Manager.
StartILM	Activates ILM.
StartServer	Starts a Server Process (CP or WP).
StopILM	Deactivates ILM.
SubmitForm	Sends the content of a Read form to the server.
SubmitPrompt	Submits a list of PromptSet values to continue with the execution of an UC4 Object.
SuspendClient	Stops the automatic processing for the current client.
SuspendTask	Stops an active task.
SwitchOutILM	Switches out an ILM partition.
SynchronizeLDAP	This request synchronizes the data of an UC4 User with LDAP.
SystemWorkload	Gets the Server workload.
TaskDetails	Gets the details of task in the activity window or statistic.
TaskList	Returns a list of a tasks based on a filter.
TaskPromptSetContent	This request reads the content of a PromptSet (List of PromptElements) for a specified task.
TaskPromptSetNames	This request reads a list of Prompt Set Objects of a specified task.
TaskStatistics	Reads the statistics of a single task.
TemplateList	Returns a list of templates for UC4 Objects.
TerminateAgentGroup	Terminates all Agents in an AgentGroup.
TerminateHost	Terminates a running Agent.
TerminateServer	Terminates a server process.
TransportObject	Places UC4 Objects into the transport folder.
UnblockJobPlanTask	Releases a blocked task in a JobPlan.
UnblockWorkflow	This request represents the menu item "Unblock Workflow" in the user interface.
UnlockAutoForecast	Unlock existing Auto Forecast recalculation processing.
UnregisterTask	Unregisters a Job which is waiting for a Group.
UploadBinary	Adds or replaces a file in a STORE object.
UserList	Lists all users in a client.
VersionControlList	Gets a list of saved versions.
XMLRequest	This is the super class of all request classes.
ZDUControl	Triggers a prompt for the zero downtime upgrade.
ZduStep	Gets the current ZDU step
ZduWizard	Performs an action in the Zero Downtime Wizard.

Enum Summary

Enum	Description
ActivityList.GroupingType	Grouping criteria for the activity window.
DeepRename.AbortIfNameExistsMode	AbortIfNameExistsMode.
DeepRename.IncludeFolderNamesMode	ChangeFolderNameMode.
MessageList.Category	Category of the message.
MessageList.MessageType	Type of the message.
MessageList.Order	Sort order.
ModifyNotificationMonitor.Action	Action in a notification monitor.
NotificationMonitor.Type	Notification type.
RestartTask.FileTransferRestart	Restart setting of FileTransfers.
SearchObject.VariableDataType	Type of a Variable.
TaskList.DateRange	Type of the time frame in a combined task selection.
UploadBinary.ContentType	Content-type of the file (BINARY, TEXT,...).
ZduWizard.Action	Represents all possible ZDU actions.

Package com.uc4.communication.requests Description

This package contains request classes that can be sent using the Connection class. Requests can be sent synchronous by using the method Connection#sendRequestAndWait. All requests except the creation of FOLD objects can also be sent asynchronous by using the method Connection#sendRequest.