How to Access
From the Conversions VM:
No additional setup is required to access the portal from the conversions VM.
From your local desktop:
install the Azure VPN Client found here from the Microsoft Store: Azure VPN Client - Microsoft Store Applications
Open the Azure VPN Client and import the file into it, and then on the upper left you will see the Azure VPN.
Click Connect and login with your PDDS Credentials.
Troubleshooting
If you fail to connect to the VPN with “No host found,” turn off the Umbrella Roaming Client service under Windows Services. Manually set your DNS server to one like googles at 8.8.8.8.
After connecting to the VPN, follow the link:
https://servicetool-portal-app-xvmgt-pr-cent.azurewebsites.net/
You should be prompted to sign into your Planet DDS account.
If you do NOT have permission to use the service tool, you will see the following error. If you normally have access, please navigate to Status Dashboard and then Back to Site. If you do not normally have access, please contact your manager.
Usage
The new service tool currently only supports the commit functionality but will eventually be expanded to support a few other tools such as map, purge, and isolator.
Home page
The home page is used to open other tools.
https://planetdds.atlassian.net/wiki/spaces/DIKB/pages/edit-v2/4677468356#Status-Dashboard
https://planetdds.atlassian.net/wiki/spaces/DIKB/pages/edit-v2/4677468356#Commit-Tool
Commit Tool
Click Commit under the list of tools.
A text box and submit button should appear. Type the URL for the site.
Click Submit.
A dialog will appear with a link to the job status. If a non-existent site is entered, an error will be displayed instead.
Clicking Go to job will take you to the status dashboard where you can observe the status of the job. For commits, there are three progress bars.
Queueing patients - Each patient to be committed is placed in a queue to be processed. This queueing step is separate from actually committing the changes to the DICOM file. There are two different servers. The portal queues the patients, while a separate cluster of server processes the patients on the queue.
Patient progress - This shows how many patients have been committed so far.
Instance progress - This shows how many DICOM files have been committed so far. There will be cases where Patient progress is 100% but instance progress is less than 100%. The job will complete and mark the remaining images as failure to commit. This happens for images that are moved out of the patient via Apteryx while the commit was still running.
A job may be stopped by clicking Delete on the top right-hand corner of the state log. Note that stopping a job only stops it from queuing more patients to be committed. Any patients already queued will continue to be processed.
A job may be restarted by going to either Failed or Deleted on the left-hand navigation menu. Select the job you want to restart via the checkbox, and click Requeue jobs.
You can return to this page anytime from the home page. Click Status Dashboard → Jobs → Processing and find the appropriate job. You can determine which site a job was for from the parameter list on the job.
Status Dashboard
Overview
The overview page shows history and statistics for resource usage and success rate.
You can return to this page anytime from the home page. Click Status Dashboard → Jobs.
At any time, you can return to the home page by clicking Back to site in the top right-hand corner of the page.
Jobs
Jobs are operations being performed such as a commit, map, purge, etc.
Enqueued - These jobs are waiting to be run
Scheduled - These jobs are next to run, but are not currently running
Processing - These jobs are currently running
Failed - These jobs have ended prematurely due to an error. Failed jobs may be requeued.
Deleted - These jobs have either been cancelled by the user or deleted because they are older than 365 days. Deleted jobs may be requeued.
Awaiting - These jobs are depending on another job to complete first.
Inside each job
Each job reports its current status and how long its been running. Scrolling down will also show a history of every failure or cancellation of the job.
A job may be stopped by clicking Delete on the top right-hand corner of the state log.
A job may be restarted by going to either Failed or Deleted on the left-hand navigation menu. Select the job you want to restart via the checkbox, and click Requeue jobs.
Isolator
Overview
The isolator is a tool for placing an Apteryx database onto its own set of resources so heavy load against that database does not impact other customers.
Usage
Isolations are necessary when performing
XVHost Push > 50k images
Commits consisting of 10k patients or more
Navigate to the service tool home page.
Click Database Isolations under the list of tools.
A text box and submit button should appear. Type the URL for the site.
Select a duration for isolation. Make sure you set this duration as small as feasible for the work being performed. You should NOT select the maximum duration “just in case.” Please perform the isolation just-in-time immediately before performing the work.
Click Submit.
Follow the link to Go to the isolations dashboard or select Isolations dashboard under the list of tools.
You should see the isolated site with the current status. There are two statuses.
-
Initiated - Initiated means that the process for isolation has begun, but is NOT completed.
-
Isolated - The isolation process is complete and you may safely begin work.
As of the writing of this document, the Isolations dashboard does not automatically refresh itself. Please refresh your browser manually and periodically to see the current status of the isolation.
Extending an isolation
An isolation may be extended by clicking on the calendar icon next to the isolation. Extend an isolation when you believe the work will not be completed before the isolation is set to automatically end.
Select the duration for extension and then type in the URL for the site, then click Confirm.
Ending an isolation early
An isolation may be ended early by clicking on the trash can icon next to the isolation. End an isolation early if the work is completed before the isolation is set to automatically end or if the isolation was created by mistake.
Type in the URL for the site and click Confirm.
The status of the site will transition to De-isolating. It will also display the total cost incurred for the isolation.