An annotation is a special user-defined column which can be added to listings for the purpose of recording observations. It functions as an additional field to the data, although it is saved separately. A reviewer could use the Annotation feature to add a subjective assessment; for example, reviewing subjects for risk level of remaining in the trial. A listing can have up to 3 annotation columns and annotations can be added to any listing – Subjects, Queries, Issues, and any domain data or listing data created from the Mapper module.
Each annotation column takes one value per record. Because there can be up to 3 annotation columns per listing, multiple reviewers could each add their own annotation in their own column.
Note: If a user overwrites the entry in an annotation column, only the most recent entry is saved.
Once an annotation column is added, the column and its data are visible to all Data Central users, and any Data Central user can add data to the column.
Add an Annotation Column
- Click the Configure icon in a listing. The domain Settings window opens.
- In the domain Settings window, click the Annotations tab.
- Initially, click the first row to add an entry; then, click the Add Annotation icon at the top right. A maximum of 3 annotation columns can be added.
- Field Name: Enter the annotation column name in the Field Name field.
- Tooltip: Enter a tooltip that displays when a user hovers over the column name.
- Field Type: Select the field type from the drop-down, Text, Yes/No, Date, Number, Pick List - Custom, or Pick List - SQL. The field type cannot be changed after data is entered into an annotation column.
- If Pick List - Custom or Pick List - SQL are selected, click the Pencil icon.
- If Pick List - Custom was selected, enter the first Option Name.
- Click the Add Annotation icon to add another row and continue adding Option Names. The entered Option Names appear in the drop-down menu for selection.
- Click Okay to close the Edit Custom Annotation Options window.
- If Pick List - SQL is selected, enter the SQL statement to populate the picklist with a dynamic set of values.
Use the Add Token link to add the schema to the SQL statement from a list of Data Stores and Staging Areas.
The following example SQL statement provides a drop-down list of Medical History terms for selection.- Click Save to close the Edit SQL Condition window.
- If Pick List - Custom or Pick List - SQL are selected, click the Pencil icon.
- Click Save.
Edit an Annotation Column
- In the domain Settings window, click the Annotations tab.
- In the row of the annotation column, update the Field Name and / or tooltip. Field Type cannot be changed once the annotation column has data.
- Click Save.
Delete an Annotation Column
- In the domain Settings window, click the Annotations tab.
- Click the Delete icon in the row to be deleted.
- If there are no data already entered in the annotated column, a confirmation message displays.
- If a column in view contains data, a Delete Annotation window opens to confirm deletion of the annotation column and its data. Click Yes to delete the column, or Cancel to keep the column in the listing. A confirmation message displays.
- If a column is not currently in view and contains data, a message displays indicating the column cannot be deleted. Click the X in the top right to close the message.
- Click Save.