From af4d495b62d0a5f8b3a09f5f239deda3ef3dcd46 Mon Sep 17 00:00:00 2001 From: Allan Bowe <> Date: Sun, 27 Jan 2019 00:25:21 +0100 Subject: [PATCH] doc: adding system requirements --- docs/dcc-tables.md | 2 +- docs/dci-backend.md | 2 +- docs/dci-requirements.md | 14 ++++++++++++++ mkdocs.yml | 1 + 4 files changed, 17 insertions(+), 2 deletions(-) create mode 100644 docs/dci-requirements.md diff --git a/docs/dcc-tables.md b/docs/dcc-tables.md index 8bd89ac..e444377 100644 --- a/docs/dcc-tables.md +++ b/docs/dcc-tables.md @@ -59,7 +59,7 @@ The full path / location (unquoted) of a SAS program that will be `%inc`'d prior Leave blank if not required. ### POST_EDIT_HOOK -The full path / location (unquoted) of a SAS program that will be `%inc`'d after an edit has been made. This modifies the CSV that is created in the staging area, and can be useful for augmenting data / applying complex DQ fixes. +The full path / location (unquoted) of a SAS program that will be `%inc`'d after an edit has been made. This program can modify the dataset (`work.staging&x`) that is created in the staging area, which is useful for augmenting data / applying complex DQ rules. If your DQ check means that the program should not be submitted, then simply exit with `syscc > 4` . Leave blank if not required. ### PRE_APPROVE_HOOK diff --git a/docs/dci-backend.md b/docs/dci-backend.md index 3d25f61..8e9241d 100644 --- a/docs/dci-backend.md +++ b/docs/dci-backend.md @@ -17,7 +17,7 @@ The backend for Data Controller consists of a set of Stored Processes, a macro l * `dc_admin_group` - enter the name of a metadata group (eg SASAdministrators) that should be given unrestricted access to the tool * `dc_libref` - if you were unable to use the `DATACTRL` libref in step 3, then use the updated libref here -5 - Deploy the data model. For this, simply compile and run the `mpe_build()` macro. +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. !!! note Make sure the SAS Spawned Server account (eg `sassrv`) can access these tables! diff --git a/docs/dci-requirements.md b/docs/dci-requirements.md new file mode 100644 index 0000000..1b2d138 --- /dev/null +++ b/docs/dci-requirements.md @@ -0,0 +1,14 @@ +# Data Controller for SASĀ® - System Requirements + +## Overview +The Data Controller is a SAS Stored Process Web Application, deployed into an existing SAS platform, and as such has no special requirements beyond what is typically available in a SAS Foundation environment. + +## Backend +A SAS Foundation deployment of at least 9.4M3 must be available. Earlier versions of SAS can be supported, on request. A SAS Stored Process Server must be configured, running under a system account. + +## Mid-Tier +A web server with `/SASLogon` and the SAS SPWA must be available to end users + +## Frontend +All major browsers supported, including IE11 (earlier versions of IE may not work properly). +For IE, note that [compatibility view](dci-troubleshooting#Internet Explorer - blank screen) must be disabled. \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 1350813..965ab61 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -11,6 +11,7 @@ pages: - Selectboxes: dcc-selectbox.md - Dates / Datetimes: dcc-dates.md - Installing Data Controller: + - System Requirements: dci-requirements.md - Backend: dci-backend.md - Frontend: dci-frontend.md - Troubleshooting: dci-troubleshooting.md