Map Milestones to Integrations

Integration Architects use the Insight Designer in theIntegrations feature in Oracle Integration to map model milestones that have been defined by a Business User to business process events.

Mapping milestones involves identifying execution points that best represent when a milestone has been passed. For example, an Integration Architect may determine that invocation of a service called placeOrder best represents passage of a milestone called OrderReceived, and creates an associated mapping between placeOrder and OrderReceived.

As part of the mapping process, an Integration Architect must also define extraction criteria for indicators. Extraction criteria define the rules that the system uses to extract information from runtime messages, and is expressed using XPath expressions.

TheIntegrations feature provides controls that allow an Integration Architect to create mappings for each milestone.


The Insight Designer in the Integrations feature.

Typical Workflow for Mapping Milestones to Integrations

The following table outlines the workflow for understanding and creating mappings between milestones in an Integration Insight model to activities in orchestration integrations.

Task Description More Information

Understand supported features

Understand which Integrations features are supported for mapping.

Supported Integrations Features

Understand prerequisites

Understand what you need (including integration and model activation lifecycle states) before you start mapping milestones to integrations.

Prerequisites for Mapping Milestones to an Integration

View existing mappings

View details about existing milestone mappings in your model.

View Milestone Mapping Details

Map to milestones

Map your milestones to integration actions.

Map a Milestone to an Integration

Define unique instance identifier extraction criteria

Define the XPath expression used to extract the unique instance identifier from the integration action mapped to a milestone.

Define Identifier Extraction Criteria

Define indicator extraction criteria

Define the XPath expression used to extract dimensions and measures from the integration action mapped to a milestone.

Define Indicator Extraction Criteria

Save your mappings

Save your changes and propagate them to the Integration Insight model.

Save Milestone Mappings

Delete unneeded mappings

Delete any mappings that are not needed or incorrect.

Delete Milestone Mappings

Supported Integrations Features

You can map milestones only to orchestration integrations. Other integration styles are not supported.

You can map milestones to the following Integrations actions:

  • Assign: When mapped to an Assign action, a milestone is considered passed and identifier/indicator values are extracted on entry or on exit of the Assign. You can define extraction criteria using message parts that exist on entry or on exit of the Assign, depending on the option you select.

  • Error Hospital: When mapped to an Error Hospital action, a milestone is considered passed and identifier/indicator values are extracted on entry of the Error Hospital. You can define extraction criteria using only message parts that exist on entry of the Error Hospital.

  • Fault Return: When mapped to a Fault Return action, a milestone is considered passed and identifier/indicator values are extracted on entry of the Fault Return. You can define extraction criteria using only message parts that exist on entry of the Fault Return.

  • Invoke: When mapped to an Invoke action, a milestone is considered passed and identifier/indicator values are extracted on entry or on exit of the Invoke. You can define extraction criteria using message parts that exist on entry or on exit of the Invoke, depending on the option you select.

  • Raise Error: When mapped to a Raise Error action, a milestone is considered passed and identifier/indicator values are extracted on entry of the Raise Error. You can define extraction criteria using only message parts that exist on entry of the Raise Error.

  • Return: When mapped to a Return action, a milestone is considered passed and identifier/indicator values are extracted on entry of the Return. You can define extraction criteria using only message parts that exist on entry of the Return.

  • Schedule: When mapped to a Schedule action, a milestone is considered passed and identifier/indicator values are extracted on exit of the Schedule. You can define extraction criteria using message parts that exist on exit of the Schedule.

  • Stop: When mapped to a Stop action, a milestone is considered passed and identifier/indicator values are extracted on entry of the Stop. You can define extraction criteria using only message parts that exist on entry of the Stop.

  • Trigger: When mapped to a Trigger action, a milestone is considered passed and identifier/indicator values are extracted on exit of the Trigger. You can define extraction criteria using message parts that exist on exit of the Trigger.

Mapping milestones to other actions is not supported.

Prerequisites for Mapping Milestones to an Integration

Before mapping milestones to an integration, all of the following conditions must be true:

  • The Oracle Integration instance with the integration you want to map to must be registered to the Integration Analytics instance and vice versa. See Registering Features in Administering Oracle Integration.

  • A connection must exist to the Oracle Integration instance with the Integrations feature and the integration you want to map to the milestones in your model. If a connection does not exist when you attempt to map a milestone, you can click Create Insight Connection in the resulting dialog to create one. Note that you need to be assigned the ServiceAdministrator role to create connections. If you have a role that doesn’t grant this privilege, like the Developer role, you can’t create a connection.
    This image displays the Create Insight Connection and Retry buttons.

    After a connection is created, click Retry to reload the Models list.

    See Create a Data Connection.

  • Models for which you want to create mappings must be created in Integration Insight. See Create a Model.

  • Models for which you want to create mappings must be in a Draft state. You can create a draft of an activated model before mapping an integration to it. See Change an Activated Model.

  • The relationship between models and integrations can be many to many: an integration can be mapped to milestones in multiple models; milestones in a single model can be mapped to multiple integrations. Milestones in all models that you want to map to an integration should be created and configured. See Create a Milestone.

When all of these conditions are met, you can use the Integrations feature in Oracle Integration to map integrations to milestones.

View Milestone Mapping Details

In the Integrations feature in Oracle Integration, you can view details about where each milestone in your model is mapped.

To view milestone mapping details:

  1. If you’re not already on the Insight Designer page:
    1. In the Oracle Integration navigation pane, click Integrations.
    2. In the Integrations navigation pane, click Designer, and then click Integrations.
    3. In the row containing the integration for which you want to view mapping details, click the Actions icon on the far right and select Map to Insight.
      Description of conn_actions_menu.png follows
      Description of the illustration conn_actions_menu.png
    The Insight Designer is displayed.
  2. In the Select a Model panel, search for or select the model for which you want to view milestone mappings.

    The model’s milestones are displayed. A green pin indicates a milestone is mapped to the current integration. A gray pin indicates a milestone is mapped to other integrations or to the REST API. An icon appears next to the pin. This icon’s tooltip reads Mapping Summary.


    Milestones displayed with a gray pin and the Mappings Summary icon to indicate this milestone is mapped somewhere other than the currently selected integration.
  3. To view a milestone’s mapping details, click the Mappings Summary icon.

    Details about the milestone mapping are displayed:

    • Mappings in this integration: Indicates if the milestone is mapped to the current integration. If it is mapped to the current integration, click View to display mapping details.

    • Mappings in other integrations: Lists other integrations mapped to the milestone.

    • API mappings: Indicates if the milestone is mapped to the REST API.

Map a Milestone to an Integration

Mapping milestones to actions in integrations is the role of an Integration Architect who understands the business process implementation in the Integration Insight feature in Oracle Integration.

Every time a mapped action occurs in an integration flow, identifier and indicator information is extracted from the message payload, if applicable, and the milestone is considered passed. Integration Insight collects this information and displays it on relevant dashboards in the model’s console.

Important:

Your business process implementation may span more than one integration. Repeat this task for each integration you want to map to your model.

To map a milestone to an integration:

  1. If you’re not already on the Insight Designer page:
    1. In the Oracle Integration navigation pane, click Integrations.
    2. In the Integrations navigation pane, click Designer, and then click Integrations.
    3. In the row containing the integration for which you want to view mapping details, click the Actions icon on the far right and select Map to Insight.
      Description of conn_actions_menu.png follows
      Description of the illustration conn_actions_menu.png
    The Insight Designer is displayed.
  2. If the Integration Insight model does not yet exist, click the Create a new Insight model icon.

    The + (Create a new Insight model) icon is highlighted.

    The Integration Insight model creation page opens in a new tab. See Create a Model.

  3. In the Insight Designer Select a Model panel, search for and select the model containing the milestones that you want to map to this integration.

    A model on the Select a Model panel in the Insight Designer.

    If the model is activated, it appears in the list with a check mark icon (Read only model - Activated).


    The Opportunity To Order model is activated, as indicated by the check mark (Read only model - Activated) icon.

    If the model is activated, you must create a Draft to create mappings:

    1. Click an activated model in the Select a Model list.
    2. Click Create Draft.

      Create Draft is highlighted.
    3. Click Save.

      WARNING:

      The Draft model is not created and your mappings are not saved until you click Save. Your changes are discarded if you click Discard or navigate away from the page before saving.

  4. (Optional) To edit the model before you map integration actions to a milestone, click the Open in Insight Designer icon. The model editor opens in a new tab.

    The Open in Insight Designer icon is highlighted.

    When you’re finished making edits, save the model editor, and then click the Refresh the models list icon in the Insight Designer.


    The Refresh the models list icon is highlighted.
  5. In the Insight Designer, click and drag a mappable action from the Integration canvas to the milestone you want to map it to. Drop it onto the Configure Insight (+) icon that appears in the center of milestone row.

    The getOpportunityFromSalesCloud invoke is being dragged from the canvas to the Quote Created milestone.

    Note:

    As noted in Supported Integrations Features, you can map only these actions: Assign, Error Hospital, Fault Return, Invoke, Raise Error, Return, Schedule, Stop, and Trigger. You cannot drag other actions to the Milestones list.

    Alternatively, you can click to select a milestone in the Milestones list, click a mappable action in the integration canvas, and then click the activity’s Configure Insight (+) icon. The action is mapped to the selected milestone.


    A milestone is selected, and then the getOpportunityFromSalesCloud invoke. The Configure Insight icon appears next to the Invoke. Clicking this icon maps the trigger to the selected milestone.
  6. (Optional) If you mapped Assign or Invoke action to a milestone: in the Implementation Mappings section, from the activity name list, select whether the milestone is considered passed On Entry or On Exit of the Invoke. On Entry is selected by default.

    The Implementation Mappings list is expanded and highlighted. The On Entry and On Exit items are displayed.

    Note:

    The option you select determines when identifier and indicator values are extracted from the message payload. For example, if you select On Exit, the value of an indicator is extracted when the Invoke activity is exited and not when it is entered.

    If you have mapped an action other than an Assign or an Invoke to the milestone, or if the mapped model is activated and has no draft created, this field is read only.


    The implementations mapping is read only because an action other than an assign or an invoke is mapped to the milestone.
  7. Repeat Steps 5 and 6 to map actions to the remaining milestones.

Define Identifier Extraction Criteria

Defining unique instance identifier extraction criteria is an Integration Architect task.

Extraction criteria is an XPath expression that defines how values are extracted from message payloads in an integration. The Integrations action from which a unique instance identifier is extracted is determined by the action that has been mapped to the milestone associated with the identifier. The unique instance identifier extraction criteria is defined in the context of this action.

Important:

Integration Insight uses the unique instance identifier to identify events that belong to the same instance (like the same order) across any number of integrations. Repeat this task for each integration mapped to your model.

  1. If you’re not already on the Insight Designer page:
    1. In the Oracle Integration navigation pane, click Integrations.
    2. In the Integrations navigation pane, click Designer, and then click Integrations.
    3. In the row containing the integration for which you want to view mapping details, click the Actions icon on the far right and select Map to Insight.
      Description of conn_actions_menu.png follows
      Description of the illustration conn_actions_menu.png
    The Insight Designer is displayed.
  2. In the Select a Model panel, search for or select the model containing the unique instance identifier for which you want to define extraction criteria.
  3. From the list under the model name, select Unique Instance Identifier.
  4. Click the Unique Instance Identifier to expand it. From the Data Type list, select the data type of the identifier.

    For unique instance identifiers, the supported data types are string, integer, double, and date.

  5. From the Implementation Mappings section of the Unique Instance Identifier list, click Define extraction criteria.

    After the milestone associated with the unique instance identifier is mapped to an integration, the Implementation Mappings section appears. This section contains the Define extraction criteria link.
    The Expression Editor opens.
  6. Use the Expression Editor to define the extraction criteria for the unique instance identifier. You can click and drag an element from the Source tree to the Expression field, or you can select an element from the mapped activity listed in the Source tree and click the select an element and move (>) icon to move it to the Expression field.

    You can also insert Functions and Operators from the Components tree into your expression or type an XPath expression directly into the Expression field. See Building Expressions in Using the Oracle Mapper with Oracle Integration.

  7. Click Validate to validate your expression. If your expression is not valid, make edits and revalidate until it is valid.
  8. Click Close to return to the Insight Designer.
The extraction criteria for your unique instance identifier are defined.

Define Indicator Extraction Criteria

Defining extraction criteria for indicators is an Integration Architect task.

The extraction criteria define the rules (in the form of an XPath expression) for pulling business data off a runtime message at the point that a milestone is passed. When your milestone is mapped to an integration, this is done in the Integrations feature in Oracle Integration.


Description of define-identifier-extraction-criteria.png follows
Description of the illustration define-identifier-extraction-criteria.png

The extraction criteria tooling automatically uses the schema of the service to which the indicator’s milestone is mapped. You can drill down into the message shape, in addition to using a variety of XPath functions.


Description of expression-builder-2.png follows
Description of the illustration expression-builder-2.png

When a milestone is set to receive events from the REST API, you simply define the data type of the indicator to extract when creating the milestone. Indicators are extracted from payloads sent for business events.

The Integrations action from which an indicator is extracted is determined by the action that has been mapped to the milestone associated with the indicator. The indicator extraction criteria is defined in the context of this action.

To define extraction criteria for indicators:
  1. If you’re not already on the Insight Designer page:
    1. In the Oracle Integration navigation pane, click Integrations.
    2. In the Integrations navigation pane, click Designer, and then click Integrations.
    3. In the row containing the integration for which you want to view mapping details, click the Actions icon on the far right and select Map to Insight.
      Description of conn_actions_menu.png follows
      Description of the illustration conn_actions_menu.png
    The Insight Designer is displayed.
  2. In the Insight Designer Select a Model panel, search for and select the model containing the indicator for which you want to define extraction criteria.
  3. From the list under the model name, select Dimensions and Measures.

    The list under the model name is highlighted and expanded. The Dimensions and Measures list item is also highlighted.
  4. Repeat the following steps for each indicator for which you want to define extraction criteria:
    1. Click the Dimension or Measure to expand it. From the Data Type list, select the data type of the indicator.

      The Data Type list is expanded. The available data types are displayed: string, integer, double, and date.

      For dimensions, the supported data types are string, integer, double, and date. For measures, the supported data types arestring, integer, and double.

    2. Click Define extraction criteria.

      The Define extraction criteria link for a dimension is highlighted.
    3. Use the Expression Editor to define the extraction criteria for the indicator. You can click and drag an element from the Source tree to the Expression field, or you can select an element from the mapped activity listed in the Source tree and click the select an element and move (>) icon to move it to the Expression field.

      You can also insert Functions and Operators from the Components tree into your expression or type an XPath expression directly into the Expression field. See Building Expressions in Using the Oracle Mapper with Oracle Integration.

    4. Click Validate to validate your expression. If your expression is not valid, make edits and revalidate until it is valid.
    5. Click Close to return to the Insight Designer.
The extraction criteria for your indicators are defined.

Save Milestone Mappings

Milestone mappings and extraction criteria definitions for indicators are only added to the Insight model definition when you save.

To save your milestone mappings:

  • In the Insight Designer, click Save to save your mappings.


    Save is highlighted on the Insight Designer screen.

WARNING:

If you close the browser window or navigate away from the Insight Designer page without saving, your mappings will not be saved.

If you close the Insight Designer (click Close) or navigate back to the Models list without saving, you are prompted to confirm you want to discard your changes. Click OK to discard your changes and exit the Insight Designer, or click Cancel to dismiss the dialog and retain your changes.

You receive a message indicating if your mappings were saved or if an error occurred.


Confirmation of saved mappings

The next time you (or another user) opens the Insight Designer or the Model Designer, the mappings appear as they were configured during the most recent save.

Next step: When your mapping is complete, you can activate the model and the integration (if it is not yet activated). See:

After activating the model and integration, Integration Insight begins collecting metrics from messages processed by the integration.

Delete Milestone Mappings

Deleting milestone mappings is an Integration Architect task.

When you delete a mapping to a milestone, the extraction criteria defined for the unique instance identifier and indicators (dimensions and measures) associated with it are also deleted.

To delete a milestone mapping:
  1. If you’re not already on the Insight Designer page:
    1. In the Oracle Integration navigation pane, click Integrations.
    2. In the Integrations navigation pane, click Designer, and then click Integrations.
    3. In the row containing the integration for which you want to view mapping details, click the Actions icon on the far right and select Map to Insight.
      Description of conn_actions_menu.png follows
      Description of the illustration conn_actions_menu.png
    The Insight Designer is displayed.
  2. In the Insight Designer Select a Model panel, search for and select the model for which you want to delete a mapping.
  3. To delete a mapping to a milestone:
    1. Click the milestone for which you want to delete a mapping.
    2. In the Implementation Mappings section, click the Delete mapping icon next to each mapping you want to delete.

      A milestone is selected. An action has been mapped to this milestone. The Delete icon next to the mapping is highlighted.

      Note:

      When deleting a mapping to a milestone, the extraction criteria defined for the unique instance identifier and indicators (dimensions and measures) associated with the milestone are also deleted.

  4. To delete an extraction criteria expression for a unique instance identifier or an indicator:

    Note:

    Identifiers and indicators inherit their mapping from the milestone with which they are associated. You can only delete this mapping by deleting the milestone mapping. However, you can also delete the extraction criteria defined for this mapping directly.

    1. From the list under the model name, select Unique Instance Identifier or Dimensions and Measures.
    2. Click the identifier or indicator to expand it.
    3. In the Implementation Mappings section, click the Delete icon next to the extraction criteria definition you want to delete.

      A unique instance identifier is selected. The Delete icon next to the extraction criteria expression is highlighted.
The mappings are deleted.