Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

ExternalDatabaseServer are not required to reference datasets you want to link/extract, these should be reference by TableInfo / Catalogue instead.

Servers can have usernames/passwords or use integrated security (windows account). Password are encrypted in the same fashion as in DataAccessCredentials.

...

Represents a collection of datasets (see Catalogue), ExtractableColumns, ExtractionFilters etc and a single ExtractableCohort for a data extraction Project. You can have multiple active ExtractionConfigurations at a time for example a Project might have two cohorts 'Cases' and 'Controls' and you would have two ExtractionConfiguration possibly containing the same datasets and filters but with different cohorts.

...

Every ExtractionInformation has an ExtractionCategory which lets you flag the sensitivity of the data being extracted e.g. SpecialApprovalRequired. One (or more) ExtractionInformation in a Catalogue can be flagged as IsExtractionIdentifier. This is the column(s) which will be joined against cohorts in data extraction linkages.

...

Tracks the fact that a given set of Catalogues require external approval for your agency to hold.

A GovernancePeriod starts at a specific date and can optionally expire. A Catalogue can have multiple GovernancePeriods e.g. if you require to get approval from 2 different external agencies to hold a specific dataset.

...

Records how to load data into one or more Catalogues. This includes name, description, scheduled start dates etc.

...

Describes a document (e.g. PDF / Excel file etc) which is useful for understanding a given dataset (Catalogue). This can be marked as Extractable in which case every time the dataset is extracted the file will also be bundled along with it (so that researchers can also benefit from the file). You can also mark SupportingDocuments as Global in which case they will be provided (if Extractable) to researchers regardless of which datasets they have selected e.g. a PDF on data governance or a copy of an empty 'data use contract document'.

...

Describes an SQL query that can be run to generate useful information for the understanding of a given Catalogue.

If it is marked as Extractable then it will be bundled along with the Catalogue every time it is extracted (for this reason it is important to ensure that no PII data is returned by the query).

...