BEING UPDATED

Introduction

There are two ways to upload data for listing in the Search & Match Service:

• manual upload (described below) and
• automatic upload where a connection is established between computer system, so called REST API. The manual for the automatic upload can be found here.
  
  

Data mentioned here is actually the encrypted files which can be files in XML or JSON format. Currently, only file in XML format is supported, when JSON format is supported, WMDA will send out an notification.

If the data is received, it will be processed,  and accepted data will be available for Search & Match. Search coordinators and transplant physicians who use the Search & Match Service will be able to search using , and is also used for Match-Connect service.

For the API usage, it is a technical work instruction, feel free to contact us if you need any support or if you do not understand the work instruction clearly. Our e-mail address is: support@wmda.info

The service is called  Data Manager before, and now changed to Data Manager.

Definitions

Purpose

This work instruction describes the manual upload method of an PGP/GPG encrypted XML file through the web application Data Manager.

General concepts:

• Only organisations that have an ION (listing organisations) will be able to upload, ION can be requested before you can list in WMDA DataManager Service.
• User must login the web application with MFA, and please follow WMDA MFA user guide to set it up.
• The platform is organised in so called 'Workspaces'. This Workspace is a private space for each organisation where files can be uploaded and processing reports become available.
• If your organisation submits data on behalf of other registries/CBBs then as an uploading organisation you will only see one Workspace where you can upload files for other registry(ies) that you are affiliated with.
• Uploaded files should follow the XML guidelines as described in the Data submission information, and JSON format in the page  TBC. JSON format will be supported from data schema version 2.4.
  
  

File requirements:

• Files must following the file naming rules as described in the Search & Match Service Data submission information
• Only files with the .pgp and .gpg extension will be accepted for upload.
• XML files should be encrypted with a public key (How to encrypt a file can be found here)
• XML files larger than 800Mb is rejected. If your file reach this limitation, contact support team at support@wmda.info. 

Getting started

Data Manager Service URLs

We have 2 variants of the data submission platform :

• sandbox: https://sandbox-datamanager.wmda.info : here organisations can upload their data for testing purposes and check their dataquality, before moving to production.
• production: https://datamanager.wmda.info : here production data is uploaded, which is permitted only after QA inspection by WMDA.

Setup MFA to get access for Data Manager

Before you can access the  Data Manager service, you need to be an authorized user in our system. After you get permission to list data in WMDA Data Manager service,

If you are not a current user and would like to have access to upload your test XML file, please send us an email to support@wmda.info

To access the system for the first time

1. As a new user, you should have received a welcome email that includes a link to the Data Manager service and instructions to set your credential with MFA. Information related to MFA and reset your MFA, please go to the user guide for MFA  for WMDA services.
2. To access the sandbox system to test your files, please go to https://sanbox-datamanager.wmda.info/ to login (Figure 1) If you just have set your password, the system should return you automatically to the login page. 
3. Within the login page you can optionally change your language by clicking on the flag just besides 'Enter login/password': 
4. You can also save a bookmark in your browser, e.g. for the  Data Manager service, so that you are immediately directed to the login page rather than having to enter the URL.
5. After login with MFA, the system defaults to your personalized Workspace, where you will find your organisation Workspace and all the folders you need. 
   
   

Change password or forgot password

Forgot password:

1. Click on the 'Forgot your password?' link and fill out your email address on the password reset page (Figure 2) and click on the 'OK' button. You will then receive an email with a link to reset your password.
2. Click on the link and choose your own password, confirm this password and click on the OK button. 

Forgot registered email address: If you might have forgotten your e-mail address that was registered for your  Data Manager account, please contact the WMDA office by email via support@wmda.info

Change password: You can also change your password after you logged into the system.

1. To do this, click on your home page on the settings button. 
2. A drop-down menu will appear and then click on 'My Account'. 
3. In the next window, click on the button 'change password' in the left bottom corner
4. A new smaller window will open. Fill out your old password and your new chosen password and click on OK. 

Tip: If you haven’t changed your password for a long time, we recommend that you do so to ensure that your profile is secure. We recommend that you change your password every 6 months.

If you attempt to login more than 3 times with incorrect credentials the system for security reasons will ask you to enter a code that appears in an image as shown in Figure 3b. 

Logging off from the service

To close and exit, click on the dropdown arrow next to your name on the top left side (Figure 4). This should give you a drop-down menu with 'Logout'. Click on 'Logout' and you will be get a pop-up window to pick an account to logout.  And after that you will see a notification window to mention you now safely logout.

Home

After logging in, you will get the screen based on whether you have access to one ION or multiple IONs.

If you have access to only one ION, then you will be redirect to your Workspace folders directly as show in Figure 

If you have access to multiple IONs, then you will be redirect to a home page as show in Figure

 On your home page, you can see information as below:

• Your name: On the top left corner. This is the name of the user that logged into the system
• Notification indicator: This is the bell that will highlight if you have any new notifications around the status of your uploaded file
• Setting button : This is the menu for functions like - Logout and Updating account details
• Search box: Useful when trying to find files, for example using a specific date
• My Workspace: Your own Workspace named with the ION of your organisation. In conjunction with your Workspace you also see two separate folders called Archives and Reports. For further details on the purpose of these folders please see section around Archive/Reports. 
• Recent history of submissions in the middle main pane

PLEASE NOTE: On the left hand side you can see the Workspace for your registry that you have access to. Most organisations will have access to just one space even if you are submitting data on behalf of other registries.

Setting button: when you click on the settings button, you can seen a drop-down menu (Figure 4) with

• My account: In this section you can set an avatar (picture) or your organisations logo and change your password. You can only review the Name and Email address but cant change it. If the name of email address shown within the account section is wrong please contact WMDA via email support@wmda.info so we can update those details in out CRM database.
• Share and About: These two functions at the moment aren't developed so please refrain from using this.
• Log out: Exit system

 

Workspace: Within your Workspace you can find the list of uploaded files

When you login for the first time, the Workspace will be empty (Figure 6).

Once you have used your Workspace to upload file(s), a new block will appear with your latest "Workspace activity" on the right hand menu. This menu shows the processes that your files have been through and also at what stage of the processing procedure the file is.

Upload a file

If you wish to upload a new PGP/GPG encrypted XML file into your Workspace to be processed, please follow the next steps:

1. Click on the Upload folder of your organisation/correct ION.
2. Within the Upload folder click on icon "Upload file" at right upper corner in the file list area. And a window to guide to upload a file will pop-up (Figure 7). 
3. Option to select a file:
   1). Click on button "Pick file" and a browser window will open and you can select the file on your computer.
   2). You can also select a file by dragging  and dropping the file in the proper area.
4. After a file is selected,  then the selected file will be listed, and the "Upload" button will become available. (Figure 8a).
5. Confirm the file selected is the correct file based on the name. 
6. Click on button Upload.
7. The file then uploaded and becomes visible in the file list area in the Upload folder. If the file is big, it may take some time to upload.

After a file is uploaded completed to the Upload folder, then it can be picked up.  After the An alternative method to upload your file to your Workspace is by dragging your file from your desktop to the main middle pane of your Workspace

•  Once the upload of the file is completed, you receive a message.
• The file is now ready to be picked-up by the Search & Match Service for further processing. When the file is picked-up by the processing pipeline, a copy of the file is stored in your archives folder. All messages concerning the processing of your file can be found in the Reports folder. The copy of the file and the file with messages have a filename related to the name of the original file in combination with the upload time and user

PLEASE NOTE: The time to upload your file to the system depends on the file size and your internet upload speed.

You are only allowed to upload files that are encrypted. If you try and upload files that are non PgP/GpG encrypted the system will give you an upload error as shown in figure 8b.

Manage/Update existing uploaded files 

After uploading your file, you can still delete the file if it hasn't picked-up by the processing pipeline. . Once the file is picked-up, you cannot delete the file anymore or cancel the processing. The system will check for new files every 10 minutes. Therefore, the time that you have left to delete the file can vary.

1. Within your Workspace go to the file you wish to update/delete and click on the 'Delete' button at the end of the file (Figure 9). 
2. The system will warn you to ensure if you really want to delete this file (Figure 9).
3. If you click OK, the file is deleted and will no longer be processed.
   
   

PLEASE NOTE: Once the file has been added to the processing pipeline service the file will then be moved to the Processing folder. As a user you only have read access to all other folders except Upload folder.

Processing folder

This folder contains the files are picked up for processing. 

Processed folder

This folder contains all the files are processed and accepted by the Data Manager Service.

Rejected folder

Archive folder

This folder contains all of the files that have moved to the pipeline for processing. There is a 10 minutes lag before a file that's been uploaded onto your workspace is picked by the pipeline for processing.  Files in the Archive folder can't be deleted. You only have read access to the Archive folder. The file name is changed to indicate the date/time the file was placed in this folder for processing.

PLEASE NOTE: These files are deleted from the folder after 6 months of them being processed. There associated reports too will be deleted from the report folder. 

Report folder

This folder has all of the processed report outcomes of the uploaded file. Once the processing pipeline picked-up the file, it will start with initial validations in a sequence. The sequence is: Decrypting the file > Unzipping the file > XML file structure validation > Data content validation > HLA validation. Only once all of these validations have been completed, the system will provide all the users from the organisation a notification and a report that will indicate the outcome of the file processing. Processing messages are generated and stored in a file in your Reports folder. All messages are collected in one file for each file you uploaded to the system. This is clearly indicated using the same file name with the date/time stamp so users can easily identify the file the report relates to. 

PLEASE NOTE: Just like the Archive folder you only have read access to this folder. Also all reports are deleted after 6 months of them being placed in this folder.

Processing report messages

Below are the list of messages that users can expect and the reasons for these messages

Whilst the uploaded files are being processed users should be reported for the following stages

• Uploaded file successfully - This is a message that users get as part of the standard file upload successfully. Please see section upload a file as part of uploading your file.
• Uploaded file is picked up by pipeline for processing 
• Uploaded file processed and report available by the pipeline

Users should be reported for the following scenarios on file level validations