This user guide is subject to change as development of the new BMDW data upload service is enhanced with new features. This manual is for the staging environment for organisations to upload their test XML data files. 

The explanation of error messages that you might receive in your report files will added soon.

 

Purpose

This document describes the manual upload method of an PGP encrypted XML file through the new submission platform. As part of continuous effort to streamline and enhance functionality for our registry users, BMDW have been developing the new data submission services in line with the file format transition from .Dot20 to XML. The automatic upload method via a REST API [1] will become available later as well as the corresponding manual.

 

General concepts:

File requirements:

PLEASE NOTE: A new BMDW private key has been created for uploading XML files through the new platform . The old BMDW public key is only valid for encryption of your DOT20 files.

Getting started

Accessing the BMDW Data submission platform

You can access the BMDW data submission platform through the web. You can access the web address (or URL) by entering the address: https://staging-dataupload.wmda.info/.

PLEASE NOTE: This platform is still under development. Therefore, you may notice outages, changes to your data, or even find some functions broken and giving errors. These potentially issues are either due to new functional deployments taking place or their being a bug in the software. If you do come across any bugs or defects please do report these as part of any feedback you may have by sending an email to support@bmdw.org.

The premise of giving our listing organisations access to the test site is to allow them to familiarise themselves in advance of this being deployed to production and also start to implement and test their XML files and provide us feedback on any functions that they might wish to enhance or see added to the system.

Logging in for the first time

Before you can access the data upload service, you need to be an authorized user in our system. Currently, the following users are added to the system:

All of these people will receive a welcome email from the BMDW data upload service system with instructions how they can access the 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@bmdw.org 

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 BMDW data upload service and instructions to set your password. 
  2. Click on the link and then on the 'Forgot your password?' link.
  3. Fill out your email address and click on OK. You will now receive an email with a link to reset your password. 
  4. Click on the link, choose your own password, confirm this password and click on the OK button.  
  5. Go to https://staging-dataupload.wmda.info/ to login (Figure 1) If you just have set your password, the system should return you automatically to the login page. 
  6. Within the login page you can optionally change your language by clicking on the flag just besides 'Enter login/password': 
  7. You can also save a bookmark in your browser, e.g. for the BMDW Data upload service, so that you are immediately directed to the login page rather than having to enter the URL.
  8. Enter your email address and your password.
  9. The system defaults to your personalized Workspace, where you will find your organisation Workspace and all other folders like notification and archived folder.

 

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 BMDW data upload account, please contact the WMDA office by email via support@bmdw.org  

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 Settings button next to your name on the top left side (Figure 4). This should give you a drop-down menu with 'log out'. Click on 'Log out' and you will be redirected to the login screen.

PLEASE NOTE: Do not simply close your browser; otherwise your unsaved data may be lost.

Settings button

Home

After logging in, you get the screen as shown in Figure 5. On your home page, you can perform the following functions:

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


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 encrypted XML file into your Workspace in order for BMDW to process the file, please follow the next steps:

  1. Click on the Workspace of your organisation.
  2. Within your Workspace click on the red tab with 'New' and then on the 'Upload' icon at the bottom of the drop-down menu (Figure 7). 
  3. A new screen will open where you can select your file for upload (Figure 8a).
  4. Click on the red button with 'Pick File'.
  5. A browser window will open and you can select the file on your computer you would like to upload. Click on Open.
  6. The file becomes then visible in the browser window and when it is the correct file, click on OK to upload the file to your Workspace.

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

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 PgP encrypted. If you try and upload files that are non PgP 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 select the file you wish to update/delete and click on the 'Delete' button/tab if you wish to delete file. You can also delete the file by clicking on the file with your right mouse button and select 'Delete' from the drop-down menu.
  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 move to the Archive folder. Files in the Archive folder can't be deleted. As a user you only have read/write access to your Workspace. You only have read access to the Archive and Reports folder.

Processing reports

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.

 



[1] The specification is available at https://pydio.com/en/docs/references/api/v2#!/File/uploadStream

 


 

STANDARD OPERATING PROCEDURE

 

TITLE:

Data submission protocol to BMDW

VERSION No:

0.3

DATE OF ORIGINAL ISSUE:

March 2017

REVIEW INTERVAL:

12 months (This includes the testing process of this new upload to BMDW format)

ORIGINAL PREPARED BY:

Manish Kakkar

QM REVIEWED BY:

Quality Team

AUTHORISED BY:

Chief Executive

COPY and LOCATION

Master Copy – WMDA Share – DOCxxx

Document Version History

Version

Author

Changes

0.1

Manish Kakkar

SOP generated

0.2

Beer Holties

Update (Sprint 3/4)

0.3

Jorine Koenderman

Release staging version (28-07-2017)

 0.4Manish Kakkar Updated post release to staging version (07-08-2017)