Workflows

Workflows provide customizable components to build business solutions that improve your audience's digital experience. These components include Customer Workflows and Back-Office Workflows and Digital Journey Flows.

Workflow Designer - Clean Install & Upgrade

Before diving into actually using the Workflow Designer, upgrade and update actions need to be taken:

Clean Install

No action needed. The pipeline automatically configures the parameters for Workflow Designer in Configuration Manager (Vault).

Upgrade

The pipeline will not update the Vault. You must manually configure the Vault for the feature to function. Follow the steps below:

1. In Configuration Manager, go to your environment > workflow.

2. Add the following:

   Keys

   • activations - configure this to define the base URLs, authentication types (like API keys), and service identifiers that allow the system to securely communicate with providers (such as DCI) to finalize lending applications.

     Copy

     [
         {
             "authType": "apiKey",
             "baseUrl": "https://apimgm-dcs-test.azure-api.net", // for internal QA envs
             "baseUrl": "https://dci-uat.ondisplayftos.com", // for all customer non-prod envs
             "baseUrl": "https://dci.fintechos.com", // for all customer prod envs
             "configurations": [
                 {    
                     "id": "00aab00a-0a00-0a00-0000-0a0000000a00",
                     "name": "demo_name",
                     "serviceId": "00aab00a-0a00-0a00-0000-0a0000000a00",
                     "subscriptionId": "demo",
                     "subscriptionKey": "demo"
                 }
             ],
             "id": "00aab00a-0a00-0a00-0000-0a0000000a00",
             "name": "dci"
         },
         {
             "authType": "platform",
             "baseUrl": "{env_envoy}",
             "configurations": [
                 {                
                     "id": "00aab00a-0a00-0a00-0000-0a0000000a00",
                     "name": "default"
                 }
             ],
             "id": "00aab00a-0a00-0a00-0000-0a0000000a00",
             "name": "platform"
         }
     ]

   • customIntegrationCatalog - a centralized registry where you define external systems and their specific integration points, enabling the workflow engine to discover and interact with custom third-party services during journey execution. Read more about Integrations.

     Copy

     {
         "integrationSystems": [],
         "integrations": []
     }

   • customServiceCatalog - a registry where you define specific business services and their input/output structures so they can be easily reused across different digital journeys.

     Copy

     {
         "serviceTypes": [],
         "predefinedServices": []
     }

    

3. Configure Async engine by going to Configuration Manager > your environment:

   • flow.config: defines the operational mapping between a specific business process and the underlying asynchronous infrastructure. Append this value to the existing json array:

     Copy

     {
         "flowName":"Workflows_Async",
         "queueMappings":[
           {
             "sourceQueueName":"ftos-workflows",
             "endpointUrl":"api/flow/webhooks/processData",
             "platformType":"portal",
             "maxThreads":10,
             "initial":true
           }
         ]
       }

   • queue.config: The queue.config section defines the structural and behavioral properties of the message queue used by the async engine. While the flow.config handles the routing, this section establishes the "container" rules for how messages are stored and managed. Append this value to the existing json array:

     Copy

     {
         "name": "ftos-workflows",
         "maxMessages": 10,
         "timeToLive": 1
       }

   • platform.config: defines the core environment endpoints required for the async engine to communicate with the platform's user interfaces. It serves as a service discovery configuration, ensuring that the engine knows exactly where the Portal and Studio instances are located within the specific deployment environment. Add key if not present, and set this value to it:

     Copy

     platform.config
     {
       "portalUrl":"{env_envoy_url}/portal/",
       "studioUrl":"{env_envoy_url}/studio/"
     }

      

4. Update the environment configuration to support file uploads from external integration webhooks, such as those used by Onfido and IDnow. To do so go to Configuration Manager > portal > app-settings > FileUploadWhiteList. Append .webm and .mp4 to the existing list of allowed extensions.

   Failure to include these formats will result in webhook errors when external providers attempt to upload received files to the platform's storage.