You are using an ad blocker that is interfering with our web typography and internal javascript. Please whitelist our domain to live in a more beautiful world. No ads here, just really great software!

Be an IT Changemaker! Learn, get inspired and inspire others on our new DEX Hub. Visit now

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

Chatbot Content Pack

Latest Version: 3.0.0.0
Install

Required Products

Nexthink Act
Nexthink Engage

Platforms

Windows 7
Windows 10

Compatibility

V6.20 and later

Description

This Library pack is a collection of different Remote Action scripts which are used by the Nexthink Chatbot SDK integration to empower chatbots with Nexthink intelligence.The Nexthink Chatbot SDK contains a catalog of use cases using these Remote Actions.This catalog of use cases enables the end-user to gain both real-time insights about their device issues and the capability to remediate them automatically.

This Pack is made out of multiple Packs, without their Metrics and some Scores.

Versions

  • 3.0.0.0 - 26 Apr 2021 - Added "Invoke System Cleanup" Remote Action without user removal
  • 2.1.0.0 - 14 Apr 2021 - Updated "Disable Application from Startup menu", "Repair Office 365", "Repair OneDrive", "Repair Outlook OST Problem" and "Disk Cleanup" Remote Actions description
  • 2.0.0.0 - 15 Mar 2021 - Removed "Invoke System Cleanup" Remote Action
  • 1.7.4.0 - 19 Feb 2021 - Fixed "Invoke System Cleanup" Remote Action empty folders removal
  • 1.7.3.0 - 22 Dec 2020 - Fixed "Invoke System Cleanup" Remote Action by changing the way a user profile is deleted. User profile deletion is only supported on Windows 10 from this version on
  • 1.7.2.0 - 15 Dec 2020 - Fixed "Get Outlook Plugin Crash Details" Remote Action
  • 1.7.1.0 - 20 Nov 2020 - Fixed "Repair OneDrive" Remote Action
  • 1.7.0.0 - 03 Nov 2020 - Updated "Get Hardware And BIOS Information" Remote Action
  • 1.6.0.0 - 02 Oct 2020 - Updated "Restore SCCM Client" Remote Action
  • 1.5.1.0 - 03 Sep 2020 - Fixed "Disable Application from Startup menu" Remote Action
  • 1.5.0.0 - 28 Aug 2020 - Updated "Get Outlook Plugin Crash Details" Remote Action
  • 1.4.0.1 - 15 Jul 2020 - Edited description
  • 1.4.0.0 - 06 May 2020 - Renamed "Test Computer Group Policy Applied" by "Request VPN Connection for Compliance" and updated features
  • 1.3.0.0 - 02 Apr 2020 - Updated "Disk Cleanup" Remote Action
  • 1.2.0.0 - 02 Mar 2020 - Updated "Repair OneDrive" Remote Action
  • 1.1.1.0 - Fixed documentation
  • 1.1.0.0 - Updated "Disable Application From Startup Menu" Remote Action
  • 1.0.0.0 - Initial release

Get Battery Status

Script Description

Returns the health status of the battery installed on the laptop, in terms of capacity that it can still hold. It also retrieves the currently active power plan. Useful for identifying the batteries to be replaced and optimize the power settings of the devices.

Execution context and suggested scheduling

Run the script as 'local system'. The script should be executed manually.

A timeout of 120 seconds is recommended.

Parameters

None.

Outputs

Label Type Description
Battery Health Ratio Health ratio, expressed as a percentage
Battery Designed Capacity Int Initial capacity, in milliamp per hour (mAh)
Battery Full Charge Capacity Int Current full charge capacity, in milliamp per hour (mAh)
Battery Cycle Count Int Number of charge cycles the battery has so far
Estimated Battery Life Millisecond Estimated battery life time with one full charge. It will be 0 on Windows 7 devices
Power Plan String The power plan which is currently active on the device. It will display "Custom" if the power plan is not any of the default ones (Balanced, High performance, Power saving) and it will display "Unknown" in the case the information could not be retrieved

Restrictions

Test Scenarios

OneBattery
Test Case Device has one battery
Environment Windows 7 Pro x86 (English), Windows 10 x64 (English)
Results Successful - The output fields show correct data
NoBattery
Test Case Device has no battery
Environment VM Windows 7 x86/x64 (Multi-language), VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Failure - The battery on this device cannot be detected

Disk Cleanup

Script Description

An assisted-help campaign is triggered to perform a light (recycle bin) or a deep (recycle bin and user temporary folder) clean.In order to run a silent execution, campaign can be skipped by providing an empty GUID as input DiskCleanupCampaignId. In such case, CleanupLevel determines how cleanup will be processed.

Warning: This Remote Action permanently deletes user temporary files and recycle bin content from all targeted devices.

Execution context and suggested scheduling

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

A timeout of 720 seconds is recommended.

Parameters

Label Description
Disk Cleanup Campaign Id UID of the campaign to allow the user select which cleanup process will be done. Provide an empty GUID to avoid executing this campaign
Cleanup Completed Campaign Id UID of the campaign to notify the user about the finish of the cleanup process. Provide an empty GUID to avoid executing this campaign
Remove Files Not Modified In Days Files modified less recently than this threshold will be deleted. Provide number of days
Maximum Delay In Seconds Maximum random delay set to avoid overloading server hosting virtual machines. Provide number of seconds less than 600
Cleanup Level Cleanup level to support Chatbot solution. Relevant only in case empty guid is provided in DiskCleanupCampaignId parameter. Accepted values are (Light/Deep), by default Light is applied

Outputs

Label Type Description
Cleanup Space Size Space freed

Further Information

All files inside user temporary folder (%TEMP%) whose last write time is older than 'RemoveFilesNotModifiedInDays' input parameter, will be removed if deep cleanup option is selected in the campaign. Parameter 'MaximumDelayInSeconds' can be used to add random script execution delay. It should be used in virtualized environments to spread over time number of I/O requests on server hosting virtual machines.
The space freed is calculated by using the 'Free' property of the command Get-PSDrive before and after the execution.
It may be unaccurate or even report 0 in certain situations due to the fact that external applications or services could be occupying the free space by downloading, creating or unzipping files. In those cases, the remaining space after the Remote Action execution could be lower than the total space freed by it.

Test Scenarios

LightWithoutCampaigns
Test Case Both campaigns IDs are an empty GUID.
Cleanup Level is 'Light'.
RemoveFilesNotModifiedInDays is 0.
Environment Windows 10 x86/x64 - Windows 7 x86/x64
Results Success - All files in the recycle bin are deleted silently.
LightWithCampaigns
Test Case Both campaigns IDs are the default value.
The end user select Light cleanup on the first campaign.
RemoveFilesNotModifiedInDays is 0.
Environment Windows 10 x86/x64 - Windows 7 x86/x64
Results Success - All files in the recycle bin are deleted.
All campaign are called.
LightWithoutFirstCampaign
Test Case First campaign GUID is empty.
Second campaign GUID has default value.
Cleanup Level is 'Light'.
RemoveFilesNotModifiedInDays is 0.
Environment Windows 10 x86/x64 - Windows 7 x86/x64
Results Success - All files in the recycle bin are deleted.
Only the second campaign is called.
DeepWithoutCampaigns
Test Case Both campaigns IDs are an empty GUID.
Cleanup Level is 'Deep'.
RemoveFilesNotModifiedInDays is 0.
Environment Windows 10 x86/x64 - Windows 7 x86/x64
Results Success - All files in the recycle bin and the temp folder are deleted silently.
DeepWithCampaigns
Test Case Both campaigns IDs are the default value.
The end user select Deep cleanup on the first campaign.
RemoveFilesNotModifiedInDays is 0.
Environment Windows 10 x86/x64 - Windows 7 x86/x64
Results Success - All files in the recycle bin and the temp folder are deleted.
All campaigns are called.
DeepWithoutFirstCampaign
Test Case First campaign GUID is empty.
Second campaign GUID has default value.
Cleanup Level is 'Deep'.
RemoveFilesNotModifiedInDays is 0.
Environment Windows 10 x86/x64 - Windows 7 x86/x64
Results Success - All files in the recycle bin and the temp folder are deleted.
Only the second campaign is called.

System Cleanup

Script Description

Performs WinSxS folder cleanup using DISM Windows tool, deletes SCCM cached files older than provided age in days, removes user profiles and all types of system memory dump files (small, kernel and full) unused for more than provided threshold in days.

Execution context and suggested scheduling

Run the script as 'local system'. The script should be executed every 4 weeks.

A timeout of 720 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
SCCM Cache Files Creation Age In Days File age threshold to delete Configuration Manager cache older or equal age. Provide 0 to ignore
Dump Files Older Than Days File age threshold to remove older or equal age. Provide 0 to ignore

Outputs

Label Type Description
Cleanup Space Size Space freed

Restrictions

Further Information

Parameter 'MaximumDelayInSeconds' can be used to add random script execution delay. It should be used in virtualized environments to spread over time number of I/O requests on server hosting virtual machines.
SCCM cache cleanup does not work with Configuration Manager older than 2012.
The freed space shown in CleanupSpace output is calculated by accessing the 'FreeSpace' property of the Win32_Volume WMI Class before and after the execution.
Please consider this output as an orientation. It may be inaccurate or report 0 in certain situations due to the fact that external applications or services could be occupying the free space by downloading, creating or unzipping files.

Test Scenarios

NestedFoldersWindows10
Test Case Various nested folders and files in SCCM cache path and memory dump files location.
Environment Windows 10 x86
Results success - Disk cleanup successfully performed.
NestedFoldersWindows7
Test Case Various nested folders and files in SCCM cache path and memory dump files location.
Environment Windows 7 x64
Results success - Disk cleanup successfully performed.

Request VPN Connection for Compliance

Script Description

Compares last time Computer Group Policies were applied on target device against provided time range.By providing a list of corporate DNS domains, in case of the device being connected to the corporate network the script schedules a Group Policies update with 1 minute of delay.If the device is not in a corporate network, the script launches a campaign to encourage the user to connect to the corporate VPN and then it schedules the Group Policies update with 5 minutes of delay.The script offers the possibility of enforcing the Group Policies update in any case without notifying the user.

Execution context and suggested scheduling

Run the script as 'local system'. The script should be executed manually.

A timeout of 720 seconds is recommended.

Parameters

Label Description
Enforce Policy Update Provide values true or false in case you want to force Group Policies to be updated in any case, when the user is connected to corporate network and when it is not
Campaign Id CampaignId to encourage the user to connect the VPN to the corporate network. Empty value is not allowed, in case of you want to force Group Policies update without asking the user, use the EnforcePolicyUpdate parameter
Corporate Dns Domains Comma-separated list of corporate DNS names. Example "dc.nexthink.com, intranet.nexthink.com"
Days Since Last Group Policies Update Number of days in range of conducted search, must be between (1-180). 1 indicate range 0-24h ago, 2 indicate range 0-48h ago and so on

Outputs

Label Type Description
Corporate Network Bool Whether or not the user is connected to a corporate network based on the provided DNS domains
User Will Connect To Corporate Network Bool Whether or not the user will connect to the VPN to enable Group Policies update

Restrictions

Further Information

Only Computer Group Policies last update is checked.
It is recommended that the device be restarted for some applied policies to take effect, to achieve that you could use Restart Device Remote Action.
Updating Group Policies may be resources consuming, be aware of the user impact before executing it.

Test Scenarios

EnforcingGpoUpdate
Test Case EnforcePolicyUpdate is set to true, Group Policies are updated through a scheduled task.
Environment Windows 10 x64 EN 1909
Results Success - A scheduled task with 1 minute of delay is created to execute gpupdate command.
GpoUpdateNotNeeded
Test Case The last Group Policies update is within the threshold, nothing is updated.
Environment Windows 10 x64 EN 1909
Results Success - Nothing is scheduled and the result is reported to the engine.
DeviceConnectedToCorporateNetwork
Test Case The last Group Policies update is out of the threshold and the device is connected to the corporate network, Group Policies are updated.
Environment Windows 10 x64 EN 1909
Results Success - A scheduled task with 1 minute of delay is created to execute gpupdate command.
DeviceNotConnectedToCorporateNetworkUserAnswersYes
Test Case The last Group Policies update is out of the threshold, the device is not connected to the corporate network and the user answers Yes to the campaign, Group Policies are updated.
Environment Windows 10 x64 EN 1909
Results Success - A scheduled task with 5 minutes of delay is created to execute gpupdate command.
DeviceNotConnectedToCorporateNetworkUserAnswersNo
Test Case The last Group Policies update is out of the threshold and the device is not connected to the corporate network and the user answers No to the campaign, Group Policies are not updated.
Environment Windows 10 x64 EN 1909
Results Success - No scheduled task is created and the result is reported to the engine.

Update Group Policy Settings

Script Description

ADVANCED SCRIPTRefreshes computer or user Group Policy settings using the 'gpupdate' command. The script is designed for Windows 10 and 7.

Execution context and suggested scheduling

Run the script as 'interactive user'. In some environments it might be necessary to run as 'local system'. The script should be executed manually.

A timeout of 1200 seconds is recommended.

Parameters

Label Description
Group Policy Target Group Policy type to be updated. Choose whether to update the "user" or the "computer" policies
Force Reapplies all policy settings. Set it to "true" to apply all policy settings, not just those that have changed, "false" otherwise
Maximum Delay In Seconds Maximum random delay set to avoid domain controller overload. Provide number of seconds

Outputs

Label Type Description
User Name String User who is currently logged in

Restrictions

Further Information

During execution, 'gpupdate' sends a number of queries to domain controller. To reduce server overload, the script contains a random wait function which delays its execution from 0 up to maximum 600 seconds.
Maximum value of random script execution delay can be set in input parameter 'MaximumDelayInSeconds'.
It is recommended that the device be restarted for some applied policies to take effect.

Get Hardware And BIOS Information

Script Description

Returns detailed information concerning the Graphics Processing Unit (GPU) and RAM installed on the device. Additionally, the script obtains the serial numbers and types of the installed disks, as well as the BIOS version and release date.

Execution context and suggested scheduling

Run the script as 'local system'. The script should be executed manually.

A timeout of 120 seconds is recommended.

Parameters

None.

Outputs

Label Type Description
GPU Name StringList Name of the graphics card installed on the device
GPU Driver Vendor StringList Provider of the graphics card driver
GPU Driver Version StringList Version of the graphics card driver
Disk Serial Number and Type StringList For each installed disk drive, the number allocated by the manufacturer to identify the physical media and its type (HDD/SDD)
Total RAM Slots Int Total number of memory slots available on the device
Maximum RAM Size Maximum total amount of RAM that can be installed on the device
Used RAM Slots Int Number of memory slots currently used
Installed RAM Size Amount of RAM currently installed
RAM Bank Capacity StringList Capacity of each installed memory bank
RAM Bank Device Locator StringList For each installed memory bank, label of the socket or circuit board that holds the memory
RAM Bank Form Factor StringList For each installed memory bank, implementation form factor for the chip
RAM Bank Manufacturer StringList For each installed bank, name of the organization responsible for producing the physical element
RAM Bank Part Number StringList For each installed bank, part number assigned by the organization responsible for producing or manufacturing the physical element
RAM bank serial number StringList For each installed bank, manufacturer-allocated number to identify the physical element
RAM Bank Speed StringList For each installed memory bank, speed of the physical memory, in nanoseconds
RAM Bank Voltage StringList For each installed memory bank, configured voltage for this device, in millivolts
RAM Bank Total Width StringList For each installed memory bank, total width, in bits, of the physical memory, including check or error correction bits
Registry BIOS Version String BIOS version installed on the device obtained from the registry
WMI BIOS Version String BIOS version installed on the device obtained from the WMI Object 'Win32_BIOS'
BIOS Date String BIOS release date installed on the device

Further Information

Disk type functionality is only available for Windows 10 systems. When not possible to retrieve such information, 'Unknown' will be displayed.

Test Scenarios

SuccessfulExecution
Test Case Execute the remote action successful
Environment VM Win7 x64 - VM Win10 x64 (Multi-language) - Win10 x64 EN
Results Success - The remote action is executed without errors and all the retrieved information of the devices is shown
BIOSDateIsString
Test Case Check BIOSDate type is String in the Remote Action in Finder
Environment VM Win7 x64 - VM Win10 x64 (Multi-language) - Win10 x64 EN
Results Success - In Finder the output BIOSDate is type String
OutputBIOSDateIsUniversalFormat
Test Case Check BIOSDate format after executing the Remote Action
Environment VM Win7 x64 - VM Win10 x64 (Multi-language) - Win10 x64 EN
Results Success - After the execution of the Remote Action the format is Universal format ('yyyy/MM/dd HH:mm:ssk')

Repair Office 365

Script Description

Repairs Office 365 by using Office built-in command line tool.The remote action uses a campaign to ask for user permission to perform the repair.User is advised to save all Office applications work in progress, since they will be closed before performing the repair.Once the repair is completed, a campaign is displayed to notify its finalization to the user.

Warning: This Remote Action simultaneously downloads and installs the latest version of Microsoft Office 365 on all targeted devices. Please ensure that the available network capacity is appropriate for the number of targeted devices.

Execution context and suggested scheduling

Run the script as 'local system'. The script should be executed manually.

A timeout of 900 seconds is recommended.

Parameters

Label Description
Office Repair Campaign Id UID of the campaign to allow Office repair
Repair Completed Campaign Id UID of the campaign to notify Office repair completion
Maximum Delay In Seconds Maximum random delay set to avoid infrastructure overload. Provide number of seconds

Outputs

None.

Restrictions

Get OneDrive Status

Script Description

Checks if the OneDrive application is working properly by reviewing some processes status, registry keys and environment variables.

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

Complete list of performed validations:
* %localappdata%\Microsoft\OneDrive\OneDrive.exe exists.
* OneDrive.exe is running.
* %OneDrive% environment variable exists.
* Review the key HKEY_CURRENT_USER\Software\Microsoft\OneDrive\Accounts\Business1\UserFolder to check if that folder was created on devices.

If some validation fails, it means that OneDrive is not working properly. Further investigation is required, but a reinstall might be necessary.

Repair OneDrive

Script Description

Performs a OneDrive repair or reinstallation on the device, mitigating possible sync issues.

Warning: This Remote Action simultaneously downloads and installs the latest version of Microsoft OneDrive on all targeted devices. Please ensure that the available network capacity is appropriate for the number of targeted devices.

Execution context and suggested scheduling

Run the script as 'interactive user'. In some environments it might be necessary to run as 'local system'. The script should be executed manually.

A timeout of 1080 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
Action Action to be performed on OneDrive. Possible values are Repair or ReInstall

Outputs

None.

Restrictions

Further Information

When sync issues happen, it is enough with a repair of the OneDrive application. To perform it, current interactive user must be selected.
Repair action may delete all not synchronized files from OneDrive folder, please, back them up before executing the remote action.
Some problems need a complete reinstallation of the OneDrive application, or when devices have different and out-of-date versions installed. To fix this, the script downloads and installs the latest compliant version of OneDrive. Local system must be selected.
Reinstall action does not remove local files and a synchronization is executed after the process.
No popups are shown to the user as OneDrive reinstallation is executed in a silent mode.

Test Scenarios

ReinstallProvided
Test Case Reinstall is provided as action.
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - No errors related to this input parameter.
RepairProvided
Test Case Repair is provided as action.
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - No errors related to this input parameter.
InvalidValueProvided
Test Case An invalid value is provided as action.
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Failure - Error in parameter validation.
OneDriveInstalledInUserFolder
Test Case OneDrive is installed in the user folder.
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - The installation is detected.
OneDriveInstalledInProgramFilesFolder
Test Case OneDrive is installed in the program files folder.
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - The installation is detected.
OneDriveIsNotInstalled
Test Case OneDrive is not installed on the device.
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Failure - The application must be installed previously.
OneDriveInUserFolderIsRepaired
Test Case OneDrive is installed in the user folder and repair is passed as action.
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - It is repaired properly.
OneDriveInProgramFilesFolderIsRepaired
Test Case OneDrive is installed in the program files folder and repair is passed as action.
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - It is repaired properly.
OneDriveInUserFolderIsReinstalled
Test Case OneDrive is installed in the user folder and reinstall is passed as action.
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - It is reinstalled properly.
OneDriveInProgramFilesFolderIsReinstalled
Test Case OneDrive is installed in the program files folder and reinstall is passed as action.
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - It is reinstalled properly.

Get Outlook Online

Script Description

Checks if Outlook, part of Microsoft Office product, is working online.

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
Is Online Bool Microsoft Outlook is working online (yes/no)

Get Outlook Plugin Crash Details

Script Description

Retrieves details of Microsoft Outlook plugin crashes, with the focus on the most recent. Scope is limited by the company policy to control Event Log, which serves as a source of information.

Execution context and suggested scheduling

Run the script as 'local system'. The script should be executed manually.

A timeout of 120 seconds is recommended.

Parameters

Label Description
Crash Event Age In Days Number of days since crash event was created to include in scope. Provide 0 to search entire log

Outputs

Label Type Description
Last Crashed Plugin Date DateTime Date of last logged crash of a Microsoft Outlook plugin
Last Crashed Plugin Name String Name of last logged crash of a Microsoft Outlook plugin
Maximum Crash Count Plugin Name String Name of a Microsoft Outlook plugin that crashed most frequently
Crashed Plugin List StringList A list of all logged Microsoft Outlook plugin crashes with its total count, sorted by most recent date

Repair Outlook OST Problem

Script Description

Repairs Outlook problems with OST file by deleting it and restarting Outlook. Runs a campaign to close applications blocking OST file (Outlook and Skype). The script is designed for Windows 10 and 7 and Outlook 2010 onwards.

Warning: This Remote Action starts the simultaneous download of Microsoft Outlook emails on all targeted devices. Please ensure that the available network capacity is appropriate for the number of targeted devices.

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

Label Description
Campaign Id UID of the campaign to notify user that Outlook and Skype must be closed

Outputs

None.

Set Outlook online

Script Description

Checks if Outlook is working offline, and sets it to online if it is not already.

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

Label Description
Campaign Id UID of the campaign to notify user that Outlook must be restarted. If it's an empty GUID, the campaign won't be called

Outputs

None.

Further Information

Outlook must be restarted after this action for the changes to take effect.

Set Outlook Plugins

Script Description

Enables or disables each Microsoft Office Outlook COM add-in specified in the parameters. The names of the available add-ins can be found by running the 'Get Outlook Plugins' Remote Action.Campaign can be skipped by providing an empty GUID as input CampaignId.

Execution context and suggested scheduling

Run the script as 'local system'. The script should be executed manually.

A timeout of 120 seconds is recommended.

Parameters

Label Description
Campaign Id UID of the campaign to notify user that Outlook must be closed. Provide an empty GUID to enable execution without campaign
Action Enable or disable the desired add-ins. Accepted values are 'enable' and 'disable'
Plugin Names Comma-separated list of words to be matched with the addins. For example, 'skype' or 'microsoft'

Outputs

Label Type Description
Outlook Plugins Configured StringList List status of all Microsoft Outlook add-ins provided in input argument 'PluginName'

Further Information

Add-in names do not have to be exact, for example 'skype'. The script is designed only for devices which do not use GPO setting to manage Microsoft Outlook plugins.

Reset Print Spooler

Script Description

Clears the print queue of the user by restarting the Spooler service (and dependent services, if any), cleaning the folder '%systemroot%\\System32\\spool\\printers' and cleaning the Win32_PrintJob jobs.Useful for troubleshooting printing-related issues.

Execution context and suggested scheduling

Run the script as 'local system'. The script should be executed manually.

A timeout of 120 seconds is recommended.

Parameters

None.

Outputs

Label Type Description
Service StringList Information about the Print Spooler service
Job Files StringList Names of the job files deleted
Print Jobs StringList Description and owner of the Print jobs cleaned

Restore SCCM Client

Script Description

Restores SCCM-related client services (SMS Agent, BITS, WMI, etc) and retrieves information about SCCM client on devices.

Execution context and suggested scheduling

Run the script as 'local system'. The script should be executed manually.

A timeout of 120 seconds is recommended.

Parameters

None.

Outputs

Label Type Description
SMS Agent Status String Status of the SMS Agent Service
Background Intelligent Transfer Service Status String Status of the Background Intelligent Transfer Service
Windows Management Instrumentation Status String Status of the Windows Management Instrumentation Service
Remote Procedure Call Subsystem Status String Status of the Remote Procedure Call Subsystem Service
Windows Time Service Status String Status of the Windows Time Service
Client Installed Bool If SCCM client is installed or is not
Management Site String Site where the device is connecting to
Last Attempted Communication DateTime Last communication date with server
Last Cumulative Update String Last cumulative update installed on the device

Restrictions

Further Information

When restarting SCCM-related services, services with dependent services are not stopped in the first place. For safety considerations, those services are just started in case they were previously stopped.
Keep in mind that many dependent services may affect directly critical functionality of Collector (network, etc).

Skype for Business Diagnostics

Script Description

Creates files with information about Skype calls and calculates metrics of the last 24h.

Execution context and suggested scheduling

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

A timeout of 165 seconds is recommended.

Parameters

Label Description
Min Seconds For Call Minimum number of seconds to consider a call as a short call
Num Hours For Timeout Number of hours to consider an unfinished call as a dropped call

Outputs

Label Type Description
Total Calls Int Total number of calls (audio + video + screen sharing)
Total Audio Int Total number of audio calls
Poor Audio Perc Int Percentage of poor quality audio calls
Poor Audio Wired Perc Int Percentage of poor quality audio calls over Ethernet
Poor Audio Wifi Perc Int Percentage of poor quality audio calls over Wifi
Failed Audio Perc Int Percentage of failed audio calls
Dropped Audio Perc Int Percentage of dropped audio calls
Short Audio Perc Int Percentage of short audio calls
Bad Audio Perc Int Percentage of bad audio calls (either failed, dropped or poor)
Main Reason Failed Audio String Main reason for failed audio calls
Main Reason Dropped Audio String Main reason for dropped audio calls
Poor Audio Jitter Perc Int Percentage of poor quality audio calls due to "Jitter > 30 ms"
Poor Audio MOS Perc Int Percentage of poor quality audio calls due to "NetworkMOSDegradation > 1.0"
Poor Audio Round Trip Perc Int Percentage of poor quality audio calls due to "RoundTripTime > 500 ms"
Poor Audio Packet Loss Perc Int Percentage of poor quality audio calls due to "PacketLossRate > 0.1"
Poor Audio Concealed Perc Int Percentage of poor quality audio calls due to "RatioConcealedSamples > 0.07"
Total Video Int Total number of video calls
Poor Video Perc Int Percentage of poor quality video calls
Poor Video Wired Perc Int Percentage of poor quality video calls over Ethernet
Poor Video Wifi Perc Int Percentage of poor quality video calls over Wifi
Failed Video Perc Int Percentage of failed video calls
Dropped Video Perc Int Percentage of dropped video calls
Short Video Perc Int Percentage of short video calls
Bad Video Perc Int Percentage of bad video calls (either failed, dropped or poor)
Main Reason Failed Video String Main reason for failed video calls
Main Reason Dropped Video String Main reason for dropped video calls
Poor Video Jitter Perc Int Percentage of poor quality video calls due to "Jitter > 30 ms"
Poor Video MOS Perc Int Percentage of poor quality video calls due to "NetworkMOSDegradation > 1.0"
Poor Video Round Trip Perc Int Percentage of poor quality video calls due to "RoundTripTime > 500 ms"
Poor Video Packet Loss Perc Int Percentage of poor quality video calls due to "PacketLossRate > 0.1"
Poor Video Concealed Perc Int Percentage of poor quality video calls due to "RatioConcealedSamples > 0.07"
Poor Video Post FEC PLR Perc Int Percentage of poor quality video calls due to "VideoPostFECPLR > 0.1"
Poor Video Local Frame Loss Perc Int Percentage of poor quality video calls due to "VideoLocalFrameLossPercentage > 10%"
Poor Recv Frame Rate Perc Int Percentage of poor quality video calls due to "RecvFrameRate < 7"
Poor Low Frame Rate Perc Int Percentage of poor quality video calls due to "LowFrameRateCallPercentage > 10%"
Poor Video Packet Loss Rate Perc Int Percentage of poor quality video calls due to "VideoPacketLossRate > 0.1"
Poor Video Frame Rate Perc Int Percentage of poor quality video calls due to "VideoFrameRate < 7"
Poor Dynamic Capability Perc Int Percentage of poor quality video calls due to "DynamicCapabilityPercentage > 10%"
Total Sharing Int Total number of screen sharing calls
Poor Sharing Perc Int Percentage of poor quality screen sharing calls
Poor Sharing Wired Perc Int Percentage of poor quality screen sharing calls over Ethernet
Poor Sharing Wifi Perc Int Percentage of poor quality screen sharing calls over Wifi
Failed Sharing Perc Int Percentage of failed screen sharing calls
Dropped Sharing Perc Int Percentage of dropped screen sharing calls
Bad Sharing Perc Int Percentage of bad screen sharing calls (either failed, dropped or poor)
Main Reason Failed Sharing String Main reason for failed screen sharing calls
Main Reason Dropped Sharing String Main reason for dropped screen sharing calls
Poor Sharing Jitter Perc Int Percentage of poor quality screen sharing calls due to "Jitter > 30 ms"
Poor Relative One Way Perc Int Percentage of poor quality screen sharing calls due to "RelativeOneWay > 1.75"
Version And Tracing Level String Version and tracing level configured

Further Information

This remote action relies on Skype logs to analyse its call activity.
For Skype to log calls properly, the logging attribute must be set to Full or Light in Skype Options > General menu.

Test Scenarios

TraceFormatWith4Digits
Test Case The log trace format has 4 digits and registered calls in the threshold.
Environment Windows 10 x64 EN 1903
Results Success - The calls are retrieved correctly.
TraceFormatWith6Digits
Test Case The log trace format has 6 digits and registered calls in the threshold.
Environment Windows 10 x64 EN 1903
Results Success - The calls are retrieved correctly.
TestShortCall
Test Case Passed 15 as MinSecondsForCall and made a call with a duration of 5 seconds.
Environment Windows 10 x64 EN 1903
Results Success - The call is identified as a short call.
TestReceiverKillsSkype
Test Case A call is established and the receiver kills skype process.
Environment Windows 10 x64 EN 1903
Results Success in the caller results - The call is identified as a dropped call.
Success in the receiver results - The call is not registered because it is considered a call in progress. If in the following executions, the call duration passes the NumHoursForTimeout value, then the call is categorized as dropped.

Get Startup Impact

Script Description

Retrieves information of application impact on login process of last logged in user. Result data is similar to the information in the Startup tab in Windows Task Manager, enhanced by detailed impact of each application.

Execution context and suggested scheduling

Run the script as 'local system'. The script should be executed manually.

A timeout of 120 seconds is recommended.

Parameters

Label Description
Applications To Exclude Parameter is used to remove all processes matching provided name(s) from output. Multiple entries are separated by comma. Does not accept illegal characters. For more information see this article

Outputs

Label Type Description
User SID String User SID (Security Identifier) to whom the XML file containing the stats belongs
Last Start Up Analysis Date DateTime Last time the startup information was updated on the device
High Impact Count Int Number of applications with a high startup impact
High Impact Applications StringList Details (CPU time in ms, Disk I/O in MB) of programs with a high startup impact
High Impact Actionable Applications StringList Actionable names of programs with a high startup impact
Medium Impact Count Int Number of applications with a medium startup impact
Medium Impact Applications StringList Details (CPU time in ms, Disk I/O in MB) of programs with a medium startup impact
Medium Impact Actionable Applications StringList Actionable names of programs with a medium startup impact
Low Impact Count Int Number of applications with a low startup impact
Low Impact Applications StringList Details (CPU time in ms, Disk I/O in MB) of programs with a low startup impact
Low Impact Actionable Applications StringList Actionable names of programs with a low startup impact
Not Measured Impact Applications StringList Applications that were started but whose startup impacts were not measured by Microsoft Windows
Not Measured Impact Actionable Applications StringList Actionable names of programs not measured by Microsoft Windows

Further Information

Result data of 'ActionableApplications' output fields can be actioned with this Remote Action.

Test Scenarios

MultipleStartupProcessDataFiles
Test Case Execute the script on machines with multiple XML files in Windows StartupInfo location.
Environment VM Windows 10 x64 EN, VM Windows 10 x86 EN, VM Windows 10 x64 ES
Results Success - Last file that was written to was selected for data processing.
OutputFieldsFormat
Test Case Execute the script on machines with startup process data file containing all types of startup impact data.
Environment VM Windows 10 x64 EN, VM Windows 10 x86 EN, VM Windows 10 x64 ES
Results Success - All results are displayed correctly, 'Count' output fields as numbers, others as string lists.
NotMeasuredAndDisabledApplicationsDetection
Test Case Execute the script on machines with applications configured as startup disabled, or not included in startup process data file due to recent installation without reboot.
Environment VM Windows 10 x64 EN, VM Windows 10 x86 EN, VM Windows 10 x64 ES
Results Success - Disabled or not measured applications are returned properly.
ApplicationsOutputIncludeActionableNames
Test Case Execute the script on machines with startup process data file containing various impact levels.
Environment VM Windows 10 x64 EN, VM Windows 10 x86 EN, VM Windows 10 x64 ES
Results Success - Output fields 'ActionableApplications' contain list of all application 'actionable' (as in registry) names for given impact level.
ApplicationImpactOutputFormat
Test Case Execute the script on machines with startup process data file not containing any 'Process' data.
Environment VM Windows 10 x64 EN, VM Windows 10 x86 EN, VM Windows 10 x64 ES
Results Success - Output fields 'ApplicationImpact' is correctly formatted as '-' and respective 'Count' as '0'.
TestWindows7
Test Case Execute the script on Windows 7 machine.
Environment VM Windows
Results Failure - Exception thrown with message which OS is compatible.
StartupDataDoNotExist
Test Case Execute the script on machine with missing startup process data file.
Environment VM Windows 10 x64 EN
Results Failure - Exception thrown with message file does not exist or is not accessible.

Get Gpo Startup Impact

Script Description

Obtains from Windows Event Log a wide range of information about user/machine GPOs applied during user logon/device startup. The script is designed for Windows 7 and 10.

Execution context and suggested scheduling

Run the script as 'local system'. The script should be executed manually.

A timeout of 120 seconds is recommended.

Parameters

None.

Outputs

Label Type Description
User Gpo Successfully Applied Bool Status of last user GPOs applied during user logon
Dc Connection Time Millisecond Duration time necessary for the device to connect to Domain Controller during user logon
Dc Information String Domain Controller DNS name and IP used during user logon
Total User Gpo Applied Time Millisecond Duration time necessary for the device to apply all user policies
User Gpo Categories String List of all user GPOs categories applied on the device
User Total Gpo Processing Time Millisecond Duration time necessary for the device to connect to the domain controller, download user policies and apply them
Computer Gpo Successfully Applied Bool Status of last computer GPOs applied during device startup
Total Computer Gpo Applied Time Millisecond Duration time necessary for device to apply all computer policies
Computer Gpo Categories String List of all device GPOs categories applied on the device
Computer Total Gpo Processing Time Millisecond Duration time device needed to connect to the domain controller, download computer policies, apply them and run startup scripts

Further Information

Useful for troubleshooting Active Directory issues on the domain joined devices.

Get Windows Information - DEPRECATED

Script Description

Returns the following information:

   * Windows build name.
   * Date on which Windows has been installed.
   * Display language currently set in Windows.
   * List of the user accounts defined on the local computer.
   * PowerShell, Java, Python and .Net versions.
   * Execution policies for PowerShell.
   * Status of the BitLocker Drive Encryption.
   * Reboot information.

Execution context and suggested scheduling

Run the script as 'local system'. The script should be executed manually.

A timeout of 120 seconds is recommended.

Parameters

Label Description
Disk Drive Volume for which the Bitlocker information should be returned (e.g. C)

Outputs

Label Type Description
Windows Build String Windows build name
Windows Install Date DateTime Date on which Windows has been installed
Windows Display Language String Display language currently set in Windows
Windows Local Accounts StringList List of the user accounts defined on the local computer
PS Version String PowerShell version (Major.Minor)
PS Policy Process String Execution policy affecting the remote actions executed by the current Windows PowerShell session. It is set within a PowerShell session via a variable
PS Machine Policy String Execution policy set through the machine GPO
PS user Policy String Execution policy set through the user GPO
PS Policy Current User String Execution policy affecting only the current user. It is set for the current user on a machine through a registry key
PS Policy Local Machine String Execution policy affecting all users of the computer. It is set for the local machine through a registry key
Bit Locker Protection Status String Indicates whether the volume and its encryption key (if any) are secured
Bit Locker Conversion Status String The status of the encryption or decryption on the volume
Bit Locker Percentage Encrypted Ratio The percentage of volume that is currently encrypted
Bit Locker Encryption Method String The encryption algorithm and key size used on the volume
Bit Locker Key Protectors StringList Lists of protectors used to secure the volume's encryption key
Last Reboot DateTime Date and time of last reboot. It also considers reboots performed while the device was offline (no connection between the Nexthink Collector and the Engine)
Number Of Days Since Last Reboot Int Number of days since the last time the machine was rebooted. It also considers reboots performed while the device was offline (no connection between the Nexthink Collector and the Engine)
Startup Mode String Name of machine startup mode: 'UEFI' or 'BIOS'
Secure Boot Enabled String Status of Secure Boot feature: 'Yes', 'No', 'Not available'
Dot Net Version String Latest version of .Net
Python Version String Default version of Python
Java Version String Default version of Java

Further Information

SecureBoot functionality only available for Windows 10.
Python must be installed for all users to present version information.

Disable Application from Startup menu

Script Description

Disables startup of every application from ApplicationsToDisable parameter, excluding all listed in ApplicationsToKeep parameter.If all applications should be disabled except specific ones, use only ApplicationsToKeep as a white-list and leave ApplicationsToDisable empty ().If only some specific applications should be disabled, use only ApplicationsToDisable and leave ApplicationsToKeep empty ().If an application is present in both parameters, ApplicationsToKeep takes precedence and the application will not be removed from Startup.

Warning: End-users could rely on the auto-start of applications that this Remote Action disables. Please perform appropriate testing before release.

Execution context and suggested scheduling

Run the script as 'local system'. The script should be executed manually.

A timeout of 120 seconds is recommended.

Parameters

Label Description
Applications To Keep Comma-separated list of programs to be kept on the Startup. Name has to be exactly as the processes' name (e.g. Lync, vmware-tray.exe)
Applications To Disable Comma-separated list of programs to be disabled on the Startup. Name has to be exactly as the processes' name (e.g. Lync, vmware-tray.exe)
Action Action to be taken with the programs to disable registry keys. Value should be 'Delete' for erasing the applications from the Startup menu and 'Disable' to keep them disabled

Outputs

None.

Restrictions

Further Information

In order to get the exact names for the input parameters, you can use Get Startup Impact Remote Action to get the list of startup applications

You may also want to check the following registry keys for local machine (HKLM) and logged user (HKU\<sid> or HKCU):
* '\SOFTWARE\Microsoft\Windows\CurrentVersion\Explorer\StartupApproved\Run'
* '\SOFTWARE\Microsoft\Windows\CurrentVersion\Explorer\StartupApproved\Run32'
* '\SOFTWARE\Microsoft\Windows\CurrentVersion\Explorer\StartupApproved\StartupFolder'
* '\SOFTWARE\Microsoft\Windows\CurrentVersion\Run'
* '\SOFTWARE\Microsoft\Windows\CurrentVersion\RunOnce'
* '\SOFTWARE\WOW6432Node\Microsoft\Windows\CurrentVersion\Run'
* '\SOFTWARE\WOW6432Node\Microsoft\Windows\CurrentVersion\RunOnce'
You can use Get Windows Registry Key Values remote Action to get this information.

Test Scenarios

ApplicationsToKeep
Test Case ApplicationsToKeep input parameter is provided.
ApplicationsToDisable is not provided (empty).
Action is 'Disable'.
Environment Windows 10 (1803/1809/1903) x86/x64 - EN/ES
Results Success - Applications present in ApplicationsToKeep were not disabled from startup. The rest of the applications were disabled from startup.
ApplicationsToDisable
Test Case ApplicationsToDisable input parameter is provided.
ApplicationsToKeep is not provided (empty).
Action is 'Disable'.
Environment Windows 10 (1803/1809/1903) x86/x64 - EN/ES
Results Success - Applications present in ApplicationsToDisable were disabled from startup. The rest of the applications were not affected.
ApplicationsToDelete
Test Case ApplicationsToDisable input parameter is provided.
ApplicationsToKeep is not provided (empty).
Action is 'Delete'.
Environment Windows 10 (1803/1809/1903) x86/x64 - EN/ES
Results Success - Applications present in ApplicationsToDisable were disabled and removed from Task Manager's Startup tab. The rest of the applications were not affected.
ApplicationsToKeepAndToDisable
Test Case Both ApplicationsToKeep and ApplicationsToDisable input parameters were provided.
Action is 'Disable'.
Environment Windows 10 (1803/1809/1903) x86/x64 - EN/ES
Results Success - Applications present in ApplicationsToKeep were not disabled from startup.
Applications present in ApplicationsToDisable were disabled from startup.
The rest of the applications were not affected.
ApplicationInBothParameters
Test Case Both ApplicationsToKeep and ApplicationsToDisable input parameters were provided.
There is an application that is present in both input parameters.
Action is 'Disable'.
Environment Windows 10 (1803/1809/1903) x86/x64 - EN/ES
Results Success - ApplicationsToKeep takes preference. Therefore, all applications in ApplicationsToDisable were disabled from startup except the application present in both lists.
EmptyApplicationLists
Test Case Both lists of applications to keep and to disable were empty.
Environment Windows 10 (1803/1809/1903) x86/x64 - EN/ES
Results Failure - The remote action execution failed, since at least one of the input parameters must be provided.