jeffersonlab/btm repository overview

⁠btm

A Jakarta EE 10⁠ web application for managing beam time at Jefferson Lab built with the Smoothness⁠ web template.

• Overview⁠
• Quick Start with Compose⁠
• Install⁠
• Configure⁠
• Build⁠
• Develop⁠
• Release⁠
• Deploy⁠
• See Also⁠

⁠Overview

The Beam Time Manager application allows crew chiefs and experimenters to track machine time accounting while allowing management to review reports. The app prompts crew chiefs and experimenters with shift timesheets pre-filled with data estimated via beam position sensor measurements. The app also holds a database view of the NPES schedule, exposes programmatic access via a JSON REST service, and integrates with Program Deputy shift plans⁠ and DTM⁠ to enable prompting timekeepers with the expected plan as well. The timesheets therefore consist of Planned, Measured, and Reported values.

⁠Quick Start with Compose

1. Grab project

git clone https://github.com/JeffersonLab/btm
cd btm

1. Launch Compose⁠

docker compose up

1. Navigate to page

http://localhost:8080/btm

Note: Login with demo username "jdoe" and password "password".

See: Docker Compose Strategy⁠

⁠Install

This application requires a Java 17+ JVM and standard library to run, plus a Jakarta EE 10 application server (developed with Wildfly).

1. Install service dependencies⁠
2. Download Wildfly 37.0.1⁠
3. Configure⁠ Wildfly and start it
4. Download btm.war⁠ and deploy it to Wildfly
5. Navigate your web browser to localhost:8080/btm⁠

⁠Configure

⁠Configtime

Wildfly must be pre-configured before the first deployment of the app. The wildfly bash scripts⁠ can be used to accomplish this. See the Dockerfile⁠ for an example.

Note: In production users often leave multiple instances of the app open per counting house and concurrent hourly refreshes may result in concurrent DB request contention for the BTM connection pool. Bumping up the max allowed concurrent⁠ DB connections can ameliorate this. See Also: https://github.com/JeffersonLab/btm/issues/9#issuecomment-2819393849⁠

⁠Runtime

Uses the Smoothness Environment Variables⁠ plus the following application specific:

⁠Database

This application requires an Oracle 19+ database with the following schema⁠ installed. The application server hosting this app must also be configured with a JNDI datasource.

⁠Build

This project is built with Java 21⁠ (compiled to Java 17 bytecode), and uses the Gradle 9⁠ build tool to automatically download dependencies and build the project from source:

git clone https://github.com/JeffersonLab/btm
cd btm
gradlew build

Note: If you do not already have Gradle installed, it will be installed automatically by the wrapper script included in the source

Note for JLab On-Site Users: Jefferson Lab has an intercepting proxy⁠

See: Docker Development Quick Reference⁠

⁠Develop

In order to iterate rapidly when making changes it's often useful to run the app directly on the local workstation, perhaps leveraging an IDE. In this scenario run the service dependencies with:

docker compose -f deps.yaml up

Note: The local install of Wildfly should be configured⁠ to proxy connections to services via localhost and therefore the environment variables should contain:

KEYCLOAK_BACKEND_SERVER_URL=http://localhost:8081
FRONTEND_SERVER_URL=https://localhost:8443
BTM_EPICS_ADDR_LIST=localhost

Further, the local DataSource must also leverage localhost port forwarding so the standalone.xml connection-url field should be: jdbc:oracle:thin:@//localhost:1521/xepdb1.

The server⁠ and app⁠ setup scripts can be used to setup a local instance of Wildfly.

⁠Release

1. Bump the version number in the VERSION file and commit and push to GitHub (using Semantic Versioning⁠).
2. The CD⁠ GitHub Action should run automatically invoking:
   • The Create release⁠ GitHub Action to tag the source and create release notes summarizing any pull requests. Edit the release notes to add any missing details. A war file artifact is attached to the release.
   • The Publish docker image⁠ GitHub Action to create a new demo Docker image.
   • The Deploy to JLab⁠ GitHub Action to deploy to the JLab test environment.

⁠Deploy

The deploy to JLab's acctest is handled automatically via the release workflow.

At JLab this app is found at ace.jlab.org/btm⁠ and internally at acctest.acc.jlab.org/btm⁠. However, those servers are proxies for wildfly3.acc.jlab.org and wildflytest3.acc.jlab.org respectively. A deploy script⁠ is provided on each server to automate wget and deploy. Example:

/root/setup/deploy.sh btm v1.2.3

JLab Internal Docs: RHEL9 Wildfly⁠

⁠See Also

• JLab ACE management-app list⁠