Externalising Configurable Properties
Traditionally, if you need to change any application configuration in a cloud environment, you must rebuild the image and deploy it again. To overcome this, you can externalise the application configuration file and pass it as an argument or option while deploying Transact Explorer or TB Server.
Externalising Configuration Properties in Transact Explorer UI
To externalise the property attribute through the system environmental variables, follow the standard syntax below.
Syntax -Dcom.temenos.te.ui.X = propertyValue
Where,
X = configuration property from appconfig.json file.
Example -Dcom.temenos.te.ui.showScreenInfo=false
Click the below button to know about the product-specific UI property attributes, their default values, and environment variables.
Product-specific UI Properties
The below table lists the property attributes, their default values, and environment variables:
Path transact-explorer-wa.war\assets\config\appconfig.json
| Property Attribute | Description | Default Value | Environment variable for Individual attribute |
|---|---|---|---|
| tbServerUrl | Indicates the tb-server URL to which the data is sent and received from. | ${this.window.location.protocol}//${this.window.location.hostname}:${this.window.location.port}/tb-server | com.temenos.te.ui.tbServerUrl |
| commandLineEnable | Indicates whether the command line has to be enabled. | true | com.temenos.te.ui.commandLineEnable |
| showServerDate | Indicates whether the date calendar should be defaulted to server date or system date. | true | com.temenos.te.ui.showServerDate |
| quickSearchRequired | Indicates whether the quick UI search is required for fastpath enquiries only for the multifonds team. | false | com.temenos.te.ui.quickSearchRequired |
| performanceMonitoring | Indicates whether the performance of the application has to be monitored while launching the PERFORMANCE.DASHBOARD command. | false | com.temenos.te.ui.performanceMonitoring |
| copyright | Indicates the copyright message to be shown in the application. | 'Copyright © 2012-2023 Temenos Headquarters SA' | com.temenos.te.ui.copyright |
| showScreenInfo | Indicates whether the date calendar should be defaulted to the server date or system date. | true | com.temenos.te.ui.showScreenInfo |
| notificationFadeTimeInSec | Indicates the time limit for the notification to be shown. | 4 | com.temenos.te.ui.notificationFadeTimeInSec |
| commandLineMaxTabs | Indicates the number of applications or enquiries to be opened on the screen. | 15 | com.temenos.te.ui.commandLineMaxTabs |
| commandLineCaseConv | Indicates to convert the command given from small case to upper case if the value is set as 'UPPER'. | NONE | com.temenos.te.ui.commandLineCaseConv |
| singlePageView | Indicates whether the rendered screen needs to be displayed within a single page. | false | com.temenos.te.ui.singlePageView |
| accessibility | Indicates whether to focus on the fields by default. | false | com.temenos.te.ui.accessibility |
| showUserCompanyInCLI | Indicates whether the user’s company has to be shown in command cli. | false | com.temenos.te.ui.showUserCompanyInCLI |
| querySorting | Indicates whether the enquiry records needs to be sorted while clicking on the header record. | true | com.temenos.te.ui.querySorting |
| showAuditAndReservedTabs | Indicates whether to show Audit and Reserved tabs as separate tabs. | true | com.temenos.te.ui.showAuditAndReservedTabs |
| classicLabelView | Indicates whether the screen has to be rendered in classic view. | false | com.temenos.te.ui.classicLabelView |
| product.name | Indicates the name of the product. | transact | com.temenos.te.ui.product.name |
| product.logoImageUrl | Indicates the logo of the product in the About dialog box. | assets/images/logo_icon_circle_primary.svg | com.temenos.te.ui. product.logoImageUrl |
| product.menuImageUrl | Indicates the image to be shown in the left menu rail. | assets/images/logo_icon_circle_secondary.svg | com.temenos.te.ui.product.menuImageUrl |
| product.logoTextImageUrl | Indicates the image next to the logo in the login page. | assets/images/logo_text.svg | com.temenos.te.ui.product.logoTextImageUrl |
| product.loginPageImageUrl | Indicates the background image in the login page. | - | com.temenos.te.ui.product.loginPageImageUrl |
| product.loginPageLogoImageUrl | Indicates the logo on the login page. | assets/images/logo_icon_circle_primary.svg | com.temenos.te.ui.product.loginPageLogoImageUrl |
| product.landingPageImageUrl | Indicates the background image on the landing page. | assets/images/logo_icon_circle_primary.svg | com.temenos.te.ui.product.landingPageImageUrl |
| product.browserTitle | Indicates the About menu title. | Transact Explorer | com.temenos.te.ui.product.browserTitle |
| product.loginPageTitle | Indicates the login page title towards the right half of the login screen. | Welcome to (text from browserTitle Property). | com.temenos.te.ui.product.loginPageTitle |
| product.loginPageMessage | Indicates the login page message below the login page title. | Technology for Better Banking | com.temenos.te.ui.product.loginPageMessage |
| product.about | Indicates the text below the Transact version in the About menu. | - | com.temenos.te.ui.product.about |
| product.logoDisplayInExportedPdf | Indicates the logo to be displayed in the PDFs downloaded through the Transact Explorer application. | assets/images/pdf_logo.png | com.temenos.te.ui.product.logoDisplayInExportedPdf |
Externalising Configuration Properties in TB Server API
To externalise the property attribute through the system environmental variable, follow the standard syntax given below.
Syntax -Dcom.temenos.te.api.<propertyAttribute> = propertyValue
Example -Dcom.temenos.te.api.helpTextLocation=../../HELP.TEXT/HelpText/
Click the below button to know about the product-specific API property attributes, their default values, and environment variables.
Product-specific API Properties
The below table lists the property attributes, their default values, and environment variables:
Path tb-server.war\WEB-INF\classes\config.properties
| Property Attribute | Description | Sample Value | Environment variable for individual attribute |
|---|---|---|---|
|
helpTextLocation
|
Indicates the help text location | ../../HELP.TEXT/HelpText/ | com.temenos.te.api.helpTextLocation |
| enableCustomScript | Indicates whether to enable custom python scripts | false | com.temenos.te.api.enableCustomScript |
|
userExternalisation
|
Indicates to work with an external user instead of creating a user in Transact | false | com.temenos.te.api.userExternalisation |
|
dbHost
|
Indicates the database hostname or ip address | <IP Address> | com.temenos.te.api.dbHost |
|
dbPort
|
Indicates the database port | <Port> | com.temenos.te.api.dbPort |
|
dbSid
|
Indicates the database SID | <SID> | com.temenos.te.api.dbSid |
|
dbServiceName
|
Indicates the database service name | <Service Name> | com.temenos.te.api.dbServiceName |
|
dbUserName
|
Indicates the database username | <Base64 Encrypted User name> | com.temenos.te.api.dbUserName |
|
dbPassword
|
Indicates the database password | <Base64 Encrypted Password> | com.temenos.te.api.dbPassword |
|
dbFileUploadTable
|
Indicates the table name used for file upload | <Table name> | com.temenos.te.api.dbFileUploadTable |
|
dbFileUploadColRecId
|
Indicates that the dbFileUploadTable property has a valid table name and maps the first column name | <Column name> | com.temenos.te.api.dbFileUploadColRecId |
|
dbFileUploadColFileName
|
Indicates that the dbFileUploadTable property has a valid table name and maps the second column name | <Column name> | com.temenos.te.api.dbFileUploadColFileName |
|
dbFileUploadColFileData
|
Indicates that the dbFileUploadTable property has a valid table name and maps the third column name | <Column name> | com.temenos.te.api.dbFileUploadColFileData |
|
jasperReportsLocation
|
Indicates the Jasper reports storage path | - | com.temenos.te.api.jasperReportsLocation |
|
fileUploadPath
|
Indicates the path to which the file should be uploaded. | Any filepath | C:\temp\doc |
Removing setup.json, Merging, and Externalising Properties into appconfig.json
To externalise the property attribute through the system environmental variables, follow the standard syntax given below.
Syntax -Dcom.temenos.te.ui.X = propertyValue
Where,
- X - configuration property from appconfig.json file.
- propertyValue - value of a particular property to be configured.
Example -Dcom.temenos.te.ui.showScreenInfo=false
The following property attributes come under the external application:
Update the properties in the below files:
- UI - transact-explorer-wa.war\assets\config\appconfig.json
- Tbserver - tb-server.war\WEB-INF\classes\config.properties
- The externalApps key indicates the external products added to the Transact Explorer application.
- externalApps.papUi- papUi indicates any name given for the provided external application.
- Maintain the default values column in the below sequence
- material-icon of the product
- label of the product
- type of the product to be launched (URL or command)
- resource path of the product that depends on the above provided type (URL or command).
- default values entered are separated by comma.
Click the below button to know about the product-specific UI property attributes, their default values, and environment variables.
Product-specifc UI Properties
Path transact-explorer-wa.war\assets\config\appconfig.json
| Property Attribute | Description | Default Value | Environment variable for Individual attribute |
|---|---|---|---|
| globalSettings.activeTheme.default | Indicates the default theme of Transact Explorer. | theme-magic-blue | com.temenos.te.ui.globalSettings.activeTheme.default |
| globalSettings.activeTheme.options |
Indicates the options to be listed for the user to change the theme. Options are given as comma-separated values as shown in the default values column. |
theme-magic-blue,theme-nature-green, theme-space-black,theme-brinjal-purple |
com.temenos.te.ui.globalSettings.activeTheme.options |
| globalSettings.fullScreen.default | Indicates the default screen size of Transact Explorer. | True | com.temenos.te.ui.globalSettings.fullScreen.default |
| globalSettings.compactMode.default | Indicates the default screen mode of Transact Explorer. | True | com.temenos.te.ui.globalSettings.compactMode.default |
| globalSettings.tabsLayout.default |
Indicates whether the application or version screens should be displayed in tabs or accordions. Default value is not set. |
- | com.temenos.te.ui.globalSettings.tabsLayout.default |
| globalSettings.tabsLayout.options |
Indicates the options such as tabs or accordions. Options are given as comma-separated values as shown in the default values column. |
tabs,accordions | com.temenos.te.ui.globalSettings.tabsLayout.options |
| globalSettings.tabbedScreenLayout.default |
Indicates whether the tabbed screens should be displayed in vertical or horizontal. Default value is not set. |
- | com.temenos.te.ui.globalSettings.tabbedScreenLayout.default |
| globalSettings.tabbedScreenLayout.options |
Indicates the options such as vertical or horizontal. Options are given as comma-separated values as shown in the default values column. |
vertical,horizontal | com.temenos.te.ui.globalSettings.tabbedScreenLayout.options |
| globalSettings.maxColumnsInputScreen.default |
Determines the number of fields to be listed perrows in create or edit mode. Default value is set to 0, which indicates standard layout. |
0 | com.temenos.te.ui.globalSettings.maxColumnsInputScreen.default |
| globalSettings.maxColumnsInputScreen.options |
Indicates the options for the user to select the number of fields per row. Options are given as comma-separated values as shown in the default values column. |
0,1,2,3,4,6,12 | com.temenos.te.ui.globalSettings.maxColumnsInputScreen.options |
| globalSettings.maxColumnsViewScreen.default |
Determines the number of fields to be listed per row in the view mode. Default value is set to 0, which indicates standard layout. |
0 | com.temenos.te.ui.globalSettings.maxColumnsViewScreen.default |
| globalSettings.maxColumnsViewScreen.options |
Indicates the options for the user to select the number of fields per row. Options are given as comma-separated values as shown in the default values column. |
0,1,2,3,4,6,12 | com.temenos.te.ui.globalSettings.maxColumnsViewScreen.options |
| globalSettings.enquiryLayout.default |
Indicates whether the enquiry screens should be displayed in the table or list view. Default value is not set. |
- | com.temenos.te.ui.globalSettings.enquiryLayout.default |
| globalSettings.enquiryLayout.options |
Indicates the options such as table or list. Options are given as comma-separated values as shown in the default values column. |
table,list | com.temenos.te.ui.globalSettings.enquiryLayout.options |
| globalSettings.textDirection.default |
Indicates whether the direction of text should be right to left (RTL) or left to right (LTR). Default value is not set. |
- | com.temenos.te.ui.globalSettings.textDirection.default |
| globalSettings.textDirection.options |
Indicates the text direction from the USER application. Options are given as comma-separated values as shown in the default values column. SYSTEM is the default value. |
SYSTEM, LTR, and RTL | com.temenos.te.ui.globalSettings.textDirection.options |
| globalSettings.fontSize.default |
Indicates whether the font size should be small, medium, or large. Default value is not set. |
- | com.temenos.te.ui.globalSettings.fontSize.default |
| globalSettings.fontSize.options | Options are given as comma-separated values as shown in the default values column. | small,medium,large | com.temenos.te.ui.globalSettings.fontSize.options |
| globalSettings.dateFormat.default |
Determines the format of date in Transact Explorer. Default value is not set. |
- | com.temenos.te.ui.globalSettings.dateFormat.default |
| globalSettings.dateFormat.options |
Determines the format of date in Transact Explorer. Options are given as comma-separated values as shown in the default values column. |
SYSTEM,DD/MM/YYYY,YYYY/MM/DD,YYYYMMDD,MM/DD/YYYY,DD.MM.YYYY,DD MMM YYYY | com.temenos.te.ui.globalSettings.dateFormat.options |
| globalSettings.fieldAutocomplete.default |
Determines whether the browser values needs to be listed when focusing on any field. Default value is not set. Allowed values are True and False. |
- | com.temenos.te.ui.globalSettings.fieldAutocomplete.default |
| globalSettings.enrichmentOnly.default |
Indicates the dropdown field to show only the enrichment without description. Default value is not set. Allowed values are True and False. |
- | com.temenos.te.ui.globalSettings.enrichmentOnly.default |
| globalSettings.clearFieldValue.default |
Determines whether the user needs to have a clear option in each and every field in Transact Explorer. Default value is not set. Allowed values are True and False. |
- | com.temenos.te.ui.globalSettings.clearFieldValue.default |
| globalSettings.zebraStripedTable.default |
Indicates whether the enquiry results should be shown in zebra striped lines (True) or normal table (False). Default value is not set. Allowed values are True and False. |
- | com.temenos.te.ui.globalSettings.zebraStripedTable.default |
| globalSettings.exclude |
Indicates whether to hide any of the property from settings page. Default values are property keys as highlighted in the property column. |
textDirection,dateFormat,fontSize,notificationAutoHide | com.temenos.te.ui.globalSettings.exclude |
| externalApps.papui |
icon - policy, label – PAPUI, url – type, resourcePath - /papui |
policy,PAPUI,url,/papui | com.temenos.te.ui.externalApps.papui |
| externalApps. webCompDocumentation |
icon - description, label – Web Component, url – command, resourcePath - TE.WEB.COMP.DOCUMENTATION |
description,Web Component,command,TE.WEB.COMP.DOCUMENTATION | com.temenos.te.ui.externalApps. webCompDocumentation |
| externalApps.transactHelpPage |
icon - help_outline, label – Help, url – command, resourcePath - TE.HELP.PAGE |
help_outline,Help,command,TE.HELP.PAGE | com.temenos.te.ui.externalApps.transactHelpPage |
Externalising web.xml in transact-explorer-wa UI war
Externalising the web.xml file includes externalisation of servlets, filters, and context parameters. You can enable or disable SSO through the system properties.
To externalise the property through the system environmental variable, follow the standard syntax given below,
Syntax -Dcom.temenos.te.ui.<propertyName>=propertyValue
Example -Dcom.temenos.te.ui. enableOpenIdConnectFilter=Y
Click the below button to know about the SSO UI property attributes, their default values, and environment variables.
SSO UI Properties
The below table lists the property attributes, their default values, and environment variables:
Path tb-server.war\WEB-INF\classes\config.properties
| Property Name | Description | Allowed values | Default Value | Environment variable for individual attribute |
|---|---|---|---|---|
| enableOpenIdConnectFilter | Indicates whether to enable (Y) or disable (N) spring filter for SSO using OIDC. | Y / N | N | com.temenos.te.ui.enableOpenIdConnectFilter |
| enableGenericAuthenticationFilter | Indicates whether to setup SSO configuration using SAML protocol. | Y/N | N | com.temenos.te.ui.enableGenericAuthenticationFilter |
Click the below button to know about the Security API Property attributes, their default values, and environment variables.
Security API Properties
The below table lists the property attributes, default and allowed values, and environment variables:
|
Property Name |
Description |
Allowed values |
Default Value |
Environment variable for individual attribute |
|---|---|---|---|---|
|
HSTSMaxAgeInSeconds
|
Indicates the maximum age for HSTS header (in seconds) in the response header. HSTSMaxAgeInSeconds is set only if it is a secure request. |
Between 0 and 31536000 |
86400 |
com.temenos.te.ui.HSTSMaxAgeInSeconds |
|
HSTSParameterValue
|
Indicates the parameter for the HSTS header to activate HSTS for sub-domains or enable preloading.HSTSParameterValue is set only if it is a secure request. |
includeSubDomains / preload / none |
none |
com.temenos.te.ui.HSTSParameterValue |
|
CrossDomainPolicyValue
|
Indicates the parameter for the cross-domain policy header value. |
master-only / none |
none |
com.temenos.te.ui.CrossDomainPolicyValue |
|
ContentSecurityPolicyValue
|
Indicates the parameter for the content security policy header value. |
null / "default-src 'self'; img-src 'self'; style-src 'self' 'unsafe-inline'; font-src 'self'; script-src 'self' 'unsafe-inline' 'unsafe-eval'; connect-src 'self';" Can be configured as required. |
null |
com.temenos.te.ui.ContentSecurityPolicyValue |
Externalising web.xml in tb-server API
Externalising the web.xml file includes externalization of servlets, filters, and context parameters. You can enable or disable SSO through the system properties.
SSO API Properties
Path tb-server.war\WEB-INF\classes\config.properties
To enable JWT token filter, use the below system option.
-Dcom.temenos.te.api.enableJWTtokenFilter=true
In this topic