vanderbilt-redcap / auto-dags-module

REDCap External Module that automatically creates, renames, and assigns records to DAGs based on a specified field.
MIT License
5 stars 7 forks source link

Documentation #9

Closed khassig2 closed 2 years ago

khassig2 commented 2 years ago

Auto DAGs - v1.0 Automatically creates, renames, and assigns records to Data Access Groups (DAGs) based on the value of a specified field. The value of that field becomes the name of the DAG. If the DAG already exists, then the record will be assigned to the existing DAG. An extra page is also provided for assigning the DAG for all records at once.

Note The field used to generate the DAGs should not be on a repeating instrument or an instrument of a repeating event. If the DAG field is on a repeating instrument, the record's DAG will never be set. If the field is on an instrument of a repeating event, the record's DAG will be set by the first instance of the event, and changes in subsequent instances will not change the record's DAG.

To use:

  1. Enable module
  2. Click on configure and choose a field that will trigger the Auto DAGs a. Or click on Set DAG for all records (then click ok)
  3. This will allow you to set the DAGs for the project.
  4. Once the configuration has been saved click Set DAG for all Records under external modules in the left-hand column
  5. This will allow you to verify the configuration and set the auto DAGS based on your project’s needs.
  6. You will see the changes, after clicking on DAGS in the left-hand column. a. Changes include, the name of the DAG and which users are in which group.