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... | |
Provides methods to manage processes, configure process properties, and return process information.
void AddProcessNote | ( | string | sessionId, |
ProcessIdentity | processIdentity, | ||
ProcessNote | processNote | ||
) |
Adds a design note to the specified process.
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
| ||||||||||||||||||||||||||||||||||||
processNote | A ProcessNote object containing the process note information that needs to be added to the process.
|
ExportedProcessCollection ExportProcesses | ( | string | sessionId, |
ProcessIdentityCollection | processesToExport, | ||
ProcessExportOptions | exportOptions | ||
) |
Exports multiple selected business processes into a single exported file.
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.
| ||||||||||||||||
exportOptions | A ProcessExportOptions object containing the export options that need to be considered while exporting. |
ProcessIdentityCollection GetCaseDefinitionAssociatedProcesses | ( | string | sessionId, |
ProcessIdentity | processIdentity | ||
) |
Retrieves the associated business processes for the specified case definition.
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 |
---|---|---|
Id | String | Id of the process |
Version | Double | The version of the process |
Name | String | Name of the process |
ProcessIdentityCollection GetProcessesSummary | ( | string | sessionId, |
ProcessesSummaryFilter | processesSummaryFilter | ||
) |
Gets the processes for the specified filter criteria.
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.
|
string GetProcessHelpText | ( | string | sessionId, |
ProcessIdentity | processIdentity | ||
) |
Retrieves the help text for a specified business process.
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.
|
ProcessInfo2 GetProcessInfo2 | ( | string | sessionId, |
ProcessIdentity | processIdentity, | ||
short | processInfoFilter | ||
) |
Retrieves the process info for the specified process. Optionally also returns annotations and attachments.
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.
| ||||||||||||||||
processInfoFilter | Indiacates whether annotations and attachments should be retrieved.
|
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 |
ProcessInitialization GetProcessInitialization2 | ( | string | sessionId, |
ProcessIdentity | processIdentity, | ||
ProcessInitializationOptions | initializationOptions | ||
) |
Retrieves the initialization variables needed for the specified process based on the given options
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.
| ||||||||||||||||
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 |
---|---|---|
InputVariables | Collection | A collection of ProcessInputVariable that have the details of each initialization variable |
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 |
MilestoneSummaryCollection GetProcessMilestones | ( | string | sessionId, |
ProcessIdentity | processIdentity | ||
) |
Retrieves the process milestones for the specified process.
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.
|
ProcessNoteCollection GetProcessNotes | ( | string | sessionId, |
ProcessIdentity | processIdentity | ||
) |
Gets the notes/comments related to the passed in Process.
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 |
---|---|---|
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 |
StateIdentityCollection GetProcessStatesSummary | ( | string | sessionId, |
ProcessIdentity | processIdentity | ||
) |
Retrieves all states defined for the specified process.
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 |
---|---|---|
Name | String | Name of the state |
XpdlImportErrorCollection ImportXpdl | ( | string | sessionId, |
string | xpdlToImport | ||
) |
Imports an XPDL from the supplied XML
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. |
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 |
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
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.
|
void ReleaseProcess | ( | string | sessionId, |
ProcessIdentity | processIdentity | ||
) |
Releases the process which are in awaiting state and increases the version number to the next whole number.
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
|
void ResetQualityCounts | ( | string | sessionId | ) |
Resets the sampling and checking counts to 0 for all processes and jobs.
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. |
void UpdateProcessNote | ( | string | sessionId, |
ProcessIdentity | processIdentity, | ||
ProcessNote | processNote | ||
) |
Updates the specified process note with the given details.
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
| ||||||||||||||||||||||||||||||||||||
processNote | A ProcessNote object containing the process note information that needs to be added to the process.
|