Centro stella dei pagamenti elettronici
  • Centro Stella
    • Instructions for Agenzia delle Entrate Mandate
      • How to join
        • 01. Sign the Agreement
        • 02. Integrate PagoPA Environments
          • Open routes
          • Request the mutual authentication certificates
          • Obtain an API key
          • Wait for activation email
          • Check if you are enabled for PagoPA UAT environment
        • 03. Configure the Batch Service
          • Prepare the Java KeyStore
          • Install the software
            • How to install JAR version
              • Download JAR file
              • Prepare the working directories
              • Define environment variables
            • How to install Docker version
              • Download Docker image
              • Define environment variables
              • Choose working directory to mount
          • Run the software
            • Run from JAR
            • Run with Docker
        • 04. Test and monitor integration
          • Test UAT
          • Test PROD
        • 05. Go live!
      • Releases / Changelog
        • Note regarding the modifications from 2.2.0 to 2.2.3
        • Note regarding the modifications from 2.1.2 to 2.2.0
        • Note regarding the modifications of the yaml file from 2.0.0 to 2.1.0
        • Note regarding the modifications of the yaml file from 1.5.1 to 2.0.0
        • Note regarding the modifications of the yaml file from 1.4.1 to 1.5.0
        • Note regarding the modifications of the yaml file from 1.3.2 to 1.4.1
        • Note regarding the modifications of the yaml file from 1.2.5 to 1.3.2
      • Appendixes
        • Appendix 1 - Environments
        • Appendix 2 - Input file specifications
        • Appendix 3 - AdE output file specifications
          • Appendix 3 - AdE output file specifications v1.2.5
        • Appendix 4 - AdE errors file specifications
        • Appendix 5 - Logback configuration
        • Appendix 6 - Configuration properties
        • Appendix 7 - Console log overview
        • Appendix 8 - Database connection for Spring Batch
        • Appendix 9 - FAQ & Troubleshooting
        • Appendix 10 - Python and Poetry installation
        • Appendix 11 - List of output and log files
      • Api Integration
  • Glossary
  • RTD documentation
    • Input file specifications
Powered by GitBook
On this page
  • Mandatory environment variables
  • Relevant optional environment variables
  1. Centro Stella
  2. Instructions for Agenzia delle Entrate Mandate
  3. How to join
  4. 03. Configure the Batch Service

Install the software

PreviousPrepare the Java KeyStoreNextHow to install JAR version

Last updated 2 years ago

Click on the desired page based on you needs.

Mandatory environment variables

The Batch Service expects some configuration variables to be always explicitly set. The following table explains those variables in detail.

We suggest to use a script to easily set up the environment for the batch execution. An example is available after the table.

Variable
Description
Possible values

ACQ_BATCH_SCHEDULED

Set the scheduled execution through the internal scheduler

true, false

ACQ_BATCH_INPUT_CRON

Defines when to execute the batch if ACQ_BATCH_SCHEDULED valued at 'true'

ACQ_BATCH_TRX_INPUT_PATH

The path to the directory containing the transaction files to be processed as input

Path on file system

ACQ_BATCH_TRX_LOGS_PATH

The directory path where any filtered or failed records will be saved

Path on file system

ACQ_BATCH_OUTPUT_PATH

The path where the output files will be deposited

Path on file system

ACQ_BATCH_HPAN_INPUT_PATH

Path where the HPAN file is saved after download

Path on file system

ACQ_BATCH_SENDER_ADEACK_OUTPUT_PATH

Path where the ade ack files are saved after download

Path on file system

ACQ_BATCH_FILE_REPORT_PATH

Path where the file reports are saved

Path on file system

HPAN_SERVICE_URL

Base URL of the CentroStella APIs

URL

HPAN_SERVICE_API_KEY

API key for authorization

String

HPAN_SERVICE_KEY_STORE_FILE

Path to the key store (.jks) containing the private key for mTLS authentication

Path on file system

HPAN_SERVICE_KEY_STORE_PASSWORD

Key store password (.jks) containing the private key for mTLS authentication

String

HPAN_SERVICE_TRUST_STORE_FILE

Path to the key store (.jks) containing the certificate for mTLS authentication

Path on file system

HPAN_SERVICE_TRUST_STORE_PASSWORD

Key store password (.jks) containing the certificate for mTLS authentication

String

JAVA_TOOL_OPTIONS

Extra parameters for the Java Virtual Machine. It is required to set at least 4GB of Heap through the parameters "-Xms6g -Xmx6g"

String

Relevant optional environment variables

Variable

Description

Possible values

Default

HPAN_SERVICE_PROXY_ENABLED

If set to 'true' HTTP requests are routed to the configured proxy service

true, false

false

HPAN_SERVICE_PROXY_HOST

Hostname of the proxy service (use in conjunction to HPAN_SERVICE_PROXY_ENABLED set to 'true')

hostname

n/a

HPAN_SERVICE_PROXY_PORT

Port number of the proxy service (use in conjunction to HPAN_SERVICE_PROXY_ENABLED set to 'true')

TCP port number

n/a

HPAN_SERVICE_PROXY_USERNAME

Username for proxy authentication (use in conjunction to HPAN_SERVICE_PROXY_ENABLED set to 'true')

username

n/a

HPAN_SERVICE_PROXY_PASSWORD

Password for proxy authentication (use in conjunction to HPAN_SERVICE_PROXY_ENABLED set to 'true')

password

n/a

ACQ_BATCH_INITIALIZE_SCHEMA

Set automatic initialisation of the database schema

always, never

always

ACQ_BATCH_INPUT_PART_MAX_POOL_SIZE

5

ACQ_BATCH_INPUT_PART_CORE_POOL_SIZE

5

ACQ_BATCH_INPUT_PART_READ_MAX_POOL_SIZE

5

ACQ_BATCH_INPUT_PART_READ_CORE_POOL_SIZE

5

i.e.: "0 0 * * * *" runs every hour

For info see:

How to install JAR version
How to install Docker version
CronSequenceGenerator (Spring Framework 5.3.13 API)
86. Database Initialization
ThreadPoolTaskExecutor (Spring Framework 5.3.14 API)
ThreadPoolTaskExecutor (Spring Framework 5.3.14 API)
ThreadPoolTaskExecutor (Spring Framework 5.3.14 API)
ThreadPoolTaskExecutor (Spring Framework 5.3.14 API)
ThreadPoolTaskExecutor (Spring Framework 5.3.14 API)
ThreadPoolTaskExecutor (Spring Framework 5.3.14 API)
ThreadPoolTaskExecutor (Spring Framework 5.3.14 API)
ThreadPoolTaskExecutor (Spring Framework 5.3.14 API)