Integrator Server SOAP API
Jedox Integrator Server offers a web service API and communicates with clients using the protocol specification SOAP (Simple Object Access Protocol). All clients send requests using this API, and the server sends a response in XML format. The API covers all back-end functionality of Jedox Integrator, such as creation of projects, data preview, execution of jobs, and retrieving execution monitor information. A valid OLAP server session must be used when calling SOAP methods. The SOAP API is available only in on-premises environments.
Jedox Integrator runs as a Java servlet inside of a Tomcat service (JedoxSuiteTomcatService). When this service is started, the WSDL file (Web Services Description Language) of Integrator Server can be accessed in a web browser at http://<tomcat server>:<tomcat port>/etlserver/services/ETL-Server?wsdl
To access the Integrator SOAP API from the local machine, you would enter
http://localhost:7775/etlserver/services/ETL-Server?wsdl
To access the Integrator SOAP API from the outside, the following changes must be made:
In server.xml, change the address for HTTP and AJP to 0.0.0.0. This allows Tomcat to be visible from the outside and to listen to all interfaces.
For our example, you would change
<Connector port="7776" address="127.0.0.1" connectionTimeout="20000" protocol="HTTP/1.1" redirectPort="8443" />
<Connector port="8010" protocol="AJP/1.3" address="127.0.0.1" />
to:
<Connector port="7776" address="0.0.0.0" connectionTimeout="20000" protocol="HTTP/1.1" redirectPort="8443" />
<Connector port="8010" protocol="AJP/1.3" address="0.0.0.0" />
With the help of this SOAP API, Jedox Integrator can be accessed with every modern programming language that offers support for SOAP web services, e.g. Java, PHP, C#, and others. Coding examples for PHP that also cover the authentication procedure can be found in Accessing Jedox Integrator from PHP.
Updated April 19, 2023