OData API
With the OData API, you can access OLAP databases and their dimensions and elements, as well as cubes, Views, and cells. Integrator components, such as extracts and transforms, are also reachable, so you can fetch source rows, and loads and jobs to be run from the OData Hub. Note that a separate license is required for the OData API.
For more information, see Jedox OData Hub Overview.
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. Using this API, clients can send requests to which the server sends a response in an easy-to-parse CSV format.
The full documentation for the Jedox OLAP's HTTP API is accessible by opening the address https://olap.name.cloud.jedox.com/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 in 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 in Jedox Web. For example, scripts can be created for databases or database objects, representing the object's content (similar to a “dump” in relational databases). Furthermore, scripts can be executed from the Designer, Modeler, and Integrator 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.
Updated March 19, 2024