Skip to content

Getting Started

The Open Source section covers the Prowide open source libraries for FIN MT and ISO 20022.

The Prowide Integrator section covers the complemetary licensed libraries and tools.

Other content in this section provides general information about the standards, and also references for the libraries impementation and maintenance policies.

Download

The open source libraries are available at Maven Central. The following links provide the coordinates for each libraries:

Download coordinates

The Prowide Integrator is licensed software, thus download and usage is restricted to licensed customers.

To see the changelog of each release, check the release notes section.

All libraries are compatible with Java 11+.

Learn by example

The online examples at GitHub cover key features of each library. For the open source projects you can just checkout the example project and start running the examples in your IDE.

Each example cover a specific feature and is self contained, so you can just run the main method of each example class.

The default setup uses Gradle.

For the Prowide Integrator, in order to compile and run the examples you need either a production or trial distribution of the required libraries.

Examples

Compile and Run

The primary intention of the examples is to show code. Most of them produce some kind of output though. All example classes have a main method that you can easily run in your IDE.

This project can serve as a template for your own, allowing you to copy and customize examples to fit your requirements. To leverage this, you must incorporate Prowide libraries into your project. There are two main approaches to integrate Prowide dependencies:

1) Direct Use of JARs from Your Local Environment:

This approach suits projects that manually manage dependencies. Obtain the JARs by downloading the open-source libraries from core and iso20022, or by extracting them from a Prowide-provided zip file.

Follow these steps to use this method:

  • After downloading the necessary JAR files, copy them to your project's lib folder.
  • In the root directory of the prowide integrator examples project, find the lib folder containing a put_your_jars_here.txt placeholder. Replace this file with the JAR files you've downloaded, ensuring they're placed at the same level as the placeholder. This placeholder file lists example JAR names for reference.
  • For Maven projects, start with the mvn local pom.xml example as a template and customize it as needed.
  • For Gradle projects, begin with the build.gradle example and modify accordingly.

If not using Maven or Gradle, directly include all necessary JARs in your classpath.

2) Accessing Libraries via Prowide's Remote Repository::

Most projects benefit from this method, as it simplifies dependency management and ensures access to the latest library versions. Configure your project to use the Prowide Nexus repository. We offer templates for both Maven and Gradle to facilitate this process. This method also applies if you have local access to the libraries and wish to copy them to your local repository.

For Maven projects:

  • Use the pom.xml example as a starting template and adapt it to your project.
  • Incorporate settings from our settings.xml example into your Maven settings file to configure Nexus repository access.

For Gradle projects:

These guidelines help you effectively incorporate Prowide libraries into your project, whether by direct JAR integration or through remote repository access. Each of these methods offers a different approach to managing dependencies, so select the one that aligns best with your project setup and management preferences.

Important Note on Library Versions

Prowide regularly releases new versions of its libraries. As such, the versions of the libraries you use may need to be updated over time. To check the latest versions and relevant changes, please visit the Prowide Release Notes. It is recommended to regularly review this page and update your project's library versions accordingly to ensure compatibility and access to the latest features and fixes.

Learn by reading

If you prefer to learn concepts step by step, our developer guides is the best place to start. Every chapter cover a specific feature and it is no necesarry built on the knowledge introduced in the previous chapters, so you can freely navigate to the sections you are interested in.

Most of the online examples are also covered in the developer guides, so if you rather use the documentation pages you will not be missing anything.

The developer guides are a permament reference you can reach at any time, while starting your journey with the libraries or when you need additional knowledge about a specific feature in an advance stage.

Notice the Prowide Integrator developer guides are not public. A password is required to access the full content.

The guides are constantly updated and improved, so you can always check for new content.

Documentation

API reference

The Javadoc is the reference for the API of each library. It is automatically generated from the source code and it is available online.

Javadoc

Note the Prowide Integrator Javadoc is not public. A password is required to access.

SWIFT Resources

The development documentation assumes some familiarity with the SWIFT MT and ISO 20022 standards. You don’t have to be an expert, but it’s harder to learn how to use the libraries API without the fundamental ideas of the message structures it handles.

The About SWIFT section provides a brief introduction to the standards, and links to the official SWIFT documentation.

Issues

For open source users, you can post Issues or questions at the relevant GitHub repositories:

Issues

Please check the existing opened and closed tickets first before posting a new one.

A Prowide developer or any other community user would normally reverts back within a few days.

Prowide Integrator customers

For commercial customers, please use the support email or Jira portal for your inquiries. Notice that request from non-registered email address are not catched by the Service Desk, and thus ignored.