10 Other Resources
This section links to any external documents that may be relevant, such as standards documents or other descriptions of this Building Block that may be useful.
Last updated
This section links to any external documents that may be relevant, such as standards documents or other descriptions of this Building Block that may be useful.
Last updated
Copyright © 2024
Example user interfaces provide illustrative context for common functionalities.
Building a process
Adding arbitrary scripts to a process
Adding new activities to existing processes
Adding credentials for use in a process
Configuring an HTTP request as an activity in a process
Adding a conditional gateway to a process
These user interface examples are meant to aid reviewers and developers in understanding the high-level requirements of the Workflow Building Block, not to specify certain design elements or guidelines.
Link to architecture requirements document (and specific sections within that document, such as cross-functional requirements, and general recommendations).
Link to use cases document – this document may be a valuable resource while developing workflows to ensure that a variety of different use cases are covered by the Building Block definition.
Link to the Building Block criteria and maturity metrics document created by Tanvir.
Link to Low Resource Settings document.
Link to GitHub repository and OpenAPI documentation site for the Building Blocks.
A historical log of key decisions regarding this Building Block.
A list of topics that may be relevant to future versions of this Building Block.
A list of functions out of the scope of this Building Block.
The WFbb is present in multiple use cases. Use cases can be found in the logical process blueprint and a subset of those that we focus on below can be found here. These user journeys and use cases have been referenced by the authors of the specification to ensure that the functional requirements for the spec suit the needs of the proposed implementations.
| User journey | Use-case | Capabilities | Functional requirements |
|---|---|---|---|
PPIC | Promotion | CHW uses a Education Materials Database(Content Management System/Registration) | GET resource from external system |
PPIC | Promotion | CHW selects some materials | n/a |
PPIC | Promotion | CHW Chooses a Demographic Group (contact list) from a Demographic Registry(Registration/Registry) | GET resource from external system |
PPIC | Promotion | Materials are sent to list of contacts from Demographic Group | Initiate process of sending out mails to uploaded list of contacts |
| User journey | Use-case | Capabilities | Functional requirements |
|---|---|---|---|
PPIC | (Voucher Request) Validate the mother has completed all steps (visited a pediatrician, procured medicine and nutrition supplies, and visited the therapy center) by connecting to MCTS registry | Must be able to start a workflow process via API. Support submission of data payload through variables) in the same API call | |
PPIC | (Voucher Request) Verify mother has no pending incentive voucher for this milestone? (from the MCTS registry) | Perform calculation | |
PPIC | (Voucher Request) Determine payment amounts for HC worker and mother | Perform calculation | |
PPIC | (Voucher Request) Generate cash payment voucher (Voucher number, QR Code, the voucher serial number and its expiry date. At this point the voucher will be flagged Pre-Activated) | Make HTTP request | |
PPIC | (Payment Initiation) Submit Payments csv file for approval and budgets (From Ministry of Health to Treasury Deparment) | n/a | |
PPIC | (Payment Initiation) (Iterate for reach record in CSV file) Verify payment details (ID Drectory Service) | Read from file, loop | |
PPIC | (Payment Initiation) Process Payments csv approval / rejected by Treasury | Perform caculation | |
PPIC | (Payment Disbursement) Submit Payment Instruction (from Disbursement Organization - Payer) to Payment Gateway (Payments Building Block supported by Workflow Building Block in the back-end) | Make HTTP request | |
PPIC | (Payment Disbursement) Payment Gateway query to ID Directory Service (requesting Mobile Money provider details for mother) | n/a |
| User journey | Use-case | Capabilities | Functional requirements |
|---|---|---|---|
PPIC | Case Management | 1. Validate client identifier (biometrics) | If validation requires checking with multiple other applications, this might require workflow. (Must be able to start a workflow process via API. Support submission of data payload through variables) in the same API call) |
PPIC | Case Management | 3. Submit new client encounter details to case management system | If a multi-step process is required for submitting encounter details this might be handled by workflow. (Must be able to start a workflow process via API. Support submission of data payload through variables) in the same API call) |
| User journey | Use-case | Capabilities | Functional requirements |
|---|---|---|---|
USCT | Send beneficiary data from Registration Building Block to Workflow Building Block | Must be able to start a workflow process via API. Support submission of data payload through variables) in the same API call | |
USCT | Check if the beneficiary is above the age of 18 from National ID Registry | Must be able to perform an external task or similar which calls remote service (REST API). Response from Remote service should contain requested data and/or response code | |
USCT | Check if the beneficiary is employed from Employment Registry | Must be able to perform an external task or similar which calls remote service (REST API). Response from Remote service should contain requested data and/or response code | |
USCT | Check if the beneficiary is receiving any income from Taxk Registry | Must be able to perform an external task or similar which calls remote service (REST API). Response from Remote service should contain requested data and/or response code |
| User journey | Use-case | Capabilities | Functional requirements |
|---|---|---|---|
USCT | Receive trigger from Scheduling Building Block that due date has been reached | Initiate worfklow via webhook | |
USCT | Load SRIS (Social Registry Information System) workload (i.e a list of eligible beneficiaries that are due for payment) | Make HTTP GET request | |
USCT | Iterate through each beneficiary and compute payment amounts due to beneficiary | Perform calculation, loop | |
USCT | Request payment for beneficiary (Payment Building Block) | Make HTTP POST request | |
USCT | Set TransactionID for successful payment and mark beneficiary as paid (Social Registry) | Make HTTP POST request |
| User journey | Use-case | Capabilities | Functional requirements |
|---|---|---|---|
USCT | 002: Payment (non-electronic/cash payments) | Receive trigger from Scheduling Building Block that due date has been reached | Allow the initiation of an async business process via POST to API. |
USCT | 002: Payment (non-electronic/cash payments) | Load SRIS (Social Registry Information System) workload (i.e. a list of eligible beneficiaries that are due for payment) | Make HTTP GET request |
USCT | 002: Payment (non-electronic/cash payments) | Request beneficiary payment details (from Social Registry) | Make HTTP GET request |
USCT | 002: Payment (non-electronic/cash payments) | Compute payment amount for beneficiary | Perform calculation |
USCT | 002: Payment (non-electronic/cash payments) | Generate TransactionID for payment due | Generate rand (execute script) |
USCT | 002: Payment (non-electronic/cash payments) | Request payment voucher (Payment Building Block) | Make HTTP request |
USCT | 002: Payment (non-electronic/cash payments) | Make voucher as paid (Payment Building Block) | Make HTTP request |
USCT | 002: Payment (non-electronic/cash payments) | Mark beneficiary as paid (Social Registry) | Make HTTP request |
