Getting started guide for an IRIS data service
Using Temenos Sandbox and Developer package you can create your new APIs and publish them on the MarketPlace web site. This document will guide you step-by-step to create an API in 30 minutes.
IRIS is an open source GitHub project and provides Interaction, Reporting and Information Services. This project is developed and maintained by Temenos.
To build an IRIS data service, you need to meet the following requirements:
- Knowledge of Web technologies
- Knowledge of OData & RESTful services
- Temenos MarketPlace Products
- Temenos Sandbox
- Member SDKs and design tools
- Microsoft Windows operating system (Windows 7 or higher) & Internet connection
Setting up the Design Studio environment
- After downloading Member SDKs and Design Tools, extract files from the DesignStudioT24-2015.9.2.zip file to a directory on your computer. Make sure your path does not contain any spaces.
- Copy the downloaded t24-binaries_2015-12-10_21-53-CET_8bb35d0a847b36db2bf7cf11c0e1abe6cee970ee.zip file to the DesignStudio installation folder. You do not need to extract files from the T24 binaries compressed file – Design Studio will do this automatically for you after you start it for the first time.
Creating an IRIS template project
You need to complete a few steps to create an IRIS data service and publish your new API.
- Go to the Design Studio folder and double click DesignStudioT24.exe.
- Specify the location for your default workspace. You can create this workspace anywhere.
- After you have started Design Studio for the first time, a message dialog is displayed with the information that new binary files have been detected in Design Studio installation directory. Click Yes to load the new T24 binaries into your new instance of Design Studio.
- In the top menu, click File → New Project. A new wizard opens.
- Expand Design Studio, select Design Studio Template Projects and click Next.
- From the drop-down list, select IRIS Data Service Project.
- Provide the project name if you want; otherwise keep it default.
Note: Do not change other attributes in the template project – these are only for advanced users.
- Click Finish. A few projects are created in your workspace.
- Delete the following two projects from your workspace – they are for different purposes.
- Additionally, delete or comment out the embedded-server-tafj reference from the pom.xml file in the *-iris-parent project.
Result: You have the following projects in your workspace.
You have created an IRIS template project. This is a standard Maven project and it follows all Maven standards.
Building an IRIS project
To build this project:
- Expand the *-iris-parent project.
- Right-click the Package.launch file, and then click Run As > Package.
- After the build finishes, the following success message is displayed in the console window.
Establishing the connection with Temenos Sandbox
To establish the connection with Temenos Sandbox:
- Expand the *-tafj-server project and double click the server.properties file.
- Enter the user name, password, host name and port number. You can get these details from your Temenos Sandbox.
- Start the server: click the Servers tab, right-click T24 Connection and click Start (or Restart).
Importing enquiries or versions
To import an enquiry from T24:
1. In the top menu, click File → Import….
2. Expand Design Studio, click Import T24 Enquiries and then click Next.
3. Select the server and click Next. It takes a few seconds to connect Design Studio with T24 and fetch all the chosen enquiries.
4. Select the enquiry you want to add to your project.
5. For this project, select the CURRENCY-LIST enquiry and click Next.
6. Save this enquiry in the enquiry folder of the *-models project. Click Finish.
7. A success message is displayed. Click OK to close this message.
The enquiry is in your *-models project.
Creating a RIM file
To create a RIM file:
1. Right-click the imported enquiry.
2. In the context menu, click Design Studio and then click Generate Code.
Result: The enqCURRENCY-LIST.rim file has been generated in the following directory:
Adding the enquiry to the service document
The last step in creating your API is to add the RIM definition to the service document. The service document is in the following directory:
1. Double click the rim file with your project name, for example MarketPlaceDemo.rim. The contents of the file are displayed in the right pane.
Add the newly created RIM reference in the Service Document resource. Make sure you follow the correct sequence: Domain Name → RIM Name → Resource Name (Collection)
Verifying the new link in the service document
Make sure that you are able to navigate from the Service Document to the newly added rim file. To test the link, control-click the new resource definition. You should be able to go the enqCurrencyLists resource.
Rebuilding your data service
Follow the above steps to rebuild your new data service: Building an IRIS Project.
|Design Studio||Design Studio (DS) is an Integrated Development Environment that enables business and IT professionals to design elements for T24 Model Bank. The application provides its own “designers” using editors and text-based tools for developing elements called models.|
|Enquiry||An enquiry is used to fetch data from T24 in read-only mode.|
|IRIS||A runtime framework for Interaction, Reporting & Information Services.|
|Model||A model is a physical representation of a T24 resource, for example an enquiry, version or application.|
|RIM||RIM stands for Resource Interaction Model. A RIM file declares a set of resources that are made available as part of an interaction data service.|
|Resource||In REST, everything is a resource and is identified by a unique identifier.|
|Service document||Main entry point of IRIS data service.|
|Version or Screen||Version and Screen are the same thing in IRIS data services.|