Compilation and Installation

Compilation

Prerequisites

To build the module's source package into a FirstSpirit Module (FSM) file, it is necessary to meet certain prerequisites:

Software

• AdoptOpenJDK 8 HotSpot JVM (in the latest version)
  • The environment variable JAVA_HOME must be set to the proper path.

Optional

The module is delivered for a current FirstSpirit version.
If the module is to be used with another FirstSpirit version, a few adjustments are necessary:

• Additionally, you must make a specific fs-isolated-runtime jar* available to the build environment by placing it in the project-local maven repository, e.g.
  mvn-local-repository/de/espirit/firstspirit/fs-isolated-runtime/[firstSpiritVersion]/fs-isolated-runtime-[firstSpiritVersion].jar
• The variable value defined for the property fsRuntimeVersion must be replaced in the path for the placeholder [firstSpiritVersion], e.g.:
  mvn-local-repository/de/espirit/firstspirit/fs-isolated-runtime/5.2.190306/fs-isolated-runtime-5.2.190306.jar
• Make sure you define the same FirstSpirit version within the build.gradle file for property fsRuntimeVersion, e.g. 5.2.190306.

* The fs-isolated-runtime jar is located in the server installation directory [serverRoot]/data/fslib.

Build Process

1. Download the source Zip package of the module you would like to use:
   • FirstSpirit Sample: OData DataAccessPlugin
   • FirstSpirit Sample: SOAP DataAccessPlugin
2. Extract the Zip package into the desired directory (the Zip package already contains a top-level directory named firstspirit_sample_dataaccessplugin_[TYPE] (with [TYPE] being either odata or soap) which will be extracted along with its contents. That directory will be represented by the placeholder [MODULE_ROOT] in the following steps.
3. Open a command line window or terminal session and navigate to the top-level module directory [MODULE_ROOT].
4. Run the gradle wrapper command with the task assembleFSM as command-line parameter:
   gradlew assembleFSM
5. The file fs-example-dataaccessplugin-[TYPE]-[VERSION].fsm will be placed in the directory [MODULE_ROOT]/build/fsm.

Installation

1. Start FirstSpirit ServerManager from the FirstSpirit start page.
2. Open the Server Properties panel (menu “Server” / “Properties”).
3. Navigate to the “Modules” page and click “Install”.
4. Locate the file fs-example-dataaccessplugin-[TYPE]-[VERSION].fsm created in Build Process and click “Open”.
5. The module provides a service component. Upon installation of the module, FirstSpirit ServerManager will ask if the service should be started automatically when the FirstSpirit server is started.
   
   • If you would like the service to be started automatically, answer to the request with “Yes”.
   • If you would like to start the service manually when needed, answer to the request with “No”. This will require you to start the service manually before the module's functionality can be used.
6. Once module installation has completed, click “OK” to confirm.

As this module was not signed by a trusted software key during the compilation process, it must be configured with “All permissions” in order to use project-specific configuration. For information about the effects of trusting an unsigned module as well as how to assign “All permissions” to a module, see Modules (→Documentation for Administrators). For information about signing your own FirstSpirit modules, see FirstSpirit Manual for Module Developers, chapter “Signieren von Modulen” (available in German only).