Home
Runbook AI (Add-on)
The Runbook AI (Add-on) is designed for both BigFix Runbook AI administrators and end users who are working towards the resolution of IT support tickets. Its primary purpose is to help BigFix administrators to easily monitor the health of their servers and initiate well-informed recovery actions with specialized Runbooks AI.
Pre-requisites guide
This guide provides instructions to install the prerequisites required for BigFix Runbook AI. This includes the installation of MongoDB and Solr for both HA (High Availability) and non-HA modes as well as generation of certificates for authentication and authorization purposes.
Pre-requisites for BigFix Runbook AI Component
The BigFix Runbook AI installer has different prerequisites depending on the type of server and component being installed. The software requirements include IIS 10.0 or above, Dot Net Framework 4.8.x, Microsoft ACE OLEDB 12.0, Python 3.8.10 64-bit, NLTK 3.4.1, Apache Server 2.4, VC++ 2015 64-bit Redistributable package, AntiWord, Spacy 3.1.2, Numpy 1.20.3, Mod_wsgi 4.9.0, En_core_web_sm 3.1.0, Google Chrome Browser, Oracle Distribution of Java JDK 1.8.x, MS SQL 2016 /MS SQL 2022 (+) Enterprise / Standard edition 64 bit, MongoDB 4.0, SOLR 8.5.0, nssm 2.24, and SSL Certificates.
Spacy
The Spacy package is a prerequisite for running any of the services in Python and can be downloaded from the provided source. Once downloaded, the contents of the extracted zip file should be placed in the specified path.

Runbook AI (Add-on)
The Runbook AI (Add-on) is designed for both BigFix Runbook AI administrators and end users who are working towards the resolution of IT support tickets. Its primary purpose is to help BigFix administrators to easily monitor the health of their servers and initiate well-informed recovery actions with specialized Runbooks AI.
- Introduction
  This guide provides you with an overview of BigFix Runbook AI and its features and benefits. It also provides an architectural overview and talks about various configurations and end user activities in brief.
- Pre-requisites guide
  This guide provides instructions to install the prerequisites required for BigFix Runbook AI. This includes the installation of MongoDB and Solr for both HA (High Availability) and non-HA modes as well as generation of certificates for authentication and authorization purposes.
  - Pre-requisites for BigFix Runbook AI Component
    The BigFix Runbook AI installer has different prerequisites depending on the type of server and component being installed. The software requirements include IIS 10.0 or above, Dot Net Framework 4.8.x, Microsoft ACE OLEDB 12.0, Python 3.8.10 64-bit, NLTK 3.4.1, Apache Server 2.4, VC++ 2015 64-bit Redistributable package, AntiWord, Spacy 3.1.2, Numpy 1.20.3, Mod_wsgi 4.9.0, En_core_web_sm 3.1.0, Google Chrome Browser, Oracle Distribution of Java JDK 1.8.x, MS SQL 2016 /MS SQL 2022 (+) Enterprise / Standard edition 64 bit, MongoDB 4.0, SOLR 8.5.0, nssm 2.24, and SSL Certificates.
    - IIS
      IIS is a server used for website hosting and is part of the Windows feature set. The installation procedure involves opening Control Panel, searching for 'Windows feature', and selecting Web Server (IIS) along with other required features. To validate successful installation, the 'inetmgr' command can be used.
    - Dot NET Framework- 4.8:
      The .NET Framework 4.8 update is available as part of the BigFix Runbook AI installer package. For help with installation and error fixing, refer to the provided links.
    - Dot NET Framework- 6.0:
      The .NET Framework 6.0 is available as part of the BigFix Runbook AI installer package. It can be downloaded using the provided link for installation and error fixing.
    - Microsoft ACE OLEDB 12.0
      Microsoft ACE OLEDB 12.0 is a software used to download the runbook metadata format. It is available as part of the iAutomate installer package and can be installed by running the appropriate exe file based on the machine's architecture.
    - Python
      Python 3.8.10 is a pre-requisite for the AI components of BigFix Runbook AI. To install Python, download the python-3.8.10-amd64.exe file and double click on it. Set the system environment variable PYTHON_HOME to C:\Python38 and add C:\Python38 and C:\Python38\Scripts to the system variable Path. To validate the installation, open Command Prompt as Administrator, type python, and press Enter.
    - NLTK package
      The NLTK package is required for NLP tasks in BigFix Runbook AI. To install it, download the nltk_data.zip file from the specified source and extract its contents to the C:\nltk_data path.
    - Open SSL Package
      The Open SSL Package is required for creating self-signed certificates and can be downloaded from the specified source. The installation procedure involves extracting the contents of the zip file and setting system environment variables.
    - Apache Server
      Apache Server is used to release features of AI components as REST APIs and create a window service for all Python components. The installation procedure involves downloading and extracting the Apache24.zip file, setting system environment variables, and installing the Apache Service using the command "httpd -k install".
    - Microsoft Visual C++ 2015 Redistributable Package
      The Microsoft Visual C++ 2015 Redistributable Package is required for the installation of Python packages. To install, download the file "vc_redist.x64.exe" and double-click on it to accept the terms and complete the setup.
    - AntiWord
      AntiWord is a software used for document crawling. It can be installed by downloading the antiword.zip file and extracting its contents to the C:\antiword path. The system environment variable ANTIWORDHOME needs to be set to C:\antiword.
    - Spacy
      The Spacy package is a prerequisite for running any of the services in Python and can be downloaded from the provided source. Once downloaded, the contents of the extracted zip file should be placed in the specified path.
    - NumPy
      The NumPy package is a requirement for running certain services in Python. To install NumPy, the previous version must be uninstalled, and the contents of the downloaded numpy.zip file should be placed in the python site-packages path.
    - Mod_wsgi
      Mod_wsgi is a python package that needs to be installed before starting any services. It can be downloaded as part of the BigFix Runbook AI installer package and the extracted contents should be placed in the python site-packages path.
    - En_core_web_sm
      The en_core_web_sm package is a requirement for Python and can be downloaded from the specified source. It consists of two folders that need to be placed in the python site-packages path.
    - Java
      Java version 1.8.0_282 is a prerequisite for installing Apache Solr for the Advanced AI component of BigFix Runbook AI. To install Java, download the java-1.8.0-openjdk.zip file, create a 'Java' folder in C:\Program Files, and extract the zip file contents into the Java folder. Then, set the JAVA_HOME environment variable and add Java to the Path variable.
    - MongoDB
      MongoDB is a NoSQL database used for storing documents' meta-data information in BigFix Runbook AI. It is available in both Community and Enterprise versions, and can be installed and configured in High Availability (HA) or non-High Availability (non-HA) mode. The installation steps include downloading the appropriate installer package, configuring authentication and authorization, enabling SSL authentication, and testing the connection.
    - Apache SOLR
      BigFix Runbook AI uses Apache Solr for indexing and searching information from documents. It can be configured in High Availability (HA) or non-HA mode, and requires the installation of Java and ZooKeeper.
    - Certificates
      Install certificate for communication by downloading and extracting the Python certificate.zip file and copying the contents to the "C:\Programfiles\certificate" folder.
    - DLL Configuration for IRecommend:
      This document provides the necessary DLL configuration for running the iRecommend module in multi-process mode. It includes the required DLLs, such as Newtonsoft.Json.dll and HCL.iAutomate.EncryptDecrypt.dll, which need to be added to the specified path. Finally, the iRecommend service should be started or restarted based on the defined steps.
- Installation Guide
  This guide provides instructions to install BigFix Runbook AI. It includes the pre-installation and the installation procedures for BigFix Runbook AI. This guide also provides summary material about additional servers and optional post- installations and references to the other documents for detailed information.
- Configuration Guide
  This guide instructs on how to install and configure BigFix Runbook AI. These instructions also include the configuration procedures for the product.
- User Guide
  This guide introduces you to the key concepts of BigFix Runbook AI and describes how to use the product. It provides an overview of the end-user interface and instructions to perform different tasks. This guide is intended for the BigFix Runbook AI end-users working towards resolution of IT support tickets.
- API Guide
  BigFix Runbook AI API guide provides documentation and instructions on how to use its application programming interface (API), including details on the functions, parameters, and endpoints available for developers to interact with the API.
- Fixlet Repository Guide
  This document provides detailed list of out-of-box fixlets available within BigFix Runbook AI. This information is intended for administrators and users authorized for configuring use cases / fixlets within BigFix Runbook AI, which works in conjunction with HCL Bigfix engine.
- Integration Guide
  This guide provides instructions to enable integrations with various ITSM and Runbook Automation tools, while configuring BigFix Runbook AI.
- Lab Manual
  This lab manual provides infrastructure administrators, installation and configuration administrators, and end users with detailed instructions on how to install, configure, and use BigFix Runbook AI. It is divided into modules, each containing an introduction and lab exercises. The manual also references additional servers, post-installation steps, and other documents for more information.
- Troubleshooting Guide
  This guide provides instructions to troubleshoot some of the commonly occurring issues along with the resolution steps. This information is intended for administrators responsible for installing, configuring, and supporting BigFix Runbook AI product.
- Abbreviations
  A list of abbreviations and their expansions.

Spacy

The Spacy package is a prerequisite for running any of the services in Python and can be downloaded from the provided source. Once downloaded, the contents of the extracted zip file should be placed in the specified path.

Table 1. Table 12 – Spacy Requirements
Version	3.1.2
Purpose	Spacy package of python needs to be present before starting any of the services
Source	Available as part of BigFix Runbook AI installer package. Follow the below path: Pre-Requisite Software Spacy_PreReq.zip

Installation Procedure

Download the file Spacy_PreReq.zip from the Path mentioned in the source field of Table 12 – Spacy Requirements . The extracted contents from the zip file named as Spacy_PreReq should be placed in the path.

C:\Python38\Lib\site-packages

Please ensure to copy the files inside the folder Spacy_PreReq to path C:\Python38\Lib\site-packages.

Table Description automatically generated — Figure 1. Figure 19 - Spacy Package Content