Provides methods to manage processes, configure process properties, and return process information. More...

Public Member Functions
void	AddProcessNote (string sessionId, ProcessIdentity processIdentity, ProcessNote processNote)
	Adds a design note to the specified process. More...

ExportedProcessCollection	ExportProcess (string sessionId, ProcessIdentity processToExport, ProcessExportOptions exportOptions)
	This function is deprecated. Please use ServerService.ExportPackage2 instead. Exports the specified process. More...

ExportedProcessCollection	ExportProcesses (string sessionId, ProcessIdentityCollection processesToExport, ProcessExportOptions exportOptions)
	Exports multiple selected business processes into a single exported file. More...

ProcessIdentityCollection	GetCaseDefinitionAssociatedProcesses (string sessionId, ProcessIdentity processIdentity)
	Retrieves the associated business processes for the specified case definition. More...

ProcessSummaryCollection	GetProcesses (string sessionId, ProcessFilter filter)
	This function is deprecated. Please use GetProcesses4 instead Retrieves a list of processes based on the specified filter criteria. More...

ProcessSummary2Collection	GetProcesses2 (string sessionId, ProcessFilter2 processFilter)
	This function is deprecated. Please use GetProcesses4 instead Retrieves a list of processes based on the specified filter criteria. More...

ProcessSummary3Collection	GetProcesses3 (string sessionId, ProcessFilter4 processFilter)
	This function is deprecated. Please use GetProcesses4 instead Retrieves a list of processes based on the specified filter criteria. More...

ProcessSummary4Collection	GetProcesses4 (string sessionId, ProcessFilter4 processFilter)
	This function is deprecated. Please use GetProcessesSummary instead. Gets the processes and associated form summary for the specified filter criteria. More...

ProcessIdentityCollection	GetProcessesSummary (string sessionId, ProcessesSummaryFilter processesSummaryFilter)
	Gets the processes for the specified filter criteria. More...

string	GetProcessHelpText (string sessionId, ProcessIdentity processIdentity)
	Retrieves the help text for a specified business process. More...

ProcessInfo	GetProcessInfo (string sessionId, ProcessIdentity processIdentity, short processInfoFilter)
	This function is deprecated. Please use GetProcessInfo2 instead. Retrieves the process info for the specified process. Optionally also returns annotations and attachments. More...

ProcessInfo2	GetProcessInfo2 (string sessionId, ProcessIdentity processIdentity, short processInfoFilter)
	Retrieves the process info for the specified process. Optionally also returns annotations and attachments. More...

ProcessInitialization	GetProcessInitialization (string sessionId, ProcessIdentity processIdentity)
	This function is deprecated. Please use GetProcessInitialization2 instead Retrieves the initialization variables needed for the specified process More...

ProcessInitialization	GetProcessInitialization2 (string sessionId, ProcessIdentity processIdentity, ProcessInitializationOptions initializationOptions)
	Retrieves the initialization variables needed for the specified process based on the given options More...

MilestoneSummaryCollection	GetProcessMilestones (string sessionId, ProcessIdentity processIdentity)
	Retrieves the process milestones for the specified process. More...

ProcessNoteCollection	GetProcessNotes (string sessionId, ProcessIdentity processIdentity)
	Gets the notes/comments related to the passed in Process. More...

StateIdentityCollection	GetProcessStatesSummary (string sessionId, ProcessIdentity processIdentity)
	Retrieves all states defined for the specified process. More...

ProcessImportError	ImportProcess (string sessionId, ExportedProcess processToImport, ProcessImportOptions importOptions)
	This function is deprecated. Please use ServerService.ImportPackage3 instead. Imports the specified process with the specified import options. More...

ProcessImportError2	ImportProcess2 (string sessionId, ExportedProcess processToImport, ProcessImportOptions importOptions)
	This function is deprecated. Please use ServerService.ImportPackage3 instead. Imports the specified process with the specified import options. More...

ProcessImportErrorCollection	ImportProcesses (string sessionId, ExportedProcessCollection processesToImport, ProcessImportOptions importOptions)
	This function is deprecated. Please use Services.ServerService.ImportPackage3 instead. Imports the specified processes using the given import options. More...

ProcessImportErrorCollection	ImportProcesses2 (string sessionId, ExportedProcessData exportedProcessData, ProcessImportOptions2 importOptions)
	This function is deprecated. Please use ServerService.ImportPackage3 instead. Imports the specified processes with the specified options. More...

XpdlImportErrorCollection	ImportXpdl (string sessionId, string xpdlToImport)
	Imports an XPDL from the supplied XML More...

PrecompileResults	PrecompileSyncProcesses (string sessionId, ProcessIdentityCollection syncProcesses)
	This api pre-compiles the synchronous capture processes used in RTTS. The ahead in time compilation improves the start-up performance of RTTS solutions significantly. For more information, consult the RTTS section in KTA documentation More...

void	ReleaseProcess (string sessionId, ProcessIdentity processIdentity)
	Releases the process which are in awaiting state and increases the version number to the next whole number. More...

void	ResetQualityCounts (string sessionId)
	Resets the sampling and checking counts to 0 for all processes and jobs. More...

void	UpdateProcessNote (string sessionId, ProcessIdentity processIdentity, ProcessNote processNote)
	Updates the specified process note with the given details. More...

Description

Provides methods to manage processes, configure process properties, and return process information.

Member Functions

void AddProcessNote	(	string	sessionId,
		ProcessIdentity	processIdentity,
		ProcessNote	processNote
	)

Adds a design note to the specified process.

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.

processIdentity

A ProcessIdentity object containing the detailsd of the process to add the note to

Name	Type	Comment	Required
Id	String	Id of the process	Yes - if Name is not specified
Version	Double	Not used	No
Name	String	Name of the process	Yes - if Id is not specified

processNote

A ProcessNote object containing the process note information that needs to be added to the process.

Name	Type	Comment	Required
Creator	Identity	Note creator's Id and Name	No
CreatedDate	DateTime	Date the note was created	No
Notes	String	Text of the note to be added	Yes
Actioned	Int16	0 - Not actioned, 1 - Actioned	No
ActionedByResource	Identity	Resource that actioned the note	Yes - Id or Name is required if Actioned is set to 1
ActionedDate	DateTime	Date the note was actioned - will be populated automatically if Actioned is set to 1	No
ActionedText	String	Comment added when note was actioned	Yes - If Actioned is set to 1
Identity	Identity	Note's Id. Populated automatically	No

Remarks: Process notes can be seen by opening a job in the Workspace, clicking View Job then clicking the Process design notes button from the bar at the top of the screen.

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

ExportedProcessCollection ExportProcess	(	string	sessionId,
		ProcessIdentity	processToExport,
		ProcessExportOptions	exportOptions
	)

This function is deprecated. Please use ServerService.ExportPackage2 instead.
Exports the specified process.

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.

processToExport

A ProcessIdentity object that needs to be exported.

Name	Type	Comment	Required
Id	String	Id of the process	Yes - if Name is not specified
Version	Double	Not used	No
Name	String	Name of the process	Yes - if Id is not specified

exportOptions A ProcessExportOptions object containing the export options that need to be considered while exporting.

Returns: A collection of type ExportedProcess

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

ExportedProcessCollection ExportProcesses	(	string	sessionId,
		ProcessIdentityCollection	processesToExport,
		ProcessExportOptions	exportOptions
	)

Exports multiple selected business processes into a single exported file.

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.

processesToExport

A collection of type ProcessIdentity object that needs to be exported.

Name	Type	Comment	Required
Id	String	Id of the process	Yes - if Name is not specified
Version	Double	Not used	No
Name	String	Name of the process	Yes - if Id is not specified

exportOptions A ProcessExportOptions object containing the export options that need to be considered while exporting.

Returns: A collection of type ExportedProcess.

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

ProcessIdentityCollection GetCaseDefinitionAssociatedProcesses	(	string	sessionId,
		ProcessIdentity	processIdentity
	)

Retrieves the associated business processes for the specified case definition.

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.

processIdentity

A ProcessIdentity object used to determine the process whose associated processes needs to be retrieved.

Name	Type	Comment	Required
Id	String	Id of the process	Yes - if Name is not specified
Version	Double	Not used	No
Name	String	Name of the process	Yes - if Id is not specified

Returns

A collection of type ProcessIdentity that has details of each of the associated processes

Name	Type	Comment
Id	String	Id of the process
Version	Double	The version of the process
Name	String	Name of the process

Security: No restrictions apply.

ProcessSummaryCollection GetProcesses	(	string	sessionId,
		ProcessFilter	filter
	)

This function is deprecated. Please use GetProcesses4 instead
Retrieves a list of processes based on the specified filter criteria.

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 ProcessFilter object containing the filter criteria to retrieve the processes.

Name	Type	Comment	Required
AccessType	Int16	Type of access needed for the returned processes	No
Status	Int16	Status of the process. Defaults to Active	No
UseStatus	Boolean	Indicates that Status should be used	No
ProcessType	Int16	Type of processes to search for	No
Category	Identity	Use to find processes belongiong to the specified category	Yes - Id or Name is required if IncludeSkins is set to 'true'
AssociatedCase	Identity	CaseReference and CaseId of the associated case	No
OpenProcessFilter	Int16	Type of processes to search for	No
UseAccessToken	Boolean	Indicates that the security token should be used	No
ProcessOwner	Identity	Use to only find processes belonging to specified resource	No
UseSkinning	Boolean	Indicates whether SupportSkinning should be taken into account	No
SupportSkinning	Boolean	Only find processes that do/do not support skinning	No
SearchText	String	Only processes whose names contain SearchText will be returned	No
IncludeSubcategories	Boolean	If 'true' then subcategories will also be searched	No
IncludeSkins	Boolean	If set to `true` then return skins of found processes	No
UseProcessType	Boolean	If not populated with a true value, the method does not filter based on ProcessType and returns all processes	No

Returns

A collection of type ProcessSummary that has the details of each process found.

Name	Type	Comment
Id	String	Not populated
Name	String	Not populated
Version	Double	Not populated
ProcessIdentity	Identity	Id, Name and Version of the process
ProcessType	Int16	The type of the process
Duration	Object	Details of the expected duration of the process
ExpectedCost	Double	Expected cost of the process
Synchronous	Boolean	Indicates whether the process is executed synchronously.
Category	Identity	The category the process belongs to
AssociatedCase	Identity	CaseReference and CaseId of the associated case
ProcessOwner	Identity	Details of the resource that currently has the process locked
Description	String	Description of the process
LatestVersion	Boolean	Indicates whether this process si the latest version
OwnerId	String	Id of the resource that owns the process
SupportSkinning	Boolean	Indicates whether skinning is supported by this process
Author	Identity	Details of the resource that created the process map
ServerId	String	Id of the server the process belongs to
LastModifiedBy	Identity	Details of the resource that last modified the process
LastModifiedDate	DateTime	Date the process was last modified
WorkQueueDefinition	Identity	Id and Name of the work queue definition associated with the process
CaptureEnabled	Boolean	Indicates whether the process is capture enabled

Remarks

If SPP_SYSTEM_SESSION_ID is specified for sessionId then no results will be returned
At least one member of ProcessFilter must be populated or the method will fail
If IncludeSkins is set to true then Category must be specified and only skins belonging to that ctaegory specifically will be found.
If UseSkinning is set to false then processes will be found regardless of whether they support skinning. Set to true then the value of SupportSkinning is taken inot account:

true - only processes that support skining will be found
false - only processes that do not support skining will be found

Security: No restrictions apply.

ProcessSummary2Collection GetProcesses2	(	string	sessionId,
		ProcessFilter2	processFilter
	)

This function is deprecated. Please use GetProcesses4 instead
Retrieves a list of processes based on the specified filter criteria.

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.

processFilter

A ProcessFilter2 object containing the filter criteria to retrieve the processes.

Name	Type	Comment	Required
UseCaptureEnabled	Boolean	Indicates whether capture enabled processes should be found	No
AllVersions	Boolean	Indicates that all versions of found processes should be returned	No
AccessType	Int16	Type of access needed for the returned processes	No
Status	Int16	Status of the process. Defaults to Active	No
UseStatus	Boolean	Indicates that Status should be used	No
ProcessType	Int16	Type of processes to search for	No
Category	Identity	Use to find processes belongiong to the specified category	No
AssociatedCase	Identity	CaseReference and CaseId of the associated case	No
OpenProcessFilter	Int16	Type of processes to search for	No
UseAccessToken	Boolean	Indicates that the security token should be used	No
ProcessOwner	Identity	Use to only find processes belonging to specified resource	No
UseSkinning	Boolean	Indicates whether SupportSkinning should be taken into account	No
SupportSkinning	Boolean	Only find processes that do/do not support skinning	No
SearchText	String	Only processes whose names contain SearchText will be returned	No
IncludeSubcategories	Boolean	If 'true' then subcategories will also be searched	No
IncludeSkins	Boolean	If set to `true` then return skins of found processes	No
UseProcessType	Boolean	If not populated with a true value, the method does not filter based on ProcessType and returns all processes	No

Returns

A collection of type ProcessSummary2 that has the details of each process found.

Name	Type	Comment
HelpText	String	Help text
AllocationAlgorithm	Int16	Method that automatic work allocation will use to distribute the process
ArrowType	Int32	Not used
ArrowWeight	Int32	Not used
Transactional	Boolean	Not used
Color	Int32	Not used
CreationDate	DateTime	Date the process was created
UseVariablePrefix	Boolean	Indicates whether a variable prefix should be used
Priority	Int16	Priority of the process
Budget	Object	Details of the budget object
Status	Int16	Status of the process
Id	String	Not populated
Name	String	Not populated
Version	Double	Not populated
ProcessIdentity	Identity	Id, Name and Version of the process
ProcessType	Int16	The type of the process
Duration	Object	Details of the expected duration of the process
ExpectedCost	Double	Expected cost of the process
Synchronous	Boolean	Indicates whether the process is executed synchronously.
Category	Identity	The category the process belongs to
AssociatedCase	Identity	CaseReference and CaseId of the associated case
ProcessOwner	Identity	Deatils of the resource that currently has the process locked
Description	String	Description of the process
LatestVersion	Boolean	Indicates whether this process si the latest version
OwnerId	String	Id of the resource that owns the process
SupportSkinning	Boolean	Indicates whether skinning is supported by this process
Author	Identity	Details of the resource that created the process map
ServerId	String	Id of the server the process belongs to
LastModifiedBy	Identity	Details of the resource that last modified the process
LastModifiedDate	DateTime	Date the process was last modified
WorkQueueDefinition	Identity	Id and Name of the work queue definition associated with the process
CaptureEnabled	Boolean	Indicates whether the process is capture enabled

Remarks

Details of Budget

Name	Type	Comment
Value	Double	Value of the budget
DynamicVariable	Identity	Id and Name of dynamic variable that contains the budget value

If SPP_SYSTEM_SESSION_ID is specified for sessionId then no results will be returned
At least one member of ProcessFilter must be populated or the method will fail
If UseVariablePrefix is set to true then new variables created will have a p prepended. For example creating a new boolean variable MyBool will have an Id of pMYBOOL when it is added
If UseSkinning is set to false then processes will be found regardless of whether they support skinning. Set to true then the value of SupportSkinning is taken inot account:

true - only processes that support skining will be found
false - only processes that do not support skining will be found

Security: No restrictions apply.

ProcessSummary3Collection GetProcesses3	(	string	sessionId,
		ProcessFilter4	processFilter
	)

This function is deprecated. Please use GetProcesses4 instead
Retrieves a list of processes based on the specified filter criteria.

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.

processFilter

A ProcessFilter4 object that derives from the ProcessFilter class containing the filter criteria to retrieve the processes.

Name	Type	Comment	Required
AccessType	Int16	Type of access needed for the returned processes	No
Status	Int16	Status of the process. Defaults to Active	No
UseStatus	Boolean	Indicates that Status should be used	No
ProcessType	Int16	Type of processes to search for	No
Category	Identity	Use to find processes belonging to the specified category	Yes - Id or Name is required if IncludeSkins is set to 'true'
AssociatedCase	Identity	CaseReference and CaseId of the associated case	No
OpenProcessFilter	Int16	Type of processes to search for	No
UseAccessToken	Boolean	Indicates that the security token should be used	No
ProcessOwner	Identity	Use to only find processes belonging to specified resource	No
UseSkinning	Boolean	Indicates whether SupportSkinning should be taken into account	No
SupportSkinning	Boolean	Only find processes that do/do not support skinning	No
SearchText	String	Only processes whose names contain SearchText will be returned	No
IncludeSubcategories	Boolean	If 'true' then subcategories will also be searched	No
IncludeSkins	Boolean	If set to `true` then return skins of found processes	No
UseCaptureEnabled	Boolean	Indicates whether capture enabled processes should be found	No
AllVersions	Boolean	Indicates that all versions of found processes should be returned	No
UseProcessType	Boolean	If not populated with a true value, the method does not filter based on ProcessType and returns all processes	No

Returns

A collection of type ProcessSummary3 that has the details of each process found.

Name	Type	Comment
Identity	Identity	Id, Name and Version of the process
ProcessType	Int16	The type of the process
Duration	Object	Details of the expected duration of the process
ExpectedCost	Double	Expected cost of the process
Synchronous	Boolean	Indicates whether the process is executed synchronously.
Category	Identity	The category the process belongs to
AssociatedCase	Identity	CaseReference and CaseId of the associated case
ProcessOwner	Identity	Details of the resource that currently has the process locked
Description	String	Description of the process
LatestVersion	Boolean	Indicates whether this process si the latest version
OwnerId	String	Id of the resource that owns the process
SupportSkinning	Boolean	Indicates whether skinning is supported by this process
Author	Identity	Details of the resource that created the process map
ServerId	String	Id of the server the process belongs to
LastModifiedBy	Identity	Details of the resource that last modified the process
LastModifiedDate	DateTime	Date the process was last modified
WorkQueueDefinition	Identity	Id and Name of the work queue definition associated with the process
CaptureEnabled	Boolean	Indicates whether the process is capture enabled
CreationDate	DateTime	Date the process was created

Remarks

If SPP_SYSTEM_SESSION_ID is specified for sessionId then no results will be returned
At least one member of ProcessFilter must be populated or the method will fail
If IncludeSkins is set to true then Category must be specified and only skins belonging to that ctaegory specifically will be found. If UseSkinning is set to false then processes will be found regardless of whether they support skinning. Set to true then the value of SupportSkinning is taken inot account:

true - only processes that support skining will be found
false - only processes that do not support skining will be found

Security: No restrictions apply.

ProcessSummary4Collection GetProcesses4	(	string	sessionId,
		ProcessFilter4	processFilter
	)

This function is deprecated. Please use GetProcessesSummary instead.
Gets the processes and associated form summary for the specified filter criteria.

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.

processFilter

A ProcessFilter4 object that derives from the ProcessFilter class containing the filter criteria to retrieve the processes.

Name	Type	Comment	Required
AccessType	Int16	Type of access needed for the returned processes	No
Status	Int16	Status of the process. Defaults to Active	No
UseStatus	Boolean	Indicates that Status should be used	No
ProcessType	Int16	Type of processes to search for	No
Category	Identity	Use to find processes belongiong to the specified category	Yes - Id or Name is required if IncludeSkins is set to 'true'
AssociatedCase	Identity	CaseReference and CaseId of the associated case	No
OpenProcessFilter	Int16	Type of processes to search for	No
UseAccessToken	Boolean	Indicates that the security token should be used	No
ProcessOwner	Identity	Use to only find processes belonging to specified resource	No
UseSkinning	Boolean	Indicates whether SupportSkinning should be taken into account	No
SupportSkinning	Boolean	Only find processes that do/do not support skinning	No
SearchText	String	Only processes whose names contain SearchText will be returned	No
IncludeSubcategories	Boolean	If 'true' then subcategories will also be searched	No
IncludeSkins	Boolean	If set to `true` then return skins of found processes	No
UseCaptureEnabled	Boolean	Indicates whether capture enabled processes should be found	No
AllVersions	Boolean	Indicates that all versions of found processes should be returned	No
UseProcessType	Boolean	If not populated with a true value, the method does not filter based on ProcessType and returns all processes	No

Returns: A ProcessSummary4Collection collection of type ProcessSummary4 objects.

Security: No restrictions apply.

ProcessIdentityCollection GetProcessesSummary	(	string	sessionId,
		ProcessesSummaryFilter	processesSummaryFilter
	)

Gets the processes for the specified filter criteria.

Parameters

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

processesSummaryFilter

A ProcessesSummaryFilter class containing the filter criteria to retrieve the processes.

Name	Type	Comment	Required
AccessType	Int16	Type of access needed for the returned processes. Supported access types are: 0 - Maintenance 1 - Create 2 - Suspend 3 - Activate 4 - Terminate 5 - Restart 6 - Place on Hold 7 - Reactivate 8 - Customize 9 - View Job Details 10 - Change Scan/VrsProfile 11 - Change Separation Settings 12 - Update Document Set	Yes
Category	CategoryIdentity	If category is specified the resource access for that category is checked first. If the user does not have access, an exception is thrown. Otherwise the list of processes belonging to the specified category is returned. If category is not specified then all processes from all categories the user has access to are returned.	No
UseProcessType	Boolean	UseProcessType is not true, the method does not filter processes based on process type and returns all processes.	No
ProcessType	Int16	If UseProcessType is true the method uses the ProcessType value, and returns processes for the respective process types. Supported process types are: 0 - BusinessProcess 1 - CaseDefinition 2 - CaseFragment.	No

Returns: A ProcessIdentityCollection collection of ProcessIdentity objects.

Security: No restrictions apply.

string GetProcessHelpText	(	string	sessionId,
		ProcessIdentity	processIdentity
	)

Retrieves the help text for a specified business process.

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.

processIdentity

A ProcessIdentity object containing the processid and version information of the process whose help text needs to be retrieved.

Name	Type	Comment	Required
Id	String	Id of the process	Yes - if Name is not specified
Version	Double	Not used	No
Name	String	Name of the process	Yes - if Id is not specified

Returns: A string containing the help text

Remarks: Process help text is set using the Advanced tab of the config options of the process in TotalAgility Designer.

Security: No restrictions apply.

ProcessInfo GetProcessInfo	(	string	sessionId,
		ProcessIdentity	processIdentity,
		short	processInfoFilter
	)

This function is deprecated. Please use GetProcessInfo2 instead.
Retrieves the process info for the specified process. Optionally also returns annotations and attachments.

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.

processIdentity

A ProcessIdentity object containing the process id and version information of the process.

Name	Type	Comment	Required
Id	String	Id of the process	Yes - if Name is not specified
Version	Double	Not used	No
Name	String	Name of the process	Yes - if Id is not specified

processInfoFilter

Indiacates whether annotations and attachments should be retrieved.

Enumeration	Description
0	No annotations or attachments
1	Annotations only
2	Attachments only
3	Annotations and attachments

Returns

A ProcessInfo object that contains the details of the process and any annotations and atatchments that were requested.

Name	Type	Comment
Identity	Identity	Id, name and version of the process
Annotations	Collection	A collection of Annotations that have the details of each annotation for the process. Will only be populated if processInfoFilter is set to 1 or 3
Attachments	Collection	A collection of Attachments that have the details of each attachment for the process. Will only be populated if processInfoFilter is set to 2 or 3
Description	String	The text description of the process
HelpText	String	The text description of the process

Remarks: For information about adding annotations please see here
For information about adding attachments please see here

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

ProcessInfo2 GetProcessInfo2	(	string	sessionId,
		ProcessIdentity	processIdentity,
		short	processInfoFilter
	)

Retrieves the process info for the specified process. Optionally also returns annotations and attachments.

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.

processIdentity

A ProcessIdentity object containing the process id and version information of the process.

Name	Type	Comment	Required
Id	String	Id of the process	Yes - if Name is not specified
Version	Double	Not used	No
Name	String	Name of the process	Yes - if Id is not specified

processInfoFilter

Indiacates whether annotations and attachments should be retrieved.

Enumeration	Description
0	No annotations or attachments
1	Annotations only
2	Attachments only
3	Annotations and attachments

Returns

A ProcessInfo2 object that contains the details of the process and any annotations and atatchments that were requested.

Name	Type	Comment
AllocationAlgorithm	Int16	Allocation algorithm to be used for automatic work allocation
Identity	Identity	Id, name and version of the process
Annotations	Collection	A collection of Annotations that have the details of each annotation for the process. Will only be populated if processInfoFilter is set to 1 or 3
Attachments	Collection	A collection of Attachments that have the details of each attachment for the process. Will only be populated if processInfoFilter is set to 2 or 3
Description	String	The text description of the process
HelpText	String	The text description of the process

Remarks: For information about adding annotations please see here
For information about adding attachments please see here

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

ProcessInitialization GetProcessInitialization	(	string	sessionId,
		ProcessIdentity	processIdentity
	)

This function is deprecated. Please use GetProcessInitialization2 instead
Retrieves the initialization variables needed for the specified process

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.

processIdentity

A ProcessIdentity object containing the processid and version information of the process for which the initialization variables needs to be retrieved.

Name	Type	Comment	Required
Id	String	Id of the process	Yes - if Name is not specified
Version	Double	Version of the process to check	No
Name	String	Name of the process	Yes - if Id is not specified

Returns

A ProcessInitialization object that has a list of the initialization variables for the process

Name	Type	Comment
InputVariables	Collection	A collection of ProcessInputVariable that have the details of each initialization variable

Process input variables

Name	Type	Comment
Id	String	Id of the variable
VariableType	Int16	The type of thwe variable
Value	Object	The value of the object
DisplayName	String	Display name of the variable

Remarks: XML variables will be checked to ensure they are well formed and XmlExpression variables will be evaluated

Security: No restrictions apply.

ProcessInitialization GetProcessInitialization2	(	string	sessionId,
		ProcessIdentity	processIdentity,
		ProcessInitializationOptions	initializationOptions
	)

Retrieves the initialization variables needed for the specified process based on the given options

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.

processIdentity

A ProcessIdentity object containing the processid and version information of the process for which the initialization variables needs to be retrieved.

Name	Type	Comment	Required
Id	String	Id of the process	Yes - if Name is not specified
Version	Double	Version of the process to check	No
Name	String	Name of the process	Yes - if Id is not specified

initializationOptions

A ProcessInitializationOptions object containing the processid and version information of the process for which the initialization variables needs to be retrieved.

Name	Type	Comment	Required
EvaluateXmlVariables	Boolean	This option has no effect	No
EvaluateXmlExpressions	Boolean	Indicates that Xml expressions are evaluated before being returned	No

Returns

A ProcessInitialization object that has a list of the initialization variables for the process

Name	Type	Comment
InputVariables	Collection	A collection of ProcessInputVariable that have the details of each initialization variable

Process input variables

Name	Type	Comment
Id	String	Id of the variable
VariableType	Int16	The type of thwe variable
Value	Object	The value of the object
DisplayName	String	Display name of the variable

Remarks: Xml variables must have well formed XML or the process will be suspended
If EvaluateXmlExpressions is set to false then XmlExpression variables will be returned as null

Security: No restrictions apply.

MilestoneSummaryCollection GetProcessMilestones	(	string	sessionId,
		ProcessIdentity	processIdentity
	)

Retrieves the process milestones for the specified process.

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.

processIdentity

A ProcessIdentity object containing the process id and version information of the process for which the milestones should be retrieved.

Name	Type	Comment	Required
Id	String	Id of the process	Yes - if Name is not specified
Version	Double	Not used	No
Name	String	Name of the process	Yes - if Id is not specified

Returns: A collection of type MilestoneSummary.

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

ProcessNoteCollection GetProcessNotes	(	string	sessionId,
		ProcessIdentity	processIdentity
	)

Gets the notes/comments related to the passed in Process.

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.

processIdentity

A ProcessIdentity object containing the process information for whihc the notes are to be retrieved

Name	Type	Comment	Required
Id	String	Id of the process	Yes - if Name is not specified
Version	Double	Not used	No
Name	String	Name of the process	Yes - if Id is not specified

Returns

A collection of type ProcessNote

Name	Type	Comment
Creator	Identity	Note creator's Id and Name
CreatedDate	DateTime	Date the note was created
Notes	String	Text of the note to be added
Actioned	Int16	0 - Not actioned, 1 - Actioned
ActionedByResource	Identity	Resource that actioned the note
ActionedDate	DateTime	Date the note was actioned
ActionedText	String	Comment added when note was actioned
Identity	Identity	Note's Id. Populated automatically

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

StateIdentityCollection GetProcessStatesSummary	(	string	sessionId,
		ProcessIdentity	processIdentity
	)

Retrieves all states defined for the specified process.

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.

processIdentity

A ProcessIdentity object containing the details for the process to retrieve the states for

Name	Type	Comment	Required
Id	String	Id of the process	Yes - if Name is not specified
Version	Double	Not used	No
Name	String	Name of the process	Yes - if Id is not specified

Returns

A collection of type StateIdentity that has the name of each state for the process

Name	Type	Comment
Name	String	Name of the state

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

ProcessImportError ImportProcess	(	string	sessionId,
		ExportedProcess	processToImport,
		ProcessImportOptions	importOptions
	)

This function is deprecated. Please use ServerService.ImportPackage3 instead.
Imports the specified process with the specified import options.

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.

processToImport

A ExportedProcess object containing the information of the process to be imported.

Name	Type	Comment	Required
Xml	String	Xml of the process	Yes
Filename	String	Not used	No
Process	Identity	Not used	No

importOptions

A ProcessImportOptions object containing the information of the import options to be considered while importing the process.

Name	Type	Comment	Required
ImportCategories	Boolean	Indicates whether categories should be imported	No
ImportResources	Boolean	Indicates whether resources should be imported	No
ImportGroupsWithResourceMembers	Boolean	Indicates whether groups with resource members should be imported	No
OverwriteExistingWQDefinitions	Boolean	Indicates whether existing workqueue definitions should be overwritten	No
OverwriteExistingCheckListData	Boolean	Indicates whether existing check list data should be overwritten	No
OverwriteExistingRoles	Boolean	Indicates whether existing roles should be overwritten	No
OverwriteBusinessRules	Boolean	Indicates whether existing business should be overwritten	No
OverwriteExistingEntityDefinitions	Boolean	Indicates whether existing entity rules should be overwritten	No
OverwriteExistingStaticDataLists	Boolean	Indicates whether existing static data lists should be overwritten	No
SaveLibraryItemsAsOrdinary	Boolean	Indicates whether library items should be saved as ordinary	No

Returns

An instance of type ProcessImportError containing any warnings and errors that may have occurred during the import.

Name	Type	Comment
FileName	String	Will contain whatever was in processToImport->FileName
Process	Identity	Id, Name and Version of the imported process
Warnings	Collection	A collection of ImportWarningsInfo that have the details of each warning caused by the import
Errors	Collection	A collection of ImportErrorsInfo that have the details of each error caused by the import

Import warnings info

Name	Type	Comment
ImportWarningType	Int16	The type of warning
Warnings	Collection	A collection of strings that contain the warning messages

Import errors info

Name	Type	Comment
ImportErrorType	Int16	The type of error
FailedReason	String	Message that explains the failure
Errors	Collection	A collection of strings that contain the error messages

Remarks: At least one member of importOptions must be specified

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

ProcessImportError2 ImportProcess2	(	string	sessionId,
		ExportedProcess	processToImport,
		ProcessImportOptions	importOptions
	)

This function is deprecated. Please use ServerService.ImportPackage3 instead.
Imports the specified process with the specified import options.

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.

processToImport

A ExportedProcess object containing the information of the process to be imported.

Name	Type	Comment	Required
Xml	String	Xml of the process	Yes
Filename	String	Not used	No
Process	Identity	Not used	No

importOptions

A ProcessImportOptions object containing the information of the import options to be considered while importing the process.

Name	Type	Comment	Required
ImportCategories	Boolean	Indicates whether categories should be imported	No
ImportResources	Boolean	Indicates whether resources should be imported	No
ImportGroupsWithResourceMembers	Boolean	Indicates whether groups with resource members should be imported	No
OverwriteExistingWQDefinitions	Boolean	Indicates whether existing workqueue definitions should be overwritten	No
OverwriteExistingCheckListData	Boolean	Indicates whether existing check list data should be overwritten	No
OverwriteExistingRoles	Boolean	Indicates whether existing roles should be overwritten	No
OverwriteBusinessRules	Boolean	Indicates whether existing business should be overwritten	No
OverwriteExistingEntityDefinitions	Boolean	Indicates whether existing entity rules should be overwritten	No
OverwriteExistingStaticDataLists	Boolean	Indicates whether existing static data lists should be overwritten	No
SaveLibraryItemsAsOrdinary	Boolean	Indicates whether library items should be saved as ordinary	No

Returns

An instance of type ProcessImportError2 containing any warnings and errors that may have occurred during the import and whether thread pools were imported

Name	Type	Comment
ThreadPoolsImported	Boolean	Indicates whether thread pools were also imported
FileName	String	Will contain whatever was in processToImport->FileName
Process	Identity	Id, Name and Version of the imported process
Warnings	Collection	A collection of ImportWarningsInfo that have the details of each warning caused by the import
Errors	Collection	A collection of ImportErrorsInfo that have the details of each error caused by the import

Import warnings info

Name	Type	Comment
ImportWarningType	Int16	The type of warning
Warnings	Collection	A collection of strings that contain the warning messages

Import errors info

Name	Type	Comment
ImportErrorType	Int16	The type of error
FailedReason	String	Message that explains the failure
Errors	Collection	A collection of strings that contain the error messages

Remarks: At least one member of importOptions must be specified

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

ProcessImportErrorCollection ImportProcesses	(	string	sessionId,
		ExportedProcessCollection	processesToImport,
		ProcessImportOptions	importOptions
	)

This function is deprecated. Please use Services.ServerService.ImportPackage3 instead.
Imports the specified processes using the given import options.

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.

processesToImport

A collection of type ExportedProcess that specify each process to be imported

Name	Type	Comment	Required
Xml	String	Xml of the process	Yes
Filename	String	Not used	No
Process	Identity	Not used	No

importOptions

A ProcessImportOptions object containing the import options that need to be considered while importing.

Name	Type	Comment	Required
ImportCategories	Boolean	Indicates whether categories should be imported	No
ImportResources	Boolean	Indicates whether resources should be imported	No
ImportGroupsWithResourceMembers	Boolean	Indicates whether groups with resource members should be imported	No
OverwriteExistingWQDefinitions	Boolean	Indicates whether existing workqueue definitions should be overwritten	No
OverwriteExistingCheckListData	Boolean	Indicates whether existing check list data should be overwritten	No
OverwriteExistingRoles	Boolean	Indicates whether existing roles should be overwritten	No
OverwriteBusinessRules	Boolean	Indicates whether existing business should be overwritten	No
OverwriteExistingEntityDefinitions	Boolean	Indicates whether existing entity rules should be overwritten	No
OverwriteExistingStaticDataLists	Boolean	Indicates whether existing static data lists should be overwritten	No
SaveLibraryItemsAsOrdinary	Boolean	Indicates whether library items should be saved as ordinary	No

Returns

A collection of type ProcessImportError object containing information about any errros that may have occurred during the import

Name	Type	Comment
FileName	String	Will contain whatever was in `processToImport->FileName`
Process	Identity	Id, Name and Version of the imported process
Warnings	Collection	A collection of ImportWarningsInfo that have the details of each warning caused by the import
Errors	Collection	A collection of ImportErrorsInfo that have the details of each error caused by the import

Import warnings info

Name	Type	Comment
ImportWarningType	Int16	The type of warning
Warnings	Collection	A collection of strings that contain the warning messages

Import errors info

Name	Type	Comment
ImportErrorType	Int16	The type of error
FailedReason	String	Message that explains the failure
Errors	Collection	A collection of strings that contain the error messages

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

ProcessImportErrorCollection ImportProcesses2	(	string	sessionId,
		ExportedProcessData	exportedProcessData,
		ProcessImportOptions2	importOptions
	)

This function is deprecated. Please use ServerService.ImportPackage3 instead.
Imports the specified processes with the specified options.

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.
exportedProcessData	Represents the ExportedProcessData information of an exported process.
importOptions	A ProcessImportOptions2 object containing the import options that need to be considered while importing.

Returns: A ProcessImportErrorCollection collection of type ProcessImportError object containing import error information if any.

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

XpdlImportErrorCollection ImportXpdl	(	string	sessionId,
		string	xpdlToImport
	)

Imports an XPDL from the supplied XML

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.
xpdlToImport	The XPDL to import.

Returns

An instance of type ProcessImportError containing the error/warning information.

Name	Type	Comment
Element	String	The element within the XML that caused the problem
Warning	String	Non-critical error message
Error	String	Critical error message

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

PrecompileResults PrecompileSyncProcesses	(	string	sessionId,
		ProcessIdentityCollection	syncProcesses
	)

This api pre-compiles the synchronous capture processes used in RTTS. The ahead in time compilation improves the start-up performance of RTTS solutions significantly. For more information, consult the RTTS section in KTA documentation

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.

syncProcesses

A ProcessIdentityCollection collection object of processes for which assemblies will be generated. Cannot be null
ProcessIdentity members.

Name	Type	Comment	Required
Id	String	The id of the process map	Yes/No. Either Id or Name needs to be supplied
Name	String	The name of the process map	Yes/No. Either Id or Name needs to be supplied
Version	Double	The version of the process map	No. See Remarks section of this API to get more information.

Returns: Returns a PrecompileResults object which contains an indicator for success/ failure and CompilationErrorCollection of type CompilerError class, if assembly generation fails for any process map.

Security: No restrictions apply.

void ReleaseProcess	(	string	sessionId,
		ProcessIdentity	processIdentity
	)

Releases the process which are in awaiting state and increases the version number to the next whole number.

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.

processIdentity

A ProcessIdentity object containing the process id and version information of the process that needs to be released

Name	Type	Comment	Required
Id	String	Id of the process	Yes - if Name is not specified
Version	Double	The version of the process	Yes
Name	String	Name of the process	Yes - if Id is not specified

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

void ResetQualityCounts ( string sessionId )

Resets the sampling and checking counts to 0 for all processes and jobs.

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.

Security: No restrictions apply.

void UpdateProcessNote	(	string	sessionId,
		ProcessIdentity	processIdentity,
		ProcessNote	processNote
	)

Updates the specified process note with the given details.

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.

processIdentity

A ProcessIdentity object containing the process information for whihc the notes are added

Name	Type	Comment	Required
Id	String	Id of the process	Yes - if Name is not specified
Version	Double	Not used	No
Name	String	Name of the process	Yes - if Id is not specified

processNote

A ProcessNote object containing the process note information that needs to be added to the process.

Name	Type	Comment	Required
Creator	Identity	Note creator's Id and Name	No
CreatedDate	DateTime	Date the note was created	No
Notes	String	Text of the note to be added	Yes
Actioned	Int16	0 - Not actioned, 1 - Actioned	No
ActionedByResource	Identity	Resource that actioned the note	Yes - Id or Name is required if Actioned is set to 1
ActionedDate	DateTime	Date the note was actioned - will be populated automatically if Actioned is set to 1	No
ActionedText	String	Comment added when note was actioned	Yes - If Actioned is set to 1
Identity	Identity	Note's Id.	No

Remarks: Please note that all details will be updated so every field should be populated with the existing if it is not being changed .

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

Public Member Functions

Description

Member Functions