Class WorkflowInstanceTableInfo
Table 'workflow_instance': A set of properties related to the workflow instance of one participant going through the flow
Implements
Inherited Members
Namespace: SuperOffice.CRM.Data
Assembly: SoDataBase.dll
Syntax
[DatabaseTable("workflow_instance")]
public class WorkflowInstanceTableInfo : TableInfo, ICloneable
Remarks
An instance of this class represents one instance of this table in an SQL statement. In most
cases each table appears only once in a SELECT, but in cases where you need to self-join, or
there are multiple occurrences for other reasons (typically additional restrictions in the joins),
then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetWorkflowInstanceInfo().
Fields
DictionaryTableName
Conceptual name of table WorkflowInstance in the database dictionary: workflow_instance
Declaration
public const string DictionaryTableName = "workflow_instance"
Field Value
Type | Description |
---|---|
string |
Remarks
An instance of this class represents one instance of this table in an SQL statement. In most
cases each table appears only once in a SELECT, but in cases where you need to self-join, or
there are multiple occurrences for other reasons (typically additional restrictions in the joins),
then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetWorkflowInstanceInfo().
Properties
ContactId
Field 'contact_id' in table 'workflow_instance': Dictionary type FK, target: Contact, .NET type: int
Contact ID of contact contact going through the flowDeclaration
public Int32FieldInfo ContactId { get; }
Property Value
Type | Description |
---|---|
Int32FieldInfo |
Remarks
An instance of this class represents one instance of this table in an SQL statement. In most
cases each table appears only once in a SELECT, but in cases where you need to self-join, or
there are multiple occurrences for other reasons (typically additional restrictions in the joins),
then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetWorkflowInstanceInfo().
ContactId_InnerJoin_Contact
Generated join from the foreign key ContactId in this table, to its target table ContactTableInfo.
Declaration
public TargetedInnerJoin<ContactTableInfo> ContactId_InnerJoin_Contact { get; }
Property Value
Type | Description |
---|---|
TargetedInnerJoin<ContactTableInfo> |
Remarks
An instance of this class represents one instance of this table in an SQL statement. In most
cases each table appears only once in a SELECT, but in cases where you need to self-join, or
there are multiple occurrences for other reasons (typically additional restrictions in the joins),
then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetWorkflowInstanceInfo().
CurrentStep
Field 'current_step' in table 'workflow_instance': Dictionary type FK, target: WorkflowStep, .NET type: int
Next step to be executed when conditions are metDeclaration
public Int32FieldInfo CurrentStep { get; }
Property Value
Type | Description |
---|---|
Int32FieldInfo |
Remarks
An instance of this class represents one instance of this table in an SQL statement. In most
cases each table appears only once in a SELECT, but in cases where you need to self-join, or
there are multiple occurrences for other reasons (typically additional restrictions in the joins),
then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetWorkflowInstanceInfo().
CurrentStep_InnerJoin_WorkflowStep
Generated join from the foreign key CurrentStep in this table, to its target table WorkflowStepTableInfo.
Declaration
public TargetedInnerJoin<WorkflowStepTableInfo> CurrentStep_InnerJoin_WorkflowStep { get; }
Property Value
Type | Description |
---|---|
TargetedInnerJoin<WorkflowStepTableInfo> |
Remarks
An instance of this class represents one instance of this table in an SQL statement. In most
cases each table appears only once in a SELECT, but in cases where you need to self-join, or
there are multiple occurrences for other reasons (typically additional restrictions in the joins),
then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetWorkflowInstanceInfo().
Definition
Definition of the table as described in the deployed runtime dictionary
Declaration
public override SoTable Definition { get; }
Property Value
Type | Description |
---|---|
SoTable |
Overrides
Remarks
An instance of this class represents one instance of this table in an SQL statement. In most
cases each table appears only once in a SELECT, but in cases where you need to self-join, or
there are multiple occurrences for other reasons (typically additional restrictions in the joins),
then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetWorkflowInstanceInfo().
DictionaryTableNumber
Table number for table WorkflowInstance in the database dictionary; potentially changes between databases, but always the same over the lifetime of any single database
Declaration
public int DictionaryTableNumber { get; }
Property Value
Type | Description |
---|---|
int |
Remarks
An instance of this class represents one instance of this table in an SQL statement. In most
cases each table appears only once in a SELECT, but in cases where you need to self-join, or
there are multiple occurrences for other reasons (typically additional restrictions in the joins),
then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetWorkflowInstanceInfo().
DropoutReason
Field 'dropout_reason' in table 'workflow_instance': Dictionary type String[256], .NET type: string
Reason for dropout/failureDeclaration
public StringFieldInfo DropoutReason { get; }
Property Value
Type | Description |
---|---|
StringFieldInfo |
Remarks
An instance of this class represents one instance of this table in an SQL statement. In most
cases each table appears only once in a SELECT, but in cases where you need to self-join, or
there are multiple occurrences for other reasons (typically additional restrictions in the joins),
then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetWorkflowInstanceInfo().
LastCommunicationStep
Field 'last_communication_step' in table 'workflow_instance': Dictionary type FK, target: WorkflowStep, .NET type: int
Last completed step with email/sms to customerDeclaration
public Int32FieldInfo LastCommunicationStep { get; }
Property Value
Type | Description |
---|---|
Int32FieldInfo |
Remarks
An instance of this class represents one instance of this table in an SQL statement. In most
cases each table appears only once in a SELECT, but in cases where you need to self-join, or
there are multiple occurrences for other reasons (typically additional restrictions in the joins),
then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetWorkflowInstanceInfo().
LastCommunicationStep_InnerJoin_WorkflowStep
Generated join from the foreign key LastCommunicationStep in this table, to its target table WorkflowStepTableInfo.
Declaration
public TargetedInnerJoin<WorkflowStepTableInfo> LastCommunicationStep_InnerJoin_WorkflowStep { get; }
Property Value
Type | Description |
---|---|
TargetedInnerJoin<WorkflowStepTableInfo> |
Remarks
An instance of this class represents one instance of this table in an SQL statement. In most
cases each table appears only once in a SELECT, but in cases where you need to self-join, or
there are multiple occurrences for other reasons (typically additional restrictions in the joins),
then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetWorkflowInstanceInfo().
LeftOuterJoin_SShipmentAddr_WorkflowInstanceId
Generated left outer join from the primary key WorkflowInstanceId on this table, to SShipmentAddr.WorkflowInstanceId.
Declaration
public TargetedLeftOuterJoin<SShipmentAddrTableInfo> LeftOuterJoin_SShipmentAddr_WorkflowInstanceId { get; }
Property Value
Type | Description |
---|---|
TargetedLeftOuterJoin<SShipmentAddrTableInfo> |
Remarks
An instance of this class represents one instance of this table in an SQL statement. In most
cases each table appears only once in a SELECT, but in cases where you need to self-join, or
there are multiple occurrences for other reasons (typically additional restrictions in the joins),
then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetWorkflowInstanceInfo().
PersonId
Field 'person_id' in table 'workflow_instance': Dictionary type FK, target: Person, .NET type: int
Person ID of person going through the flowDeclaration
public Int32FieldInfo PersonId { get; }
Property Value
Type | Description |
---|---|
Int32FieldInfo |
Remarks
An instance of this class represents one instance of this table in an SQL statement. In most
cases each table appears only once in a SELECT, but in cases where you need to self-join, or
there are multiple occurrences for other reasons (typically additional restrictions in the joins),
then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetWorkflowInstanceInfo().
PersonId_InnerJoin_Person
Generated join from the foreign key PersonId in this table, to its target table PersonTableInfo.
Declaration
public TargetedInnerJoin<PersonTableInfo> PersonId_InnerJoin_Person { get; }
Property Value
Type | Description |
---|---|
TargetedInnerJoin<PersonTableInfo> |
Remarks
An instance of this class represents one instance of this table in an SQL statement. In most
cases each table appears only once in a SELECT, but in cases where you need to self-join, or
there are multiple occurrences for other reasons (typically additional restrictions in the joins),
then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetWorkflowInstanceInfo().
Registered
Field 'registered' in table 'workflow_instance': Dictionary type UtcDateTime, .NET type: DateTime
Registered whenDeclaration
public DateTimeFieldInfo Registered { get; }
Property Value
Type | Description |
---|---|
DateTimeFieldInfo |
Remarks
An instance of this class represents one instance of this table in an SQL statement. In most
cases each table appears only once in a SELECT, but in cases where you need to self-join, or
there are multiple occurrences for other reasons (typically additional restrictions in the joins),
then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetWorkflowInstanceInfo().
RegisteredAssociateId
Field 'registered_associate_id' in table 'workflow_instance': Dictionary type FK, target: Associate, .NET type: int
Registered by whomDeclaration
public Int32FieldInfo RegisteredAssociateId { get; }
Property Value
Type | Description |
---|---|
Int32FieldInfo |
Remarks
An instance of this class represents one instance of this table in an SQL statement. In most
cases each table appears only once in a SELECT, but in cases where you need to self-join, or
there are multiple occurrences for other reasons (typically additional restrictions in the joins),
then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetWorkflowInstanceInfo().
RegisteredAssociateId_InnerJoin_Associate
Generated join from the foreign key RegisteredAssociateId in this table, to its target table AssociateTableInfo.
Declaration
public TargetedInnerJoin<AssociateTableInfo> RegisteredAssociateId_InnerJoin_Associate { get; }
Property Value
Type | Description |
---|---|
TargetedInnerJoin<AssociateTableInfo> |
Remarks
An instance of this class represents one instance of this table in an SQL statement. In most
cases each table appears only once in a SELECT, but in cases where you need to self-join, or
there are multiple occurrences for other reasons (typically additional restrictions in the joins),
then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetWorkflowInstanceInfo().
RuntimeDefinition
Definition of the table as described in the deployed runtime dictionary
Declaration
[Obsolete("Use instance property Definition or static member DictionaryTableNumber", true)]
public static SoTable RuntimeDefinition { get; }
Property Value
Type | Description |
---|---|
SoTable |
Remarks
An instance of this class represents one instance of this table in an SQL statement. In most
cases each table appears only once in a SELECT, but in cases where you need to self-join, or
there are multiple occurrences for other reasons (typically additional restrictions in the joins),
then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetWorkflowInstanceInfo().
Status
Field 'status' in table 'workflow_instance': Dictionary type Enum, .NET type: WorkflowInstanceStatus
Status of the workflow instanceDeclaration
public WorkflowInstanceStatusFieldInfo Status { get; }
Property Value
Type | Description |
---|---|
WorkflowInstanceStatusFieldInfo |
Remarks
An instance of this class represents one instance of this table in an SQL statement. In most
cases each table appears only once in a SELECT, but in cases where you need to self-join, or
there are multiple occurrences for other reasons (typically additional restrictions in the joins),
then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetWorkflowInstanceInfo().
StepLevel
Field 'step_level' in table 'workflow_instance': Dictionary type Int, .NET type: int
Some steps have multiple levels, this indicates what level is reachedDeclaration
public Int32FieldInfo StepLevel { get; }
Property Value
Type | Description |
---|---|
Int32FieldInfo |
Remarks
An instance of this class represents one instance of this table in an SQL statement. In most
cases each table appears only once in a SELECT, but in cases where you need to self-join, or
there are multiple occurrences for other reasons (typically additional restrictions in the joins),
then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetWorkflowInstanceInfo().
StepStarted
Field 'step_started' in table 'workflow_instance': Dictionary type DateTime, .NET type: DateTime
The currently executing step was started at this timeDeclaration
public DateTimeFieldInfo StepStarted { get; }
Property Value
Type | Description |
---|---|
DateTimeFieldInfo |
Remarks
An instance of this class represents one instance of this table in an SQL statement. In most
cases each table appears only once in a SELECT, but in cases where you need to self-join, or
there are multiple occurrences for other reasons (typically additional restrictions in the joins),
then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetWorkflowInstanceInfo().
Updated
Field 'updated' in table 'workflow_instance': Dictionary type UtcDateTime, .NET type: DateTime
Last updated whenDeclaration
public DateTimeFieldInfo Updated { get; }
Property Value
Type | Description |
---|---|
DateTimeFieldInfo |
Remarks
An instance of this class represents one instance of this table in an SQL statement. In most
cases each table appears only once in a SELECT, but in cases where you need to self-join, or
there are multiple occurrences for other reasons (typically additional restrictions in the joins),
then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetWorkflowInstanceInfo().
UpdatedAssociateId
Field 'updated_associate_id' in table 'workflow_instance': Dictionary type FK, target: Associate, .NET type: int
Last updated by whomDeclaration
public Int32FieldInfo UpdatedAssociateId { get; }
Property Value
Type | Description |
---|---|
Int32FieldInfo |
Remarks
An instance of this class represents one instance of this table in an SQL statement. In most
cases each table appears only once in a SELECT, but in cases where you need to self-join, or
there are multiple occurrences for other reasons (typically additional restrictions in the joins),
then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetWorkflowInstanceInfo().
UpdatedAssociateId_InnerJoin_Associate
Generated join from the foreign key UpdatedAssociateId in this table, to its target table AssociateTableInfo.
Declaration
public TargetedInnerJoin<AssociateTableInfo> UpdatedAssociateId_InnerJoin_Associate { get; }
Property Value
Type | Description |
---|---|
TargetedInnerJoin<AssociateTableInfo> |
Remarks
An instance of this class represents one instance of this table in an SQL statement. In most
cases each table appears only once in a SELECT, but in cases where you need to self-join, or
there are multiple occurrences for other reasons (typically additional restrictions in the joins),
then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetWorkflowInstanceInfo().
UpdatedCount
Field 'updatedCount' in table 'workflow_instance': Dictionary type UShort, .NET type: short
Number of updates made to this recordDeclaration
public UInt16FieldInfo UpdatedCount { get; }
Property Value
Type | Description |
---|---|
UInt16FieldInfo |
Remarks
An instance of this class represents one instance of this table in an SQL statement. In most
cases each table appears only once in a SELECT, but in cases where you need to self-join, or
there are multiple occurrences for other reasons (typically additional restrictions in the joins),
then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetWorkflowInstanceInfo().
Variables
Field 'variables' in table 'workflow_instance': Dictionary type Clob, .NET type: string
Instance data and variablesDeclaration
public StringFieldInfo Variables { get; }
Property Value
Type | Description |
---|---|
StringFieldInfo |
Remarks
An instance of this class represents one instance of this table in an SQL statement. In most
cases each table appears only once in a SELECT, but in cases where you need to self-join, or
there are multiple occurrences for other reasons (typically additional restrictions in the joins),
then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetWorkflowInstanceInfo().
WaitUntil
Field 'wait_until' in table 'workflow_instance': Dictionary type DateTime, .NET type: DateTime
Don't evaluate conditions until given time (set by a waiting step, and status Suspended). An event may change the wait_until or status to Running.Declaration
public DateTimeFieldInfo WaitUntil { get; }
Property Value
Type | Description |
---|---|
DateTimeFieldInfo |
Remarks
An instance of this class represents one instance of this table in an SQL statement. In most
cases each table appears only once in a SELECT, but in cases where you need to self-join, or
there are multiple occurrences for other reasons (typically additional restrictions in the joins),
then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetWorkflowInstanceInfo().
WorkflowId
Field 'workflow_id' in table 'workflow_instance': Dictionary type FK, target: Workflow, .NET type: int
The flow this instance belongs toDeclaration
public Int32FieldInfo WorkflowId { get; }
Property Value
Type | Description |
---|---|
Int32FieldInfo |
Remarks
An instance of this class represents one instance of this table in an SQL statement. In most
cases each table appears only once in a SELECT, but in cases where you need to self-join, or
there are multiple occurrences for other reasons (typically additional restrictions in the joins),
then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetWorkflowInstanceInfo().
WorkflowId_InnerJoin_Workflow
Generated join from the foreign key WorkflowId in this table, to its target table WorkflowTableInfo.
Declaration
public TargetedInnerJoin<WorkflowTableInfo> WorkflowId_InnerJoin_Workflow { get; }
Property Value
Type | Description |
---|---|
TargetedInnerJoin<WorkflowTableInfo> |
Remarks
An instance of this class represents one instance of this table in an SQL statement. In most
cases each table appears only once in a SELECT, but in cases where you need to self-join, or
there are multiple occurrences for other reasons (typically additional restrictions in the joins),
then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetWorkflowInstanceInfo().
WorkflowInstanceId
Field 'workflow_instance_id' in table 'workflow_instance': Dictionary type PK, .NET type: int
Primary keyDeclaration
public Int32FieldInfo WorkflowInstanceId { get; }
Property Value
Type | Description |
---|---|
Int32FieldInfo |
Remarks
An instance of this class represents one instance of this table in an SQL statement. In most
cases each table appears only once in a SELECT, but in cases where you need to self-join, or
there are multiple occurrences for other reasons (typically additional restrictions in the joins),
then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetWorkflowInstanceInfo().