Not found
Oops! This page doesn't exist. Try going back to our home page.
You can learn how to make a 404 page like this in Custom 404 Pages.
This is the multi-page printable view of this section. -Click here to print.
Documentation
- 1: User Guides
- 1.1: Getting Started
- 1.1.1: UQ members
- 1.1.2: Other AAF members
- 1.1.3: Non-AAF members
- 1.1.4: HIRF users
- 1.2: Logging into XNAT
- 1.2.1: AAF login
- 1.2.2: RCC Authenticate
- 1.2.3: Alias tokens
- 1.3: Browsing XNAT
- 1.4: Managing Data
- 1.4.1: Downloading Data
- 1.4.1.1: Zip Download
- 1.4.1.2: Desktop client
- 1.4.1.3: Download Scan
- 1.4.2: Viewing Images
- 1.4.3: Uploading Data
- 1.4.3.1: Web Upload
- 1.4.3.2: Resource uploader
- 1.4.3.3: Prearchive
- 1.4.4: Syncing Data
- 1.4.5: Anonymising Data
- 1.4.5.1: Project anonymiser
- 1.4.5.2: Site anonymiser
- 1.5: Processing Data
- 1.5.1: Command line tools
- 1.6:
- 2: Facility Guides
- 2.1: Clinical Trials Processor (CTP)
- 2.1.1: Installation
- 2.1.2: Proxy Server Settings
- 2.1.3: Windows Service
- 2.1.4: Linux Service
1 - User Guides
For Researchers and Collaborators
1.1 - Getting Started
Signing up and getting started with UQ-RCC XNAT
1.1.1 - UQ members
For UQ Staff and Students
Signing into XNAT
Step 1
Open https://xnat.rcc.uq.edu.au
Note
This is the link to the UQ AIS XNAT. If you have been provided with a project specific XNAT link to use, use that one insteadStep 2
Login in with the AAF Single sign-on button (shown below).
Follow the AAF login process for your organisation
Unexpected error
If you encounter the following error, refresh the page 2-3 times. The login should progress
If the error remains after multiple refreshes, contact support.
Step 3
After the AAF sign-in, you should be redirected back to XNAT (Example below)
There will be no projects listed when signing in for the first-time, as your user account would have just been created.
Proceed to to next section for setting up an XNAT project
Creating XNAT project
For UQ users, XNAT uses UQ-RDM HPC collections for storage allocation.
For any general questions about UQ-RDM, please refer to the library guides
Note
Only one member of the project team needs to request for the projectStep 1
Before creating an XNAT project, you’ll require a UQ-RDM HPC Collection
- HPC collections ends with -Q and a 4-digit numerical identifier (e.g. PROJ001-Q0189)
- Non-HPC collections end with -A (e.g. PROJ001-A0189) or -I (PROJ001-I0189)
If you have an existing UQ-RDM HPC collection (ending with -Qxxxx), skip to the next step
To create a new UQ-RDM HPC Collection, proceed with the following
Open https://rdm.uq.edu.au/create-record and sign-in
Fill in the record as per your project details
Important
For (6) Data Storage Options, select the second option (The project data needs to be mounted on UQ HPC facilities.)
Any other option will be incompatible with XNAT, requiring a new RDM request
REQUEST DATA STORAGE when complete
Move on to the next step after the RDM collection is provisioned
You should have an RDM collection name ready (e.g. PROJ001-Q0189)
Step 2
Open a ticket with RCC support
Example below (replace __________ with your details)
Subject: Create XNAT project __________
Hello RCC support -Can we create an XNAT project for RDM collection __________
Step 3
The support ticket will inform you when the project is set up.
- An XNAT project will be created with the matching name (e.g. PROJ001-Q0189)
- An xnat directory will be created in the RDM collection for storing the XNAT data files
- Please do not write or modify anything under the xnat directory
XNAT Project setup typically takes around ~24 hours from ticket submission
An automated email from XNAT will be sent through when project is ready, and your user has been added
1.1.2 - Other AAF members
Other AAF members
This guide is for users from Australian Universities and AAF member organisations, including:
- QUT, Griffith, CQU, JCU, USQ, USC
- CSIRO, Australian Universities
- AAF VHO accounts
Other AAF members usually require UQ AIS XNAT access for:
- Management of data acquisition from sites such as CAI, HIRF, TRI
- Collaborating on projects managed on UQ AIS XNAT
Full list of AAF members found here
For all other organisations, use the Non-AAF members guide
Signing into XNAT
Step 1
Open https://xnat.rcc.uq.edu.au
Note
This is the link to the UQ AIS XNAT. If you have been provided with a project specific XNAT link to use, use that one insteadStep 2
Login in with the AAF Single sign-on button (See below).
Follow the AAF login process for your organisation
Unexpected error
If you encounter the following error, refresh the page 2-3 times. The login should progress
If the error remains after multiple refreshes, contact support.
Step 3
After the AAF sign-in, you should be redirected back to XNAT (Example below)
There will be no projects listed when signing in for the first-time, as your user account would have just been created.
Accessing XNAT Project
If you are Acquiring data at HIRF, CAI or TRI
- The respective facility will organise the project creation.
- You will receive a follow up email when access has been granted
- Contact rcc-support@uq.edu.au if you have not received access within 5 working days
If you are collaborating on an existing XNAT project
- Contact the project lead to grant you access to the XNAT project
1.1.3 - Non-AAF members
Non-University, non-AAF members and other users
This is for users from non-AAF member organisations, including:
- QLD Health, TRI, QIMR, QLD Xray
Non-AAF members usually require XNAT access for:
- Management of data acquisition from sites such as CAI, HIRF, TRI
- Collaborating on projects managed on UQ-RCC XNAT
XNAT uses AAF for login. QCIF/QRIScloud can provide AAF Virtual Home (VHO) accounts for non-AAF users.
Creating an AAF VHO account
Step 1
Open a ticket with RCC support to request an AAF account
Example below (replace __________ with your details)
Subject: XNAT AAF account for project __________
Hello RCC support
-I require an AAF account to access the UQ AIS XNAT service
My details are below
Organisation: __________
Data Acquisition Site: __________
Step 2
AAF’s VHO account will return an email regarding the VHO account registration process
Step 3
After account is provisioned, continue on to the Signing into XNAT guide
Signing into XNAT
Step 1
Open https://xnat.rcc.uq.edu.au
Note
This is the link to the UQ AIS XNAT. If you have been provided with a project specific XNAT link to use, use that one insteadStep 2
Login in with the AAF Single sign-on button (See below).
Select the AAF Virtual Home option (See below) and login with your AAF VHO credentials.
+
This is the multi-page printable view of this section. +Click here to print.
Documentation
- 1: User Guides
- 1.1: Getting Started
- 1.1.1: UQ members
- 1.1.2: Other AAF members
- 1.1.3: Non-AAF members
- 1.1.4: HIRF users
- 1.2: Logging into XNAT
- 1.2.1: AAF login
- 1.2.2: RCC Authenticate
- 1.2.3: Alias tokens
- 1.3: Browsing XNAT
- 1.4: Managing Data
- 1.4.1: Downloading Data
- 1.4.1.1: Zip Download
- 1.4.1.2: Desktop client
- 1.4.1.3: Download Scan
- 1.4.2: Viewing Images
- 1.4.3: Uploading Data
- 1.4.3.1: Web Upload
- 1.4.3.2: Resource uploader
- 1.4.3.3: Prearchive
- 1.4.4: Syncing Data
- 1.4.5: Anonymising Data
- 1.4.5.1: Project anonymiser
- 1.4.5.2: Site anonymiser
- 1.5: Processing Data
- 1.5.1: Command line tools
- 1.6:
- 2: Facility Guides
- 2.1: Clinical Trials Processor (CTP)
- 2.1.1: Installation
- 2.1.2: Proxy Server Settings
- 2.1.3: Windows Service
- 2.1.4: Linux Service
1 - User Guides
For Researchers and Collaborators
1.1 - Getting Started
Signing up and getting started with UQ-RCC XNAT
1.1.1 - UQ members
For UQ Staff and Students
Signing into XNAT
Step 1
Open https://xnat.rcc.uq.edu.au
Note
This is the link to the UQ AIS XNAT. If you have been provided with a project specific XNAT link to use, use that one insteadStep 2
Login in with the AAF Single sign-on button (shown below).
Follow the AAF login process for your organisation
Unexpected error
If you encounter the following error, refresh the page 2-3 times. The login should progress
If the error remains after multiple refreshes, contact support.
Step 3
After the AAF sign-in, you should be redirected back to XNAT (Example below)
There will be no projects listed when signing in for the first-time, as your user account would have just been created.
Proceed to to next section for setting up an XNAT project
Creating XNAT project
For UQ users, XNAT uses UQ-RDM HPC collections for storage allocation.
For any general questions about UQ-RDM, please refer to the library guides
Note
Only one member of the project team needs to request for the projectStep 1
Before creating an XNAT project, you’ll require a UQ-RDM HPC Collection
- HPC collections ends with -Q and a 4-digit numerical identifier (e.g. PROJ001-Q0189)
- Non-HPC collections end with -A (e.g. PROJ001-A0189) or -I (PROJ001-I0189)
If you have an existing UQ-RDM HPC collection (ending with -Qxxxx), skip to the next step
To create a new UQ-RDM HPC Collection, proceed with the following
Open https://rdm.uq.edu.au/create-record and sign-in
Fill in the record as per your project details
Important
For (6) Data Storage Options, select the second option (The project data needs to be mounted on UQ HPC facilities.)
Any other option will be incompatible with XNAT, requiring a new RDM request
REQUEST DATA STORAGE when complete
Move on to the next step after the RDM collection is provisioned
You should have an RDM collection name ready (e.g. PROJ001-Q0189)
Step 2
Open a ticket with RCC support
Example below (replace __________ with your details)
Subject: Create XNAT project __________
Hello RCC support +Can we create an XNAT project for RDM collection __________
Step 3
The support ticket will inform you when the project is set up.
- An XNAT project will be created with the matching name (e.g. PROJ001-Q0189)
- An xnat directory will be created in the RDM collection for storing the XNAT data files
- Please do not write or modify anything under the xnat directory
XNAT Project setup typically takes around ~24 hours from ticket submission
An automated email from XNAT will be sent through when project is ready, and your user has been added
1.1.2 - Other AAF members
Other AAF members
This guide is for users from Australian Universities and AAF member organisations, including:
- QUT, Griffith, CQU, JCU, USQ, USC
- CSIRO, Australian Universities
- AAF VHO accounts
Other AAF members usually require UQ AIS XNAT access for:
- Management of data acquisition from sites such as CAI, HIRF, TRI
- Collaborating on projects managed on UQ AIS XNAT
Full list of AAF members found here
For all other organisations, use the Non-AAF members guide
Signing into XNAT
Step 1
Open https://xnat.rcc.uq.edu.au
Note
This is the link to the UQ AIS XNAT. If you have been provided with a project specific XNAT link to use, use that one insteadStep 2
Login in with the AAF Single sign-on button (See below).
Follow the AAF login process for your organisation
Unexpected error
If you encounter the following error, refresh the page 2-3 times. The login should progress
If the error remains after multiple refreshes, contact support.
Step 3
After the AAF sign-in, you should be redirected back to XNAT (Example below)
There will be no projects listed when signing in for the first-time, as your user account would have just been created.
Accessing XNAT Project
If you are Acquiring data at HIRF, CAI or TRI
- The respective facility will organise the project creation.
- You will receive a follow up email when access has been granted
- Contact rcc-support@uq.edu.au if you have not received access within 5 working days
If you are collaborating on an existing XNAT project
- Contact the project lead to grant you access to the XNAT project
1.1.3 - Non-AAF members
Non-University, non-AAF members and other users
This is for users from non-AAF member organisations, including:
- QLD Health, TRI, QIMR, QLD Xray
Non-AAF members usually require XNAT access for:
- Management of data acquisition from sites such as CAI, HIRF, TRI
- Collaborating on projects managed on UQ-RCC XNAT
XNAT uses AAF for login. QCIF/QRIScloud can provide AAF Virtual Home (VHO) accounts for non-AAF users.
Creating an AAF VHO account
Step 1
Open a ticket with RCC support to request an AAF account
Example below (replace __________ with your details)
Subject: XNAT AAF account for project __________
Hello RCC support
+I require an AAF account to access the UQ AIS XNAT service
My details are below
Organisation: __________
Data Acquisition Site: __________
Step 2
AAF’s VHO account will return an email regarding the VHO account registration process
Step 3
After account is provisioned, continue on to the Signing into XNAT guide
Signing into XNAT
Step 1
Open https://xnat.rcc.uq.edu.au
Note
This is the link to the UQ AIS XNAT. If you have been provided with a project specific XNAT link to use, use that one insteadStep 2
Login in with the AAF Single sign-on button (See below).
Select the AAF Virtual Home option (See below) and login with your AAF VHO credentials.
-
Step 3
After the AAF sign-in, you should be redirected back to XNAT (Example below)
There will be no projects listed when signing in for the first-time, as your user account would have just been created.
Accessing XNAT Project
If you are Acquiring data at HIRF, CAI or TRI
- The respective facility will organise the project creation.
- You will receive a follow up email when access has been granted
- Contact rcc-support@uq.edu.au if you have not received access within 5 working days
If you are collaborating on an existing XNAT project
- Contact the project lead to grant you access to the XNAT project
1.1.4 - HIRF users
For users acquiring data at HIRF
Data acquired at HIRF can be sent to the UQ-RCC XNAT repository
To get started, refer to the relevant guide below:
- UQ members
- UQ Staff and Students
- Other AAF members
- QUT, Griffith, CQU, JCU, USQ, USC, Bond
- CSIRO, QCIF, Australian Universities
- Full list of AAF members found here
- Non-AAF members
- TRI, QIMR
- QLD Health, QLD Xray, Pacific Radiology
If you have any questions, contact rcc-support@uq.edu.au or HIRFAdministration@health.qld.gov.au
1.2 - Logging into XNAT
Logging into XNAT
AAF
AAF is the recommended way to sign up and login to XNAT.
If your organisation is not in the AAF list during the sign-up process, please contact the respective XNAT support for further options
If your organisation is part of the Australian Access Federation (AAF), you can use your AAF credentials to sign up. See here
For more details on the Australian Access Federation, see https://aaf.edu.au
RCC Authenticate
To use this login, you would have received an email from a UQ XNAT administrator with the login information.
Note
If you have not received an email, either use AAF or contact the respective XNAT support.
RCC Authenticate credentials are NOT your UQ or institutional username and password
1.2.1 - AAF login
Login using Australian Access Federation (AAF)
AAF is the recommended way to sign up and login to XNAT.
If your organisation is not in the AAF list during the sign-up process, please contact the respective XNAT support for further options
If your organisation is part of the Australian Access Federation (AAF), you can use your AAF credentials to sign up. Follow the steps below to sign-up/login using AAF.
- Open https://xnat.rcc.uq.edu.au
- Login in with the AAF Single sign-on button (shown below)
This will take you to your XNAT home page.
Unexpected error
If you encounter the following error, refresh the page 2-3 times. The login should progress
If the error remains after multiple refreshes, contact support.
First time users
First time users will only see publically accessible project when they login1.2.2 - RCC Authenticate
Login using RCC Authenticate
To use this login, you would have received an email from a UQ XNAT administrator with the login information.
Note
If you have not received an email, either use AAF or contact the respective XNAT support.
RCC Authenticate credentials are NOT your UQ or institutional username and password
- Login in with the RCC Authenticate button (shown below)
- You’ll be taken to a UQ RCC SERVICES (shown below)
- Enter your user name and password to sign in.
+
Step 3
After the AAF sign-in, you should be redirected back to XNAT (Example below)
There will be no projects listed when signing in for the first-time, as your user account would have just been created.
Accessing XNAT Project
If you are Acquiring data at HIRF, CAI or TRI
- The respective facility will organise the project creation.
- You will receive a follow up email when access has been granted
- Contact rcc-support@uq.edu.au if you have not received access within 5 working days
If you are collaborating on an existing XNAT project
- Contact the project lead to grant you access to the XNAT project
1.1.4 - HIRF users
For users acquiring data at HIRF
Data acquired at HIRF can be sent to the UQ-RCC XNAT repository
To get started, refer to the relevant guide below:
- UQ members
- UQ Staff and Students
- Other AAF members
- QUT, Griffith, CQU, JCU, USQ, USC, Bond
- CSIRO, QCIF, Australian Universities
- Full list of AAF members found here
- Non-AAF members
- TRI, QIMR
- QLD Health, QLD Xray, Pacific Radiology
If you have any questions, contact rcc-support@uq.edu.au or HIRFAdministration@health.qld.gov.au
1.2 - Logging into XNAT
Logging into XNAT
AAF
AAF is the recommended way to sign up and login to XNAT.
If your organisation is not in the AAF list during the sign-up process, please contact the respective XNAT support for further options
If your organisation is part of the Australian Access Federation (AAF), you can use your AAF credentials to sign up. See here
For more details on the Australian Access Federation, see https://aaf.edu.au
RCC Authenticate
To use this login, you would have received an email from a UQ XNAT administrator with the login information.
Note
If you have not received an email, either use AAF or contact the respective XNAT support.
RCC Authenticate credentials are NOT your UQ or institutional username and password
1.2.1 - AAF login
Login using Australian Access Federation (AAF)
AAF is the recommended way to sign up and login to XNAT.
If your organisation is not in the AAF list during the sign-up process, please contact the respective XNAT support for further options
If your organisation is part of the Australian Access Federation (AAF), you can use your AAF credentials to sign up. Follow the steps below to sign-up/login using AAF.
- Open https://xnat.rcc.uq.edu.au
- Login in with the AAF Single sign-on button (shown below)
This will take you to your XNAT home page.
Unexpected error
If you encounter the following error, refresh the page 2-3 times. The login should progress
If the error remains after multiple refreshes, contact support.
First time users
First time users will only see publically accessible project when they login1.2.2 - RCC Authenticate
Login using RCC Authenticate
To use this login, you would have received an email from a UQ XNAT administrator with the login information.
Note
If you have not received an email, either use AAF or contact the respective XNAT support.
RCC Authenticate credentials are NOT your UQ or institutional username and password
- Login in with the RCC Authenticate button (shown below)
- You’ll be taken to a UQ RCC SERVICES (shown below)
- Enter your user name and password to sign in. This will take you to your XNAT home page.
For first time users
Use your temporary username and temporary password to sign in.
The next screen will allow you set your permanent password
First-time user will only see publically accessible project when they login
1.2.3 - Alias tokens
Alias tokens
AAF is used for logging into the XNAT website itself.
But there are a lot of tools and services that will require a connect to the XNAT server externally
These could include
- Windows or Mac desktop clients, like XNAT Desktop
- Command line tools such as xnatpy, pyxnat, xnatutils etc
- XSYNC
All of these tools and services need a way to authenticating to your XNAT account without AAF.
An alias token is a time-limited, long, randomised username and password used for authenticating from external services, without compromising your AAF account or credentials. They can be generated and revoked easily
We’ll look at how to generate them next
Generating Alias tokens
To access the alias token Click your name on the top right of the website. This will take you to your user profile management page
Then click the “Manage Alias Tokens” option
There, you’ll find the option to “Create an Alias Token”
When you create the alias token, it will appear as a new entry
Alias tokens expire 60 days after creation @@ -18,7 +19,7 @@ Click modify, and then submit for the changes to take effect.
Just note, subject renaming can take a few minutes to take effect
1.3.3 - Sessions
Managing Scan Sessions
Sessions are divided into three types, based on modality information extracted from the DICOM metadata
- MR
- CT
- PET
The following is an example MR session
Editing Sessions
We can edit session details and metadata from the actions panel on the right
Here we can change some of the key properties of the sessions, such as
- Change session name
- Move sessions to other projects
- Move sessions to other subjects
- Create a new subject, and move session to that subject
- Fix invalid or blank session names
1.3.3.1 - Scans
Accessing individual Scans
The Scans themselves are listed at the bottom with the relevant series descriptions and other information If you hover over one of them, and click the highlighted view details button. This will open up a more details and an image preview window
Here we can also view View DICOM headers
And see the DICOM headers as shown on the right
1.3.4 - Search
Search across Projects, Subjects and Sessions
You can search across Projects, Subjects or Sessions And Sessions are broken up into MR, PET and CT
For instance, we can fill a couple of fields on the MR Sessions search -You don’t have to specify all the fields
And XNAT will provide a list of results.
1.4 - Managing Data
Managing Data
1.4.1 - Downloading Data
Downloading data from XNAT Projects
- Navigate to Scan or Session (See guide on browsing data)
- Select
Downloadfrom controls on top right. - Use the following settings for downloading dataset as zip
For further information refer to the XNAT official guide on downloading data
1.4.1.1 - Zip Download
Downloading data as Zip using the XNAT UI
The Project, Subject and Sessions page has the option to Download Images from the right hand side menu
+You don’t have to specify all the fields
And XNAT will provide a list of results.
1.4 - Managing Data
Managing Data
1.4.1 - Downloading Data
Downloading data from XNAT Projects
- Navigate to Scan or Session (See guide on browsing data)
- Select
Downloadfrom controls on top right. - Use the following settings for downloading dataset as zip
For further information refer to the XNAT official guide on downloading data
1.4.1.1 - Zip Download
Downloading data as Zip using the XNAT UI
The Project, Subject and Sessions page has the option to Download Images from the right hand side menu
Select Option 2: ZIP download
Note
Untick Simply downloaded archive structure to keep scan names in scan folders
Filter out the Session and scans from the first two columns and select Submit
1.4.1.2 - Desktop client
Downloading data using the XNAT Desktop client
The XNAT Desktop client is maintained by the XNAT development team. For information see the link below.
- XNAT Desktop client
- https://www.xnat.org/download/desktop-client/
Install client
Download and install the client for you operating system
Download images
The Project, Subject and Sessions page has the option to Download Images from the right hand side menu
Select Option 1: Download via Desktop Client
Note
Untick Simply downloaded archive structure to keep scan names in scan folders
Click Download Via App
Select a local destination folder
Download should start, and progress can be monitored
1.4.1.3 - Download Scan
Downloading induvidual Scans using the XNAT UI
Induvidual scans can be downloaded from the Sessions page
Multiple scans can be selected and downloaded using Bulk Actions
1.4.2 - Viewing Images
Viewing Images in the XNAT OHIF Viewer
XNAT OHIF Viewer
AIS XNAT instances come with the XNAT OHIF Image viewer Which is a plugin developed by the Institute for Cancer Research in London
Just note, if your publication uses the OHIF viewer, they have an article for citation. @@ -49,7 +50,7 @@
- Copy CTP/scripts/DicomServiceAnonymizer.script to CTP/scripts/dicom-anonymizer-sender.script
- Add the PROJECTID parameter to the list of parameters at the start of the file
<p t="PROJECTID">my xnat project id</p>
- Change the PatientComments element 0010,4000 to set XNAT project routing info
@always()@append(){Project:@param(@PROJECTID) Subject:@contents([0010,0010]) Session:@contents([0008,0050])}
- Review/set other parameters at the start of the file
- PROFILENAME, eg. AIS-Clinical-Site-210604
- DATEINC, eg. 0
- PROJECTNAME, SITEID, SITENAME, TRIALNAME, TRIALSPONSOR as required
- Optional: review script to check anonymisation settings are appropriate
java -jar Launcher.jar
- If the browser can’t connect, check CTP is not already running, or try changing the Server port
- Top RHS banner should show “Welcome admin”
cd dcmtk-3.6.5-win64-dynamic/bin
dcmsend localhost 25055 ../../dicom_viewer_Mrbrain/MRBRAIN.DCM
-- Use “Upload” → “Go to prearchive”
- DICOM should appear in “Receiving” status, with project id assigned from step 6
- Optional: non-admin users need to search by subject/etc
- Use Refresh to check when “Ready” or it disappears from list (as it has been routed to the project)
- Debugging: use dcm2xml from DCMTK to check anonymised dicom file under CTP/roots/FileAfterAnonymization25055
- You should see the dicom listed as subject “1737775597”
Further information
If you need a different commit of CTP-installer
git clone https://github.com/johnperry/CTP
+- Use “Upload” → “Go to prearchive”
- DICOM should appear in “Receiving” status, with project id assigned from step 6
- Optional: non-admin users need to search by subject/etc
- Use Refresh to check when “Ready” or it disappears from list (as it has been routed to the project)
- Debugging: use dcm2xml from DCMTK to check anonymised dicom file under CTP/roots/FileAfterAnonymization25055
- You should see the dicom listed as subject “1737775597”
Further information
If you need a different commit of CTP-installer
git clone https://github.com/johnperry/CTP
cd CTP/products
git checkout <commit> CTP-Installer.jar
If you need other AIS CTP config files
git clone https://github.com/Australian-Imaging-Service/configuration.git
@@ -57,9 +58,9 @@
CTP documentation links:
2.1.2 - Proxy Server Settings
Updating CTP Proxy Server Settings
If CTP uses a proxy server for internet access, you can update the CTP proxy server settings on Windows as follows
Stop the CTP Windows service
- If you already have a Services short-cut on the Windows desktop, double-click the short-cut to start Windows Services
- If not, click the Windows start button, start typing “services” and the Services App icon should appear
- Click the Services App icon to start Windows Services
- Locate the CTP service in the list of services, right-click and select Stop from the context menu
Start the CTP Launcher
- If you already have a CTP Launcher short-cut on the Windows desktop, double-click the short-cut to start the CTP Launcher
- If not, locate the CTP service in the list of services again, right-click and select Properties from the context menu
- Use the Path to executable entry to find the installation folder for CTP. It will be in the form
<install folder>\windows\CTP.exe - Open a Windows Command prompt window
- Click the Windows Start button, start typing “cmd” and the Command Prompt App icon should appear
- Click the Command Prompt App icon to start the Command Prompt
- In the Command Prompt window, enter the following commands
cd <install folder> java -jar Launcher.jar - Use the Path to executable entry to find the installation folder for CTP. It will be in the form
Navigate to the CTP Launcher Configuration tab
Use the navigation panel on the left to select Configuration -> Server -> ProxyServer -
Update the proxy server settings in the right panel as required. You can set an IP address or host name in the proxyIPAddress field
Select File -> Save from the main menu bar to save your changes
Close the CTP Launcher using the Window close button at the top right
If the following prompt appears, select No. -
-If the CTP is stopped, restart it from the Windows services menu (See below)Close the Command Prompt window
Re-Start the CTP Windows service using Windows Services
Locate the CTP service in the list of services, right-click and select Start from the context menu
Troubleshooting
- If the CTP Windows service Stop is disabled, try restarting Windows Services as administrator by right-clicking the icon and selecting Run as administrator
Further information
2.1.3 - Windows Service
Enabling CTP as a Windows Service
The CTP install.bat script uses Apache procrun. Use the following steps to enable CTP as a Windows service, including an update to use a JRE other than system default (leave out step 2 if using the system default JRE)
- Install CTP
java -jar CTP-installer.jar +Update the proxy server settings in the right panel as required. You can set an IP address or host name in the proxyIPAddress field
Select File -> Save from the main menu bar to save your changes
Close the CTP Launcher using the Window close button at the top right
If the following prompt appears, select No. +
+If the CTP is stopped, restart it from the Windows services menu (See below)Close the Command Prompt window
Re-Start the CTP Windows service using Windows Services
Locate the CTP service in the list of services, right-click and select Start from the context menu
Troubleshooting
- If the CTP Windows service Stop is disabled, try restarting Windows Services as administrator by right-clicking the icon and selecting Run as administrator
Further information
2.1.3 - Windows Service
Enabling CTP as a Windows ServiceThe CTP install.bat script uses Apache procrun. Use the following steps to enable CTP as a Windows service, including an update to use a JRE other than system default (leave out step 2 if using the system default JRE)
- Install CTP
java -jar CTP-installer.jar - To use JRE other than system default, edit
<ctp-home>/windows/install.bat. Find the –Jvm=auto, add –JavaHome entry and set both as follows--JavaHome="<jre home> " ^ --Jvm="<jre-home>\bin\server\jvm.dll" ^- ^ is needed to wrap/continue command line in batch file
- The jvm.dll location under
is the same for JRE 1.7 and 1.8 installs. Confirm this is the case for other JREs/JDKs
- Run install.bat as Administrator to create the CTP windows service
cd <ctp-home>/windows @@ -73,6 +74,4 @@ sudo update-rc.d ctpService defaults 98 02Start and stop CTP using the following commands
sudo service ctpService start sudo service ctpService stop -