Skip to main content
Skip table of contents

Configuration guide: Battery replacement scheduling

Introduction

To get started with this workflow, please ensure all related content is installed and configured appropriately. This page provides guidance on which content is included and how to configure it.

Please keep in mind this is just a guide and represents suggested configurations. You are free to customize and edit content as you see fit based on your specific environment. 

Dependencies

To utilize this workflow, you need to install the necessary content into your Nexthink Infinity tenant.

Pre-requisites 

This library pack contains content from the following expansion products

Content and dependency

Type

Name

Description

Workflows

Battery replacement scheduling

Automate the end-to-end battery replacement process.

Campaigns

Battery replacement advisory

The campaign informs the user that their battery is due for replacement and ask for their permission to log an ITSM ticket to have it replaced

Remote Actions

Get Battery Status

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

Get Warranty Information

Retrieves warranty information of Dell and/or Lenovo devices, via REST APIs. The warranty data obtained can be also related to the laptop batteries.

Configuration

Step 1) Install library pack content

Go to the Nexthink Library and install all required content.

Step 2) Configure ITSM API connector credentials

The configuration of connector credentials is essential for enabling API calls. See detailed information at https://docs.nexthink.com/platform/latest/webhooks-manage-credentials . Each Service/API thinklet has a dropdown field for credentials that needs to be filled out. When the workflow is installed or copied from the Library, this field will be blank as it is a local setup of each environment and is not included in the Library.

Connector credential.png
image-20240119-144723.png

Step 3) Configure global parameters

There is one global parameter in this workflow:

  • itsm_sys_id - the reference for a single global ITSM ticket created before running the workflow.

Before running the workflow, a ticket should be logged in ITSM for battery replacement. The ticket reference (sys_id for ServiceNow) can then be added to the workflow as a global parameter. As the workflow progresses and tickets need to be logged, the workflow will append comments to this global ticket with essential details, such as the device name and the battery and warranty status.

Step 4) Configure remote action(s)

Name

Trigger

Schedule Query

Parameters to edit

Get Battery Status

API trigger should be enabled so that it can be triggered from the Workflow

CODE
devices
| where device.hardware.manufacturer in ["Dell", "Lenovo", "Apple"] 
| where hardware.type == laptop
| list name, hardware.manufacturer

Temperature output (Celsius/Fahrenheit)

Get Warranty Status

API trigger should be enabled so that it can be triggered from the Workflow

CODE
devices
| where device.hardware.manufacturer in ["Dell", "Lenovo", "Apple"] 
| where hardware.type == laptop
| list name, hardware.manufacturer

In order to retrieve the warranty information of Dell and/or Lenovo devices, via REST APIs, there are certain input fields that need to be populated. Please refer to the table below for more details.

Get warranty status - input parameters

Name

Default value

Description

MaximumDelayInSeconds

30

Maximum delay in seconds to avoid overloading the vendor servers with too many API requests occurring at the same time

DellClientID

None

Dell Client ID

DellClientSecret

None

Dell Client Secret token

DellDeviceWarrantyItemNumbers

None

List of Dell's device warranty item numbers from where to retrieve the information. The elements should be separated by comma

DellBatteryWarrantyItemNumbers

None

List of Dell's battery warranty item numbers from where to retrieve the information. The elements should be separated by comma

LenovoClientToken

None

Lenovo Client token

LenovoDeviceWarrantyProductCodes

None

List of Lenovo's device warranty product codes from where to retrieve the information. The elements should be separated by comma

LenovoBatteryWarrantyProductCodes

None

List of Lenovo's battery warranty product codes from where to retrieve the information. The elements should be separated by comma

Further Information

The Warranty Item Number found in the API response is known as the SKU number on the Dell Invoice. Choose the SKUs for the support item that relates to the device warranties for each purchased model. Do the same for the batteries, which are typically included with shorter warranty period. These SKU values are what should be used in DeviceWarrantyItemNumbers input parameters.

Step 5) Configure campaign

This workflow contains one Engage campaign “ Battery Replacement Advisory”. The purpose of this campaign is to inform the employee that their battery has been identified as being in need of replacement and to check with them whether or not they would like to proceed with ordering a replacement. This adds a crucial step to the process, as an employee's particular work habits may mean that they are not impacted by a poor battery.

image-20231228-103646.png

This campaign should be modified before use to ensure that it matches corporate communication guidelines.. Navigate to the manage campaigns administration page to review and edit your campaigns. 

For each installed campaign, please ensure to: 

  • Customize the sender name and image.

  • Review and adjust questions.

  • Publish the campaign when you are ready to use it.

Step 6) Configure battery replacement criteria

The workflow will identify devices with batteries that need to be replaced, using the same logic as the Battery Health dashboard. This logic can be adjusted within the workflow if required. By default devices are considered to be candidates for battery replacement if they fulfil the following requirements:

  • Windows

    • Battery health < 60%

    • Battery Cycle Count > 300

  • macOS

    • Battery Condition: Service Recommended

Step 7) Schedule the workflow

The Battery replacement scheduling workflow can be triggered on all laptop devices but is designed to work best with Dell and Lenovo Windows devices, and MacBooks. The workflow will identify devices with batteries that need to be replaced, using the same logic as the Battery Health dashboard. For Dell and Lenovo devices it will then determine if the device, and/or the battery are covered by the manufacturer’s warranty. The workflow will then engage with the user to notify them that their battery is in need of replacement and ask them for feedback on their battery performance so that they can give their permission for the global ITSM ticket to be updated.

Trigger configuration for the workflow

This workflow is primarily designed to run periodically using a scheduled trigger. However, it can also be manually triggered for ad hoc usage on single or multiple devices as required, through the use of an Investigation.
The example below shows how the automatic schedule could be configured for a periodical check of laptop devices fully compatible with the workflow.

NQL:

CODE
devices
| where device.hardware.manufacturer in ["Dell", "Lenovo", "Apple"] 
| where hardware.type == laptop
| list name, hardware.manufacturer

Usage guide

Your content is now configured and ready to be used. For usage overview and recommendations, you can visit the usage guide: 

Usage guide: Battery replacement scheduling

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.