Difference between revisions of "Reporting Constraints - Structural Metadata Management"

From Fusion Registry Wiki
Jump to navigation Jump to search
Line 29: Line 29:
  
 
::<small>''Figure 2 showing a constrained Reference Area Codelist in the Context of a Data Provider and Dataflow combination (Provision Agreement)''</small>
 
::<small>''Figure 2 showing a constrained Reference Area Codelist in the Context of a Data Provider and Dataflow combination (Provision Agreement)''</small>
 +
 +
== Report Constraint Wizard ==
 +
 +
The Reporting Constraint Wizard includes the first generic step for information.
 +
 +
The second step is used to define what Structures are being constrained and of the constrained structures, which Components will be included in the Constraints.  Only Components which reference a Codelist are included in the available list.  If the Constrained structure is a Data Provider, the list of Components will be derived from all the Dataflows the Data Provider has a Provision Agreement for.
 +
 +
 +
::[[File:Reporting Constraints 4.jpg‎|frameless|750px]]
 +
 +
::<small>''Figure 3 showing the Constrained Structure and selected Components to include in the Constraint''</small>
 +
 +
The third and fourth steps are to define the included and excluded values respectively.  A Component can only be defined to contain included codes or excluded Codes not both.
 +
 +
::[[File:Reporting Constraints 5.jpg‎|frameless|750px]]
 +
 +
::<small>''Figure 4 showing step 3 of the Reporting Constraint Wizard''</small>

Revision as of 04:12, 22 November 2019

Overview

Reporting Constraints are used to further restrict the allowable content of a Codelist in the context of a DSD, Dataflow, Provision Agreement, or Data Provider. Collectively these are termed as Constrainable Structures. The restrictions imposed by Reporting Constraints are taken into account when validating a dataset reported by a Data Provider. A Reporting Constraint defines restrictions against Dimensions and Attributes of a DSD which take allowable content from an enumerated list (e.g Codelist).


Reporting Constraints 1.jpg


The Codelists which can be constrained are determined from the Constrainable structures that the Reporting Constraint is referencing.

A Reporting Constraint can impose a rule on any of the available Codelists to remove any number of allowable Codes, therefore reducing the universe of the enumerated list. A Codelist is constrained by either defining which Codes in the Codelist are included (remain valid) or which codes are excluded (are not valid). An included or excluded Code may also be marked as cascade, which means any Codes which are children of that Code also inherit the rule of inclusion or exclusion.

When viewing a Reporting Constraint, the Included Cube shows which Codes remain valid for any of the Constrained Components. The excluded Cube shows which Codes are no longer valid.


Reporting Constraints 2.jpg
Figure 1 showing the view of the included Cube for a Reporting Constraint


A Constrainable Structure, such as a Provision Agreement will inherit any Reporting Constraints which are attached to lower level structures that it references. For example the Provision Agreement will inherit any Reporting Constraints against the Dataflow it uses, and the DSD that the Dataflow uses. It will also inherit any Reporting Constraints against the Data Provider it references.

The rules defined by Reporting Constraints will be enforced when performing data validation. The rules are also reflected when viewing a DSD, Dataflow, or Provision Agreement, as shown below.


Reporting Constraints 3.jpg
Figure 2 showing a constrained Reference Area Codelist in the Context of a Data Provider and Dataflow combination (Provision Agreement)

Report Constraint Wizard

The Reporting Constraint Wizard includes the first generic step for information.

The second step is used to define what Structures are being constrained and of the constrained structures, which Components will be included in the Constraints. Only Components which reference a Codelist are included in the available list. If the Constrained structure is a Data Provider, the list of Components will be derived from all the Dataflows the Data Provider has a Provision Agreement for.


Reporting Constraints 4.jpg
Figure 3 showing the Constrained Structure and selected Components to include in the Constraint

The third and fourth steps are to define the included and excluded values respectively. A Component can only be defined to contain included codes or excluded Codes not both.

Reporting Constraints 5.jpg
Figure 4 showing step 3 of the Reporting Constraint Wizard