Page History

<style type="text/css">
.highlight .hll { background-color: #ffffcc }
.highlight  { background: #eeffcc; }
.highlight .c { color: #408090; font-style: italic } /* Comment */
.highlight .err { border: 1px solid #FF0000 } /* Error */
.highlight .k { color: #007020; font-weight: bold } /* Keyword */
.highlight .o { color: #666666 } /* Operator */
.highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */
.highlight .cp { color: #007020 } /* Comment.Preproc */
.highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */
.highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */
.highlight .gd { color: #A00000 } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .gr { color: #FF0000 } /* Generic.Error */
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
.highlight .gi { color: #00A000 } /* Generic.Inserted */
.highlight .go { color: #303030 } /* Generic.Output */
.highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
.highlight .gt { color: #0040D0 } /* Generic.Traceback */
.highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #007020 } /* Keyword.Pseudo */
.highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #902000 } /* Keyword.Type */
.highlight .m { color: #208050 } /* Literal.Number */
.highlight .s { color: #4070a0 } /* Literal.String */
.highlight .na { color: #4070a0 } /* Name.Attribute */
.highlight .nb { color: #007020 } /* Name.Builtin */
.highlight .nc { color: #0e84b5; font-weight: bold } /* Name.Class */
.highlight .no { color: #60add5 } /* Name.Constant */
.highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */
.highlight .ni { color: #d55537; font-weight: bold } /* Name.Entity */
.highlight .ne { color: #007020 } /* Name.Exception */
.highlight .nf { color: #06287e } /* Name.Function */
.highlight .nl { color: #002070; font-weight: bold } /* Name.Label */
.highlight .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */
.highlight .nt { color: #062873; font-weight: bold } /* Name.Tag */
.highlight .nv { color: #bb60d5 } /* Name.Variable */
.highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
.highlight .mf { color: #208050 } /* Literal.Number.Float */
.highlight .mh { color: #208050 } /* Literal.Number.Hex */
.highlight .mi { color: #208050 } /* Literal.Number.Integer */
.highlight .mo { color: #208050 } /* Literal.Number.Oct */
.highlight .sb { color: #4070a0 } /* Literal.String.Backtick */
.highlight .sc { color: #4070a0 } /* Literal.String.Char */
.highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */
.highlight .s2 { color: #4070a0 } /* Literal.String.Double */
.highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */
.highlight .sh { color: #4070a0 } /* Literal.String.Heredoc */
.highlight .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */
.highlight .sx { color: #c65d09 } /* Literal.String.Other */
.highlight .sr { color: #235388 } /* Literal.String.Regex */
.highlight .s1 { color: #4070a0 } /* Literal.String.Single */
.highlight .ss { color: #517918 } /* Literal.String.Symbol */
.highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */
.highlight .vc { color: #bb60d5 } /* Name.Variable.Class */
.highlight .vg { color: #bb60d5 } /* Name.Variable.Global */
.highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */
.highlight .il { color: #208050 } /* Literal.Number.Integer.Long */
</style>


<div class="section" id="defining-the-first-task">
<span id="defining-a-task"></span><span id="index-0"></span>
<p>Next, we need to write the <a class="reference internal" href="../../../glossary/#term-ecf-script"><em class="xref std std-term">ecf script</em></a> for the task <strong>t1</strong>.
By default ECF expects files to be in a directory structure below ECF_HOME that reflect the hierarchy of the suites.
The <a class="reference internal" href="../../../glossary/#term-task"><em class="xref std std-term">task</em></a> <strong>t1</strong> being in the <a class="reference internal" href="../../../glossary/#term-suite"><em class="xref std std-term">suite</em></a> test, the <a class="reference internal" href="../../../glossary/#term-ecf-script"><em class="xref std std-term">ecf script</em></a> for the task <strong>t1</strong> must be in a sub-directory test.</p>
<ul>
<li><p class="first">In ECF_HOME, create a directory test:</p>
<div class="highlight-python"><pre>&gt; mkdir test</pre>
</div>
</li>
<li><p class="first">In test, create a file name <tt class="file docutils literal"><span class="pre">t1.ecf</span></tt> with the following contents:</p>
<div class="highlight-python"><pre>%include "../head.h"
echo "I am part of a suite that lives in %ECF_HOME%"
%include "../tail.h"</pre>
</div>
</li>
</ul>
<p>Although similar an <a class="reference internal" href="../../../glossary/#term-ecf-script"><em class="xref std std-term">ecf script</em></a> is not a unix script. It contains <a class="reference internal" href="../../../glossary/#term-pre-processing"><em class="xref std std-term">pre-processing</em></a> <a class="reference internal" href="../../../glossary/#term-directives"><em class="xref std std-term">directives</em></a>.
Those <a class="reference internal" href="../../../glossary/#term-directives"><em class="xref std std-term">directives</em></a> are specified using the character %.
Before submitting the task, the ECF will scan the script and substitute the following strings:</p>
<ul class="simple">
<li>%include &#8221;../head.h&#8221; will be substituted by the content of the file <a class="reference internal" href="../getting-started/#head-h"><em>head.h</em></a>.
Note that the file name is given relatively to the file <tt class="file docutils literal"><span class="pre">t1.ecf</span></tt>, i.e. in the directory above the one containing <tt class="file docutils literal"><span class="pre">t1.ecf</span></tt></li>
<li>%ECF_HOME% will be substituted by the value of the ECF variable ECF_HOME</li>
<li>%include <em>&#8221;../tail.h&#8221;</em> will be substituted by the content of the file <a class="reference internal" href="../getting-started/#tail-h"><em>tail.h</em></a></li>
</ul>
<p>The output of <a class="reference internal" href="../../../glossary/#term-job-creation"><em class="xref std std-term">job creation</em></a> is known as the <a class="reference internal" href="../../../glossary/#term-job-file"><em class="xref std std-term">job file</em></a>, and is usually a unix script, although not necessarily.
This is the script that ECF will submit to your system.</p>
<p>The workings of the files <a class="reference internal" href="../getting-started/#head-h"><em>head.h</em></a> and <a class="reference internal" href="../getting-started/#tail-h"><em>tail.h</em></a> are described inline.
head.h contains code to set-up the job environment so that it can work with ECF and also
includes the required error trapping to report any script errors to the ECF server.
The file <a class="reference internal" href="../getting-started/#tail-h"><em>tail.h</em></a> contains clean up code.</p>
<p>What to do:</p>
<ol class="arabic simple">
<li>Type in the <a class="reference internal" href="../../../glossary/#term-ecf-script"><em class="xref std std-term">ecf script</em></a> <tt class="file docutils literal"><span class="pre">t1.ecf</span></tt></li>
</ol>
</div>