Skip to main content

Getting started

Prerequisites​

Creating gateway on the SAP web portal​

Before installing the gateway software a Gateway instance must be created in SAP by signing in, going to the Gateways page and clicking the New button. For detailed instructions for creating a gateway refer to the SAP User Guide.

Obtaining Installation token​

Once the gateway has been created in SAP click on it in the Gateways table to go to the details page and click the Generate Installation Token button. An email will be sent with an installation token and a download link to get the SAP Gateway Installer.

Downloading the Coherent SAP Gateway installation package​

Use the download link in the received email from SAP to download the Coherent SAP Gateway installation package. When downloading the package you will be asked to provide your SAP credentials.

Once downloaded, unzip the file into a temporary directory. The sap-gateway-installer utility can then be run from this directory to install the gateway application.

Windows Service Account​

The SAP Gateway may use the Local System account to run but it is recommended that a new Windows Account (machine or domain) is created and used.

The account must have the "Log on as a service" user right. If the account doesn't have this the installation will succeed but the credentials will need to be re-entered via the Windows Services console before the service can be started.

Firewall rules​

The gateway needs to be able to communicate with the SAP server so any firewall it is behind must allow it TCP access to sap.coherent-research.co.uk, port 8883.

The installation procedure needs to communicate with the SAP API so any firewall it is behind must allow it TCP access to sap-web-api.coherent-research.co.uk, port 443.

Initial install​

To do an initial install of the gateway software enter the following command:

sap-gateway-installer install --token INSTALLATION-TOKEN --account SERVICE-ACCOUNT

This command must be run as an administrator.

The installation utility will do the following:

  • Install the SAP gateway binaries to C:\Program Files\Coherent Research\SapGateway
  • Create a Windows Service called Coherent-SAP-Gateway
  • Install a client certificate to authenticate the gateway to SAP in the Local Machine certificate store (along with the required certificate chain).
  • Provide client certificate access to the service account. If the Local System account is used this will already have access to the client certificate.

When installed the service can be started as normal.

See SAP Gateway Installer for details on using the installation utility.

Troubleshooting​

SAP Gateway will write fatal errors to the Windows Application Event log with source SAP Gateway. Authentication errors will normally be logged to the Windows System Event log.

For more detailed troubleshooting SAP Gateway will log to C:\CoherentLogs\SAP