Class ProcessEngineService
The web service that provides access to the methods.
Inheritance
System.Object
ProcessEngineService
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Assembly: Terrasoft.Core.ServiceModel.dll
Syntax
[CoreServiceRoute("/ServiceModel/")]
[CoreServiceRoute("/0/ServiceModel/")]
[ServiceBehavior(Namespace = "http://Terrasoft.WebApp.ServiceModel")]
[AspNetCompatibilityRequirements(RequirementsMode = AspNetCompatibilityRequirementsMode.Required)]
public class ProcessEngineService : BaseService, IProcessEngineService
Properties
CurrentHttpContext
Gets the current HTTP context.
Declaration
protected virtual HttpContext CurrentHttpContext { get; }
Property Value
Type |
Description |
HttpContext |
The current HTTP context.
|
Methods
CancelExecution(Stream)
Cancels process execution.
Declaration
public void CancelExecution(Stream data)
Parameters
Type |
Name |
Description |
System.IO.Stream |
data |
Process identifier list.
|
CancelExecutionBySchemaId(String)
Cancels execution of all processes for all schema versions.
Declaration
public string CancelExecutionBySchemaId(string schemaId)
Parameters
Type |
Name |
Description |
System.String |
schemaId |
The schema unique identifier.
|
Returns
Type |
Description |
System.String |
The response text.
|
ChangeProcessElementState(ChangeProcessElementStateRequest)
Declaration
public BaseResponse ChangeProcessElementState(ChangeProcessElementStateRequest request)
Parameters
Returns
ChangeToAppropriateDcmInstance(ChangeToAppropriateDcmInstanceRequest)
Declaration
public BaseRunProcessResponse ChangeToAppropriateDcmInstance(ChangeToAppropriateDcmInstanceRequest request)
Parameters
Returns
CompleteExecuting(String, String, String)
Completes process element executing.
Declaration
public void CompleteExecuting(string procElUId, string entitySchemaName, string entityId)
Parameters
Type |
Name |
Description |
System.String |
procElUId |
Process element identifier.
|
System.String |
entitySchemaName |
|
System.String |
entityId |
Entity identifier.
|
Exceptions
Type |
Condition |
System.ServiceModel.Web.WebFaultException |
If entity schema not found.
|
CompleteExecuting(CompleteExecutingRequest)
Declaration
public CompleteExecutingResponse CompleteExecuting(CompleteExecutingRequest request)
Parameters
Returns
CompleteExecution(String)
Completes process element execution by the specified identifier.
Declaration
public string CompleteExecution(string procElUId)
Parameters
Type |
Name |
Description |
System.String |
procElUId |
Process element identifier.
|
Returns
Type |
Description |
System.String |
|
Exceptions
Type |
Condition |
System.ServiceModel.Web.WebFaultException |
if process element not found.
|
ContinueExecuting(String)
Continues process executing by the specified identifier.
Declaration
public void ContinueExecuting(string processUId)
Parameters
Type |
Name |
Description |
System.String |
processUId |
The process identifier.
|
ContinueExecutingPost(String, Stream)
Declaration
public void ContinueExecutingPost(string processUId, Stream input)
Parameters
Type |
Name |
Description |
System.String |
processUId |
|
System.IO.Stream |
input |
|
DisableProcess(String)
Declaration
public DisableProcessResponse DisableProcess(string sysSchemaId)
Parameters
Type |
Name |
Description |
System.String |
sysSchemaId |
|
Returns
EnableProcess(String)
Declaration
public EnableProcessResponse EnableProcess(string sysSchemaId)
Parameters
Type |
Name |
Description |
System.String |
sysSchemaId |
|
Returns
ExecuteProcess(String)
Declaration
public void ExecuteProcess(string processSchemaName)
Parameters
Type |
Name |
Description |
System.String |
processSchemaName |
|
ExecuteProcessByCaptionPost(Stream)
Declaration
public void ExecuteProcessByCaptionPost(Stream input)
Parameters
Type |
Name |
Description |
System.IO.Stream |
input |
|
ExecuteProcessByUId(String)
Declaration
public void ExecuteProcessByUId(string processSchemaUId)
Parameters
Type |
Name |
Description |
System.String |
processSchemaUId |
|
ExecuteProcessByUIdPost(String, Stream)
Declaration
public void ExecuteProcessByUIdPost(string processSchemaUId, Stream input)
Parameters
Type |
Name |
Description |
System.String |
processSchemaUId |
|
System.IO.Stream |
input |
|
ExecuteProcessElementByUId(String)
Executes process element by the specified identifier.
Declaration
public void ExecuteProcessElementByUId(string procElUId)
Parameters
Type |
Name |
Description |
System.String |
procElUId |
Process element identifier.
|
Exceptions
Type |
Condition |
System.ServiceModel.Web.WebFaultException |
|
ExecuteProcessPost(String, Stream)
Declaration
public void ExecuteProcessPost(string processSchemaName, Stream input)
Parameters
Type |
Name |
Description |
System.String |
processSchemaName |
|
System.IO.Stream |
input |
|
ExecuteProcessWithResult(String, String)
Declaration
public string ExecuteProcessWithResult(string processSchemaName, string resultParameterName)
Parameters
Type |
Name |
Description |
System.String |
processSchemaName |
|
System.String |
resultParameterName |
|
Returns
Type |
Description |
System.String |
|
ExecuteProcessWithResultPost(String, String, Stream)
Declaration
public string ExecuteProcessWithResultPost(string processSchemaName, string resultParameterName, Stream input)
Parameters
Type |
Name |
Description |
System.String |
processSchemaName |
|
System.String |
resultParameterName |
|
System.IO.Stream |
input |
|
Returns
Type |
Description |
System.String |
|
GetDcmExecutionData(DcmExecutionDataRequest)
Returns data for the opening page by the specified dcm elements.
Declaration
public ProcessExecutionDataResponse GetDcmExecutionData(DcmExecutionDataRequest request)
Parameters
Returns
GetExecutionData(String, String)
Returns additional data for the opening page.
Declaration
public string GetExecutionData(string elementUId, string recordId)
Parameters
Type |
Name |
Description |
System.String |
elementUId |
Identifier of the process element.
|
System.String |
recordId |
Identifier of the entity.
|
Returns
Type |
Description |
System.String |
String that contains additional data for the opening page.
|
GetExecutionData(ProcessExecutionDataRequest)
Returns data for the opening page by the specified elements.
Declaration
public ProcessExecutionDataResponse GetExecutionData(ProcessExecutionDataRequest request)
Parameters
Returns
GetProcessElementStatus(ProcessElementStatusRequest)
Gets the specified process element running status.
Declaration
public ProcessElementStatusResponse GetProcessElementStatus(ProcessElementStatusRequest request)
Parameters
Returns
GetProcessSchemaDebugInfo(String, String, String)
Declaration
public void GetProcessSchemaDebugInfo(string schema, string manager, string type)
Parameters
Type |
Name |
Description |
System.String |
schema |
|
System.String |
manager |
|
System.String |
type |
|
GetRunningProcessCount(GetRunningProcessCountRequest)
Gets running process count for all process schema versions.
Declaration
public int GetRunningProcessCount(GetRunningProcessCountRequest request)
Parameters
Returns
Type |
Description |
System.Int32 |
The number of running processes.
|
GetTimerEventsInfo(Guid)
Gets timer events information.
Declaration
public TimerEventsInfoResponse GetTimerEventsInfo(Guid processSchemaUId)
Parameters
Type |
Name |
Description |
System.Guid |
processSchemaUId |
UId of process schema.
|
Returns
RunProcess(String)
Runs process by the specified name.
Declaration
public string RunProcess(string processName)
Parameters
Type |
Name |
Description |
System.String |
processName |
Process schema name.
|
Returns
Type |
Description |
System.String |
|
RunProcess(RunProcessRequest)
Declaration
public RunProcessResponse RunProcess(RunProcessRequest request)
Parameters
Returns
RunProcessForEachValue(RunProcessForEachValueRequest)
Declaration
public BaseRunProcessResponse RunProcessForEachValue(RunProcessForEachValueRequest request)
Parameters
Returns
Declaration
public BaseRunProcessResponse RunProcessForMatchingRecords(RunProcessForMatchingRecordsRequest request)
Parameters
Returns
RunSpecifiedProcessVersion(RunSpecifiedProcessVersionRequest)
Runs the specified process version.
Declaration
public RunProcessResponse RunSpecifiedProcessVersion(RunSpecifiedProcessVersionRequest request)
Parameters
Returns
ThrowSignal(String)
Declaration
public void ThrowSignal(string signal)
Parameters
Type |
Name |
Description |
System.String |
signal |
Signal name.
|
ThrowSignalPost(String, Stream)
Declaration
public void ThrowSignalPost(string signal, Stream input)
Parameters
Type |
Name |
Description |
System.String |
signal |
|
System.IO.Stream |
input |
|
Implements
Extension Methods
See Also