<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta name="robots" content="noindex">
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<!-- THIS FILE IS AUTOMATICALLY GENERATED FROM THE GLOBUS SOURCE CODE
DO NOT MODIFY.
-->
<title>Globus Reference Manual</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head>
<body>
<!-- Generated by Doxygen 1.8.3.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('globus_gram_job_manager_rsl_validation_file.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">RSL Validation File Format </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>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.</p>
<p>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.</p>
<h1><a class="anchor" id="validation_file_format"></a>
File Format</h1>
<h2><a class="anchor" id="validation_comments"></a>
Comments</h2>
<p>The RSL validation file may contain comments. Comments are indicated in the file by a line beginning with the <em>#</em> character. Comments continue until end-of-line. Comments are discarded by the RSL Validation File parser.</p>
<p>Example:</p>
<div class="fragment"><div class="line"><span class="preprocessor"># I am a comment. Ignore me.</span></div>
</div><!-- fragment --><h2><a class="anchor" id="validation_records"></a>
ValidationRecords</h2>
<p>The RSL validition file consists of a set of <em>ValidationRecords</em>. Each <em>ValidationRecord</em> consists of a number of <em>ValidationProperties</em> associated with a single RSL attribute. <em>ValidationRecord</em>s are separated by a blank line in the RSL validation file.</p>
<h2><a class="anchor" id="validation_properties"></a>
Validation Properties</h2>
<p>A <em>ValidationProperty</em> is defined in the RSL validation file by a <em>PropertyName</em> and a <em>PropertyValue</em>. The syntax of a validation property is simply the <em>PropertyName</em> followed by a colon character, followed by a <em>PropertyValue</em>.</p>
<p>If a <em>PropertyValue</em> begins with a double-quote, then it may span multiple lines. Double-quote characters within a multiline <em>PropertyValue</em> must be escaped by a preceding backslash character. An unquoted <em>PropertyValue</em> ends at the first newline character.</p>
<p>Example:</p>
<div class="fragment"><div class="line">Attribute: directory</div>
<div class="line">Description: <span class="stringliteral">"Specifies the path of the directory the jobmanager will</span></div>
<div class="line"><span class="stringliteral"> use as the default directory for the requested job."</span></div>
</div><!-- fragment --><h2><a class="anchor" id="rsl_validation_record_types"></a>
Defined PropertyNames</h2>
<p>The following <em>PropertyName</em>s are understood by this version of the RSL validation file parser. Any unknown <em>PropertyName</em> will cause the <em>ValidationProprty</em> to be ignored by the parser.</p>
<dl class="section user"><dt>Attribute</dt><dd>The name of the RSL parameter to which this record refers.</dd></dl>
<dl class="section user"><dt>Description</dt><dd>A textual description of what the RSL parameter means.</dd></dl>
<dl class="section user"><dt>Default</dt><dd>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.</dd></dl>
<dl class="section user"><dt>Values</dt><dd>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 <b>"yes no"</b>.</dd></dl>
<dl class="section user"><dt>RequiredWhen</dt><dd>Some subset of the "when strings" (<a class="el" href="globus_gram_job_manager_rsl_validation_file.html#when_strings">see below</a>), indicating when the RSL parameter is required for the RSL to be valid.</dd></dl>
<dl class="section user"><dt>DefaultWhen</dt><dd>Some subset of the "when strings" (<a class="el" href="globus_gram_job_manager_rsl_validation_file.html#when_strings">see below</a>) indicating when then RSL's default value will be used if the RSL attribute is not present in the RSL.</dd></dl>
<dl class="section user"><dt>ValidWhen</dt><dd>Some subset of the "when strings" (<a class="el" href="globus_gram_job_manager_rsl_validation_file.html#when_strings">see below</a>) indicating when then RSL attribute may be used.</dd></dl>
<h2><a class="anchor" id="when_strings"></a>
"When" Strings</h2>
<p>The set of when strings understood by the RSL validation file parser are</p>
<dl class="section user"><dt>GLOBUS_GRAM_JOB_SUBMIT</dt><dd>The RSL attribute pertains to job submission.</dd></dl>
<dl class="section user"><dt>GLOBUS_GRAM_JOB_MANAGER_RESTART</dt><dd>The RSL attribute pertains to job manager restart.</dd></dl>
<dl class="section user"><dt>GLOBUS_GRAM_JOB_MANAGER_STDIO_UPDATE</dt><dd>The RSL attribute pertains to the STDIO_UPDATE signal. </dd></dl>
</div></div><!-- contents -->
</div><!-- doc-content -->
<hr>
<p align="center">
<a href="http://www.globus.org/toolkit/about.html" target="_top">about globus</a> |
<a href="http://www.globus.org/toolkit/" target="_top">globus toolkit</a> |
<a href="https://dev.globus.org/wiki/Welcome/" target="_top">dev.globus</a>
<br>
<br>
Comments? <a href="mailto:webmaster@globus.org">webmaster@globus.org</a>
</body>
</html>
