Assembly: OptimaJet.Workflow.Core

Class CreateInstanceParams

OptimaJet.Workflow.Core.Runtime.CreateInstanceParams

Provides parameters for creating a process instance.

Namespace: OptimaJet.Workflow.Core.Runtime

public class CreateInstanceParams

Constructors

public CreateInstanceParams(string schemeCode, Guid processId) #
Initializes a new instance of the CreateInstanceParams class.

Parameters

Name
Type
Description
schemeCode
String
The code of the scheme that will be used to create the instance.
processId
Guid
The identifier of the process instance.

Properties

public string SchemeCode { get; set; } #
Gets or sets the code of the scheme used to create the process instance.
public Guid ProcessId { get; set; } #
Gets or sets the identifier of the process instance.
public string IdentityId { get; set; } #
Gets or sets the workflow participant identity that initiates execution of the initial command, if one exists.
public string ImpersonatedIdentityId { get; set; } #
Gets or sets the workflow participant identity on whose behalf the initial command is executed.
public IDictionary<string, object> InitialProcessParameters { get; set; } #
Gets or sets the initial parameters passed to the new process instance.
public string TenantId { get; set; } #
Gets or sets an optional tenant identifier.
public List<string> Persist { get; set; } #
Gets or sets the names of initial parameters that should be persisted.
public string CalendarName { get; set; } #
Gets or sets the work calendar name used by the process instance.

Methods

public CreateInstanceParams AddPersistentParameter(string name, object value) #
Adds an initial process parameter and marks it as persistent.

Parameters

Name
Type
Description
name
String
The parameter name.
value
Object
The value to assign to the parameter.

Returns

Type
Description
CreateInstanceParams
The same CreateInstanceParams instance.
public CreateInstanceParams AddTemporaryParameter(string name, object value) #
Adds an initial process parameter that is not marked as persistent.

Parameters

Name
Type
Description
name
String
The parameter name.
value
Object
The value to assign to the parameter.

Returns

Type
Description
CreateInstanceParams
The same CreateInstanceParams instance.