Configuration of web service listen connections
For connectors that use the shared web server to manage incoming traffic, connection settings are controlled at the Runtime level on the Shared Web Server panel within Runtime Management.
In standard Integration connectors, a connection component is paired with an operation component to build a direct link to a desired application or data source. This is not the case for connectors that use the shared web server to manage incoming traffic. For API publishing, connection settings are controlled at the Runtime level, so the same web server can be used for all processes that are deployed to the Runtime.
-
The Shared Web Server panel (Manage > Runtime Management > Settings and Configuration > Shared Web Server) is used to specify URL requirements and to control network and security settings at the account and account user level.
-
The maximum number of configurable API users, including the account itself, is specified by the container property
com.boomi.container.sharedServer.http.maxSoaUsers. -
The default number of API users is 200, which is the maximum number allowed by the Runtime. You may want to set this to a smaller number for your Runtime. For information about configuring access to API processes at the individual user level, see the topic about securing APIs.
-
The AS2 Shared Server and Web Services Server connectors use the shared web server to manage incoming traffic. Their connection components are not predefined. You must create a process to use the shared web server settings along with the associated operation.
-
The process(es) containing the connectors must be deployed to launch web server listening and to route the proper documents to a process.
-
If you are using API Management, you must likewise deploy the API Service component in which an API endpoint(s) are defined that link to the process(es). See the related topic about Designing APIs for information about generating and configuring API endpoints.
Review the Web Services Server Operation Configuration topic to learn how to construct advanced API scenarios and implement response paging.
Base URL
The base URL for a Runtime’s deployed APIs is shown in the Runtime’s Shared Web Server panel. By default this URL is constructed based on the Runtime’s host name or external host name and the shared web server’s port/SSL port settings.
- For a runtime cloud or Test runtime cloud, use the domain name shown in Hostnames and IP addresses for the runtime clouds.
Listen connections on local runtimes
-
If you want to publish APIs that integrate with local applications or data sources behind your firewall, you need to deploy the integration process to a local Runtime that has access to those resources.
-
If you are using a local Runtime within a secure network, you should configure your firewall/router to route incoming messages to this Runtime. The proper ports should be opened for the Runtime web server to receive messages.
-
The web server settings can be configured to forward requests to a standard HTTP or HTTPS address.
| Definition URL (recommended) | http(s)://<External/Internal Host>:<Port>/ws/soap?wsdl | Used to output multi-file WSDLs. |
| Definition URL | http(s)://<External/Internal Host>:<Port>/ws/soap?wsdl=single | Used to create a WSDL merged into one file, with inline schemas and no includes. |
Listen connections on the Boomi Runtime Clouds
-
Each runtime cloud’s Runtime instance manages the authentication token settings for your account ID and the runtime cloud's domain name. For all runtime clouds, the token (password) is accessible from the Runtime Management page.
-
The web server settings for a runtime cloud's domain name are managed in the runtime cloud on the Runtime Management page.
-
By default, the connection requires an HTTPS address and BASIC authentication to connect. If you are accessing the WSDL via a browser or SOAP client, you will be prompted for a user name and password.
Sample Definition URL
https://c01-usa-east-integrate.boomi.com/ws/soap?wsdl
Listen connections on the Boomi Test Runtime Clouds
The above information regarding runtime cloud connections otherwise applies to the Test runtime clouds. The only aspect of Test runtime cloud connections that differs is the presence of the subdomain “test” in the base URL.
Protected input headers
- Protected input headers can be configured for a Runtime’s shared web server in the Shared Web Server panel.
- When a header is protected, its value in a REST/SOAP/simple HTTP request cannot be passed to the web service listener process execution as a dynamic document property.
The following HTTP headers are designated as protected in the shared web server’s default configuration:
| General Headers | Request Headers | Non-standard Headers |
|---|---|---|
Connection | Host | Proxy-Connection |
Upgrade | Proxy-Authorization | x-Forwarded-For |
Via | X-Forwarded-Proto |
