Workflow Entities

Workflow

  • Name
    id
    Type
    uuid
    Description

    ID of the workflow

  • Name
    label
    Type
    string
    Description

    Workflow name

  • Name
    description
    Type
    string
    Description

    Workflow description

  • Name
    steps
    Type
    WorkflowStep[]
    Description

    An array of the steps in this workflow

Workflow Step

  • Name
    id
    Type
    uuid
    Description

    ID of the step

  • Name
    workflowId
    Type
    uuid
    Description

    ID of the workflow this step belongs to

  • Name
    label
    Type
    string
    Description

    Step name

  • Name
    type
    Type
    WorkflowStepType
    Description

    Step type

  • Name
    nextStepLinks
    Type
    WorkflowStepLink[]
    Description

    An array of the direct links from this step to the next step(s) in the workflow. In the case of branched workflows, this array can contain multiple links

  • Name
    previousStepLinks
    Type
    WorkflowStepLink[]
    Description

    An array of the direct links to this step from previous step(s) in the workflow

  • Name
    stepFields
    Type
    WorkflowStepField[]
    Description

    An array of fields which can be captured at this step

  • Name
    workflowCustomStepRequirements
    Type
    WorkflowCustomStepRequirement[]
    Description

    An array of the requirements which must be met at this step

  • Name
    workflowCustomStepTriggers
    Type
    WorkflowCustomStepTrigger[]
    Description

    An array of the triggers to be executed at this step (This is where the webhook will be defined to inform the external system of updates)

  • Name
    id
    Type
    uuid
    Description

    ID of the link

  • Name
    fromStepId
    Type
    uuid
    Description

    The ID of the step the link belongs to

  • Name
    toStepId
    Type
    uuid | null
    Description

    The ID of the step we're linking to

  • Name
    position
    Type
    int
    Description

    Position of the fromStep within the workflow

  • Name
    parallelPosition
    Type
    int
    Description

    Used to maintain the ordering of parallel steps in branched workflows when rendering

Workflow Step Trigger

  • Name
    id
    Type
    uuid
    Description

    ID of the trigger

  • Name
    workflowStepId
    Type
    uuid
    Description

    ID of the step the trigger is attached to

  • Name
    additionalData
    Type
    object
    Description

    Object containing descriptive data about the trigger, used mostly for frontend display on the delio platform

  • Name
    leadingEdge
    Type
    boolean
    Description

    Defines if the trigger is executed when an investor "arrives" at the step (true), or when they progress from the step (false)

  • Name
    customTrigger
    Type
    object
    Description

    Object containing the name of the class to be executed by the trigger. List here

Workflow Step Requirement

  • Name
    id
    Type
    uuid
    Description

    ID of the requirement

  • Name
    workflowStepId
    Type
    uuid
    Description

    ID of the step the requirement is attached to

  • Name
    displayData
    Type
    json
    Description

    Object containing additional data, used mostly for frontend display on the delio platform

  • Name
    optional
    Type
    boolean
    Description

    Used to define a requirement as optional

  • Name
    leadingEdge
    Type
    boolean
    Description

    Defines if the requirement must be met for an investor to "arrive" at the step (true), or to progress from the step (false)

  • Name
    customRequirement
    Type
    object
    Description

    Object containing the className for the logic used to perform the check. List here

Workflow Step Field

  • Name
    id
    Type
    uuid
    Description

    ID of the field

  • Name
    fieldKey
    Type
    string
    Description

    Field key, for the workflow event data object

  • Name
    required
    Type
    boolean
    Description

    Is the field required (true), or optional (false)

Workflow Event

  • Name
    id
    Type
    uuid
    Description

    ID of the event

  • Name
    investorUserId
    Type
    uuid
    Description

    The transaction management user ID of the investor the event relates to

  • Name
    dealId
    Type
    uuid
    Description

    ID of the deal the event relates to

  • Name
    fromStepId
    Type
    uuid
    Description

    ID of the workflow step that the investor was at before this event

  • Name
    toStepId
    Type
    uuid
    Description

    ID of the workflow step this event relates to

  • Name
    data
    Type
    WorkflowEventDataObject
    Description

    Object containing data captured at toStep, as defined by its stepFields

  • Name
    createdAt
    Type
    Date
    Description

    Date created

  • Name
    createdByUserId
    Type
    uuid
    Description

    Transaction management user ID of the user who created this event

Types

Workflow Step Types

default - a standard workflow step

kyc - a step containing a KYC integration

branch_split - a step denoting the start of a branch

branch_parallel - one of the parallel sections of a branched workflow


Workflow Event Data Object

Workflow event data objects have the following structure

{
    "{key}": string
}

where key is one of the following

committed_amount - used to capture the investors commitment

confirmed_amount - used to capture the confirmed investment amount

effective_date - used to capture the date of the event, if it will differ from the date the event was created

currency_code - the currency used for the transaction, this should be the same as the currency specified for the deal

progress_to_step_id - used by branched workflows to capture the branch chosen to progress through


Trigger classes

DocumentRelease - Grants access to documents associated with this step

AutomaticallyProgressInvestorWithValidKyc - Used with KYC steps, to automatically skip the step for investors who have already completed the KYC process.

CreateFormImplementationForInvestor - Used by steps implementing custom data capture, to initialise the form for the investor when they arrive at the appropriate step.

GenerateDocumentFromTemplate - Used by steps implementing custom data capture with document generation, to generate a document from a specified template

StepInformationBanner - Used to display information to investors at this step within the Delio platform.

ProgressInvestorToSelectedBranch - Used by branched workflows, to automatically progress an investor down the branch they selected.

ProgressInvestorToConditionalBranch - Used by branched workflwos, to automatically progress an investor down the appropriate branch as defined by their classification.


Requirement classes

InvestorHasMadeCommitment - The investor must have indicated a commitment to progress past this step.

InvestorHasUploadedDocument - The investor must have uploaded a specified document to progress past this step.

InternalUserOnly - The move must have been initiated by an internal user to progress past this step.

InvestorHasValidKycRecord - The investor must have completed KYC checks to progress past this step.

InvestorHasClassification - The investor must be classified correctly to progress past this step.

InvestorHasCompletedForm - The investor must have completed the specified form to progress past this step.

AmountExceedsMinimumInvestment - The amount being captured for this step must exceed the minimum investment amount defined for the deal.