.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "ECACCESS-JOB-SUBMIT 1p"
.TH ECACCESS-JOB-SUBMIT 1p "2013-12-11" "perl v5.18.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
ecaccess\-job\-submit \- Submit a new ECaccess Job
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBecaccess-job-submit \-version|\-help|\-manual\fR
.PP
\&\fBecaccess-job-submit [\-debug] [\-distant] [\-encrypt] [\-bufsize\fR \fIlength\fR\fB] [\-scheduledDate\fR \fIdate\fR\fB]
[\-noDirectives] [\-gateway\fR \fIname\fR\fB] [\-remote\fR \fIlocation\fR\fB] [\-transferOutput] [\-transferError]
[\-transferInput] [\-keep] [\-eventIds\fR \fIlist\fR\fB] [\-sterr2Stdout] [\-noRenew] [\-mailTo\fR \fIemail\fR\fB]
[\-onStart] [\-onSuccess] [\-onFailure] [\-onRetry] [\-jobName\fR \fIname\fR\fB] [\-manPage\fR \fIcontent\fR\fB]
[\-lifeTime\fR \fIdays\fR\fB] [\-retryCount\fR \fInumber\fR\fB] [\-retryFrequency\fR \fIfrequency\fR\fB] [\-queueName\fR \fIname\fR\fB]\fR
\&\fIsource\fR
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Allow submitting the \fIsource\fR script on either the default ECaccess batch queue or the ECaccess batch queue
specified with the \fI\-queueName\fR option. ECaccess batch queue name can be obtained with the \fBecaccess-queue-list\fR
command (the default queue is the first in the list).
.PP
A special service (see option \fB\-eventIds\fR) allows to automatically submit jobs to be run when certain points in the daily
\&\s-1ECMWF\s0 operational forecast suite have been reached. The main purpose is to ensure that certain data is available before
e.g. submitting a \s-1MARS\s0 request. These events correspond to the different stages when the \s-1ECMWF\s0 operational activity
has produced certain data or products. The list of events can be retrieved with the \fBecaccess-event-list\fR command.
.PP
In order to facilitate the migration from the old ECtools (ecjreq/ecjput commands) the equivalents options can be set using
their old names (e.g. \fB\-at\fR for \fB\-scheduledDate\fR). This should limit the scripts modifications for job submissions.
.SH "ARGUMENTS"
.IX Header "ARGUMENTS"
.IP "\fIsource\fR" 8
.IX Item "source"
The name of the file which contains the job input script (depending of the \-distant
option this file is either at \s-1ECMWF\s0 or local to your workstation).
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-distant\fR" 8
.IX Item "-distant"
By default the \fIsource\fR is specifying a file which is local to your workstation. Using this option
allow submitting a script which is already at \s-1ECMWF.\s0
.IP "\fB\-encrypt\fR" 8
.IX Item "-encrypt"
By default the \fIsource\fR file is uploaded through the plain text channel (http).
Using this option will force the upload to occurs through the \s-1SSL\s0 secure
channel (https). This option only apply for local scripts (no \fB\-distant\fR).
.IP "\fB\-bufsize\fR \fIlength\fR" 8
.IX Item "-bufsize length"
Specify the \fIlength\fR of the buffer (in bytes) which is used to upload the file.
The larger the buffer the smaller the number of http/s requests. By default a
buffer of 524288 bytes (512KB) is used. This option only apply for local scripts
(no \fB\-distant\fR).
.IP "\fB\-at, \-scheduledDate\fR \fIdate\fR" 8
.IX Item "-at, -scheduledDate date"
Allow specifying the start \fIdate\fR for the Job. By default the job will start
as soon as possible. The format for the date is 'yyyy\-MM\-dd HH:mm'.
.IP "\fB\-nd, \-noDirectives\fR" 8
.IX Item "-nd, -noDirectives"
Allow submitting a job with no scheduler directives. Some default directives
will be added to your input script to allow processing the job.
.IP "\fB\-tg, \-gateway\fR \fIname\fR" 8
.IX Item "-tg, -gateway name"
This is the \fIname\fR of the target ECaccess Gateway for the transfers. It is by default
the Gateway you are connected to. In order to get the name of your current Gateway you
can use the \fBecaccess-gateway-name\fR command. When using the commands at \s-1ECMWF\s0 the
default Gateway is always \*(L"ecaccess.ecmwf.int\*(R".
.IP "\fB\-tr, \-remote\fR \fIlocation\fR" 8
.IX Item "-tr, -remote location"
Defines the target ECtrans \fIlocation\fR in the format \fIassociation-name\fR\fB[\fR\fI\f(CI@protocol\fI\fR\fB]\fR.
.IP "\fB\-to, \-transferOutput\fR" 8
.IX Item "-to, -transferOutput"
Request the transfer of the job standard output to the gateway and remote location defined
in the \fB\-gateway\fR and \fB\-remote\fR options.
.IP "\fB\-te, \-transferError\fR" 8
.IX Item "-te, -transferError"
Request the transfer of the job error output to the gateway and remote location defined
in the \fB\-gateway\fR and \fB\-remote\fR options.
.IP "\fB\-ti, \-transferInput\fR" 8
.IX Item "-ti, -transferInput"
Request the transfer of the job input to the gateway and remote location defined
in the \fB\-gateway\fR and \fB\-remote\fR options.
.IP "\fB\-tk, \-keep\fR" 8
.IX Item "-tk, -keep"
Allow keeping the transfers requests in the spool.
.IP "\fB\-ni, \-eventIds\fR \fIlist\fR" 8
.IX Item "-ni, -eventIds list"
Allow giving a \fIlist\fR of event-identifiers to subscribe to with the Job. The list should
be separated by ';' or ','.
.IP "\fB\-eo, \-sterr2Stdout\fR" 8
.IX Item "-eo, -sterr2Stdout"
Force redirection of the job standard error output (stderr) to the job standard output (stdout).
.IP "\fB\-ro, \-noRenew\fR" 8
.IX Item "-ro, -noRenew"
The job subscriptions to events will not be renewed.
.IP "\fB\-mu, \-mailTo\fR \fIemail\fR" 8
.IX Item "-mu, -mailTo email"
Defines the target \fIemail\fR address (default: current \s-1ECMWF\s0 user identifier).
.IP "\fB\-mb, \-onStart\fR" 8
.IX Item "-mb, -onStart"
Allow sending a mail when the execution/transfer begins.
.IP "\fB\-me, \-onSuccess\fR" 8
.IX Item "-me, -onSuccess"
Allow sending a mail when the execution/transfer ends.
.IP "\fB\-mf, \-onFailure\fR" 8
.IX Item "-mf, -onFailure"
Allow sending a mail when the execution/transfer fails.
.IP "\fB\-mr, \-onRetry\fR" 8
.IX Item "-mr, -onRetry"
Allow sending a mail when the execution/transfer retries.
.IP "\fB\-queueName\fR \fIname\fR" 8
.IX Item "-queueName name"
The name of the ECaccess batch queue to submit the job to.
.IP "\fB\-jn, \-jobName\fR \fIname\fR" 8
.IX Item "-jn, -jobName name"
Allow specifying a \fIname\fR for the new Job (other than the Job Identifier). If no name
is specified then the name of the input script is used.
.IP "\fB\-mp, \-manPage\fR \fIcontent\fR" 8
.IX Item "-mp, -manPage content"
Allow giving the man page \fIcontent\fR which will be displayed to the \s-1ECMWF\s0 operators in
case of problems with your Job (e.g. what to do or who to contact).
.IP "\fB\-lt, \-lifeTime\fR \fIdays\fR" 8
.IX Item "-lt, -lifeTime days"
Allow specifying the job input/output life time in \fIdays\fR. The default is 7 days.
.IP "\fB\-rc, \-retryCount\fR \fInumber\fR" 8
.IX Item "-rc, -retryCount number"
Defines the \fInumber\fR of retries. The default is 0.
.IP "\fB\-rf, \-retryFrequency\fR \fIfrequency\fR" 8
.IX Item "-rf, -retryFrequency frequency"
Defines the \fIfrequency\fR of retries in seconds. The default is 600 seconds.
.IP "\fB\-version\fR" 8
.IX Item "-version"
Display version number and exits.
.IP "\fB\-help\fR" 8
.IX Item "-help"
Print a brief help message and exits.
.IP "\fB\-manual\fR" 8
.IX Item "-manual"
Prints the manual page and exits.
.IP "\fB\-retry\fR \fIcount\fR" 8
.IX Item "-retry count"
Number of \s-1SSL\s0 connection retries per 5s to \s-1ECMWF.\s0 This parameter only apply to the
initial \s-1SSL\s0 connection initiated by the command to the \s-1ECMWF\s0 server. It does not
apply to all the subsequent requests made afteward as it is mainly targeting errors
that can happen from time to time during the \s-1SSL\s0 handshake. Default is no retry.
.IP "\fB\-debug\fR" 8
.IX Item "-debug"
Display the \s-1SOAP\s0 and \s-1SSL\s0 messages exchanged.
.SH "EXAMPLES"
.IX Header "EXAMPLES"
\&\fBecaccess-job-submit \-noDirectives\fR \fI./test.txt\fR
.PP
Transfer the local file \fItest.txt\fR to your \s-1ECMWF\s0 spool and submit the job to the default ECaccess batch queue.
The source does not have any directives.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBecaccess-queue-list\fR, \fBecaccess-event-list\fR, \fBecaccess-job-delete\fR, \fBecaccess-job-get\fR, \fBecaccess-job-list\fR
\&\fBecaccess-job-restart\fR and \fBecaccess\fR.