Skip to content

Starting template for a JAX-RS REST API implementation in Planon.

License

Notifications You must be signed in to change notification settings

planon-community/planon-restapi

Repository files navigation

Planon JAX-RS

Setup

  1. You will need to obtain the necessary Planon .jar files to compile and deploy

    • client.api.utils-1.0.4.jar
    • com.planonsoftware.enterprise.service.api.v2-3.5.0.0-1.jar
    • com.planonsoftware.hades-18.0.35.0-35.jar
    • com.planonsoftware.json.server.api.v7-9.0.8.0-1.jar
    • com.planonsoftware.logging-4.0.5.0-1.jar
    • gson-2.8.6.jar
    • log4j-1.2.17.jar
    • org.apache.felix.dependencymanager-3.1.0.jar
  2. Mount /tms/upload/servicessdk to /Volumes/tms/upload/servicessdk, the jar will automatically be copied here

  3. Build the jar

gradle build

Install

  1. Upload to /tms/servicessdk

  2. Reload TMS

  3. Should see a message similar to the following in the catalina.out log

    Running...
    INFO [12-01-2021 21:49:21, , thread=] Jax-Rs registry (v1) will be mounted upon the next request: JaxRSRegistry
    CATA 01/12/21 21:49:21 INFO [org.apache.catalina.core.ApplicationContext log] ROOT: Bundle: Dartmouth-REST (0.0.0) is started. 
    INFO [12-01-2021 21:49:22, f003xt4, thread=] Installing registry edu.dartmouth.planon.rest.osgi.Activator$JaxRSRegistry
  4. Service can be accessed via https://environment/services/sdk

  5. In System settings --> Password security --> Security --> Access keys

    1. Generate key pair
  6. Verify access keys is setup in layout for accounts

  7. Setup access key for account

Upgrade

CATA 01/13/21 01:21:21 INFO [org.apache.catalina.core.ApplicationContext log] ROOT: Bundle: Dartmouth-REST (0.0.0) is removed. 
 INFO [13-01-2021 01:21:21, , thread=] Service registry (v1) will be unmounted upon the next request: JaxRSRegistry
 INFO [13-01-2021 01:21:22, , thread=] Jax-Rs registry (v1) will be mounted upon the next request: JaxRSRegistry
CATA 01/13/21 01:21:22 INFO [org.apache.catalina.core.ApplicationContext log] ROOT: Bundle: Dartmouth-REST (0.0.0) is started. 
 INFO [13-01-2021 01:21:32, f003xt4, thread=] Uninstalling registry edu.dartmouth.planon.rest.osgi.Activator$JaxRSRegistry@1ce89f10
 INFO [13-01-2021 01:21:32, f003xt4, thread=] Installing registry edu.dartmouth.planon.rest.osgi.Activator$JaxRSRegistry

About

Starting template for a JAX-RS REST API implementation in Planon.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages