To enable Cohort Builder (CB) users must follow the steps below. If you need assistance with any of the below steps or would like more information, please speak to your Aridhia project manager.
Enable Cohort Builder by role
Users enabling Cohort Builder must decide which roles they wish to add the permission to, or if they want to create a new CB-specific role. The chosen roles can have the permission added via the ‘Roles’ tab by opening the role they wish to add the permissions to. The Cohort Builder permissions are at the bottom left of this tab:
Enable Cohort Builder by dataset
Cohort Builder needs to be enabled on a per dataset basis. A data owner who wishes to make a dataset available for Cohort Builder should navigate to the dataset they want to enable and choose the ‘Settings’ tab. They will be presented with the below pop-up that will allow them to enable Cohort Builder on the dataset:
Ensure dataset dictionaries and data tables align for cohort enabled datasets
Cohort Builder depends on the data tables and the dataset dictionaries matching . Where there is a mis-match, Cohort Builder may fail. Therefore, users should ensure that the datasets they want to enable for Cohort Builder have a well-maintained dictionary. In practice this means three things:
- Ensuring that field names match: e.g. if the field name in the dataset is ‘ParticipantID’, it should not be ‘Participant_ID’ in the dictionary
- Ensuring that data type is accurately recorded in the dictionary: e.g. integers in the dataset are labelled as such in the dictionary
- Ensuring 1:1 mapping between data table fields and dictionary fields: e.g. each field in the data table should map to a field in the dictionary and vice versa