Project Setup

This chapter provides an overview of the recommended multi-module Maven project setup to get started with a project-specific implementation of the FS-CD Adapter.

Recommended Project Structure

recommended project structure
fscd-adapter    my.group-id.fscd-adapter:fscd-adapter-parent
|__ ics         my-group-id.fscd-adapter:ics
|__ ipm         my-group-id.fscd-adapter:ipm
|__ shared      my-group-id.fscd-adapter:shared
|__ webapp      my-group-id.fscd-adapter:webapp

These modules are the reference implementation delivered as source code. In order to obtain the project files, please contact your Faktor Zehn point of contact or the Faktor Zehn product development.

Additional Information

  1. Depending on the IPM, either the ipm-basis (German Versicherungsbasis) or ipm-base (international Insurance Base) module should be used. Since both are never deployed together, the @ConditionalOnProperty annotation can be removed from the IbEditingEventListener and IbPolicyEditingReader classes (or their Vb* counterparts).

  2. Additional modules can be added as needed, for instance web and business modules to customize corresponding FS-CD Adapter modules.

  3. If a specific integration is not required, the whole module can be removed.

  4. Additional information about the modules' internals can be found in chapter Integration Layer.

Webapp Module

The webapp module bundles the other modules into a runnable Spring Boot application and provides sensible Spring Profiles.

SAP Java Connector (JCo)

The SAP Java Connector (SAP JCo) is a library that enables Java applications to communicate with SAP systems via SAP’s RFC protocol and can be installed as follows.

  1. Download the library as zip file from the official SAP website (requires SAP account)

  2. Extract the zip file to a local directory

  3. Provide the directory to the JVM with argument java.library.path (see below)

Start the FS-CD Adapter

To start the FS-CD Adapter locally, replace /path/to/sapjco3/ with the path pointing to the JCo directory, profileA,ProfileB with the Spring profiles to activate and run

`mvn spring-boot:run -Dspring-boot.run.jvmArguments="-Djava.library.path=/path/to/sapjco3" -Dspring-boot.run.profiles=profileA,profileB`