adding dcu_flow image and updating stp instance docs

This commit is contained in:
Allan Bowe 2020-05-26 09:43:42 +02:00
parent 080b9115fa
commit 360426733a
4 changed files with 291 additions and 273 deletions

View File

@ -21,6 +21,24 @@ There are 5 roles identified for users of the Data Controller:
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.
## What is a submission?
The submission is the data that has been staged for approval. Note - submissions are never applied automatically! They must always be approved by 1 or more approvers first. The process of submission varies according to the type of submit.
### Web Submission
When using the Web editor, a frontend check is made against the subset of data that was filtered for editing to see which rows are new / modified / marked deleted. Only those changed rows (from the extract) are submitted to the staging area.
### Excel Submission
When importing an excel file, all rows are loaded into the web page. You have an option to edit those records. If you edit them, the original excel is discarded, and only changed rows are submitted (it becomes a web submission). If you hit SUBMIT immediately, then ALL rows are staged, and a copy of the excel file is uploaded for audit purposes.
### CSV submission
A CSV upload bypasses the part where the records are loaded into the web page, and ALL rows are sent to the staging area directly. This makes it suitable for larger uploads.
## Edit Stage Approve Workflow
Up to 500 rows can be edited (in the web editor) at one time. These edits are submitted to a staging area. After one or more approvals (acceptances) the changes are applied to the source table.
![screenshot](img/dcu_flow.png)
## Use Case Diagram ## 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) 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)

View File

@ -8,8 +8,31 @@ Under these circumstances, it is recommended to create a dedicated STP server in
!!! note !!! note
Data Controller only updates data (add, delete, modify records). It does not need the ability to create new (permanent) tables, or modify the structure of existing tables. Data Controller only updates data (add, delete, modify records). It does not need the ability to create new (permanent) tables, or modify the structure of existing tables.
## Set up DC account
## STP Server Configuration It is recommended to have a user for each environment in which DC is deployed, eg:
* dcsrv_dev
* dcsrv_test
* dcsrv_prod
After these OS users are created, log into SMC in relevant environment and open User Manager. Adjust as follows:
* Open SAS General Servers group
* Select Accounts tab
* Add the dcsrv_[ENV] user in DefaultAuth domain
## STP Server Configuration - 9.4
Open the SAS Deployment Wizard and deploy a new Application Context Server from the panel windows.
Be sure to use the relevant dcsrv_[env] user as configured above.
Now head to the [security](#security) section.
## STP Server Configuration - 9.3
As the wizard does not exist in 9.3 it is necessary to copy the folder structure.
### Clone existing directory ### Clone existing directory
@ -40,25 +63,6 @@ DataControllerSTPsvr
* Sasuser folder EMPTY CONTENTS (remove all files). They arent relevant in the * Sasuser folder EMPTY CONTENTS (remove all files). They arent relevant in the
data controller context. data controller context.
### Set up DC account
It is recommended to have a user for each environment in which DC is deployed, eg:
* dcsrv_dev
* dcsrv_test
* dcsrv_prod
Log into SMC in relevant environment and open User Manager. Adjust as follows:
* Open SAS General Servers group
* Select Accounts tab
* Add the dcsrv_[ENV] user in DefaultAuth domain
#### Adding new users (Windows)
Open Windows Server Manager and adjust as follows:
* Select / Configuration / Local Users and Groups / Groups
* Select Administrators group and Add the dcsrv_[Env] user
### Add Server ### Add Server

BIN
docs/img/dcu_flow.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

File diff suppressed because it is too large Load Diff