Chapter 14. DFdiscover System Files
Prev		Next

Chapter 14. DFdiscover System Files

Table of Contents

14.1. Introduction
14.2. DFdiscover system directories
14.3. Format used to describe files
14.4. DFdiscover system configuration files
14.5. DFdiscover system work files

14.1. Introduction

This chapter is a reference for the files and directories that comprise a DFdiscover installation. It starts with a brief overview of the top level directories of the DFdiscover installation directory. It then describes in detail the DFdiscover configuration and status files maintained under the lib and work directories. A similar chapter, Programmer Guide, Study FilesDFdiscover Study Files, describes the file system maintained for each individual DFdiscover study.

14.2. DFdiscover system directories

The following directories are part of a standard DFdiscover installation.

`bin`	This directory contains all of the executables included in a DFdiscover installation. All DFdiscover applications are executed from this directory. In most cases, the executable is only a symbolic link to a script that determines and executes the true executable for the current operating system and hardware. In some cases, the executable is a shell script itself.
`doc`	This directory contains all of the DFdiscover documentation.
`ecbin`	This directory contains any scripts called by edit checks that are system-wide or common to all studies.
`ghostscript`	This directory contains configuration information and documentation for the DFgs interpreter included with DFdiscover.
`identify`	Fax pages received by DFdiscover which cannot be identified as belonging to any of the registered studies, are stored in this directory (1 file per page). They can be viewed, printed, deleted, and if appropriate, routed to a study using the DFexplore Image Router function.
`lib`	The directory holds all system configuration files (managed using DFadmin), and 3 databases used to keep track of the current status of each study server, the inbound fax daemon, and the outbound fax daemon. The following files are described in detail later in this chapter in DFdiscover system configuration files: `DFedcservice.cf`. EDC service configuration file `DFinbound.cf`. inbound daemon configuration file `DFinbound.db`. current status of the inbound daemon `DFlogin.html`. configuration file for login banner `DFmaster.cf`. master daemon configuration file `DFoutbound.cf`. outbound daemon configuration file `DFoutbound.db`. current status of the outbound daemon `DFreceipt.sample`. example replyfax receipt `DFreplyfax.cf`. configuration file for replyfax feature `DFsites.db`. database of registered sites for replyfax feature `DFstudies.db`. current status of all study database servers `DFuserdb.log`. user, role, and permissions database iso3166-1. ISO 3166-1 table of 3-character country codes
`reports`	This directory contains the standard DFdiscover reports which are executable through Reports View in DFexplore.
`utils`	This directory contains various utility applications. They are less frequently used than the executables in the `bin` directory. The executable is a symbolic link to a script that determines and executes the true executable for the current operating system and hardware.
`work`	This directory contains various DFdiscover log and status files. The following files are described in detail later in this chapter in DFdiscover system work files: `001`. the work directory used by the incoming fax daemon. The directory is used for temporary storage of the incoming fax pages being processed by the incoming fax daemon. When fax processing is complete this directory will be empty. This directory is not described further below. `router_log`. log of all faxes in router `fax_log`. log of all faxes received `fax_log.idx`. index on log of all faxes received `license`. DFdiscover software license `replyfax_log`. Log of all receipt faxes sent by replyfax feature `sendfax_log`. log of all transmitted faxes `server_log`. log of server start and stop activity `sitefax_log`. log of faxes received from unregistered sites `.serverstatus###`. Lock for executing server `.seqYYWW`. incoming fax sequence numbering `.seqOUT`. outgoing fax sequence numbering
`x86_linux`	Operating system and hardware specific executables for Redhat or SUSE Linux on Intel hardware. If DFdiscover is not installed on Linux Intel hardware, this directory will not be present.

The remainder of this chapter describes the files kept under the DFdiscover lib and work directories. Each file is described using a common format.

	Do not edit system files
You should never try to manually edit any of the DFdiscover system files! These files are created and maintained by one or more DFdiscover applications and are integral to the proper functioning of the various applications which together make up the DFdiscover system. Manual edits could produce unexpected and disastrous effects. It is however perfectly safe to read these files for system diagnosis, or use them as input for system administration scripts. It is for this reason that this information is provided here.

Do not edit system files

You should never try to manually edit any of the DFdiscover system files! These files are created and maintained by one or more DFdiscover applications and are integral to the proper functioning of the various applications which together make up the DFdiscover system. Manual edits could produce unexpected and disastrous effects. It is however perfectly safe to read these files for system diagnosis, or use them as input for system administration scripts. It is for this reason that this information is provided here.

14.3. Format used to describe files

Each file documented in this section is described with the following attributes:

Table 14.1. File attributes

Heading	Description
Usual Name	the file name that is usually given to files having this format. Some files are kept at the DFdiscover directory level while others are kept separately with each study directory.
Type	one of: "clear text" or "binary". Clear text files can be reviewed with any text editor.
Created By	the name of the DFdiscover program(s) that create and modify this file. If you need to edit the contents of the file, use the program listed here.
Used By	the name of the DFdiscover program(s) that reference or read this file.
Field Delimiter	how fields within a record are delimited. Typically, the delimiter is a single character.
Record Delimiter	how records within the file are delimited. Typically, the delimiter is a single character.
Comment Delimiter	how comments within the file are delimited. If comments are not permitted within the file, "NA" is indicated.
Fields/Record	the expected number of fields per record. If the number of fields varies across records, the minimum number is given, followed by a `+`.
Description	a detailed description of the meaning of each field.
Example	one or more example records from the file.

14.4. DFdiscover system configuration files

Table 14.2. DFedcservice.cf

Usual Name	`DFedcservice.cf`
Type	clear text
Created By	INSTALL
Used By	DFedcservice
Field Delimiter	`space` character
Record Delimiter	`\n`
Comment Delimiter	`#`
Fields/Record	2
Description	The file configures the DFedcservice processes, telling it where to find its SSL key and certificate as well as which DFmaster.rpcd to talk to. The format of the configuration file is one keyword, value pair per record with one occurrence of each of the following keywords required: `master`, `key`, `certificate`. The file can also instruct the DFedcservice process to bind to a particular network interface using the optional `bindaddr` keyword. This is useful if the server running DFedcservice has more than one network adapter (either real or virtual), and it also services non-DFdiscover requests on port 443. Finally, the list of ciphers available for secure communication can be specified using the optional `ciphers` keyword. The value is a comma-delimited list of ciphers used for secure communication. DFdiscover ships with the current recommended list of ciphers based upon widely-accepted best security practices. The list can be edited as needed to add newer ciphers (should they become available after the DFdiscover release). A good, albeit technical, reference for this can be found here as well as an up-to-date list of recommended ciphers.
Example	master apache.dfnetresearch.com key /opt/dfdiscover/lib/edckey.pem certificate /opt/dfdiscover/lib/edccert.pem bindaddr 192.168.3.30 ciphers ECDHE-RSA-AES128-SHA,ECDHE-RSA-AES128-SHA256,TLS_AES_128_GCM_SHA256,TLS_CHACHA20_POLY1305_SHA256

Table 14.3. DFinbound.cf

Usual Name	`DFinbound.cf`
Type	clear text
Created By	DFadmin
Used By	DFinbound.rpc
Field Delimiter	`=`
Record Delimiter	`\n`
Comment Delimiter	`#`
Fields/Record	2
Description	The file configures the DFinbound.rpc daemon. The format of the configuration file is one keyword, value pair per record with one occurrence of each of the following keywords required: `WORKING_DIR`, `INBOUND_ARCHIVE_DIR`.
Example	WORKING_DIR=/opt/dfdiscover/work INBOUND_ARCHIVE_DIR=/opt/dfdiscover/archive

Table 14.4. DFinbound.db

Usual Name	`DFinbound.db`
Type	clear text
Created By	DFadmin
Used By	DFmaster.rpcd
Field Delimiter	`\|`
Record Delimiter	NA, only one record permitted
Comment Delimiter	`#`
Fields/Record	7
Description	The incoming daemon database maintains the status of the incoming daemon. The fields within the single record are defined in Table 14.5, “Field descriptions for `DFinbound.db`”.
Example	001\|\|\|\|/opt/dfdiscover/bin/DFinbound.rpc -c /opt/dfdiscover/lib/DFinbound.cf\|purgatory\|Inbound daemon 001

Table 14.5. Field descriptions for DFinbound.db

Field #	Contains	Description
1	daemon number	the unique identifier of the daemon. The daemon number must be in the range 1 to 255.
2	host name	the host name of the machine that the daemon is executing on. If the daemon is currently processing a fax, this field contains the host name of the machine that DFinbound.rpc is executing on. If the daemon is not running, the field is empty.
3	RPC program number	the RPC program number that the daemon is servicing. If the daemon is not running, the field is empty.
4	RPC version number	the RPC version number that the daemon is servicing. If the daemon is not running, the field is empty.
5	command to start daemon	the command that the slave daemon executes to start the incoming daemon. The leading applications name will always be the same while the argument configuration file may change across daemons.
6	candidate host names	a comma delimited list of machines that the incoming daemon can execute on (no spaces).
7	label	a descriptive label for the daemon. It is generally ignored, and is only provided so that this database format is compatible with the format of the studies database.

Table 14.6. DFlogin.html

Usual Name	`DFlogin.html`
Type	HTML
Created By	DFadmin
Used By	DFedcservice
Field Delimiter	NA
Record Delimiter	NA
Comment Delimiter	NA
Fields/Record	NA
Description	The login banner HTML file defines the information that is displayed at the bottom of the login screen for DFexplore, DFsetup, DFadmin and DFsend. This file may contain only HTML text as configured in DFadmin. For more information, refer to Configuring the DFdiscover master.
Example	<html> <center> <h1>DF/Net Research, Inc.</h1> <p><h3>Seattle, Washington, USA</h3></p> <p>For assistance, contact <a href="mailto:help@dfnetresearch.com">help@dfnetresearch.com</a></p> </center> </html>

Table 14.7. DFmaster.cf

Usual Name	`DFmaster.cf`
Type	clear text
Created By	DFadmin
Used By	DFmaster.rpcd
Field Delimiter	`=`
Record Delimiter	`\n`
Comment Delimiter	`#`
Fields/Record	2
Description	This file configures the behavior of the DFmaster.rpcd process. The format of the configuration file is one keyword, value pair per record with one occurrence of each of the following keywords required: `AUTO_SLAVES`, `CDN_URL`, `MAILEE`, `PASSWORD_RULES`, `PRINTER`, `VERSION_STRICT`. The value for `PASSWORD_RULES` is an 8-tuple where fields have the following meaning: `length,complexity,expiry,reuse,lockout,failures,email,reset` `length`. the minimum number of characters required in a valid password `complexity`. the sum of the following complexity rule values: `1` at least one character and one digit must be included `2` at least one lowercase and one uppercase character must be included `4` at least one special character must be included `expiry`. a single password is valid for this number of days and must be changed before this period ends, otherwise the password expires `reuse`. reuse of this many most recent passwords is not permitted `lockout`. after multiple failed login attempts, lockout the user for this many minutes `failures`. the user is locked out if there are this many consecutive failed login attempts `email`. if the user is locked out, send a notification email to this address `reset`. allow the user to reset their own password (1) from the login dialog or disallow (0) this functionality Additional requirements for the values matching each keyword are given in Configuring the DFdiscover master.
Example	AUTO_SLAVES=purgatory MAILEE=root PRINTER=hp5lj CDN_URL=https://cdn.dfdiscover.com/v5 PASSWORD_RULES=8,1,90,3,5,5,user@domain.com,1 VERSION_STRICT=0

Table 14.8. DFoutbound.cf

Usual Name	`DFoutbound.cf`
Type	clear text
Created By	DFadmin
Used By	DFoutbound.rpc
Field Delimiter	`=`
Record Delimiter	`\n`
Comment Delimiter	`#`
Fields/Record	4
Description	The file configures the DFoutbound.rpc process. The format of the configuration file is one keyword, value pair per record with one occurrence of each of the following keywords required: `WORKING_DIR`, `POLLING_INTERVAL`, `ROUND_TRIP_TIMEOUT`.
Example	WORKING_DIR=/opt/dfdiscover/work POLLING_INTERVAL=20 ROUND_TRIP_TIMEOUT=24

Table 14.9. DFoutbound.db

Usual Name	`DFoutbound.db`
Type	clear text
Created By	DFadmin
Used By	DFmaster.rpcd
Field Delimiter	`\|`
Record Delimiter	NA, only one record permitted
Comment Delimiter	`#`
Fields/Record	7
Description	The outgoing daemon database maintains the status of the outgoing daemon. The fields within the record are defined in Table 14.10, “Field descriptions for `DFoutbound.db`”.
Example	001\|\|\|\|/opt/dfdiscover/bin/DFoutbound.rpc -c /opt/dfdiscover/lib/DFoutbound.cf\|purgatory\|Outbound daemon 001

Table 14.10. Field descriptions for DFoutbound.db

Field #	Contains	Description
1	daemon number	the unique identifier of the daemon. The daemon number must be in the range 1 to 255.
2	host name	the host name of the machine that the daemon is executing on. If the daemon is currently running, this field contains the host name of the machine that DFoutbound.rpc is executing on. If the daemon is not running, the field is empty.
3	RPC program number	the RPC program number that the daemon is servicing. If the daemon is not running, the field is empty.
4	RPC version number	the RPC version number that the daemon is servicing. If the daemon is not running, the field is empty.
5	command to start daemon	the command that the slave daemon executes to start the outgoing daemon. The leading applications name will always be the same while the argument configuration file may change across daemons.
6	candidate host names	a comma delimited list of machines that the outgoing daemon can execute on (no spaces).
7	label	a descriptive label for the daemon. It is generally ignored, and is only provided so that this database format is compatible with the format of the studies database.

Table 14.11. DFprinters

Usual Name	`DFprinters`
Type	clear text
Created By	text editor
Used By	DFexplore
Field Delimiter	NA
Record Delimiter	`\n`
Comment Delimiter	NA
Fields/Record	1
Description	This optional file defines the list of printer names that are accessible from DFdiscover client or server machines and are PostScript capable. The file contains one printer name per record (line). In each application that has a print dialog, the list of available printers is created from the contents of this file. If the file does not exist, or is empty, the default behavior is used which involves querying the list of printers known to the host via the lpstat -t command.
Example	hp4000_med hplj5_safety hp4050

Table 14.12. DFreceipt.sample

Usual Name	`DFreceipt.sample`
Type	clear text
Created By	text editor
Used By	DFinbound.rpc
Field Delimiter	NA
Record Delimiter	NA
Comment Delimiter	NA
Fields/Record	NA
Description	A receipt file contains a text message that will be faxed back to those clinical sites that are defined to use DFdiscover's replyfax feature. A receipt file may contain only ASCII text. Certain substitutions can be performed by the reply fax feature in the body of the message before the receipt is faxed. These substitutions are: `%s`. site name as taken from field 2 of `DFsites.db` `%p`. total number of pages received in the fax `%t`. local time of day that the fax was received `%d`. local date that the fax was received `%g`. the G3 fax identifier, typically the subscriber id of the sending fax
Example	DFDISCOVER RECEIPT for STUDY XYZ To: %s From: XYZ STUDY coordinating site Re: recently received fax from number %g A %p page fax was received at %t on %d (local time). If this does not agree with your fax receipt, contact: John Doe at 1-888-123-4567, extension 7777 THANK YOU FOR YOUR ONGOING STUDY PARTICIPATION.

Table 14.13. DFreplyfax.cf

Usual Name	`DFreplyfax.cf`
Type	clear text
Created By	DFadmin
Used By	DFinbound.rpc
Field Delimiter	`space` character
Record Delimiter	`\n`
Comment Delimiter	NA
Fields/Record	2+
Description	This file records the settings from the replyfax dialog in DFadmin. The structure of the file is one setting per record where each setting has a keyword to identify it followed by 1 or more arguments. The keywords and their possible arguments are listed in Table 14.14, “Field descriptions for `DFreplyfax.cf`”.
Example	The following reply fax configuration file has receipts enabled, 3 retries at 5 minute intervals, logging of fax back failures only, notification to root@servername.com of fax back failures, processing of all faxes, and logging of faxes from unregistered sites only. receipts 1 attempts 3 5 log 2 notify 1 root@servername.com processing 0 unknownfax 1 0

Table 14.14. Field descriptions for DFreplyfax.cf

Keyword	Argument 1	Argument 2	Argument 3
receipts	0 (disable reply fax feature) or 1 (enable reply fax feature)
attempts	`#` (number of retries - default is 2)	`#` (minutes between retries - default is 10)
log	0 (do not log fax backs) or 1 (log all fax backs) or 2 (log only fax back failures)
notify	0 (do not notify) or 1 (notify)	email address to send notification to if first argument is 1
processing	0 (process all incoming faxes/emails) or 1 (process faxes/emails from registered sites only)
unknownfax	0 (do not log faxes/emails from unregistered sites) or 1 (log faxes/emails from unregistered sites)	0 (do not send a notification email) or 1 (send a notification email)	email address to send notification of unregistered faxes to if second argument is 1

Table 14.15. DFsites.db

Usual Name	`DFsites.db`
Type	clear text
Created By	text editor
Used By	DFinbound.rpc
Field Delimiter	`\|`
Record Delimiter	`\n`
Comment Delimiter	NA
Fields/Record	5
Description	This file identifies the clinical sites that are to receive fax or email receipts when the replyfax feature of DFdiscover is enabled. Sites that do not require fax/email receipts do not need to be defined in this file. The file contains 1 record per clinical site as described in Table 14.16, “Field descriptions for `DFsites.db`”.
Example	The following example database illustrates two sites where each site receives a unique receipt. The first site (General Hospital) has a fax number as its sender ID and receives a receipt via fax. The second site (St. Elsewhere) has an email address as its sender ID and receives a receipt via email. 1\|General Hospital\|888-123-4567\|1-888-123-4567\|/opt/studies/xyz/lib/reply.001 1\|St. Elsewhere\|elsewhere@hospital.com\|mailto:person@hospital.com\|/opt/studies/abc/lib/reply.001

Table 14.16. Field descriptions for DFsites.db

Field #	Contains	Description
1	status	the status field is set to 1 to enable fax receipts to this site. To disable fax receipts (but keep the site in the database), set the status field to 0.
2	site name	the name of the site.
3	sender ID	the sender ID (usually the site's fax number or email address) must be included in each received fax/email from the site. It is required to uniquely identify where each transmission came from. Any faxes or emails from the site which do not include this identifier will not be recognized as arriving from this site. This field can accommodate up to a maximum of 100 characters. Comparison of the sender identification with this value is always performed case-insensitive.
4	reply fax number	the fax number or email address to which all reply fax receipts are to be transmitted for this site. It is valid for this fax number or email address to be different from the sender id. Exactly one reply address is permitted in this field, up to a maximum of 100 characters in length. The number of reply addresses is not enforced, therefore the user must exercise care when entering a value for this field.
5	receipt file name	the full pathname of the file that contains the reply fax receipt for this site.

Table 14.17. DFstudies.db

Usual Name	`DFstudies.db`
Type	clear text
Created By	DFadmin
Used By	DFmaster.rpcd
Field Delimiter	`\|`
Record Delimiter	`\n`
Comment Delimiter	`#`
Fields/Record	7
Description	The study servers database maintains the status of all of the study servers defined for your DFdiscover site. The fields within each record are defined as described in Table 14.18, “Field descriptions for `DFstudies.db`”.
Example	102\|goofy\|536871270\|1\|/opt/dfdiscover/bin/DFserver.rpc -c /local/study102/lib/DFserver.cf\|goofy,ariel\|Example study 102

Table 14.18. Field descriptions for DFstudies.db

Field #	Contains	Description
1	daemon number	the study number of the server. The study number must be in the range 1 to 999. Study numbers beyond 255 are available for EDC studies and only if the software is licensed to allow it.
2	host name	the host name of the machine that the server is executing on. If the server is currently running, this field contains the host name of the machine that DFserver.rpc is executing on. If the server is not running, the field is empty.
3	RPC program number	the RPC program number that the server is servicing. If the server is not running, the field is empty.
4	RPC version number	the RPC version number that the server is servicing. If the server is not running, the field is empty.
5	command to start server	the command that the slave daemon executes to start the study server. The leading applications name will always be the same while the argument configuration file will change across study servers.
6	candidate host names	a comma delimited list of machines that the study server can execute on (no spaces).
7	label	the study name.

Table 14.19. DFstudyspaces.db

Usual Name	`DFstudyspaces.db`
Type	clear text
Created By	DFserveradmin
Used By	DFadmin, DFmigrate
Field Delimiter	`\|`
Record Delimiter	`\n`
Comment Delimiter	`#`
Fields/Record	3
Description	This file holds the UNIX pathnames where users are allowed to install DFdiscover study directories. Each record is comprised of 3 fields. The first field contains a label displayed in DFadmin when users select the 'Study Space' for a new study, the second field contains the full UNIX pathname corresponding to that label, and the third is either a 0 to indicate this study space is not available for new studies, or a 1 if it is. The UNIX pathname is the root directory for all DFdiscover studies created under that space.
Example	NIH Studies\|/opt/studies1\|1 Other Studies\|/opt/studies2\|1 To create a new study a user selects a study space and then enters a study folder name. For example, selecting 'NIH Studies' and then entering ECIC as the folder name would create study directory /opt/studies1/ECIC.

Table 14.20. DFuserdb.log

Usual Name	`DFuserdb.log`
Type	clear text
Created By	DFadmin
Used By	DFmaster.rpcd, DFuserdb
Field Delimiter	`\|`
Record Delimiter	`\n`
Comment Delimiter	`#`
Fields/Record	Variable
Description	The user database log provides an audit trail of all additions and changes made to users, roles and permissions. It includes 5 record types for: Users, User Roles, Roles, Role Permissions, and Passwords. The fields within each record are defined in Table 14.21, “Field descriptions for `DFuserdb.log` - User Record” (User Record), Table 14.22, “Field descriptions for `DFuserdb.log` - User Role Record” (User Role Record), Table 14.23, “Field descriptions for `DFuserdb.log` - Role Record” (Role Record), Table 14.24, “Field descriptions for `DFuserdb.log` - Role Perm Record” (Role Permissions Record), Table 14.25, “ Field descriptions for `DFuserdb.log` - Password Record” (Password Record)
Example	User Record: 20060315165834\|USER\|datafax\|datafax\|2\|DFdiscover Admin\|\|\|\|\|\|\|\|\|\|0\|0\|0\|-1 User Role Record: 20060315165834\|USRL\|datafax\|datafax\|1\|1\|1\|\| Role Record: 20060316131756\|ROLE\|datafax\|1\|253\|2\|FullPerms\|\|\|\|\|\| Role Perm Record: 20060316131756\|RLPM\|datafax\|1\|1\|2\|\|\|1,2,3,4\|1,2,3,4,5\|1,2,3,4\|\|\|\|1\|2 Password Record: 20060316131756\|PASS\|datafax\|datafax\|md50f3a987b1eb76652e11c903930dc4d15\|1288026696

Table 14.21. Field descriptions for DFuserdb.log - User Record

Field #	Contains	Description
1	Record Time Stamp	the date and time this record was created
2	Record Type	the static 4 letter record identifier: USER
3	Record Modifier	the username of the user who created this record
4	User Login (key field)	the username uniquely identifying a DFdiscover user even if that user has been deleted or made inactive
5	Status	the status of this username (0=Deleted, 1=InActive or 2=Active)
6	Full Name	full name (Maximum 256 characters)
7	Affiliation	affiliation name (Maximum 256 characters)
8	Address	street address (Maximum 256 characters)
9	City	city name (Maximum 256 characters)
10	State	state or province (Maximum 256 characters)
11	Postal Code	ZIP or postal code (Maximum 256 characters)
12	Country	country (Maximum 256 characters)
13	Telephone	phone number (Maximum 256 characters)
14	Fax	fax number (Maximum 256 characters)
15	Email	email address (Maximum 256 characters)
16	Language	language preference (0=English or 1=French) [ignored in the current release]
17	Receipt	how user prefers to receive messages (0=Mail, 1=Fax or 2=Email) [ignored in the current release]
18	Router Access	permission to use DFrouter (0=No or 1=Yes)
19	Administrator	permission to perform administrative tasks at the system or study levels (blank=No Admin privileges, -1=DFdiscover Admin, *=Admin for All Studies, or list of study numbers=Admin for specified studies)

Table 14.22. Field descriptions for DFuserdb.log - User Role Record

Field #	Contains	Description
1	Record Time Stamp	the date and time this record was created
2	Record Type	the static 4 letter record identifier: USRL
3	Record Modifier	the username of the user who created this record
4	User Login (key field)	the username uniquely identifying a DFdiscover user even if that user has been deleted or made inactive
5	Role ID (key field)	a sequential identification number, unique across all roles for all studies, assigned to each role when it is created, regardless of whether or not the role is saved
6	Instance (key field)	a sequential number which identifies the potentially multiple specifications of the current study role for the current user (i.e. for different sites and/or subjects) on different rows in the user permissions table
7	Status	the status of this instance of this role for this user (0=Deleted, 1=InActive or 2=Active)
8	Sites	sites at which this user has this role as specified by this instance
9	Subjects	subjects for which this user has this role as specified by this instance

Table 14.23. Field descriptions for DFuserdb.log - Role Record

Field #	Contains	Description
1	Record Time Stamp	the date and time this record was created
2	Record Type	the static letter record identifier: ROLE
3	Record Modifier	the username of the user who created this record
4	Role ID (key field)	a sequential identification number, unique across all roles for all studies, assigned to each role when it is created, regardless of whether or not the role is saved
5	Study	a DFdiscover study number
6	Status	the status of this role (0=Deleted, 1=InActive or 2=Active)
7	Role Name	the role name, which must be unique within a study, but not across studies (Maximum 256 characters)
8	Description	the role description (Maximum 256 characters)
9	DFexplore Views	the list of Explore Views accessible by users with this role ( 0=None, 1=Views-Info, 2=Views-Schedule, 3=Views-Data, 4=Views-Queries, 5=Views-History, 6=Views-Reasons, 7=Views-Image, 8=Views-Data - with Select, 9=Views-Reports, 10=Views-Status, 11=Views-List, 12=SavePrint-Blank CRFs, 13=SavePrint-Completed CRFs, 14=SavePrint-Images, 15=SavePrint-Data, 16=SavePrint-Reports, 17=SavePrint-DFsas jobs, 18=Misc-Developer, 19=Reports-Create lists, 20=List-Create views, 21=Fax-Delete new records, 22=Fax-Raw data entry, 23=May disable edit checks, 24=List-Import Data, 25=Fax-Create tasks, 26=Show query status detail, 27=Data-Import subject CRFs, 28=Data-Submit PDF, 29=Dashboard, 30=Data-Attach subject document or * represents ALL views)
10	Reports	the list of reports accessible by users with this role (DFdiscover report names in comma delimited format or * represents ALL reports)
11	Study Reports	the list of study reports accessible by users with this role (study report names in comma delimited format or * represents ALL study reports)
12	Tasks	the list of Tasks accessible by users with this role (study task names in comma delimited format or * represents ALL tasks) [not implemented in this release]
13	Tools	the comma-delimited list of DFdiscover applications (or application components) accessible by users with this role (0=None, 2=Setup-View, 8=Server-Export Data, 9=Server-Batch Edit checks, 11=Server-Import Data, 12=Setup-Plates, 13=Setup-Edit checks, 14=Setup-Lookup Tables, 15=Setup-Centers, 16=Setup-Missing Map, 17=Setup-Sort Map, 18=Setup-Visit Map, 19=Setup-Conditional Terminations, 20=Setup-Conditional Cycles, 21=Setup-Conditional Visits, 22=Setup-Conditional Plates, 23=Setup-Query Titles, 24=Setup-Query Covers, 25=Setup-Query Messages, 26=Setup-CRF Type Map, 27=Setup-CRF Background Map, 28=Setup-Query Category Map or * represents ALL DFdiscover applications)
14	Auto Logout Default	the initial default auto logout period (in minutes) for DFexplore and DFsetup users with this role (The 'Maximum' can be any value from 1 to 1440 minutes). (0 represents inheriting this value from Study settings).
15	Auto Logout Maximum	the maximum value that can be set as auto logout period (in minutes) in DFexplore and DFsetup by users with this role (The 'Maximum' can be any value from 1 to 1440 minutes). (0 represents inheriting this value from Study settings).

Table 14.24. Field descriptions for DFuserdb.log - Role Perm Record

Field #	Contains	Description
1	Record Time Stamp	the date and time this record was created
2	Record Type	the static 4 letter record identifier: RLPM
3	Record Modifier	the username of the user who created this record
4	Role ID (key field)	a sequential identification number, unique across all roles for all studies, assigned to each role when it is created, regardless of whether or not the role is saved
5	Instance (key field)	a sequential number which identifies the different specifications making up the definition of the current role, i.e. the different rows in the role permissions table for the same Role ID
6	Status	the status of this role instance specification (0=Deleted, 1=InActive or 2=Active)
7	Visits	the visits to which these permissions apply
8	Plates	the plates to which these permissions apply
9	Data Permissions	a list of permissions for data records (1=Create, 2=Modify, 3=Delete, 4=Register as Lost) which are applied in DFexplore.
10	Query Permissions	a list of permissions for queries which are applied in DFexplore. Operations allowed both manually and by edit checks: (1=Create, 2=Modify, 3=Delete, 4=Approve replies, 5=Create/Modify replies), operations allowed only when performed by edit checks: (6=Create, 7=Modify, 8=Delete, 9=Approve replies, 10=Create/Modify replies)
11	Reason Permissions	a list of permissions for reason records which are applied in DFexplore. Operations allowed both manually and by edit checks: (1=Create, 2=Modify, 3=Delete, 4=Approve), operations allowed only when performed by edit checks: (6=Create, 7=Modify, 8=Delete, 9=Approve)
12	Get Levels	only records at these levels can be retrieved in DFexplore (* represents ALL levels, equivalent to 0-7)
13	Modify Levels	only records at these levels can be modified in DFexplore (* represents ALL levels, equivalent to 0-7)
14	Write Levels	records can be written to only these levels in DFexplore (* represents ALL levels, equivalent to 0-7)
15	Hidden Fields	permission to see Hidden Fields - applied in DFexplore. (0=None or 1=All)
16	Internal Queries	permission to see Internal queries - applied in DFexplore. (0=None, 1=Resolved queries only or 2=All)

Table 14.25. Field descriptions for DFuserdb.log - Password Record

Field #	Contains	Description
1	Record Time Stamp	the date and time this record was created
2	Record Type	the static letter record identifier: PASS
3	Record Modifier	the username of the user who created this record
4	User Login (key field)	the username uniquely identifying a DFdiscover user even if that user has been deleted or made inactive.
5	Password Hash	the MD5 hash of the user login and password
6	Expiry	the time in seconds since Jan 1, 1970 that this password expires.

Table 14.26. iso3166-1

Usual Name	iso3166-1
Type	clear text
Created By	NA
Used By	DFsetup, DFexplore
Field Delimiter	`\|`
Record Delimiter	`\n`
Comment Delimiter	NA
Fields/Record	2
Description	This table contains the official ISO 3166-1 three-letter country codes and country names. It is a static table, read only by DFsetup (when identifying the country for a site) and by DFexplore (when reporting data grouped by country).

14.5. DFdiscover system work files

Table 14.27. router_log

Usual Name router_log

Type clear text

Created By DFmaster.rpcd

Used By DFmaster.rpcd, DFserver.rpc

Field Delimiter |

Record Delimiter \n

Comment Delimiter NA

Fields/Record 9

Description

DFexplore Image Router activity, including both input and output, is recorded in the router_log. Each action performed is appended to the log file. The fields of the log file are described in Table 14.28, “ Field descriptions for router_log”.

The fifth field records the type of operation being performed as follows:

cut in two	Indicates that this page was cut resulting in two separate pages.
cut from `####.###X###`	This page was created from the cut operation performed on the specified page.
to study	The page has been sent to the new queue of the study specified in the sixth field.
deleted	This page has been permanently deleted.
printed	This page was either printed or exported as PDF.
from incoming	This page was sent to the router because DFinbound.rpc daemon could not identify it (Barcode read failure).
Moved from study `###`	From DFexplore the page has been sent to the router. It did not belong to the original study.

The last four fields of the log record are not relevant for some operations.

Examples

2017-12-05|10:56:54|sandra|1749.000D001|to study|253|2603|1|3
2017-12-07|11:00:39|sandra|1749.000A001|printed||||
2017-12-07|16:33:01|sandra|1749.000A001|deleted||||

Table 14.28. Field descriptions for router_log

Field #	Description
1	date the operation was performed
2	time the operation was performed
3	user who performed the operation
4	fax page id on which the operation was performed
5	description of the operation
6	study number
7	subject ID
8	visit number
9	plate number

Table 14.29. fax_log

Usual Name	`fax_log`
Type	clear text
Created By	DFmaster.rpcd
Used By	DF_XXtime, DF_ATfaxes, DF_WFcrfsperwk, DFexplore
Field Delimiter	`\|`
Record Delimiter	`\n`
Comment Delimiter	NA
Fields/Record	5
Description	DFmaster.rpcd appends a record to `fax_log` for every fax or PDF received by DFdiscover, thus the most recent transmissions appear at the end of this file. Each record contains 5 pieces of information described in Table 14.30, “ Field descriptions for `fax_log`”. The third field recorded in `fax_log` is the date and time the transmission was received. For a typical fax transmission the date and time comes from the TIFF file "Date & Time" tag created by HylaFAX when the fax is received to disk. If DFdiscover receives a TIFF or PDF file as an email attachment, the date and time written to `fax_log` comes from the computer clock on the machine that processed the incoming mail. This is true, even if a TIFF file attachment already contains a date and time tag representing when it was created at the site. In such cases the original date and time tag is replaced in the TIFF file before it is saved in the DFdiscover archive directory. In the case of a PDF file attachment, Ghostscript is used to convert the file to TIFF format, with the date and time tag set from the machine that processed the incoming PDF, before the attachment is saved in the DFdiscover archive directory. The fourth field contains a quoted string which identifies the sender. It will contain one of the following: the sender id programmed into the sending fax machine if the pages were sent by fax a blank string if the sender id is unknown because the sender id was not programmed into the sending fax machine the senders email address if the file was sent as an email attachment, unless the file contains a non-blank image description field (e.g. TIFF files sent by email may contain such information), in which case the image description is used DFexplore Submit PDF:username if the pages were transmitted using the DFexplore 'Submit PDF' feature.
Example	/opt/dfdiscover/archive/1742/0024\|16\|Tue Oct 17 04:46:23 2017\|555-1212\|28

Table 14.30. Field descriptions for fax_log

Field #	Description
1	full pathname of fax file, typically in archive directory
2	total number of pages in fax
3	date and time fax was transmitted
4	sender identification
5	archive duration. This field is currently ignored unless its value is 0

Table 14.31. fax_log.idx

Usual Name	`fax_log.idx`
Type	binary
Created By	DFmaster.rpcd
Used By	DFmaster.rpcd
Field Delimiter	NA
Record Delimiter	NA
Comment Delimiter	NA
Fields/Record	NA
Description	The `fax_log.idx` file is an index on the `fax_log` file and enables DFmaster.rpcd to quickly retrieve individual entries from `fax_log` for operations such as Get Context in DFexplore. This file is not user editable or readable.

Table 14.32. license

Usual Name	`license`
Type	clear text
Created By	DFadmin
Used By	DFmaster.rpcd
Field Delimiter	`\t` (tab)
Record Delimiter	`\n`
Comment Delimiter	`#`
Fields/Record	2
Description	DFdiscover is a licensed software product. It is licensed for a particular machine (by unique host identifier). Each DFdiscover license is typically valid for a one year period. The license is provided yearly by DF/Net Research, Inc. in the form of a codeword. The codeword encodes, among other things, the host identifier, the expiration date, and the maximum number of concurrent users. The license file contains values for each of the following keywords: `hostid`, `hostname`, `clients`, `expiration`, `password`. The value for `hostname` can be changed without affecting the other values, and in particular, without requiring a new license. However, it is critical that the values for the other keywords not be changed without a new password because they are interrelated.
Example	hostid SH2X-F77S-JURH-DJMQ-JCHW hostname venus nclients 1 expiration 20061231 password KZTD-CQA3-MY5W-HX5E-24N3

Table 14.33. replyfax_log

Usual Name	`replyfax_log`
Type	clear text
Created By	DFadmin
Used By	DFoutbound.rpc
Field Delimiter	`\|`
Record Delimiter	`\n`
Comment Delimiter	`#`
Fields/Record	7
Description	The DFdiscover reply fax configuration includes an option to log all receipts sent to registered sites. This log information is stored in this file, one record per receipt, and is described in Table 14.34, “Field descriptions for `replyfax_log`”.
Example	/opt/studies/xyz/lib/DFreceipt.sample\|SentOk\|Fri May 18 11:16:23 2018\|datafax\|purgatory\|18881234567\|1

Table 14.34. Field descriptions for replyfax_log

Field #	Description
1	the full pathname of the faxed receipt
2	the final fax transmission disposition. Will contain one of two possible values: `SentOk` or `Failed`
3	the date and time that the fax was transmitted
4	the username of the person who requested that the fax be transmitted
5	the hostname of the machine from which the request was made
6	the phone number that the fax was sent to
7	the number of attempts needed to successfully send the fax if the status in field 2 is SentOk, or the total number of failed attempts if the status in field 2 is Failed

Table 14.35. sendfax_log

Usual Name	`sendfax_log`
Type	clear text
Created By	DFoutbound.rpc
Used By
Field Delimiter	`\|`
Record Delimiter	`\n`
Comment Delimiter	NA
Fields/Record	7
Description	Every fax that is faxed from DFdiscover is recorded by DFoutbound.rpc to this file. The file is always appended to so that the most recently transmitted fax is listed at the end of the file. Each fax sent to one recipient represents one record in the file. Each entry records the information described in Table 14.36, “Field descriptions for `sendfax_log`”.
Example	/studyA/reports/QC/001-171203\|SentOk\|Sun Dec 3 11:16:23 2017\|root\|venus\|5551212\|1

Table 14.36. Field descriptions for sendfax_log

Field #	Description
1	the full pathname of the faxed file
2	the final fax transmission disposition. Will contain one of two possible values: `SentOk` or `Failed`
3	the date and time that the fax was transmitted
4	the username of the person who requested that the fax be transmitted
5	the hostname of the machine from which the request was made
6	the phone number that the fax was sent to
7	the number of attempts needed to successfully send the fax if the status in field 2 is SentOk, or the total number of failed attempts if the status in field 2 is Failed

Table 14.37. server_log

Usual Name	`server_log`
Type	clear text
Created By	DFmaster.rpcd
Used By
Field Delimiter	NA
Record Delimiter	`\n`
Comment Delimiter	NA
Fields/Record	5
Description	Each time that a DFdiscover study server starts or exits, it appends a message to this file in the following format: DFserver.rpc.`###`[`PPPPP`]: start\|exit on `Host` at `Date` `Time` where the study number is indicated by `###` and the process id by `PPPPP`. If the server is starting the log message will contain the word `start` and if the server is exiting, the log message will contain the word `exit`. The hostname of the CPU that the server started on is reflected in the `Host` value and the time it started (or exited) in the `Date` and `Time` fields. If the server exited normally there should be exactly one pair of `start` and `stop` log messages for each unique combination of process id and host. Messages are also appended to this file if a DFdiscover administrator deletes a study, study data, or study data and setup info using the DFadmin 'Delete' option. The example below illustrates the message from each of these operations performed on study 101. This log file is not consulted by any DFdiscover process and is purely for informational purposes. It can be truncated if it grows too large.
Example	DFserver.rpc.153[20401]: start on idemo41 at Wed Nov 29 22:22:11 2017 DFserver.rpc.153[20401]: exit at Thu Nov 30 00:54:03 2017 DFedcservice.101[21877]: jack@localhost deleted all study data Fri Dec 1 12:00:09 2017 DFedcservice.101[21877]: jack@localhost deleted all study data and setup info Fri Dec 1 12:01:19 2017 DFedcservice.101[21877]: jack@localhost deleted study from datafax registry Fri Dec 1 12:02:58 2017

Table 14.38. sitefax_log

Usual Name	`sitefax_log`
Type	clear text
Created By	DFoutbound.rpc
Used By
Field Delimiter	`\|`
Record Delimiter	`\n`
Comment Delimiter	NA
Fields/Record	5
Description	Configuration of the DFdiscover replyfax feature allows for logging of each fax that is received from an "unregistered" site. An unregistered site is a sending fax site that not appear in the `DFsites.db` database. One log entry is created for each fax transmission received from an unregistered site. The format of each entry is described in Table 14.39, “Field descriptions for `sitefax_log`”.
Example	/opt/dfdiscover/archive/1820/0025\|1\|Fri May 18 10:20:12 2018\|"905 522 7284"\|unregistered

Table 14.39. Field descriptions for sitefax_log

Field	Description
1	full pathname to the location of the received fax
2	total number of pages in the received fax
3	date and time that the fax was received in `Day Mon DD HH:MM:SS` format
4	Sender identification (typically fax number) of the sending fax machine
5	always contains the string "unregistered"

Table 14.40. .serverstatus###

Usual Name	`.serverstatus###`
Type	clear text
Created By	DFmaster.rpcd
Used By	DFmaster.rpcd, DFserver.rpc
Field Delimiter	NA
Record Delimiter	NA
Comment Delimiter	NA
Fields/Record	1
Description	This file keeps track of the process ID number of the study server if it is currently executing. It is created and used by DFmaster.rpcd to keep track of which study servers are running. It is a serious error to delete a server status file unless instructed to do so by the output of the DFstudyDiag utility.

Table 14.41. .seqYYWW

Usual Name	`.seqYYWW`
Type	clear text
Created By	DFmaster.rpcd
Used By	DFmaster.rpcd
Field Delimiter	NA
Record Delimiter	NA
Comment Delimiter	NA
Fields/Record	1
Description	This file keeps track of the next sequence number to be assigned to an incoming fax within the current week of the current year. These sequence files are created and maintained exclusively by DFmaster.rpcd. Each sequence file has a name of the form `.seqYYWW` where YYWW represents a particular week within a particular year. Each sequence file contains exactly one positive number, which is the next number to be assigned to the next fax which arrives in that particular week of that particular year. When a fax arrives, it is assigned the number from the sequence file. The number is then incremented and written back to the file. If the required sequence file does not exist, it is created by the master and should thereafter remain in existence. It is a serious error to delete any sequence file, however if one is accidentally deleted, it can be recreated with the DFcmpSeq utility.

Table 14.42. .seqOUT

Usual Name	`.seqOUT`
Type	clear text
Created By	DFmaster.rpcd
Used By	DFmaster.rpcd
Field Delimiter	NA
Record Delimiter	NA
Comment Delimiter	NA
Fields/Record	1
Description	This file keeps track of the next sequence number to be assigned to the next outgoing fax. This sequence file is created and maintained exclusively by DFmaster.rpcd. The sequence file contains exactly one positive number, which is the next number to be assigned to the next fax to be sent out. When a fax is sent, it is assigned the number from the sequence file. The number is then incremented and written back to the file. If the required sequence file does not exist, it is created by the master and should thereafter remain in existence. It is a serious error to delete any sequence file.

Prev		Next
Chapter 13. Troubleshooting	Home	Appendix A. Copyrights - Acknowledgments