Chapter 2. Reference Pages

Table of Contents

2.1. Organization of Reference Pages
2.1.1. Name
2.1.2. Synopsis
2.1.3. Description
2.1.4. Options
2.1.5. Examples
2.1.6. See Also
2.1.7. Limitations
2.2. Alphabetical Listing, DFdiscover Reports
DF_DatabaseDefinition — Database Definition
DF_Enrollment — Enrollment by Site
DF_InboundTraffic — Inbound Traffic
DF_PlateStatus — Plate Status
DF_QueryReport — Query Report
DF_QueryUpdate — Query Update
DF_SBhistory — History of Changes
DF_SBschedule — Subject Schedule of Visits
DF_SBunexpected — Subject Unexpected Visits
DF_SSsites — Site Definition
DF_STcrfs — CRFs by Site
DF_STqueries — Queries by Site
DF_STvisits — Visits by Site
DF_Status — Status and Level Summary
DF_queriesbyfield — Queries by Field
2.3. Alphabetical Listing, Legacy Reports
DF_ATcrfs — Track keys associated with a CRF page over time
DF_ATfaxes — Trace validation history of each page in selected documents
DF_ATmods — Trace database modifications over a time period
DF_CTcrfs — Summary report of records received from each site
DF_CTpages — Summary report of CRF pages received during a specified time period.
DF_CTqcs — Summary report of external queries for each site
DF_CTvisits — Number of subjects who have reached each visit at each site
DF_ICcenters — Verify consistency of the sites database
DF_ICimages — Verify image references against data records
DF_ICkeys — Check key fields (id,visit,plate) and subject initials
DF_ICqcs — Check queries for consistency with data records
DF_ICrecords — Check data records for structural inconsistencies
DF_ICschema — Check database schema for common errors and inconsistencies
DF_ICvisitdates — List problems detected by the last execution of DF_XXkeys
DF_ICvisitmap — Report inconsistencies and errors in the study visit map
DF_PTcrfs — Display available CRF information for subjects
DF_PTlist — List subject data grouped by subject ID and visit number
DF_PTmissing — Display missing pages and overdue visits
DF_PTqcs — Summary report of external queries for each subject
DF_PTschedule — Display subject scheduling information from DF_QCreports
DF_PTunexpected — List unexpected data records found in the study database
DF_PTvisits — Scheduling and status of all cycles & visits in the visit map
DF_QCfax — Fax or email Query Reports
DF_QCfaxlog — Examine the transmission date/time and status of faxed/emailed Query Reports
DF_QCprint — Print Query Reports
DF_QCreports — Create Query Reports
DF_QCsent — Mark Query Reports as sent
DF_QCstatus — List existing Query Reports
DF_QCupdate — Update Query database
DF_QCview — Display requested Query Reports
DF_SScenters — Display study site information
DF_SSschema — Display detailed data dictionary information
DF_SSvars — Display essential variable information from data dictionary
DF_SSvisitmap — List visit scheduling specifications for a study
DF_WFcrfs — Summary of daily journal transactions for CRF validation
DF_WFcrfsperwk — List and graph incoming fax traffic
DF_WFdiskusage — List and graph weekly disk usage
DF_WFfaxes — Summary of elapsed time to 1st validation
DF_WFqcs — Summary of daily journal transactions for queries
DF_XXkeys — Export keys and visit dates from required plates
DF_XXtime — Prepare timing summary files for other reports
DF_qcsbyfield — Tabulate and summarize queries by category
DF_stats — Display simple variable statistics for a single plate

This chapter is a reference for each DFdiscover and each legacy report. The reference information for each report is the same (except for formatting) as that available from DFexplore's Reports view. In that view, the information is available by selecting the report name and clicking Explain.

2.1. Organization of Reference Pages

The description of each report in this reference is divided into sections.

2.1.1. Name

The official name of the report.

The report name is case sensitive and must be typed exactly as specified. This section also provides the brief purpose of the report.

2.1.2. Synopsis

Lists all of the valid options for the report invocation.

When a report is invoked from the command-line, the study number is a required option and must appear as the first option. When the same report is invoked from Reports View in DFexplore, the study number is inserted automatically so it should not be manually inserted in the options list. The only situation in which the study number is not required, occurs when the user requests a usage message for the specified report. A usage message is produced when running a report from a shell or DFexplore's Reports View by specifying -u as the first option following the report name.

Each option is either optional or required. Most options are, not surprisingly, optional, a few are required, and yet others may require one option from a specific subset. Each option type is indicated with a particular notation. Except for some required options, a report option begins with - and is followed by an option letter. In some cases this may be enough to select the option; in other cases, the option letter will be further followed by an option string.

[Note]Option Letter

An option letter may be given different meanings in different reports. There is no requirement that the same option letter infers the same meaning when used across different reports.

Table 2.1. Notation for report options

NotationMeaning

{study}

Required. The report will not function without the specification of this option. The option must be provided at the specified location in the list of options.

[-o]

Optional. The option may be omitted. The report will function, albeit differently, with or without this option.

[-o string ]

Optional, with an additional option string. The option may be omitted, however when it is used, the option letter must be immediately followed by a space and the option string. The option string generally ends at the next white-space character, however some option strings may contain spaces, and may or may not require that such strings be delimited by ".

{ [-s] | [-u] }

One of the options from the specified subset is required.

[ [-s #] | [-u #] ]

Several options are possible but only zero or one from the specified subset may be used.


2.1.3. Description

Describes the report purpose in greater detail.

This section describes exactly how the report works in terms of environment, input requirements, output format, dependencies, etc. It may also include detailed information about the report behavior for commonly used combinations of options.

2.1.4. Options

Detailed listing of available options, their use, and their meaning.

2.1.5. Examples

Illustrates the report options and output by way of example(s).

2.1.6. See Also

Lists other reference materials, typically other reports, that are relevant to the report. This is an optional section.

2.1.7. Limitations

Describes any limitations in the use or capabilities of the report. This in an optional section.

2.2. Alphabetical Listing, DFdiscover Reports

2.3. Alphabetical Listing, Legacy Reports