Skip to main content

Knowledge Platform Agent Requirements and Installation

Ben Bauer
  • Updated

This article contains Installation steps for the Syniti Knowledge Platform Agent. 

It contains the following sections:

Installation Overview and Requirements

The Syniti Knowledge Platform Agent runs on Linux-based architectures and is installed and maintained using standard package management capabilities.

Supported Distributions:

  • Redhat Enterprise Linux 8.4
  • SUSE Linux Enterprise Server 15 SP3
  • Ubuntu 20.04
NOTE: SAP does not officially support RFC connectivity via Ubuntu
and therefore the SAP metadata scanning may not operate fully on an Ubuntu server.

Hardware Specifications:

The following minimum hardware requirements are recommended for the Knowledge Platform Agent and all associated services:

  • 4 core CPU
  • 16GB RAM
  • 50GB Disk

Software Prerequisites:

The installation process installs as necessary prerequisites for the agent and associated services. One prerequisite may need to be installed directly:  Wireguard.

Wireguard and WireguardTools (https://www.wireguard.com/install/) are required for the Knowledge Platform Agent machine. The install scripts check for their existence before continuing.

Network Traffic

The Knowledge Platform Agent initiates communication by sending traffic out to the Syniti Cloud using the following ports and protocols:

  •  TCP port 443: the Knowledge Platform Agent requests configuration details from the Syniti Cloud using HTTP over TLS (OUTBOUND only).
  • UDP port 51820: the Knowledge Platform Agent initiates a Wireguard tunnel to the Syniti Cloud (OUTBOUND)
  • IP v6 must be enabled on the server.

Install the Knowledge Platform Agent 

Be sure you have `sudo` access on the Linux machine where the Knowledge Platform Agent is installed.

To install the agent:

Register the Syniti cloud package repository to the machine.

  1. Download the appropriate script for your operating system:
  1. Move the script to the machine where you want to install the agent.
  2. Run the script as sudo with: sudo bash <install_script> <flags>
  3. When installing an agent, the script takes in a required parameter:
    -u Connect to syniti.com in the USA
    -e Connect to syniti.eu in Europe (Germany)
    -a Connect to syniti.au in Australia
    For example, this command installs the agent and associated services pointing back to a tenant running in Australia:
    sudo bash syniti_install_ubuntu -a
    If you do not pass in a flag or pass in an incorrect flag, the script returns a message and guides you to use the proper command.
  4. The final step of the script displays the Public Key of the agent. Copy this string of characters for registration in the Syniti Knowledge Platform.

Install the SAP Metadata Scanner (JCo) 

The SAP NetWeaver scanner relies upon SAP’s Java Connector (JCo), which must be downloaded from SAP’s support site as part of scanner installation. 

Install the scanner on the Virtual Machine where the Syniti Agent is installed. 

To install the SAP JCo metadata scanner:

  1. Access https://support.sap.com/en/product/connectors/jco.html.
  2. Scroll to the download section on the page.
  3. Click the Processor link for Linux for Intel compatible processors. 

    NOTE: A valid SAP account is required to download the package.

  4. Once downloaded, unzip the package and copy the files sapjco3.jar and libsapjco3.so into the appropriate directory on the Agent server. Syniti recommends copying them to the /usr/lib/ directory.

SAPJCO.png

Files to copy from the package

Register the Syniti Knowledge Platform Agent in the Syniti Knowledge Platform

NOTE: You must have Administrator permissions to register a Syniti Knowledge Platform Agent.
For more information about setting up user permissions, refer to Manage User Accounts.

To register Syniti Knowledge Platform Agent:

  1. Click the user avatar in the top right corner.
  2. Click Admin in the dropdown menu.
  3. Click Agents on the left.
  4. Click Create Agent.
  5. Enter a name for the agent in the Name field.

    NOTE: It is recommended that you name the agent with enough information to provide troubleshooting later such as the IP address or other identifying information

  6. Paste the public key value from the server where the agent is installed in the Public Key field.
  7. Click Save.
  8. Click Confirm.
  9. Click Agents on the left to go back to the Agents page.
  10. Locate the agent you just created and click the Run button to test the connection you just saved.

NOTE: It may take up to 60 seconds for the initial handshake to be established so if the test connection fails, please try again after a couple of minutes

A successful test is confirmed with a green check in a green circle in the Last Test Result column.

Related articles