Administrator
Administrator in Datto RMM
Datto RMM > ComStore tab
The Workplace"Workplace" describes the Autotask Workplace service in its entirety./Datto RMM integration offers the following major benefits:
- Seamless, silent deployment and removal of Datto Workplace (DWP) using Datto RMM. The DWP team key allows you to install or uninstall Workplace DesktopAlso known as the Workplace Desktop app, and in the context of this documentation, simply "the app," Workplace Desktop is the software installed on a computer that is responsible for synchronizing data between the local drive and the cloud. without end user interaction. The installation and uninstallation of the Workplace Desktop can be performed using the same component.
- Alerting on key problems of DWP, like devices failing to sync. Tickets can also be created from the alerts in Autotask PSA if the ticket integration is enabled.
This feature offers seamless, silent deployment and removal of Datto Workplace (DWP) using Datto RMM. The DWP team key allows you to install or uninstall Workplace Desktop without end user interaction. The installation and uninstallation of the Workplace Desktop can be performed using the same component.
For detailed information about how to configure your Datto Workplace/Datto RMM integration, please refer to this topic in the Datto RMM online help.
Installing Workplace with Datto RMM
Datto RMM can be used to silently deploy Workplace Desktop to your devices. Please refer to this topic in the Datto RMM online help.
If you install remotely with Datto RMM, you must then log out of the user profile and log back in, or restart the machine.
To install using a different endpoint management tool, please refer to Silent Installation.
Monitoring Workplace with Datto RMM
Workplace Desktop 7.0 and later includes an .xml file that Datto RMM can utilize for monitoring purposes. For more information on managing monitors in Datto RMM, please refer to the Create and Manage Monitors topic in the Datto RMM help.
For further information about the contents of the .xml file that you can use to build a custom monitor in Datto RMM, please refer to Can I monitor Workplace devices with a remote monitoring and management (RMM) tool? in our FAQs.
Monitoring Workplace with other RMMs
For information about monitoring Workplace with other RMMs, please refer to Can I monitor Workplace devices with a remote monitoring and management (RMM) tool? in our FAQs.
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 | 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 UserIDThe UserID is a unique identifer for a member or connection within a Workplace team. (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 Workplace Desktop has reconnected since startup |
| value | agent-connection-host | win,mac | string | Host name for current Workplace Desktop connection |
| value | agent-connection-port | win,mac | integer | Port number for current Workplace Desktop connection |
| value | agent-hw-approved | win,mac | boolean | Status of hardware approval |
| value | agent-idle | win,mac | boolean | Indicates whether Workplace Desktop is idle? |
| value | agent-logon-time | win,mac | time_t | Last login (Unix time stamp) |
| value | agent-online | win,mac | enum | Displays Workplace Desktop status: "Disconnected", "Connecting", "Authenticating", "Online", "Retry", "Low-disk-space" |
| value | agent-policy-configuration-locked | win,mac | boolean | Indicates whether Workplace Desktop configuration is locked by policy (user cannot alter configuration) |
| value | agent-run-mode | win | enum | Displays if Workplace Desktop is running in service mode ("service") or standard mode ( "unified") |
| value | agent-start | win,mac | time_t | Displays last Workplace Desktop start time (Unix time stamp) |
| value | agent-subscription-status | win,mac | enum | Displays Workplace Desktop user status: "Enabled", "Disabled", "Deleted", "Guest" |
| value | agent-version | win,mac | string | Displays version of Workplace Desktop version installed on the device |
| value | backup-active | win,mac | boolean | Indicates whether Workplace Desktop 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 Workplace Desktop completed a backup (Unix time stamp - shows "Now" if backup is completed) |
| 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: "Enable" - backup/sync enabled on the network connection, "Suspended" - backup disabled on the network connection, "Don’t-use" - sync and backup disable on the network connection |
| 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 | 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 Workplace Desktop setup is currently running? |
| value | setup-deployment-info | win,mac | string | Displays error messages regarding Workplace Desktop 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-email", "Wait-admin", "Wait-user", "Finished", "Failed" |
| value | sync-active | win,mac | boolean | Indicates whether Workplace Desktop is currently syncing |
| value | sync-complete | boolean | Indicates whether Workplace Desktop 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, ProjectA project is a top-level folder within Autotask Workplace. A project is the primary container for all the folders and files that are synchronized by the Workplace service. Projects create the basic organizational structure to store data and control user access. 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 Workplace Desktop 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 |
|
Forward this topic to others |
|
Provide feedback for the Documentation team |