Stored Procedures User Interface

This service is named storedprocedures and allows to read, edit and run stored procedures. A stored procedure is a SQL query with the possiblity to template parameters.

To see the stored procedures menu entry on the Portal, the storedprocedures=view permission is required.

Note

The storedprocedures=* permission will grant access to all the functions mentioned below.

View the stored procedures

To have access to all the stored procedures, you need to have the storedprocedures=read permission. Otherwise, you cannot read the data.

If your permission has values like this: storedprocedures=read('Stored Procedures 1', 'Stored Procedures 2'), you will only see the Stored Procedures 1 and Stored Procedures 2 stored procedures.

Edit a stored procedure

Editing a stored procedure requires the storedprocedures=edit permission.

Double-click on the line associated to a stored procedure to see the edit form.

Warning

If the stored procedure type is different from UserDefined, you will not be able to edit it.

When a stored procedure is created, the user query value will be parsed and any content inside a ${ } enclosure, will be defined as parameters and displayed in the parameters list.

Run a stored procedure

Running a stored procedure requires the storedprocedures=read and the storedprocedures=edit permissions.

In the case you run the stored procedure without filling the parameters, you will received an error.

In the other case, the results will be displayed as a table.

Run and export a stored procedure

You need the same permissions than the one needed in order to run a stored procedure.

When you Run and Export a stored procedure, a spinner will appear informing you that it is running. When it is done, the Running Jobs modal will appear and allow you to export your results.

If an error has occured, it will be displayed in an editor below the execution panel.