(v1) Solace PubSub+
- 1 Int4 Suite configuration
- 1.1 Step 1. Get the URLs of Your services
- 1.2 Step 2. Create the environment
- 1.2.1 Environment creation
- 1.2.1.1 Available environment types:
- 1.2.1.2 Basic information section
- 1.2.1.3 Properties section
- 1.2.1.4 Connections and parameters sections
- 1.2.1 Environment creation
- 1.3 Step 3. Populate the environment technical details
- 1.3.1 Connection test
- 1.4 Step 4. Configure Messaging Inbound Communication User.
- 2 Solace PubSub+ configuration
Int4 Suite configuration
Step 1. Get the URLs of Your services
API Management Connectivity
In Solace PubSub+ portal, find endpoint and credentials for SEMP API. It is located in Cluster manager, Manage tab, Other Management Tools and SEMP - REST API section.
Target host: copy host from Public/Private Internet field (without http:// prefix)
Path Prefix: copy path ‘/SEMP/v2’ from Public/Private Internet field ( without /config sufix )
Port: as in Public/Private Internet field
Basic authentication:
User: user id from SEMP Credentials section
Password: user password from SEMP Credentials section
API Messaging Connectivity
In Solace PubSub+ portal, find endpoint and credentials for REST Messaging API. It is located in Cluster manager / Connect tab. Select view by Protocol and Connection details will be visible under Rest section.
Target host: copy host from Secured REST URI (without https:// prefix)
Path Prefix: empty
Port: as in Secured REST URI
Basic authentication:
User: user id from Connection Details
Password: user password from Connection Details
There might be a different user created for messaging API. It can be found in Message VPN in Access Control tab
Step 2. Create the environment
Environment creation
From the Launchpad, select the Environments Tile
List of environments will appear. Choose “Create” in the top right to initialize environment creation.
Create Environment pop-up will appear on the screen.
Here, please select the appropriate Environment Type and provide a unique identifier (Id). It’s also possible to add a description field for internal reference.
Available environment types:
Type | Description |
---|---|
Advanced Event Mesh | Use for testing Event scenarios with Advanced Event Mesh solution |
HTTP Host | Used for general API tests, in scenarios where endpoints are available with HTTP and HTTPS based URL’s. Use this for REST API’s and general SOAP/Webservice based endpoints |
SAP API Management | Use for connecting to SAP API Management for API data import |
SAP Cloud Integration | Use for connecting to SAP Cloud Integration for metadata import and testing iFlow scenarios. This includes also B2B/TPM and Pipeline concept based scenarios |
SAP Event Mesh | Use for testing Event scenarios with SAP Event Mesh solution |
SAP PI/PO | Use for connecting to SAP PI/PO instances for message selection and test case creation in migration scenarios |
Once type is selected and ID populated, click Create to create the environment definition.
Environment definition screen will appear with multiple options, common and type dependent.
Basic information section
Field | Purpose |
---|---|
Description | Free-form description of the environment, for reference only |
Production | Use this checkbox to mark environment as production environment to disable testing and limit the definition only for message collection and retrieval purposes |
Obsolete environment | Use this checkbox to mark environment as obsolete. This enables to keep the environment definition in place for reporting and audit purposes, while clearly distinguishing the environment as not available for test case creation and execution |
Properties section
Use this section to populate environment properties allowing for fine grained search and automatic assignment of environments for shift-left and migration scenarios. The fields can be filled with free-form tags.
While the tags are free-form, Int4 recommends to agree early on the naming convention and structure for the properties, to avoid ambiguities while working with the tool.
Connections and parameters sections
This sections are specific to environment type.
Step 3. Populate the environment technical details
In the Connections sections of the environment screen, please note the Import Service Key button (or buttons, for some types).
Clicking the Import Service Key button opens up a dialog box, where the service key created before can be pasted or uploaded from file.
Please use this option for importing the respective service keys as created before.
As an alternative, one can create Communication Systems on the SAP BTP platform manually and use the button to proceed to Communication Arrangement creation screen.
Connection test
Following the import, Communication System definition and Communication Arrangement are created automatically. Connection test option is available.
Click on the button to do a connection check. Popup with test result will appear.
Step 4. Configure Messaging Inbound Communication User.
In Communication system created for Messaging API.
Open Communication system and go into edit mode.
Click on + button in Users for Inbound Communication section.
Select existing user or create a new one and confirm clicking OK.
In Communication Arrangement created for Messaging API.
Open Communication Arrangement and go into edit mode.
Click on User Name value help in Inbound Communication section.
Select proper user and save the changes.
Solace PubSub+ configuration
Navigate to you PubSub+ instance and open Event Broker for service you want to configure.
Step 1. Create Rest Delivery Point
In Message VPN, Create a new REST Delivery Point. It can be found in Clients tab.
Step 2. Create REST consumer
For Created REST Delivery Point create REST consumer. Use Service URL and user as defined in created Communication Arrangement for Messaging API.
HTTP method: POST
Host: Only Host from Service URL (skip https:// and path)
Step 3. Create Technical Queue
Create Technical Queue INT4SuiteTechBTP that will be used by Int4 Suite.
As a owner of the queue set #rdp/<rdp_name>. Use REST Delivery Point created in previous steps.
Step 4. Create Queue Binding
Go back to created RDP (Clients->REST->created RDP) and create Queue Binding using name of technical queue created in previous step.
As a Post Request Target put path from Service URL Messaging API Communication Arrangement:
/sap/bc/http/INT4/AEM_QUEUE_TST_SRV
Step 5. Create Request Headers
For created Queue Binding create Request Headers:
Header name: aem-topic
Header value: ${topic()}
Header name: ‘aem-message-vpn’
Header value: <name_of_your_message_vpn>
Header name: ‘int4suite-environment’
Header value: <name_of_your_psp_environment_in_int4suite>
Step 6. Enable Solace PubSub+ Message Collection
In order to capture messages from Solace PubSub+ installation into Your system for easy creation of test cases based on historical data, please proceed to the (v1) Solace PubSub+ Message Collection page of the manual.