Summary
This article describes how to use the different screen and action permissions at their most basic level.
Table of Contents
- Audits
- Coding
- Comments
- Data Entry
- Fountayn DCT
- Deletion
- Difference Manager
- Dynamic Status
- Exports
- Form Flow
- Imports
- Info Mode
- Managers
- Metadata
- Miscellaneous
- Queries
- Randomization
- Standard Reports
- Study Modifications
- Subject Status
Each permission is associated with its own set of actions and screens that provides access to different aspects of the Fountayn system. This section describes how to use the different screen and action permissions at their most basic level. These screen and action permissions can be further combined when a role should have access to multiple permissions.
Note: Not all permission combinations listed below are found in the standard DataArchitect template. If different permissions are wanted other than what is found in the standard DataArchitect Role worksheet manually added a row with the desired Actions and Screen combination.
Alerts
Actions | Actions Required | Screens Required | Description | Example |
---|---|---|---|---|
alerts – view reason for override audits | viewViolationAudits | Displays Audit icon | ||
alerts – update reason for override | editViolation | viewViolationAudits | Update existing entries and displays Audit icon | |
alerts – Alert Manager | violationManager | Provides access to the Alerts Manager | Image (1) Below | |
alerts – close/reopen alerts | updateViolation | violationManager | Allows alerts to be reopened/closed through the Alert Manager dropdown menu | Image (2) Below |
alerts – close/reopen alerts | updateViolation,updateMetaData | Allows alerts to be reopened/closed on a form | Image (3) Below |
Note: The processForm action may also be useful if missing data flags are configured for use with alerts.
Audits
Basic Audit Permissions
Actions | Actions Required | Screens Required | Description | Example |
---|---|---|---|---|
audits- Audit Manager | auditManager | Provides access to the Audits Manager | Image (1) Below | |
audits- view subject and form level audits | viewAllAudits | Provides access to subject level audits and form level audits | Image (2) Below | |
audits – view question level audits | viewAudit | Provides access to question level audits on each form | Image (3) Below |
Manager Audit Permissions
This table outlines how audit permissions can be combined with different managers to provide access to audits through the specified manager.
Actions | Actions Required | Screens Required | Description | Example |
---|---|---|---|---|
audits – view coding audits | viewCodeAudit,codeManager | Provides access to coding audits in the Code Manager | Image (1) Below | |
audits – view synonym audits | viewSynonymAudit,synonymManager | Provides access to synonym audits in the Synonym Manager | Image (2) Below | |
audits- view audits in schedule manager | viewAudit,scheduleManager | Provides access to audits in the Schedule Manager | Image (3) Below | |
audits- view audits in drug Assignment Manager | viewAudit,drugAssignmentManager | Provides access to audits in the Drug Assignment Manager | Image (4) Below | |
audits- view audits in drug container manager | viewAudit,drugContainerManager | Provides access to audits in the Drug Container Manager | Image (5) Below | |
audits- view audits in shipment manager | viewAudit,shipmentManager | Provides access to audits in the Shipment Manager | Image (6) Below |
Coding
Actions | Actions Required | Screens Required | Description | Example |
---|---|---|---|---|
coding – Code Manager | codeManager | Provides access to Code Manager | Image (1) Below | |
coding – reset codes in two ways | updateCode | updateCode,codeManager | Allows codes to be reset in the Code Manager through the dropdown list or Reset column | Image (2) Below |
coding – reset codes in one way | updateCode | codeManager | Allows codes to be reset in the Code Manager through the dropdown list only | Image (3) Below |
coding – search and complete codes | searchCode,updateCode | searchCode,updateCode,codeManager | Allows incomplete and complete codes to be updated through the code search feature | Image (4) Below |
coding – approve codes | approveCode | codeManager | Allows codes to be approved through the dropdown list | Image (5) Below |
coding – view medical code | viewMedicalCode | By default, all roles can view medical codes on forms. If the App Property “viewMedicalCodeDefault” is set to false so that no roles can view medical codes, this permission allows selected roles to view medical codes | Image (6) Below | |
coding – Synonym Manager | synonymManager | Provides access to the Synonym Manager | Image (7) Below | |
coding – Synonym details | synonymManager,viewCode | Provides access to synonym details screen in Synonyms Manager though the View column | Image (8) Below | |
coding – Create Synonym | codeManager,createSynonym | Allows for the creation of synonyms through the Code Manager | Image (9) Below | |
coding – Delete Synonym | deleteSynonym | synonymManager | Allows for the deletion of synonyms through the dropdown list in the Synonym Manager | Image (10) Below |
Comments
Actions | Actions Required | Screens Required | Description | Example |
---|---|---|---|---|
comments- Comment Manager | commentManager | Provides access to the Comment Manager and allows for the viewing of existing comments on a form | Image (1) Below | |
comments- create comments | createComment | Allows for the creation and viewing of comments on a form | Images (2 & 3) Below | |
comments- view comments | viewComment | Allows for the viewing of existing comments on a form | Image (4) Below |
Data Entry
Actions | Actions Required | Screens Required | Description | Example |
---|---|---|---|---|
data – enroll subject | createRecord | Provide access to the Enroll Subject button within the Subject Widget on the Desktop | Image (1) Below | |
data – create form | createForm | Provides access to the button used to add forms | Image (2) Below | |
data – create specified form | createForm-FormType Ex: createForm-ae | Provides access to the button used to add the specified forms only | Image (3) Below | |
data – changeEnrollment | changeEnrollment | Provides access to the change enrollment feature | Image (4) Below | |
data – process form | processForm | Allows for the editing and saving of all questions on a form except for PlaintText questions; also enables the missing data buttons | Image (5) Below | |
data – edit plain text questions | processForm,plainTextEdit | Allows for the editing and saving of PlainText questions | Image (6) Below |
Fountayn DCT
Actions | Actions Required | Screens Required | Description | Example |
---|---|---|---|---|
Unlink subject connected to Fountayn DCT | unlinkDirectRecords | Allows the unlinking of EDC records with Fountayn DCT subjects. This permission is useful in the test and design phases of a build where the configuration can change and the old subjects are removed and need retested. | Image (1) Below | |
Renew Fountayn DCT Incremental State | renewDirectIncrementalState | Allows for the next import execution of the DCT Integration Import to do a full resynchronization. This permission is useful in cases where the integration configuration has changed. | Image (2) Below | |
Reconcile DCT Linkage | reconcileDirectLinkage | Allows all subjects of the current application that are not linked to Fountayn DCT to be checked against the currently configured directSubjectOn expression. This permission is useful for when changes are made to the directSubjectOn expression and retrospective subjects need reconciled against the change to determine if they are ready to be enrolled into Fountayn DCT. | Image (3) Below | |
Enroll DCT Subject | enrollDirectSubject | Allows the user to see and interact with the enrollment banner at the top of the form. This will traditionally be given to the data entry roles. | Image (4) Below |
Deletion
Actions | Actions Required | Screens Required | Description | Example |
---|---|---|---|---|
delete – remove dynamic forms | removeForm | Allows for the deletion of dynamic forms through the dropdown menu on the form summary (Also see the note below this table) | Image (1) Below | |
delete – remove all types of forms | removeAllForm | Allows for the deletion of dynamic and static forms through the dropdown menu on the form summary (Also see the note below this table) | Image (2) Below | |
delete – remove subject | removeRecord | Allows for the deletion of subjects through the dropdown menu of the subject manager | Image (3) Below | |
restore- restore form | restoreForm | Allows for the restoring of forms through the dropdown menu of the form summary | Image (4) Below | |
restore- restore subject | restoreRecord | Allows for the restoring of subjects through the dropdown menu of the subject manager | Image (5) Below |
Note: Users with the 'removeForm' permission will be able to delete any form that is created by a script that does not pre-exist in the Forms Template. Any form that is created with a Form ID that does not pre-exist in the Forms Template will be considered to be a dynamic/'log form' and therefore delete-able by only the 'removeForm' permission. Normally any form that is 'static' or created by design in the Forms Template requires the 'removeAllForm' permission to remove it but this caveat exists in contrast to that concept due to the creation mechanism.
Difference Manager
Permissions related to the Difference Manager can be found on the Difference Manager design page.
Dynamic Status
Actions | Actions Required | Screens Required | Description | Example |
---|---|---|---|---|
dynamic status – manage dynamic statuses | manageDynamicStatus | Provides access to the Manage Dynamic Status screen used to create new dynamic statuses | Image (1) Below | |
dynamic status – assign dynamic statuses | assignDynamicStatus | Provides access to the ‘Assign Dynamic Status’ action in the dropdown list of the Subject Manager; Dynamic statuses created through the Manage Dynamic Status screen are included in the list of statuses available for assignment | Image (2) Below | |
dynamic status – clear dynamic statuses | clearDynamicStatus | Provides access to the ‘Clear Dynamic Status’ action in the dropdown list of the Subject Manager; Dynamic statuses created through the Manage Dynamic Status screen are included in the list of statuses that can be unassigned | Image (3) Below | |
dynamic status – assign DA dynamic statuses | assignDynamicStatus, assignDADynamicStatus | Provides access to the ‘Assign Dynamic Status’ action in the dropdown list of the Subject Manager; Dynamic statuses created through the Manage Dynamic Status screen and the DA are included in the list of statuses available for assignment | Image (4) Below | |
dynamic status – clear DA dynamic statuses | clearDynamicStatus, clearDADynamicStatus | Provides access to the ‘Clear Dynamic Status’ action in the dropdown list of the Subject Manager; Dynamic statuses created through the Manage Dynamic Status screen and the DA are included in the list of statuses that can be unassigned | Image (5) Below |
Exports
Actions | Actions Required | Screens Required | Description | Example |
---|---|---|---|---|
exports – Complete and subset exports | exportData | exportData | Provides access to the Exports tab and subset export feature | Image (1) Below |
exports – view archive | viewArchive | Provides access to the ‘View Archive’ column on the Exports screen | Image (2) Below | |
exports – view export log | viewExportLog | Provides access to the ‘failure’ log generated by the export if it fails | Image (3) Below |
Form Flow
Actions | Actions Required | Screens Required | Description | Example |
---|---|---|---|---|
form flow – view form flow column | viewFormFlowColumn | Allows the Form Flow column to be displayed in the Forms Manager | Image (1) Below | |
form flow – form flow transitions | formFlowTransition | formFlowTransition | Allows for the transition of a form from one status to another | Image (2) Below |
If configuring form flow for an existing study, additional form flow permissions related to study modifications are also available.
Imports
Actions | Actions Required | Screens Required | Description | Example |
---|---|---|---|---|
Imports – view and perform configured imports | importData | importData | Provides access to the Imports screen | Image Below |
Info Mode
Info Mode is for debugging purposes only. For more information on the different permissions available, view the Info Mode feature page.
Managers
Actions | Actions Required | Screens Required | Description | Example |
---|---|---|---|---|
alerts – Alert Manager | violationManager | Provides access to the Alerts Manager | Image (1) Below | |
audits – Audit Manager | auditManager | Provides access to the Audits Manager | Image (2) Below | |
codes – Code Manager | codeManager | Provides access to the Code Manager | Image (3) Below | |
codes – Synonym Manager | synonymManager | Provides access to the Synonym Manager | Image (4) Below | |
comments – Comment Manager | commentManager | Provides access to the Comment Manager | Image (5) Below | |
forms – Form Manager (Status Manager) | statusManager | Provides access to the Forms Manager | Image (6) Below | |
queries – Query Manager | queryManager | Provides access to the Query Manager | Image (7) Below | |
questions – Question Manager | questionManager | Provides access to the Question Manager | Image (8) Below | |
visits – Visit Manager | visitManager | Provides access to the Visit Manager | Image (9) Below | |
subjects – hide Subject Manager | hideGlobalSummary | recordManager | The Subject Manager is displayed by default; This permission hides the Subjects Manager | Image (10) Below |
See User Tasks | usertaskManager | Provides access to the User Task Manager used for Adjudication | Image (11) Below | |
All users tasks | viewAllUsersTasks | Provides ability to see all tasks assigned to all users. Without this permission, users in roles with usertaskManager access will see only their own individual tasks. | Image (12) Below |
Metadata
Actions | Actions Required | Screens Required | Description | Example |
---|---|---|---|---|
partial metadata – change meta data plans | changeMetaDataPlans | Provides access to the Change Metadata Plans action in the dropdown menu for the Subject Manager | Image (1) Below | |
metadata – complete and clear complete | complete,clearComplete,updateMetaData | Allows forms to be marked as complete, as well as allows complete statuses to be cleared | Image (2) Below | |
metadata – data review and clear data review | dataReview,updateMetaData | Allows forms or questions to be marked as data reviewed, as well as the clearing of data review statuses | Image (3) Below | |
metadata – SDV and clear SDV | sdv,clearSdv,updateMetaData | Allows forms or questions to be marked as SDV’d, as well as the clearing of SDV statuses | Image (4) Below | |
metadata – freeze and unfreeze | freeze,updateMetaData | Allows forms or questions to be marked as frozen, as well as the clearing of frozen statuses | Image (5) Below | |
metadata – signature and clear signature | signForm,clearSignature,updateMetaData | signForm | Allows for the signing of a form and the clearing of signature from a form. | Image (6) Below |
metadata – lock and unlock | lock,updateMetaData | Allows for the locking of forms and questions, as well as the clearing of locked statuses | Image (7) Below | |
partial metadata – require SDV | requireSDV | Provides access to the requireSDV action in the dropdown menu for the Subject Manager | Image (8) Below |
If configuring the partial metadata status feature for an existing study, additional partial metadata status permissions related to study modifications are also available.
Information related to the query metadata status can be found in the Queries section.
Miscellaneous
Actions | Actions Required | Screens Required | Description | Example |
---|---|---|---|---|
misc – study homepage | home | Provides access to the Study Homepage; with the release of version 14.1, this permission is no longer required. | Image (1) Below | |
misc – manage notifications | manageNotifications | Provides access to the Manage Notifications feature which is available through the green actions menu on the study homepage. The email notification system uses configurable .vm files as email templates. If no customized VM files are associated with the study, the default system template is used. The default files are in English. | Image (2) Below | |
misc – generate PDF of eCRF | formPrint | Allows the currently viewed form to be printed to PDF through the ‘Standard Form’ action in the green actions menu | Image (3) Below | |
misc – upload document | uploadDocument | uploadDocument | Allows files to be uploaded to a form through the ‘Upload File’ button. Additionally allows user to grant file access to sub forms. | Image (4) Below |
misc – attach document | attachDocument | viewDocuments | Allows files from the File Manager to be attached to a form through the ‘Attach Files’ button | Image (5) Below |
misc – remove attached or uploaded documents | removeDocument | removeDocument | Allows files uploaded or attached to a form to be removed by clicking the remove icon | Image (6) Below |
misc – fill with sample data | fillRecord | Provides access to the ‘Fill Sample Data’ action in the dropdown menu of the Subject Manager | Image (7) Below | |
misc – local lab | viewLocalLab | Allows the user to see local lab data on a form when the Local Lab Lookup feature is configured for the trial | Image (8) Below | |
misc – view of Missing Forms Report | missingForms | Allows the user to access and export the Missing Forms standard report. | Image (9) Below | |
misc – configuration of Missing Forms Report | missingFormsConfiguration | Allows the user to modify the configuration of the Missing Forms standard report. | Image (10) Below | |
Adjudication Restart | restartAdjudication | Allows the user to access the ‘Restart Adjudication’ action within the actions menu. | Image (11) Below |
Note: 'Restart Adjudication' property works in conjunction with the 'formType.actionHandler' application property. Without the property, the action will not appear in the list of available actions.
Queries
Actions | Actions Required | Screens Required | Description | Example |
---|---|---|---|---|
queries- Query Manager | queryManager | Provides access to Query Manager | Image (1) Below | |
queries- create query | createQuery | Allows queries to be created on a form | Image (2) Below | |
queries – generate queries from Alert Manager | generateQuery | violationManager | Allows queries to be generated from alerts through the dropdown menu in the Alerts Manager | Image (3) Below |
queries – close/reopen queries | updateQuery | queryManager | Allows queries to be closed and reopened through the dropdown menu in the Query Manager | Image (4) Below |
queries – view query details screen | viewQuery,queryManager | Provides access to the query details screen. Also allows a query to be printed to PDF while viewing it by selecting the ‘Download PDF’ action from green actions bar. | Image (5) Below | |
queries – update queries on query details screen | updateQuery | viewQuery,queryManager | Allows queries to be closed, reopened and updated on the query details screen | Image (6) Below |
queries – address query | respondQuery | viewQuery,queryManager | Allows queries to be addressed on the query details screen | Image (7) Below |
queries – answer query | answerQuery | queryManager | Allows queries to be answered through the dropdown list in the Query Manager | Image (8) Below |
queries – print queries to PDFs | getQueryPdf | viewQuery,queryManager | Allows multiple queries to be printed to PDF through the ‘Download PDF’ action in the dropdown menu of Queries Manager | Image (9) Below |
The following section is found at the bottom of the Roles sheet and controls access to different query statuses. The available values are:
- set – allows the user to set a query in this status
- view – allows the user to view queries with this status
- both – allows the user to view and set a query in this status
- neither – denies the ability to see or set queries that have this status
Query Permissions/Description | Query Status | Permission |
---|---|---|
Unconfirmed queries are typically used to hide queries from site users until reviewed | unconfirmed | both |
New queries are the initial state for queries that are visible to sites | new | both |
Answered queries are queries that the site has responded to | answered | both |
Reopened queries are queries that require further clarification after an initial answer | reopened | both |
Closed queries are queries that have been answered and accepted by the data review staff | closed | view |
Declined queries are rejected queries from either a query workflow or the result of a query that will not be confirmed | declined | neither |
Randomization
Randomization and Inventory permissions can be found in the Randomization & Trial Supply Management manual.
Standard Reports
Actions | Actions Required | Screens Required | Description | Example |
---|---|---|---|---|
standard report – Averages Report | averagesReport | Provides access to the Averages Report | Image (1) Below | |
standard report – Form Statistics Reports | formStatistics | Provides access to the Form Statistics Report | Image (2) Below | |
standard report – Patient Management Report | patientManagement | Provides access to the Patient/Subject Manager Report | Image (3) Below | |
standard report – Statistics reports | statisticsManager | Provides access to the Alert Statistics, Query Statistics, Subject Statistics and Data Point reports | Image (4) Below | |
standard report – Trial Summary | trialSummary | Provides access to the Trial Summary | Image (5) Below | |
standard report – Visit Schedule | visitSchedule | Provides access to the Visit Schedule | Image (6) Below |
Study Modifications
Modifications Through Study Homepage
This section lists the utilities available from the Study Homepage’s green action menu.
Actions | Actions Required | Screens Required | Description | Example |
utilities – enable/disable questions | updateQuestionDisplay | Allows you to enable or disable questions for your display | Image (1) Below | |
utilities – reconcile | reconcile | Provides access to the Reconcile and Reconcile Process Assignments utilities | Image (2) Below | |
utilities – reconcile record | chooseRecord | reconcileRecord, chooseRecord | Provide access to the Reconcile Record utility; this utility also uses the Choose Record utility | Image (3) Below |
utilities – reconcile code status | reconcileCodeStatus | Provides access to the Reconcile Code Status utility | Image (4) Below | |
utilities – update questions | updateQuestions | Provides access to the Update Questions utility | Image (5) Below | |
utilities – upgrade dictionary | upgradeDictionary | upgradeDictionary | Provides access to the Upgrade Dictionary utility | Image (6) Below |
utilities – update name | updateNames | updateNames | Provides access to the Update name utility | Image (7) Below |
form flow – activate form flow | activateFormFlow | Provides access to the action used to activate the Form Flow feature for existing studies | Image (8) Below | |
form flow – activate record level form flow transitions | activateRecordLevelFormFlowTransitions | Provides access to the action used to activate record level form flow transitions for existing studies | Image (9) Below | |
record status – activate record status | activateRecordStatus | Provides access to the action used to activate record status feature for existing studies | Image (10) Below | |
metadata – reconcile metadata plans | reconcileMetaDataPlans | Provides access to the action used to updating existing records’ metadata plans when changes are made to metadata plans in the DA | Image (11) Below | |
metadata – reconcile metadata counts | reconcileMetaDataCounts | Provides access to the action used to update existing metadata counts. This might be required when changes are made to metadata plans in the DA or when casebook modifications are made that affect the number of questions present | Image (12) Below |
Modifications Through Subject Manager
This section lists the utilities available from the Subject Manager’s dropdown menu.
Actions | Actions Required | Screens Required | Description | Example |
---|---|---|---|---|
utilities – move record | moveRecord | moveRecord | Provides access to the Move Record utility | Image (1) Below |
utilities – move form | moveForm | moveForm | Provides access to the Move Form utility | Image (2) Below |
utilities – update form configuration | updateFormConfig | updateFormConfig | Provides access to the Update Form Configuration utility | Image (3) Below |
utilities – insert form | insertForm | insertForm | Provides access to the Insert Form utility | Image (4) Below |
utilities – refresh metadata | refreshMetaData | refreshMetaData | Provides access to the Refresh Metadata utility | Image (5) Below |
utilities – rename form | renameForm | renameForm | Provides access to the Rename Form utility | Image (6) Below |
utilities – update question type | updateQuestionType, chooseQuestions | Provides access to the Update Question Type Utility; this utility also uses the Choose Question utility | Image (7) Below | |
utilities – reconcile form | reconcileForm | reconcileForm | Provides access to the Reconcile Form utility | Image (8) Below |
record status – show record status dependencies | showRecordStatusDependencies | Allows roles to see record status dependencies which are useful when configuring the record status feature with casebooks that are dynamically generated through scripts | Image (9) Below |
Modifications Through Code Manager
This section lists the utilities available through the Code Manager.
Actions | Actions Required | Screens Required | Description | Example |
---|---|---|---|---|
utilities – update codes | reCode | codeManager | Provides access to a utility that attempts to automatically re-code terms after synonym tables or dictionaries are upgraded | Image Below |
Modifications Through Forms
This section lists the utilities available on the Form Summary and through the Form Manager.
Actions | Actions Required | Screens Required | Description | Example |
---|---|---|---|---|
utilities – update sequence | updateSequence | Provides access to the Update Sequence utility | Image Below |
Subject Status
Actions | Actions Required | Screens Required | Description | Example |
---|---|---|---|---|
record status – view record status history | viewRecordStatusHistory | viewRecordStatusHistory | Provides access to the Record Status History screen through the dropdown menu in Subject Manager | Image (1) Below |
record status – delete subject status history | viewRecordStatusHistory, deleteRecordStatusHistory | viewRecordStatusHistory | Allows for the deletion of historical record statuses on the record status history screen | Image (2) Below |
If configuring the record status feature for an existing study, additional record status permissions related to study modifications are also available.
Need more help?
Please visit the Fountayn Contact Information page.