ftos.flow.getBusinessState

(FintechOS v24.5.0 to later)

Returns a string representing the current business state of the flow instance; business states can be created/defined by the user.

This is a business logic method for business service components.

Syntax

(method) Flow.getBusinessState(flowName: string, instanceId: string): string

Returns

A string representing the current business state of that flow instance, where the business state is a user‑defined status.

Example

This example reads the current business state (a status defined by the business user, e.g. "New", "Approved") of an existing LoanApplicationFlow instance and stores the returned string in a variable.

var flowName = "LoanApplicationFlow";
var instanceId = "3f4a9a8c-12ab-4cde-9f01-234567890abc";

var businessState = ftos.flow.getBusinessState(flowName, instanceId);