Eureka! Clinical Admin Webapp
Georgia Clinical and Translational Science Alliance (Georgia CTSA), Emory University, Atlanta, GA
What does it do?
It provides web pages for admin to manage user profiles and the user agreement. It also implements a proxy servlet and router for web clients to access the web services provided by eurekaclinical-user-service and eurekaclinical-user-agreement-service.
Version 2.0
Updated dependencies.
Version 1.1
Updated dependencies. Added route to eurekaclinical-protempa-service for future job management functionality.
Version 1.0
Initial release.
Build requirements
Runtime requirements
- Oracle Java JRE 8
- Tomcat 7
- Also running
- The eurekaclinical-user-service war
- The eurekaclinical-user-agreement-service war
- The cas-server war
Proxied REST APIs
You can call all of eurekaclinical-user-service's and eurekaclinical-user-agreement-service's and eurekaclinical-registry-service's REST APIs through the proxy. Replace /api/protected/
with /proxy-resource
. The point of doing this is for web clients -- you can deploy the webapp on the same server as web client, and deploy the service on a separate server.
Building it
The project uses the maven build tool. Typically, you build it by invoking mvn clean install
at the command line. For simple file changes, not additions or deletions, you can usually use mvn install
. See https://github.com/eurekaclinical/dev-wiki/wiki/Building-Eureka!-Clinical-projects for more details.
Performing system tests
You can run this project in an embedded tomcat by executing mvn process-resources cargo:run -Ptomcat
after you have built it. It will be accessible in your web browser at https://localhost:8443/eurekaclinical-admin-webapp/. Your username will be superuser
.
Installation
Configuration
This webapp is configured using a properties file located at /etc/ec-user/application.properties
. It supports the following properties:
eurekaclinical.adminwebapp.callbackserver
: https://hostname:porteurekaclinical.adminwebapp.url
: https://hostname:port/eurekaclinical-admin-webappeurekaclinical.userservice.url
: https://hostname.of.userservice:port/eurekaclinical-user-serviceeurekaclinical.useragreementservice.url
: https://hostname.of.useragreementservice:port/eurekaclinical-user-agreement-serviceeurekaclinical.registry.url
: https://hostname.of.registryservice:port/eurekaclinical-registry-servicecas.url
: https://hostname.of.casserver:port/cas-servercas.url.login
: /logincas.url.logout
: /logouteurekaclinical.adminwebapp.allowedwebclients
: https://hostname.of.admin.webclient:port/eurekaclinical-admin-webclient/#/welcome/loggedIn
A Tomcat restart is required to detect any changes to the configuration file.
WAR installation
- Stop Tomcat.
- Remove any old copies of the unpacked war from Tomcat's webapps directory.
- Copy the warfile into the Tomcat webapps directory, renaming it to remove the version. For example, rename
eurekaclinical-admin-webapp-1.0.war
toeurekaclinical-admin-webapp.war
. - Start Tomcat.
Maven dependency
<dependency>
<groupId>org.eurekaclinical</groupId>
<artifactId>eurekaclinical-admin-webapp</artifactId>
<version>version</version>
</dependency>
Developer documentation
Getting help
Feel free to contact us at [email protected].