AMT Application Config File

The amt-config.yaml file is used to configure AMT applications. Each key and setting found in this file is described below.

Base Configuration

Secure Storages

The settings for Secure Storage providers, which relate to the database settings further down.
This setting is replaces the Secure Storage section which only allowed for a single secure storage provider.

Authentication

In the sample config file, the client name is "rest" – this can be named anything, as long as it is unique when defining multiple clients.

Runtime Configuration

Database Configuration

The Database configuration section. First, the database kind needs to be defined. Use 'applicationDatabase' for applications. See the Control Center Config File to configure the System and Transaction databases.

All of the database settings can be stored in a key vault. A dollar sign $ prefixing a value denotes the use of a key stored in a key vault.

Clusters

The Cluster and Remote Cluster sections. A cluster configuration allows the bundling or separation of applications, and controllers. A cluster consists of a single node or multiple nodes (optional), including remote cluster nodes. A remote cluster allows for starting transactions on a remote application. Remote cluster nodes only require host and gRPCPort settings.

COBOL Configuration

The COBOL Configuration section, cobolConfig, for AMT applications.

Sample File

---
####################################################################################################
#
# APPLICATION CONFIGURATION
# General application related configuration items.
#
####################################################################################################
version: v1
name: AMT GO Java Application Configuration Template
environment: DEV
basePath: "C:/Amt"
applicationName: smoketest
applicationPackage: com.avanade.ltcoe.smoketest
remoteApplicationPackages: # Optional, all remote packages need to be part of the allinone-jar
  XX: com.avanade.ltcoe.package1
  YY: com.avanade.ltcoe.package2
####################################################################################################
#
# SECURE STORAGE SECTION
# Settings related to the secure storage provider. This ties into the database settings later on.
#
####################################################################################################
secureStorages:
  # Secure Storage can be configured in a couple of different ways.
  # See the Secure Storage Wiki page for more information.
  - id: local-vault
    vaultType: Simple
    vaultConfiguration:
      authenticationType: rest # or sdk 
      vaultFilePath: "C:/AMT/smoketest-secrets.txt"
####################################################################################################
#
# AUTHENTICATION CONFIGURATION SECTION
# Settings related to the external authentication provider.
# Defaults are added for a simple KeyCloak setup, if another authentication provider is required,
# then you need to add the correct issuerURL & clientID.
#
####################################################################################################
authentication:
  type: OIDC
  clients:
    rest:
      settings:
        issuerURL: http://localhost:8080/realms/AMTRealm
        clientID: AMT
        claimUserName: preferred_username
        claimUserRoles: amt # "oauth". When using OAuth, claimRolesKey and rolemapping needs to be configured
          #claimRolesKey: # Key to roles in OAth token. For Azure e.g. it is "groups",
          # where for keycloak it is "resource_access;AMT;roles", it is 3 layers deep, using ; separates the keys.
      #roleMapping:
      #role1: amt_role1
####################################################################################################
#
# SERVER CERTIFICATE CONFIGURATION
# Paths to the server key and certificate (file or classpath resource).
# If not set, the default key and certificate will be loaded from the classpath (/certs/server1.key and /certs/server1.pem)
#
####################################################################################################
serverCertificate:
  # Can be a file path or classpath resource.
####################################################################################################
#
# RUNTIME CONFIGURATION SECTION
# Settings related to the runtime behavior of the application.
#
####################################################################################################
runtime:
  settings:
    customSignEncoding: ""
    cacheWorkingStorage: false
    storeCompInASCII: true
    translationFileEBCDIC: "C:/Amt/translationFileEBCDIC"
    useAmtCursor: false
    clientTimeout: 3000 # milliseconds
    transactionTimeout: 3000 # milliseconds
    expiredFileTaskTimeout: 60 # seconds
    grpcIdleTimeout: 60 # seconds
    fileMessageSize: 2 # MB
    gdgMaxCycleNumber: 9999
    #urimap field is an optional, it required when the CICS statement uses URIMAP
    #urimap: "urimap.yaml"
    # Optional, set specific path to python interpreter if it's not the default version on the OS.
    # Applies only to the application runtime configuration.
    #pythonInterpreter: "C:/Path/To/Python/Executable.exe"
    # Optional, set a date to be used for testing purposes.
    # Application uses this date instead of the system date. Format is yyyyMMdd
    #useDate: 20250123
    #addAppNameToForm: true
    # formInputsUpperCase is optional. If set to true, all form input data will be made upper case at runtime
    # formInputsUpperCase: true
    # jclConverterPath: /home/user/tools/JclConverterConsole.dll
    # jclOutputPath : /home/user/python/converted_jcl
####################################################################################################
#
# SYSTEM DATABASE CONFIGURATION SECTION FOR POSTGRESQL
# Settings related to the system database. Values can be keys for the configured key vault
# from the Secure Storage section up above.
#
####################################################################################################
systemDatabase:
  type: POSTGRES
  settings:
    name: amtsystem
    schema: amtsystem
    username: amtsystem
    password: amtsystem
    driverClassname: org.postgresql.Driver
    url: jdbc:postgresql://localhost/amtsystem
    hibernateDialect: org.hibernate.dialect.PostgreSQLDialect
    # Uncomment these if you want to override the default values.
    #hibernateShowSql: false
    #connectionPoolSize: 200
    #lockTimeoutSeconds: 20
    #lockTimeoutReportsProgramsSeconds: 5
    #sqlCommandTimeout: 30
####################################################################################################
#
# SYSTEM DATABASE CONFIGURATION SECTION FOR DB2
# For DB2 use same settings as for PostgreSql except for the ones below
#
####################################################################################################
#systemDatabase:
  #type: DB2
  #settings:
    #driverClassname: com.ibm.db2.jcc.DB2Driver
    #url: jdbc:db2://localhost:25000/dbname
    #hibernateDialect: org.hibernate.dialect.DB2Dialect
####################################################################################################
#
# TRANSACTION DATABASE CONFIGURATION SECTION (ENABLE & USE WHEN CONFIGURING A TRANSACTION DATABASE)
# Settings related to the transaction database. Values can be keys for the configured key vault
# from the Secure Storage section up above.
#
####################################################################################################
#transactionDatabase:
#  type: POSTGRES
#  settings:
#    name: amtsystransaction              <Create name>
#    schema: amtsystransaction            <Create schema>
#    username: amtsystransactionUser      <username from secrets file>
#    password: amtsystransactionPassword  <password from secrets file>
#    driverClassname: org.postgresql.Driver
#    url: jdbc:postgresql://localhost/amtsystransaction
#    hibernateDialect: org.hibernate.dialect.PostgreSQLDialect
#    # Uncomment these if you want to override the default values.
#    #hibernateShowSql: false
#    #connectionPoolSize: 200
#    #lockTimeoutSeconds: 20
#    #lockTimeoutReportsProgramsSeconds: 5
#    #sqlCommandTimeout: 30
####################################################################################################
#
# TRANSACTION DATABASE CONFIGURATION SECTION FOR DB2
# For DB2 use same settings as for PostgreSql except for the ones below
#
####################################################################################################
#transactionDatabase:
#type: DB2
  #settings:
    #driverClassname: com.ibm.db2.jcc.DB2Driver
    #url: jdbc:db2://localhost:25000/dbname
    #hibernateDialect: org.hibernate.dialect.DB2Dialect
####################################################################################################
#
# APPLICATION DATABASE CONFIGURATION SECTION FOR POSTGRESQL
# Settings related to the application database. Values can be keys for the configured key vault
# from the Secure Storage section up above.
#
####################################################################################################
smoketest:
  aliases: al1, al2
  type: POSTGRES
  settings:
    name: smoketest
    schema: smoketest
    username: smoketest
    password: smoketest
    driverClassname: org.postgresql.Driver
    url: jdbc:postgresql://localhost/smoketest
    # Uncomment these if you want to override the default values.
    #queryCacheSize: 2 # MB
    #connectionPoolSize: 200
    #minimum-idle: 1
    #encryptConnection: false
    #stringParametersAsUnicode: false
    #statementCachePoolSize: 10 # If set to 0 statement caching is disabled
    #newConnection: false
    #nlsLanguage: AMERICAN
    #credentials:
    # - username: $default:us_1
    #   password: $default:ps_1
    # - username: $default:us_2
    #   password: $default:ps_2
    # - username: $default:us_3
    #   password: $default:ps_3
    ####################################################################################################
    #
    # HIKARICP CUSTOM PROPERTIES
    # Any HikariCP property can be configured by prefixing it with "hikari."
    # Properties will be applied dynamically to the HikariDataSource.
    # See https://github.com/brettwooldridge/HikariCP#configuration-knobs-baby for available properties.
    #
    ####################################################################################################
    # Examples of commonly used HikariCP properties:
    #hikari.connectionTimeout: 30000        # Maximum time (ms) to wait for a connection from the pool
    #hikari.idleTimeout: 600000             # Maximum time (ms) a connection can sit idle in the pool
    #hikari.maxLifetime: 1800000            # Maximum lifetime (ms) of a connection in the pool
    #hikari.leakDetectionThreshold: 0       # Time (ms) before a connection leak is logged (0 = disabled)
    #hikari.validationTimeout: 5000         # Maximum time (ms) for connection validation query
    #hikari.connectionTestQuery: SELECT 1   # SQL query to validate connections
    #hikari.autoCommit: true                # Default auto-commit behavior
    ####################################################################################################
    #
    # APPLICATION DATABASE CONFIGURATION SECTION FOR DB2
    # For DB2 use same settings as for PostgreSql except for the ones below
    #
    ####################################################################################################
    #smoketest:
    #type: DB2
    #settings:
        #driverClassname: com.ibm.db2.jcc.DB2Driver
        #url: jdbc:db2://localhost:25000/dbname
        #hibernateDialect: org.hibernate.dialect.DB2Dialect
####################################################################################################
#
# CLUSTER CONFIGURATION (SINGLE-NODE EXAMPLE)
# Settings related to the cluster configuration. A cluster can be single node (as configured below)
# or multi-node (as shown in the commented out example further down).
#
####################################################################################################
cluster:
  type: PEKKO
  mode: SINGLE_NODE
  nodes:
    single-node-amt:
      settings:
        host: 0.0.0.0
        gRPCPort: 8080
        restPort: 9000
        httpOnly: false
        jobQueues: default
remoteCluster:
  nodes:
    remote-node:
      settings:
        host: 0.0.0.0
        gRPCPort: 9090
####################################################################################################
#
# CLUSTER CONFIGURATION (MULTI-NODE EXAMPLE)
# Multi-node settings for a cluster configuration.
#
####################################################################################################
#cluster:
#  type: PEKKO
#  mode: CLUSTER_NODE
#  nodes:
#    node-1:
#      settings:
#        host: 0.0.0.0
#        port: 25251
#        seedNodes: localhost:25251,localhost:25252
#        gRPCPort: 8080
#        restPort: 9000
#        httpOnly: false
#        roles: job,file,program
#        jobQueues: Default
#    node-2:
#      settings:
#        host: 0.0.0.0
#        port: 25252
#        seedNodes: localhost:25251,localhost:25252
#        gRPCPort: 8081
#        restPort: 9001
#        httpOnly: false
#        roles: job,file,program
#        jobQueues: Default
#    node-3:
#      settings:
#        host: 0.0.0.0
#        port: 0
#        seedNodes: localhost:25251,localhost:25252
#        gRPCPort: 8082
#        restPort: 9002
#        httpOnly: false
#        roles: transaction,file
#    node-4:
#      settings:
#        host: 0.0.0.0
#        port: 0
#        seedNodes: localhost:25251,localhost:25252
#        gRPCPort: 8083
#        restPort: 9003
#        httpOnly: false
#        roles: transaction,file,print
####################################################################################################
#
# COBOL CONFIGURATION
#
####################################################################################################
cobolConfig:
  cwaSize: 0
...