.TH "globus_gram_job_manager_rsl_validation_file" 3 "Mon Apr 30 2012" "Version 13.33" "globus gram job manager" \" -*- nroff -*-
.ad l
.nh
.SH NAME
globus_gram_job_manager_rsl_validation_file \- RSL Validation File Format 
The idea behind the RSL Validation file is to provide a mechanism for job manager scheduler interfaces to implement RSL extensions, while having the job manager still be able to decide whether a job request contains a valid RSL string\&.
.PP
In addition to indicating what RSL attributes are valid, the RSL validation file contains information about when the RSL attribute may be used, it's default value, and the format of the attribute's value\&.
.SH "File Format"
.PP
.SS "Comments"
The RSL validation file may contain comments\&. Comments are indicated in the file by a line beginning with the \fI#\fP character\&. Comments continue until end-of-line\&. Comments are discarded by the RSL Validation File parser\&.
.PP
Example:
.PP
.PP
.nf
# I am a comment\&. Ignore me\&.
.fi
.PP
.SS "ValidationRecords"
The RSL validition file consists of a set of \fIValidationRecords\fP\&. Each \fIValidationRecord\fP consists of a number of \fIValidationProperties\fP associated with a single RSL attribute\&. \fIValidationRecord\fPs are separated by a blank line in the RSL validation file\&.
.SS "Validation Properties"
A \fIValidationProperty\fP is defined in the RSL validation file by a \fIPropertyName\fP and a \fIPropertyValue\fP\&. The syntax of a validation property is simply the \fIPropertyName\fP followed by a colon character, followed by a \fIPropertyValue\fP\&.
.PP
If a \fIPropertyValue\fP begins with a double-quote, then it may span multiple lines\&. Double-quote characters within a multiline \fIPropertyValue\fP must be escaped by a preceding backslash character\&. An unquoted \fIPropertyValue\fP ends at the first newline character\&.
.PP
Example:
.PP
.PP
.nf
Attribute: directory
Description: 'Specifies the path of the directory the jobmanager will
              use as the default directory for the requested job\&.'
.fi
.PP
.SS "Defined PropertyNames"
The following \fIPropertyName\fPs are understood by this version of the RSL validation file parser\&. Any unknown \fIPropertyName\fP will cause the \fIValidationProprty\fP to be ignored by the parser\&.
.PP
\fBAttribute\fP
.RS 4
The name of the RSL parameter to which this record refers\&.
.RE
.PP
\fBDescription\fP
.RS 4
A textual description of what the RSL parameter means\&.
.RE
.PP
\fBDefault\fP
.RS 4
The default value of the RSL parameter if it is not found in the RSL\&. The default value is only used if the DefaultWhen value matches the current validation mode\&.
.RE
.PP
\fBValues\fP
.RS 4
A string containing whitespace-separated list of enumerated values which are valid for this RSL attribute\&. For example, for the 'dryrun' parameter, this may be \fB'yes no'\fP\&.
.RE
.PP
\fBRequiredWhen\fP
.RS 4
Some subset of the 'when strings' (\fBsee below\fP), indicating when the RSL parameter is required for the RSL to be valid\&.
.RE
.PP
\fBDefaultWhen\fP
.RS 4
Some subset of the 'when strings' (\fBsee below\fP) indicating when then RSL's default value will be used if the RSL attribute is not present in the RSL\&.
.RE
.PP
\fBValidWhen\fP
.RS 4
Some subset of the 'when strings' (\fBsee below\fP) indicating when then RSL attribute may be used\&.
.RE
.PP
.SS "'When' Strings"
The set of when strings understood by the RSL validation file parser are
.PP
\fBGLOBUS_GRAM_JOB_SUBMIT\fP
.RS 4
The RSL attribute pertains to job submission\&.
.RE
.PP
\fBGLOBUS_GRAM_JOB_MANAGER_RESTART\fP
.RS 4
The RSL attribute pertains to job manager restart\&.
.RE
.PP
\fBGLOBUS_GRAM_JOB_MANAGER_STDIO_UPDATE\fP
.RS 4
The RSL attribute pertains to the STDIO_UPDATE signal\&. 
.RE
.PP