Skip to content

Latest commit

 

History

History
70 lines (60 loc) · 3.56 KB

README.md

File metadata and controls

70 lines (60 loc) · 3.56 KB
Raw

Eureka! Clinical Client Archetype

Georgia Clinical and Translational Science Alliance (Georgia CTSA), Emory University, Atlanta, GA

What does it do?

This project is an maven archetype that helps you create a base Eureka! Clinical client project for using a Eureka! Clinical service's REST APIs.

Version 2.0 development series

Latest release: Latest release

This version will support creating REST API clients for the new major version releases of Eureka! Clinical components.

1.0

Initial release.

Requirements

How to use it

You can create a new client project as follows:

  1. Run the following command with your own values for the properties from groupId down in the example below.
mvn archetype:generate -DarchetypeGroupId=org.eurekaclinical \
    -DarchetypeArtifactId=eurekaclinical-client-archetype \
    -DarchetypeVersion=version \
    -DgroupId=org.eurekaclinical \
    -DartifactId=eurekaclinical-microservicename-client \
    -Dpackage=org.eurekaclinical.packagename \
    -DserviceArtifactId=eurekaclinical-microservicename-service \
    -DinceptionYear=four-digit-year \
    -Dversion=1.0-SNAPSHOT

Alternatively, run the following and answer the prompts:

mvn archetype:generate -DarchetypeGroupId=org.eurekaclinical \
    -DarchetypeArtifactId=eurekaclinical-client-archetype \
    -DarchetypeVersion=version

The groupId, artifactId, version, and package properties are standard maven properties that specify the groupId, artifactId and version of the resulting maven project, and the package that all of the project's classes will go in. This archetype will append .client onto the package name that you specify. The initial version should be 1.0-SNAPSHOT. The other properties are specific to Eureka! Clinical:

  • inceptionYear: the four-digit year in which the service's initial release is anticipated. The value that you specify here goes into the inceptionYear tag in the resulting maven project's pom.xml, and it also goes into the etc/NOTICE.template file.
  • serviceArtifactId: the artifactId of the corresponding service project. Assumes that the service project and this project have the same groupId.

All Eureka! Clinical core projects should follow the naming convention in the first example above, replacing microservicename or MicroserviceName with a name for your new client with corresponding capitalization. Projects that are deployment-specific should have their own groupId, and the artifactId should begin with an identifier for your deployment, for example, emory instead of eurekaclinical for services that are specific to a deployment at Emory University.

  1. After confirming that you want to go ahead and create the new client project, maven will create a folder with the new project in the current directory, which in this example would be eurekaclinical-microservicename-client. It also will create a starter set of class files and resources. Type cd eurekaclinical-microservicename-client.
  2. To generate an initial NOTICE file, type mvn notice:generate. You will need to rerun this command whenever the project's dependencies change.

The resulting project will be buildable using mvn clean install.