VMware Workspace ONE Hub Services Integration

Integrate your VMware Workspace ONE Hub Services product with VMware Workspace ONE Intelligence to enable the transfer of data between the two systems. With the integration, you can perform various actions on managed devices using the Workspace ONE Intelligent Hub app, a component of the Hub Services system. Various actions include sending micro-surveys for your DEEM Solution, using Hub Services as a Data Source in workflows to send notifications to the Hub app on devices, and using custom dashboards to display analytics about your Hub Services notifications.

VMware Workspace ONE Hub Services documentation

For details on Workspace ONE Hub Services, see the Workspace ONE documentation site. - VMware Workspace ONE Hub Services Documentation - Administering Hub Services with Workspace ONE UEM and Workspace ONE Access

How to authorize the Hub Services connection

Authorize the transfer of data between your Workspace ONE Hub Services product and Workspace ONE Intelligence so you can use and configure applicable features.

Retrieve the URL to your Workspace ONE Hub Services console. You enter it in Workspace ONE Intelligence to authorize the connection. To find your Workspace ONE Hub Services console URL, launch your Hub Services console and copy the address from your browser. An example might be https://hubsvc.acme.com.

You must be a super admin to authorize this connection.

Set up with Workspace ONE Access

If you use Workspace ONE Access to authenticate to Intelligence, follow this procedure to authorize the connection.

  1. In Workspace ONE Intelligence, go to Integrations > Data Sources and select the Workspace ONE Hub Services integrations card.
  2. Select Get Started.
  3. Select Authorization Details.
  4. Enter your Workspace ONE Hub Services Console URL in the Authorized URI text field.
  5. Select Connect to Workspace ONE Hub Services.
    Workspace ONE might prompt you for your admin credentials if you are not using an active SSO session.
  6. Enter your Workspace ONE Access, admin credentials, if prompted.
  7. Click Accept to authorize the Workspace ONE Intelligence and the Workspace ONE Hub Services connection.

Set up with Workspace ONE UEM

If you use Workspace ONE UEM to authenticate to Intelligence, work in both the Workspace ONE Intelligence console and in the Workspace ONE UEM console.

  1. Begin the authorization process in Workspace ONE Intelligence.
    1. In Workspace ONE Intelligence, go to Integrations > Data Sources and select the Workspace ONE Hub Services integrations card.
    2. Select Get Started.
    3. Select Authorization Details.
  2. Go to your Workspace ONE UEM console and launch Workspace ONE Hub Services to get the Hub Services URL and to deploy a token for the connection on the back end.
    1. In another browser tab, open your Workspace ONE UEM console.
    2. Go to the correct organization group.
    3. Select the menu square in the top right of the UI and then select Workspace ONE Hub Services.
      You can retrieve your Hub Services console URL now if you did not already do so.
  3. Complete the authorization in Workspace ONE Intelligence.
    1. On the browser tab with your Workspace ONE Intelligence instance, enter your Workspace ONE Hub Services Console URL in the Authorized URI text field.
    2. Click Accept to authorize the Workspace ONE Intelligence and the Workspace ONE Hub Services connection.

How can you check the connection is valid?

You can check that the connection is valid by viewing the Workspace ONE Hub Services integrations card.

  • The Status tab displays applicable data.
    • Connection Status
    • Connected Time
    • Last Successful Survey Response Time
    • Number of Successful Survey responses in the last 24 hours
  • The Usage tab displays data for dashboards, workflows, and reports used by the authorized Hub Services connector.
  • The Actions tab displays recent actions performed using the authorized Hub Services connector.

How do you configure Surveys?

One of the features the Hub Services integration enables is the creation and publication of surveys for your Experience Management Solution. For details, see the topic What are Surveys?.

How do you create workflows to send notifications through Hub Services?

Send informational or actionable Workspace ONE Intelligent Hub notifications to users through your Hub Services integration with Intelligence. When parameters trigger the workflow, the system sends the configured notification as a Workspace ONE Intelligent Hub notification to targeted users.

For details about Workflows in Workspace ONE Intelligence, see Freestyle Orchestrator.

Use cases for sending notifications through Hub Services

Some use cases where using a workflow to send notifications through Hub Services include preparing for the listed possibilities.

  • Notify users if your environment experiences OS crashes, security issues, or vulnerabilities.
  • Notify users in case a managed app has an issue and is not working.

Where can users find notifications in the Intelligent Hub app?

Users can see Hub Services notifications on the For You tab in the Workspace ONE Intelligent Hub app on their devices.

Hub Services action for workflows

You can use the Send Notifications action in workflows to send a message through the Workspace ONE Intelligent Hub.

Prerequisites

Authorize the integration of Workspace ONE Hub Services and Workspace ONE Intelligence before configuring workflows to send notifications.

Notes:

  • You can configure only one Hub Services notification per workflow.
  • For configurations that use a URL, you must use https://. Examples of configurations where you might use a URL are Media Type, Links, or certain actions. If the URL does not start with https://, the workflow fails.

Procedure

Follow the steps to configure a custom workflow for Hub Services notifications.

  1. In Workspace ONE Intelligence, go to Workspace > Workflows > Add.
  2. Select to Start Custom Workflow.
  3. Select the connector (the data source) and the category as the Trigger. Use the listed categories to configure the Trigger because these categories support the sending of notifications through Hub Services. Not all categories support this action.
    • Workspace ONE UEM > Devices
    • Workspace ONE UEM > Apps
    • Intelligence > Device Activity
    • Intelligence > App Activity
  4. Select a Trigger Type, Automatic, Schedule, or Manual.
  5. Add Trigger Rules by selecting Empty Rule. Add the two listed categories.
    You can add more categories to the rule, but the workflow fails to execute if it does not have the two listed categories configured in the Filters section.
    • Devices > Enrollment Status > Equals > Enrolled
    • Users > User Status > Equals > 1
  6. Add an Action using the + icon, and select Workspace ONE Hub Services > Send Notifications.
  7. Save the workflow.

Users see notifications sent when triggers are met on the For You tab in the Workspace ONE Intelligent Hub app on their devices.

How can you view analytics for your Hub Services notifications?

Workspace ONE Intelligence can collect analytics about user engagement with your notifications sent through Hub Services. Select from several ways to display analytics about your notifications.

  • Use the Hub Notifications dashboard.
  • Import a dashboard.
  • Create a custom dashboard.

Considerations

View these considerations about the current release of this feature so you know why the feature displays the events it displays and behaves as it does.

  • Currently, Workspace ONE Intelligence displays analytics for notifications that you configure in Hub Services or in Workspace ONE Intelligence. It does not display, create, or send analytics for notifications configured through APIs or through other services.
  • Urgent notifications require your users to interact with them before the user can do anything in the Workspace ONE Intelligent Hub app. To get the best insight into user engagement with your Urgent notifications, use the Opened event rather than the Viewed event.
    • Intelligence records a Viewed event when the user is on the For You tab to see an Urgent notification. However, Intelligence records an Opened event when an Urgent message pop up appears to the end-user anywhere in the Hub app. They don’t have to be on the For You tab to record an Opened event, so Opened events are more insightful for your Urgent notification engagements.
  • Due to the Intelligent Hub for Windows left navigation tab behavior, the Hub app might register a Viewed event for a notification when a user is not on the For You tab. For example, if the user has the Apps tab open and the system sends a new For You notification, the Hub app might log a Viewed event for that notification.

Prerequisites

Authorize the integration of Workspace ONE Hub Services and Workspace ONE Intelligence before importing or creating your custom dashboard that displays your notification analytics.

Types of events and their behaviors

For events, the system looks for specific actions or behaviors as the system and users interact in the Hub Services notifications framework. After the system identifies that actions and behaviors have occurred that equal an event, the system logs the event. Events include the listed actions and user behaviors.

  • Actioned: The system logs this event when the user completes the requested action successfully.
    • The system notes what action was taken. For example it notes if the user selected a specific menu item.
    • Failed actions are not logged as Actioned events.
  • Created: The system logs this event when an admin creates a notification.
  • Dismissed: The system logs this event when the user dismisses a notification selecting the X in the top right corner of a notification card. Dismissing a notification moves it to the History section of the Hub app.
  • Opened: The system logs this event when the user selects and opens a notification to see the details.
  • Sent: The system logs this event when the system sends a notification to users or devices.
  • Viewed: The system logs this event when a notification displays for the user on the For You tab. However, if the user is on the For You tab and the notification hasn’t yet reached the viewing area of the Hub app, the system does not log a Viewed event. Viewed is the only event that is dependent on displaying in a specific area to be logged.

Use the Hub Notifications dashboard

Use the Hub Notifications dashboard as an OOTB (out of the box) display of your Hub Services notification analytics.

The Hub Notifications dashboard offers various ways for you to interact with notification analytics including hovering over the graph to display event data.

  1. Find the Hub Notifications dashboard in Workspace ONE Intelligence in Workspace > Experience Management > Hub Notifications.
  2. The dashboard has two tabs, the Overview tab and the Notifications tab.
    • Overview: This tab displays an at-a-glance view of your notification analytics for all Hub notifications. It displays counters, an activity timeline that you can change using the calendar filter, and action cards that report events by platform.
    • Notification List: This tab lists your events for each Hub notification. Select an event, Actionable or Informational, to see its unique counters, activity timeline, and widgets.
  3. Counters: The counters offer a numerical report of your notification analytics that occurred during the configured calendar filter (for example, Last 28 days).
  4. Activity Timeline: This graph depicts when all the actions occurred during the set calendar filter. You can hover over the colored squares in the Action Type area to highlight an specific action in the graph.
  5. Hover over the graph to see an action breakdown of the individual and total number of events for that depicted time.
  6. Action counters: Use these counters to quickly see individual numbers for each action type by platform.
  7. Select View to interact further with the Activity Timeline data. Create a Workflow, a Report, copy the data, or edit the data ranges from this view.
  8. Select the ellipses (…) if you want to use workflows, export the data as a CSV, copy the data, edit the dashboard theme, or edit the data ranges.

The Notification List tab

This tab lists your Hub notification events. Select an event, Actionable or Informational, to see its unique counters, activity timeline, and widgets.

  • Counters: Select to use the Total Count or the Unique Count in the activity timeline and the widgets for the selected event. Users can perform an action more than once so the Unique Count is the counter to use for a distinct and singular account of the number of times an event occurred.
  • Activity Timeline: This graph depicts when an event, Viewed, Opened, Actioned, or Dismissed occurred for the selected notification.
  • Actions Breakdown: The system displays this widget for only Actionable events. It visually depicts the number of actions and the actions taken that occurred over a set time period. You can quickly see the days when there are increases in actions.
  • Views By Platform: The system displays this widget for Actionable and Informational events. It visually depicts the number of views by platform over a set time period. Quickly see spikes in views for your supported platforms.
  • Select the View menu item on the Activity Timeline graph or on the widgets to drill down into the specific analytics.

Import Hub Services notification analytics dashboard templates

Import dashboard templates for Hub Services notification analytics by downloading custom Hub Analytics dashboard code samples (as JSONs) from the Sample Exchange on VMware Developer. Enter Hub notifications to find Actionable notification analytics Dashboard samples.

Create a custom dashboard to view notification analytics

Create a custom dashboard or import a template from the Workspace ONE Intelligence Dev Center to view your user engagement for your Hub Services notifications.

Measure filters you can use

  • For unique counts of users or devices, measure by Distinct Count of User GUID or Device GUID.
    • Distinct Count of User GUID works best if you want data by platform.
  • For total counts of users or devices, measure by Count of Event ID. This filter includes data on users or devices that might be viewing or opening a notification multiple times.

Example custom dashboard for Hub Services notification analytics

Follow this example to create a custom dashboard with your Hub Services notification analytics for total counts of users devices.

Here's an example of the widgets for your Hub Services notifications analytics dashboard.

  1. In Workspace ONE Intelligence, go to Workspace > My Workspace > Recent Dashboards > View All > Add > Custom Dashboard.
  2. Name your dashboard so you can identify it in the console. For example, you could name your dashboard MyName’s Hub Services Notification Analytics.
  3. Add a date range.
  4. Select Add Widget > Custom Widget.
  5. Add all or some of the listed widgets to create a custom dashboard that reflects your user engagement with your Hub Services notifications.
    • Total Created
      • Category > Workspace ONE Hub Services > Notification
      • Data Visualization > Snapshot
      • Chart Type > Metric
      • Measure > Count of Notification ID
      • Results per group > 10
      • No filters needed
    • Total Sent
      • Category > Workspace ONE Hub Services > Notification Action
      • Data Visualization > Historical
      • Chart Type > Metric
      • Measure > Count of Event ID
      • Results per group > 10
      • Date Range > Last 28 days
      • Frequency > Entire date range
      • Filters
        • Event Type includes (notification_action)
        • Status includes (success)
        • Action Type equals (sent)
    • Total Failed To Send
      • Category > Workspace ONE Hub Services > Notification Action
      • Data Visualization > Historical
      • Chart Type > Metric
      • Measure > Count of Event ID
      • Results per group > 10
      • Date Range > Last 28 days
      • Frequency > Entire date range
      • Filters
        • Status includes (failed)
        • Action Type equals (sent)
    • Total Viewed
      • Category > Workspace ONE Hub Services > Notification Action
      • Data Visualization > Historical
      • Chart Type > Metric
      • Measure > Count of Event ID
      • Results per group > 10
      • Date Range > Last 28 days
      • Frequency > Entire date range
      • Filters > Action Type includes (viewed)
    • Total Opened
      • Category > Workspace ONE Hub Services > Notification Action
      • Data Visualization > Historical
      • Chart Type > Metric
      • Measure > Count of Event ID
      • Results per group > 10
      • Date Range > Last 28 days
      • Frequency > Entire date range
      • Filters > Action Type includes (opened)
    • Total Actioned
      • Category > Workspace ONE Hub Services > Notification Action
      • Data Visualization > Historical
      • Chart Type > Metric
      • Measure > Count of Event ID
      • Results per group > 10
      • Date Range > Last 28 days
      • Frequency > Entire date range
      • Filters > Action Type includes (actioned on)
    • Total Dismissed
      • Category > Workspace ONE Hub Services > Notification Action
      • Data Visualization > Historical
      • Chart Type > Metric
      • Measure > Count of Event ID
      • Results per group > 10
      • Date Range > Last 28 days
      • Frequency > Entire date range
      • Filters > Action Type includes (dismissed)
    • Informational vs Actionable
      • Category > Workspace ONE Hub Services > Notification
      • Data Visualization > Snapshot
      • Chart Type > Vertical
      • Measure > Count of Notification ID
      • Group by > Notification Type
      • Results per group > 10
      • No filters needed
    • Total Views by Platform
      • Category > Workspace ONE Hub Services > Notification Action
      • Data Visualization > Historical
      • Chart Type > Heat Map
      • Measure > Distinct Count of Event ID
      • Group by > Platform
      • Results per group > 10
      • Date Range > Last 28 days
      • Frequency > Entire date range
      • Filters > Action Type includes (viewed)
    • All Activity Timeline
      • Category > Workspace ONE Hub Services > Notification Action
      • Data Visualization > Historical
      • Chart Type > Line
      • Measure > Count of Event ID
      • Group by > Action Type
      • Results per group > 10
      • Date Range > Last 28 days
      • Frequency > 1 day
      • No filters needed

See your Hub Services notification analytics in your custom dashboard in your workspace.

check-circle-line exclamation-circle-line close-line
Scroll to top icon