Application integration
In the scope of the strategic further development of the product FirstSpirit the Application integration is essential.
For this reason, interfaces to FirstSpirit are provided which enables partners to realise fully independent individual application integrations for FirstSpirit. An application integration API can be accessed, born of practical experience of application integration of the core product, and which has, therefore, already been tried and tested in practice.
In conjunction with the add-on interface (FirstSpirit modules) also long established in the FirstSpirit product, product add-ons can be developed, which seamlessly integrate into the FirstSpirit application integration infrastructure.
The true potential of the application integration lies in particular within the domain of FirstSpirit development partners. With the Application integration API, a powerful tool has been made available to them, with which they can realise specialised integration solutions in their own particular areas of expertise.
At this point, however, it should be noted that Application integration is a highly complex topic which, even after a development period of more than two years, is still not fully developed, as experience with it in turn opens up an increasing number of new applications. Even at the level of the core product, development of FirstSpirit application integration has a long way to go before it is completed, and is still in full swing.
Access API
The Application API is one of the most important point of entry to the Application integration. Using this API application tabs, located in the applications' area of the FirstSpirit SiteArchitect, can be controlled. The Application API is part of the Developer API.
All interfaces introduced in the following are part of the FirstSpirit Developer API. In contrast to the Access API, the requirements concerning the stability for the Developer API are lower: The Developer API remains stable within a minor version line, i.e. methods, classes and functions may be changed in case of a minor version change (see demands for stability of the Developer API). |
The most important parts of the documentation about the FirstSpirit Application API can be found in the package de.espirit.firstspirit.client.gui.applications:
You can find a simple example for opening an application tab of the type BrowserApplication here:
Geolocation Showcase
e-Spirit decided to make the source code of an example implementation accessible, to show FirstSpirit development partners the potential of the FirstSpirit Application integration. For this reason, you can find a Google Maps integration with a special input component CUSTOM_GEOLOCATION in the Sample implementations for components.
ClientPlugin
Another component of the Application integration is the option to integrate a ClientPlugin into the SiteArchitect. By this means it is possible to integrate a module, by using the Public Hotspot of FirstSpirit, which is initialised already while starting the SiteArchitect. This can then control for example application tabs.
Since the ClientPlugin API is only preliminary at the moment, it is not yet subject to the demands for stability as the Developer API is. |
The most important parts of the documentation about the FirstSpirit ClientPlugin API can be found in the package de.espirit.firstspirit.client.plugin: