diff --git a/docs/admin-services.md b/docs/admin-services.md new file mode 100644 index 0000000..fdb56a5 --- /dev/null +++ b/docs/admin-services.md @@ -0,0 +1,55 @@ +--- +layout: article +title: Admin Services +description: Data Controller contains a number of admin-only web services, such as DB Export, Lineage Generation, and Data Catalog refresh. +--- + +# Admin Services + +Several web services have been defined to provide additional functionality outside of the user interface. These somewhat-hidden services must be called directly, using a web browser. The URL is made up of several components: + +* SERVERURL -> the domain (and port) on which your SAS server resides +* EXECUTOR -> Either `SASStoredProcess` for SAS 9, else `SASJobExecution` for Viya +* APPLOC -> The root folder location in which the Data Controller backend services were deployed +* SERVICE -> The actual Data Controller service being described. May include additional parameters. + +To illustrate the above with an example: + +https://sas.analytium.co.uk/SASJobExecution/?_program=/Public/app/dc/services/admin/exportconfig + +* `$SERVERURL` = `https://sas.analytium.co.uk` +* `$EXECUTOR` = `SASJobExecution` +* `$APPLOC` = `/Public/app/dc` +* `$SERVICE` = `services/admin/exportconfig` + +The below sections will only describe the `$SERVICE` component - you may construct this into a URL as follows: + +> $SERVERURL/$EXECUTOR?_program=$APPLOC/$SERVICE + +## Export Config + +This service will provide a zip file containing the current database configuration. This is useful for migrating to a different data controller database instance. + +EXAMPLE: +> services/admin/exportconfig + +## Export Database +Exports the data controller control library in DB specific DDL. The following URL parameters may be added: + +* &flavour= (only PGSQL supported at this time) +* &schema= (optional, if target schema is needed) + +EXAMPLES: +> services/admin/exportdb&flavour=PGSQL&schema=DC +> services/admin/exportdb&flavour=PGSQL + +## Refresh Catalog +Refreshes the Data Controller data catalog. The model is stored in SCD2 so it's a great way to track changes over time! The process can take a long time if you have a lot of tables - if a library crashes, you can exclude it from the refresh process by adding pipe-separated LIBREFs to the DCXXXX.MPE_CONFIG table (var_scope='DC_CATALOG', var_name='DC_IGNORELIBS'). + +The following params can be added: + +* &libref (optional) to run the process for just one library. + +EXAMPLES: +> services/admin/refreshcatalog +> services/admin/refreshcatalog&libref=MYLIB \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 5208bd4..6489c46 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -10,6 +10,7 @@ nav: - File Uploads: dcu-fileupload.md - Filter Mechanism: filter.md - Table Viewer: dcu-tableviewer.md + - Admin Services: admin-services.md - Configuration: - Dates / Datetimes: dcc-dates.md - Dynamic Cell Dropdown: dynamic-cell-dropdown.md @@ -25,10 +26,10 @@ nav: - Macros: macros.md - Installation: - System Requirements: dci-requirements.md - - SAS 9 Deploy: dci-deploysas9.md - SAS Viya Deploy: dci-deploysasviya.md + - SAS 9 Deploy: dci-deploysas9.md + - SAS 9 Dedicated STP: dci-stpinstance.md - Troubleshooting: dci-troubleshooting.md - - Dedicated STP: dci-stpinstance.md - Evaluation (Demo) Version: - Installation: dci-evaluation.md - Legal: