This article contains Installation steps for the Syniti Knowledge Platform Connector.
It contains the following sections:
- Installation Overview and Requirements
- Install the Syniti Knowledge Platform Connector
- Install the SAP Metadata Scanner (JCo)
-
Register the Syniti Knowledge Platform Connector in the Syniti Knowledge Platform
Installation Overview and Requirements
The Syniti Knowledge Platform Connector runs on Linux-based architectures and is installed and maintained using standard package management capabilities.
Distribution | Note |
Redhat Enterprise Linux 8.7 or 8.8 |
When upgrading to 8.8, Wireguard also needs to be upgraded to 8.8. |
Oracle Linux 8.7 or 8.8 |
SAP does not officially support Oracle Linux and therefore the SAP metadata scanning may not operate fully on an Oracle Linux server. |
SUSE Linux Enterprise Server 15 SP4 |
N/A |
Ubuntu 20.04 | SAP does not officially support RFC connectivity via Ubuntu and therefore the SAP metadata scanning may not operate fully on an Ubuntu server. |
Web Traffic
This is a list of common URLs to allowlist on any networks that are used for installation or upgrade of the Syniti Knowledge Platform. Refer to Web Traffic for a complete list.
Syniti does not host third-party components that are required for a unique environment.
NOTE: These are not required to be opened all the time.
- https://hpackagecloud.io
- https://download.oracle.com
- https://d28dx6y1hfq314.cloudfront.net
- https://dl.fedoraproject.org
- https://pypi.python.org
- https://pypi.org
- https://*.pypi.org
- https://files.pythonhosted.org
- https://www.wireguard.com/install/
- https://*.elrepo.org
- https://*.syniti.com
- https://*.oracle.com
- https://*.packagecloud.io
- https://*.python.org
- https://*.syniti.eu
- https://*.xtom.de
Hardware Specifications
The following minimum hardware requirements are recommended for the Syniti Knowledge Platform Connector and all associated services. Only Intel/AMD-based processors are supported.
- 4 core CPU
- 16GB RAM
NOTE: If you are using Match, additional CPU/RAM is required. Refer to Requirements for more information.
- 50GB Disk
- 125MB/s Disk Throughput
Software Prerequisites
The installation process installs as necessary prerequisites for the Syniti Knowledge Platform Connector and associated services. One prerequisite may need to be installed directly: Wireguard.
Wireguard and WireguardTools (https://www.wireguard.com/install/) are required for the Syniti Knowledge Platform Connector machine. The install scripts check for their existence before continuing.
Network Traffic
The Syniti Knowledge Platform Connector initiates communication by sending traffic out to the Syniti Cloud using the following ports and protocols:
- TCP port 443: the Syniti Knowledge Platform Connector requests configuration details from the Syniti Cloud using HTTP over TLS (OUTBOUND only).
- UDP port 51820: the Syniti Knowledge Platform Connector initiates a Wireguard tunnel to the Syniti Cloud (OUTBOUND)
- IP v6 must be enabled on the server.
Static IPs
The Syniti Knowledge Platform Connector uses static IPs. Refer to Web Traffic in the online help for more information.
NOTE: Customers MUST allowlist the Syniti IPs listed in Web Traffic for inbound traffic.
Data Center | Static IPs |
US |
|
EU |
|
APJ |
|
Install the SKP Connector
`sudo` access is required on the Linux machine in order to install the SKP Connector.
To install the SKP Connector:
- Register the Syniti cloud package repository to the machine.
- Download the appropriate script for your operating system: Knowledge Platform Connector - Download
- Move the script to the machine where you want to install the Syniti Knowledge Platform Connector. Make note of the folder; it will be used again in the installation process.
- Run the script as sudo with: sudo bash <install_script> <flags>
- When installing the SKP Connector, the script takes in a required parameter, which depends on your client's region:
Country | Parameter | Notes |
USA and Canada | -u | Use this parameter if your tenant domain ends with .com, as this indicates an installation in the US or Canada. |
Europe (Germany) | -e | Use this parameter if your tenant domain ends with .eu. |
For example, this command installs the Syniti Knowledge Platform Connector and associated services pointing back to a tenant running in the US:
sudo bash syniti_install_ubuntu -u
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.
NOTE: This location refers to your tenant’s region, not the region in which your SKP Connector is installed.
NOTE: To update this value, refer to the instructions in the section Reconfigure SKP Connector Services.
- The final step of the script displays the Public Key of the SKP Connector. Copy this string of characters for registration in the Syniti Knowledge Platform.
Install the SAP Metadata Scanner (JCo)
The SAP NetWeaver scanner relies on SAP's metadata scanner (JCo).
To install the SAP metadata scanner (Jco):
- Verify you have a valid SAP account.
- Access https://support.sap.com/en/product/connectors/jco.html.
- Scroll to the download section of the page.
- Click the Processor link for Linux for Intel compatible processors.
- Once downloaded, unzip the package and copy the files sapjco3.jar and libsapjco3.so into the appropriate directory on the Syniti Knowledge Platform Connector server. Syniti recommends copying them to the same folder used in Step #2 in the above section, Install the Syniti Knowledge Platform Connector.
NOTE: If you are connecting via an SAP Message Server, then you are required to edit the services file located in the /etc/ location on the SKP Connector server, adding an entry for the SAP Message Server in the format sapms<SYSID> 36<Instance No>/tcp.
For example: sapmsAB1 3612/tcp, where AB1 is the SYSID for the SAP system and 12 is the Instance number.
Register the SKP Connector in the Syniti Knowledge Platform
- To register the SKP Connector:
- Verify you have Administrator permissions in the Syniti Knowledge Platform.
- Click the user avatar in the top right corner.
- Click Admin in the dropdown menu.
- Click SKP Connectors on the left.
- Click Register SKP connector.
- Enter a name for the connector in the Name field.
NOTE: Name the SKP Connector with enough information to provide troubleshooting later such as the IP address or other identifying information.
- Paste the public key value from the server where the SKP Connector is installed in the Public Key field.
- Click Save.
- Click Confirm.
- Click SKP Connectors on the left to go back to the Connectors page.
- Locate the connector you just created and click the Test connection button to test the connection you just saved.
NOTE: It may take up to 60 seconds for the initial connection 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.