Parameter lists in detail:


COMMAND

Command

Usage: COMMAND COMMAND
1 parameter in this list:

COMMAND

Additional command appended to the request string, in format name=value
  • Format: Character (88 characters)
  • Default value: Not specified

CUPDATE

Code update

This command downloads updated versions of IGeoS codes and installs them. The updated codes are identified by their higher "build numbers".

Usage: CUPDATE MODE DO DONOT
3 parameters in this list:

MODE

Type of operation:
  • UPDATE : version from server is loaded if it is newer;
  • REVERT : version from server is loaded if it is older;
  • FORCE : version from server is loaded regardless of the version numbers;
    • Format: Selection
    • Selectable Values: (codes in parentheses)
      • Update (UPDATE)
      • Revert (REVERT)
      • Force (FORCE)
    • Default value: UPDATE

    DO

    Item to update. The syntax is the same as used by "sia-update":
    1. ".all" corresponds to everything; ".modules" to all modules
    2. Names beginning with a dot are directories: ".setup", ".source". ".xplot", ".gui", ".xviewer", ".progs", ".utils",".examples"
    3. Plain names (without dots) are expected to be module names
    • Format: Character (24 characters)
    • Default value: Not specified

    DONOT

    Item to EXCLUDE from updating. The syntax is the same as for DO
    • Format: Character (24 characters)
    • Default value: Not specified

    1 group of 2 REPEAT parameters per line:

    DO

    Additional items to update
    • Format: Character (24 characters)
    • Default value: Not specified

    DONOT

    Additional item to EXCLUDE from updating. The syntax is the same as for DO
    • Format: Character (24 characters)
    • Default value: Not specified

    Preceding list (COMMAND)

    DLOAD

    Download results

    This list sets options for downloading the results returned by the server

    Usage: DLOAD ONOPEN ONCLOSE DIR
    3 parameters in this list:

    ONOPEN

    Action performed before the data are downloaded:
  • PURGE : remove all current files from the download directory;
  • KEEP : Keep all current files in the dowbload directory;
    • Format: Selection
    • Selectable Values: (codes in parentheses)
      • Keep (KEEP)
      • Purge (PURGE)
    • Default value: PURGE

    ONCLOSE

    Closing action performed after the data are downloaded.
  • DELETE : a request to delete the data is sent to the server;
  • KEEP : a request to keep the data is sent to the server;
  • No preference : no data deletion request is sent. The server may keep or remove the data upon its discretion.
    • Format: Selection
    • Selectable Values: (codes in parentheses)
      • Delete (DELETE)
      • Keep (KEEP)
      • No preference (SERV)
    • Default value: DELETE

    DIR

    Directory into which the files returned by the web service are downloaded
    • Format: Directory name (72 characters)
    • Default value: Not specified

    Preceding list (CUPDATE)

    ENV

    Environment

    Usage: ENV ENV
    1 parameter in this list:

    ENV

    Environment variable set on the server, in format NAME=VALUE. Multiple entries can be separated by commas, semocolons, colons, or spaces.
    • Format: Character (88 characters)
    • Default value: Not specified

    1 group of 1 REPEAT parameter per line:

    PATH

    Continuation of the path environment string.
    • Format: Character (88 characters)
    • Default value: Not specified

    Preceding list (DLOAD)

    EXEC

    Run flow

    This command runs a flow already posted on the server with user parameters

    Usage: EXEC FLOW
    1 parameter in this list:

    FLOW

    Flow name on the server, relative to the IGeoS web server mountpoint
    • Format: Character (88 characters)
    • Default value: Not specified

    1 group of 1 REPEAT parameter per line:

    Parameter string provided to the web service subflow. Multiple strings are concatenated

    PARAM

    Parameter string
    • Format: Character (88 characters)
    • Default value: Not specified

    Preceding list (ENV)

    FLOWLIB

    Upload flow library

    This command retrieves IGEoS processing scripts from the server and installs them locally

    Usage: FLOWLIB NAME
    1 parameter in this list:

    NAME

    Name of the library to retrieve
    • Format: Character (32 characters)
    • Default value: Not specified

    1 group of 1 REPEAT parameter per line:

    DIR

    Root directory in which the updated job directories are placed
    • Format: Directory name (88 characters)
    • Default value: Not specified

    Preceding list (EXEC)

    INFO

    Info

    A description of the relevant server settings and usage info is displayed. No other actions can be combined with INFO.

    Usage: INFO SUBJECT
    1 parameter in this list:

    SUBJECT

    Name of the info subject, or name of any module.
    • Format: Editable selection (24 characters)
    • Selectable Values: (codes in parentheses)
      • Contents (CONTENT)
      • Colors (COLORS)
      • Fonts (FONTS)
      • Modules (MODULES)
    • Default value: Not specified

    Preceding list (FLOWLIB)

    JOB

    Job ID

    Usage: JOB JOBID
    1 parameter in this list:

    JOBID

    Job ID. The output data will be placed into a subdirectory USERID/JOBID. JOBID may include slashes to indicate subdirectories. When submitting multiple flows in one call, JOBID can include C integer format (%d) to include the number of the flow, starting from 0. If no JOBID is specified, client UNIX process ID is used.
    • Format: Character (88 characters)
    • Default value: Not specified

    Preceding list (INFO)

    OUTFILE

    Output file name

    Usage: OUTFILE FNAME
    1 parameter in this list:

    FNAME

    Output file name.
    • Format: File name (88 characters)
    • Default value: Not specified

    Preceding list (JOB)

    PATH

    Path

    Usage: PATH PATH
    1 parameter in this list:

    PATH

    Path environment variable set on the server, in format NAME=VALUE. The difference from the general variable set by ENV is that PATH should be defined relative to the entry point of the web server. The root path is appended to this variable, so that it appears as full path within the server job. . Multiple entries can be separated by commas, semocolons, colons, or spaces.
    • Format: Character (88 characters)
    • Default value: Not specified

    1 group of 1 REPEAT parameter per line:

    PATH

    Continuation of the path environment string.
    • Format: Character (88 characters)
    • Default value: Not specified

    Preceding list (OUTFILE)

    RESULT

    Result

    Specifies actions performed with downloaded result files

    Usage: RESULT ITEM ACTION
    2 parameters in this list:

    ITEM

    Item with which the following ACTION is performed. Special names mean:
    1. =MAIN=: main page returned by the server process.
    2. =INDEX=: sia_index.html file returned by the server process.
    3. =LOG=: log.txt file.
    4. =DEBUG=: debug.txt file.
    . Other values of ITEM are interpreted as file name masks.
    • Format: Editable selection (32 characters)
    • Selectable Values: (codes in parentheses)
      • Main (=MAIN=)
      • Index file (=INDEX=)
      • Log file (=LOG=)
      • Debugging
    • Default value: =INDEX=

    ACTION

    Type of the action performed with the response. For DISPLAY, a browser window is opened and the user is allowed to view the results and download files interactively. For DLOAD (Download), the program does not start the browser but downloads all posted results by using "wget". If NONE (No action) is selected, the program ignores the response of the remote service. For PRINT, the response from the service is printed in the log stream. Action EXECUTE (or EXEC) depends on the type of returned file. For text files, EXECUTE is equivalent to DISPLAY
    • Format: Selection
    • Selectable Values: (codes in parentheses)
      • No action (NONE)
      • Print (PRINT)
      • Display (DISPLAY)
      • Download (DLOAD)
      • Execute (EXEC)
    • Default value: DLOAD

    Preceding list (PATH)

    SAVE

    Save the data

    This request will advise the server administrator that the data may be valuable for others or for later use

    Usage: SAVE REASON
    1 parameter in this list:

    REASON

    Brief summary of the reason for the data to be needed later. This text is intended for the server administrator.
    • Format: Character (88 characters)
    • Default value: Not specified

    1 group of 1 REPEAT parameter per line:

    REASON

    Continuation of the explanation.
    • Format: Character (88 characters)
    • Default value: Not specified

    Preceding list (RESULT)

    SERVER

    Server

    Usage: SERVER URL
    1 parameter in this list:

    URL

    URL of the server executing the service.
    • Format: URL address
    • Default value: Not specified

    Preceding list (SAVE)

    SUBMIT

    Submit flow

    Sends a local flow to the server(s) and executes it there

    Usage: SUBMIT FLOW
    1 parameter in this list:

    FLOW

    Name of the flow (job) file executed remotely as a web service. Multiple flows can be submitted by using UNIX file name masks as FLOW. The flows will be executed one after another.
    • Format: Processing flow name (80 characters)
    • Default value: Not specified

    1 group of 1 REPEAT parameter per line:

    Parameter string provided to the web service subflow. Multiple strings are concatenated

    PARAM

    Parameter string
    • Format: Character (88 characters)
    • Default value: Not specified

    Preceding list (SERVER)

    USAGE

    Usage info

    This command requests usage info from a flow located on remote server

    Usage: USAGE FLOW
    1 parameter in this list:

    FLOW

    Flow name on the server, relative to the IGeoS web server mountpoint
    • Format: Character (88 characters)
    • Default value: Not specified

    Preceding list (SUBMIT)

    USER

    User ID

    Usage: USER USERID
    1 parameter in this list:

    USERID

    User ID serving as a root subdirectory for user data.
    • Format: Character (88 characters)
    • Default value: Not specified

    Preceding list (USAGE)

    IGeoS version 5.1
    Copyright (c) 1995-2015, I.B.Morozov
    Updated Wed Apr 1 21:42:03 2020