Intelligent Advisor Flow Engine API
The Intelligent Advisor Flow Engine API is a JavaScript module that is intended for use by enterprise developers to integrate Intelligent Advisor browser-authored flows into a wide range of applications and scenarios ranging from traditional interviews to chat to pure backend headless services. It allows complete control over rendering an interactive Intelligent Advisor experience. Flows authored in Intelligent Advisor Hub are similar to Policy Modeling interviews, but with greater flexibility when it comes to rendering controls and how data enters the session. Like other Intelligent Advisor products, rules in a flow project drive form behavior and decisions based on input values, with input data coming from external sources and from the user interacting with the defined input controls which have been placed in a certain order within pages and other grouping controls by a flow author.
Each flow is built upon a flow scheme, and it is the flow scheme which defines the names of controls as they appear to both flow authors within the Hub, and to the application that is interacting with the Flow Engine API to determine what controls to render. The application responsible for rendering the controls accesses the controls via their integration IDs, while in the flow authoring experience within the Hub the controls are named according to their Name in palette.
To get started using the Flow Engine API, you need the following NPM package:
The root module is called @oracle/ia-flows-sdk which contains the method to create a flow session.
The flow session objects are in @oracle/ia-flows-sdk/IAFlowEngineAPI.
Starting a flow session is a two stage process that consists of:
-
Getting a session token - This should be done server side in a secure Oracle Fusion call.
-
Creating a flow session - This is done by sending the session token to the client and then calling the appropriate API method to create a flow session object.
A detailed technical sample is available that renders a provided flow project. The sample shows just one of the many ways you may choose to render projects using the Flow Engine API. For more information, see Flow Rendering Example.
A debugger widget is available that can be attached to any html element in an application using the Flow Engine API. It will show a debugging user interface alongside any interview started as a flow engine debug session. For more information, see Flow Debugger Overview.
A key concept underpinning the flow technology is the linearization algorithm. The main principle here is that data set later in the flow should not influence the state of items (for example, visible, read-only, optional and so on) that appear earlier in the flow. This algorithm is discussed in detail in Understand Linear Flows.
For details about the external data integration feature of the Flow Engine API, see Data Integration In Flows.
API documentation is available in the Flow Engine API Reference.
To enable the Flow Engine API feature, contact Oracle Support.