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 automation 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.

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.

Authorize the integration of Hub Services and Workspace ONE Intelligence with the Hub Services card.

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, automations, 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 micro-surveys?

One of the features the Hub Services integration enables is the creation and publication of micro-surveys for your DEEM Solution. For details, see the topic What are DEEM micro-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 Automations and Workflows in Workspace ONE Intelligence, see Automations for Workspace ONE Intelligence.

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.

Prerequisites

Authorize the integration of Workspace ONE Hub Services and Workspace ONE Intelligence before configuring automation 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 Automations > Workflows > Add.
  2. Select to use a Custom Workflow.
  3. Use the listed categories to configure the Trigger (When) 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. To configure the Filter (If) menu item to target a specific audience, 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 Filter (If) section.
    • Devices > Enrollment Status > Equals > Enrolled
    • Users > User Status > Equals > 1
  5. In the Action (Then) section, select Workspace ONE Hub Services > Send Notifications.
  6. Configure the notification by selecting Send Notifications to open the configuration section.
    • Define the priority level as Urgent, High, or Standard.
    • Select the type of notification as Informational or Actionable.
    • Enter a Title, Description, and at least one Actionable Type.
    • Optionally, you can configure the Media Type, Subtitle, Links (up to 10), and Additional Details (up to five).
  7. Save your 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. Import or create a custom dashboard with widgets using the Workspace ONE Hub Services > Notification or Notification Action categories to display analytics about your notifications.

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 Open 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 Open 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 Open event, so Open 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.

Import Hub Services notification analytics dashboard templates

Importing dashboard templates for Hub Services notification analytics is similar to importing Experience Management (also called DEEM) templates. You can download custom Hub Analytics dashboard code samples (as JSONs) from the Sample Exchange on VMware {code}.

Types of events and their behaviors

With Hub Services and Workspace ONE Intelligence integrated, you can view the listed events. For each event, the system recognizes parameters and logs each event when the notification displays in the Workspace ONE Intelligent Hub app.

  • Actioned on: 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 button.
    • Failed actions are not logged as Action events.
  • Created: The system logs this event to record the number of notifications created by an admin.
  • Dismissed: The system logs this event when the user dismissed 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 to record the number of notifications the system sends 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.

How do you view Hub Services notifications analytics with custom dashboards?

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 Dashboards > My Dashboards > 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. Select Add Widget > Custom Widget.
  4. 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 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
        • 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 My Dashboards.

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