adding use case diagram and more detail on file upload process

docs/dc-userguide.md

@@ -10,9 +10,9 @@ The Data Controller has 5 tabs, as follows:
 * *[Approvals](#approvals)*.  This shows an approver all their outstanding approval requests.
 * *[History](#history)*.  This shows an auditor, or other interested party, what changes have been submitted for each table.
 
-## Viewer
+### Viewer
 
-### Overview
+#### Overview
 The viewer screen provides users with a raw view of underlying data.  It is only possible to view tables that have been registered in metadata.
 Advantages of using the viewer (over client tools) for browsing data include:
 
@@ -20,7 +20,7 @@ Advantages of using the viewer (over client tools) for browsing data include:
 * In the case of SAS datasets, prevent file locks from ocurring
 * Ability to quickly download a CSV / Excel / SAS Cards program for that table
 
-### Usage
+#### Usage
 Choose a library, then a table, and click view to see the first 5000 rows.
 A filter option is provided should you wish to view a different section of rows.
 
@@ -34,7 +34,7 @@ The Download button gives three options for obtaining the current view of data:
 
 Note - if the table is registered in Data Controller as being TXTEMPORAL (SCD2) then the download option will prefilter for the _current_ records and removes the valid from / valid to variables.  This makes the CSV a suitable format for subsequent DC file upload, if desired.
 
-## Editor
+### Editor
 
 The Editor screen lets users who have been pre-authorised (via the `DATACTRL.MPE_SECURITY` table) to edit a particular table.  A user selects a particular library, and table and then has 3 options:
 
@@ -51,13 +51,17 @@ New rows can be added using the right click context menu, or the 'Add Row' butto
 When ready to submit, hit the SUBMIT button and enter a reason for the change.  The owners of the data are now alerted (so long as their email addresses are in metadata) with a link to the approve screen.
 If you are also an approver you can approve this change yourself.
 
-## Submitted
+### Submitted
 This page shows a list of the changes you have submitted (that are not yet approved).
 
-## Approvals
+### Approvals
 This shows the list of changes that have been submitted to you (or your groups) for approval.
 
-## History
+### History
 View the list of changes to each table, who made the change, when, etc.
 
-## Functionality
+## Use Case Diagram
+
+There are four Actors (Viewer, Editor, Approver, Auditor) and 3 primary use cases (View Table, Edit Table, Approve Change, View Change History)
+
+<img src="/img/dcu-usecase.svg" height="350" style="border:3px solid black" >

docs/dcu-fileupload.md

@@ -14,6 +14,8 @@ The following should be considered when uploading data in this way:
  - Additional columns are ignored
  - The order of variables does not matter
  - The delimiter is extracted from the header row (so for `var1;var2;var3` the delimeter would be assumed to be a semicolon)
+ - The above assumes the delimeter is the first special character! so `var,1;var2;var3` would fail
+ - The following characters should not be used as delimeters: `"' ` (doubleqoute, quote, space)
 
 When loading dates, be aware that the data controller makes use of the `ANYDTDTE` and `ANYDTDTTME` informats.
 This means that uploaded date / datetime values should be unambiguous (eg `01FEB1942` vs `01/02/42`) to avoid confusion - as the latter could be interpreted as `02JAN2042` depending on your locale and options `YEARCUTOFF` settings.

docs/img/dcu-usecase.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:lucid="lucid" width="1278.32" height="1029.32"><g transform="translate(-11.481170898361768 -8.814504231695011)" lucid:page-tab-id="0_0"><path d="M0 0h1360v1121.26H0z" fill="#fff"/><path d="M31.48 35.8c0-2.75 2.24-5 5-5h838c2.76 0 5 2.25 5 5v38c0 2.78-2.24 5-5 5h-838c-2.76 0-5-2.22-5-5z" fill="none"/><use xlink:href="#a" transform="matrix(1,0,0,1,31.481170898361768,30.81450423169501) translate(2.01 28.444444444444446)"/><use xlink:href="#b" transform="matrix(1,0,0,1,31.481170898361768,30.81450423169501) translate(103.63962962962965 28.444444444444446)"/><use xlink:href="#c" transform="matrix(1,0,0,1,31.481170898361768,30.81450423169501) translate(359.73839506172845 28.444444444444446)"/><use xlink:href="#d" transform="matrix(1,0,0,1,31.481170898361768,30.81450423169501) translate(381.3680246913581 28.444444444444446)"/><use xlink:href="#e" transform="matrix(1,0,0,1,31.481170898361768,30.81450423169501) translate(464.2322222222223 28.444444444444446)"/><use xlink:href="#f" transform="matrix(1,0,0,1,31.481170898361768,30.81450423169501) translate(572.6766666666667 28.444444444444446)"/><path d="M30.8 78.8h1248" stroke="#999" stroke-width="2" fill="none"/><path d="M620 230.17c0 30.14-36.67 54.58-81.9 54.58-45.24 0-81.9-24.44-81.9-54.58 0-30.14 36.66-54.58 81.9-54.58 45.23 0 81.9 24.43 81.9 54.57z" stroke="#666" stroke-width="2" fill="#fff"/><use xlink:href="#g" transform="matrix(1,0,0,1,456.1952492728173,175.59298034932195) translate(31.62999999999999 59.0875)"/><use xlink:href="#h" transform="matrix(1,0,0,1,456.1952492728173,175.59298034932195) translate(93.48 59.0875)"/><path d="M188.66 285.05l266.54-54.88" stroke="#999" stroke-width="2" fill="none"/><path d="M188.86 286.03l-.2.04v-1.02zM456.2 230.17v.8l-.8.18-.4-1.96 1.23-.26z" fill="#999"/><path d="M790.6 431c0 40.47-49.9 73.28-111.46 73.28-61.56 0-111.47-32.8-111.47-73.28 0-40.47 49.9-73.28 111.47-73.28S790.6 390.52 790.6 431z" stroke="#666" stroke-width="2" fill="#c7e8ac"/><use xlink:href="#i" transform="matrix(1,0,0,1,567.6683987648347,357.72390419769886) translate(65.905 78.7125)"/><use xlink:href="#j" transform="matrix(1,0,0,1,567.6683987648347,357.72390419769886) translate(111.55499999999999 78.7125)"/><path d="M656.85 931.18c0 48.02-49.9 86.96-111.48 86.96-61.56 0-111.47-38.94-111.47-86.96 0-48.03 49.9-86.96 111.47-86.96s111.48 38.93 111.48 86.96z" stroke="#666" stroke-width="2" fill="#c7e8ac"/><use xlink:href="#k" transform="matrix(1,0,0,1,433.90061937441385,844.2171899362671) translate(69.28 90.525)"/><use xlink:href="#j" transform="matrix(1,0,0,1,433.90061937441385,844.2171899362671) translate(108.18 90.525)"/><path d="M620 683.76c0 35.22-36.67 63.77-81.9 63.77-45.24 0-81.9-28.55-81.9-63.77 0-35.2 36.66-63.76 81.9-63.76 45.23 0 81.9 28.55 81.9 63.76z" stroke="#666" stroke-width="2" fill="#fff"/><use xlink:href="#l" transform="matrix(1,0,0,1,456.1952492728173,620) translate(34.779999999999994 66.4)"/><use xlink:href="#j" transform="matrix(1,0,0,1,456.1952492728173,620) translate(83.68 66.4)"/><path d="M924.38 931.18c0 32.62-34.93 59.07-78.03 59.07s-78.03-26.45-78.03-59.07c0-32.63 34.94-59.07 78.03-59.07 43.1 0 78.03 26.45 78.03 59.08z" stroke="#666" stroke-width="2" fill="#fff"/><use xlink:href="#m" transform="matrix(1,0,0,1,768.3200678504656,872.1085949681335) translate(18.154999999999994 62.74375)"/><use xlink:href="#n" transform="matrix(1,0,0,1,768.3200678504656,872.1085949681335) translate(72.05499999999999 62.74375)"/><path d="M924.38 674.25c0 47.02-49.9 85.13-111.47 85.13-61.56 0-111.46-38.1-111.46-85.13 0-47.02 49.9-85.14 111.47-85.14s111.48 38.13 111.48 85.15z" stroke="#666" stroke-width="2" fill="#c7e8ac"/><use xlink:href="#o" transform="matrix(1,0,0,1,701.4361781552554,589.1122732271053) translate(39.70499999999999 89.2125)"/><use xlink:href="#n" transform="matrix(1,0,0,1,701.4361781552554,589.1122732271053) translate(117.50500000000001 89.2125)"/><path d="M188.66 285.05l378 145.95" stroke="#999" stroke-width="2" fill="none"/><path d="M189.02 284.12l-.36.93v-1.07zM567.68 430.32v.73l.02 1.42-1.4-.54.73-1.86z" fill="#999"/><path d="M188.66 857l244.24 74.18" stroke="#999" stroke-width="2" fill="none"/><path d="M188.95 856.03l-.3.96v-1.06zM433.92 930.44l-.02.8.03 1.3-1.32-.4.6-1.92z" fill="#999"/><path d="M924.38 240.6c0 44.5-54.7 80.6-122.2 80.6-67.47 0-122.18-36.1-122.18-80.6 0-44.5 54.7-80.6 122.2-80.6 67.48 0 122.18 36.1 122.18 80.6z" stroke="#666" stroke-width="2" fill="#c7e8ac"/><use xlink:href="#i" transform="matrix(1,0,0,1,680,160) translate(43.355 85.275)"/><use xlink:href="#p" transform="matrix(1,0,0,1,680,160) translate(89.005 85.275)"/><use xlink:href="#q" transform="matrix(1,0,0,1,680,160) translate(139.805 85.275)"/><path d="M1169.62 285.05L925.38 240.6" stroke="#999" stroke-width="2" fill="none"/><path d="M1169.62 286.07l-.18-.03.18-1zM925.56 239.62l-.36 1.96-.83-.15v-2.03z" fill="#999"/><path d="M1215.2 857L925.4 240.6M1215.2 857l1.3 2.7"Line truncated