This guide describes minimum configuration required to establish connection between SAP backend and FSM using message broker.
You must download the Message Broker first. It comes as a ZIP package and there are two compilations: one for Windows and one for Linux. The Linux version of a message broker can also be deployed to BTP. Message Broker downloads are available in the SAP Download Centre but for the sake of easiness, you find all relevant links here as well.
After you have downloaded the right package it must be extracted to a destination directory of your own choice. For more details on executables' installation check here if using Windows and go here in case of Linux. Deployment in BTP is covered here.
Further configuration steps include
Configuration of the message broker - Message Broker YAML file.
Configuration of the web services in SAP SOAMANAGER (to be exact one web service and one proxy)
Definition of the ‘Client ID’ and ‘Client secret’ in FSM
Message Broker config file can be either maintained in the text editor (notepad++ is our recommendation) or using transaction /PACG/ECM_MBCF_GEN
First things first
The best would be to start with something easy - login to FSM admin section and create a new client definition, you will need Client ID and Client Secret to establish a connection between message broker and FSM. More on how to do that you will find here.
In the message broker configuration file in the ‘CloudAccounts’ section fill following information:
Id - as ID of account, in the message broker configuration but also in the Connector configuration the name of it is used (and not this numerical value you can see in FSM as ID)
ClientId and ClientSecret - this is self-explanatory, here you must enter the client ID and secret you got for your newly created client (step 1)
If you don’t want to keep sensitive information like ClientSecret as a open text in the configuration file you can have it encrypted. How to perform the encryption you can learn here.
Connecting SAP to Message Broker
Start with message broker configuration file. Here you must enter few extremely important information:
Find section ‘WebServiceDeinition’. This section is responsible for web service run by message broker. This is a service that a SAP system will be connecting to.
Key in:UserName - this is a user name with which SAP will be connecting to message broker. This is entirely made up user name, and has nothing in common with Windows users, Linux users nor SAP users - does not require any reference in any of these systems. It exists exclusively within message broker space
Password - a password for the user entered line above. This username and pass will be then needed during configuration of logical port in SAP SOA Manager. Password can be encrypted (same thing like in case of Client Secret, more on passwords' encryption you will find here) and then use PasswordSecure instead of Password.
Port - TCP port number used by message broker. Any valid value from 0 to 65353 will do however port numbers from 0 to 1023 are reserved for common TCP/IP applications and are called well-known ports so it is recommended to use higher values. Another import thing is that services can’t share TCP ports (one service - one port number), so for instance if you wanted to run several message broker instances in single server each of them must use unique TCP port. Most likely, for the first message broker you can leave default value of 9696. More on the topic of ports in networking you can learn here.
UrlPath - URL path is part of the web service address which consists of IP address or domain address of a server where it runs, protocol, port number and this path. Unlike port numbers path does not need to be unique and might as well you can leave its default value. Later on it will be needed to define logical port in SAP SOA Manager
Https - is a subsection of ‘WebServiceDeinition’. As mentioned in https://proaxia-prod-doc.atlassian.net/wiki/spaces/PFCC/pages/6293863/Basic+communication+setup#Key-information%3A connection from SAP to message broker can be encrypted and for that HTTPS must be enabled. This subsection includes properties which must be set to make it work. The detailed step by step description of it you can find here: Setting up secure (HTTPS) connection from SAP system to FSM Message Broker. However it is ok to use unsecured connection for testing purposes, just to make message broker work and then get to it later (if needed). In such case leave property Enabled set to false (its default value)
Now - time to configure logical port in SOA Manager. Component responsible for connecting from SAP to Message Broker (technically it is all about connecting to remote web service, no matter what it is) is called service consumer or consumer proxy and the one that comes with Connector is named ISendOutboundMessageService (corresponding internal/ABAP name is /PACG/CO_ECMISEND_OUTBOUND_MES)
Start with running SOA Manager in your SAP system (t-code: soamanager)
And then jump to Outgoing Service (SAP to FSM). Here you will find full and comprehensive guide through the configuration of the web service consumer.