Skip to content

Commit 82fa1a5

Browse files
aswinnarayananaswinnarayanan
committed
deploy: 654387f 
1 parent 71a1a91 commit 82fa1a5

4 files changed

Lines changed: 4 additions & 4 deletions

File tree

‎_print/docs/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Could you please create a new XNAT project for RDM collection `+t.value.trim()+`?
66
77
Thank you`}t.addEventListener("input",function(){var e=t.value.trim();e?(a.textContent=s(),r.textContent=o(),c.href="mailto:rcc-support@uq.edu.au?subject="+encodeURIComponent(s())+"&body="+encodeURIComponent(o()+`
8-
`),n.style.display="block"):n.style.display="none"});function i(e,t){navigator.clipboard.writeText(t).then(function(){var t=e.textContent;e.textContent="Copied!",setTimeout(function(){e.textContent=t},2e3)})}document.getElementById("copy-subject-"+e).addEventListener("click",function(){i(this,s())}),document.getElementById("copy-body-"+e).addEventListener("click",function(){i(this,o())}),n.querySelector("[data-copy]").addEventListener("click",function(){i(this,this.getAttribute("data-copy"))})})()</script><h4 id=step-3-1>Step 3</h4><p>The support ticket will inform you when the project is set up.</p><ul><li>An XNAT project will be created with the matching name (e.g. <strong>PROJ001-Q0189</strong>)</li><li>An <strong>xnat</strong> directory will be created in the RDM collection for storing the XNAT data files</li><li>Please do not write or modify anything under the <strong>xnat</strong> directory</li></ul><p>XNAT Project setup typically takes around ~24 hours from ticket submission<br>An automated email from XNAT will be sent through when project is ready, and your user has been added</p></div><div class=td-content style=page-break-before:always><h1 id=pg-c12350d0fe6d96d6361b5bd2b2938a0a>1.1.2 - Other AAF members</h1><div class=lead>Other AAF members</div><p>This guide is for users from Australian Universities and AAF member organisations, including:</p><ul><li>QUT, Griffith, CQU, JCU, USQ, USC</li><li>CSIRO, Australian Universities</li><li>AAF VHO accounts</li></ul><p>Other AAF members usually require UQ AIS XNAT access for:</p><ul><li>Management of data acquisition from sites such as CAI, HIRF, TRI</li><li>Collaborating on projects managed on UQ AIS XNAT</li></ul><p>Full list of AAF members found <a href=https://aaf.edu.au/subscribers>here</a><br>For all other organisations, use the <a href=https://docs.xnat.rcc.uq.edu.au/docs/user-guides/getting-started/non-aaf-members/>Non-AAF members</a> guide</p><h2 id=signing-into-xnat>Signing into XNAT</h2><hr><h4 id=step-1>Step 1</h4><p>Open <a href=https://xnat.rcc.uq.edu.au>https://xnat.rcc.uq.edu.au</a><div class="alert alert-warning" role=alert><h4 class=alert-heading>Note</h4>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 instead</div></p><h4 id=step-2>Step 2</h4><p>Login in with the AAF Single sign-on button (<em>See below</em>).</p><p>Follow the AAF login process for your organisation</p><p><img src=https://docs.xnat.rcc.uq.edu.au/docs/user-guides/logging-into-xnat/xnat-aaf-login-page.png width=100% style="border:1px solid #ddd"></img></p><h4 id=step-3>Step 3</h4><p>After the AAF sign-in, you should be redirected back to XNAT (<em>Example below</em>)</p><p>There will be <strong>no projects listed</strong> when signing in for the first-time, as your user account would have just been created.</p><p><img src=https://docs.xnat.rcc.uq.edu.au/docs/user-guides/getting-started/xnat-signed-in.png width=100% style="border:1px solid #ddd"></img></p><h2 id=accessing-xnat-project>Accessing XNAT Project</h2><hr><h4 id=if-you-are-acquiring-data-at-hirf-cai-or-tri>If you are Acquiring data at HIRF, CAI or TRI</h4><ul><li>The respective facility will organise the project creation.</li><li>You will receive a follow up email when access has been granted</li><li>Contact <a href=mailto:rcc-support@uq.edu.au>rcc-support@uq.edu.au</a> if you have not received access within 5 working days</li></ul><h4 id=if-you-are-collaborating-on-an-existing-xnat-project>If you are collaborating on an existing XNAT project</h4><ul><li>Contact the project lead to grant you access to the XNAT project</li></ul></div><div class=td-content style=page-break-before:always><h1 id=pg-c70179caf15c824a566e2e3f54ae0e6b>1.1.3 - Non-AAF members</h1><div class=lead>Non-University, non-AAF members and other users</div><p>This is for users from non-AAF member organisations, including:</p><ul><li>QLD Health, TRI, QIMR, QLD Xray</li></ul><p>Non-AAF members usually require XNAT access for:</p><ul><li>Management of data acquisition from sites such as CAI, HIRF, TRI</li><li>Collaborating on projects managed on UQ-RCC XNAT</li></ul><p>XNAT uses AAF for login. QCIF/QRIScloud can provide AAF Virtual Home (VHO) accounts for non-AAF users.</p><h2 id=creating-an-aaf-vho-account>Creating an AAF VHO account</h2><hr><h4 id=step-1>Step 1</h4><p>Open a ticket with RCC support to request an AAF account</p><p><em>Example below (replace __________ with your details)</em></p><div class="td-card card border me-4"><div class=card-header><strong>To:</strong> <a href=mailto:rcc-support@uq.edu.au>rcc-support@uq.edu.au</a></div><div class=card-body><h6 class="card-title ms-2 text-body-secondary"><strong>Subject:</strong> XNAT AAF account for project __________</h6><p class=card-text>Hello RCC support
8+
`),n.style.display="block"):n.style.display="none"});function i(e,t){navigator.clipboard.writeText(t)}document.getElementById("copy-subject-"+e).addEventListener("click",function(){i(this,s())}),document.getElementById("copy-body-"+e).addEventListener("click",function(){i(this,o())}),n.querySelector("[data-copy]").addEventListener("click",function(){i(this,this.getAttribute("data-copy"))})})()</script><h4 id=step-3-1>Step 3</h4><p>The support ticket will inform you when the project is set up.</p><ul><li>An XNAT project will be created with the matching name (e.g. <strong>PROJ001-Q0189</strong>)</li><li>An <strong>xnat</strong> directory will be created in the RDM collection for storing the XNAT data files</li><li>Please do not write or modify anything under the <strong>xnat</strong> directory</li></ul><p>XNAT Project setup typically takes around ~24 hours from ticket submission<br>An automated email from XNAT will be sent through when project is ready, and your user has been added</p></div><div class=td-content style=page-break-before:always><h1 id=pg-c12350d0fe6d96d6361b5bd2b2938a0a>1.1.2 - Other AAF members</h1><div class=lead>Other AAF members</div><p>This guide is for users from Australian Universities and AAF member organisations, including:</p><ul><li>QUT, Griffith, CQU, JCU, USQ, USC</li><li>CSIRO, Australian Universities</li><li>AAF VHO accounts</li></ul><p>Other AAF members usually require UQ AIS XNAT access for:</p><ul><li>Management of data acquisition from sites such as CAI, HIRF, TRI</li><li>Collaborating on projects managed on UQ AIS XNAT</li></ul><p>Full list of AAF members found <a href=https://aaf.edu.au/subscribers>here</a><br>For all other organisations, use the <a href=https://docs.xnat.rcc.uq.edu.au/docs/user-guides/getting-started/non-aaf-members/>Non-AAF members</a> guide</p><h2 id=signing-into-xnat>Signing into XNAT</h2><hr><h4 id=step-1>Step 1</h4><p>Open <a href=https://xnat.rcc.uq.edu.au>https://xnat.rcc.uq.edu.au</a><div class="alert alert-warning" role=alert><h4 class=alert-heading>Note</h4>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 instead</div></p><h4 id=step-2>Step 2</h4><p>Login in with the AAF Single sign-on button (<em>See below</em>).</p><p>Follow the AAF login process for your organisation</p><p><img src=https://docs.xnat.rcc.uq.edu.au/docs/user-guides/logging-into-xnat/xnat-aaf-login-page.png width=100% style="border:1px solid #ddd"></img></p><h4 id=step-3>Step 3</h4><p>After the AAF sign-in, you should be redirected back to XNAT (<em>Example below</em>)</p><p>There will be <strong>no projects listed</strong> when signing in for the first-time, as your user account would have just been created.</p><p><img src=https://docs.xnat.rcc.uq.edu.au/docs/user-guides/getting-started/xnat-signed-in.png width=100% style="border:1px solid #ddd"></img></p><h2 id=accessing-xnat-project>Accessing XNAT Project</h2><hr><h4 id=if-you-are-acquiring-data-at-hirf-cai-or-tri>If you are Acquiring data at HIRF, CAI or TRI</h4><ul><li>The respective facility will organise the project creation.</li><li>You will receive a follow up email when access has been granted</li><li>Contact <a href=mailto:rcc-support@uq.edu.au>rcc-support@uq.edu.au</a> if you have not received access within 5 working days</li></ul><h4 id=if-you-are-collaborating-on-an-existing-xnat-project>If you are collaborating on an existing XNAT project</h4><ul><li>Contact the project lead to grant you access to the XNAT project</li></ul></div><div class=td-content style=page-break-before:always><h1 id=pg-c70179caf15c824a566e2e3f54ae0e6b>1.1.3 - Non-AAF members</h1><div class=lead>Non-University, non-AAF members and other users</div><p>This is for users from non-AAF member organisations, including:</p><ul><li>QLD Health, TRI, QIMR, QLD Xray</li></ul><p>Non-AAF members usually require XNAT access for:</p><ul><li>Management of data acquisition from sites such as CAI, HIRF, TRI</li><li>Collaborating on projects managed on UQ-RCC XNAT</li></ul><p>XNAT uses AAF for login. QCIF/QRIScloud can provide AAF Virtual Home (VHO) accounts for non-AAF users.</p><h2 id=creating-an-aaf-vho-account>Creating an AAF VHO account</h2><hr><h4 id=step-1>Step 1</h4><p>Open a ticket with RCC support to request an AAF account</p><p><em>Example below (replace __________ with your details)</em></p><div class="td-card card border me-4"><div class=card-header><strong>To:</strong> <a href=mailto:rcc-support@uq.edu.au>rcc-support@uq.edu.au</a></div><div class=card-body><h6 class="card-title ms-2 text-body-secondary"><strong>Subject:</strong> XNAT AAF account for project __________</h6><p class=card-text>Hello RCC support
99
I require an AAF account to access the UQ AIS XNAT service<br>My details are below<br>Organisation: __________<br>Data Acquisition Site: __________<br></p></div></div><h4 id=step-2>Step 2</h4><p>AAF&rsquo;s VHO account will return an email regarding the VHO account registration process</p><h4 id=step-3>Step 3</h4><p><em>After account is provisioned, continue on to the <a href=https://docs.xnat.rcc.uq.edu.au/docs/user-guides/getting-started/non-aaf-members/#signing-into-xnat>Signing into XNAT guide</a></em></p><h2 id=signing-into-xnat>Signing into XNAT</h2><hr><h4 id=step-1-1>Step 1</h4><p>Open <a href=https://xnat.rcc.uq.edu.au>https://xnat.rcc.uq.edu.au</a></p><div class="alert alert-warning" role=alert><h4 class=alert-heading>Note</h4>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 instead</div><h4 id=step-2-1>Step 2</h4><p>Login in with the AAF Single sign-on button (<em>See below</em>).</p><p><img src=https://docs.xnat.rcc.uq.edu.au/docs/user-guides/logging-into-xnat/xnat-aaf-login-page.png width=100% style="border:1px solid #ddd"></img></p><p>Select the <strong>AAF Virtual Home</strong> option (<em>See below</em>) and login with your AAF VHO credentials.</p><p><img src=https://docs.xnat.rcc.uq.edu.au/docs/user-guides/logging-into-xnat/aaf-virtual-home-login.png width=50% style="border:1px solid #ddd"></img>
1010
<i class="fa-solid fa-arrow-right fa-xl" style=color:#000></i>
1111
<img src=https://docs.xnat.rcc.uq.edu.au/docs/user-guides/logging-into-xnat/aaf-vho-signin.png width=25% style="border:1px solid #ddd"></img></p><h4 id=step-3-1>Step 3</h4><p>After the AAF sign-in, you should be redirected back to XNAT (<em>Example below</em>)</p><p>There will be <strong>no projects listed</strong> when signing in for the first-time, as your user account would have just been created.</p><p><img src=https://docs.xnat.rcc.uq.edu.au/docs/user-guides/getting-started/xnat-signed-in.png width=100% style="border:1px solid #ddd"></img></p><h2 id=accessing-xnat-project>Accessing XNAT Project</h2><hr><h4 id=if-you-are-acquiring-data-at-hirf-cai-or-tri>If you are Acquiring data at HIRF, CAI or TRI</h4><ul><li>The respective facility will organise the project creation.</li><li>You will receive a follow up email when access has been granted</li><li>Contact <a href=mailto:rcc-support@uq.edu.au>rcc-support@uq.edu.au</a> if you have not received access within 5 working days</li></ul><h4 id=if-you-are-collaborating-on-an-existing-xnat-project>If you are collaborating on an existing XNAT project</h4><ul><li>Contact the project lead to grant you access to the XNAT project</li></ul></div><div class=td-content style=page-break-before:always><h1 id=pg-44bf775b57710be569f71452e7fcf2cc>1.1.4 - HIRF users</h1><div class=lead>For users acquiring data at HIRF</div><p>Data acquired at HIRF can be sent to the UQ-RCC XNAT repository</p><p>To get started, refer to the relevant guide below:</p><ul><li><a href=https://docs.xnat.rcc.uq.edu.au/docs/user-guides/getting-started/uq-members/>UQ members</a><ul><li>UQ Staff and Students</li></ul></li><li><a href=https://docs.xnat.rcc.uq.edu.au/docs/user-guides/getting-started/other-aaf-members/>Other AAF members</a><ul><li>QUT, Griffith, CQU, JCU, USQ, USC, Bond</li><li>CSIRO, QCIF, Australian Universities</li><li>Full list of AAF members found <a href=https://aaf.edu.au/subscribers>here</a></li></ul></li><li><a href=https://docs.xnat.rcc.uq.edu.au/docs/user-guides/getting-started/non-aaf-members/>Non-AAF members</a><ul><li>TRI, QIMR</li><li>QLD Health, QLD Xray, Pacific Radiology</li></ul></li></ul><div class="alert alert-warning" role=alert>If you have multiple valid affiliations, we&rsquo;d recommend using <a href=https://docs.xnat.rcc.uq.edu.au/docs/user-guides/getting-started/uq-members/>UQ</a> or <a href=https://docs.xnat.rcc.uq.edu.au/docs/user-guides/getting-started/other-aaf-members/>AAF</a> affiliation where possible</div><p>If you have any questions, contact <a href=mailto:rcc-support@uq.edu.au>rcc-support@uq.edu.au</a> or <a href=mailto:HIRFAdministration@health.qld.gov.au>HIRFAdministration@health.qld.gov.au</a></p></div><div class=td-content style=page-break-before:always><h1 id=pg-9cdedf32f71895047e614c8ad7dfce98>1.2 - Logging into XNAT</h1><div class=lead>Logging into XNAT</div><h2 id=aaf><a href=https://docs.xnat.rcc.uq.edu.au/docs/user-guides/logging-into-xnat/aaf-login/>AAF</a></h2><div class="alert alert-primary" role=alert><p>AAF is the recommended way to sign up and login to XNAT.</p><p>If your organisation is not in the AAF list during the sign-up process, please contact the respective XNAT support for further options</p></div><p>If your organisation is part of the Australian Access Federation (AAF), you can use your AAF credentials to sign up. See <a href=https://docs.xnat.rcc.uq.edu.au/docs/user-guides/logging-into-xnat/aaf-login/>here</a></p><p>For more details on the Australian Access Federation, see <a href=https://aaf.edu.au>https://aaf.edu.au</a></p><h2 id=rcc-authenticate><a href=rcc-login>RCC Authenticate</a></h2><p>To use this login, you would have received an email from a UQ XNAT administrator with the login information.</p><div class="alert alert-warning" role=alert><h4 class=alert-heading>Note</h4><p>If you have not received an email, either use <a href=../aaf-login>AAF</a> or contact the respective XNAT support.<br></p><p>RCC Authenticate credentials are <strong>NOT</strong> your UQ or institutional username and password</p></div></div><div class=td-content style=page-break-before:always><h1 id=pg-5fb860a27f2d6d80753a84588a09fed5>1.2.1 - AAF login</h1><div class=lead>Login using Australian Access Federation (AAF)</div><div class="alert alert-primary" role=alert><p>AAF is the recommended way to sign up and login to XNAT.</p><p>If your organisation is not in the AAF list during the sign-up process, please contact the respective XNAT support for further options</p></div><p>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.</p><ol><li>Open <a href=https://xnat.rcc.uq.edu.au>https://xnat.rcc.uq.edu.au</a></li><li>Login in with the AAF Single sign-on button (shown below)</li></ol><p><img src=../xnat-aaf-login-page.png width=100% style="border:1px solid #ddd"></img></p><p>This will take you to your XNAT home page.</p><div class="alert alert-warning" role=alert><h4 class=alert-heading>First time users</h4>First time users will only see publically accessible project when they login</div></div><div class=td-content style=page-break-before:always><h1 id=pg-24b7273250ba1f4425b753393b365ba0>1.2.2 - Alias tokens</h1><div class=lead>Alias tokens</div><p>AAF is used for logging into the XNAT website itself.</p><p>But there are a lot of tools and services that will require a connect to the XNAT server externally</p><p>These could include</p><ul><li>Windows or Mac desktop clients, like XNAT Desktop</li><li>Command line tools such as xnatpy, pyxnat, xnatutils etc</li><li>XSYNC</li></ul><p>All of these tools and services need a way to authenticating to your XNAT account without AAF.</p><p>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</p><p><img src=alias-tokens-1.png width=50% style="border:1px solid #ddd"></img></p><p>We’ll look at how to generate them next</p><h2 id=generating-alias-tokens>Generating Alias tokens</h2><p>To access the alias token

0 commit comments

Comments
 (0)