Install the software

Click on the desired page based on you needs.

pageHow to install JAR version

pageHow to install Docker version

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'	CronSequenceGenerator (Spring Framework 5.3.13 API) i.e.: "0 0 * * * *" runs every hour
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 For info see: 86. Database Initialization	always
ACQ_BATCH_INPUT_PART_MAX_POOL_SIZE	ThreadPoolTaskExecutor (Spring Framework 5.3.14 API)	ThreadPoolTaskExecutor (Spring Framework 5.3.14 API)	5
ACQ_BATCH_INPUT_PART_CORE_POOL_SIZE	ThreadPoolTaskExecutor (Spring Framework 5.3.14 API)	ThreadPoolTaskExecutor (Spring Framework 5.3.14 API)	5
ACQ_BATCH_INPUT_PART_READ_MAX_POOL_SIZE	ThreadPoolTaskExecutor (Spring Framework 5.3.14 API)	ThreadPoolTaskExecutor (Spring Framework 5.3.14 API)	5
ACQ_BATCH_INPUT_PART_READ_CORE_POOL_SIZE	ThreadPoolTaskExecutor (Spring Framework 5.3.14 API)	ThreadPoolTaskExecutor (Spring Framework 5.3.14 API)	5