Help - Request:/ Variables

Request:/
Setting Explanation Default /
Example Data
Type Access
R,W,A,D
Argument/ The decoded arguments supplied with the method (command) being invoked by the client. Each name and value pair is inserted into the list after having been unescaped.
Under the HTTP protocol, this insertion of variables occurs regardless of whether METHOD=GET or METHOD=POST was specified for the form.
See the Guided Tour for examples.
Text List R
ArgumentText The arguments as originally supplied with the method (command) being invoked by the client.
If these arguments are compatible with the HTML Forms Interface, they are automatically decoded into the individual variable name and value pairs within the "Request:/Argument/" directory.
23,52 Text R
AuthenticateType The type of user authentication performed. This variable is set from headers supplied by the client's browser, and is verified internally by PowerWeb, or by a User Authentication server hook. none Text R,W
AuthenticateUser The user name of the client user for authentication, as supplied by the client's browser or FTP software. This variable, along with the password, is set by PowerWeb prior to calling the User Authentication server hook. joe Text R,W
AuthenticatePassword The password supplied by the client user for authentication, as supplied by the client's browser or FTP software. This variable, along with the user's name, is set by PowerWeb prior to calling the User Authentication server hook. Note this stage is purely for authentication, that is verifying the identity of the user. The user is not authorised to access the requested resource until the Access Control server hook agrees. secret Text R,W
AutoHeaders Set to TRUE to allow the server to generate a set of automatic default headers for the reply to the request. Set to FALSE to only reply with those headers that the server hooks specifically output. Yes Integer R,W
BytesRead The number of bytes received from the network so far during the current request. 0 Integer R
BytesSent The number of bytes sent to the network so far during the current request. This excludes the number of bytes currently sitting in the "Result" variable waiting to be sent. 0 Integer R
Elapsed The elapsed time, in milliseconds, since the current request started (that is, when the request was first received, before any processing). 0 Integer R
ImmediateWrite Set to TRUE to cause all output to be written immediately to the client without being buffered. This is useful for server-push scripts or for very large documents or images.
Set to FALSE (the default) to cause the server and the network to automatically decide the optimal data transmission timing and sizing. No Integer R,W
Method The method (command) being invoked by the client. For example, "GET", "POST", "READ". To know the protocol in use, access the variable "Protocol". To see a complete list of protocols, methods and sub-methods, read about access control. GET Text R
NoCache Set to TRUE to prevent the cache manager from trying to cache the response to this request. Default is FALSE, unless the header variable Expiry date is set to the current date and time. Some protocols will want to force this to FALSE for most types of requests.
Note: this setting is currently ignored, as the server automatically decides which documents to cache. No Integer R,W
ObjectType The type of object referred to by the resource. This is set by the Resource Name Translation server hook. There is a standardised list of object types. CGI Integer R,W
PathInfo The directory path following the "Resource" name within the "VirtualResource". See also "PathTranslated". This variable is often used by CGI scripts which specify further arguments after the name of the CGI program, for example: "/cgi-bin/example.exe/art/image1.dat" in which case the PathInfo variable would be "/art/image1.dat". /map/globe.map Text R,W
PathTranslated This is the "PathInfo" variable after translation according to the document root directory. /powerweb/docs/map/globe.map Text R,W
PostedText The extra data included at the end of an HTTP POST request. It is not unescaped or altered in any way.
For forms processing there is a much easier method of handling this data, simply use the already decoded individual field name and value pairs which are contained within the "Request:/Argument/" directory. See the Guided Tour for examples.
Company=CompuSource Text R
Protocol The protocol and version number used for this request. HTTP/1.0 Text R
Request The first line of the request sent by the client. Variables "Protocol", "Method", "Resource", and "Arguments" break down the request into its constituent parts. GET /index.html HTTP/1.0 Text R
Resource The name of the resource after having been translated from its virtual path (contained in the "VirtualResource" variable) by the Resource Name Translation server hook. It is typically the full path name of the physical file or directory to be accessed. /powerweb/docs/home.html Text R,W
Result The result data to be returned to the client. Interacts with the variable "ImmediateWrite" in that if it is set, the contents of the variable "Result" are cleared after every write. Any data written to this variable is automatically sent to the client. It is best used in conjunction with API extensions. Binary & Text W,A
Status The cross-protocol standardised status value which is transformed into a status code particular to the given protocol before returning to the client. If you know the protocol-specific status code, you can set "StatusCode" instead and leave "Status" set to 0.
The standardised statuses are:

1 = No error, OK.
2 = Redirect the client to another server.
3 = Tell the client the data has not been modified.
4 = The request was not understood.
5 = The client has insufficient authorisation and should try again.
6 = The client is forbidden access, regardless of authorisation.
7 = The resource was not found.
8 = The server experienced an internal error.
9 = The server currently does not implement the feature requested.
0 Integer R,W
StatusCode The status code to return to the client. Protocols such as HTTP and FTP define a set of standardised status codes. You should be aware of these standard codes before setting this variable. If you do not know which code to use, you can use one of the cross-protocol standard status codes and set the variable "Status" appropriately.
If both "Status" and "StatusCode" are defined, the value in "StatusCode" is used.
200 Integer R,W
StatusText The status text to return to the client. Follows the "Status" code in the reply to the client. Should be kept short. For the HTTP protocol, it is not normally shown to the user by the client's browser, because the "Status" code tells the browser what to do. OK Text R,W,A
SubMethod The sub-method of the command being invoked by the client. For example, with the HTTP protocol, the "GET" method has sub-methods "EXEC", "DOCUMENT", "INCLUDE", "INDEX" and "SCRIPT". To see a complete list of protocols, methods and sub-methods, read about access control. DOCUMENT Text R
VirtualResource The name of the resource specified for the method (command) being invoked by the client. For example, "/index.html". This variable contains what is often called the URI in unescaped format. The URI is the portion of the URL following the host name and the port (if any) in the client request.
It is not a physical filename and must still be translated through aliases and server and document root directories before it is a physical filename as stored in the "Resource" variable.
/home.html Text R

Request:/
Setting	Explanation	Default / Example	Data Type	Access R,W,A,D
Argument/	The decoded arguments supplied with the method (command) being invoked by the client. Each name and value pair is inserted into the list after having been unescaped. Under the HTTP protocol, this insertion of variables occurs regardless of whether METHOD=GET or METHOD=POST was specified for the form. See the Guided Tour for examples.		Text List	R
ArgumentText	The arguments as originally supplied with the method (command) being invoked by the client. If these arguments are compatible with the HTML Forms Interface, they are automatically decoded into the individual variable name and value pairs within the "Request:/Argument/" directory.	23,52	Text	R
AuthenticateType	The type of user authentication performed. This variable is set from headers supplied by the client's browser, and is verified internally by PowerWeb, or by a User Authentication server hook.	none	Text	R,W
AuthenticateUser	The user name of the client user for authentication, as supplied by the client's browser or FTP software. This variable, along with the password, is set by PowerWeb prior to calling the User Authentication server hook.	joe	Text	R,W
AuthenticatePassword	The password supplied by the client user for authentication, as supplied by the client's browser or FTP software. This variable, along with the user's name, is set by PowerWeb prior to calling the User Authentication server hook. Note this stage is purely for authentication, that is verifying the identity of the user. The user is not authorised to access the requested resource until the Access Control server hook agrees.	secret	Text	R,W
AutoHeaders	Set to TRUE to allow the server to generate a set of automatic default headers for the reply to the request. Set to FALSE to only reply with those headers that the server hooks specifically output.	Yes	Integer	R,W
BytesRead	The number of bytes received from the network so far during the current request.	0	Integer	R
BytesSent	The number of bytes sent to the network so far during the current request. This excludes the number of bytes currently sitting in the "Result" variable waiting to be sent.	0	Integer	R
Elapsed	The elapsed time, in milliseconds, since the current request started (that is, when the request was first received, before any processing).	0	Integer	R
ImmediateWrite	Set to TRUE to cause all output to be written immediately to the client without being buffered. This is useful for server-push scripts or for very large documents or images. Set to FALSE (the default) to cause the server and the network to automatically decide the optimal data transmission timing and sizing.	No	Integer	R,W
Method	The method (command) being invoked by the client. For example, "GET", "POST", "READ". To know the protocol in use, access the variable "Protocol". To see a complete list of protocols, methods and sub-methods, read about access control.	GET	Text	R
NoCache	Set to TRUE to prevent the cache manager from trying to cache the response to this request. Default is FALSE, unless the header variable Expiry date is set to the current date and time. Some protocols will want to force this to FALSE for most types of requests. Note: this setting is currently ignored, as the server automatically decides which documents to cache.	No	Integer	R,W
ObjectType	The type of object referred to by the resource. This is set by the Resource Name Translation server hook. There is a standardised list of object types.	CGI	Integer	R,W
PathInfo	The directory path following the "Resource" name within the "VirtualResource". See also "PathTranslated". This variable is often used by CGI scripts which specify further arguments after the name of the CGI program, for example: "/cgi-bin/example.exe/art/image1.dat" in which case the PathInfo variable would be "/art/image1.dat".	/map/globe.map	Text	R,W
PathTranslated	This is the "PathInfo" variable after translation according to the document root directory.	/powerweb/docs/map/globe.map	Text	R,W
PostedText	The extra data included at the end of an HTTP POST request. It is not unescaped or altered in any way. For forms processing there is a much easier method of handling this data, simply use the already decoded individual field name and value pairs which are contained within the "Request:/Argument/" directory. See the Guided Tour for examples.	Company=CompuSource	Text	R
Protocol	The protocol and version number used for this request.	HTTP/1.0	Text	R
Request	The first line of the request sent by the client. Variables "Protocol", "Method", "Resource", and "Arguments" break down the request into its constituent parts.	GET /index.html HTTP/1.0	Text	R
Resource	The name of the resource after having been translated from its virtual path (contained in the "VirtualResource" variable) by the Resource Name Translation server hook. It is typically the full path name of the physical file or directory to be accessed.	/powerweb/docs/home.html	Text	R,W
Result	The result data to be returned to the client. Interacts with the variable "ImmediateWrite" in that if it is set, the contents of the variable "Result" are cleared after every write. Any data written to this variable is automatically sent to the client. It is best used in conjunction with API extensions.		Binary & Text	W,A
Status	The cross-protocol standardised status value which is transformed into a status code particular to the given protocol before returning to the client. If you know the protocol-specific status code, you can set "StatusCode" instead and leave "Status" set to 0. The standardised statuses are: 1 = No error, OK. 2 = Redirect the client to another server. 3 = Tell the client the data has not been modified. 4 = The request was not understood. 5 = The client has insufficient authorisation and should try again. 6 = The client is forbidden access, regardless of authorisation. 7 = The resource was not found. 8 = The server experienced an internal error. 9 = The server currently does not implement the feature requested.	0	Integer	R,W
StatusCode	The status code to return to the client. Protocols such as HTTP and FTP define a set of standardised status codes. You should be aware of these standard codes before setting this variable. If you do not know which code to use, you can use one of the cross-protocol standard status codes and set the variable "Status" appropriately. If both "Status" and "StatusCode" are defined, the value in "StatusCode" is used.	200	Integer	R,W
StatusText	The status text to return to the client. Follows the "Status" code in the reply to the client. Should be kept short. For the HTTP protocol, it is not normally shown to the user by the client's browser, because the "Status" code tells the browser what to do.	OK	Text	R,W,A
SubMethod	The sub-method of the command being invoked by the client. For example, with the HTTP protocol, the "GET" method has sub-methods "EXEC", "DOCUMENT", "INCLUDE", "INDEX" and "SCRIPT". To see a complete list of protocols, methods and sub-methods, read about access control.	DOCUMENT	Text	R
VirtualResource	The name of the resource specified for the method (command) being invoked by the client. For example, "/index.html". This variable contains what is often called the URI in unescaped format. The URI is the portion of the URL following the host name and the port (if any) in the client request. It is not a physical filename and must still be translated through aliases and server and document root directories before it is a physical filename as stored in the "Resource" variable.	/home.html	Text	R