The Matrix Explorer provides a high-level overview of the Folders / Forms / Fields and Edit Checks associated with a particular Matrix.
The Explorer displays Folders, Forms and Fields using a pin-board metaphor with each Folder taking a vertical column of the display. Under each Folder are displayed a list of Forms contained in the Folder, with each Form appearing similar to an index card. On each Form/card is a list of the Fields within that Form.
Edit Checks may be displayed alongside the Forms to which they are related. This provides a visual representation of the relationships between Edit Checks and the Forms/Fields they rely on.
Understanding the Matrix Explorer Display¶
When Edit Checks are displayed they appear as blue rectangles between the Folder/Form/Field columns. Where a Field is used in an Edit Check in a Check Step a blue line connects the Edit Check to a blue circle at either the left or right hand side of the Field. The Edit Check will always connect to the closest blue circle connector for that Field.
A solid line indicates that the Check Step is direct to that Folder/Form/Field combination - i.e. that it does not wildcard any of the Folder/Form/Field values.
A dashed line indicates that the Check Step wilcards some element of the selector (e.g. “Any Form”, “Any Folder” or is a VariableOID only selector across any Folder/Form/Field with that VariableOID).
Hovering over an Edit Check with the mouse will show more information about that Edit Check, including its CQL definition and its Check Action types. Links from the Edit Check are also highlighted while the mouse hovers over the Edit Check.
Wildcard Check Steps can select many Fields in a Matrix and this would cause many dashed lines to be drawn which could clutter the display. To reduce this visual clutter only the first of the Fields referenced by a Wildcard is shown. i.e. If a CheckStep is by VariableOID only (Any Folder / Any Form / Any Field) and this VariableOID is used in 10 Fields in the Matrix, the dashed line is only drawn to the first of the 10 Fields. Hovering over the Edit Check will display all of these lines.
The types of Fields (i.e. their Control Types / Data Formats) are shown graphically via icons next to the Fields:
Hovering over a Field endpoint (one of the circles) will highlight all Edit Checks and Edit Check links for this Field. In addition, the names of the related Edit Checks are also shown in an information box below the Field while the mouse is hovered over it.
Selecting a Matrix¶
If the Draft has a Default Matrix set then this is shown on opening the Explorer. Typically the best overall view of a study will be provided by an “all Forms” or “PDF” Matrix - a Matrix created to contain all possible Folder/Form combinations for reporting purposes. However, a user can select any Matrix defined in the Draft from the drop-down Matrix selector.
Each time a new Matrix is selected the Explorer window will re-draw to show the selected Matrix. In addition, any Filters on Forms to display will be re-set to show all Forms in the Matrix.
Filtering the Display of Forms / Fields¶
The Explorer shows all Folders, Forms and Fields contained in the Matrix but since Matrices may be large it is possible to filter the types of Fields shown and which Forms are shown.
To Filter by Form or Field type, click the Filter icon to open the Filtering panel and select the types of Fields you wish to display and Forms to show.
Any Field/Form hidden by the Filter also hides Edit Checks related to that Form or Field.
Filtering the Display of Edit Checks¶
Edit Checks may be filtered by type: Either Form-related (i.e. Checks that only reference a single Form) or Cross-Form (Edit Checks that reference multiple Forms). Since Cross-Form checks may draw lines which clutter the display, it can be useful to exclude them when you want to focus on Edit Checks which are related to Forms.
Edit Checks may also be filtered by Action Type. Use the Action Type filter to view Edit Checks with those Action Types - for instance, only Edit Checks with OpenQuery or AddForm actions.
Panning and Zooming¶
Click-Drag (hold down left mouse button and move mouse) to pan the Explorer view left, right up or down. This will be necessary in a large Matrix to view Folders that do not fit in the current view window.
Use the mouse scroll wheel to zoom the Explorer window in and out. Double-click to zoom into a region of the view.
The Reset button at the top right of the Explorer will reset the Zoom level and image position back to the original settings.