LogoLogo
LearnDocumentationSupportCommunity
Version 6.30
Version 6.30
  • Welcome
  • Nexthink V6
  • Overview
    • Software components
    • Collector
    • Finder
    • Engine
    • Portal
    • Nexthink Library
    • Digital Experience Score
  • Installation and configuration
    • Planning your installation
      • Overview of the installation process
      • Hardware requirements
      • Connectivity requirements
      • Software requirements
      • Reference architectures
    • Installing Portal and Engine Appliances
      • Installing the Appliance
      • Installing the Appliance on Azure
      • Installing the Appliance on AWS
      • Installing the Appliance on OTC
      • Managing Appliance accounts
      • Setting the names of the Portal
      • Setting the names of the Engines
      • Specifying your internal networks and domains
      • Federating your Appliances
      • STIG compliance in Web Console
      • Connecting the Portal to the Engines
      • Configuring session performance storage
      • Configuring device performance storage
      • Setting up a software license
      • Sending email notifications from the Appliance
      • Allocating resources for the Portal
    • Installing the Collector
      • Installing the Collector on Windows
      • Installing the Collector on macOS
      • Installing the Collector for a Proof of Value
      • Assigning Collectors to Engines
      • Assignment of roaming Collectors
      • Collector MSI parameters reference table
      • Nxtcfg - Collector configuration tool
      • Inspecting the connection status of the Collector
      • Querying the status of the TCP connection of the Collector
      • Reporting the URL of HTTP web requests
      • Auditing logon events
      • Viewing user interactions in virtualized and embedded environments
      • Engage notifications on macOS
      • Configuring Collector level anonymization
    • Collector remote connectivity
      • Redirecting and anonymizing Collector traffic
      • Redirecting the Collector TCP channel
      • Support for DirectAccess
      • Windows Collector proxy support
      • Mac Collector proxy support
    • Installing the Event Connector
      • Installing the Event Connector on Linux
    • Installing the Finder
      • Installing the Finder on Windows
      • Enabling Cross-Engine Finder features
      • Expanding the time frame of investigations in the Finder
      • Enabling Finder access to the Library
      • Finder proxy support
    • Updating from V6.x
      • Updating the Appliance
      • Content centralization when updating the Appliance
      • Updating the Collector
      • Viewing Collector deprecated fields
      • Updating the Finder
    • Security and user account management
      • Importing and replacing certificates
      • Hierarchizing your infrastructure
      • Adding users
      • Enabling SAML authentication of users
      • Just-In-Time provisioning of user accounts
      • Enabling Windows authentication of users
      • Multi-factor authentication for local accounts overview
      • Provisioning user accounts from Active Directory
      • Establishing a privacy policy
      • Disabling local accounts for interactive users
      • Setting the complexity and minimum length of passwords for local accounts
      • Protecting local accounts against brute force attacks
      • Preventing password saving in the Finder
      • Controlling session timeouts in the Portal
      • Security settings in the Appliance
      • Setting the Do Not Disturb periods between campaigns
    • Data retrieval and storage
      • Data retention
      • Increasing the maximum number of metrics
      • Establishing a data retention policy in the Engine
      • Storing Engine data in a secondary disk drive
      • Importing data from Microsoft Active Directory
      • Setting the locale in the Portal
      • Changing the Time Zone of the Portal
      • Time Zones and data collection
      • Changing the data collection time of the Portal
      • Nightly task schedules timetable
      • Changing the thresholds of High CPU warnings
      • Automatic restart of unresponsive Engine
    • Maintenance operations
      • Logging in to the CLI
      • Special operation modes for the Engine and the Portal
      • Changing the default ports in the Appliance
      • Centralized Management of Appliances and Engines
      • Monitoring the performance of the Appliance
      • Resizing partitions in Appliance
      • Configuring the system log
      • Examining the logs in the Portal
      • GDPR - Retrieving or anonymizing personal data
      • Finding out unlicensed devices
      • Removing devices
      • Installing third-party software in the Appliance
      • Installing VMware Tools in the Appliance
      • Operational data sent to Nexthink
      • Sending additional data to Support
    • Disaster recovery
      • Planning for disaster recovery
      • Web Console backup and restore
      • Engine backup and restore
      • Portal backup and restore
      • Rule-based assignment backup and restore
      • License backup and restore
      • PKI backup and restore
    • Branding
      • Branding the Portal
      • Branding of campaigns
  • User manual
    • Getting started
      • Logging in to the Finder
      • Logging in to the Portal
      • Enabling STIG in Webconsole
    • Querying the system
      • Searching the subject of interest
      • Executing an investigation
      • Creating an investigation
      • Editing the options of an investigation
      • Combining logical conditions in investigations
      • Navigating through the results of an investigation
      • Properties of users and devices
    • Visualizing system activity in the Finder
      • Getting a quick overview
      • Graphically observing the activity of users and devices
      • Observing service performance
      • Viewing network connections
      • Viewing web requests
      • Viewing executions
    • Monitoring IT custom metrics
      • Creating a metric
      • Examples of metrics
      • Session performance
      • Device performance
      • Following the evolution of a metric
      • Finding the visuals of a metric
    • Monitoring IT services
      • Analyzing service quality
      • Creating a service
      • Following the evolution of a service
      • Specifying URL paths of web-based services
    • Engaging with the end user
      • Getting feedback from the end users
      • Types of campaigns
      • Creating a campaign
      • Editing a campaign
      • Types of questions
      • Controlling the flow of questions
      • Translating a campaign
      • Triggering a campaign manually
      • Limiting the reception rate of campaigns
      • Scrutinizing the results of a campaign
      • Continuously measuring the satisfaction of employees
    • Rating devices and users with scores
      • Computing scores
      • Creating a score
      • Checking and comparing ratings
      • Computing potential savings
      • Score XML Reference
      • Documenting scores
    • Remotely acting on devices
      • Scenarios for remote actions
      • Creating a remote action
      • Executing remote actions
      • Triggering a remote action manually
      • Writing scripts for remote actions on Windows
      • Writing scripts for remote actions on Mac
      • Example of self-healing scenario
      • Example of self-help scenario
      • Application control and remote actions
    • Organizing objects with categories
      • Classifying objects of the same type
      • Creating categories and keywords
      • Tagging objects manually
      • Tagging objects automatically
      • Importing tags from text files
    • Getting notified by the system
      • Receiving Engage campaigns
      • Receiving email digests
      • Receiving alerts
      • Creating a service-based alert
      • Creating an investigation-based alert
    • Building web-based dashboards
      • Introducing dashboards in the Portal
      • Creating a dashboard
      • Examining metrics in depth
      • Documenting dashboards
      • Assessing license use
      • Computing dashboard data
      • Reusing dashboard content
    • Importing and exporting authored content
      • Methods for reusing authored content
      • Manually sharing Finder content
      • Importing a content pack
      • Conflict resolution
      • Exporting a content pack
  • Library packs
    • Compliance
      • Device Compliance
    • Configuration Manuals
      • Overview (Configuration Manuals)
      • Installing A New Version Of A Library Pack
    • Digital Employee Score (DEX score)
      • DEX Score Installation And Configuration
      • Detailed Library Pack Changelog
    • Device management
      • Reduce logon duration
      • Group Policy Management
      • Hardware Asset Renewal
      • Hardware Asset Renewal Advanced
      • Application Auto-Start Impact
    • Remote Employee Experience
      • Remote Worker Experience
      • Home Networking
      • Change Log And Upgrade Process
      • Remote Worker Vs Office Worker Device Category
      • Remote Worker Insights
      • DEX V2 Upgrade Of Remote Worker
    • Persona Insight
      • Persona Insight - Overview
      • Persona Insight - Library Pack
      • Persona Insight - Score Only Pack
      • Persona Insight - Without Campaign pack
      • Persona Insight - Getting Started and Upgrade Procedure
      • Persona Insight - Configuration Guide
      • Persona Insight - Troubleshooting - Multiple devices on multiple engines
      • Persona Insight - Reference Guide
      • Persona Insight - Example Pack
      • Persona Insight - Device Sizing
        • Persona Insight - Device Sizing Overview
        • Persona Insight - Device Sizing Configuration
      • Persona Insight - Application Sizing
        • Persona Insight - Application Sizing Overview
        • Persona Insight - Application Sizing Configuration
      • Legacy Persona documentation
        • Persona Insight - Library Pack (V.1.0.0.0)
        • Persona Insight - Base Pack
        • Persona Insight - Base Pack Advanced
        • Persona Insight - Customization Guide (V1.0.0.0)
        • Persona Insight - Configuration Guide (V1.0.0.0)
        • Persona Insight - Reference Guide (V1.0.0.0)
    • GSuite
      • GSuite: Health
      • GSuite: Services
      • GSuite: Sentiment
      • GSuite: Advanced Health
    • Support
      • Support: Level 1
    • Shadow IT
      • Shadow IT
    • Malware Protection
      • Malware Protection
    • Office 365 Health
      • Office 365 Health: Overview
      • Office 365 Health: Services
    • Office 365 OneDrive
      • OneDrive Summary
      • OneDrive Operations
      • OneDrive Advanced Health
      • OneDrive Migration
      • OneDrive Sentiment
      • OneDrive Management
      • OneDrive Advanced Operations
    • Office 365 Teams
      • Teams Overall Configuration
      • Teams - Migration
      • Teams - Health
      • Teams - Advanced Health
      • Teams - Adoption
    • Microsoft 365 Apps
      • Microsoft 365 Apps - Operate
    • Employee Self Service
      • Overview
      • Configuration
      • Usage
    • Onboarding Experience Management
      • OEM - Overview
      • OEM - Configuration
    • Office 365 Outlook
      • Outlook Troubleshooting
    • Virtualization
      • Virtualization: Operate
      • Virtualization: AVD - Advanced
      • Virtualization: Citrix Advanced
      • Virtualization: Project
      • Virtualization: Troubleshooting
        • Virtualization: Troubleshooting: Configuration
    • Windows
      • Win10: Configuration
      • Win10: Migration
      • Win10: Feature Update
      • Win10: Quality Update
      • Windows Defender Management
      • Administrators Management
    • Windows 11
      • Windows 11 - Readiness
      • Windows 11 - Migration Pilot
      • Windows 11 - Migration
      • Windows 11 - Operate
    • Webex
      • Webex Operate
    • Zoom
      • Zoom Operate
    • Remote Actions
      • Get Performance Monitor Data
      • Skype For Business
      • Restart Device
      • Upload Logs to S3 using PreSigned URLs
    • Software Asset Optimization
    • Collaboration Optimization
      • Collaboration Optimization - Solution Overview
      • Collaboration Optimization - Configuration
      • Collaboration Optimization - Usage / Troubleshooting
    • Systems Management
      • Manage Configuration Drift
      • MS ConfigMgr - Client Health
        • MS ConfigMgr - Client Health - Summary
        • MS ConfigMgr - Client Health - Configuration Guide
      • Intune
        • Intune - Health
          • Intune - Health - Summary
          • Intune - Health - Configuration Guide
    • Return to the office
      • Return to the office - Planning
      • Return to the office - Readiness
    • Green IT
      • Green IT - Overview
      • Green IT - Configuration Guide
    • Hybrid Working
      • Hybrid Working Experience
      • Hybrid Working Experience - Installation and upgrade procedure
  • Integrations
    • Nexthink ServiceNow Service Graph Connector
      • Overview
        • Roles and Permissions
        • Modules
      • Installation and Configuration Guide
        • Pre-requisites
          • Configure Identification Rules
          • Import and setup the CMDB categories in Finder
        • Setup
          • Configure the connection
          • Configure import properties
          • Configure additional engines
          • Set up scheduled import jobs
      • Data transformation and mapping by default
      • How to customize the behaviour of the Connector
      • FAQ
        • Why ServiceNow Service Graph Connector?
        • What about Nexthink CMDB Connector?
        • Why is the name the primary key for the devices?
      • Troubleshooting
        • IRE identification issues
          • [No Choice found in the sys_choice table for the target table](integrations/nexthink-servicenow-service-graph-connector/troubleshooting/ire-identification-issues/ no-choice-found-in-the-sys_choice-table-for-the-target-table.md)
          • Identification rules not created
          • Discovery_source choice not created
        • Timeout Errors
          • ECCResponseTimeoutException
          • HTTP 0 error
        • MID server issues
          • java.lang.NullPointerException
          • MID Server memory issues
          • Not trusted certificates in Quebec release
        • Configure credentials issues
          • [Not allowing update of property authentication_choice](integrations/nexthink-servicenow-service-graph-connector/troubleshooting/configure-credentials-issues/ not-allowing-update-of-property-authentication_choice.md)
          • Invalid username/password combo (HTTP 401/403)
        • Configure Engines Issues
          • [The client secret supplied for a confidential client is invalid](integrations/nexthink-servicenow-service-graph-connector/troubleshooting/configure-engines-issues/ the-client-secret-supplied-for-a-confidential-client-is-invalid.md)
        • No Cis imported and no errors found in the log
    • Nexthink ServiceNow Incident Management Connector (IMC)
      • Installation and configuration guide (IMC)
      • Troubleshooting Guide (IMC)
      • Domain separation installation (IMC)
    • Nexthink ServiceNow CMDB Connectors
      • Installation and Configuration Guide
      • Troubleshooting Guide
      • Field transformation and normalisation examples
    • Nexthink Event Connector
      • High level overview
      • Installation and Configuration Guide
      • Troubleshooting guide
      • RPM installation
      • Splunk specific documentation
        • Upgrading from Splunk Connector to Event Connector
        • Splunk add-on installation and usage
    • Nexthink Chatbot SDK
      • Introduction and concepts
      • Installation, configuration and update guide
        • Installation and configuration
        • Update to newer version
        • Uninstallation
        • Authentication
        • Topics configuration
        • Remote action configuration
        • Advanced configuration
        • Additional resources and references
      • Dimensioning guide
      • Troubleshooting
      • Technical solution description
      • Downloads and release notes
  • Glossary and references
    • Search and information display
      • Search in Finder
      • Keyboard shortcuts for column display selection
      • Campaign display compatibility
      • Real-time and consolidated service data
      • Service errors and warnings
      • Errors and warnings for devices and executions
      • Types of widgets
      • Widget compute state in charts
      • Errors in the execution of remote actions
      • Top results of Cross-Engine investigations
      • Engine data history
    • Tooltips in the user and device views
      • Alerts tooltips
      • Warnings tooltips
      • Errors tooltips
      • Activity tooltips
      • Services tooltips
    • Database information and organization
      • Maximum supported values
      • Local and shared content
      • Device Identification
      • Local IP address of devices
      • Timestamping of events
      • Boot and logon duration
      • Application startup duration
      • Application not responding events
      • Memory and CPU usage
      • Status of TCP connections
      • Status of UDP connections
      • Network and port scan conditions
      • Binary paths
      • Maximum number of Binaries
      • Package Executable Mapping
      • Metro apps
      • Investigation with packages
      • Portal aggregation and grouping
      • Focus time metric
    • Security
      • Access rights and permissions
      • Active Directory authentication
      • Canonical domain names for Windows authentication
      • System alerts
      • Audit trail
      • Appliance hardening
      • STIG hardening
      • FIPS 140-2 compliance
      • Security bulletins
        • Is Nexthink affected by Okta breach
        • Is Nexthink affected by SolarWinds breach
        • Nexthink and Log4j - Security bulletin
        • CVE-2022-22965 - Security Vulnerability Spring4shell - Spring Framework
        • Version 6.22.2.10: Security Vulnerability Maintenance Release
        • The Collector V6.27.X Release – Security Bulletin
    • References
      • Components of the Collector
      • Server support
      • Compatibility mode
    • Glossary
      • Activity
      • Alert
      • Application
      • Binary
      • Campaign
      • Category
      • Connection
      • Dashboard
      • Destination
      • Device
      • Domain
      • Entity
      • Event
      • Executable
      • Execution
      • Focus time
      • Hierarchy
      • Installation
      • Investigation
      • Keyword
      • Metric
      • Module
      • Object
      • Package
      • Platform
      • Port
      • Printer
      • Score
      • Service
      • Session
      • System boot
      • User
      • User logon
      • Web request
      • Widget
  • API and integrations
    • Integrating with Nexthink
      • Event Connector
      • Getting data through the NXQL API
      • Bidirectional integration with the Finder
      • Count metrics API
      • Software metering API
      • Services API
      • List Engines API
      • GetSID API
      • Triggering campaigns via their API
      • Triggering remote actions via their API
      • Audit trail API
      • Integrating investigation-based alerts
      • Downloads
    • NXQL API
      • Introducing the NXQL API
      • NXQL Tutorial
      • NXQL language definition
      • NXQL Data Model
    • Integrations
      • Excel integration with NXQL
      • Power BI
      • Azure Data Lake Storage Gen2
      • Splunk Event Connector
    • ServiceNow
      • CMDB Connector
      • Incident Management Connector
      • Event Management

© Nexthink

  • Privacy policy
  • Responsible Disclosure Policy
On this page

Was this helpful?

Last updated 7 months ago

Was this helpful?

This document provides comprehensive information about the introduction and concepts around the Nexthink Chatbot SDK, its API and use cases. The information contained herein is subject to change without notice and is not guaranteed to be error-free. If you find any errors, please report them to us via . This document is intended for readers with a detailed understanding of Nexthink technology.

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

Installation requirements

Hardware requirements

  • A separated dedicated appliance with Oracle Linux 8 is required for the deployment.

    • Do not run any Engine or Portal on the same server.

    • For dimensioning details, please check .

  • The server must have access to the Internet to download required libraries during the installation.

  • The Oracle Linux 8 server must have Docker version 27.2.0 installed. Otherwise, these will be automatically downloaded from the Internet during the installation process.

  • There must be a dedicated nexthink user with sudo privileges with home /home/nexthink in the appliance. If the nexthink user doesn’t exist, create one.

Nexthink pre-requisites

  • Nexthink 6.30 or higher

  • Nexthink Engines with licenses for Integrate, Act and Engage modules

  • Local user in Nexthink Portal with a profile that allows for Web API access and remote action execution For more details on how to configure this in Finder, go to and configure the profile section.

    • We recommend creating a new user in Portal for Chatbot SDK integration. The information is required during the installation process.

  • The necessary remote actions are installed and configured in Engines.

    • If you want to use the out-of-the-box catalog, install the Chatbot Content Pack, available in.

    • Remote actions must be configured as explained in the remote actions settings section.

    • Installation and configuration of remote actions is necessary before Chatbot SDK is installed.

Installation Steps

Update

If you are using a regular Oracle Linux 8 instead of a Nexthink appliance, please ensure it is up to date by running:

$ sudo yum install -y yum-utils unzip

It may require sudo permissions.

Download

Download the file nexthink-chatbot-adapter-X.X.X.zip, save it on the Linux appliance at the /home/nexthink directory and decompress it.

$ cd /home/nexthink

$ unzip nexthink-chatbot-adapter-X.X.X.zip

$ cd nexthink-chatbot-adapter-X.X.X/

If needed, add the Nexthink user execution permission for the scripts.

$ chmod +x scripts/nexthink-chatbot-adapter-*.sh

Execute the script

Execute the installation script and pass the tgz path you want to install as a parameter.

To avoid file permission problems, it is recommended to execute the installation with the same Nexthink user that is going to be used to execute Docker commands.

If you do not have a separated file with the list of Engines:

$ ./scripts/nexthink-chatbot-adapter-install.sh ./nexthink-chatbot-adapter-X.X.X.tgz

$ ./scripts/nexthink-chatbot-adapter-install.sh -c ~/my_engines.yaml ./nexthinkchatbot-adapter-X.X.X.tgz

The installation script is going to check if your environment meets the installation requirements and check the tgz file. It creates the installation directory at /var/nexthink/nexthink-chatbotadapter and decompresses the tgz file into the installation directory.

For those steps that need to be executed with sudo, the user password may be required during the installation process.

During the installation process, you will be asked to include certain configurations via a prompt.

Configure the environment variables

Portal and chatbot ingress network configuration including users and passwords are required as described in the following steps.

The script will prompt for the following values:

PORTAL_HOST: FQDN or IP of your Portal host

NEXTHINK_PASS: Finder or Portal user password

CHATBOT_ADAPTER_PORT: By default, the external TCP port for incoming connections to Chatbot SDK is 8090

PROXY_URL (optional): FQDN or IP of the proxy, including the protocol http://or https://. Empty for no proxy configuration.

PROXY_USER (optional): The proxy user if basic authentication is used. Empty if no proxy configuration or no authentication is required.

PROXY_PASSWORD (optional): The proxy password if basic authentication is used. Empty if no proxy configuration or no authentication is required.

These values will be stored in a file located in the installation directory: /var/nexthink/nexthink-chatbot-adapter/.env

Configure Nexthink Engines

The script asks for confirmation in case you want to automatically load the Engine configuration values from Portal, which was configured in the previous step.

Please note that the Portal API used to retrieve Engine information does not provide the Web API ports. They are set by the script with the following default values: 1671 for on-premise and 443 for Cloud deployments. If other ports differ from the default ones for the Web API, you need to manually modify the resulting engines.yaml file to include the correct ports. In order to apply these manual changes, the Docker containers need to be restarted. To do so, navigate to the folder where the original zip was decompressed and execute the restart script:

$ ./scripts/nexthink-chatbot-adapter-restart.sh

If you choose not to load any configuration from Portal you may enter the Engine configuration manually. You can enter as many Engines as needed.

Engine Address: FQDN or IP of Engine host

Engine Port: Engine Web API port. The default value is 1671 for on-premise deployments and 443 for Cloud deployments. You may need to modify these values if you are not using the default ports.

Please note that the timezone is case-sensitive and should be typed exactly as it appears in the link.

Configure cached fields

In order to configure the local cache, the script will automatically extract all suitable fields from the NXQL queries found in the topics in the config directory and create the /var/nexthink/nexthink-chatbot-adapter/config/cached_fields.yaml file with a list of all the fields.

Once you have configured the installation, the script will load the Docker images and will start the Docker containers.

You must log out and log in to be able to run Docker commands successfully.

Check that the Docker containers are up and running

$ docker ps

Customize remote actions (optional)

If remote actions are different from those provided in the content pack, then you should customize the remote actions in: /var/nexthink/nexthink-chatbotadapter/topics/remote_actions.yaml

The values formatted as code below should be replaced based on your setup.

Verify remote actions

Verify that the remote actions mentioned in the file exist in your Nexthink installation. You can find them by their name. Below is an example of what to replace:

Please note that the name of the remote action defined in this file is case sensitive and it must exactly match the name in Finder.

$ vi /var/nexthink/nexthink-chatbot-adapter/config/topics/remote_actions.yaml

repair_outlook_ost_problem: name: Repair Outlook OST Problem UID: 130bb94e-3e0b-f87c-e2::/vb8-3a2d022394fe

set_outlook_online: name: Set Outlook online UID: 683c5c12-6160-913a-99df-6087dbefab6c

clear_outlook_autocomplete_cache: name: Clear Outlook AutoComplete Cache UID: 24c76f25-dcbe-26b9-0fec-b118cce4075d

disk_cleanup: name: Disk Cleanup UID: bf8fe752-03b8-4936-a51c-769705e1fd3d

Update UID

It is necessary to update the UID value in the file if it differs from the UID in the installation.

Change SSL certificate (optional)

Restart the environment

After all the remote actions have been properly configured in Finder to be either launched manually or automatically, it is recommended to restart the containers. Navigate to the folder where the zip was decompressed and execute the restart script:

$ ./scripts/nexthink-chatbot-adapter-restart.sh

Check that the containers are up and running

$ docker ps

Check the API

To check the correct configuration of the deployment, call the API to assure it is working properly.

If the API Key was not previously generated, use curl to generate it:

<Nexthink_user>is the local user in Nexthink Portal added during the installation.

If the API key was generated previously, use:

Ensure that only one API key is valid at a time. The key is not regenerated at restart, and it never expires. However, once you generate a new one, the previous one is automatically invalidated.

Validate that the endpoint is working by listing the topics:

$ curl -k -H "X-API-key:" https://localhost:8090/v1/topics

Validate access to Engines by finding the devices for an employee.

  • Find the employee in Finder.

  • Retrieve the employee devices by sending the API Key as a custom header.

$ curl -k -H "X-API-key:" https://localhost:8090/v1/user//devices

Example:

Check the Logs

Check the logs to verify that the installation is going as expected. Each log can be read from the stdout of each container. For instance, for an overview of incoming and outgoing requests, we can check the chatbotingress logs.

You will have to write Docker commands during the installation process. For more information, refer to .

For the Engine list created in a separated Engine YAML configuration file, use the following command. Please refer to for more details:

NEXTHINK_USER: Finder or Portal user described in the section

Optional: there are other advanced variables that have default values and are not required to be modified for the default configuration. If needed, they can be changed manually later by editing the /var/nexthink/nexthink-chatbot-adapter/.env file. For more details, please check the page.

Engine Database UID: This value can be taken from the Portal API or it can be left blank if it is unknown. Please refer to the section for more details.

Engine Timezone: Engine timezone as it appears in , for example, Europe/Madrid.

This information will be stored in the file located in the directory /var/nexthink/nexthinkchatbot-adapter/config/engines.yaml. The file will be populated automatically with the information included during the installation prompts. It can be changed manually at a later time as described on the page.

You can change the self-signed SSL certificate included in the installation by your own trusted SSL certificate. This can be done by following instructions on the page.

Follow an installation checklist in the guide if you have trouble with any of the steps listed above.

  1. Integrations
  2. Nexthink Chatbot SDK
  3. Installation, configuration and update guide

Installation and configuration

Code
$ curl -X POST -k https://<Nexthink_User>:<Nexthink_Pass>@localhost:8090/v1/api_key  
1574fbf6cece2c1d0af2c771a1bf192161b7956d3551b5eb33bc42bafafe9adc
Code
$ curl -k https://<Nexthink_User>:<Nexthink_Pass>@localhost:8090/v1/api_key 
1574fbf6cece2c1d0af2c771a1bf192161b7956d3551b5eb33bc42bafafe9adc 
Code
$ curl -k -H "X-API-key:1574fbf6cece2c1d0af2c771a1bf192161b7956d3551b5eb33bc42bafafe9adc" 
\https://localhost:8090/v1/user/jsmith@NXT-JSMITH/devices  

[{"name":"NXT-
JSMITH","device_uid":"f38d649e92b44788cf5674f704834591","platform":"windows",
"total_ram":42 94967296,"last_ip_address":"192.168.5.11",
"group_name":"WORKGROUP","entity":"","device_mode l":"VMware Virtual Platform",
"os_version_and_architecture": "Windows 10 Enterprise (64 bits)",
"system_drive_capacity":26317156352,"system_drive_free_space":16200781824,
"number_of _days_since_last_boot":2}] 
Code
$ docker logs -f nexthink-chatbot-adapter_chatbotingress_1 

2019-03-06T12:23:10Z [Ingress] main.go:54: Debug flag true 
2019-03-06T12:23:10Z [Ingress] main.go:62: Secure flag true 
2019-03-06T12:23:10Z [Ingress] main.go:129: Starting Chatbot Ingress on port 8090 
2019-03-06T12:23:10Z [Ingress] main.go:132: /user_devices: http://userdevices:8001/v1 2019-03-06T12:23:10Z [Ingress] main.go:132: /topic: http://topicmanager:8002/v1 
2019-03-06T12:23:10Z [Ingress] main.go:132: /remote_action: http://remoteactionmanager:8003/v1 
2019-03-06T12:23:28Z [IngressDebug] router.go:20: URL: 
http://userdevices:8001/v1/user_devices/nexthink@NXTV-WIN10EN 
2019-03-06T12:23:29Z [IngressDebug] router.go:34: Response: [{"name":"NXTV-WIN10EN-
15","device_uid":"54965105b7192099cc5c17e2be830df3","platform":"windows"},{"name":"NXTV-
WIN10EN","device_uid":"9a1dcb96b1f185fa23b728fd29b773e1","platform":"windows"}] 
  • Installation requirements
  • Hardware requirements
  • Nexthink pre-requisites
  • Installation Steps
  • Update
  • Download
  • Execute the script
  • Configure the environment variables
  • Configure Nexthink Engines
  • Configure cached fields
  • Check that the Docker containers are up and running
  • Customize remote actions (optional)
  • Change SSL certificate (optional)
  • Restart the environment
  • Check the API
  • Check the Logs
Advanced configuration
Advanced configuration
TZ database
Advanced configuration
Troubleshooting
Installation requirements
Nexthink Support Portal
Dimensioning guide
Nexthink Library
Basic Docker commands
Custom certificate installation
Nexthink local user configuration in Portal
Modifying the list of Engines
Getting Remote Action Uid
Docker containers