Uses of Class
com.uc4.communication.requests.XMLRequest

Packages that use XMLRequest

Package	Description
com.uc4.communication	This package contains classes for the communication with the UC4 Server.
com.uc4.communication.requests	This package contains request classes that can be sent using the Connection class.

Uses of XMLRequest in com.uc4.communication

Subclasses of XMLRequest in com.uc4.communication

Modifier and Type	Class and Description
class	CreateFolder Creates objects like die Dialog Client

Methods in com.uc4.communication with parameters of type XMLRequest

Modifier and Type	Method and Description
String	Connection.sendRequest(XMLRequest sendableMessage, IResponseHandler handler) Sends an message to the UC4 Server.
String	AEConnection.sendRequest(XMLRequest sendableMessage, IResponseHandler handler) Sends an message to the UC4 Server.
void	AEConnectionPool.sendRequestAndWait(ConnectProperties connectInfo, XMLRequest req) Sends a request to the Automation Engine.
void	AEConnectionPool.sendRequestAndWait(ConnectProperties connectInfo, XMLRequest req, Properties options) Sends a request to the Automation Engine.
void	Connection.sendRequestAndWait(XMLRequest sendableMessage) Sends a message to the UC4 Server and waits for the response.
void	AEConnection.sendRequestAndWait(XMLRequest sendableMessage) Sends a message to the UC4 Server and waits for the response.

Uses of XMLRequest in com.uc4.communication.requests

Subclasses of XMLRequest in com.uc4.communication.requests

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