Developing with FX Sales

You have the option of taking a source code release of FX Sales, which allows you to customise and extend FX Sales. This page provides an overview of how to get started.

We encourage extending Caplin source code rather than changing it. Changing the source code can make taking future upgrades more difficult.

Caplin offers training on FX Sales and can offer advice on how to customise it safely. To learn more, contact your Caplin account manager.

Requirements

To develop with FX Sales, you need:

  • Node.js version 14.

  • OpenJDK 8 or 11.

  • The 'variantsalestrader-version.zip' source code file for your variant of FX Sales, available from the Caplin downloads page.

  • Yarn package manager.

  • Caplin CLI. See Installing Caplin CLI.

  • Network access to GitHub.

  • Network access to the npm registry.

A working Caplin Platform stack, connected to your backend systems, composed of:

Preparing for development

There are a couple of things you need to decide on for this project:

  • Where to store the project’s Java dependencies.

  • A Git branching strategy that makes taking future source code releases easier.

Storing dependencies

Before you start customising FX Sales, decide where you’re going to store this project’s Java module dependencies, as listed in the file variantsalestrader/apps/salestrader/server/java/dependencies.gradle. You can choose to store this project’s dependencies in one of two locations:

  • (Recommended) An artifact repository such as Artifactory.

  • Your project’s Git repository.

Branching strategy

It’s important to decide on a branching strategy early on in the project to make taking upgrades to FX Sales easier. An example of a simple branching strategy follows, which uses a caplin branch to track changes between Caplin source code releases and merge them into an integration branch, develop.

branchingstrategysales

To set up this example branching strategy, follow the steps below:

  1. Create a new directory to host your project.

  2. Extract the 'variantsalestrader-version.zip' file to the project directory.

  3. Initialize the git repository:

    $ git init
  4. Add all files to the staging area:

    $ git add --all
  5. Execute the initial commit:

    $ git commit -m "Initial commit"
  6. Tag the commit to record the version of the Caplin source code release:

    $ git tag caplin-fxsales-2.0.0
  7. Create an integration branch (develop) and a branch to track Caplin source code releases (caplin):

    $ git branch develop
    $ git branch caplin

When a new version of FX Sales is released:

  1. Checkout the caplin branch:

    $ git checkout caplin
  2. Delete all files in the caplin branch:

    $ rm -r *
    Do not use git rm -r * to delete the files. If you delete the files using an IDE, it will likely run the git rm command to execute the deletion.
  3. Extract the new source code release to the caplin branch.

  4. Update Git’s staging area to match your working directory:

    $ git add --all
  5. Commit changes:

    $ git commit -m "Caplin source code release FX Sales 2.21.0"
  6. Tag the commit:

    $ git tag caplin-fxsales-2.21.0
  7. Checkout the develop branch:

    $ git checkout develop
  8. Merge caplin into develop:

    $ git merge caplin
  9. Resolve merge conflicts.

Creating your development project

Follow the steps below:

  1. Download your 'variantsalestrader-version.zip' source code file of FX Sales, available from the Caplin downloads page.

  2. Create a new directory under your development directory to host the new software project.

    home usernamedevelopment variantsalestrader
  3. Extract the source code ZIP into this directory.

    The directory now looks like this:

    home usernamedevelopment variantsalestrader apps packages-caplin
  4. If you have chosen to store your Java module dependencies in an Artifactory repository (see Preparing for development above), then import all the JAR files from variantsalestrader/apps/salestrader/server/java/src/main/webapp/WEB-INF/lib into that repository. For the group IDs of the JAR files, please see the file variantsalestrader/apps/salestrader/server/java/dependencies.gradle.

    Add your internal artifact repository to this project’s build.gradle file:

    variantsalestrader/apps/salestrader/server/java/build.gradle
    repositories {
        mavenCentral()
        maven {
            url "https://plugins.gradle.org/m2/"
        }
        maven {
            url 'https://<artifactory_host_name>/artifactory/<repository_name>'
        }
    }
  5. Initialize your Git repository, and create branches according to your branching strategy. See the suggested branching strategy above.

  6. In the directory variantsalestrader/apps/salestrader/ run the command below to install this project’s Node modules:

    $ yarn install

You can now start customising the source code of FX Sales.

Previewing your changes

To preview any customisations you make to your variant of FX Sales, follow the steps below:

  1. In the salestrader directory variantsalestrader/apps/salestrader/, run the appropriate command below to start Express and Gretty:

    Java module dependencies stored in an artifact repository
    $ yarn start --variant variant
    Java module dependencies stored in the project
    $ yarn start --variant variant --useLocalDeps

    When you specify --useLocalDeps, the dependencies stored in directory variantsalestrader/apps/salestrader/server/java/src/main/webapp/WEB-INF/lib are used.

    If you run yarn start without --useLocalDeps, all local dependencies in the variantsalestrader/apps/salestrader/server/java/src/main/webapp/WEB-INF/lib directory are deleted in expectation of downloading them from a Maven compatible repository.

View a preview of your customisations at http://localhost:8080.

When you make a change to your project, refresh the page to view your changes.