Nintex Insights- Beginning Beacon

Use the Nintex Insights - Beginning Beacon action A tool for building the processes, logic, and direction within workflows. Actions are the steps the workflow performs to complete a process. to log the start of a process stage A particular portion in a workflow containing actions with a specific purpose to send data to Nintex Insights. A process stage is always identified by a start (Nintex Insights - Beginning beacon action) and an end (Nintex Insights - Ending beacon) point. in your workflow. By using variables, you can also add beacons Used to capture specific data in your workflow and pass to Nintex Insights for analytic purposes. and pass to Nintex Insights for analytic purposes.

For example, you have a workflow that aims to collect results of a hospital survey, and the workflow is triggered to start when a user submits an online Nintex - Form .

In designing the workflow:

  • You select Nintex - Form as the start event. You design a form and name it "Survey for hospital patients". The response to each question is captured and stored in variables which we will use as beacons.
  • You define a particular process stage in the workflow. You use the Nintex Insights - Beginning Beacon action as the start point and the Nintex Insights - Ending Beacon as the end point of the process stage.
  • In the process stage, you assign a beacon for each survey response. For example, the configurations of the first beacon are as follows:
    • Name: Name of respondent
    • Value: Respondent

      • This is a variable that holds the data entered by a user in the Patient's Name field of the online form.

For more information about this example, see: Example: Configure the Nintex Insights actions in Nintex Automation Cloud and add a data connection in Nintex Insights.

Note: 

To identify the start and end of a process stage, you must use these two actions together:

  • Nintex Insights - Beginning beacon action: Logs the start time.
  • Nintex Insights - Ending beacon action: Logs the end time.

For more information about the Nintex Insights connector, go to Nintex Insights.

Before you begin: 

In the context of Nintex Insights, you use beacons to capture specific data in your workflow and pass to Nintex Insights for analytic purposes.

A process stage is a particular portion in a workflow containing actions with a specific purpose to send data to Nintex Insights. The process stage is always identified by start (Nintex Insights - Beginning beacon action) and end (Nintex Insights - Ending beacon) points.

Jump to:

Configure the Nintex Insights - Beginning beacon action

  1. Add the action to the workflow and open the action configuration panel. For more information, see Add an action to the workflow.

  2. Type a Stage Name for your process stage.
  3. Type a Name and Value for a beacon.
  4. Click Add beacon to add more beacons.
  5. Specify an Expected Duration (in minutes) for the process stage to run.

Nintex Insights - Beginning beacon action fields and selections

Section

Field

Description

Variable types
  Stage Name

A name to identify a process stage within the workflow.

Every process stage is defined by a start and end point, the former specified by the Nintex Insights- Beginning Beacon action and the latter by the Nintex Insights - Ending Beacon action. You must use the same Stage Name for each action.

 n/a
Beacons Name Name of a beacon to use for passing data from the workflow to Nintex Insights. Text, Decimal, Integer, Boolean, DateTime, Collection
  Value Value of the beacon. Text, Decimal, Integer, Boolean, DateTime, Collection
  Add beacon

Click to add more beacons in the process stage.

Field/ selection Description
Name Name of beacon.
Value Value of beacon.
Delete Deletes the beacon added.
n/a
  Expected Duration (in minutes) Expected duration for the process stage to run. This number is measured against the actual duration that takes the process to complete. For example, you expect this process stage to complete within 1 minute and you can test that number in the report in Nintex Insights. Integer

Caution: If a file/folder that's used in a workflow is moved, renamed, or deleted, any workflows that use that file/folder will not start or will fail. Make sure you keep the paths in your workflow configurations up to date.

This example will show how a workflow in Nintex Automation Cloud collects survey results, and how to create a data connection to Nintex Automation Cloud in Nintex Insights.

In the Designer page of your Nintex Automation Cloud tenant:

  1. Click Start event.
  2. In the configuration panel that appears, select Form. Additional fields appear.
  3. Click Design form. The form designer appears.

  4. Drag the following controls in this specific order, and set values for each control:

    • Text - short:
      • Title: Respondent
    • Choice - Single
      • Title: Which ward where you admitted?
      • Display type: Drop-down list
      • Options: Maternity, Cardiology, Intensive care unit
    • Choice - Single
      • Title: Do you like the conditions of your delivery room? e.g baby cot, bed height, labor support tools, etc.
      • Display type: Radio buttons
      • Options: Very satisfied, Adequate, Neutral, Dissatisfied
      • Alignment: Horizontal
    • Choice - Single
      • Title: Were the nursing staff compassionate to your labor and postpartum needs?
      • Display type: Radio buttons
      • Options: Very satisfied, Adequate, Neutral, Dissatisfied
      • Alignment: Horizontal
    • Choice - Single
      • Title: Are you satisfied with the breastfeeding you have received?
      • Display type: Radio buttons
      • Options: Very satisfied, Adequate, Neutral, Dissatisfied
      • Alignment: Horizontal
    • Yes/No
      • Title: Would you recommend our hospital to family and friends?
      • Display type: Toggle
      • Alignment: Vertical

      Your form should look like the following:

      Hawkeye tutorial in Nintex Automation Cloud

    1. From the action toolbox on the left, search for the Branch by condition action.
    2. Click the Branch by condition action to open its configuration panel.
    3. Click Add condition.
    4. Complete the following fields with the following values:
      • When: Which ward were you admitted
      • Operator: equals (=)
      • Value: Maternity
    5. Click Add condition.
  6. In the Yes branch of the Branch by condition action, drag the following actions:
    • Nintex Insights - Beginning beacon
    • Nintex Insights - Ending beacon
    1. Click the Nintex Insights - Beginning beacon action to open its configuration panel.
    2. In Stage Name, write "Survey results for patients in Maternity ward."
    3. In Beacons section, write "Respondent" for Name.
    4. For Value, follow these steps:
      1. Click Variable that uppers on the upper right corner of the Value field.
      2. In the pane that appears, go to the Start event tab.
      3. Click Insert next to Respondent.
    5. Let's add more beacons! Click Add beacons three times. In the new fields that appear, enter beacon name and values.

      6. For Name, simply type the text provided in the following table. For Value, follow the previous steps in inserting a variable.

      Name Value
    1st Do you like the conditions of your delivery room Do you like the conditions of your delivery room eg baby cot bed length etc
    2nd Were the nursing staff compassionate to your labor and postpartum needs? Were the nursing staff compassionate to your labor and postpartum needs
    3rd Are you satisfied with the breastfeeding you have received? Are you satisfied with the breastfeeding you have received
    1. Type "5" for Expected duration in minutes.

    Your configuration panel should look like the following:

    Hawkeye tutorial in Nintex Automation Cloud

    1. Click the Nintex Insights - Ending beacon action to open its configuration panel.
    2. In Stage Name, select Survey results for patients in Maternity ward.
    3. In Beacons section, write "Would you recommend our hospital to family and friends" for Name.
    4. For Value, follow these steps:
      1. Click Variable on the upper right corner of the Value field.
      2. In the pane that appears, go to the Start event tab.
      3. Click Insert next to Would you recommend our hospital to family and friends.
    1. Type "3" for Expected duration in minutes.
  9. From the toolbar, click Publish.
  10. In the dialog window that appears, fill the following fields:
    1. Workflow name: Survey for hospital patients
    2. Description: A workflow to send beacon values to Nintex Insights.

    Leave the other fields unchanged.

  11. Click Publish.

Your workflow should look like the following:

Nintex Hawkeye Nintex Automation Cloud tutorial

We're finished creating the workflow! To keep things simple for this tutorial, we only collected survey responses from maternity ward patients, thus configuring only the Yes branch of the Branch by condition action. Of course, in actual scenarios, we must configure the No branch where you can capture responses from ICU patients, for example. To test the workflow and analyze data in Nintex Insights, let's move on to the next steps!

Log on to your Nintex Insights portal to begin seeing your workflow analytics. You can add data connections for all of your Nintex capabilities to display a full view of your Nintex platform data in the dashboard.

In your Nintex Insights tenant:

  1. On the Home page, click Add connection. The Data connections page is displayed.
  2. Click Add new data connection.

  3. Select Nintex Automation Cloud for the Data connection type.

  4. Click Connect.

    Note: You must have the administrator role in Nintex Automation Cloud to add a data connection for Nintex Automation Cloud. See, User management.

  5. The Nintex Automation Cloud sign in window is displayed. Sign in to Nintex Automation Cloud.

    1. Type your Email.

    2. Type your Password.

    3. Click Sign In.

    If multiple Microsoft credentials exist on your browser, you are asked to pick one.

  6. Select a Microsoft account.

  7. Click Continue.

The data connection is created and displays in the Data connections page of Nintex Insights. Nintex Automation Cloud data will display in your Nintex Insights Dashboard.