Versions Compared

Old Version 22

changes.mady.by.user Laurent Gougeon

Saved on

compared with

New Version 23

changes.mady.by.user Laurent Gougeon

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

NameDefaultType/UnitComment
returnCode"0"integerAllow specifying the expected exit code of the command started with the "script" option. If the exit code is different from the one specified in this parameter then the transmission is tagged as failed. This value can be overwritten in the ECtrans Association. This option is only used when the "synchronous" option is set to "true", otherwise the script is started in the background and ECtrans does not wait for the exit code to return.
script${ecmwf.dir}/gateway/bin/ectransstringAllow specifying the script to execute on the ECaccess Gateway once a file has been transmitted.
dir-stringSets the working directory for the data transmission.
synchronous"true"booleanIf set then the script is started and ECtrans wait for the exit code to return, If not set then the script is started in the background and ECtrans does not wait for the exit code to return.
usePipe"false"booleanIf set then the arguments (parameters) of the script are sent one per line to the standard input stream of the process running the script. If not set then the arguments (parameters) are passed to the script through the command-line. This option can be useful to hide the arguments passed to the script, which could be seen by a "ps" command started on the system.
args-string

This is the string which is passed to the script for execution.

e.g. args="-user $ecuser -filename $target"

The args string can take the following parameters:

  • $msuser[name]: name of the association.
  • $msuser[comment]: comment.
  • $msuser[dir]: target directory.
  • $msuser[host]: target host.
  • $msuser[login]: login identifier.
  • $msuser[passwd]: password.
  • $msuser[password]: alias to $msuser[passwd].
  • $ecuser[name]: ECMWF user-name.
  • $ecuser[uid]: ECMWF user-identifier.
  • $ecuser[gid]: ECMWF group-identifier.
  • $ecuser[dir]: ECMWF home directory.
  • $ecuser[shell]: ECMWF login shell.
  • $ecuser[comment]: ECMWF comment.
  • $ecuser: alias to $ecuser[name].
  • $target: target file name (absolute path).
  • $dir: working directory as defined in the "dir" option.
  • $location: alias to $dir.
  • $password: alias to $msuser[passwd].
mkdirs"true"booleanAllow creating the directory named by the target pathname, including any necessary but non-existent parent directories.
usetmp"true"booleanForce using a temporary name when transmitting a file to the ECaccess Gateway. Once the transmission has completed successfully, and before the script is started, the file is renamed with its final target name. The temporary file name is by default the file name with the ".tmp" suffix concatenated to it, however this behaviour can be customised with the "prefix" and "suffix" options.
prefix-stringWhen using the "usetmp" option, this option allow setting the prefix to use for the temporary file name (e.g. ".").
suffix-stringWhen using the "usetmp" option, this option allow setting the suffix to use for the temporary file name (e.g. ".tmp").

...