Install and configure Axway Decision Insight

Introduction

This section describes how to set up an Axway Decision Insight node and configure Prebuilt Dashboards for SecureTransport on it.

Install Axway Decision Insight

Install the latest DI version by following the Axway Decision Decision Insight documentation.

Configure Axway Decision Insight

Prerequisites

Step Action
1 Before the first start of your instance, choose an application start date, for example, 2017-08-26T00:00:00.000+02:00
2

Update or set the following properties in the platform conf/platform.properties file: 

conf/platform.properties
#update the following properties :
com.systar.titanium.initialPeriodValidTimeEnd=[application-start-date-chosen-above]
com.systar.calcium.totalPartitions=16
com.systar.titanium.memtable.globalMaxSize=4G
com.systar.titanium.memtable.individualMaxSize=256M
 
#add the following properties :
com.systar.krypton.scheduler.collector.defaultComputingRhythm.scalar=5
com.systar.krypton.scheduler.collector.defaultComputingRhythm.unit=minutes
com.systar.krypton.scheduler.collector.defaultComputingLag.scalar=30
com.systar.krypton.scheduler.collector.defaultComputingLag.unit=seconds
3

JVM memory

If the JVM memory XMX is equal or less than 4Gb, you must modify the memory space use by titanium(globalMaxSize).  For example for xmx=4G, in conf/platform.properties the property would be com.systar.titanium.memtable.globalMaxSize=2G

4

Update the JVM memory size in conf/jvm.conf. Please see the sizing guide to use the correct XMX size. Example for 16Gb entering these values in conf/jvm.conf :

conf/jvm.conf
-Xms16G
-Xmx16G
5 You can now start your Decision Insight instance.

Import the application

Once your Decision Insight instance is started, follow these steps.

Step Action
1

Download the Prebuilt Dashboards application package from the Axway marketplace http://marketplace.axway.com.

2 Unzip the downloaded file.
3

In CONFIGURATION > Administration > Application – or at the first screen if a new instance of DI is started – click the Import button (1)


4

Import (4) the application .appx file (1) and the properties.xml (2) files, using the password 'admin' for import (3).

5

At this step, set the application import date to the application start date chosen above:

Wait

Once you've updated the application start-date properties, go and check the current activity on your node.

Step Action
1 On the main menu, click Security &Monitoring. On the left menu, click Current Activity. From this tab, you can monitor the node usage on your server.
2

Wait until the CPU usage is down to a few percents.

This allows time for all pre-computings to bootstrap, and for computing to become LIVE.

Set up the QLT server security (connexion with SecureTransport Monitoring)

To establish a connexion with SecureTransport monitoring, create the key-store and trust-store for TLS communication with the SecureTransport Monitoring.

The connection is not a mutual authentication. Decision Insight keystore and truststore must be in PKCS12 or JKS format. For more information, see  How to generate keys and certificates files for TLS mutual authentication?  in the Axway Decision Insight documentation. 

 Check your connector information

  1. On the main menu, click Data Integration. On the left menu, click Connectors. In the In space dropdown, select 04-ST- Integration.

  2. Select qltSslContextParameters and check that the connector information below is present.

SSL connector parameters
Name qltSslContextParameters
Class name com.systar.aluminium.engine.impl.util.SSLContextParameters

keyManagers class: org.apache.camel.util.jsee.keyManagersParameters


keyPassword {{key_password}}

keyStore Class: org.apache.camel.util.jsee.KeyStoreParameters


password {{keyStore_password}}


resource {{keyStore_filePath}}
cipherSuitesList TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384

trustManagers class: org.apache.camel.jsee.TrustManagersParameters


keyStore Class: org.apache.camel.util.jsee.KeyStoreParameters


password {{trustStore_password}}


resource {{trustStore_filePath}}
secureSocketProtocolsList TLSv1.2



Add the correct keystore and trust store information

Step Action
1 On the left menu, click Properties.
2 In the In space dropdown, select 04-ST-Integration .
3

Create the correct file paths and passwords properties of the key-store and the trust-store for the Decision Insight QLT Server:

key_password – ****************

keyStore_filePath /path-to-DI-install/DecisionInsight/security/keyStore.jks

keyStore_password – ****************

trustStore_filePath/path-to-DI-install/DecisionInsight/security/trustStore.jks

trustStore_password – ****************

4 On the left menu, click Routes.
5 In the In space dropdown, select 04-ST-Integration .
6 Select the 01_AbsorbTrackedObject route.
7

This route must use a secure QLT URI.

The URI of the route must be <from uri="qlts:0.0.0.0:1305?sslContextParameters=#qltSslContextParameters"/>

where #qltSslContextParameters is the name of the SSL connector.

If you estimate that your network is secure enough and you estimate that you can use an non-secure connection, you can uncomment the uri (line 15) <from uri=" qlt:0.0.0.0:1305 "/>  and comment the secure uri (line 14)

<!-- <from uri="qlts:0.0.0.0:1305?sslContextParameters=#qltSslContextParameters"/> -->

Change the encryption key for the SecureTransport server

To assure interactions with SecureTransport, a list of connections is stored In DI. For more information, see Configure the SecureTransport server.

This list contains addresses, login and password...

For security reasons, the password is encrypted with an encryption key.

Set up a new encryption key

Step Action
1 In Decision Insight, on the main menu, click  Data Integration. On the left menu, click  Properties.
2 In the In space dropdown, select 07-ST-Configuration .
3

Verify that the flag to automatically encode passwords is set at True

Change the password. (by default it is set to password )

ST_SERVER_PASSWORD_ENCRYPTED    -   True

ST_SERVER_PASSWORD_ENCRYPTION_KEY - ****************


Step Action
1 In Decision Insight, on the main menu, click  Data Integration. On the left menu, click  Properties.
2 In the In space dropdown, select 04-ST-Integration .
3

Change the password. (by default it is set to password )

ST_SERVER_PASSWORD_ENCRYPTION_KEY - ****************




1.  If you update the encryption key, you must restart the following routes:

Space Route
04-ST-Integration 02_ResubmitTransfer
07-ST-Configuration 08_getBusinessUnitFromST
13_EncryptStPasswords

2.  If you update the encryption key , you must re-add all SecureTransport server passwords to refresh the encryption with the new encryption key. For more information, see Configure the SecureTransport server.

SecureTransport SSO connection

If SecureTransport uses a SSO authentication, you need to change the property BYPASS_ST_SSO .

Step Action
1 In Decision Insight, on the main menu, click  Data Integration. On the left menu, click  Properties.
2 In the In space dropdown, select 04-ST-Integration .
3

Set to True the value of the property BYPASS_ST_SSO . (by default it is set to false )

4 In the In space dropdown, select 07-ST-Configuration .
5

Set to True the value of the property BYPASS_ST_SSO . (by default it is set to false )


If you update the  BYPASS_ST_SSO property, you must restart the following routes:

Space Route
04-ST-Integration 02_ResubmitTransfer
07-ST-Configuration 08_getBusinessUnitFromST

Set up new configuration files for punctuality check and alert

Step Action
1 In Decision Insight, on the main menu, click  Data Integration. On the left menu, click  Routes.
2 In the In space dropdown, select 04-ST-Initializer .
3

Start the route 02_CreateAlertingDefaultConfigFiles to create configuration files for the punctuality check and alert. 

This route will create files : dtPunctualityCheck.txt and dtPunctualityAlert.txt that contain decision table configuration for the punctuality check and alerting logic respectively.


Note

To be able to use punctuality analytics and alerting, don't forget to configure those files. For information, see Configure punctuality check on file arrival for a specific account and Punctuality check alert

Start routes

If not started.

Step Action
1 In Decision Insight, on the main menu, click  Data Integration. On the left menu, click  Routes.
2 In the In space dropdown, select 04-ST-Integration .
3

Start the 01_AbsorbTrackedObject route to absorb the SecureTransport incoming file transfer logs.

4

This route is configured to be automatically started with the Decision Insight node. If stopped, start the 02_ResubmitTransfer route to enable the resubmit transfer button.

Decision Insight configuration

To be able to call the "resubmit transfer" service exposed by the SecureTransport instance, don't forget to configure the ST instance access In Decision Insight. For information, see Configure the SecureTransport server.

5 In the In space dropdown, select  07-ST-Configuration .
7

Start the 08_getBusinessUnitFromST route to configure the application retrieving Business Units from SecureTransport.

8

Start the 13_EncryptStPasswords route to automatically encrypt password setting by a web service of the mapping : 04_UpdateSTServer.

SecureTransport configuration

On SecureTransport, don't forget to Setup the Axway Sentinel/Decision Insight Events. For more information, see, Configure how SecureTransport sends events to Decision Insight.

Configure automated data purge

It is recommended to activate automated data purge to remove old data when they are no longer used.

By default purge is configured to remove data after a 3 months retention period. 

In the context of the Prebuilt dashboards for example, setting a retention period for transfers and flow events to 1 month will allow you to release disk space from old data on a regular basis.

In Decision Insight,  two types of functional categories of entities are used to store data: Transaction entities and Stable entities.
For this Embedded Analytics application:

Transaction entities list is: FileTransfer and FlowEvent

Stable entities list is: all other entities.

For information about how to purge data, see Purge data in the Axway Decision Decision Insight documentation.

Upgrade the Prebuilt analytics


Consider the following elements before performing an upgrade:

  • Before doing an application upgrade, please be aware that any custom application items you may have added to your application, for example, custom data integration routes and mappings, resources, model entities and attributes, dashboards, indicators, etc., are not guaranteed to be kept following the application upgrade. Therefore, it is not recommended to upgrade an application that has already been customized to fit a specific purpose.
  • For extra caution, we highly recommend you create a manual checkpoint using a meaningful comment as described in Checkpoint in the Axway Decision Decision Insight documentation.


Step Action
1

Note

This step is to fulfill only when the punctuality check is configured within your Decision Insight's instance. If not, skip to step 2.


This release is no more using the resource decisiontable_filecheck stored in Data Integration > Properties > In space 04-ST-Integration. In your current installation, backup the resource content into your local desktop for later user.



3

Download and import the latest version of Prebuilt analytics from Axway's marketplace http://marketplace.axway.com and if needed the minimal version for Decision Insight by following the Axway Decision Decision Insight documentation.

Once your upgrade is done, the decisiontable_filecheck resource above will no longer exist and replaced by a text file that will be deposited into Decision Insight's server (See step 4).

4

In your upgraded instance, Start the route 02_CreateAlertingDefaultConfigFiles to create configuration files for the punctuality check and alert. 

This route will create files : dtPunctualityCheck.txt and dtPunctualityAlert.txt that contain decision table configuration for the punctuality check and alerting logic respectively.


Decision Insight configuration

Not fulfilling this step will issue an error in the absorption route. 

5

In your Decision Insight's installation server, go to directory "<DI INSTALLATION FOLDER>\Var", edit file dtPunctualityCheck.txt and replace its content with the content saved from the resource decisiontable_filecheck in Step 1.


Note

To be able to use the punctuality alerting feature, don't forget to configure the file dtPunctualityAlert.txt as well. For information, see Punctuality check alert.





Related Links