Configuring Arbortext Publishing Engine > Understanding Queuing on the Arbortext PE server > Queuing Query Parameters
  
Queuing Query Parameters
The Arbortext Publishing Engine implementation of a Queue Manager and queuing supports the following HTTP query parameters. These parameters can be used by client applications and web browsers to specify how to handle a queued request.
Query Parameters for Queuing
Parameter Name
Value
Description
queue
yes or no
Specifies whether to queue a request. If this parameter is omitted or set to no in the request HTTP query, the transaction is treated as an immediate request.
The default is no.
queue-priority
1, 2, 3, 4, or 5
Specifies the priority of the request when placing the transaction on a queue. 1 is the highest and 5 is the lowest.
queue=yes must also be specified.
The default is 3
transaction-name
descriptive-name
Specifies the descriptive text to be used for a transaction name. The specification can include the string $t, that will be replaced with the unique transaction ID assigned on the Arbortext PE server. For example,
transaction-name=Docs_$t
response-format
xml or html
Specifies the format of the response that the Queue Manager will return to the client submitting the request. The response will contain the transaction ID.
queue=yes must also be specified.
The default is html.
notify-email
a valid email address
Specifies an email address to which a notification can be sent when the transaction completes. A notifier must be set up on the Arbortext PE server.
Note that this parameter may be specified with both immediate and queued requests.
If you implement a notifier, the notifier needs to receive a request-parameter from the HTTP query set to the value of the query parameter name that will be used to submit an email address. To use the built-in notify-email query parameter, the request-parameter must be set to notify-email. When the client submits a request, notify-email="user@mycompany.com" must also be part of the query request. See Configuring a Notifier for information about the sample package, including an example for using it.