DEFORM Parameters and Qualifiers

DEFORM Scripting Utility

[next] [previous][contents]

6 - DEFORM Parameters and Qualifiers

DEFORM [qualifiers]

A symbol for a foreign command should be first assigned, then the image activated.

  $ DEFORM = "$HT_EXE:DEFORM"
  $ DEFORM [qualifiers]

6.1 - Parameters

None.

6.2 - Qualifiers

/AUTHENTICATE= realm
The utility checks for the presence of an authenticated remote user name (DCL symbol WWW_REMOTE_USER. If not detected the utility send an authentication failure header to the browser, causing it to provide authentication dialog, then exits with an error status. If an authenticated user name exists any other functionality is performed. The value supplied specifies the authentication realm. Currently only HFRD is defined.

/FILE
For the HTTP POST method the request body is parsed into plain text contained within a temporary file specified by the DCL symbol DEFORM_FILE.

/GET
If the HTTP method is not GET then just exit with a success status. That is, only perform any specified functionality if the method is the same as the qualifier.

/HTML
The utility outputs an HTTP response header specifying to the browser that the following document will be HyperText Markup Language. The document supplied should not include embedded HTTP carriage-control (i.e. no carriage-return/line-feed sequences).

/LOCATION= URL
The utility will output a redirection response resulting in the document of the specified URL begin returned to the browser. The URL must be either a full URL (scheme//host/path, e.g. ``http://host.domain/dir1/dir2/doc.type''), or the full path of a document accessable by the same server (e.g. ``/dir1/dir2/doc.type''). Relative paths cannot be processed.

/TYPE= MIME-Content-Type
The utility outputs an HTTP response header specifying to the browser that the following document will be of the specified type. The document supplied should not include embedded HTTP carriage-control (i.e. no carriage-return/line-feed sequences).

/POST
If the HTTP method is not POST then just exit with a success status. That is, only perform any specified functionality if the method is the same as the qualifier.

/SCRATCH
Assigns two DCL symbols indicating the location of a directory for scratch files (DEFORM_SCRATCH) and a time string that can be used to create unique file names, etc. (DEFORM_UNIQUE).

/STATUS= HTTP-Status-String
The utility outputs an HTTP header to the browser including the supplied string as the reponse status. It must be a legitimate three digit code, with or without a trailing explanation string. When specifying a header any subsequent output to the browser should include full embedded HTTP carriage-control (i.e. carriage-return/line-feed sequences).

/TEXT
The utility outputs an HTTP response header specifying to the browser that the following document will be plain text. The document supplied should not include embedded HTTP carriage-control (i.e. no carriage-return/line-feed sequences).

/SYMBOLS
For the HTTP POST method the request body is parsed into a series of global symbols.


[next] [previous][contents]