Datasets and Parameters

Jarvis supports various internal mechanics for performing actions on behalf of requests executed by client applications.

Datasets

Datasets are configured XML files which map to SQL definitions and are executed against configured databases.

The Dataset Definition and Dataset Storing documentation outlines the basic structure of datasets.

The dataset mechanism currently supports DBI, Mongo DB and SSAS database types.

All datasets support Dataset Transformations to manipulate input and output data.

All datasets support Nested Datasets allow recursive queries to be executed to construct complex RESTful response JSON objects.

Exec

When a dataset requires a command line action to be performed (I.E. performing a call out to a report generate module) the Exec Dataset mechanism is supported.

Plugin

In some situations SQL alone isn’t sufficent for a dataset. To support more complex actions backed by Perl driven code Plugin Datasets are available.

Plugin datasets allow for full integration with the Jarvis API, Databases and provide a mechanism by which a programmer can fully control the acftions required.

Hook

Hook Modules provide a mechanism to trigger Perl code to execute at various stages within the Jarvis request lifecycle.

For example; sanitizing the output of a query; transforming properties.