diff --git a/docs/dci-evaluation.md b/docs/dci-evaluation.md index 4a4c3b1..0ff41ee 100644 --- a/docs/dci-evaluation.md +++ b/docs/dci-evaluation.md @@ -3,19 +3,29 @@ ## Overview A free version of Data Controller is available for evaluation purposes. Compiled into a single SPK, it is very easy to install and configure. However it should not be used in production environments for all the reasons mentioned in the [caveats](#caveats) section. -## Deployment +## Installation -Step 1 is to import the SPK to the desired location in the metadata tree. During the import, be sure to change the location of the library (BASE engine) to a directory folder which the Stored Process system account (sassrv) has write access to. +### Deployment -Step 2 is to navigate to the [YOURHOST]/SASStoredProcess web application and 'list available stored processes'. Make sure you use the same user as before, or at least a user that has WRITE METADATA permissions on the imported Data Controller folder. Find the location where the app was imported, open the Admin subfolder, right click the 'makedata' service and open in a new window. This service will ensure logs are directed to a subfolder of the library location, and will create the necessary configuration tables in that library. +Simply import the SPK to the desired location in the metadata tree. During the import (step 5 of the wizard), be sure to change the location of the library (BASE engine) to a directory folder which the Stored Process system account (sassrv) has write access to. Also, make sure that your user account has WRITE METADATA (WM) on the imported Data Controller DATA folder, and that anyone who will use the app has READ. -## Configuration +### Configuration + +Firstly, if your SAS user acocunt is **not** in the 'SASAdministrators' group then you may need to update the settings to give your user the ability to view all tables. Using SAS Management Console, open the `makeData` stored process in the Admin folder, and change the DC_ADMIN_GROUP macro variable to a group of your choosing. + +!!! warning + Every member of the group you provide above will have UNRESTRICTED access to the tool! + + +Navigate to the [YOURHOST]/SASStoredProcess web application and 'list available stored processes'. Find the location where the app was imported, open the Admin subfolder and run the 'makedata' stored process. This service will ensure logs are directed to a subfolder of the library location, and will create the necessary configuration tables in that library. + +!!! note + A quick way to update the admin group is to simply add `&admin=YOURGROUPNAME` to the url when running the `makeData` stored process. -If your user is not in the 'Administrators' group then you may need to update the settings to give your user the ability to view all tables. Within the root of the application there is a 'dc_admin_group' property, add an appropriate metadata group here to give full access to the tool. ## Usage -Simply navigate to the imported location, right click on the 'clickme' stored process, and open in new window! +Simply navigate to the imported location from the Stored Process Web App, right click on the 'clickme' stored process, and open in new window! ## Caveats @@ -26,7 +36,7 @@ The demo version is optimised for rapid install, however it should not be consid 2) Direct URLs are not functional -3) Requires BASE engine for config tables, with risk of file locks +3) Requires BASE engine for config tables, with high risk of table locks 4) Not licenced for commercial use, and not supported diff --git a/docs/emails.md b/docs/emails.md new file mode 100644 index 0000000..e0fc633 --- /dev/null +++ b/docs/emails.md @@ -0,0 +1,31 @@ +# Data Controller for SAS® - Emails + +## Overview +Data Controller enables email alerts for users when tables are: + +* SUBMITTED - a proposed change has been submitted. +* APPROVED - the proposed change was approved and applied. +* REJECTED - the proposed change was rejected. + +Emails are sent after any post edit / post approve hooks. They can be sent when specific tables are updated, or when any tables in a particular library are updated, or for all changes to all tables. See configuration section below. + +Email addresses are looked for first in `DCXXXXXX.MPE_EMAILS`. If they are not found there, then a metadata search is made (the first email found in metadata for that user is used). + +## Setup +As not every site has emails configured, this feature is switched OFF by default. +To switch it on, navigate to `DCXXXXXX.MPE_CONFIG` and set the value for `DC_EMAIL_ALERTS` to be `YES` (uppercase). + +![alerttable](img/mpe_alertconfig.png) + +!!! tip + If your Stored Process session does not have the email options configured, then the appropriate options statement must be invoked. These options may need to be done at startup, or in the configuration file. See [documentation](https://documentation.sas.com/?cdcId=pgmsascdc&cdcVersion=9.4_3.4&docsetId=lrcon&docsetTarget=n05iwqtqxzvtvun1eyw11nrd9i9r.htm&locale=en) + +## Configuration +The `DCXXXXXX.MPE_ALERTS` table must be updated with the following attributes: + +* ALERT_EVENT - either `*ALL*`, `SUBMITTED`, `APPROVED` or `REJECTED` +* ALERT_LIB - either `*ALL*` or the libref to be alerted on +* ALERT_DS - either `*ALL*` or the dataset name to be alerted on +* ALERT_USER - the metadata name (not displayname) of the user to be alerted + +If your site does not put emails in metadata, then the user emails must instead be entered in `DCXXXXXX.MPE_EMAILS`. \ No newline at end of file diff --git a/docs/img/mpe_alertconfig.png b/docs/img/mpe_alertconfig.png new file mode 100644 index 0000000..01c907b Binary files /dev/null and b/docs/img/mpe_alertconfig.png differ diff --git a/mkdocs.yml b/mkdocs.yml index 2cfeb52..3ddf395 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -10,6 +10,7 @@ pages: - Security: dcc-security.md - Selectboxes: dcc-selectbox.md - Dates / Datetimes: dcc-dates.md + - Emails: emails.md - Installing Data Controller: - System Requirements: dci-requirements.md - Backend: dci-backend.md