11.1 pdrBatcher/AEMO Gateway software

For detailed installation instructions, see AEMO Gateway GUI installer.

11.1.1 Full Install

To install pdrBatcher Software responsible for transferring files to and from AEMO's participant file server to the participant's local Data Interchange folders. It can be installed in any environment supporting Java. v8.0.0 as a new implementation, select the following file from the Data Interchange A set of cooperating applications used to replicate data between AEMO's energy market systems and a participant's DBMS conforming to the MMS Data Model. software:

Participant Data Replication Batcher GUI Installer v8.0.0

Participant Data Replication Batcher GUI Installer v8.0.0.zip

File

Filename

Benefit

Participant Data Replication Batcher GUI Installer v8.0.0

Participant Data Replication Batcher GUI Installer v8.0.0.zip

Requires the minimum data entry for localisation.

All implementation steps are automatic.

A manual installation is possible by exiting the installer and using a text editor to set the configuration properties.

11.1.2 Upgrading from v7.6.0 to v8.0.0

The release of pdrBatcher v8.0.0 introduces a number of new optional configurations in the .properties file. For details, see Properties file updates below.

Properties file updates

For help configuring these properties, see Participant Data Replication Batcher User Guide.

Participant Data Replication Batcher GUI Installer v8.0.0

Participant Data Replication Batcher GUI Installer v8.0.0.zip

Property

Detail

batcher_error_dir

Error folder for files that are unable to be processed.

OAuth2 provider definitions

Refer to the documentation in pdrBatcher.properties.

Data Source definitions

Numerous new configurations which add support for various connector types such as AMQP, etc. Refer to the documentation in pdrBatcher.properties.

Event Source definitions

Event sources support channels such as WebSockets for connectivity to IDX. Refer to the documentation in pdrBatcher.properties.

Request rate limiter configuration

Refer to the documentation in pdrBatcher.properties.

JSON schema configuration

Refer to the documentation in pdrBatcher.properties.

XML schema configuration

Refer to the documentation in pdrBatcher.properties.

batcher_thread_check_interval

The interval (seconds) to check for failed threads. Default is 5 seconds.

batcher_thread_report_interval

The interval (seconds) to report thread summary in log file. Default is 3600 seconds.

batcher_thread_{N}_min_size_bytes

Allows the specification of a minimum file size filter on a processing thread.

batcher_thread_{N}_source_api_scope

The scope to request when the source uses OAuth for authentication.

batcher_thread_{N}_dest_api_scope

The scope to request when the destination uses OAuth for authentication.

batcher_thread_{N}_service_name

The service name associated with this thread when called as a synchronous API service.

batcher_thread_{N}_service_roles

The JWT roles required to access this thread.

batcher_thread_{N}_service_request_limit_filter

The label for the request rate limiter to apply. Optional.

batcher_thread_{N}_file_status_translator

Ability to perform a translation on an completed transaction for status reporting back to source.

Allows merging of data within return acknowledgment transaction.

Configuration option per batcher_thread_{N}_file_translator.

batcher_thread_{N}_transaction_archive

Set to Y to enable transaction audit for this thread.

batcher_thread_{N}_transaction_archive_data_dir

The transaction data directory for this thread, which overrides batcher_transaction_archive_data_dir.

batcher_thread_{N}_retention_time_mins

The retention time for a thread operating in PURGE mode.

batcher_thread_{N}_file_integrity_check

The integrity check to apply to an incoming file. Valid settings are:

- NONE: Pass through, no check performed.

- ZIP: Performs a check that a compressed file is valid. Supported compression types include zip, gz, .7z, .tgz, tar.gz

Note: A zip validator does not inspect the content of the zip file unless further validators are chained in a pipeline. See below.

- JSON JavaScript Object Notification: Performs a check that a file contains valid JSON

- XML eXtensible Mark-up Language.: Performs a check that a file contains valid XML. Valid parameters (case sensitive):

schema: The XML schema configuration to use. Refer to configuration xml_schema_configurations.

- DEFAULT: Performs a check based on the file extension, matching to the appropriate validator or passing through if there are no validators for that file type.

batcher_thread_{N}_parameters

A set of parameters that can be defined for use in operations within the thread. Defined as a list of comma delimited name value pairs. Example: x-market=NEM,x-initiatingParticipantId=XXXX

batcher_thread_{N}_participant_list

The comma delimited list of participant ID to process. Relevant to aseXML and IDX message exchange patterns. Overrides batcher_{DS}_participant_list for thread {N}.

batcher_thread_{N}_fire_and_forget

Sets whether to acknowledge inbound messages with a generated message ack back to source or assume a fire and forget pattern which suppresses generation of a message ack. Applies only to IDX message exchange patterns.

batcher_thread_{N}_business_function_list

The comma delimited list of business functions to process. Relevant to IDX message exchange patterns. Overrides batcher_{DS}_business_function_list for thread {N}.

web_server_https_keystore_file

The keystore file which contains certificates to support SSL configuration of the web server.

web_server_https_keystore_type

The type of keystore file. Default is PKCS12.

web_server_https_store_password

The key store password associated with KeyStoreFile. Defaults to encryption key stored in pdr_key.properties.

web_server_https_key_password

The certificate password. Defaults to encryption key stored in pdr_key.properties.

web_server_https_protocol

The SSL protocol to use. Options include TLS, TLSv1.2. Default is TLS.

Properties file deletions

No properties are made obsolete for v8.0.0.

GUI installation process

The GUI installation process is a simple, clean way to upgrade. Alternatively, you can use the Manual Installation process below.

Follow the steps below to upgrade an existing Participant Data Replication Batcher An application providing an interface for batch transactions, called MSATS Participant Batcher. Software v7.6.0 to v8.0.0 installation:

  • If it is not already installed, install JRE 21.
  • Validate the jar file signature. From the command line prompt, run the following command:

    • jarsigner -verify "Participant Data Replication Batcher GUI Installer v8.0.0.jar"

  • For more information, see https://docs.oracle.com/en/java/javase/21/docs/specs/man/jarsigner.html
  1. Install the pdrBatcher v8.0.0 to the current installation folder (for example, C:\Pdr\Batcher).
  • The current installation is backed up to a folder alongside the current installation with a timestamp appended to the folder name.
  1. If running as a Windows service, ensure the Windows service name entered into the GUI installer matches the existing service name.
  2. Check the pdrBatcher.properties file changes and re-apply any customised configurations. See properties file updates and deletions.
  3. Run the pdrBatcher.bat or the Windows service and check the pdr.log in the Log folder for any errors.

Manual installation process

Follow the steps below to manually upgrade an existing Participant Data Replication Batcher Software v7.6.0 to v8.0.0 installation:

  • Backup your pdrBatcher v7.6.0 installation folder.
  • Remove the pdrBatcher v7.6.0 Windows service by running:

    • pdrServiceUninstall.bat <insert_Windows_service_name_here>.

  1. Remove all existing jar files from the Lib folder.
  1. Copy the following content from the pdrBatcher v8.0.0 installation media into your Lib folder:
  2. All jar files
  3. New windows service wrapper:
  4. prun*.exe
  5. pdrServiceInstall.ini
  1. If it is not already installed, install JRE 21 and update the JRE path variable in:
  2. pdrEnvironment.bat
  3. pdrServiceInstall.bat
  1. Create an Error folder under the main installation directory and add property:

    2. batcher_error_dir=${batcher_install_dir}/Error

  1. Consider aligning your pdrBatcher.properties to the standard configuration file unless you have specific customisation requirements. For participants with customisation requirements, it is recommended that these customisations be merged into a standard v8.0.0 properties file definition.
  2. Install a new Windows service by running:

    3. pdrServiceInstall.bat <insert_Windows_service_name_here>.

  1. Check the NEMNET password is correctly encrypted before running the service by running the following command to avoid any password lockout:

    2. pdrConnectionTest.bat

  1. Run pdrBatcher.bat or the Windows service and check the pdr.log in the Log folder for any errors. For help, see Guide to Participant Data Replication Batcher.

Custom code extensions

The pdrBatcher v8.0.0 release updates the code package from au.com.nemmco.* to au.com.aemo.*.

Any references to the interfaces which define those extensions must be recompiled against the interfaces in the new package. Refer to the SDK folder in the installation directory for instructions and examples. Participants requiring assistance to migrate any existing plug-in configurations should log a support ticket with AEMO Australian Energy Market Operator Support Hub.