All Classes Namespaces Functions Properties Pages
Public Member Functions | List of all members
ProcessService Class Reference

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 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...
 
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...
 
ProcessInfo2 GetProcessInfo2 (string sessionId, ProcessIdentity processIdentity, short processInfoFilter)
 Retrieves the process info for the specified process. Optionally also returns annotations and attachments. 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...
 
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
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
processIdentityA 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
processNoteA 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 ExportProcesses ( string  sessionId,
ProcessIdentityCollection  processesToExport,
ProcessExportOptions  exportOptions 
)

Exports multiple selected business processes into a single exported file.

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
processesToExportA 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
exportOptionsA 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
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
processIdentityA 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.
ProcessIdentityCollection GetProcessesSummary ( string  sessionId,
ProcessesSummaryFilter  processesSummaryFilter 
)

Gets the processes for the specified filter criteria.

Parameters
sessionIdA string that uniquely identifies the Session for the current logged-on user. If the SessionId is invalid, an exception is raised.
processesSummaryFilterA 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
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
processIdentityA 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.
ProcessInfo2 GetProcessInfo2 ( string  sessionId,
ProcessIdentity  processIdentity,
short  processInfoFilter 
)

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

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
processIdentityA 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
processInfoFilterIndiacates 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 GetProcessInitialization2 ( string  sessionId,
ProcessIdentity  processIdentity,
ProcessInitializationOptions  initializationOptions 
)

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

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
processIdentityA 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
initializationOptionsA 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
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
processIdentityA 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
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
processIdentityA 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
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
processIdentityA 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.
XpdlImportErrorCollection ImportXpdl ( string  sessionId,
string  xpdlToImport 
)

Imports an XPDL from the supplied XML

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
xpdlToImportThe 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
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
syncProcessesA 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
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
processIdentityA 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
sessionIdA 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
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
processIdentityA 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
processNoteA 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.