This section describes data prerequisites, requirements, validation rules, limitations, and actions related to creating Business Journeys.
Before creating Business Journeys ensure that the feature is enabled in your environment. Determine whether flow maps for business workflows are required in your environment. Ensure that your environment meets the data prerequisites detailed in the section.
SaaS: Business Journeys is enabled by default in SaaS environments.
On-premises: Business Journeys is disabled in on-premises installations. To enable Business Journeys, an Administrator needs to configure certain properties in the Controller Settings.
Before starting the Event Service, do the following:
Business Journey page displays a flow map detailing the business workflow across milestones. You can hide the flow map by changing the value of the
analytics.business.outcomes.flowmap.enabled property to
false in the Controller Settings.
As you create milestones, a flow map detailing the business workflow is automatically displayed in the Business Journey page. Additionally, selecting a Business Journey opens it in a new window with the flow map enabled. This behavior is controlled by the
analytics.business.outcomes.flowmap.enabled property in the Controller Settings. Setting its value to true indicates that flow map is enabled for Business Journeys.
Analytics creates Business Journey composite events by collecting events and fields that you have already captured as analytics data. In addition to built-in analytics data sources, custom event data can also be used to create Business Journeys. As you define the milestones in the Business Journey, you specify which events to use and which fields to extract from the events. You can extract fields collected by default or custom fields that you have configured for collection. You can add milestones with custom events created from Analytics API Keys.
You need to know your starting and ending event and the clearly defined steps in between. To collect additional fields in the events being captured by Application Analytics use one or more of the following techniques:
Application, for example, are considered a duplicate.
This section describes certain rules to validate Business Journey definition and naming convention for Business Journeys, milestones, and extracted fields. You can save your work as a draft without invoking validation. When you are ready, you can use Validate and Save to check that your definition is acceptable. Saving the Business Journey definition does not enable the Business Journey. Data is not captured until you actually enable the Business Journey. For more information, see Business Journeys Life Cycle.
This section describes the validation rules for naming Business Journeys, milestones, and extracted fields. Validation rules are not applied when you save your Business Journey definition as a draft. Validation is only invoked when you use Validate and Save. The validation rules include the following:
The following reserved field names cannot be used to name milestones or fields in your Business Journey definition.
A Business Journey definition must contain:
Define the milestones that comprise your workflow and the fields to extract at each milestone. You can reorder the milestones in the UI using drag-and-drop.
Once you name the primary key, you can not change the name unless the definition is in the draft state. See Business Journey Life Cycle for more information.
The primary key field is not populated for subsequent milestones because the primary key might have different field names in the event type for different milestones.
Fields that are extracted by default by Business Journeys are not shown. Refer to the table describing Filters and Fields.
Save the definition using one of the following actions:
This section provides detail on each phase of Business Journey life cycle.
Because you might not have all the required details at the beginning, creating the definition may involve multiple temporary versions. Use Save As Draft to capture your initial, incomplete definition and place your Business Journey into a Draft state.
Once the definition has the required details, use Validate and Save, which transitions the definition into the Valid Draft state. You can still modify the definition in this state. Business Journey events are not captured until you enable the definition.
When you are ready to process data, use the Enable action. This transitions the definition to the Enabled state. Most definitions will spend their lifetime in the Enabled state.
At some point, you may want to disable the Business Journey. The Disable action transitions the Business Journey definition to the User Disabled state. In this state, no incoming events are processed. Existing events can still be queried.
You can update the definition in the following ways:
When you no longer need the Business Journey definition, use the Delete action. This is the final phase of the definition's lifecycle. In this state, no incoming events are processed for it. Existing Business Journey events are not available for query.