ODRF
Prev 6.7.3. Reference Pages Next

ODRF

ODRF — which records are logged to an external DFdiscover Retrieval File (DRF) and when

Synopsis

Content model

ODRF ::=
EMPTY

Attributes

NameTypeDefaultDescription
whichEnumeration:
none
data
msg
qc
none

The value for this attribute is one or more (space-delimited) words from the enumerated list. Inclusion of a word in the attribute value indicates that the batch is interested in the action of this operation.

Edit checks operate in three distinct areas:

  • data - changes that are made to data field values
  • qc - addition/modification of queries to data fields by dfaddqc() and dfeditqc or missing page query operations by dfaddmpqc() and dfdelmpqc()
  • msg - messages that are generated by dfmessage(), dfwarning(), and dferror()

none is beneficial only when used on its own. Specifying another word in addition to none is the same as not specifying none at all. For example, 

which="none msg"

is equal to 

which="msg"

whenEnumeration:
all
changes
NoneIf the value is all, every record, or edit check (in the case of LOG), every action is taken. If the value is changes, only those records which are changed, or edit checks (in the case of LOG) that cause a change, are actioned.
fileCDATANoneA relative or absolute pathname. For relative pathnames, the base directory is the $STUDY_DIR/drf directory of the study. The pathname must be specified using UNIX file and directory naming semantics. If the pathname is not given, the processing system will create a pathname from:

  1. the base directory of $STUDY_DIR/drfof the study followed by

  2. the name of the batch, and terminated with

  3. the fixed suffix, .drf

The pathname specification can also include a sub-folder, the basic rule is, /STUDY_DIR/drf/sub-folder/xx_out.drf, which starts from absolute path, or sub-folder/xx_out.drf, which is a relative path. In both ways, the output file should be found in /STUDY_DIR/drf/sub-folder/xx_out.drf. The filename cannot contain ../ or /.. to alter the file path. Doing this will lead to error.
shareEnumeration:
yes
no
NoneIs this file sharable (meaning readable and writable) with other members of the same group? If the attribute value is no, the file can be read and written by the creator only. If the attribute value is yes, the file can be read and written by the creator and others in the same group as the creator. If the attribute is not specified, the sharing is inherited from the user's environment. In UNIX, this is defined by the umask command.
modeEnumeration:
create
write
writeshould the file be created, (create), or (over)written, (write)? Generally, files will be created with write so that they can be subsequently overwritten when the batch is re-run. However, if a batch is only intended to be run once or you would like to ensure that the log file does not accidentally overwrite a log file from another batch that might have the same name, use create.
[Note]Note

The combination of attributes mode="create" and history="yes" has no semantic meaning as it will never be possible to preserve the history of a log file that can only be created once.

Description

Parents

These elements contain ODRF: ACTION.

Children

The following elements occur in ODRF: None.

Examples

Example 6.45. Write all records that have had messages generated to the DRF named /opt/studies/254/batch/outputs/sample1.drf and enable file sharing 

<ODRF
        when="all"
        which="msg"
        file="/opt/studies/254/batch/outputs/sample1.drf"
        share="yes"
        mode="write"
/>

Example 6.46. Write records which have had data value changed or messages generated to the DRF in a sub-folder 

<ODRF
        when="all"
        which="data msg"
        file="test/sample1.drf"
/>

or 

<ODRF
        when="all"
        which="data msg"
        file="/STUDY_DIR/drf/test/sample1.drf"
/>

The output file should be found in /STUDY_DIR/drf/test/sample1.drf


Prev Up Next
MOVETO Home PLATE