adding use case diagram and bitemporal section to userguide
This commit is contained in:
		| @@ -20,3 +20,9 @@ There are 5 roles identified for users of the Data Controller: | |||||||
| 3. *Approver*.  An approver accepts / rejects proposed changes to data under their control. If accepted, the change is applied to the target table. | 3. *Approver*.  An approver accepts / rejects proposed changes to data under their control. If accepted, the change is applied to the target table. | ||||||
| 4. *Auditor*.  An auditor has the ability to review the [history](dc-userguide.md#history) of changes to a particular table. | 4. *Auditor*.  An auditor has the ability to review the [history](dc-userguide.md#history) of changes to a particular table. | ||||||
| 5. *Administrator*.  An administrator has the ability to add new [tables](dcc-tables.md) to the Data Controller, and to configure the security settings (at metadata group level) as required. | 5. *Administrator*.  An administrator has the ability to add new [tables](dcc-tables.md) to the Data Controller, and to configure the security settings (at metadata group level) as required. | ||||||
|  |  | ||||||
|  | ## Use Case Diagram | ||||||
|  |  | ||||||
|  | There are five roles (Viewer, Editor, Approver, Auditor, Administrator) which correspond to 5 primary use cases (View Table, Edit Table, Approve Change, View Change History, Configure Table) | ||||||
|  |  | ||||||
|  | <img src="/img/dcu-usecase.svg" height="350" style="border:3px solid black" > | ||||||
|   | |||||||
| @@ -51,6 +51,10 @@ 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. | 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. | If you are also an approver you can approve this change yourself. | ||||||
|  |  | ||||||
|  | #### BiTemporal Tables | ||||||
|  |  | ||||||
|  | The Data Controller only permits BiTemporal data uploads at a single point in time - so for convenience, when viewing data in the edit screen, only the most recent records are displayed.  To edit earlier records, either use file upload, or apply a filter. | ||||||
|  |  | ||||||
| ### Submitted | ### Submitted | ||||||
| This page shows a list of the changes you have submitted (that are not yet approved). | This page shows a list of the changes you have submitted (that are not yet approved). | ||||||
|  |  | ||||||
| @@ -60,8 +64,3 @@ This shows the list of changes that have been submitted to you (or your groups) | |||||||
| ### History | ### History | ||||||
| View the list of changes to each table, who made the change, when, etc. | View the list of changes to each table, who made the change, when, etc. | ||||||
|  |  | ||||||
| ## 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" > |  | ||||||
|   | |||||||
| @@ -1,21 +1,24 @@ | |||||||
| # Data Controller for SAS: File Uploads | # Data Controller for SAS: File Uploads | ||||||
|  |  | ||||||
| Files can be uploaded via the Editor interface - first choose the library and table, then click "Upload". | Files can be uploaded via the Editor interface - first choose the library and table, then click "Upload".  Currently only CSV files are supported, although these can be provided with non standard delimiters (such as semicolon). | ||||||
|  |  | ||||||
|  |  | ||||||
| <img src="/img/dcu-files1.png" height="350" style="border:3px solid black" > | <img src="/img/dcu-files1.png" height="350" style="border:3px solid black" > | ||||||
|  |  | ||||||
| The following should be considered when uploading data in this way: | The following should be considered when uploading data in this way: | ||||||
|  |  | ||||||
|  - A header row (with variable names) is required |  - A header row (with variable names) is required | ||||||
|  - Variable names must match the target |  - Variable names must match the target (not case sensitive).  An easy way to ensure this is to download the data from Viewer and use this as a template. | ||||||
|  - Duplicate variable names are not permitted |  - Duplicate variable names are not permitted | ||||||
|  - Missing columns are not permitted |  - Missing columns are not permitted | ||||||
|  - Additional columns are ignored |  - Additional columns are ignored | ||||||
|  - The order of variables does not matter |  - 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 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 above assumes the delimiter is the first special character! So `var,1;var2;var3` would fail | ||||||
|  - The following characters should not be used as delimeters: `"' ` (doubleqoute, quote, space) |  - The following characters should not be used as delimiters | ||||||
|  |     - doublequote | ||||||
|  |     - quote | ||||||
|  |     - space | ||||||
|  |     - underscore | ||||||
|  |  | ||||||
| When loading dates, be aware that the data controller makes use of the `ANYDTDTE` and `ANYDTDTTME` informats. | 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. | 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. | ||||||
|   | |||||||
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							| Before Width: | Height: | Size: 26 KiB After Width: | Height: | Size: 29 KiB | 
		Reference in New Issue
	
	Block a user
	 Allan Bowe
					Allan Bowe