Management Service More...

Public Member Functions
ServiceProfileIdentity	AddCoreWorkerServiceProfile (string sessionId, CoreWorkerServiceProfile profile)
	Adds a core worker service profile More...

ServiceProfileIdentity	AddExportServiceProfile (string sessionId, ExportServiceProfile profile)
	Adds Export Service Profile. More...

ServiceProfileIdentity	AddTransServerServiceProfile (string sessionId, TransServerServiceProfile profile)
	Adds Transformation Server Service Profile. More...

void	DeleteServiceProfile (string sessionId, ServiceProfileIdentity identity)
	Deletes Service profile More...

CoreWorkerServiceProfile	GetCoreWorkerServiceProfile (string sessionId, ServiceProfileIdentity identity)
	Gets a CoreWorker service profile More...

ExportServiceProfile	GetExportServiceProfile (string sessionId, ServiceProfileIdentity identity)
	Gets a Export Service Profile More...

MachineCoreWorkerServiceProfile	GetMachineCoreWorkerServiceProfile (string sessionId, string machineName)
	Gets Machine Core Worker Service Profile More...

MachineExportServiceProfile	GetMachineExportServiceProfile (string sessionId, string machineName)
	Gets Machine export Service Profile More...

MachineServiceProfileCollection	GetMachineServiceProfiles (string sessionId, MachineServiceProfileFilter filter)
	Retrieves the list of available machine service profiles using the filter specified. More...

MachineTransServerServiceProfile	GetMachineTransServerServiceProfile (string sessionId, string machineName)
	Gets Machine Trans server Service Profile More...

int	GetServiceProfileRefreshInterval (string sessionId)
	Gets Service Profile Refresh Interval in seconds. More...

ServiceProfileSummaryCollection	GetServiceProfiles (string sessionId, ServiceProfileFilter filter)
	Retrieves the list of available service profiles using the filter specified. More...

TransServerServiceProfile	GetTransServerServiceProfile (string sessionId, ServiceProfileIdentity identity)
	Gets Transformation Server Service Profile. More...

long	GetWorkerTaskHistoryRetention (string sessionId, short workerTaskType)
	Gets worker task history retention period in seconds for specified worker task type. 0 is returned if worker task type is not specified to record history. More...

WorkerTaskDetailsCollection	GetWorkerTasks (string sessionId, WorkerTasksFilter filter)
	Gets worker tasks based on specified filter. If a system worker task type is specified in the filter, it returns the non system worker tasks created/performed by the specified system worker task More...

WorkerTaskStats	GetWorkerTaskStats (string sessionId, WorkerTaskStatsFilter filter)
	Gets worker task statistics (count, min value, max value, average value) based on specified filter. If a system worker task type is specified in the filter, it returns the stats of the non system worker tasks created/performed by the specified system worker task More...

void	SaveMachineServiceProfiles (string sessionId, MachineServiceProfileCollection profiles)
	Save machine service profiles More...

void	UpdateCoreWorkerServiceProfile (string sessionId, CoreWorkerServiceProfile profile)
	Updates core worker service profile More...

void	UpdateExportServiceProfile (string sessionId, ExportServiceProfile profile)
	Updates Export Service Profile. More...

void	UpdateServiceProfileRefreshInterval (string sessionId, int serviceProfileRefreshInSeconds)
	Updates Service Profile Refresh interval in seconds More...

void	UpdateTransServerServiceProfile (string sessionId, TransServerServiceProfile profile)
	Updates Transformation Service Profile. More...

void	UpdateWorkerTaskHistoryRetention (string sessionId, short workerTaskType, long retentionPeriodInSeconds)
	Saves worker task history retention period in seconds for specified worker task type. If 0 is passed as retention period then the existing worker task type does not record history More...

Description

Management Service

Member Functions

ServiceProfileIdentity AddCoreWorkerServiceProfile	(	string	sessionId,
		CoreWorkerServiceProfile	profile
	)

Adds a core worker service profile

Parameters

sessionId	A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
profile	A CoreWorkerServiceProfile object which holds the core worker profile details to be added

Name	Type	Comment	Required
Identity	ServiceProfileIdentity	The unique identity of the service profile.	Yes
CustomJobThreadPools	JobThreadPoolConfig	Gets or sets the job threadpool configuration.	No
CoreWorkerIntervalInSeconds	int	Indicates how often the system should check the in-memory worker task if they are due.	No
CoreWorkerDBIntervalInSeconds	int	Indicdates how often the system should poll for a due db worker task.	No
CoreWorkerResetTaskIntervalInSeconds	int	Indicates how often the system checks for timed-out worker tasks.	No
CoreWorkerResetActivityIntervalInSeconds	int	Indicates how often the core worker checks for timed-out activities.	No
CoreWorkerActivityTimeoutIntervalInMinutes	int	Defines the duration after which an activity becomes timed out. When an activity times out, when the corresponding task executes, the activity will be freed up.	No
MaximumNumberOfMessagesToImport	int	Defines the maximum number of documents/messages to import for Document Ingest.	No
CoreWorkerWorkQueueSize	int	Indicates the workqueue size of the core worker service.	No
MaximumNumberOfEvaluateJobTasksToTake	int	Indicates the maximum number of the evaluate job tasks to take.	No
CoreWorkerActivityOrder	int	Indicates the activity order of the core worker.	No
MaximumNumberOfActivitiesToLock	int	Indicates how many automatic activities to lock, when the core worker polls for automatic activities to execute.	No
ImportConnectorName	string	This property allows admins to explicitly specify which import connection the CoreWorker should use, by default it uses all. This setting is useful when one has multiple CoreWorkers setup.	No
CoreWorkerThreadPoolMonitoringIntervalInSeconds	int	Defines how often a thread pool should monitor the threads in it.	No
ArchiveDeleteWorkerTasksToRetrieve	int	Indicates number of ArchiveJob and DeleteItem non-system level worker tasks to be retrieve for execution.	No
ArchiveDeleteRetryIntervalInSeconds	int	Indicates maximum duration in seconds to calculate next duedate to execute ArchiveJob and DeleteItem non-system worker tasks.	No
AutoActivitiesPoolName	string	Gets or sets the auto activities pool name.	No
AutoActivitiesPoolId	short	Gets or sets the auto activities pool id.	No
UpgradeJobsThreadPoolSize	short	Gets or sets the value of upgrade jobs threadpool size.	No

Returns

ServiceProfileIdentityThe unique identity of the service profile.

Name	Type	Comment	Required
Id	string	Id of the service profile.	Id will be autogenerated if not specified.
Name	string	Name of the service profile.	Yes.

Security: Resource must have atleast read write access permission on server ACL.

ServiceProfileIdentity AddExportServiceProfile	(	string	sessionId,
		ExportServiceProfile	profile
	)

Adds Export Service Profile.

Parameters

sessionId	A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
profile	A ExportServiceProfile object which holds the export service profile details to be added

Name	Type	Comment	Required
Identity	ServiceProfileIdentity	The unique identity of the service profile.	Yes
CoreWorkerActivityOrder	int	Indicates the activity order of the core worker.	No
CoreWorkerResetActivityIntervalInSeconds	int	Indicates how often the core worker checks for timed-out activities.	No
CoreWorkerActivityTimeoutIntervalInMinutes	int	Defines the duration after which an activity becomes timed out. When an activity times out, when the corresponding task executes, the activity will be freed up.	No

Returns

ServiceProfileIdentityThe unique identity of the service profile.

Name	Type	Comment	Required
Id	string	Id of the service profile.	Id will be autogenerated if not specified..
Name	string	Name of the service profile.	Yes.

Security: Resource must have atleast read write access permission on server ACL

ServiceProfileIdentity AddTransServerServiceProfile	(	string	sessionId,
		TransServerServiceProfile	profile
	)

Adds Transformation Server Service Profile.

Parameters

sessionId	A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
profile	A TransServerServiceProfile object which holds the export service profile details to be added

Name	Type	Comment	Required
Identity	ServiceProfileIdentity	The unique identity of the service profile.	Yes
PoolName	string	The pool name.	No
MaxProcessingSlotsNumber	int	Number of maximum processing slots.	No
TransformationServerActivityOrder	short	Transformation server activity order.	No
ResetActivitiesIntervalMinutes	int	Indicates how often the transformation service checks for timed-out activities.	No
OnlineLearningExecutionEnabled	bool	Indicates whether to enable online learning execution or not.	No
EnableSynchronousCalls	bool	Indicates whether to enable synchronous calls or not.	No

Returns

ServiceProfileIdentityThe unique identity of the service profile.

Name	Type	Comment	Required
Id	string	Id of the service profile.	Id will be autogenerated if not specified..
Name	string	Name of the service profile.	Yes.

Security: Resource must have atleast read write access permission on server ACL

void DeleteServiceProfile	(	string	sessionId,
		ServiceProfileIdentity	identity
	)

Deletes Service profile

Parameters

sessionId	A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
identity	ServiceProfileIdentityThe unique identity of the service profile.

Name	Type	Comment	Required
Id	string	Id of the service profile.	Yes, if Name is not specified.
Name	string	Name of the service profile.	Yes, if Id is not specified.

Security: Resource must have atleast read write access permission on server ACL

CoreWorkerServiceProfile GetCoreWorkerServiceProfile	(	string	sessionId,
		ServiceProfileIdentity	identity
	)

Gets a CoreWorker service profile

Parameters

sessionId	A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
identity	ServiceProfileIdentityThe unique identity of the service profile.

Name	Type	Comment	Required
Id	string	Id of the service profile.	Yes, if Name is not specified.
Name	string	Name of the service profile.	Yes, if Id is not specified.

Returns

A CoreWorkerServiceProfile object which holds the core worker profile details to be added

Name	Type	Comment	Required
Identity	ServiceProfileIdentity	The unique identity of the service profile.	Yes
CustomJobThreadPools	JobThreadPoolConfig	Gets or sets the job threadpool configuration.	No
AutoActivityThreadPools	ThreadPoolCollection	Gets or sets the auto activity thread pools collection.	No
CoreWorkerIntervalInSeconds	int	Indicates how often the system should check the in-memory worker task if they are due.	No
CoreWorkerDBIntervalInSeconds	int	Indicdates how often the system should poll for a due db worker task.	No
CoreWorkerResetTaskIntervalInSeconds	int	Indicates how often the system checks for timed-out worker tasks.	No
CoreWorkerResetActivityIntervalInSeconds	int	Indicates how often the core worker checks for timed-out activities.	No
CoreWorkerActivityTimeoutIntervalInMinutes	int	Defines the duration after which an activity becomes timed out. When an activity times out, when the corresponding task executes, the activity will be freed up.	No
MaximumNumberOfMessagesToImport	int	Defines the maximum number of documents/messages to import for Document Ingest.	No
CoreWorkerWorkQueueSize	int	Indicates the workqueue size of the core worker service.	No
MaximumNumberOfEvaluateJobTasksToTake	int	Indicates the maximum number of the evaluate job tasks to take.	No
CoreWorkerActivityOrder	int	Indicates the activity order of the core worker	No
MaximumNumberOfActivitiesToLock	int	Indicates how many automatic activities to lock, when the core worker polls for automatic activities to execute.	No
ImportConnectorName	string	This property allows admins to explicitly specify which import connection the CoreWorker should use, by default it uses all. This setting is useful when one has multiple CoreWorkers setup.	No
CoreWorkerThreadPoolMonitoringIntervalInSeconds	int	Defines how often a thread pool should monitor the threads in it.	No
ArchiveDeleteWorkerTasksToRetrieve	int	Indicates number of ArchiveJob and DeleteItem non-system level worker tasks to be retrieve for execution.	No
ArchiveDeleteRetryIntervalInSeconds	int	Indicates maximum duration in seconds to calculate next duedate to execute ArchiveJob and DeleteItem non-system worker tasks.	No
AutoActivitiesPoolName	string	Gets or sets the auto activities pool name.	No
AutoActivitiesPoolId	short	Gets or sets the auto activities pool id.	No
UpgradeJobsThreadPoolSize	short	Gets or sets the value of upgrade jobs threadpool size.	No

Security: Resource must have atleast read access permission on server ACL

ExportServiceProfile GetExportServiceProfile	(	string	sessionId,
		ServiceProfileIdentity	identity
	)

Gets a Export Service Profile

Parameters

sessionId	A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
identity	ServiceProfileIdentityThe unique identity of the service profile.

Name	Type	Comment	Required
Id	string	Id of the service profile.	Yes, if Name is not specified.
Name	string	Name of the service profile.	Yes, if Id is not specified.

Returns

A ExportServiceProfile object which holds the export service profile details.

Name	Type	Comment	Required
Identity	ServiceProfileIdentity	The unique identity of the service profile.	Yes
CoreWorkerActivityOrder	int	Indicates the activity order of the core worker.	No
CoreWorkerResetActivityIntervalInSeconds	int	Indicates how often the core worker checks for timed-out activities.	No
CoreWorkerActivityTimeoutIntervalInMinutes	int	Defines the duration after which an activity becomes timed out. When an activity times out, when the corresponding task executes, the activity will be freed up.	No

Security: Resource must have atleast read access permission on server ACL

MachineCoreWorkerServiceProfile GetMachineCoreWorkerServiceProfile	(	string	sessionId,
		string	machineName
	)

Gets Machine Core Worker Service Profile

Parameters

sessionId	The session id
machineName	machineName

Returns: Machine Core Worker Service Profile

MachineExportServiceProfile GetMachineExportServiceProfile	(	string	sessionId,
		string	machineName
	)

Gets Machine export Service Profile

Parameters

sessionId	The session id
machineName	machineName

Returns: Machine Export Service Profile

MachineServiceProfileCollection GetMachineServiceProfiles	(	string	sessionId,
		MachineServiceProfileFilter	filter
	)

Retrieves the list of available machine service profiles using the filter specified.

Parameters

sessionId	A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
filter	A MachineServiceProfileFilterThe filter object containing the search criteria to retrieve the machine service profiles.

Name	Type	Comment	Required
ServiceType	short	The service type. See Remarks section of this API to get more information.	No
MachineId	int16	The machine id.	No

Returns

A collection of MachineServiceProfileCollection MachineServiceProfile members that has the details of the machine service profiles that match the search criteria.

Name	Type	Comment
Identity	ServiceProfileIdentity	The unique identity of the service profile
MachineId	int16	The machine id
MachineName	string	The machine name
ServiceType	ServiceType	The service type. See Remarks section of this API to get more information.

Remarks

Returns all machine service profiles when MachineId and ServiceType both not specified. The supported service types and their corresponding numerical values are as follows:

Enumeration	Description	Comment
0	All	If service type is 0 then return all machine service profiles.
1	CoreWorkerServiceProfile	Returns the core worker service profile.
2	ExportServiceProfile	Returns the export service profile.
3	TransServerServiceProfile	Returns the trans server service profile.

Security: Resource must have atleast read access permission on server ACL.

MachineTransServerServiceProfile GetMachineTransServerServiceProfile	(	string	sessionId,
		string	machineName
	)

Gets Machine Trans server Service Profile

Parameters

sessionId	The session id
machineName	machineName

Returns: Machine Trans server Service Profile

int GetServiceProfileRefreshInterval ( string sessionId )

Gets Service Profile Refresh Interval in seconds.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

Returns: Service Profile Refresh Interval in seconds.

Security: Resource must have atleast read access permission on server ACL

ServiceProfileSummaryCollection GetServiceProfiles	(	string	sessionId,
		ServiceProfileFilter	filter
	)

Retrieves the list of available service profiles using the filter specified.

Parameters

sessionId	A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
filter	A ServiceProfileFilterThe filter object containing the search criteria to retrieve the service profiles.

Name	Type	Comment	Required
ServiceType	Short	The service type. See Remarks section of this API to get more information.	Yes

Returns

A collection of ServiceProfileSummaryCollection ServiceProfileSummary members that has the details of the service profiles that match the search criteria.

Name	Type	Comment
Identity	ServiceProfileIdentity	The unique identity of the service profile
ServiceType	short	The service type. See Remarks section of this API to get more information.

Remarks

The supported service types and their corresponding numerical values are as follows:

Enumeration	Description
1	CoreWorkerServiceProfile
2	ExportServiceProfile
3	TransServerServiceProfile

Security: Resource must have atleast read access permission on server ACL.

TransServerServiceProfile GetTransServerServiceProfile	(	string	sessionId,
		ServiceProfileIdentity	identity
	)

Gets Transformation Server Service Profile.

Parameters

sessionId	A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
identity	ServiceProfileIdentityThe unique identity of the service profile.

Name	Type	Comment	Required
Id	string	Id of the service profile.	Yes, if Name is not specified.
Name	string	Name of the service profile.	Yes, if Id is not specified.

Returns

A TransServerServiceProfile object which holds the export service profile details.

Name	Type	Comment	Required
Identity	ServiceProfileIdentity	The unique identity of the service profile.	Yes
PoolName	string	The pool name.	No
MaxProcessingSlotsNumber	int	Number of maximum processing slots.	No
TransformationServerActivityOrder	short	Transformation server activity order.	No
ResetActivitiesIntervalMinutes	int	Indicates how often the transformation service checks for timed-out activities.	No
OnlineLearningExecutionEnabled	bool	Indicates whether to enable online learning execution or not.	No
EnableSynchronousCalls	bool	Indicates whether to enable synchronous calls or not.	No

Security: Resource must have atleast read access permission on server ACL

long GetWorkerTaskHistoryRetention	(	string	sessionId,
		short	workerTaskType
	)

Gets worker task history retention period in seconds for specified worker task type. 0 is returned if worker task type is not specified to record history.

Parameters

sessionId	A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
workerTaskType	The worker task type.

Returns: Returns retention period in seconds

Remarks

The supported worker task types and their corresponding numerical values are as follows:

Enumeration	Description
9	CreateExceptionTask
10	CreateJobTask
11	ProcessActivityTask
12	ArchiveJobTask
13	ProcessStateActionTask
14	CreateJobExceptionTask
24	CaptureBatchTask
26	EvaluateJobTask
27	ReportingTransportTask
32	DeleteItemTask
35	UpgradeJobsTask
36	UpgradeJobTask
38	ActivateSuspendedJobsTask
40	TerminateJobTask
41	DeleteCaptureBinaryTask

Security: Resource must have at least Read access permission on Server ACL.

WorkerTaskDetailsCollection GetWorkerTasks	(	string	sessionId,
		WorkerTasksFilter	filter
	)

Gets worker tasks based on specified filter. If a system worker task type is specified in the filter, it returns the non system worker tasks created/performed by the specified system worker task

Parameters

sessionId	A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
filter	A WorkerTasksFilter object that can be used to filter the worker tasks by worker task type, status and machine name.

Name	Type	Comment	Required
TaskType	Short	The worker task type. See Remarks section of this API to get more information.	Yes
Status	Short	The worker task status. See Remarks section of this API to get more information.	Yes
MachineName	String	The machine name.	No

Returns

Returns: A collection of WorkerTaskDetails

WorkerTaskDetails members.

Name	Type	Comment
WorkerTaskIdentity	WorkerTaskIdentity	The worker task identity. Contains id and name of worker task
CreatedDateTime	DateTime	Indicates the worker task created date time. This is set when worker task status is pending, failed, taken and complete.
TakenDateTime	DateTime	Indicates worker task taken date time. This is set when worker task status is taken and complete.
CompletedDateTime	DateTime	Indicates worker task completed date time. This is set when wroker task status is complete.

Remarks

The supported task types and their corresponding numerical values are as follows:

Enumeration	Description
0	ArchiveJobsSystemTask
1	CreateExceptionsSystemTask
2	CreateJobsSystemTask
3	JobSchedulingSystemTask
4	MonitoringSystemTask
5	PerformAutoActivitiesSystemTask
6	ProcessActivitiesSystemTask
7	ProcessSessionTimeoutsSystemTask
8	ProcessStateActionsSystemTask
9	CreateExceptionTask
10	CreateJobTask
11	ProcessActivityTask
12	ArchiveJobTask
13	ProcessStateActionTask
14	CreateJobExceptionTask
15	TransformationServerExecutionSystemTask
16	OnlineLearningSystemTask
17	XeroxFtpFetchSystemTask
18	KMFtpFetchSystemTask
19	ProcessCaptureTimeoutsSystemTask
20	IngestSystemTask
21	DeviceManagementCleanupSystemTask
22	ExportSystemTask
23	ReportingSystemTask
24	CaptureBatchTask
25	EvaluateJobsSystemTask
26	EvaluateJobTask
27	ReportingTransportTask
28	CreateTenantTask
29	UpdateTenantTask
30	DeleteTenantTask
31	RetentionPolicySystemTask
32	DeleteItemTask
33	LicenseMonitoringSystemTask
34	UpgradeJobsSystemTask
35	UpgradeJobsTask
36	UpgradeJobTask
37	CaptureDataCleanUpSystemTask
38	ActivateSuspendedJobsTask
39	UpgradeTenantTask
40	TerminateJobTask
41	DeleteCaptureBinaryTask
42	OAuthServerTokenRefreshSystemTask
43	ExchangeEventsSystemTask
44	DirectIngestTask

The supported worker task status and their corresponding numerical values are as follows:

Enumeration	Description
0	Pending
1	Taken
2	Failed
4	Completed

Security: Resource must have at least Read access permission on Server ACL.

WorkerTaskStats GetWorkerTaskStats	(	string	sessionId,
		WorkerTaskStatsFilter	filter
	)

Gets worker task statistics (count, min value, max value, average value) based on specified filter. If a system worker task type is specified in the filter, it returns the stats of the non system worker tasks created/performed by the specified system worker task

Parameters

sessionId	A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
filter	A WorkerTaskStatsFilter object that can be used to filter the worker tasks stats by worker task type, status, machine name and also it can be used whether to retun count, min, max and average duration of worker tasks

Name	Type	Comment	Required
TaskType	Short	The worker task type. See Remarks section of this API to get more information.	Yes
Status	Short	The worker task status. See Remarks section of this API to get more information.	Yes
MachineName	String	The machine name.	No
GetCount	Boolean	Indicates whether to return the count of worker tasks.	No
GetMaxDuration	Boolean	Indicates whether to return the maximum duration of worker tasks. Duration is the time the activity was taken.	No
GetMinDuration	Boolean	Indicates whether to return the minimum duration of worker tasks. Duration is the time the activity was taken	No
GetAverageDuration	Boolean	Indicates whether to return the average duration of worker tasks. Duration is the time the activity was taken	No
GetMaxPendingTime	Boolean	Indicates whether to return the maximum pending time of worker tasks.	No
GetMinPendingTime	Boolean	Indicates whether to return the minimum pending time of worker tasks.	No
GetAveragePendingTime	Boolean	Indicates whether to return the average pending time of worker tasks.	No

Returns

Returns: Returns a WorkerTaskStats object which contains statistics of worker tasks

WorkerTaskStats members.

Name	Type	Comment
Count	Long	Indicates the worker tasks count
MaxDuration	TimePeriod	Indicates the worker tasks maximum duration
MinDuration	TimePeriod	Indicates the worker tasks minimum duration
AverageDuration	TimePeriod	Indicates the worker tasks average duration
MaxPendingTime	TimePeriod	Indicates the worker tasks maximum pending time
MinPendingTime	TimePeriod	Indicates the worker tasks minimum pending time
AveragePendingTime	TimePeriod	Indicates the worker tasks average pending time

Remarks

Duration is the time the worker task is/was taken. The supported worker task types and their corresponding numerical values are as follows:

Enumeration	Description
0	ArchiveJobsSystemTask
1	CreateExceptionsSystemTask
2	CreateJobsSystemTask
3	JobSchedulingSystemTask
4	MonitoringSystemTask
5	PerformAutoActivitiesSystemTask
6	ProcessActivitiesSystemTask
7	ProcessSessionTimeoutsSystemTask
8	ProcessStateActionsSystemTask
9	CreateExceptionTask
10	CreateJobTask
11	ProcessActivityTask
12	ArchiveJobTask
13	ProcessStateActionTask
14	CreateJobExceptionTask
15	TransformationServerExecutionSystemTask
16	OnlineLearningSystemTask
17	XeroxFtpFetchSystemTask
18	KMFtpFetchSystemTask
19	ProcessCaptureTimeoutsSystemTask
20	IngestSystemTask
21	DeviceManagementCleanupSystemTask
22	ExportSystemTask
23	ReportingSystemTask
24	CaptureBatchTask
25	EvaluateJobsSystemTask
26	EvaluateJobTask
27	ReportingTransportTask
28	CreateTenantTask
29	UpdateTenantTask
30	DeleteTenantTask
31	RetentionPolicySystemTask
32	DeleteItemTask
33	LicenseMonitoringSystemTask
34	UpgradeJobsSystemTask
35	UpgradeJobsTask
36	UpgradeJobTask
37	CaptureDataCleanUpSystemTask
38	ActivateSuspendedJobsTask
39	UpgradeTenantTask
40	TerminateJobTask
41	DeleteCaptureBinaryTask
42	OAuthServerTokenRefreshSystemTask
43	ExchangeEventsSystemTask
44	DirectIngestTask

The supported worker task status and their corresponding numerical values are as follows:

Enumeration	Description
0	Pending
1	Taken
2	Failed
4	Completed

Security: Resource must have at least Read access permission on Server ACL.

void SaveMachineServiceProfiles	(	string	sessionId,
		MachineServiceProfileCollection	profiles
	)

Save machine service profiles

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

profiles

A collection of type MachineServiceProfile which holds the machine service profile details to be added

Name	Type	Comment	Required
Identity	ServiceProfileIdentity	The unique identity of the service profile.	Yes
MachineId	int16	The machine id	Yes
MachineName	string	The machine name	No
ServiceType	short	Type of the service/agent	Yes

Remarks

The supported service types and their corresponding numerical values are as follows:

Enumeration	Description
1	CoreWorkerServiceProfile
2	ExportServiceProfile
3	TransServerServiceProfile

Security: Resource must have atleast read write access permission on server ACL

void UpdateCoreWorkerServiceProfile	(	string	sessionId,
		CoreWorkerServiceProfile	profile
	)

Updates core worker service profile

Parameters

sessionId	A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
profile	A CoreWorkerServiceProfile object which holds the core worker profile details to be added

Name	Type	Comment	Required
Identity	ServiceProfileIdentity	The unique identity of the service profile.	Yes
CustomJobThreadPools	JobThreadPoolConfig	Gets or sets the job threadpool configuration.	No
AutoActivityThreadPools	ThreadPoolCollection	Gets or sets the auto activity thread pools collection.	No
CoreWorkerIntervalInSeconds	int	Indicates how often the system should check the in-memory worker task if they are due.	No
CoreWorkerDBIntervalInSeconds	int	Indicdates how often the system should poll for a due db worker task.	No
CoreWorkerResetTaskIntervalInSeconds	int	Indicates how often the system checks for timed-out worker tasks.	No
CoreWorkerResetActivityIntervalInSeconds	int	Indicates how often the core worker checks for timed-out activities.	No
CoreWorkerActivityTimeoutIntervalInMinutes	int	Defines the duration after which an activity becomes timed out. When an activity times out, when the corresponding task executes, the activity will be freed up.	No
MaximumNumberOfMessagesToImport	int	Defines the maximum number of documents/messages to import for Document Ingest.	No
CoreWorkerWorkQueueSize	int	Indicates the workqueue size of the core worker service.	No
MaximumNumberOfEvaluateJobTasksToTake	int	Indicates the maximum number of the evaluate job tasks to take.	No
CoreWorkerActivityOrder	int	Indicates the activity order of the core worker	No
MaximumNumberOfActivitiesToLock	int	Indicates how many automatic activities to lock, when the core worker polls for automatic activities to execute.	No
ImportConnectorName	string	This property allows admins to explicitly specify which import connection the CoreWorker should use, by default it uses all. This setting is useful when one has multiple CoreWorkers setup.	No
CoreWorkerThreadPoolMonitoringIntervalInSeconds	int	Defines how often a thread pool should monitor the threads in it.	No
ArchiveDeleteWorkerTasksToRetrieve	int	Indicates number of ArchiveJob and DeleteItem non-system level worker tasks to be retrieve for execution.	No
ArchiveDeleteRetryIntervalInSeconds	int	Indicates maximum duration in seconds to calculate next duedate to execute ArchiveJob and DeleteItem non-system worker tasks.	No
AutoActivitiesPoolName	string	Gets or sets the auto activities pool name.	No
AutoActivitiesPoolId	short	Gets or sets the auto activities pool id.	No
UpgradeJobsThreadPoolSize	short	Gets or sets the value of upgrade jobs threadpool size.	No

void UpdateExportServiceProfile	(	string	sessionId,
		ExportServiceProfile	profile
	)

Updates Export Service Profile.

Parameters

sessionId	A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
profile	A ExportServiceProfile object which holds the export service profile details to be added

Name	Type	Comment	Required
Identity	ServiceProfileIdentity	The unique identity of the service profile.	Yes
CoreWorkerActivityOrder	int	Indicates the activity order of the core worker.	No
CoreWorkerResetActivityIntervalInSeconds	int	Indicates how often the core worker checks for timed-out activities.	No
CoreWorkerActivityTimeoutIntervalInMinutes	int	Defines the duration after which an activity becomes timed out. When an activity times out, when the corresponding task executes, the activity will be freed up.	No

Security: Resource must have atleast read write access permission on server ACL

void UpdateServiceProfileRefreshInterval	(	string	sessionId,
		int	serviceProfileRefreshInSeconds
	)

Updates Service Profile Refresh interval in seconds

Parameters

sessionId	A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
serviceProfileRefreshInSeconds	Service profile refresh interval value in seconds.

Security: Resource must have atleast read write access permission on server ACL

void UpdateTransServerServiceProfile	(	string	sessionId,
		TransServerServiceProfile	profile
	)

Updates Transformation Service Profile.

Parameters

sessionId	A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
profile	A TransServerServiceProfile object which holds the export service profile details to be added

Name	Type	Comment	Required
Identity	ServiceProfileIdentity	The unique identity of the service profile.	Yes
PoolName	string	The pool name.	No
MaxProcessingSlotsNumber	int	Number of maximum processing slots.	No
TransformationServerActivityOrder	short	Transformation server activity order.	No
ResetActivitiesIntervalMinutes	int	Indicates how often the transformation service checks for timed-out activities.	No
OnlineLearningExecutionEnabled	bool	Indicates whether to enable online learning execution or not.	No
EnableSynchronousCalls	bool	Indicates whether to enable synchronous calls or not.	No

Security: Resource must have atleast read write access permission on server ACL

void UpdateWorkerTaskHistoryRetention	(	string	sessionId,
		short	workerTaskType,
		long	retentionPeriodInSeconds
	)

Saves worker task history retention period in seconds for specified worker task type. If 0 is passed as retention period then the existing worker task type does not record history

Parameters

sessionId	A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
workerTaskType	The worker task type.
retentionPeriodInSeconds	The retention period in seconds.

Remarks

The supported worker task types and their corresponding numerical values are as follows:

Enumeration	Description
9	CreateExceptionTask
10	CreateJobTask
11	ProcessActivityTask
12	ArchiveJobTask
13	ProcessStateActionTask
14	CreateJobExceptionTask
24	CaptureBatchTask
26	EvaluateJobTask
27	ReportingTransportTask
32	DeleteItemTask
35	UpgradeJobsTask
36	UpgradeJobTask
38	ActivateSuspendedJobsTask
40	TerminateJobTask
41	DeleteCaptureBinaryTask

Security: Resource must have at least Read Write access permission on Server ACL.

Public Member Functions

Description

Member Functions