AMT JCL Config

It is possible to make configuration changes to JCL scripts without rebuilding AMT-JCL by overriding their settings with a JSON configuration file (jcl-config.json).

Python scripts load the settings from the configuration file upon start. The location of the JSON configuration file can be set using the JCL_CONFIG_FILE environment variable.

Setting the Environment Variable

The file path pointing to the location of the JCL configuration file can be set using the JCL_CONFIG_FILE environment variable. Follow the instructions below for Windows or Linux.

Windows

1. Open the Settings of Windows and navigate to System.
2. Click on Advanced system settings A new dialog appears.
3. Click on the Environment Variables button.
4. Under System variables, click on the New button.
5. Fill out the Variable name and Variable value as follows:
   1. Set the Variable name to JCL_CONFIG_FILE.
   2. Set the Variable value to point to the location of the JCL configuration file.
6. Click the OK button.

Linux

1. Open a terminal.
2. Open the environment file in a text editor: sudo <text editor> /etc/environment.
• Text editor: specify a text editor, such as nano, vim, gedit, and kate.
3. Enter the super user password to authenticate.
4. Add the following line at the end of the file: JCL_CONFIG_FILE="<value>".
• The value should point to the location of the JCL logging file.
5. Save the file.
6. Open a new terminal and run echo $JCL_CONFIG_FILE to verify the variable has been set successfully.

Configuring GRPC and OIDC Authentication

It is necessary to configure OIDC to authenticate clients and allow access to the AMT application.

Azure Entra Example

"oidc_url": "<URL OIDC provider>",
"oidc_client_id": "<Client ID>",
"oidc_client_secret": "<Client Secret>",
"oidc_scope": "api://id/.default"

Keycloak Example

Set the environment variable "SSL_CERT_FILE" to the cert file used by keycloak. For example: C:\AMT\Java\certs\server1.pem. Python uses the cert file to verify the certificate of Keycloak.

"oidc_url": "<localhost:port/realms/AMTRealm/protocol/openid-connect/token>",
"oidc_client_id": "<Client ID>",
"oidc_client_secret": "<Client Secret>",
"oidc_scope": "openid offline_access"

Enabling Support For OpenTelemetry

Usage of OpenTelemetry is optional and it is disabled by default. To enable OpenTelemetry, the host address and port of the OTEL collector must be configured (these fields are empty by default):

Example:

"otel_collector_host": "localhost",
"otel_collector_port": "4317"

Available Configuration Settings

The following settings are available in the jcl_config.json file:

"smtp_host": "smtp_hostmail.company.com"
                

"smtp_user": "user@company.com"
                

"smtp_email": "noreply@company.com"
                

"smtp_subject_suffix": " [Company Internal]"
                

"smtp_default_bcc": ["john@doe.com", "jane@doe.com"]
                

Vaults

A key vault is a secure storage solution for managing sensitive information, such as API keys, passwords, and certificates. It provides a centralized location for storing and accessing these secrets, ensuring that they are protected and only accessible to authorized users and applications. The JCL configuration offers the possibility to configure the HashiCorp vault.

The vaults setting is an array that can contain multiple vault configurations. Each vault configuration is represented as a JSON object with the following fields:

The secret extraction from the vault is supported for all settings except file_encoding. When using these settings with the vault configuration, the secret name should be specified for each property with the following structure: $vault_id:secret_name. Otherwise, use a plaintext value.

Example file

jcl_config.json

{
  "development" : false,
  "customer_library": "",
  "app_name": "TEST-APP",
  "application_kind": "",
  "job_summary": true,
  "amt_job_name": "GLOBAL_JOB",
  "job_logging_path": "C:/AmtJava/Logging",
  "include_folder": "",
  "proc_libs_folder": "C:/AmtJava/amt-go/parent-scripting/jcl/python/amt-jcl/amt_jcl/procs",
  "file_encoding": "ASCII",
  "block_size": 32000,
  "max_wait_time": 1,
  "max_gdg_generation": 255,
  "file_extension": ".DAT",
  "print_extension": ".PRN",
  "abend_on_missing_file": false,
  "virtual_data_path": "",
  "keep_all_files": false,
  "int_rdr_folder": "",
  "int_rdr_queue": "",
  "default_printer": "DEFAULT",
  "cert": "C:/Sources/amt-go-java/parent-scripting/jcl/python/amt-jcl/amt_jcl/amt/platform/communication/grpc/certs/ca.pem",
  "app_host": "localhost",
  "app_grpc_port": "8080",
  "job_finished_polling_interval": 0.5,
  "merge_finished_polling_interval": 0.5,
  "use_date": "",
  "ftp_override_mode": false,
  "ftp_override_host": "",
  "ftp_override_user": "",
  "ftp_override_password": "",
  "ftp_override_destination": "",
  "ftp_ignore_cd": false,
  "ftp_disabled": false,
  "ftp_default_port": 21,
  "smtp_host": "",
  "smtp_port": 25,
  "smtp_user": "",
  "smtp_password": "$smtp:SMTP_PASSWORD",
  "smtp_email": "",
  "smtp_subject_suffix": "",
  "smtp_default_bcc": [],
  "server_list": [],
  "oidc_url": "",
  "oidc_client_id": "",
  "oidc_client_secret": "$auth:CLIENT_SECRET",
  "oidc_scope": "",
  "otel_collector_host": "",
  "otel_collector_port": -1,
  "intrdr_folder": "C:/Amt/Scripts/IntRdr",
  "vaults": [
    {
      "id": "smtp",
      "type": "HashiCorp",
      "url": "http://127.0.0.1:8200",
      "token": "HASHICORP_VAULT_TOKEN_API_KEY1",
      "secret_path": "smtp"
    },
    {
      "id": "auth",
      "type": "HashiCorp",
      "url": "http://127.0.0.1:8202",
      "token": "HASHICORP_VAULT_TOKEN_API_KEY2",
      "secret_path": "keycloak"
    }
  ]
}