Known issues

Visibility field on node view of metadata record

The visibility field informs logged in users who can see a metadata record. The options are:

• Public (shows public)
• Authenticated (Government of BC employees)
• Restricted (Office of primary responsibility plus whatever org is selected in field_visibility if it is not public or autnenticated)

This logic is currently in code and assumes that the term Public is used for publicly available records and the term Government of BC employees is used for authenticated users.

The problem is, if anyone ever changes any of those term labels, the functionality and style of this field will break.

If either of those terms changes, the preprocessor for the dc_theme will need to be updated to match.

A feature request has been submitted to have fields in the UI control visibility field display.

Mismatch between machine names and labels on some fields

In the early stages of the project, the asumption was made that we are working with entities called Data sets, as the project progressed, it made more sense to call the entities in the data catalogue Metadata records as the app holds metadata about data sets that reside elsewhere. When this change happened, development was too far along to change machine names. An attempt was made, however it failed. See issue #259 for details.

At the Metadata Record level:

• field_data_set_type represents the item type being catalogued

• field_data_sets_used represents the items used to build the item being catalogued

These two attributes above pertain to more than one type of item that can be catalogued (Form, Data, Report) so ideally they should not have included "data_set" in the name.

At the Data Dictionary level:

• field_column_type

• field_instance_of

• field_metadata_type

Note that these are inconsistently named. Other data dictionary machine names use the word column to differentiate them from data set fields.

Documentation search searches all books

The documentation pages are implemented using the book module. This is the only use of book on the site. The search feature for the documentation limits the search to all books. If another book is created in the future and it should not be included in the documentation search, the search will need to be updated to filter by book ID; see Instructions for creating a search_api processor.