QUESTION
Can I monitor Workplace devices with a remote monitoring and management (RMM) tool?
ANSWER Yes. Just use the .xml generated by the Workplace app or Workplace Server.
NOTE For information about monitoring the Workplace app and Workplace Server with Datto RMM, please refer to Integrate with Datto RMM.
The Workplace app and Workplace Server 7.0 and later include an .xml file that you can use in conjunction with remote monitoring and management tools. The file locations on your computer are noted below:
Windows
v10 or later
%USERPROFILE%\AppData\Local\Datto\Workplace CloudConnect\Profiles\live\Sessions\0\StatusReport.xml
v8
%USERPROFILE%\AppData\Local\Datto\Common\Status Report - Datto Workplace.xml
Mac
v10 or later
~/library/Preferences/com.datto.dwc/account_<TeamName>(<UserName>)/Status Report.xml
v8
~/Library/Preferences/com.datto.dwp/Status Report.xml
Workplace Server
C:\ProgramData\Datto\Common\Status Report - Datto Workplace Server.xml
The files are comprised of the following fields:
XML Header Fields
Name | Platform | Format | Description |
---|---|---|---|
now | win,mac | time_t | unix timestamp, "when this file was written" |
platform | win,mac | string | "win" or "mac" |
rcid | win,mac | string | agent id |
product | win,mac | string | Name of this product |
XML Body Fields
Tag | Name | Platform | Format | Description |
---|---|---|---|---|
value | AD | win | boolean | Indicates whether the device is acting as an Active Directory integration agent. |
value | agent-account-name | win,mac | integer | Returns the UserID (numeric value) |
value | agent-bw-inbound | win,mac | integer | Bytes per second inbound network usage |
value | agent-bw-outbound | win,mac | integer | Bytes per second outbound network usage |
value | agent-connect-counter | win,mac | integer | Number of times the Workplace app has reconnected since startup |
value | agent-connection-host | win,mac | string | Host name for current the Workplace app connection |
value | agent-connection-port | win,mac | integer | Port number for current the Workplace app connection |
value | agent-hw-approved | win,mac | boolean | Status of hardware approval |
value | agent-idle | win,mac | boolean | Indicates whether the Workplace app is idle? |
value | agent-logon-time | win,mac | time_t | Last login (Unix time stamp) |
value | agent-online | win,mac | enum | Displays the Workplace app status: "disconnected", "connecting", "authenticating", "online", "retry", "low-disk-space" |
value | agent-policy-configuration-locked | win,mac | boolean | Indicates whether the Workplace app configuration is locked by policy (user cannot alter configuration) |
value | agent-run-mode | win | enum | Displays if the Workplace app is running in service mode ("service") or standard mode ( "unified") |
value | agent-start | win,mac | time_t | Displays last the Workplace app start time (Unix time stamp) |
value | agent-subscription-status | win,mac | enum | Displays the Workplace app user status: "enabled", "disabled", "deleted", "quarantined" (device is quarantined due to ransomware attack.), "blocked" (IP Address in not permitted due to IP Address Whitelist policy) |
value | agent-version | win,mac | string | Displays version of the Workplace app version installed on the device |
value | backup-active | win,mac | boolean | Indicates whether the Workplace app is currently backing up |
value | backup-bytes-remaining | win,mac | integer | Displays the number of bytes remaining to backup |
list | backup-configuration | win,mac | list of strings | Lists the root folders that are being backed up |
value | backup-files-remaining | win,mac | integer | Displays the number of files pending backup |
value | backup-last-complete | win,mac | time_t | Displays the last time the Workplace app completed a backup (Unix time stamp) |
value | backup-numbytes | win,mac | integer | Displays the number of bytes configured to backup |
value | backup-numfiles | win,mac | integer | Displays the number of files configured to backup |
value | backup-percent-complete | win, mac | 0..100 | Displays backup configuration progress as a percentage |
value | backup-policy | win,mac | boolean | Displays whether the backup configuration is controlled by policies |
value | backup-setting | win,mac | enum |
Displays backup status, as impacted by network settings:
|
value | backup-timeleft | win,mac | integer | Displays number of seconds left to complete backup |
value | backup-stopped-quota | mac,win | boolean | Indicates that backup is suspended due to lack of storage quota |
value | drive letter | win | enum | Indicates the drive letter for local storage |
value | is-v10 | win | boolean | Indicates whether the app is on v10 |
value | restore-active | win,mac | boolean | Displays whether the device is actively restoring |
value | restore-bytes | win,mac | integer | Displays number of bytes in current restore set |
value | restore-status | win,mac | 0..100 | Displays percentage complete of restore |
value | restore-time | win,mac | integer | Displays the number of seconds left in current restore |
value | setup-active | win,mac | boolean | Indicates whether the Workplace app setup is currently running? |
value | setup-deployment-info | win,mac | string | Displays error messages regarding the Workplace app setup issues |
value | setup-deployment-key | win,mac | string | Displays the TeamKey being used for remote deployment |
value | setup-deployment-status | win,mac | enum | Displays the current deployment status: "init", "complete", "wait-admin", "wait-user", "finished", "failed" |
value | sync-active | win,mac | boolean | Indicates whether the Workplace app is currently syncing |
value | sync-complete | boolean | Indicates whether the Workplace app is fully synced | |
value | sync-incoming-bytes | win,mac | int | Displays the total number of bytes currentlyincoming |
value | sync-incoming-files | win,mac | int | Displays the total number of files currentlyincoming |
value | sync-incoming-timeleft | win,mac | int | Displays the number of seconds remaining to complete incoming sync |
value | sync-mpf-location | win,mac | string | Displays path to users Workplace folder |
value | sync-mpf-status | mac,win | int | Displays an error code. Please refer to Sync Errors |
value | sync-outgoing-bytes | win,mac | int | Displays the total number of bytes currently outgoing |
value | sync-outgoing-files | win.mac | int | Displays the total number of files currently outgoing |
value | sync-outgoing-timeleft | win,mac | int | Displays the number of seconds remaining to complete outgoing sync |
value | sync-policy-active | win,mac | boolean | Indicates whether the projects syncing to the device are controlled by policy |
list | sync-projectlist | win,mac | list of records | Displays a list of synced projects, showing the FileID, Project name, Bytes synced, Files synced, Project path, Error status. Please refer to Sync Errors |
value | sync-violations | win,mac | int | Displays the number of sync violations |
Sync Errors
Code | Error | Description |
---|---|---|
0 or 2 | engine_ok | Indicates the Workplace app is functioning as expected |
3 | root_removed | Root Removed |
5 | root_missing | Project folder missing |
6 | invalid_root_path | Project folder is on path where watcher doesn't operate |
7 | cannot_create_root | Project folder cannot be created. |
8 | root_not_owned | Project folder is owned by someone else |
9 | new_root_not_empty | Project folder is new and not empty folder. |
10 | invalid_watcher | File watcher not operating correctly |
11 | create_project_failed | Unable to create project |
12 | out_of_diskspace | Project folder is out of disk space |
13 | cannot_place_file | Cannot place file into project folder |
14 | cannot_upload_file | Cannot upload file from project folder |
15 | cannot_create_folder | Cannot create folder |
17 | invalid_key | Cannot generate valid secret key (VFS). |
19 | db_rebuild | Requested sync db rebuild |
20 | repeated_rebuild_db | Repeated sync db rebuilds within 1h - contact support |