docs.datacontroller.io/docs/dci-backend.md

38 lines
2.3 KiB
Markdown
Raw Normal View History

2018-07-08 16:14:56 +00:00
#Data Controller for SAS® - Backend Deployment
## Overview
2018-07-09 14:38:11 +00:00
The backend for Data Controller consists of a set of Stored Processes, a macro library, and a database. The database can be SAS Base library if desired, however this can cause contention (eg table locks) if end users are able to connect to the datasets directly, eg via Enterprise Guide or Base SAS.
2018-07-08 16:14:56 +00:00
2018-10-22 21:43:06 +00:00
## Regular Deployment
2018-07-08 16:14:56 +00:00
2018-12-30 20:30:14 +00:00
1 - Import `/sas/import.spk` using SAS Management Console. Make a note of the root location in which this was deployed - as this will be added to the `metadataRoot` value in the `h54sConfig.json` file in the [frontend](dci-frontend.md#details) deployment.
2018-07-08 16:14:56 +00:00
2018-12-30 20:30:14 +00:00
2 - Create a physical staging directory. This folder will contain the logs and CSV files generated by Users. The SAS Spawned Server account (eg `sassrv`) will need write access to this location.
2018-07-08 16:14:56 +00:00
2018-10-14 16:35:33 +00:00
3 - Register a library in metadata for the control database. The libref should be `DATACTRL`. If this is not possible, then an alternative libref can be used, simply specify it in the configuration component.
2018-07-08 16:14:56 +00:00
2018-10-14 16:35:33 +00:00
4 - Update the configuration component (imported in the SPK) with the following attributes:
2018-07-08 16:14:56 +00:00
2018-10-14 16:35:33 +00:00
* `dc_staging_area` - location of staging directory as per step 2
* `dc_admin_group` - enter the name of a metadata group (eg SASAdministrators) that should be given unrestricted access to the tool
2018-12-30 20:30:14 +00:00
* `dc_libref` - if you were unable to use the `DATACTRL` libref in step 3, then use the updated libref here
2018-07-08 16:14:56 +00:00
2019-01-26 23:25:21 +00:00
5 - Deploy the physical tables and register them in metadata. For this, simply compile and run the `mpe_build()` macro using an account with appropriate priviliges.
2018-07-08 16:14:56 +00:00
2018-10-22 21:43:06 +00:00
!!! note
Make sure the SAS Spawned Server account (eg `sassrv`) can access these tables!
2018-07-08 16:14:56 +00:00
The next step is to deploy the [frontend](dci-frontend.md).
2018-10-22 21:43:06 +00:00
## EUC Deployment
Optionally, a shared network drive can be configured to enable EUCs to temporarily stage CSVs for upload into the Data Controller review process.
For security, it is recommended to set permissions so that end users can write, but not read or modify. The SAS Spawned Server account (eg `sassrv`) will need read and modify access - as it will remove the files once they are loaded into the secure staging area.
## Deployment Diagram
An overview of how the components fit together is available below:
![deploymentdiagram](img/dci_deploymentdiagram.png)