Jedox APIs
HTTP API for Jedox In-Memory DB (OLAP)
Jedox OLAP server (In-Memory DB) offers a RESTful API and communicates with clients using the HTTP 1.1 protocol. Clients send requests using this API, and the server sends a response in an easily parsable CSV format.
The interface[s] and port[s] through which the Jedox OLAP server listens to all incoming requests is configured in the configuration file palo.ini, with an entry in the following format:
http "<server-address>" <port>
Here, server-address is the network interface via by which the Jedox OLAP server is accessed, and port is a network port. It is possible to specify several listening interfaces; however, a unique port must be specified for each entry.
The full documentation for the Jedox OLAP's HTTP API is accessible by opening the address http://<server-address>:<port>/api in a web browser.
See Jedox OLAP HTTP API and Server Browser.
PHP API for Jedox In-Memory DB (OLAP)
In addition to the HTTP API, you can also connect to the Jedox In-Memory DB by using the Jedox PHP client library and the PHP API it provides. The PHP API provides all functions necessary for establishing a connection to the In-Memory DB, to retrieve data, and to create or modify database contents. The PHP API can be used by a report designer in a Jedox Web spreadsheet macro or Supervision Server (SVS) script, offering extended capabilities compared to Spreadsheet PALO functions.
The connection can be handled in the functions in two ways, each of which requires a slightly different function syntax: as a connection string or as a resource ID. Using a resource ID is generally recommended; the connection string method should be avoided if possible.
An overview and documentation of all functions provided in the Jedox PHP API can be found in the PHP Palo API Documentation, which is available online or as a download.
Java API for Jedox In-Memory DB (OLAP)
Within Integrator Groovy jobs and functions, a Java API (palojlib) – can be used by model builders. The Java API provides all functions necessary for establishing a connection to the In-Memory DB, retrieving data, and creating or modifying database contents.
An overview and documentation of all functions provided in the Jedox Java API can be found in the Java API Documentation, which is available online or as a download.
Database Scripts
Database scripts for Jedox offer a lightweight yet powerful way to create and modify database contents in a simple, scripted approach. Scripts are comprised of commands that are executed against a specific OLAP database. They can be parametrized through use of variables. Support for script execution is built into Jedox Web; for example, scripts can be created for databases or parts of the database, in which case they will represent the object's content (similar to a “dump” in relational databases). Furthermore, scripts can be executed from the Designer and Modeler components. During the deployment of Jedox Models, scripts are used to generate and modify database contents.
Specific documentation for OLAP database script commands is available here:
Open in Browser / Download as zip-archive
Integrator Scripting API
In Jedox Integrator, scripting languages could be used in the following components:
- Groovy functions and jobs
- JavaScript functions and jobs
- Variable definition (Groovy only)
Besides the functionality of the scripting language, Jedox Integrator provides several classes with additional functionality related to Jedox Integrator processing. The Java API Documentation for the ETL components is available online or as a download.
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
See Integrator Server SOAP API .
Updated June 5, 2023