Installation

Installation

Here you can find an example of the structure that you need to have to run the Figaf IRT application.
This is just an example and you need to put your own values if you have another jar version, DB credentials, etc.

There are two ways of how to run/install Figaf IRT on Windows: a bat file or a Windows service.
There are also two ways of how to run/install Figaf IRT on Linux: a sh file or a Linux systemd service.

Commons steps

There are a couple of common steps in all cases:
1. Create a folder for your installation.
2. Put an  irt-*.jar file into this folder. You can download it  here .
3. Put a postgresql JDBC  driver  into the "libs" folder.
4. Create a config/application.yml.
spring:
  profiles: production
irt:
  db:
    type: postgresql
    host: localhost
    port: 5432
    username:  <db username>
    password:   <db password>
    name: irt
server:
  port: 8089
  
#uncomment for getting more detailed logs
#logging:
#  level:
#    com.figaf: DEBUG
5. logs folder will be created automatically.

Windows installation details

1. Windows .bat file

Folder structure:


run-irt.bat:
java -Xmx4096m -Dloader.path="./libs" -Djavax.net.ssl.trustStoreType=Windows-ROOT -jar irt-21033.jar ^
pause
If you just need to run the tool without installation as a windows service, then just execute  "run-irt.bat" file.

2. Windows Service

We recommend using a Windows Service Wrapper:  https://github.com/winsw/winsw.
Folder structure:


1. Download exe file from the GitHub releases page
2. Rename it to figafIrt.exe
3. Create a figafIrt.xml:
<?xml version="1.0" encoding="UTF-8"?>
<service>
    <id>figafIrt</id>
    <name>Figaf IRT</name>
    <description>FIGAF IRT Windows Service</description>
    <executable> <your path to JDK>\bin\java</executable>
    <arguments>-Xmx4096m -Dloader.path="./libs" -Djavax.net.ssl.trustStoreType=Windows-ROOT -jar irt-21033.jar</arguments>
    <logmode>rotate</logmode>
</service>
4. Open the command line.
5. Run " figafIrt.exe install".
6. Run " figafIrt.exe start".

Linux installation

You can run IRT on Linux using .sh file described below in section 2. It will run the tool in the context of your current session.
For full standalone installation as a systemd service do all steps below.

1. User access configuration

The best practice is to create a separate user that will only own the IRT installation folder and will be used in the systemd service descriptor (see section 3 below) to run the tool.
The following commands show how to configure separate user figafToolRunner and group  figafToolManager to restrict access properly  (you should run them as root, login with 'sudo su -'):
  1. # create user figafToolRunner
    useradd -m figafToolRunner
  2. # define password for figafToolRunner
    passwd figafToolRunner
  3. # create group figafToolManager
    groupadd figafToolManager
  4. # add group figafToolManager to the user figafToolRunner
    usermod -GfigafToolManager figafToolRunner
  5. # add group figafToolManager to your user to be able to browse/edit content in the IRT installation folder
    usermod -GfigafToolManager <your user>
  6. # change ownership for all files inside installation folder to the user figafToolRunner
    chown -R figafToolRunner /var/opt/figaf-tool
  7. # change owner's group for all files inside installation folder to the group figafToolManager
    chgrp -R figafToolManager /var/opt/figaf-tool
  8. # grant full access for owner and users that have owner's group
    chmod -R ug+rwx /var/opt/figaf-tool
  9. # remove access for other users
    chmod -R o-rwx /var/opt/figaf-tool
All new files uploaded to the installation folder must have rwx permissions for the owner's group if these files will be used by the tool in runtime

As an alternative, if you already have a user that should be used in the systemd service descriptor (see section 3 below) to run the tool, just grant permissions to IRT installation folder (for example /var/opt/figaf-irt).
You can use the following commands (you should run them as root, login with 'sudo su -'):
  1. # change ownership to specified user
    chown -R <required user> /var/opt/figaf-irt
  2. # grant full access for owner and users that have owner's group
    chmod -R ug+rwx /var/opt/figaf-irt
  3. # remove access for other users
    chmod -R o-rwx /var/opt/figaf-irt
It will change the ownership of the folder and enable full access to the owner and owner's group.


2. Linux .sh file

Create run-irt.sh file in the IRT installation folder (for example  /var/opt/figaf-irt/run-irt.sh ):
java -Xmx4096m -Dloader.path="./libs" -jar irt-21033.jar
Folder structure is the same as in the Windows example.
This file should be open for execution by user who is configured in systemd service descriptor ( see section 3 below). If user is configured in the way described above, grant rwxrwx--- access to it:
  1. chmod ug+rwx run-irt.sh
If you just need to run the tool without installation as a systemd service, then just execute "run-irt.sh" file.

3. Linux systemd service

1. Configure "run-irt.sh" file as it is described in the previous section.
2. Create a service definition under the root access:  /etc/systemd/system/figaf-irt.service.
<user that should run the tool> here is either figafToolRunner from the example in the configuration section or your another user.
[Unit]
Description=Figaf IRT Service
[Service]
User=<user that should run the tool>
#change this to your workspace
WorkingDirectory=/var/opt/figaf-irt 
 
ExecStart=/bin/bash /var/opt/figaf-irt/run-irt.sh
SuccessExitStatus=143
TimeoutStopSec=10
Restart=on-failure
RestartSec=5
[Install]
WantedBy=multi-user.target
3. Enable the service and start it  (you should run them as root, login with 'sudo su -'):
  1. systemctl enable figaf-irt.service
  2. systemctl daemon-reload
  3. systemctl start figaf-irt

After completing any of these configurations, go to  http://localhost:8089/irt and start using the Figaf tool.


You can get a license key by registering at figaf.com/devops
Goto Configuration -> License and insert your license key. 
Next up you can configure your agents. 


    • Related Articles

    • Requirement before installation

      We recommend the following prerequisites Registration for a trial at figaf.com/devops so you will get a license key Download the Figaf runtime jar file at irt.figaf.com/download. Have a server/laptop with 8Gb of memory. Figaf can run on a laptop but ...
    • How to add xslt templates to the tool deployed in SAP BTP

      Migration from PI/PO systems to CPI systems is one of the most important features of the Figaf tool. Here you can find more details about it: https://help.figaf.com/portal/en/kb/configuration/pi-to-cpi It requires XSLT templates placed on a server. ...
    • Deploy to SAP BTP, Cloud Foundry

      This article describes how to deploy the Figaf tool to CPI BTP, Cloud Foundry. Install "cf" command on your computer https://github.com/cloudfoundry/cli/wiki/V7-CLI-Installation-Guide#installers-and-compressed-binaries. Log in to your SAP BTP account ...