Class ProcessEngineService

The web service that provides access to the IProcessEngine methods.

Inheritance
System.Object
BaseService
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()
Namespace: Terrasoft.Core.ServiceModel
Assembly: Terrasoft.Core.ServiceModel.dll
Syntax
[CoreServiceRoute("/ServiceModel/")]
[CoreServiceRoute("/0/ServiceModel/")]
public class ProcessEngineService : BaseService, IProcessEngineService

Constructors

ProcessEngineService()

Declaration
public ProcessEngineService()

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)

Makes changes to inner state of the running process element.

Declaration
public BaseResponse ChangeProcessElementState(ChangeProcessElementStateRequest request)
Parameters
Type Name Description
ChangeProcessElementStateRequest request
Returns
Type Description
BaseResponse

ChangeToAppropriateDcmInstance(ChangeToAppropriateDcmInstanceRequest)

Changes to appropriate DCM instance.

Declaration
public BaseRunProcessResponse ChangeToAppropriateDcmInstance(ChangeToAppropriateDcmInstanceRequest request)
Parameters
Type Name Description
ChangeToAppropriateDcmInstanceRequest request
Returns
Type Description
BaseRunProcessResponse

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)

Completes executing of specified process element.

Declaration
public CompleteExecutingResponse CompleteExecuting(CompleteExecutingRequest request)
Parameters
Type Name Description
CompleteExecutingRequest request

Instance of the CompleteExecutingRequest.
Returns
Type Description
CompleteExecutingResponse

Instance of the CompleteExecutingResponse.

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
Type Description
DisableProcessResponse

EnableProcess(String)

Declaration
public EnableProcessResponse EnableProcess(string sysSchemaId)
Parameters
Type Name Description
System.String sysSchemaId
Returns
Type Description
EnableProcessResponse

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

ExecuteProcessElementByUIdPost(ExecuteProcessElementRequest)

Declaration
public ExecuteProcessElementResponse ExecuteProcessElementByUIdPost(ExecuteProcessElementRequest request)
Parameters
Type Name Description
ExecuteProcessElementRequest request
Returns
Type Description
ExecuteProcessElementResponse

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
Type Name Description
DcmExecutionDataRequest request

Request.
Returns
Type Description
ProcessExecutionDataResponse

Additional batch data for the opening page.

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
Type Name Description
ProcessExecutionDataRequest request

Request.
Returns
Type Description
ProcessExecutionDataResponse

Additional batch data for the opening page.

GetProcessElementStatus(ProcessElementStatusRequest)

Gets the specified process element running status.

Declaration
public ProcessElementStatusResponse GetProcessElementStatus(ProcessElementStatusRequest request)
Parameters
Type Name Description
ProcessElementStatusRequest request

Request.
Returns
Type Description
ProcessElementStatusResponse

Status of the specified process element.

GetProcessSchemaDebugInfo(String, String, String)

Returns process schema internal information.

Declaration
public void GetProcessSchemaDebugInfo(string schema, string manager, string type)
Parameters
Type Name Description
System.String schema

Schema name or UId.
System.String manager

Manager name.
System.String type

Debug information type.

GetRunningProcessCount(GetRunningProcessCountRequest)

Gets running process count for all process schema versions.

Declaration
[Obsolete("7.18.4 | Method is not in use and will be removed in upcoming releases. Use GetRunningProcessCountResponse GetRunningProcessesCount(GetRunningProcessCountRequest request) instead")]
public int GetRunningProcessCount(GetRunningProcessCountRequest request)
Parameters
Type Name Description
GetRunningProcessCountRequest request

The request with some schema version UId.
Returns
Type Description
System.Int32

The number of running processes for all process schema versions.

GetRunningProcessesCount(GetRunningProcessCountRequest)

Gets running process count for all process schema versions.

Declaration
public GetRunningProcessCountResponse GetRunningProcessesCount(GetRunningProcessCountRequest request)
Parameters
Type Name Description
GetRunningProcessCountRequest request

The request with some schema version UId.
Returns
Type Description
GetRunningProcessCountResponse

The number of running processes for all process schema versions.

GetTimerEventsInfo(Guid)

Gets timer events information.

Declaration
public TimerEventsInfoResponse GetTimerEventsInfo(Guid processSchemaUId)
Parameters
Type Name Description
System.Guid processSchemaUId

UId of process schema.
Returns
Type Description
TimerEventsInfoResponse

Information about timer events.

OpenProcessPage(OpenProcessPageRequest)

Opens process page.

Declaration
public OpenProcessPageResponse OpenProcessPage(OpenProcessPageRequest request)
Parameters
Type Name Description
OpenProcessPageRequest request
Returns
Type Description
OpenProcessPageResponse

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)

Runs process.

Declaration
public RunProcessResponse RunProcess(RunProcessRequest request)
Parameters
Type Name Description
RunProcessRequest request

Run process request.
Returns
Type Description
RunProcessResponse

The result of running process.

RunProcessForEachValue(RunProcessForEachValueRequest)

Runs process for each specified record.

Declaration
public BaseRunProcessResponse RunProcessForEachValue(RunProcessForEachValueRequest request)
Parameters
Type Name Description
RunProcessForEachValueRequest request
Returns
Type Description
BaseRunProcessResponse

RunProcessForMatchingRecords(RunProcessForMatchingRecordsRequest)

Runs process for each record matched with specified filter.

Declaration
public BaseRunProcessResponse RunProcessForMatchingRecords(RunProcessForMatchingRecordsRequest request)
Parameters
Type Name Description
RunProcessForMatchingRecordsRequest request
Returns
Type Description
BaseRunProcessResponse

RunSpecifiedProcessVersion(RunSpecifiedProcessVersionRequest)

Runs the specified process version.

Declaration
public RunProcessResponse RunSpecifiedProcessVersion(RunSpecifiedProcessVersionRequest request)
Parameters
Type Name Description
RunSpecifiedProcessVersionRequest request

The request.
Returns
Type Description
RunProcessResponse

The result of running process.

ThrowSignal(String)

Throws signals.

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