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... | |
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 ExportProcess | ( | string | sessionId, |
ProcessIdentity | processToExport, | ||
ProcessExportOptions | exportOptions | ||
) |
This function is deprecated. Please use ServerService.ExportPackage2 instead.
Exports 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. | ||||||||||||||||
processToExport | A ProcessIdentity object that needs to be exported.
| ||||||||||||||||
exportOptions | A ProcessExportOptions object containing the export options that need to be considered while exporting. |
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 |
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.
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 |
---|---|---|
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 |
true
then Category must be specified and only skins belonging to that ctaegory specifically will be found. 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 foundfalse
- only processes that do not support skining will be found 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.
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 |
---|---|---|
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 |
Name | Type | Comment |
---|---|---|
Value | Double | Value of the budget |
DynamicVariable | Identity | Id and Name of dynamic variable that contains the budget value |
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 foundfalse
- only processes that do not support skining will be found 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.
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 |
---|---|---|
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 |
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 foundfalse
- only processes that do not support skining will be found 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.
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.
|
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.
|
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.
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 |
---|---|---|
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 |
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 GetProcessInitialization | ( | string | sessionId, |
ProcessIdentity | processIdentity | ||
) |
This function is deprecated. Please use GetProcessInitialization2 instead
Retrieves the initialization variables needed 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 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 |
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 |
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.
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.
| ||||||||||||||||||||||||||||||||||||||||||||
importOptions | A ProcessImportOptions object containing the information of the import options to be considered while importing the process.
|
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 |
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.
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.
| ||||||||||||||||||||||||||||||||||||||||||||
importOptions | A ProcessImportOptions object containing the information of the import options to be considered while importing the process.
|
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 |
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.
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
| ||||||||||||||||||||||||||||||||||||||||||||
importOptions | A ProcessImportOptions object containing the import options that need to be considered while importing.
|
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 |
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.
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. |
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.
|