To manage eForm access rules, you need the 'Maintain Schedule' permission
Create a new eForm access rule
Delete an existing eForm access rule
These routines enable you to control access to specific eForms, based on role.
To manage eForm access rules, you need the 'Maintain Schedule' permission
Create a new eForm access rule to allow or deny access to an eForm for a specific role, either in a single visit or across all visits.
Ensure you follow the required conventions when specifying user credentials.
|
Parameter |
Description |
|
Functionality identifier |
"RoleBasedEformAccess" |
|
User credentials |
User name/Password/Database/Userrole |
|
Operation Identifier |
"AddRule" |
|
studyName |
The name of the study for which the new access rule will operate |
|
visitCode |
The code of the visit containing the eForm to which you are controlling access (leave blank for all visits) |
|
eFormCode |
The code of the eForm to which you are controlling access |
|
roleCodeForRule |
The code of the role that you want to associate with the rule |
|
accessFlag |
Indicates if the rule allows access (1) or denies it (0) |
|
/RoleBasedEformAccess/Username/Password/Database/Role/AddRule/studyName/visitCode/eFormCode/roleCodeForRule/accessFlag |
|
Result,AddRule,study,visit,eForm,role,accessFlag |
To grant access for users with the DataReview role to the Cover eForm in the Screening visit:
|
InferMed.M40.MACRO_CL.exe /RoleBasedEformAccess/rde/macrotm/M480DB/FullUser/AddRule/Demostudy40/screening/cover/DataReview/1 |
|
Success,AddRule,Demostudy40,screening,cover,DataReview,1 |
To grant access for users with the DataMonitor role to the Cover eForm in any visit:
|
InferMed.M40.MACRO_CL.exe /RoleBasedEformAccess/rde/macrotm/M480DB/FullUser/AddRule/Demostudy40//cover/DataMonitor/1 |
|
Success,AddRule,Demostudy40,,cover,DataMonitor,1 |
To deny access for users with the DataReview role to the Cover eForm in the Screening visit (providing there are no Allow rules for the same visit/eForm combination):
|
InferMed.M40.MACRO_CL.exe /RoleBasedEformAccess/rde/macrotm/M480DB/FullUser/AddRule/Demostudy40/screening/cover/DataReview/0 |
|
Success,AddRule,Demostudy40,screening,cover,DataReview,0 |
Remove an existing eForm access rule.
Ensure you follow the required conventions when specifying user credentials.
|
Parameter |
Description |
|
Functionality identifier |
"RoleBasedEformAccess" |
|
User credentials |
User name/Password/Database/Userrole |
|
Operation Identifier |
"RemoveRule" |
|
studyName |
The name of the study for which the access rule operates |
|
visitCode |
The code of the visit containing the eForm to which you are controlling access (leave blank for all visits) |
|
eFormCode |
The code of the eForm to which you are controlling access |
|
roleCodeForRule |
The code of the role that is associated with the rule |
|
accessFlag |
Indicates if the rule allows access (1) or denies it (0) |
|
/RoleBasedEformAccess/Username/Password/Database/Role/RemoveRule/studyName/visitCode/eFormCode/roleCodeForRule/accessFlag |
|
Result,RemoveRule,study,visit,eForm,role,accessFlag |
To remove the Allow rule that exists for users with the DataReview role for the Cover eForm in the Screening visit:
|
InferMed.M40.MACRO_CL.exe /RoleBasedEformAccess/rde/macrotm/M480DB/FullUser/RemoveRule/Demostudy40/screening/cover/DataReview/1 |
|
Success,RemoveRule,Demostudy40,screening,cover,DataReview,1 |
To remove the Deny rule that exists for users with the DataMonitor role for the Cover eForm in the Screening visit:
|
InferMed.M40.MACRO_CL.exe /RoleBasedEformAccess/rde/macrotm/M480DB/FullUser/RemoveRule/Demostudy40/screening/cover/DataMonitor/0 |
|
Success,RemoveRule,Demostudy40,screening,cover,DataMonitor,0 |
Each operation returns an individual result to the console as a comma-separated message with one of the following result codes:
|
Value |
Description |
|
Success |
Operation completed successfully |
|
PermissionError |
User does not have permission to carry out this operation |
|
DatabaseError |
An unexpected error occurred while accessing the database |
|
InvalidStudyError |
Specified study was not found |
|
InvalidRoleError |
Specified role was not found |
|
InvalidVisitError |
Specified visit was not found |
|
InvalidEformError |
Specified eForm was not found |
|
Unknown |
Unexpected error occurred |