Create an Ockto workflow

Introduction

In this chapter, we will guide you through the setup of an Ockto workflow. In this workflow, we will:

• Start an Ockto session

• Check the availability of the needed data sources

• Wait for an end user to scan the Ocko QR code

• Proceed the workflow to wait for the availability of the Ockto data from the end user process

• Get the Ockto data

• Handle the data using business rules

Ultimately, we will create a workflow that can be reused as a template for all kinds of processes with Ockto as a basis.

a typical Ockto workflow

System prerequisites:

• Ockto should be enabled on the Rulecube instance as part of your Rulecube license

• You already have set up all the Ockto settings you need in your Tenant:

  • Username

  • Password

  • Provider code

  • Endpoint (staging or production)

  • Certificate

In the rest of this chapter, we assume you already know how to create rulesets and workflows. If that's not the case, please go through chapter Create a Workflow first.

Step 1: Create a workflow ruleset

Go to the workflow canvas. You will see a Start step in the workflow.

Step 2: Create an Entity to save the ockto session data in the workflow state:

• Entity name: OcktoSession

• Input properties:

  • sessionId: string

  • sessionId: string

Add an input to the State Entity:

• name: ockto

• type: ocktoSession

Step3: start the Ockto session step

Drag an Action step on the workflow canvas. Give it a name, e.g. 'Start Ockto session'. Drag a line between the Start step and your new action. In this action, type the following code:

state.ockto = Ockto.startSession(Workflow.instanceId, {
    consentCode: "001",
    ocktoType: "P",
    odmVersion: "v4_3",
    requestDocuments: [],
    disablePartner: true,
    psd2InfoIncluded: true,
    psd2AmountOfMonths: 3
})

In the code above, we call Ockto and wait for a session to be started. This call results in both a session ID and a QR code. We save those in the workflow state.

Use the right settings for your specific process. See the documentation and the Ockto support portal for a description of all the options.

Step 4: Show the Ockto QR code to the end user

Normally, you will have a front-end application handling the customer process. In that front end, you would now show the Ockto QR code. The customer can open their Ockto app and start gathering their personal data from there.

This guide only uses the workflow debugging feature (the Sandbox). To show the QR code in the Sandbox, you can use Rulecube's logging feature. Add the following javascript code to the action above:

console.log(state.ockto.qrCode);

Step 5: Wait for the end user to scan the Ockto QR code

Three things can happen: the customer scans the QR code and starts gathering their information, the customer doesn't scan the QR code, or the customer cancels the process.

Add a Wait step to the workflow canvas. Give it a name, e.g. "Wait for QR scan".

Add two branches to this step:

• NOK: this branch will be chosen when the user cancels the process

• OcktoQRScanned: this branch will be chosen when the user scans the QR code

Add an End step to the workflow canvas and connect the NOK branch to the End step.

Step 6: Wait for the end user to gather their information

Add a Wait step to the workflow canvas. Give it a name, e.g. "Wait for Ockto data".

Add the OcktoQRScanned branch to this step.

Step 7: Get the Ockto data and handle the data in your process

Add an Action step to the workflow canvas. Give it a name, e.g. "Get Ockto result".

Add a branch between the "Wait for Ockto data" step and the "Get Ockto result" step and give it the name "OcktoDataReceived".

Add the following code to the action:

let result = Ockto.getResult(state.ockto.sessionId)
console.log(result);
// handle the result, i.e. add some rules, some extra process steps, etc.

The result variable now contains all of your customer's Ockto data.

If you save this ruleset and start it from the Sandbox, you can try it out for yourself!