Skip to main content
Skip table of contents

Installing and Upgrading Cognitive Suite

Table of Contents

Hardware Prerequisites

The Shinydocs Cognitive Toolkit is your data worker, these machines are separate from the Analytics Engines and have different requirements. In most cases, more Cognitive Toolkit machines will improve throughput.

For information on hardware and software prerequisites, see Cognitive Suite Requirements.

Before you begin

Download the following files from your customer collaboration space or contact your support representative:

Cognitive Toolkit

shinydocs-cognitive-toolkit-[version]-[date].zip

Cognitive Toolkit Resources

shinydocs-cognitive-toolkit-resources-[version]-[date].zip

Shinydocs Extraction Service

shinydocs-extraction-[version]-[date].zip

Analytics Engine

shinydocs-indexer-visualizer-[date] ([version]).zip

Shinydocs Cognitive Suite

The Shinydocs Cognitive Suite installation involves the following components:

  1. Cognitive Toolkit, Cognitive Resources, and Extraction Service

  2. Analytics Engine and Visualizer

Installation

The following instructions outline how to complete a fresh installation of Shinydocs Cognitive Suite. Typically all installs should be done on a non OS drive.

Cognitive Toolkit

  1. Right-click the Cognitive Toolkit (shinydocs-cognitive-toolkit-[version]-[date].zip) zip file and select Properties. 

  2. Under the General tab, select Unblock and then select Apply.                     

  3. Right-click on the Cognitive Toolkit (shinydocs-cognitive-toolkit-[version]-[date].zip) zip file and select Extract All.

Note the location to which you extract the Cognitive Toolkit. The Cognitive Toolkit Resources will be extracted to this folder location in the next step.

Cognitive Toolkit Resources

  1. Right-click the Cognitive Toolkit Resources (shinydocs-cognitive-toolkit-resources-[version]-[date].zip) zip file and select Properties. 

  2. Under the General tab, select Unblock and then select Apply.                     

  3. Right-click on the Cognitive Toolkit Resources (shinydocs-cognitive-toolkit-resources-[version]-[date].zip) zip file. Select Extract All... and unzip the file into the same folder location the Cognitive Toolkit was extracted. 

  4. The Cognitive Toolkit folder now has 2 sub-folders: External Resources and Scripts.

Shinydocs Extraction Service

  • Ensure JAVA_HOME environment variable is set

  1. Right-click the Shinydocs Extraction Service (shinydocs-extraction-[version]-[date].zip) zip file and select Properties. 

  2. Under the General tab, select Unblock and then select Apply.                     

  3. Right-click on the Shinydocs Extraction Service (shinydocs-extraction-[version]-[date].zip) zip file. Select Extract All... and unzip the file into a temporary file location. 

  4. From the temporary file location above, run ShinydocsExtraction.Setup.

  5. Follow the prompts during the installation.

  6. When finished the shinydocs-extraction service will be installed and running.

  • Congratulations! You have completed the installation of the Cognitive Toolkit portion of the Shinydocs Cognitive Suite

Analytics Engine and Visualizer

  • Ensure the service account has administrative access and full rights to all directories used
    in this installation.

  • Ensure JAVA_HOME environment variable is set

  • Anti-Virus and security exclusions may need to be made to these folders

  1. Navigate to the shinydocs-indexer-visualizer-yyyy-mm-dd.zip

  2. Right-click on the zipper after downloading > Properties > Unblock

  3. Extract the zipper to the drive where you wish to install the Analytics Engine and Visualizer

  4. Open a Windows command prompt as Administrator and navigate to the extracted
    shinydocs-indexer-visualizer-yyyy-mm-dd (X.X.X).zip

  5. Run install.bat and follow the prompts

  6. The setup will then execute the installation of the two Windows services:

    1. Shinydocs-Indexer

    2. Shinydocs-Visualizer

  7. Set your heap space for jvm.options:

    1. Navigate to the directory where the indexer is installed. The default location would be C:\ShinyDocs\indexer\config\jvm.options

    2. Scroll down to line 22, 23 (this is where these options will be by default), where you can configure “initial” and “maximum” total heap space and change the default value to half of your current server's RAM allocation - 4 GB (the 4 GB is to leave enough room for the OS).

      1. For example, the server has 64GB of RAM. Change the values to 28.

      2. The configuration should look like the following and then save the file.
        -Xms28g
        -Xmx28g

  8. The following configurations are located in the elasticsearch.yml file located in ..\indexer\config

    1. Line 17 - cluster.name

      1. Remove the comment character # at the beginning of the line

      2. Replace my-application with a name for your cluster (e.g. acme-analytics)

        1. This name will need to be the exact same on every node in the cluster

    2. Line 23 - node.name

      1. Remove the comment character # at the beginning of the line

      2. Replace node-1 with a unique name for this machine. This will be the name reported on the Monitoring page of Kibana. Using the server's name is a good choice!

    3. Line 43 - bootstrap.memory_lock

      1. Remove the comment character # at the beginning of the line

      2. Keep the value true

    4. Line 55 - network.host

      1. Remove the comment character # at the beginning of the line

      2. Generally, the easiest value to set network.host to is 0.0.0.0 meaning that it will bind on all network interfaces on the machine. For more details see network.host | Elasticsearch Guide [6.8] | Elastic network.host | Elasticsearch Guide [6.8] | Elastic

      3. If this line is not modified, the index and Kiabana will not be accessible outside of the local machine

    5. If you are configuring a cluster of servers, please see our guide on Cluster Setup for Analytics Engine (Shinydocs Indexer)

    6. Save the file and restart the Shinydocs Indexer service for your changes to take effect

  9. To reach the visualizer from a different machine, you will need to edit the kibana.yml file:

    1. kibana.ymlfile located in ..\visualizer\config

    2. Line 7 - server.host

    3. Remove the comment character # at the beginning of the line

    4. Set the server.host to "0.0.0.0"

    5. Save the file and restart the Shinydocs Visualizer service for your changes to take effect

  10. In your web-browser, verify you are able to access the following web pages:
    a. http://localhost:9200 : Indexer - will return a JSON file if working normally

    Screenshot that displays a JSON file containing indexer configuration info if the indexer is functioning normally.

    b. http://localhost:5601 : Visualizer - will load Shinydocs Analytics

    Screenshot that displays the Shinydocs Visualizer in a web-browser tab.

Success! You’ve installed the Shinydocs Cognitive Suite!

What’s next? Get started by Activating the Cognitive Toolkit License.

Upgrade

The following instructions outline how to upgrade an existing version of Shinydocs Cognitive Suite to a newer version.

Cognitive Toolkit

  1. Right-click the Cognitive Toolkit (shinydocs-cognitive-toolkit-[version]-[date].zip) zip file and select Properties. 

  2. Under the General tab, select Unblock and then select Apply.                     

  3. Right-click on the Cognitive Toolkit (shinydocs-cognitive-toolkit-[version]-[date].zip) zip file and select Extract All... 

  4. When selecting the extraction location, overwrite the old Cognitive Toolkit directory with this new one.

Note the location to which you extract the Cognitive Toolkit. The Cognitive Toolkit Resources will be extracted to this folder location in the next step.

Cognitive Toolkit Resources

Make a copy of your source settings files BEFORE updating your Resources. If source settings files are updated, you will need to copy your existing authentication values to the new source settings files

If you use the SaveValue operation in the Cognitive Toolkit and have a saved-parameters.yaml file for encrypted passwords, ensure that file is not deleted. If it was previously stored within the old Cognitive Toolkit folder, it will need to be re-saved to the same location within the new folder.

  1. Right-click the Cognitive Toolkit Resources (shinydocs-cognitive-toolkit-resources-[version]-[date].zip) zip file and select Properties. 

  2. Under the General tab, select Unblock and then select Apply.                     

  3. Right-click on the Cognitive Toolkit Resources (shinydocs-cognitive-toolkit-resources-[version]-[date].zip) zip file. Select Extract All... and unzip the file into the same folder location the Cognitive Toolkit was extracted. 

  4. When selecting the extraction location, overwrite the old shinydocs-cognitive-toolkit-resources with this new one.

  5. The Cognitive Toolkit folder now has 2 sub-folders: External Resources and Scripts.

  6. If source settings files are updated, copy your existing authentication values to the new source settings files

Congratulations! You have completed the upgrade of the Cognitive Toolkit portion of the Shinydocs Cognitive Suite

Analytics Engine

Please see our Changes when using Elasticsearch and Kibana 6.8.23 (Free Tier) instead of Shinydocs Indexer and Visualizer 6.8.23 guide.

JavaScript errors detected

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

If this problem persists, please contact our support.

Contact Support Close