DFaccess.rpc — Change access to a study database or , or query their current access status.
DFaccess.rpc
{
[-s study]
| [-inbound]
}
[
[-ro]
| [-rw]
| [-enable]
| [-q]
]
[
[-restrict reason string]
| [-disable reason string]
]
DFaccess.rpc provides the same functionality from the command line that is available
in the DFadmin Status View.
Like all shell level programs, DFaccess.rpc can be executed by datafax or
any other user with a UNIX login account who is in group studies.
Read-Only Mode. While a study is in read-only mode DFexplore and DFsetup can be used to view but not change study data and setup information. Studies are typically put into Read-Only mode because data collection is complete, all queries have been resolved, and the data has been verified against source documents. Statistical analysis may be ongoing or an FDA audit may be in progress thus the study cannot be disabled, but no further changes are expected or allowed.
By design, read-write access to a study database is only granted to tools that write new data records or update existing data records. All other tools have read-only access. Thus when is used to switch a study sever to read-only mode only those tools that normally have read-write access will be affected. This includes the following:
Table 3.2. Software Components Affected by Read-Only Mode
| Program | When Database Server is in Read-Only Mode |
|---|---|
| DFbatch | exits without executing any edit checks |
| DFimport.rpc | exits without importing any records |
| DFinbound.rpc | incoming pages barcoded for the study are moved to the system-wide
identify directory
|
| DFqcsent.rpc | will not run because the Query database cannot be updated |
| DFexplore | the study can be used in view-only mode but pages cannot be sent to the study from the unidentified fax router |
| DFsetup | can be used in view-only mode |
| DFadmin | can be used by DFdiscover and study administrators to view and change study access |
| DF_ICqcs | the -r (repair) option cannot be used |
| DF_QCfax | faxes can be sent but post-processing to move external reports to the sent directory and to mark queries as having been sent will fail |
| DF_QCreports | external reports that include refax (correction) and/or Q&A (clarification) queries cannot be created because the Query database cannot be updated |
| DF_QCsent | will not run because the Query database cannot be updated |
| DF_QCupdate | will not run because the Query database cannot be updated |
When a study is put into read-only mode it will remain in that mode until
reset using DFadmin or with the -rw option.
While a study is in read-only mode, any incoming pages barcoded for that study
will be moved to DFrouter's identify directory.
Restricted Access.
Access to a study can be restricted for DFdiscover and study administrators only
using the -restricted option. While a study is restricted
other users are not allowed to login, even in view-only mode.
When a study is restricted using or DFadmin users who are logged in will be able to continue working until they log off, but only administrators will be able to make new login connections.
While a study is restricted, any incoming pages barcoded for the study will be processed normally and sent to the study new fax queue, but only DFdiscover and study administrators will be able to view or process them.
A study may be made both restricted and read-only, but these options cannot be used together on the same command line, it requires 2 separate executions of ; the order is not important.
When a study is put into restricted mode it will remain in that mode until
reset using DFadmin or with the -enable option
or until the study server is restarted.
Disabled Access.
A study database may be disabled, making it unavailable to all users,
using the -disable option.
While a study is disabled, any incoming pages barcoded for the study will be held until the study is enabled, and will not show up in the study new fax queue until processing is triggered by the arrival of the next fax received by the DFdiscover server. It is not necessary for the next fax to contain pages barcoded for the study in question or for any study.
When a study is disabled it will remain in that mode until
reset using DFadmin or with the -enable option.
To complete a change in access mode, must be the only client accessing the server. Thus fails if there are any tools with open connections to the study server.
-s study | the study number |
-inbound | used when changing the status of , which processes incoming faxes and PDF files |
-ro | change the database server to read-only mode |
-rw | change the database server to read-write mode |
-enable | reverses -disable or -restrict to return the study or to normal access |
-q | query the state of the database server or |
-restrict reason string | restrict the database server making it available to DFdiscover and study administrators only, and displaying the reason string in study selection dialogs |
-disable reason string | disable the database server making it unavailable to all users, and displaying the reason string in study selection dialogs |
DFaccess.rpc exits with one of the following statuses:
0 | The mode of the database server was successfully changed to the requested mode, or the mode was successfully queried. |
1 | The mode of the database server was not successfully changed. The server is currently in a mode that is incompatible with the change. |
2 | The study server could not be contacted or there was an error in the command-line arguments. |
Example 3.1. Enable read-only access to study #123, do lengthy operation, and then reinstate read-write access
# /opt/dfdiscover/bin/DFaccess.rpc -s 123 -ro...some lengthy operation...
# /opt/dfdiscover/bin/DFaccess.rpc -s 123 -rwExample 3.2. Restrict study #123 in read-only access to DFdiscover and study administrators only, while they analyze and run reports on a static database, and then reinstate normal access to all users
#/opt/dfdiscover/bin/DFaccess.rpc -s 123 -restrict analysis#/opt/dfdiscover/bin/DFaccess.rpc -s 123 -ro
...administrators perform their analyses
#/opt/dfdiscover/bin/DFaccess.rpc -s 123 -rw#/opt/dfdiscover/bin/DFaccess.rpc -s 123 -enable