dc/docs.datacontroller.io
5
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix: update to include formats and special SAS missing numerics in the docs

Browse Source
This commit is contained in:
munja
2022-02-27 19:37:35 +00:00
parent 7acb205d81
commit bf146c2375
5 changed files with 13 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/dc-userguide.md
View File

@@ -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.
If you are also an approver you can approve this change yourself.
#### Special Missings
Data Controller supports special missing numerics, ie - a single letter or underscore. These should be submitted _without_ the leading period. The letters are not case sensitive.
#### 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.

2
docs/dcc-tables.md
View File

@@ -26,7 +26,7 @@ The libref of the table. If not pre-assigned, DC will assign it at runtime using
### DSN
The dataset (table) name as visible when assigning a direct libref connection to `LIBREF`.
The dataset (table) name as visible when assigning a direct libref connection to `LIBREF`. If the target is a format catalog, it should have a "-FC" suffice (eg `FORMATS-FC`). More info on formats [here](/formats.md).
### NUM_OF_APPROVALS_REQUIRED

15
docs/formats.md
View File

@@ -4,23 +4,20 @@ title: API
description: Viewing and Modifying SAS Formats in Data Controller
---
!!! warning
Work in Progress!
# Formats
SAS Formats are stored in Catalogs, and are used for in-memory lookup operations. Some formats are available by default, others (custom formats) are maintained seperately.
Using Data Controller to manage formats means that it will no longer be necessary to maintain 'CNTLIN' datasets seperately to the main catalog.
Using Data Controller to manage formats avoids the need to maintain 'CNTLIN' datasets seperately to the main catalog.
Formats will be presented with a new icon (`bolt`), in the same library as other tables (in both the VIEW and EDIT screens):
Formats are displayed with a special icon (`bolt`), in the same library as other tables (in both the VIEW and EDIT screens):
![formats](https://i.imgur.com/rnQOLlv.png)
Viewing a format catalog will always mean that the entire catalog is exported and displayed.
Viewing or editing a format catalog will always mean that the entire catalog is exported, before being filtered (if filters applied) and displayed. For this reason, it is recommended to split a large format catalog over several catalogs, if performance is a consideration.
Filters will be applied after the export. DDL / excel exports will apply to the export.
The usual export mechanisms can also be applied - you can downlad the DDL, or export the catalog in CSV / Excel / Datalines formats.
The MPE_TABLES for formats will need to be configured with a new LOADTYPE (FMTCATALOG) and specific CLOSE_VARS and BUSKEY values.
When adding a format to MPE_TABLES, the `DSN` should contain the format catalog name plus a `-FC` extension. The LOADTYPE should be `FORMAT_CAT` and the BUSKEY should be `FMTNAME START`. HOOK scripts can also be applied (run some DQ after an edit, or re-run a batch job after an approval).
Edits to formats will follow the regular approval process, with changes logged in MPE_AUDIT.
Just like regular table edits, all changes may also be logged in the `MPE_AUDIT` table.

BIN
docs/video/fullTableSearch.mp4 Normal file
View File

Binary file not shown.