Upload Operational Intelligence File

This feature is not available in DWS Mode.

  1. From the VoiceConsole tab, select the Device Management tab.
  2. Under Navigation, click Device Profiles.
  3. In the View Device Profiles list, select the device profile.
  4. Under Device Profile Actions, select Upload Operational Intelligence File.
    The Upload Configuration File for Device Profile page is displayed.

To upload an Operational Intelligence configuration file, create a new device profile and select Operational Intelligence Data Analytics option. Existing device profiles do not support adding this option after creation. To use Operational Intelligence, create a new device profile with Operational Intelligence Data Analytics selected.

You can upload Operational Intelligence files only to device profiles that were created with Operational Intelligence Data Analytics enabled. If the option was not enabled during profile creation, create a new device profile with the option enabled

Create an Operational Intelligence Onboarding File

Operational Intelligence can generate an XML onboarding file for devices. Import the XML file into VoiceConsole to add the onboarding information to a device profile. You can use the same onboarding file to configure multiple devices.

For information on creating the onboarding file within Operational Intelligence, see Operational Intelligence Voice Onboarding User Guide available under Guides and Manuals at automation.honeywell.com/us/en/software/productivity-solutions/operational-intelligence

VoiceConsole automatically detects expired Operational Intelligence onboarding XML files and notifies users before the files expire. Device onboarding XML files remain valid for six months from the date they are generated. If site synchronization between VoiceConsole and Operational Intelligence is configured, VoiceConsole automatically updates the XML file before it expires.

If the XML file expires, devices continue to communicate with the Operational Intelligence platform without interruption. An expired XML file affects only site changes in VoiceConsole. You cannot move a device from one site to another if the associated XML file has expired.

If you attempt to change a device's site with an expired XML file, VoiceConsole displays an error message indicating that a valid XML file is required to complete the site change.

The page indicates whether an Operational Intelligence configuration file has been uploaded. If a configuration file is already uploaded, uploading a new file replaces the existing file.

Operational Intelligence Configuration File Expiration

VoiceConsole monitors expiration of Operational Intelligence configuration files.

  • The View Sites table displays the Expiration Date field when a configuration file has been uploaded to the site.

  • Expired configuration files cannot be uploaded.

  • The system generates critical notifications before the configuration file expires. The expiration notification time lead can be configured in System Configuration.

This feature integrates with VoiceConsole/Operational Intelligence Site Sync to help maintain site-level data consistency.

Upload the Onboarding File

To upload the Operational Intelligence configuration file:

  1. Open VoiceConsole.
  2. Click the VoiceConsole tab.
  3. Click the Device Management tab.
  4. Under Navigation, select Device Profiles.
  5. Select a device profile, and then select Upload Operational Intelligence File.

  6. Select a site from the Site Information list. Select All to associate the uploaded file with all sites.

  7. Select Browse, and then select the onboarding XML file.
  8. Click Upload.

The system displays the expiration date of the uploaded configuration file. If no file has been uploaded, the system displays N/A by default.

To verify the configuration status and expiration details for a site, go to Administration > Sites. Select a site, and then select View Selected Site. The Has Operational Intelligence Configuration and Operational Intelligence Configuration Expiration fields display the current status of the uploaded file.


VoiceConsole reads the expiration date from the JSON Web (JWT) token in the XML file. You cannot upload an expired file. The expiration date appears in the Operational Intelligence Configuration Expiration column in the View Sites table.

Automatic File Management

When you select a site, the following properties are displayed:

  • Site Name: The name assigned when the site was created.

  • Description: The optional description entered when the site was created.

  • Notes: Any notes entered when the site was created.

  • Time Zone: Time zone assigned when site was created.

  • Automatic Configuration Push: When an Operational Intelligence onboarding XML configuration file is updated, either manually or automatically through the site synchronization feature, VoiceConsole pushes the updated configuration file to all devices associated with device profiles that reference the file. This ensures that devices continue communicating with Operational Intelligence.

  • Trigger Scenarios: A configuration push occurs when a device is assigned to a different site, an expired onboarding XML file is manually replaced, or an onboarding XML file is automatically renewed through the Operational Intelligence site synchronization feature.

  • Automatic Renewal: VoiceConsole automatically fetches a replacement onboarding XML file from Operational Intelligence as the current file nears expiration. If the retrieval fails, the system retries every 24 hours until it succeeds.

For a configuration push to occur, the device must have an active device profile that includes the Operational Intelligence onboarding configuration. VoiceConsole delivers the updated file the next time the device connects.

Add the Configuration to a Device Profile

Operational Intelligence configuration is supported only for new device profiles.

  1. Open VoiceConsole.
  2. Click the VoiceConsole tab.
  3. Click the Device Management tab.
  4. Click Device Profiles on the upper left menu.
  5. Click Create New Device Profile under Device Profile Actions on the lower left menu.
  6. Fill in the information on the Create Device Profile: Configure Profile pages. Click Continue to advance to the next page each time.
  7. On Create Device Profile (Page 4 of 4): Configure Profile, click the Advanced Settings tab at the bottom of the page.
  8. Select the Operational Intelligence Data Analytics check box.
  9. Click Finish.

The profile is ready to deploy to devices.

Verify the microservices.config file Status

During profile deployment, VoiceConsole appends the contents of the microservices.configuration file to the *.cci file sent to each device.

To view the microservices.config information:

  1. Open VoiceConsole.
  2. Click the VoiceConsole tab.
  3. Click the Device Management tab.
  4. Click Device Profiles on the upper left menu.
  5. Select the device profile you want to verify.
  6. Under Device Profile Actions on the lower left menu:
    1. Click View Selected Device Profile.
    2. Click Export the Configuration of This Device Profile.
  7. Open the exported file in a text editor such as Notepad.
    The microservices.config information appears under the registry key setting
    [HKEY_LOCAL_MACHINE\Vocollect\CONFIG_PARAMS\
    IOT_BROKER_CFG].

Verify the exported configuration

Verify that the exported file contains the following registry key:

[HKEY_LOCAL_MACHINE\Vocollect\CONFIG_PARAMS\IOT_BROKER_CFG]

If the exported file doesn't contain this registry key, the device can't communicate with Operational Intelligence. To resolve the issue, verify that Operational Intelligence Data Analytics is enabled in the device profile's Advanced Settings, and then export the configuration again.