Allegra Core Dokumentation

We publish here the JavaDoc Core documentation to help you understand better how to write custom cockpit tiles and report datasources. Please note that the internal classes can be changed any time and that you can rely solely on the official public APIs.

Core Java Documentation


Here you get libraries for Java and .NET that make it easy to work with the Allegra webservice interface.

To get started, install Groovy on your computer, download the TC client libraries and place them into <your home directory>/.groovy/lib. Then follow the instructions in the Allegra online help under "Using the TC command line client".

Software Release 7.1.0 für Java

TC client for Groovy console

Client Library (TCL)

Web Service Definition File

Web Service API Documentation

Java examples for using the TCL

C# .NET TCL with examples


The nice thing about cockpit tiles is that most administrative functionality like placing them in the proper place on the cockpit is already taken care of by the Allegra framework. You develop your view using the cockpit development kit provided below. This will create a JAR file which you deposit into the lib directory of your Allegra application on the server. After a server restart your new view can be placed on your cockpit.

Software and Documentation

Allegra Developers Manual with CDK Tutorial


Allegra comes with a number of report templates and datasources. If you cannot create your own, special custom report using the standard datasources that come with Allegra you need to program your own. With custom datasources you can create any report conceivable.

A report consists of

  • a report datasource that queries the database and returns the data in XML format.
  • an optional report configuration view that permits you to select filter conditions (e.g. data from last month, or any other criteria). This view is completely customizable, you can program anything you like to make life easy for your users.
  • a presentation view based on a template.

You work with Jaspersoft Studio to develop your own report templates, using existing report datasources. You can also create your own handcrafted views when you are willing to do a little programming. A report datasource provides the first two items, namely the data in XML format and optionally a configuration view. To create new report datasource types you need to know how to program in Java, using the Allegra API. To get started download the Developers Manual listed below and go to Chapter 4. Just follow the instructions there.

Software and Documentation

Developer's Manual 4.x

Javadoc API documentation