IRIS R18 User Guide PDF

IRIS R18 - User Guide
©2018 Temenos Headquarters SA - All rights reserved.

Warning: This document is protected by copyright law and international treaties. Unauthorised reproduction of this document, or any portion of it, may result in severe
and criminal penalties, and will be prosecuted to the maximum extent possible under law.
Table Of Contents
Introduction 3
Purpose of the Guide 3
Intended Audience 3
Overview 4
Prerequisites 5
Maven, Java 5
Key Application configuration 6
API Dev 9
Getting Started 10
Workbench Installation 12
Creation of Artefacts in T24 16
Creation of Service Container 18
Creation of Service Project 22
Creation of Provider API 30
Security 44
Creation of Published API 48
Deployment and Configuration 55
Deployment options 55
T24 Connectivity Configuration TAFJ and TAFC 55
SSL Configuration for IRIS R18 on Jboss 7 59
IRIS R18 Dynamic Mocking 65
Infrastructure Services 72
Directory Services 72
Tools 74
RIM Importer 75
Appendix 114
T24 Enquiry 114
T24 Version 119
IRIS R18 - Page 2 of 120

Introduction
Purpose of the Guide
This document helps the user to design models and resources for the data service which is generated from
the designed models to communicate with T24. This allows the model to be used for all T24 users. This doc-
ument also helps to configure and deploy IRIS R18 provider and publisher components of T24 infrastructure.
Intended Audience
This User Guide is intended for the use of External and Partner teams to deploy IRIS R18 Module.

Overview
IRIS R18 is a lightweight, REST standards based solution that uses OFS message format to communicate
with T24. This allows the solution to be used for all T24 customers across release versions.
The below screenshot shows the overview of the solution and its components.
l Provider API Layer : hosts REST APIs for T24 modules

l Published API: hosts Published API. Used to transform provider API to an interface external applic-
ations or standards message formats.
l Connectors: Standard connectors available to connect to T24 based on the T24 deployment
(TAFC/TAFJ).
l Consent Management: management layer to apply access control while servicing API requests from
client application.
l Service Catalogue: hosts SWAGGER API documentation for Provider and Publisher APIs.
l Apache Camel: is an open source frameworks used to define rest end points, transforms data and
route messages in Publisher and Provider layer.

Prerequisites
The following tools should be available for development and testing purpose:
Item Link
Apache Camel http://camel.apache.org/
Maven https://maven.apache.org/
Spring https://projects.spring.io/spring-framework/
Open API Spec, fka Swagger https://swagger.io/

Postman https://www.getpostman.com/
Eclipse http://www.eclipse.org/
Junit http://junit.org
Maven, Java
Maven and Java 8 are required. You can download the other dependencies from the Maven repository.

Key Application configuration
T24 Application Configuration
OFS.SOURCE Configuration
1. FIELD Val in order to enable Field validation for OFS Messages specifically for AA activities, configure
the attribute Field Val as Yes of OFS.SOURCE

2. Remove the TWS attribute in the OFS.Source

Note: Restart the T24 Application to apply the configuration for the application runtime.

API Dev
An API defined in Swagger 2.0 is imported into an API project. Import process will create the Camel routes,
mock responses and wire the routes to the mock responses. This is done using a Maven plugin, either from
your IDE or from the command line.
This module covers the following topics.

Getting Started
The table below describes the technical terminologies used in the solution.
Terms Description
Swagger Swagger is an open source software framework backed by a large ecosystem of tools that
helps developers design, build, document, and consume RESTful Web services.
Apache Apache Camel is an open source framework for message-oriented middleware with a rule-
Camel based routing and mediation engine that provides a Java object-based implementation of
the Enterprise Integration Patterns using an application programming interface (or declar-
ative Java domain-specific language) to configure routing and mediation rules.
Archetype It is defined as an original pattern or model from which all other things of the same kind
are made.
Maven Maven is a build automation tool used primarily for Java projects.
Inventory It is a file that provides the information of an API in core banking terms. It helps in creating
the service implementation by generating swagger specification of an API.
payload The actual information or message in transmitted data, as opposed to automatically gen-
erated metadata.
Deploy- A deployment descriptor refers to a configuration file for an artifact that is deployed to
ment some container.
Descriptor
The following steps are required for API development:

l Creation of Artefacts in T24- This section explains how data is retrieved from T24 system and
provided to IRIS to expose to external requests. This in turn reduces the data loads being retrieved
and simplifies the whole process. Also, it can be referred as filtering of T24 data by T24 being expose
to the external request.
l Creation of Service Project- It contains the default directories and set of model data. It basically acts
as a platform where developers can build and run the required APIs. It also contains a set of arche-
types which gives developers options of creating desired APIs.
l Creation of Provider API- Provider APIs expose core banking capabilities as RESTful APIs. The key
concept is that each Provider API is driven from an inventory that defines the contents of the API in
core banking terms. The inventory is used to create the Swagger specification of the API. Together,
the inventory file and the generated swagger specification are used to create the service imple-
mentation.
l Creation of Published API- Publisher APIs provide the following REST resources:

o Login
o Logout
o Add API, Update API, Remove API, Copy an API
o Validation roles
Note: When you access any API other than the login and logout APIs through an external REST
client, first invoke the login API to ensure that user is authenticated. When the login API is
invoked, the system stores the generated session cookie in a file, which we use in the next API
invocations.

Workbench Installation
IRIS R18 Workbench
IRIS R18 Workbench is a Licensed Design-Time Tool that can be effectively used to create Provider APIs as
well as Publisher APIs. A separate request is required to make to the Distribution to acquire the workbench
which facilitates you to create the APIs on your own.
IRIS Workbench Packaging

For acquiring the package, a request should be made for IRIS R18 design time package which will follow the
naming convention IRISR18_Design_vxx.xx.xx.zip where xx denotes the release version.
This package will mainly consist of the following components :
l irf-web-client.war - This is the Workbench war which needs to extracted from the zip package and
can be deployed in any of the application servers(jboss, weblogic, websphere). It is required to con-
nect to T24 via jetty server or default IRIS war.
l irf-test-web.war - This is an out of box pre-configured IRIS R18 war which will by default contain PSD2
APIs. This war can be deployed in jboss and can be used by the Workbench to connect to T24 during
Design Time (steps mentioned below to configure the workbench for it).
l irf-repo - This is the IRIS R18 Framework artefacts that forms the repository and are needed while
generating an IRIS war from the container project.
IRIS Workbench Configurations Steps

Step 1 : Extract the irf-web-client.war from the received Design time package IRISR18_Design_vxx.xx.xx.zip.

Step 2 : Deploy the irf-web-client.war in deployment folder of Jboss Application Server.
Step 3 : Verify that the irf-web-client.war is deployed successfully and Workbench is up and running.
l Open New Browser Window & type http://localhost:9089/irf-web-client/
Step 4 : To start creating Provider APIs, you are required to connect to T24 to get a list of artefacts for
which you intend to generate an API service. There are two ways to do this :
l First way is using jetty server started from the created container project. For that, ensure that the
setting in the workbench has been properly configured and T24 is up and running. By Default , jetty

runs on 8080 port.
l Second way is to connect via irf-test-web.war provided as a part of the IRIS Design time package.
For that you need to extract the irf-test-web.war from the package and deploy it in the jboss server.
Once successfully deployed, you need to configure the WorkBench by adding a new server in the set-
tings as shown below to connect to T24 via pre-configured irf-test-web.war

Step 5 : Once properly configured, you should hover to APIs → Create Provider API and the Workbench list
you all the available artefacts in T24\. You are ready to go and create your own APIs.

Creation of Artefacts in T24
In order for T24 Version and Enquiry artefacts to be used in the Interaction Framework, certain rules must
be followed. These rules provide a simple and effective governance framework that
l Clearly identifies that a given T24 artefact is used in an API
l Allows simple versioning control to be applied to the T24 artefact following semantic versioning
(refer http://semver.org/)
l Provides data type meta data to ensure clean conversion of data from T24 to internet standard data
types
l Provides meaningful operation names
The following rules must be followed:
ID Naming Convention
For Enquiry, the following ID naming convention must be followed:
Examples: PZ.API.ACCOUNTS.BALANCES.1.0.0, PZ.API.ACCOUNTS.TRANSACTIONS.1.0.0

For Version the following ID naming convention must be followed:
Example: FUNDS.TRANSFER, AC.API.CREATE.TRANSFER.1.0.0

Field data typing
Each Enquiry column and Version field must have a data type defined.
For Enquiry, this is the FIELD.DISP.TYPE field,
For VERSION the ATTRIBS field is used.
Fields are considered to be alphanumeric unless they are set as Date or Amount. Amount and date fields
must be unformatted, e.g. 20170123 and 1234.56
S.No T24 Data Type Swagger Schema Data Type

1 ALPHANUMERIC string
2 AMOUNT number
3 DATE Date
4 TIMESTAMP Date-time
5 BOOLEAN Boolean

Description
Each Enquiry and Version must have a description. For Enquiry, this is the DESCRIPT field, for Version the
DESCRIPTION field is used.
This is used to describe the operation supported and should follow verb/resource/subresource, e.g. getAc-
countTransactions, getAccountBalances, createAccountTransfer
Restrictions on Enquiry
Header fields should not be used in API enquiries.

l Turn SEL.LABEL into API style labels
l remove HEADER
l Turn FIELD.LABEL into API style labels
l Use FIELD.DISPLAY.TYPE for data type (Alphanumeric / amount, date)
l remove any static labels - where OPERATION is a literal and COLUMN is set
l Set ATTRIBS to ''
l Remove drill down information (ENQUIRY.NAME,SEL.CRIT,LABEL.FIELD,NXT.DESC)
l Set DESCRIPT to be the operation, e.g. getAccountBalances
Naming should be in standard vocabulary
The standard Temenos vocabulary exists to bring consistent naming across all API initiatives. Field / main
resource / sub resource names should exist in the standard vocabulary.
Click here to know how the T24 enquiry definition affects the JSON response.
Note: If there is an existing Service Project, you can skip Create Service Project step and nav-
igate to Provider API step.

Creation of Service Container
In order to run any API projects, you should have a service container. A service container hosts one or more
service projects. It is also a runtime container that hosts the camel run time and configuration required to
connect to downstream systems, i.e. T24
You can create the service container using the supplied Maven Archetype, either from your IDE or from the
command line.
Using the command line
mvn archetype:generate -DarchetypeGroupId=com.temenos.irf -DarchetypeArtifactId=irf-service-con-

tainer-archetype
-DarchetypeVersion=1.0
Supply values for various arguments, either interactively or as parameters from the command line:
Define value for property 'groupId': com.temenos.training.irf
Define value for property 'artifactId': training-container
Define value for property 'version' 1.0-SNAPSHOT: :
Define value for property 'package' com.temenos.training.irf::
Confirm properties configuration:
groupId: com.temenos.training.irf
artifactId: training-container
version: 1.0.0-SNAPSHOT
package: com.temenos.training.irf
As a single command:
mvn archetype:generate -DarchetypeGroupId=com.temenos.irf -DarchetypeArtifactId=irf-service-con-
tainer-archetype
-DarchetypeVersion=1.0 -DartifactId=training-container
-DgroupId=com.temenos.irf.training -Dpackage=com.temenos.irf.training -Dversion=SNAPSHOT-0.0.1
Using Eclipse
From the File menu, select File > New > Maven Project

Click the Next button.
Select Archetype
Select the irf-service-container-archetype option from Artifact Id and click the Next button.

Provide Project Details
Fill in the Group Id, Artifact Id and Version fields, and click the Finish button.

Project Structure
You should see a project created with the following structure:
Start the server
You can now start the server, either from the command line or from your IDE using mvn jetty:run
mvn jetty:run
In Eclipse, right click the project and select Run As > Maven Build
In the dialog box, set the Goals to jetty:run

Creation of Service Project
Create a service project using the irf-service-archetype.

mvn archetype:generate -DarchetypeGroupId=com.temenos.irf -DarchetypeArtifactId=irf-service-archetype
-DarchetypeVersion=1.0 -DarchetypeCatalog=local
Define value for property 'artifactId': training-api
artifactId: training-api
version: 1.0-SNAPSHOT
-DarchetypeVersion=1.0 -DartifactId=training-api
Using Eclipse

Select archetype
Select the irf-service-archetype option from Artifact Id column and click the Next button.

Provide Project details
Project Structure

Using Workbench to Define Provider API
The easiest mechanism to create a Provider API is to use the Interaction Framework Workbench. Select
"APIs > Create Provider API":
Step 1 - Start Service Container
Make sure that, Service Container is up and running.

http://localhost:8080/api/v1.0.0/meta/apis
If it is not running, start the server using the following command
jetty:run from maven command prompt
Step 2 - Service Definition
Provide the Title, service Key, Description , etc in the Service Definition section
Step 3 - Select Artefacts to include
Artefacts may be filtered to aid in discovery. Clicking on an artefact will add an endpoint to the service, and
create a URL based on the artefact definitions. Review the URL and Operation to ensure that this matches
the API design. An end point may be removed by clicking on the trash icon in the top right of the endpoint
definition.

Step 4 - Map URL parameters to Query Selection
Where a T24 VERSION is selected, only the method is required to be set. The payload will be configured in
Swagger directly from the T24 Model. POST should be used to create new resources, PUT to amend and
existing resource, GET for viewing a resources and DELETE for removing a resource.
Where a T24 ENQUIRY is selected, the URL parameters need to be mapped to the ENQUIRY selection fields.
A selection field can be mapped from mulitple URL query or path parameters. In the above example,
fromDate and toDate are both mapped to the valueDate selection field.
Click Next in the top right fo the screen to review the provider API
Step 5 - Review

The inventory file can be copied directly from the Inventory pane and pasted into an IDE. Or if preferred
click Finish to create a zip file file containing the swager spec, Camel routes, mappings and mock
responses.
Step 6 (optional) - Submit
Click Finish the top right fo the screen to submit the provider API
The result provides a link to download a zip file containing the swager spec, Camel routes, mappings and
mock responses.

Step 7 Importing generated Artifacts
Extract the content of downloaded zip into <service-provider> project/ resources folder.
Project Structure
Step 8 - Build The Provider API Project
Run the project as Maven > Install to build the project
Build the Service Project

Right click the project and choose Run As > Maven install to build the project.

Creation of Provider API
Provider APIs expose core-banking capabilities as RESTful APIs. The key concept is that each Provider API is
driven from an inventory that defines the contents of the API in core banking terms. The inventory is used
to create the Swagger specification of the API. Together, the inventory file and the generated swagger spe-
cification are used to create the service implementation.
Creating an Inventory using Interaction Framework Workbench

The easiest mechanism to create a Provider API is to use the Interaction Framework Workbench. Select
"Create Provider API":
Step 1 - Service Definition
Provide the Group and Key (used in as the Group in the Maven artefact), the service title and the version of
the service.
Step 2 - Select Artefacts to include
Artefacts may be filtered to aid in discovery. Clicking on an artefact will add an endpoint to the service, and
create a URL based on the artefact definitions. Review the URL and Operation to ensure that this matches
the API design. An end point may be removed by clicking on the trash icon in the top right of the endpoint
definition.

Step 3 - Map URL parameters to Query Selection
Where a T24 VERSION is selected, only the method is required to be set. The payload will be configured in
Swagger directly from the T24 Model. POST should be used to create new resources, PUT to amend an exist-
ing resource, GET for viewing a resource and DELETE for removing a resource.
Where a T24 ENQUIRY is selected, the URL parameters need to be mapped to the ENQUIRY selection fields.
A selection field can be mapped from mulitple URL query or path parameters. In the above example,
fromDate and toDate are both mapped to the valueDate selection field.
Click Next in the top right of the screen to review the Provider API.
Step 4 – Review

Note: The inventory file can be copied directly from the Inventory pane and pasted into an IDE
or if preferred click Finish to create a zip file containing the swagger spec, Camel routes, map-
pings and mock responses.
Click here to know how to create a zip file containing the swagger spec, Camel routes, mappings and mock
responses.
Create Service Project

Create a service project using the irf-service-archetype.

-DarchetypeVersion=1.0 -DarchetypeCatalog=local
Define value for property 'artifactId': training-api
artifactId: training-api
version: 1.0-SNAPSHOT

-DarchetypeVersion=1.0 -DartifactId=training-api
Using Eclipse
Select archetype
Select the irf-service-archetype option from Artifact Id column and click the Next button.

Provide Project details

Project Structure
Submit the Provider API

After creation of inventory file as shown in Step 4 of the Creating an Inventory using Interaction Framework
Workbench.

Click Finish in the top right of the screen to submit the provider API.
The result provides a link to download a zip file containing the swagger spec, Camel routes, mappings and
mock responses.

Build the Service Project
Run the project as Maven > Install to build the project
Click here to know about T24 Connectivity Configuration TAFJ and TAFC
Deploy and Test Provider API

Add to the Service Container Project
In your service container project, amend the pom.xml to include your API as a dependency:
NB There are several dependencies tags in the pom.xml file - this dependency needs to be added to the
MAIN dependency, below the comment:

<dependency>
<groupId>com.temenos.training</groupId>
<artifactId>provider-accounts</artifactId>
<version>0.0.1-SNAPSHOT</version>
</dependency>
The service container should restart automatically, if not stop the server and restart manually.
Check Deployment
Use Postman to make a GET request to the management service

localhost:8080/api/v1.0.0/meta/apis
You should see the servicer returned in the response:

{
"header": {

"serviceCount": 9,
"audit": {
"processTime": 9
},
"body": [
"service": "provider-accounts.service.v1.0.0",
"endPoints": [
"method": "POST",
"uri": "/v1.0.0/provider-accounts/payments"
},
"method": "GET",
"uri": "/v1.0.0/provider-accounts/{accountId}/transactions"
},
"service": "accounts.service.v1.0.0",
"endPoints": [
"method": "GET",
"uri": "/v1.0.0/accounts/{AccountId}/transactions"
},
Exposing AA Activities as Provider APIs

Service configuration

Define the Service Definition parameters for "New Arrangement creation" for a Mortgage loan product.
Select the "LENDING" option under the "Available artifact" section and add it.
Enter Activity & Product Details
Select the product group MORTGAGES from the list and click Product: Mortgage and Activity: New
Arrangement.
Select-able payload properties should appear on the screen.
Click the request and response payload tick boxes to specify the input (Request Payload) and output
(Response Payload). In case both of them are the same, click "Response payload same as request pay-
load".
Default behavior, i.e., in case no boxes are selected, will result in all the applicable properties to be used.
Response payload version can be configured by creating AA.ARR.{property class},AA.API.RESPONSE.1.0.0
For example: AA.ARR.ACCOUNT,AA.API.RESPONSE.1.0.0

Download the Generated Artifacts
Click Next and click Finish.
Workbench displays a URL link to download the generated artifacts.
Create Lending API project using eclipse Maven Archetype

1. Create provider api project for Lending Product using the Maven Arch type.
a. Select "irf-service-archetype" of Dev.0.0.0-Snapshot Version
b. Enter Service API project details

Group Id : com.temenos.irf.training.aalending
Artifact id : provider-smallbusinessloan-service
Click Finish.
Import and Build the Generated Artifacts
1. Extract the generated artifacts into the resources/services folder of the Lending API project created
from the Service API maven archetype.
2. Buildthe Service API project using maven command
mvn clean install

3. Add dependencies of API maven project in the Container maven pom.xml under "dependencies" sec-
tion.
<dependency>
<groupId>com.temenos.irf.training.aalending</groupId>
<artifactId>provider-smallbusinessloan-service</artifactId>
<version>0.0.1-SNAPSHOT</version>
</dependency>
4. Build and Restart the Container project

Test Mortgage Loan Service
1. Test the Service from Postman using the below Url

a. URL :http://localhost:8080/api/v1.0.0/product/mortgage
b. data :
{
"header": {
},
"body": {
"parties": [
"partyId": "100100",
"partyRole": "USD"
],
"currencyId": "USD",
"commitment": {
"amount": "7000",
"term": "1Y"
and Post the request

2. Get success response with the Arrangement details

Replace Indicator
By default, all PUT request messages are mapped with OFS replace Indicator.
Messages (update messages) with replace indicator tells T24 to update the record by regenerating the
entire record. Hence, the mandatory fields required by the record generation process has to be passed to
T24 for a successful output. To learn more about OFS replace indicator, please refer to OFS User Guides.
To disable replace indicator functionality, add the following in your service XML.
...
<setProperty propertyName="ignoreReplace">
<constant>true</constant>
</setProperty>
...

Security
Token Based Security Filter Implementation
IRIS Data Services can be supported as an intermediary in an authenticated request with the JWT token as a
mechanism for authentication and identification with the help of this functionality. The handling of the JWT
token is expected to be fully configurable to support various deployment choices from naive authenticator
to the most secure one.
The JWT Token based authentication solution is designed as pluggable and extendable through con-
figuration.
Click here to go to the Configurations page.
Configurations
Spring Security Filter Enablement
IRIS web application gets enabled with Spring security filter chains by configuring respective tags in the
web.xml of IRIS application. springSecurityFilterChain Filter should be added to enable spring security.

Spring Security Configurations
spring-jwt-iris-authenticator.xml – is used to define spring beans and should be loaded as a part of con-
figuration. Add spring configuration xml in the web configuration settings.
spring-jwt-iris-authenticator.xml Configuration
This authenticator xml allows the user to extend the IRIS infrastructure based on their token validation
requirements.
Below section helps to configure the Spring Security Authentication Provider and the Token Validation filter
based on the user requirement.
Out of the box, Temenos provides Validation filter and Authentication provider to validate the JWT token.
The Validation filter uses this configuration XML to perform the algorithm, claim, and Signature validations.
I. AlgorithmValidator
The ‘alg’ value should be the default of RS256 or any one of the values given under Rely-
ingPartyClient property “idTokenSignedAlg”.
The ‘kid’ optional parameter, if present, is used to identify the key for decrypting the token applying
the valid algorithm in the ‘alg’ claim.
II. SignatureValidator
A signed token needs to be validated for the signature to verify the integrity of the token.

If the client is configured to support an unsigned token and there is no signature then there is no sig-
nature validation required.
III. ClaimValidator
ClaimValidator is a generic validator for various claims in the token. Each instance of the ClaimVal-
idator would validate one specific claim. The claim that needs to be validated is injected into the
instance.
The following are the claims default validators supported for:
1. exp
2. iss
3. aud
4. azp
5. iat
IV. CustomValidator
A generic custom validator can be defined through which any number of custom validations could be
written and plugged into the validator composite through simple spring beans configuration.
For example, if the user wants to implement a custom validator to perform custom validation with
authentication provider, user can implement additional validator by implementing base interface of
the validation which provides token and the http request objects to the custom validator.
Custom validator needs to extend “com.temenos.security.oidc.token.validator. TokenValidator”
and should implement “verify” method
Upon successful authentication by obtaining and validating the token, the validation filter builds and
propagates the authenticated principal and invokes the remaining filter change as normal.
Spring Security uses org.springframework.security.core.userdetails.UserDetails to manage user
information across the application. Once the requests get authenticated, Spring security made user-
Details available as a part of Spring Authentication object.
IRISAuthenticatedUser is the iris authenticated user object used to carry user data as a part of Spring
Authentication object.
On successful authentication of the token, the successfulAuthentication callback sets Spring Authentic-
ation object references in the Spring Security Context. The Security Context holds the user inform-
ation (IRISAuthenticatedUser ) which is available across the IRIS Version and Enquiry processors.

T24 Security Filter Configuration
IRIS T24 Processors uses T24 Security Context to construct OFS message with the respective user cre-
dentials. T24SecurityFilter derives the User principal from the Spring Security Context and constructs user’s
T24 security context.
Out of the box, Temenos provides a T24 Security filter "com.temenos.ir-
f.comms.security.AuthImpl.T24SpringSecurityContextFilter". This T24 Security filter retrieves the user prin-
cipal from spring security context and constructs T24 Security context which is used for constructing the
OFS message.

Creation of Published API
Overview
An API defined in Swagger 2.0 may be imported into an API project. The import process will create the
Camel routes, mock responses and wire the routes to the mock responses. This is done using a Maven plu-
gin, either from your IDE or from the command line.
Creation of Provider Service Project

Click Next
Select archetype
Select the irf-service-archetype and click next

Provide project details
Fill in the Group Id, Artifact Id and Version fields, and click Finish.

Project Structure

Import API Spec
The import process is done using the Interaction Framework Workbench. Go to APIs > Import API Definition.
You should be able to see the following screen.
Select the publisher swagger definition (swagger json file) that you want to import and then click Upload
Give your service a name in the next screen and click Upload & Generate
Download and extract the zip and place the generated files in the service project

Project Structure
Refresh the project view and verify the project structure:
Provider API to Published API Mapping

Map path params from publisher to provider
Route for published Funds Transfer Status Report
...
<rest path="/v1.0.0/published" produces="application/json" id="published.service.restlet">
<get uri="/payments/{accountid}/statusreport" id="PublishedPaymentStatusReport">
<param name="accountid" type="path" required="true"/>
<to uri="direct:published.PublishedPaymentStatusReport"/>
</get>
</rest>
...
<route id="direct.published.PublishedPaymentStatusReport">
<from uri="direct:published.PublishedPaymentStatusReport"/>
<to uri="direct-vm:order-PSD2.getPaymentTransferList" />
<process ref="FTStatusReportResponseMapper"/>
</route>

Note: Use "direct-vm" component to map all the publisher path params to provider path
params. This will enable it to look through all the CamelContexts present in the same JVM and
route to the underlying provider API.
Save all the files, and build the publisher api project as Maven > Install.
Sample Publisher route for the reference
Additional Beans before CamelContext tag
...
<bean id="FTInitiationRequestMapper" class="com.temenos.irf.published_FT_api.FTIni-

tiationRequestProcessor"/>
<bean id="FTInitiationResponseMapper" class="com.temenos.irf.published_FT_api.FTIni-

tiationResponseProcessor"/>
<bean id="FTStatusReportResponseMapper" class="com.temenos.irf.published_FT_api.FTStatusRe-

portResponseProcessor"/>
<bean id="FTSubmissionResponseMapper" class="com.temenos.irf.published_FT_api.FTSub-

missionResponseProcessor"/>
...
Published FT Status Report Route

...
<get uri="/payments/{accountid}/statusreport" id="PublishedPaymentStatusReport">
<param name="accountid" type="path" required="true"/>
<to uri="direct:published.PublishedPaymentStatusReport"/>
</get>
...
<route id="direct.published.PublishedPaymentStatusReport">
<from uri="direct:published.PublishedPaymentStatusReport"/>
<process ref="FTStatusReportResponseMapper"/>
</route>
Published FT Initiation Route

...
<post uri="/payments/transfer/initiation" id="PublishedPaymentTransferInitiation">

<to uri="direct:published.PublishedPaymentTransferInitiation"/>
</post>
...
<route id="direct.published.PublishedPaymentTransferInitiation">
<from uri="direct:published.PublishedPaymentTransferInitiation"/>
<process ref="FTInitiationRequestMapper"/>
<process ref="FTInitiationResponseMapper"/>
</route>
Published FT Submission Route

...
<post uri="/payments/transfer/{id}/submission" id="PublishedPaymentTransferSubmission">
<param name="id" type="path" required="true"/>
<to uri="direct:published.PublishedPaymentTransferSubmission"/>
</post>
...
<route id="direct.published.PublishedPaymentTransferSubmission">
<from uri="direct:published.PublishedPaymentTransferSubmission"/>
<process ref="FTSubmissionResponseMapper"/>
</route>
The request and response mappers configured will have java code to transform from publisher json format
to provider json and vice versa.

Deployment and Configuration
This section covers the following topics.
Deployment options
Once the service project is build, the user can deploy it using either of the following application servers:
l Jboss
l Weblogic
l Websphere
You can configure the IRIS R18 solution using TAFJ (JMS Connector) or TAFC (TCS and TOCFEE Connectors).
T24 Connectivity Configuration TAFJ and TAFC

The following connectors are used in connectivity configuration of TAFJ and TAFC:
JMS Connector - TAFJ & TAFC TOCFEE

From T24 R09, the Temenos Open Connectivity Framework has been updated to allow deployment in Java
Enterprise Edition application servers – TOCF (EE). TOCF (EE) is a family of JEE compliant components
providing connectivity to T24. However, in addition to utilising industry standard connectivity mechanisms
for security, high availability and connection pooling, TOCF (EE) also facilitates connectivity to external sys-
tems from T24.
JMS (Java Message Service) is an API that provides the facility to create, send and read messages. It
provides loosely coupled, reliable and asynchronous communication.
JMS Connector provides JMS based connector implementation for Interaction Framework X to interface
with T24 using OFS Message-based interface.

Deployment Configuration
1. JMS Resource Configuration required in the Deployment Descriptor
The following resources references are expected to get configured to use the respective JNDI
resources available in the application server:
l queue/t24OFSQueue – need to get mapped to OFS Request Queue 's JNDI resource.
l queue/t24OFSReplyQueue – need to get mapped to OFS Response Queue's JNDI Resource.
l jms/jmsConnectionFactory – need to get mapped to JMS Connection factory Resource.
2. Application Context - Spring bean configuration
Below configuration is required in the Application Context.xml to load JMS Based connector factory.
<bean id="t24JmsConnectionProperties" class="com.temenos.irf.config.StandardPropertyReader">
<property name="path" value="irf-config/jms.properties"/>
</bean>
<bean id="t24JMSConnectionFactory" class="com.temenos.irf.comms.jms.JMSConnectorFactory">

<property name="propertyReader" ref="t24JmsConnectionProperties"/>
</bean>
irf-config/jms.properties — Contains the following set of configurations to handle retry in case of JMS
Queue or Connection related failures:
l RetryWait=60
l RetryCount=3
l ConnectionTimeout=30
3. Remote Connectivity
This section is applicable only when Interaction Framework components and TAFJ application are
deployed in different Servers (specifically JBOSS).
l Application context configuration
Application Context configuration in applicationContext.xml will be
<bean id="t24ConnectionProperties" class-
s="com.temenos.irf.config.StandardPropertyReader">
<property name="path" value="../irf-config/standalone-comms remote.properties"/>
</bean>
<bean id="serviceLocatorProperties" class-

s="com.temenos.irf.config.StandardPropertyReader">
<property name="path" value="../irf-config/service-locator.properties" />
</bean>

l JBoss Management User Creation
To access TAFJ or TOCFEE JMS Queues, a management user needs to be created in JBOSS Man-
agementRealm.
RUN add-user.bat/add-user.sh available in <JBOSS_HOME>/bin directory.
The user id and password set using add-user.bat/add-user.sh in the JBoss environment needs to
be configured in standalone-comms remote.properties.
l standalone-comms remote.properties
Sample content of standalone-comms remote.properties is as shown below
java.naming.provider.url — Remote URL of JBoss instance where TAFJ/TOCFEE is deployed

java.naming.security.principal — Management User created in Remote JBOSS instance
t24.security.context=INPUTT/xxxxxxx – T24 User to be used to connect T24
java.naming.security.credentials - Credentials of the Management User (to be saved as plain
text)
internal.reqque.jndiname=jms/queue/t24OFSQueue
internal.respque.jndiname=jms/queue/t24OFSReplyQueue
external.reqque.jndiname=jms/queue/t24TCIBQueue
external.respque.jndiname=jms/queue/t24TCIBReplyQueue
Usage
JMS Connector will be used as a T24 interface connector in Interaction Framework X where
T24 Deployment mode is:

l TAFJ or
l TAFC - where TOCFEE component is enabled.
TCS Connector - TAFC TCS

In earlier releases of T24, Temenos supported T24 Server Services (TSS) which provided a programmable
interface for external application to interact with T24 over TCP/IP. The TCS client distribution has necessary
libraries to connect to TSS and exchange messages for business transactions. In case of T24 deployment
where TSS services are running, TCS connector needs to be enabled for T24 integration.
TCS Connector provides TCS based connector implementation for Interaction Framework X to interface with
T24 using OFS Message-based interface.
Deployment Configuration
1. TCS Resource Configuration is required in the Deployment Descriptor
The following resources references are expected to get configured to use the respective resources
available in the Application Server:
l tcs/tcsConnectionFactory – should get mapped to TCS Connection factory Resource.
l Need to start listeners by invoking the TCServer.bat.
2. Application Context – Spring bean Configuration
l Below configuration is required in the ApplicationContext.xml to load TCS Based connector fact-
ory.
<bean id="t24ConnectionProperties" class="com.temenos.irf.config.StandardPropertyReader">
<property name="path" value="../irf-config/tafc-connection.properties"/>
</bean>
<bean id="t24TafcConnectionFactory" class="com.temenos.irf.tcs.TCSConnectionFactory">
<property name="propertyReader" ref="t24ConnectionProperties"/>
</bean>
Usage
TCS Connector will be used as a T24 interface connector in Interaction Framework X where T24 Deploy-
ment mode is TAFC.

SSL Configuration for IRIS R18 on Jboss 7
This explains you how to setup SSL/HTTPS support for your Jboss 7 server using the pure Java imple-
mentation supplied by JSSE.
Firstly, you have to configure keys and (self-signed) certificates for your web server. This guide will briefly
explain how to accomplish that.
l Pure Java SSL-Setup using keytool
Generate a secret key/certificate and store it in a file called a "key store". The certificate is valid for
1 year = 365 days. The password use for encryption is "temenos".
1. Step 1: Generate key
$ keytool -genkey -alias temenos -keyalg RSA -keystore temenos.keystore -validity 365
(open a cmd prompt pointing to the bin directory eg: ..\jdk8\bin & execute the given com-
mand to generate the key )
Command Line
Enter keystore password: temenos
Re-enter new password: temenos
What is your first and last name?
[Unknown]: localhost
What is the name of your organizational unit?
[Unknown]: IT
What is the name of your organization?
[Unknown]: temenos
What is the name of your City or Locality?
[Unknown]: Bangalore
What is the name of your State or Province?
[Unknown]: Karnataka
What is the two-letter country code for this unit?
[Unknown]: IN
Is CN=localhost, OU=IT, O=temenos, L=Bangalore, ST=Karnataka, C=IN correct?
[no]: yes

Enter key password for <deva> temenos
(RETURN if same as keystore password):
Re-enter new password: temenos
You will find a key generated "temenos.keystore" in the same jdk bin directory.
2. Step 2: Configure JBoss 7
Once the key is generated, move the key to the configuration directory of your application
server(in this case \jboss\stan-
dalone\configuration\).Inthestandalone.xmlconfigfile,underthesubsystem<subsystem xmlns-
s="urn:jboss:domain:undertow:3.1">, include a http-listener for "https" as follows : (include the
highlighted line )
3. <server-identities> in ApplicationRealm realm Definition

The server identities section of a realm definition, which is used to define how a server appears
to the outside world, currently this element can be used to configure a password to be used
when establishing a remote outbound connection.
Add the Highlighted lines:

Once this is done, startup you jboss, by default jboss https runs on port 8443, you can configure
as per your wish.
Ensure your jboss is up and running.Try to access https://localhost:8443/ , if you see the below
page, its configured properly and listening on configured port 8443.
4. Step 4: Certificate Installation in Browser

l In this step, you need to install the self-signed certificate as per the screen shots below.
l Certificate Installation Wizard
l Provide the path to import the self-signed certificate

l Certificate imported successfully
l Now the SSL works fine with HTTPS

Note: The name ‘localhost’ should be same with the Common Name (CN) provided while cre-
ating a keystore and truststore.

IRIS R18 Dynamic Mocking
Overview
IRIS Mock Services support dynamic mock response generation based on the fields present as a part of API
metadata and dynamically generated data based on the local mock dictionary maintained. IRIS Mock Ser-
vices are responsible to generate random data for the metadata fields based on the domain mock files
maintained for the same. If the fields are not present in the specified domain (specific mock file), it gen-
erates random data based on the corresponding field datatype.
Design
MockDataMgmtProcessor & MockResponder are the classes responsible for handling and generating ran-
dom data for a request dynamically at run time.
The MockDataMgmtProcessor provides implementation to insert, update, view and delete entries into
domain specific mock file maintained at basepath specified as a part of mockDataMgmtProcessor bean
property.
The MockResponder provides implementation to generate mock responses based on metadata at run time
, it gets corresponding random data by performing a lookup on the domain specific mock file maintained at
basepath specified as a part of mockResponder bean property, and generating response schema out of it.
If the field is not present in the specified mock domain dictionary file, based on the mentioned datatype, it
is expected to generate some random data for it.
Spring Configurations
The mockDataMgmtProcessor bean should be properly configured with basePath property set to the base
Directory where mock Files folder holding all the domain specific mock files are placed.
The mockResponder bean should be properly configured with basePath property set to the base Directory
where mockFiles folder holding all the domain specific mock files are placed.
Services for Domain Specific Mock Dictionary

There is a provision to perform various operations such as to insert, update, view and delete new entries
into the maintained mock dictionary via various services. Corresponding Swagger schema is also published
in reference to that.

Note: If you are referring to the mock dictionary from the classpath, then you will not be
allowed to add, update or delete any of the mock dictionary files from these services, only view
access are permitted.
Understanding MockResponder Service

The MockResponder provides implementation to generate mock responses based on metadata at run
time, it gets corresponding random data by performing a lookup on the domain specific mock file main-
tained at basepath specified as a part of mockResponder bean property, and generating response schema
out of it. If the field is not present in the specified mock domain dictionary file, based on the mentioned
datatype, it is expected to generate some random data for it.
As a part of APIs created from the Workbench ,you will have a mock json file corresponding to the service
generated in a mock directory inside the service directory as shown below:

1. Each of the generated mock json contains all the metadata fields along with corresponding datatypes.
2. Along with this, there is a unique field “ref” along with the mapped domain specific mock file, cre-
ated during generation itself as shown in above figure.
3. During Mocking the Request, IRIS R18 looks into the above file mentioned in the “ref” of the mock
json to get random data from already maintained domain specific mock file.
4. If “ref” is not present in the json, it just generates the response same as in the generated mock json.

5. It perfoms a lookup in the mock dictionary files based on the domain in the generated mock json and
get random values for all the fields in the mock json.
6. If not present, it randomly generates values based on the datatypes of the fields mentioned in the gen-
erated mock json.
Steps you need to Follow to Mock your Service

Step 1 : Create a new service

Step 2 : Once Service is generated, Check the generated mock file for "ref" in the json is proper or not.
Step 3 : Modify the service xml, configure the property to set "mockTarget" pointing it to the generated mock file
for reference to fetch metadata and "ref" for dictionary reference at run-time.

Step 4 : Ensure that the mockResponder and mockDataMgmtProcessor beans are configured properly in Applic-
ationContext.xml so that the mock dictionary can be reference to generate mock Data.

Step 5 : Add the service dependency in the container project, start the jetty and you are good to go. Test your Ser-
vice.

Infrastructure Services
Directory Services
Directory based service locator is one of the three, lookup implementation for dynamically listing the avail-
able APIs and displaying the swagger spec. This service locator implementation is available in irf-service-loc-
ator and configurable in Application Context xml file as properties of processor ServiceDirectoryProcessor.
IRIS R18 APIs adopts Open API Specification and defines schema for all services supported.
Listing the services

Users can discover the services supported using the discovery url. Below url helps users to get the swagger
documentation url for all the services supported in T24 deployment.
http:<base url>/api/v1.0.0/meta/apidocs?
Where base url will be used to access IRIS R18 application.
Example: http://mybank.com/IRIS-Web/api/v1.0.0/meta/apidocs ?
Sample Response:
Additionally users can also filter the services by using below query parameters:
l resource- used to filter based on the resource name.
Example: resource=”account-info”
l tag- used to filter based on the tags specified in the swagger API specification.
Example: tag = “accounts”

Swagger Specification
The url available in the response of API Docs request can be used to get the swagger api documentation of
the provider apis.
"http://localhost:9089/irf-test-web/api/v1.0.0/meta/apidocs/payments-1.0.0"

Tools

RIM Importer
Overview
RIM Importer is a part of IRIS R18 tool chain, the tool intends to address the challenge of migration of leg-
acy IRIS generated API’s to current IRIS R18. The Tool also intends to migrate 80% of the existing API
involving both manual and automated work process. The tool helps to “Load, Transform, Validate and Gen-
erate” API Services that is compatible to IRIS R18.
Note: The generated API Services is still up to the user or an individual to test and verify for
intent.
The IRIS R18 API migration is a commandline based tool that helps in reducing the effort of API migration.
Below is the architectural diagram for RIM Importer. RIM Importer intends to take RIM and generated
properties files to convert the legacy IRIS generated API to IRIS R18 compliant API as Service i.e CamelCon-
text (.zip) files. The RIM files alone is sufficient if the artefact naming convention was followed which case
the generated properties files are optional, though recommended for accurate and reliable extraction of
API’s and is must for field mapping for the ENQUIRY type of artifacts. The tool generates intermediate API
(.csv) files for verification, nice REST compliance of the URL, other details to be compliant to IRIS R18 con-
vention and rules as needed or applicable. The updated API (.csv) files is fed back to tool for API Service gen-
eration harnessing the existing IRIS R18 tooling system. The output of the system is Camel Service Context
(.zip) files which are consumed in the IRIS R18 Service Component which in turn gets hosted by the IRIS R18
Container getting deployed and hosted on the Web Server as Container to host the T24 artefacts as L2 API
Service aka Provider API’s.

Workflow
RIM Importer performs migration from Legacy IRIS System to IRIS R18 in three steps which involves both
manual and automated work job towards correction and generation.
l API Extraction
l API Validation
l API Generation
API Extraction
The base RIM and T24 Properties Files from the delivered API’s from the legacy IRIS is provided for API
Extraction project wise. The artifacts are used to reverse engineer the API information and to compile a list
of API for the migration. The extracted API list from each of the Project are compiled to respective API CSV
files.
Once the API's are extracted from the provided RIMS, the tool can automatically create the relevant arte-
fact in T24 Server by following the IRIS R18 convention making completely discoverable to the IRIS R18
designer to extend and validate the APIs using the designer. The auto creation of the artefact automatically
updates resource and field description compatible to vocabulary. Vocabularies are maintained by the ver-
tical domain experts and by the API governance team. Vocabulary standardizes the rest api path formation
based on domain terms. The artefact creation step by default is not mandatory but if the naming con-
vention is satisfactory to the expectation then auto creation of the artefact is recommended.
API Extraction
Usage : -e -f C:\IRIS-Importer\TCImages -o C:\IRIS-Importer\TCImages.csv

-e : (M) Generates the Entity Models from RIMS and optionally loads the properties files if input to the
importer to extract the list of API’s and details.

-f : (M) The input RIMS and Properties files are provided as files.
or
-d : (M) The input RIMS and Properties files are provided as directory.
-p : (O) Input importer properties file e.g C:\IRIS-Importer\importer.properties
-o : (O) Specifies the output file and location where the raw Extracted API is saved. This token is optional,
when not specified, gets saved in a file "IRIS-ExtractedAPIs.csv" in the current working directory of the IRIS
R18 Importer Console Application.
Artefact Creation
Usage : -c -f C:\IRIS-Importer\Release\output.csv -p C:\IRIS-Importer\Release\importer.properties -m

C:\IRIS-Importer\Release\domains.properties
-c : (M) Sets the importer in automatic artefact creation mode, the extracted api's output file is loaded to
generate artefact compatible with IRIS R18 API specification from old artefact.
-p : (M) Input importer properties file e.g C:\IRIS-Importer\importer.properties
-m : (M) Specifies the domain properties file that classifies or categorizes the artefact into domain (Main-
tained by each vertical or by governance team)
API Validation
The extracted API CSV is then audited manually, the URL and parameters for the enquiries are corrected
manually as required to be compatible with IRIS R18 specification. The audited files are then sent to T24 for
artifact verification and validation upon which the results are saved as finalized API CSV files.
Usage : -v -f C:\IRIS-Importer\TCImages.csv -o C:\IRIS-Importer\TCImagesEx.csv

-v : (M) Sets the importer in validation mode, the extracted list of API’s and details are loaded for validation
especially URL and Artefacts(VERSION and ENQUIRY).

-f : (M) Input extracted api list file e.g C:\IRIS-Importer\TCImage.csv
-p : (O) Input importer properties file e.g C:\IRIS-Importer\importer.properties
-o : (O) Specifies the output file and location where the validated Extracted API is saved, token is optional.
API Generation
The finalized APIs are loaded for an intermediate inventory(json) file generation compatible to IRIS R18 API
Web Service generation. The inventory file is then used to generate API Services(.zip) using existing IRIS R18
Tooling.
Inventory Generation
Usage : -i -f C:\IRIS-Importer\TCImagesEx.csv -o C:\IRIS-Importer\Importer-Provider-Inventory.json

-i : (M) Sets the importer in inventory generation mode, the extracted & validated list of API Details are
loaded for inventory generation compatible with IRIS R18 API specification.
-f : (M) Input extracted & validated API file e.g C:\IRIS-Importer\TCImagesEx.csv
-o : (O) Specifies the output inventory file and location where the Inventory file is saved, token is optional
Camel Service Context Generation
Usage : -s -f C:\IRIS-Importer\Release\Importer-Provider-Inventory.json -o C:\IRIS-Importer\Release\

-s : (M) Sets the importer in camel service context generation mode, the generated and validated inventory
file is loaded for camel service context for the APIs compatible with IRIS R18 API specification.
-f : (M) Input generated API Inventory file e.g C:\IRIS-Importer\Release\Importer-Provider-Inventory.json
-o : (O) Specifies the output path or location where the Services needs to be generated and saved

Getting Started
Prerequisites
1. Java/JDK 1.8
http://www.oracle.com/ , JAVA_HOME is set appropriately
2. Maven 3.3+
https://maven.apache.org/ , MAVEN_HOME is set appropriately
3. Latest UTP with TAFJ
http://utp.temenosgroup.com/ , TAFJ_HOME is set appropriately
4. Eclipse Oxygen or any preferred version
http://www.eclipse.org/downloads/eclipse-packages/
5. REST Client or POSTMAN or Insomnia (Optional)
6. Browser Extensions : JSON Formatter, JSONView, etc (Optional)
Procedure
1. Download latest rimimporter released pack from Temenos Maven Repository Click here to Down-
load.
Link : http://maven.temenosgroup.com/content/groups/temenos/com/temenos/irf/irf-rim-importer-
packager/DEV.0.0-SNAPSHOT/
2. Extract the rimimporter pack.
3. Navigate to location "..\irf-rim-importer" within the extract folder.

4. To Extract API's using sample RIMs (TCIB, Nordea), Run "1.extract-apis.bat"

Note: Open Run IRF-73.bat and Edit the rim Source Path
5. Extracted APIs will be written and found in file "output.csv"

6. Verify and Confirm the API extracted from RIMS and edit, if required
Note: Editable Columns Domain, Parent Resource, Resource, ResourceId, Verb, Oper-
ationId, OperationKey, Selections

7. Validate the extracted API's against the IRISX conventions for conformance, Run "2.validate-
apis.bat"

8. The validation status along with the reason will be updated in file "validated_output.csv"

9. Refer Status column for conformance status and refer Reason column for the failure cause.
10. Correct and re-run steps 7-9 until Status columns gets TRUE.
Note: Update vocabulary or artifact if resource or property doesn't exist (VERSION,

ENQUIRY)

11. The extracted API's with Status = TRUE are ready for the inventory generation, Run "3.generate-
inventory.bat"
12. The inventory file "imported-provider-inventory.json" will be generated in IRISX service generation
schema.
Note: Verify the correctness of import via Workbench & to generate the service using
Workbench

Note: Update vocabulary or artifact if resource or property doesn't exist (VERSION,
ENQUIRY)

13. The inventory is ready to generate camel service context, run "4.generate-service.bat"
14. The service context will be generated under folder(s) "out" and "zip" respectively.
15. Copy the service context from "out" directly or Extract latest archive from "zip" to IRF Service Pro-
ject "src/main/resources"

16. Build service project.
Note: Refer documentation on how to create and build IRF Service Project
17. Run container project, if not running already.
Note: Refer documentation on how to create, build and run IRF Service Container Project
18. Open REST Client or Browser (Chrome)
Note: In case, you choose Browser then appropriate extensions are installed to view JSON
e.g JSON Formatter
19. Enter http://localhost:8080/api/v1.0.0/meta/apis"

20. Find the created service listed with all imported endpoints listed.
Things to remember
1. Click Download to download the latest rimimporter release package from the Temenos Maven Repos-
itory
2. Setup Import Configuration

a. Copy all rims to any valid folder and edit "1.extract-apis.bat" to change the source path.
b. Copy all corresponding generated properties files to "..\irf-config\generated"
Note: Needed for hand-coded or modified rims not following the IRIS1 naming
standards
3. T24 - Jboss is running [Mandatory]

4. IRF Service Container Project - Jetty is running [Mandatory]
Note: Refer documentation on how to create IRF Service Container Project.
5. IRF Service Project - referenced in IRF Service Container Project [Mandatory]

Note: Refer documentation on how to create IRF Service Project.
6. Workbench - JBoss is running [Optional]

Link: http://localhost:9089/irf-web-client/
How to create IRF Service Container Project

1. Open Eclipse or EDS
2. Click File > New Project
3. Select Maven Project

4. Click "Next"

5. Uncheck "Create a simple project"
6. Click "Next"

7. Check "Include snapshot archetypes"
8. Select Item with Artifact Id "irf-service-container-archetype"

9. Click "Next"

10. Enter project details
GroupID : com.temenos.irf
ArtifactId : demo-provider-container
Version : 0.0.1-SNAPSHOT [Replace appropriate version]
11. Click "Finish"

12. Find the irf service container project created
13. Setup Build Configuration
a. Select the project
b. Right click on project
c. Select Run As > Maven Build... [First time only]
d. Find Configuration Window Popup
e. Go to Goals
f. Enter "clean install"
g. Click "Apply" & "Run"

14. Setup Run Configuration
e. Go to Goals
f. Enter "jetty:run"
g. Click "Apply" & "Run"

15. Right click and Select Run As > Maven Build
16. Check Eclipse or EDS Console Window for Message "Jetty Started..."
How to create IRF Service Project


4. Click "Next"

6. Click "Next"

7. Check "Include snapshot archetypes"
8. Select Item with Artifact Id "irf-service-archetype"

9. Click "Next"
10. Enter project details


ArtifactId : demo-provider-service
Version : 0.0.1-SNAPSHOT [Replace appropriate version]
11. Click "Finish"
12. Find the irf service container project created

13. Setup Build Configuration
e. Go to Goals
f. Enter "clean install"
g. Click Apply and Run.

14. Reference IRF Service Project in IRF Service Container Project
a. Open POM XML
b. Copy the Artifact Details
c. Go to IRF Service Contained Project
d. Open POM XML
e. Add an artifact reference under references
f. Paste the details
i. GroupId
ii. ArtefactId
iii. Version
g. Save POM XML ( Both Service and container Projects )
15. Right Click and Select Run As > Maven Build
16. Check Eclipse or EDS Console Window for Message "Jetty Restarted..."
How to add IRF Archetypes


4. Click "Next"

6. Click "Next"

7. Click "Add Archetype..."
8. Provide Archetype details

a. IRF Service Container Project Archtype
ArtifactId : irf-service-container-archtype
Version : DEV.0.0-SNAPSHOT [Replace appropriate version]
URL: http://maven.temenosgroup.com/content/repositories/t24-snapshots/com/temenos/irf/
b. IRF Service Project Archtype
ArtifactId : irf-service-archetype

Version : DEV.0.0-SNAPSHOT [Replace appropriate version]
URL : http://maven.temenosgroup.com/content/repositories/t24-snapshots/com/temenos/irf/
9. Click "OK" to add archetype
Alternatively
1. >Browse to "C:\Users\<UserName>\.m2" directory of maven
2. Find and Open "archetype-catalog.xml"
3. Add the below details between <archetypes> ... </archetypes>

<archetype>
<groupId>com.temenos.irf</groupId>
<artifactId>irf-service-container-archetype</artifactId>
<version>DEV.0.0-SNAPSHOT</version>
</archetype>
<archetype>
<groupId>com.temenos.irf</groupId>
<artifactId>irf-service-archetype</artifactId>
<version>DEV.0.0-SNAPSHOT</version>
</archetype>
4. Save the file

How to configure RimImporter to communicate Remote T24 Server
1. Create a new "Application User" in JBoss (Remote Server i.e T24Server)
a. Go to <JBOSS_HOME>/bin/add-user.bat
b. Select option 'b' to start creating an "Application User"

c. Enter your username and password as per instruction
d. Enter your group as “admin”
e. Enter "No" for server-server EJB call
2. Configure the RimImporter Importer.properties

a. Go to irf-rim-importer directory
b. Open "importer.properties" configuration file
c. Update the below section details
i. url in java.naming.provider
ii. username and password in java.naming.security
3. Verify the Configuration and Setup

a. Go to irf-rim-importer directory
b. Run 1.extract-api.bat to extract the API's from configured RIMS or Location
c. Ensure that No Errors on Connection
4. Troubleshoot after the configuration ( Just in case of cross platform machines )

Issue : ActiveMQNotConnectedException[errorType=NOT_CONNECTED message=AMQ119007: Can-
not connect to server(s). Tried with all available servers.]
Solution: Add outbound socket with actual IP and mention the binding name on http-connector
RIMImporter Configuration Files

1. importer.properties
The file has all configuration required to setup the rim importer utility. The properties file contains
the connection details required to establish connection with JBoss and T24Server. Below are some of
the connection parameters
#Connection Credentials
java.naming.security.principal=INPUTT
java.naming.security.credentials=123456
t24.security.context=INPUTT/123456
#Connection Timeout
connection_timeout=7000
Note: By default this file might not be available and will be picked using classpath
resource. In case you differ from the default connection, it can be edited by copying the

above details and creating a file with importer.properties with updated details and save.
The file shall and must be located in the same directory as the batch files.
2. domain.properties
The file is used to categorize application list into domains like party, retail, holdings, etc. The
domains are used to follow the convention of IRISX of URL resource pattern of \ap-
i\version\domain\resource\{property}\subresource\{property}. Ensure that all the applications are
classified into respective domains so that the url formation is done in compliance to the IRISX con-
ventions meeting REST Standards. Another key information that the domains are also used to refer
the right vocabulary file for its resource and properties for validation. Below are some Applications
and Meta information are classified into there respective domains.
party*=IM.DOCUMENT.IMAGE:IM.DOCUMENT.UPLOAD
meta=GETMetadata:T24FieldMetadata
Note: ( * ) asterisks indicates that domain is default to any Application that is not clas-
sified or categorized into its respective domain, in above example "party" is default
domain. The application lists are separated by ( : ) semicolon. The file shall and must be
located in the same directory as the batch files.
3. verb.Properties
The file is used to map the IRIS Legacy command with corresponding IRISX methods. The methods are
used to determine the type of the http operation and name of the operation as per the IRISX con-
ventions. The file shall and must be located in the same directory as the batch files. Below mentioned
are few entries from the verb properties file
GetEntities=get
GetEntity=get
CreateEntity=create
DeleteEntity=delete
GET=get
POST=create
PUT=update
DELETE=delete
4. vobcabulary-<domain>.json
The file is used to catalog all domain specific entries like the domain, resource and property asso-
ciated with a URL or exchange parameters keeping the entire exchange well known and secured. The
vocabulary is part of IRISX conventions, any field(s) and criteria(s) exchange must meet the vocab-
ulary. So owners can either update the vocabulary with artifact (VERSION\ENQUIRY) details or update

the artifact based on the vocabulary. The recommended approach is to first check the vocabulary for
the details and update the artifact if not meeting the expectation the vocabulary shall be updated in
accordance. Below mentioned are few entries from domain specific vocabulary file indicating
resource and property type resources.
{
"key" : "transactionType",
"description" : "transactionType",
"plural" : "transactionTypes",
"insteadOf" : [ ],
"links" : [ ],
"usage" : [ ],
"entryType" : "resource",
"dataType" : "String",
"label" : null,
"generated" : false
}, {
"key" : "transactionTotal",
"description" : "transactionTotal",
"plural" : "transactionTotals",
"insteadOf" : [ ],
"links" : [ ],
"usage" : [ ],
"entryType" : "property",
"dataType" : "String",
"label" : null,
"generated" : false
},

RIMImporter FAQ'S
1. Where to get the latest release pack of RimImporter from?
Click Download to download the latest rimimporter release package from the Temenos Maven Repos-
itory
2. How to configure RimImporter for Remote T24Server?
Refer : How to configure RimImporter to communicate Remote T24 Server?

Appendix
T24 Enquiry
Overview
This section explains how the T24 Enquiry configuration affects the structure of the JSON that is produced.
The Basics
A standard column based Enquiry is rendered as:

Adding Data to the Body
Setting the DISPLAY.BREAK to ONCE create a separate row in the response. Note the row count remains
unchanged.

Adding Data to the Header
Setting the DISPLAY.BREAK to END and SECTION to FOOTER creates a data element in the header section of
the response. Note the row count remains unchanged.

Changing the SECTION to HEADER for accountId removes the added row, and moves the data to the header
section. NB if multiple data elements are present, i.e. no DISPLAY.BREAK is set, the last element will be
added to the header. Note the row count remains unchanged.

Multi-Values as Collections
To create a multi value collection group, the COMMENTS field is used to define the collection label, e.g.
currencies. SINGLE.MULTI must be set to S and remove any width restrictions in LENGTH.MASK. By default,
IRIS will separate multi values base on a SPACE character (the T24 default) - however some ENQUIRYs are

defined to delimit by a pipe character (|). If this is the case, the COMMENTS field is also used to specifiy
the delimieter, hence a multi-value label of currencies used with a pipe delimiter would be specified as cur-
rencies PIPE.
T24 Version
Overview
This section explains how the T24 Version configuration affects the structure of the JSON that is produced.
The Basics
Version Field Usage in Description
API
DESCRIPTION Oper- Used as the name of the operation in the API, should conform to the fol-
ation lowing pattern:
verbCollectionResource
e.g.
GetAccountTransactions
CreateAccountTransfer
TEXT Label to The label to be used in the JSON response
be used in
Note:
JSON
l The text label provided must match with the entries in the vocabulary
l Add new text label in IRIS R18 Vocabulary if it doesn't exists else reuse
closest matching entry as text label

PROMPT.TEX- Group Used to signify that a field is part of a collection (multi-value group) or col-
T labels lection of collections (sub-value group) and to provide the name of the col-
lection.
For example, the fields chargeFor, chargeType and chargeAmount are a

multi value set. Setting the PROMPT.TEXT to charges would result in the fol-
lowing JSON strcuture:
"charges": [ { "chargeFor": "string", "chargeType": "string",

"chargeAmount": "string" } ]
Where a sub-value is set, the group names are needed for both the multi
value group and the sub value group, separated by a space.
For example, a multi-value set of relatedMsg has a sub-value of timeIn-

dicator. Setting the PROMPT.TEXT to relatedMessages for the relatedMsg
field and to relatedMessages timeIndicators for timeIndicator, would result
in the following JSON strcuture:
"relatedMessages": [ { "timeIndicators": [ { "timeIndicator":

"string" } ], "relatedMsg": "string" } ]
NB If PROMPT.TEXT is not set, the fields are NOT noted as a collection

ATTRIBS Data type Alphanumeric
of the
field.
Date
Amount
TOOL.TIP List of Comma delimited list of allowed values

allowed
values

IRIS R18 User Guide PDF

Uploaded by

Copyright:

Available Formats

IRIS R18 User Guide PDF

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

IRIS R18 User Guide PDF

Uploaded by

Copyright:

Available Formats

What are the main components of IRIS R18?

What are the main components of IRIS R18?

What are the prerequisites for developing and testing with IRIS R18?

What are the prerequisites for developing and testing with IRIS R18?

IRIS R18 - User Guide

©2018 Temenos Headquarters SA - All rights reserved.

IRIS R18 - Page 2 of 120

IRIS R18 - Page 3 of 120

l Provider API Layer : hosts REST APIs for T24 modules

IRIS R18 - Page 4 of 120

Open API Spec, fka Swagger https://swagger.io/

IRIS R18 - Page 5 of 120

IRIS R18 - Page 6 of 120

IRIS R18 - Page 7 of 120

IRIS R18 - Page 8 of 120

IRIS R18 - Page 9 of 120

The following steps are required for API development:

IRIS R18 - Page 10 of 120

IRIS R18 - Page 11 of 120

IRIS Workbench Packaging

IRIS Workbench Configurations Steps

IRIS R18 - Page 12 of 120

IRIS R18 - Page 13 of 120

IRIS R18 - Page 14 of 120

IRIS R18 - Page 15 of 120

For Enquiry, the following ID naming convention must be followed:

Examples: PZ.API.ACCOUNTS.BALANCES.1.0.0, PZ.API.ACCOUNTS.TRANSACTIONS.1.0.0

Example: FUNDS.TRANSFER, AC.API.CREATE.TRANSFER.1.0.0

S.No T24 Data Type Swagger Schema Data Type

IRIS R18 - Page 16 of 120

Header fields should not be used in API enquiries.

IRIS R18 - Page 17 of 120

Using the command line

mvn archetype:generate -DarchetypeGroupId=com.temenos.irf -DarchetypeArtifactId=irf-service-con-

IRIS R18 - Page 18 of 120

IRIS R18 - Page 19 of 120

IRIS R18 - Page 20 of 120

You should see a project created with the following structure:

Start the server

IRIS R18 - Page 21 of 120

Using the command line

Click the Next button.

IRIS R18 - Page 22 of 120

IRIS R18 - Page 23 of 120

You should see a project created with the following structure:

IRIS R18 - Page 24 of 120

Make sure that, Service Container is up and running.

Step 2 - Service Definition

Step 3 - Select Artefacts to include

IRIS R18 - Page 25 of 120

IRIS R18 - Page 26 of 120

IRIS R18 - Page 27 of 120

Step 8 - Build The Provider API Project

Run the project as Maven > Install to build the project

Build the Service Project

IRIS R18 - Page 28 of 120

Creating an Inventory using Interaction Framework Workbench

Step 2 - Select Artefacts to include

IRIS R18 - Page 30 of 120