Process Orchestration
Overview
This document provides diagrams that illustrate relationships within the Process Orchestration domain. By understanding this model, you can visualize the complete data structure behind the Process Orchestration API, including how entities and attributes are organized and how their relationships are represented.
For a detailed description of each entity and its attributes, refer to Process Orchestration API.
Process orchestration
- To view the diagram in full size, right-click and select Open Image in New Tab.
- To learn how to read the diagram, see How to read these diagrams.
The Process Orchestration domain acts as a central hub for creating, managing, and tracking processes in Akkuro Lending. It ensures that each process follows predefined status transitions and maintains a complete audit trail. The Process Orchestration API is designed for developers integrating loan workflows into their applications.
Process Orchestration defines how a lending process is modeled and executed across systems. The model includes:
- Definition: Process and status definition.
- Instance: Running processes, including current status, history, data, and references.
Definition
Defines what kinds of processes exist and how they are allowed to progress with statuses.
To retrieve all process and status definitions, use the Definitions API.
Process definition
A ProcessDefinition defines a type of lending process and its metadata. Each process definition contains a set of status definitions that describe the allowed lifecycle of that process.
Some examples of process definitions are Loan Origination, Loan Modification, or Loan Review process.
Status definition
A StatusDefinition represents a valid status in a process and defines which statuses it can transition to next. The ToStatuses attribute records the reference ID of the next status that can be reached from the current status.
Some examples of status definitions within a process can be Start Process, Process changes successful, or Process changes unsuccessful.
Instance
Represents running processes, including their current status, history, data, and references.
Process
A Process represents a single instance of a process definition created for a specific business case. It allows you to track the current status and the complete lifecycle of the process, including status changes and related metadata.
For example, when a loan enters the Loan Origination process, this object is created to track its progress through the defined statuses.
To create and manage processes in the Akkuro Lending, use the Processes Management API. The type of process you create is determined by the process definition.
To retrieve information about an existing process, use the Processes Query API.
External references
An ExternalReference contains an external reference ID that links a process to the identifier used by your system outside of Akkuro Lending. The origin attribute indicates which system provided this external reference ID. A process can contain multiple external references.
Status changes
A StatusChange records a transition between two statuses within a process, including motivations and a timestamp.
To request a status change, use the Status Change Management API.