Terms and conditions

FX Corporate includes a customisable terms and conditions (T&Cs) dialog that is presented to users when they first login to FX Corporate.

Users must agree to the terms and conditions to use FX Corporate. The date and time of each user’s acceptance is recorded by Caplin Transformer’s Persistence Service.

You can update the T&Cs at any time. Users will be prompted to review the new T&Cs at their next login and must agree to the change to continue using FX Corporate.

Setting the terms and conditions text

The legal text for your services terms and conditions is stored in a plain text file on your web server.

File location

The terms and conditions file must be publicly accessible on your webserver. If the file is stored outside of your website’s directory hierarchy, then you must configure your webserver to map a website URL to the file. For guidance on how to configure Apache Tomcat, see Example configuration for Apache Tomcat.

Specify the URL of your terms and conditions file using the TERMSANDCONDITIONS.URL configuration option.

File contents

The format of the terms and conditions file is as follows:

  • The first line contains the version number of the text in the format <major>.<minor>.<revision>. For example: 1.0.0

  • The second and subsequent lines are rendered as a paragraphs (<p>text</p>).

  • Empty lines are rendered as empty paragraphs (<p></p>).

  • Formatting markup, such as HTML or Markdown, is not supported.

An example file conforming to this format is shown below. Note that each paragraph’s text has been abridged (…​) for clarity.

Example terms and conditions file
1.0.0 (1)
Lorem ipsum dolor sit amet ... consectetur adipiscing elit. (2)
Suspendisse lacinia convallis ... leo ac volutpat. (3)
1 Version number
2 First paragraph
3 Second paragraph

An example terms and conditions file is included in the FX Corporate ZIP file. The example file is supplied as an example only; it is not displayed by FX Corporate.

Updating the terms and conditions text

To update the terms and conditions file, edit the terms and conditions file.

If users are required to accept your changes to continue using the service, then increment the version number.

When a user logs in, the version in the terms and conditions file is compared with the last version that the user agreed to. If the user has not agreed to the current version, then the Terms and Conditions Dialog is displayed and the user must agree to the new terms and conditions to continue using FX Corporate. A record of the user’s acceptance is stored in Transformer’s Persistence Service.

Retrieving users' acceptance dates

Each user’s most recent acceptance of your terms and conditions is stored in Transformer’s Persistence Service under the private subject /PRIVATE/PERSISTENCE/TermsAndConditions.

The following data is recorded for each acceptance:

  • the user’s username

  • the version number of the terms and conditions.

  • the date and time of the user’s acceptance.

To retrieve this data from the database used by Transformer’s Persistence Service, execute queries against the TF_RECORD_PERSISTENCE table. For example, to retrieve acceptance data for all your FX Corporate users, run the query below:

SELECT
  PERSISTENCE_USER,
  PERSISTENCE_ID,
  PERSISTENCE_DATA
FROM
  TF_RECORD_PERSISTENCE
WHERE
  PERSISTENCE_ID = 'TermsAndConditions';

Setting an expiry date on acceptance

By default, users are only prompted to re-accept T&Cs if you issue a new version of the T&Cs. You can configure FX Corporate to also prompt users to re-accept T&Cs after a specified number of months.

When a user’s acceptance expires, the user is prompted to re-accept the T&Cs the next time they login. They must accept the T&Cs to continue using FX Corporate.

For more details, see the documentation on the TERMSANDCONDITIONS.EXPIRY.MONTHS configuration option.

Example configuration for Apache Tomcat

The T&Cs text file must be available at a publicly accessible URL on your webserver, and the URL of the file must be assigned to the TERMSANDCONDITIONS.URL configuration option.

To configure Apache Tomcat to serve the T&Cs text file, add the XML below to the web application context at $CATALINA_BASE/conf/enginename/hostname/appname.xml:

<Resources>
  <PostResources
    className="org.apache.catalina.webresources.DirResourceSet"
    base="../conf/resources"
    webAppMount="/resources" />
</Resources>

For more information on how to configure the context of your web app, see The Context Container in the Apache Tomcat configuration reference.

See also: