Flow Analytics Connector
The Flow Analytics connector lets you log details about flow outcomes that you can review in flow analytics.
You can use the Flow Analytics connector to:
-
Track analytics based on different flow outcomes.
-
Create a policy for running flows if logging errors occur.
Setup
Configuring the connector
Add the connector in PingOne DaVinci as shown in Adding a connector, then configure it as follows.
This connector doesn’t have a configuration at the environment level. You configure it in your flow instead.
Using the connector in a flow
Capture flow information
You can use the Log flow outcomes capability to log details about flow outcomes based on outcome type and outcome status.
The following character limits apply to flow outcome fields. Content that exceeds a limit is automatically trimmed during flow execution.
-
Outcome Type: Max 75 characters
-
Outcome Status: Max 75 characters
-
Outcome Status Detail: Max 75 characters
-
Outcome Description/Comment: Max 2500 characters
Using global variables in flow analytics
You can use global variables in the Flow Analytics connector fields.
You can map these variables into outcome fields like in the following example:
{
"outcomeType": "{{global.flowName}}",
"outcomeStatus": "success",
"outcomeStatusDetail": "{{global.flowVersionAlias}}"
}
Capabilities
Log Flow Outcomes
Log custom flow outcomes.
Show details
-
Properties
-
Input Schema
-
Output Schema
- outcomeType dropDown required
- Custom Value textField
-
Enter a custom text or map any previous connector outcome
- outcomeStatus dropDown required
- Custom Value textField
-
Enter a custom text or map any previous connector outcome
- outcomeStatusDetail textField
- outcomeDescription textArea
- customTimestamp textField
- shouldContinueOnError toggleSwitch
-
default object
-
properties object
-
outcomeType string required minLength: 2 maxLength: 75
Type of outcome from flow (e.g. login, enrollment, etc.)
-
outcomeStatus string required minLength: 2 maxLength: 75
Status of the outcome from the flow (e.g. success, error, denied, fraud, approved, etc.)
-
outcomeStatusDetail string minLength: 2 maxLength: 250
Details about status of the outcome
-
outcomeDescription string minLength: 2 maxLength: 2500
Description of the outcome
-
customTimestamp string minLength: 2 maxLength: 75
Custom timestamp to be logged along with the outcome
-
shouldContinueOnError boolean
true if flow should continue if an error is encountered in logging
-
-
Input Example
{
"properties": {
"outcomeType": "login",
"outcomeStatus": "success"
}
}