User Details Service

The User Details Service provides information about a user to front-end applications. The data is typically drawn from a Customer Relationship Management (CRM) system.

An implementation of the User Details Service (UserDetailsAdapter) is required for the following features in Caplin FX Sales from v1.18: Sales Intervention, and Unregistered Client Dealing.

UserDetailsAdapter class

The UserDetailsAdapter class, available in FX Integration API 3.5 and above, provides extra information about the sales user and the clients the sales user trades on behalf of. The information is usually sourced from a bank’s Customer Relationship Management (CRM) system. Because permissioning data is also commonly stored in a bank’s CRM system, previous techniques for publishing user details often repurposed the Permissioning Integration API. This technique was convenient but unsuitable because it could reduce the performance of the permissioning system. With the introduction of the UserDetailsAdapter class, repurposing the Permissioning Integration API to publish data unrelated to permissioning is now discouraged.

There are three different possible ways of accessing user details:

  • SalesUserDetails: For accessing details regarding a sales user.

  • ToboUserDetails: For accessing details regarding a client when trading on their behalf.

  • UserDetails: For accessing details regarding a client when self serving.

Each of these have their own subject, but typically you would expect UserDetails and ToboUserDetails to have the same details for the same user.

Implementing a User Details Adapter

For most architectures, with a permissioning adapter already connected to the CRM, the permissioning adapter is the best place to implement a User Details Service.

Follow the steps below:

  1. Add the following object mapping to your adapter’s rttpd.conf file:

    object-map "/PRIVATE/SALESUSERDETAILS" "/PRIVATE/%u/SALESUSERDETAILS"
object-map "/PRIVATE/SALES/USERDETAILS/TOBOUSER/%1" "/PRIVATE/SALES/%u/USERDETAILS/TOBOUSER/%1"
object-map "/PRIVATE/USERDETAILS" "/PRIVATE/%u/USERDETAILS"

  2. Add the following include pattern to the add-data-service block in your adapter’s rttpd.conf file

    include-pattern "^/PRIVATE/[^/]+/SALESUSERDETAILS"
include-pattern "^/PRIVATE/SALES/[^/]+/USERDETAILS/TOBOUSER"
include-pattern "^/PRIVATE/[^/]+/USERDETAILS"

  3. For guidance on developing a UserDetailsAdapter, read the NovoUserDetailsAdapter example in the examples directory of the FX Integration API Kit.

Permissions

To permit users to view the user details subjects, add the following permissions to the global namespace:

Permission
Field Description

Action

VIEW

Product

^/PRIVATE/%u/SALESUSERDETAILS

Namespace

Authorisation

ALLOW
Permission
Field Description

Action

VIEW

Product

^/PRIVATE/SALES/%u/USERDETAILS/TOBOUSER

Namespace

Authorisation

ALLOW
Permission
Field Description

Action

VIEW

Product

^/PRIVATE/%u/USERDETAILS

Namespace

Authorisation

ALLOW

See also: