Data Action Categories
The data action categories include Navigate to URL, HTTP API, Navigate to Canvas, and Event actions:
- Navigate to URL: Opens the specified URL in a new browser tab.
- HTTP API: Uses the
GET/POST/PUT/DELETE/TRACEcommands to target an HTTP API and doesn't result in a new tab. Instead the HTTP status code is examined and a transient success or failure message is displayed. - Navigate to Canvas: Enables the user to navigate from a source canvas to a target canvas in either the same or a different visualization. Any filters that are in effect in the source canvas are passed to the target canvas as external filters. When the target canvas opens, it attempts to apply the external filters to the visualization. The mechanism by which external filters are applied isn't described here.
- Event Actions: Publishes an event using the Oracle Analytics event router. Any JavaScript code (for example, a third-party extension) can subscribe to these events and handle their custom response accordingly. This provides the maximum flexibility because the extension developer can choose how the data action responds. For example, they can choose to display a user interface or pass data to multiple services at once.
Both the Navigate to URL and HTTP API data action category
types can use a token syntax to inject data or metadata from the visualization into the
URL and POST parameters.
URL Token Replacement
HTTP data actions can replace tokens in URLs with values from the context passed to the data action. For example, qualified data reference values, filter values, username, workbook path, and canvas name.
| Token | Notes | Replace With | Example | Result |
|---|---|---|---|---|
${valuesForColumn:COLUMN} |
NA | Column display values from the qualified data reference. | ${valuesForColumn:
"Sales"."Products"."Brand"} |
BizTech,FunPod |
${valuesForColumn:COLUMN, separator:"/"}
|
Any token that can potentially be replaced with
multiple values supports the optional separator option. The
separator defaults to a comma (,) but you can
set it to any string. You can escape double quotes inside this
string by using a backslash (\).
|
Column display values from the qualified data reference. | ${valuesForColumn:
"Sales"."Products"."Brand"} |
BizTech,FunPod |
${valuesForColumn:COLUMN,
separationStyle:individual}
|
Any separationStyle defaults to
delimited but you can set it to
individual if the user needs to generate
separate URL parameters for each value.
|
Column display values from the qualified data reference. | &myParam=${valuesForColumn:
"Sales"."Products"."Brand"} |
&myParam=BizTech&myParam=FunPod |
${keyValuesForColumn:COLUMN}
|
NA | Column key values from the qualified data reference. | ${keyValuesForColumn:COLUMN} |
10001,10002 |
${env:ENV_VAR}
|
Supported environment variables are:
sProjectPath, sProjectName,
sCanvasName, sUserID, and
sUserName.
|
An environment variable. | ${env:'sUserID'} |
myUserName |