Nexthink Recognized by SIIA as the Best Digital Employee Experience Platform Learn more

Learn more

Learn more

cookie alert

We use cookies to offer you a better browsing experience, analyze site traffic, personalize content, and serve targeted advertisements. If you continue to use this site, you consent to our use of cookies.

Nexthink Library

OneDrive – Advanced Operations

Back

OneDrive – Advanced Operations

Latest Version: 2.0.4.0
|
Updated on November 23, 2023
Install
Configuration

Description

OneDrive is a key productivity and collaboration application that millions of users around the world rely on to share and store key documents. When OneDrive crashes, becomes out of sync, or has accessibility issues, employees are suddenly faced with critical productivity blockers. Moreover, when employees cannot, or refuse to use OneDrive, IT could be faced with serious compliance and Shadow IT threats.

A stable, synced and accessible OneDrive environment is a must for any modern organization.

The OneDrive – Advanced Operations library pack allows you to monitor, manage and improve the usage and performance of your OneDrive environment throughout its lifecycle.

Leverage new metrics and remote actions to gain a keen understanding of your OneDrive deployment. You can monitor which devices have OneDrive clients installed and running, determine the update rings of those devices, and determine the number of files and their size stored locally or in the cloud.

In addition, you can track OneDrive sync status across your landscape to spot and fix sync issues plaguing your employees' collaborative environment.

Screenshots

Versions

  • 2.0.4.0 - 23 Nov 2023 - Updated OS requirements
  • 2.0.3.1 - 22 Jul 2022 - Fixed documentation typo error in "Get Microsoft Office Information" Remote Action
  • 2.0.3.0 - 16 Feb 2022 - Added the proper version of "Get Microsoft Office Information" Remote Action
  • 2.0.2.0 - 27 Oct 2021 - Execution frequency and suggested scheduling updated on "Get Microsoft Office Information" and "Get One Drive Information" Remote Actions
  • 2.0.1.0 - 08 Oct 2021 - Refactored "Get OneDrive Information" Remote Action, fixed an issue with paths longer than 259 characters
  • 2.0.0.0 - 27 Sep 2021 - Updated pack to have full feature parity with macOS and minor bugfixes
  • 1.1.0.0 - 17 Sep 2021 - Updated "Get OneDrive Information" Remote Action message
  • 1.0.0.3 - 02 Feb 2021 - Updating the description of the library pack on the web library.
  • 1.0.0.2 - 02 Feb 2021 - Fixed some typos found in the Slide-out help section of some of the dashboards.
  • 1.0.0.1 - 28 Jan 2021 - Changed minimum required Nexthink version from 6.30 down to 6.29
  • 1.0.0.0 - 28 Jan 2021 - Initial release

Content

Categories - 2
Dashboards - 4
Metrics - 40
Remote actions - 4
Get OneDrive Information Get OneDrive Sync Status Get MS Office information Get OneDrive Status

Required Products

Nexthink Act

Platforms

Windows 7 and newer
MacOS Catalina and newer

Compatibility

V6.27 and later

This Might Interest You

Workflow: Windows 11 migration
New

Orchestrate the Windows 11 migration process with automated compatibility checks and pre-to-post migration user engagement.

Released on April 11, 2024
View Library Pack

Workflow: Device assignment verification
New

Orchestrate the verification and update of device assignee information in the ServiceNow Hardware Asset Management database through a dedicated workflow.

Released on April 10, 2024
View Library Pack

Get OneDrive Information

Script Description

This Remote Action calculates information regarding the size of the Business and Personal OneDrive tenant folders.

Execution context and suggested scheduling

Run the script as 'interactive user'. The script should be executed every 1 day.

A timeout of 1320 seconds is recommended.

Parameters

Label Description
Maximum Delay In Seconds Maximum random delay set to avoid overloading server hosting virtual machines. Provide number of seconds less than 600
Sharepoint Server Set to 'true' if using Sharepoint Server for synchronizing folders on the endpoint. Path length is limited to 259 characters

Outputs

Label Type Description
Total Cloud Size Business Size Size of the OneDrive Business main tenant folder on the cloud
Total Local Size Business Size Size of the OneDrive Business main tenant folder on the disk
Size of the OneDrive Business tenant folders (other than main tenant) on the cloud Size Size of additional OneDrive folders
Total Local Size Shared Libraries Size Size of the OneDrive Business tenant folders (other than main tenant) on the disk
Total Cloud Size Personal Size Size of the OneDrive Personal tenant folders on the cloud
Total Local Size Personal Size Size of the OneDrive Personal tenant folders on the disk
One Drive Update Ring String Currently configured OneDrive Update Ring. For more information visit this link

Further Information

The Windows Remote Action gets the cloud and local size of Shared Libraries (which are the files that are not present on the Microsoft tenant) and also outputs the currently configured OneDrive update ring.

Starting in Windows 10, version 1607, MAX_PATH limitations have been removed from common Win32 file and directory functions. However, you must opt-in to the new behavior to support long paths.

To enable the new long path behavior, use the input "SharepointServer" and ensure the following is set:

- The registry key 'Computer\HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\FileSystem\LongPathsEnabled (Type: REG_DWORD)' must exist and be set to 1. The key's value will be cached by the system (per process) after the first call to an affected Win32 file or directory function (see below for the list of functions). The registry key will not be reloaded during the lifetime of the process. In order for all apps on the system to recognize the value of the key, a reboot might be required because some processes may have started before the key was set.

This registry key can also be controlled via Group Policy at Computer Configuration > Administrative Templates > System > Filesystem > Enable Win32 long paths.

Test Scenarios

OneDriveBusinessAccountConfigured
Test Case The device has a Business OneDrive folder with some Shared Libraries synced.
Environment Windows 10 x64 (1809)
Results Success - Folder content size was correctly returned with respective output parameters.
OneDriveNotInstalled
Test Case The device does not have a Business OneDrive installed.
Environment Windows 10 x64 (1809)
Results Failure - Exception is thrown reporting OneDrive accounts registry key is not accessible.
OneDriveAccountNotConfigured
Test Case The device does not have a Business OneDrive configured, or does not have any data.
Environment Windows 10 x64 (1809)
Results Success - Script completed successfully and returned zero bytes as output values.
OneDriveUpdateRingConfigured
Test Case The device is configured with specific OneDrive Update Ring.
Environment Windows 10 x64 (1809)
Results Success - Script completed successfully and returned current OneDrive Update Ring.
OneDriveUpdateRingNotConfigured
Test Case The device is not configured with OneDrive Update Ring.
Environment Windows 10 x64 (1809)
Results Success - Script completed successfully and reported message OneDrive Update Ring registry is not accessible.
OneDriveBusinessAccountConfigured
Test Case The device has a Business OneDrive folder synced.
Environment macOS Catalina (10.15.7) x64 (English) - macOS Big Sur (11.4) x64 (English)
Results Success - Folder content size was correctly returned with respective output parameters.
OneDrivePersonalAccountConfigured
Test Case The device has a Personal OneDrive folder synced.
Environment macOS Catalina (10.15.7) x64 (English) - macOS Big Sur (11.4) x64 (English)
Results Success - Folder content size was correctly returned with respective output parameters.
OneDriveNotInstalled
Test Case The device does not have a Business OneDrive installed.
Environment macOS Catalina (10.15.7) x64 (English) - macOS Big Sur (11.4) x64 (English)
Results Failure - Exception is thrown reporting OneDrive accounts registry key is not accessible.
OneDriveBusinessAccountNotConfigured
Test Case The device does not have a Business OneDrive configured, or does not have any data.
Environment macOS Catalina (10.15.7) x64 (English) - macOS Big Sur (11.4) x64 (English)
Results Success - Script completed successfully and returned zero bytes as output values. It also displays a status message about not being able to find any business accounts.

Get OneDrive Sync Status

Script Description

Gathers OneDrive sync status from the business accounts SyncDiagnostics.log.

Execution context and suggested scheduling

Run the script as 'interactive user'. The script should be executed manually.

A timeout of 120 seconds is recommended.

Parameters

None.

Outputs

Label Type Description
Sync Progress State String Status of the sync process
Timestamp DateTime Timestamp when the log was written for the last time
To Download Size Total amount of size pending to download
To Upload Size Total amount of size pending to upload
Files To Download Int Number of files pending to download
Files To Upload Int Number of files pending to upload
Changes To Process Int Number of changes pending to process
Changes To Send Int Number of changes pending to send
Download Speed BitRate Download speed
Upload Speed BitRate Upload speed
Estimated Time Remaining Millisecond Estimated time remaining to finish the sync process
Office Sync Active Bool Whether Microsoft Office sync is active on the device
Office Sync Enabled Bool Whether Microsoft Office sync is enabled on the device
File Failed Upload Count Int Number of failing uploads
File In Warning Count Int Number of warnings during the sync process

Restrictions

Test Scenarios

PersonalAccountsNotAllowed
Test Case The user has only a personal account in OneDrive
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Failure - Only business account are allowed
LogMissing
Test Case The log is not present in the expected folder
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Failure - The log must be present to gather the information
InformationGathered
Test Case The log is present with the expected data
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - The output fields are filled with the information from the log file
LogMissing
Test Case The log is not present in the expected folder
Environment VM macOS 10.15, 11, 12, 13
Results Failure - The log must be present to gather the information
InformationGathered
Test Case The log is present with the expected data
Environment VM macOS 10.15, 11, 12, 13
Results Success - The output fields are filled with the information from the log file

Get MS Office information

Script Description

Returns several Microsoft Office-related information, such as the version of the suite, the applications installed, the language preferences, the size of the user's Outlook Data Files and the used space in the OneDrive business account folder.Useful for troubleshooting both Office-related and disk space issues and for managing the Office migration to the cloud. The script is developed for Windows 10 and 7 and Microsoft Office 2010 onwards.

Execution context and suggested scheduling

Run the script as 'interactive user'. The script should be executed every 1 day.

A timeout of 120 seconds is recommended.

Parameters

None.

Outputs

Label Type Description
MS Office Version StringList Version of the Microsoft Office suite installed on the device
Installed Applications StringList List of installed Office applications
Active Display Language StringList Display language currently in use
Installed Display Languages StringList List of display languages installed on the device
Installed Editing Languages StringList List of editing languages installed on the device
Number Of PST Files Int Number of .PST files stored on the device
Number Of OST Files Int Number of .OST files stored on the device
PST Overall size Size Size of the .PST file, or sum of all .PST files' sizes
OST Overall size Size Size of the .OST file, or sum of all .OST files' sizes
One Drive Sync Files Size Size Size on the disk of the OneDrive folder
Other One Drive Sync Files Size Size Size on the disk of all other data locally synchronized through OneDrive agent

Further Information

Limited support for Click to Run deployments. Installed applications and language-related information cannot be retrieved.

Get OneDrive Status

Script Description

Checks if OneDrive application is working properly.

Execution context and suggested scheduling

Run the script as 'interactive user'. The script should be executed manually.

A timeout of 120 seconds is recommended.

Parameters

None.

Outputs

Label Type Description
One Drive Status StringList Overall result of the OneDrive health status review

Further Information

The Windows Remote Action reviews some processes status, registry keys and environment variables.

The macOS Remote Action reviews if the package is installed, the application is running and the OneDrive business account sync folder exists and is accessible.

Test Scenarios

OneDriveIsInstalledAndRunning
Test Case OneDrive application is installed, running and the business account folder exists and is accessible
Environment macOS Catalina (10.15.7) x64 (English) - macOS Big Sur (11.4) x64 (English)
Results Success - The output reflects the fact that OneDrive is installed and running and the sync folder is accessible
OneDriveIsNotInstalled
Test Case OneDrive application is not installed
Environment macOS Catalina (10.15.7) x64 (English) - macOS Big Sur (11.4) x64 (English)
Results Success - The output reflects the fact that OneDrive is not installed