Create and Enable Workflows for Using in Agentic Applications
An agentic application is built using workflows. These workflows provide the response
when the agentic application requests for displays, actions, communications, summary
text, subtitle text, or user-query answers. The recommended method is for the workflow
to receive the request from the agentic application using the
OraMessageHint webhook variable. Create your workflow structure to
receive the webhook message, branch the workflow, and then provide the needed output to
the agentic application.
- Go to AI Agent Studio and open the
Workflows
tab. - Select Edit
to
edit the workflow you want to use in agentic applications. - Select Settings
. - From the Details tab, enable Expose to agentic apps.
- Publish your workflow.
OraMessageHint Variable
OraMessageHint is the primary application-aware workflow variable,
and its value can be retrieved using the expression
$context.$app.$OraMessageHint. It tells your workflow why the
application is calling it. In prompt templates, use expressions such as {{
$context.$app.$OraMessageHint }}. In Code nodes, use the value as
$context.$app.$OraMessageHint.
Here are some common values for OraMessageHint:
| Value | Description |
|---|---|
Summary |
Indicates that the application is asking for summary text. Return short summary text for that agent's contribution. |
InitSubtitle |
Indicates that the application is asking for the dynamic subtitle. Return the subtitle text itself. |
InitDisplay |
Indicates that the application is asking for startup
displays. Return one or more oraInfoDisplay
blocks, and it may also include actions and communication
suggestions when that improves the startup experience. |
InitActions |
Indicates that the application is asking for startup actions. Return zero or more action suggestions. |
InitCommunications |
Indicates that the application is asking for startup
communication suggestions. Return zero or more
oraComms blocks. |
Query |
Indicates that the user asked something through the application. Use the input message and answer the user. This response can also include displays, actions, and communications when appropriate. |
InvokeAction |
Indicates that a UI action sent work back to the workflow. Use this for follow-up handling after a widget command triggers an action path that sends a command to an agent. |
AdditionalContent |
Indicates that the application is loading an extra panel
under a focused agent. Use OraPanelName to tell
which panel is being requested. |
FillParameters |
Indicates that the application is asking one or more agents to fill communication parameters before generating or sending a response. |
SendCommunication |
Indicates that the application is asking a target workflow to send or complete a communication flow. |