Pinery Reports

A Java app for generating regular reports based on Pinery data

Requirements

• Maven 3 or later
• JDK 11 or later

Build

git checkout develop
mvn clean install

Generate

java -jar pinery-reports-<version>-jar-with-dependencies.jar -s <pinery-url> -r <report> -f <format> -g <guanyin-url> -o <filename> [report-specific-options]

Options

Option	Required	Description	Example
-s	YES	Source Pinery URL	-s http://localhost:8080/pinery-miso
-r	YES	Report to generate. See Reports below	-r stock
-f	no	Output format. Can be csv or pdf. Some formats may not be available for all reports. Default varies by report. See Reports below	-f pdf
-g	no	Guanyin URL. If provided, when a report is run it will make sure it is registered with Guanyin, and will create an output file that can be sent to Guanyin to record that the report was run	-g http://guanyin.url:3000
-o	no	Output file. Defaults to "report.csv" or "report.pdf" in current working directory	-o ~/reports/PCSI-stocks-2017-06.pdf

Reports

See report pages or the OICR wiki for additional options and examples:

Generate using Docker

Build the Docker image:

docker build -t pinery-reports .

Generating the reports can be done by running a Docker container with the report-specific parameters.

• the container saves the report with the name you give it to its /output directory.
  • to save the file back to the host machine, use the -v option to link any host machine directory to the /output directory in the Docker container.
  • doing so will cause the file to have the same permissions as the user who ran the Docker container
• to use the host's network (to access an intranet-accessible Pinery or Guanyin, for instance), run the container with the option --network host.
• if the GUANYIN_URL option is provided, the report will register itself with Guanyin if no necessary, and will write a file (in the same directory as the report is written to) containing JSON that can be used to create a Guanyin report record.

docker run -it --rm \
  -e PINERY_URL=<pinery-url> \
  -e REPORT_NAME=<report-name> \
  -e FILE_NAME=<output-file-name> \
  -v <host volume to write report to>:/output \
  --network host \
  pinery-reports <any report-specific options>

Example

docker run -it --rm \
  -e PINERY_URL=http://pinery.url.goes.here:8080 \
  -e REPORT_NAME=slide \
  -e FILE_NAME="PCSI_slide.csv" \
  -v /usr/reports:/output \
  --network host \
  pinery-reports --project=PCSI