Installing the Pipeline Engine

Changes in Pipeline Framework XNAT 1.9+

In XNAT version 1.9 onwards, the Pipeline Engine Framework now requires two components to be installed and configured:

• The Pipeline Engine (as mentioned in this document)

• The XNAT Pipeline Engine Plugin.

Get the latest Pipeline Engine code: $ git clone https://www.github.com/nrgXnat/xnat-pipeline-engine.git

The XNAT pipeline engine is distributed as a code repository that contains the pipeline engine installer. To install the pipeline engine:

1. Create a folder to contain the pipeline installer, change to that directory, then clone the :

   Extracting XNAT pipeline installer

   BASH

   $~$ mkdir pipeline
   ~$ cd pipeline/
   ~/pipeline$ git clone https://www.github.com/nrgXnat/xnat-pipeline-engine.git 

2. Create a destination folder for the pipeline engine. The standard XNAT practice is to use /data/project/pipeline. As with other XNAT folders, the pipeline folder must be accessible by the Tomcat user.

   Creating XNAT pipeline installation folder

   BASH

   ~$ mkdir /data/xnat/pipeline

3. Run setup.sh with the administrator email address, SMTP server address, XNAT URL, site name, and destination folder:

   Alternatively, you can save these options in a file named gradle.properties in the pipeline installer folder:

   XNAT pipeline installer gradle.properties

   BASH

   xnatUrl=http://oldschool.edu
   siteName=XNAT
   adminEmail=admin@oldschool.edu
   smtpServer=mail.oldschool.edu
   destination=/data/xnat/pipeline

   Now run gradlew from that folder:

   Installing XNAT pipeline with gradlew

   BASH

   ~$ ./gradlew

   The advantage of the latter approach is that you can reinstall updates to the pipeline engine with one simple command rather than having to re-enter the full setup.sh syntax again.