Host Environment Commands › ADDRESS AP Commands › AP PPQ—Write to Queue

AP PPQ—Write to Queue

The ADDRESS AP PPQ WRITE command writes one or more items to a specified queue on an MSF connected CA Automation Point system.

The ADDRESS AP PPQ WRITE command has the following format:

ADDRESS AP 'PPQ WRITE {SYSTEM(apsysname)} {QUEUE(qname)}
  {ITEM(item)|VAR(varname)}
  [ITEMNUM(LAST|FIRST|itemnum)]'

The following operands are required:

SYSTEM

Defines the 1- to 8-character MSF name of the CA Automation Point system. A system ID cannot exceed 8 bytes.

QUEUE

Defines the 1- to 16-character name of the queue (qname). The queue name can contain alphanumeric characters and any of these special characters:  

! @ # $ _ (for example, !Qun1, Queue1, 12334)

The queue name cannot contain blanks.

ITEM

Specifies the item to write to the queue. The item value cannot exceed 30,000 characters in length and can be either a literal string (such as “this is an item”) or a simple variable name (not enclosed in the host command quotation marks so that REXX can evaluate it).

Note: You cannot specify the ITEM operand if you specify the VAR operand.

VAR

Defines the name of a simple variable on the local machine containing the item to be written to the queue, qname.

Example:

Vartest = 'this is a test'

variable ='12345…..'

The rule for varname is to follow standard simple variable naming conventions used in REXX.

varname cannot exceed 50 characters in length. The value of varname cannot exceed 30,000 characters in length.

Note: You cannot specify the VAR operand if you specify the ITEM operand.

ITEMNUM

(Optional) Specifies the starting item to write to the queue.

Assume that the specified queue contains count number of items and that you want to write n items to the queue. Valid ITEMNUM values are:

LAST

Starts the write operation from the end of the queue. The first item written to the queue is item number count+1 and succeeding items are numbered count+2, count+3, and so on through count+n. This is the default method for writing to the queue.

FIRST

Starts the write operation from the beginning of the queue. The current item number 1 in the queue becomes item number 1+n after n items are written.

Itemnum

Starts the write operation from somewhere in the middle of the queue. The WRITE command writes n items ahead of an item (specified by itemnum) that already exists in the queue (so that the current itemnum becomes itemnum+n after n items are written).

Note: The starting item that you specify must exist or must be the count+1 item in the queue; specifying an itemnum value beyond the end of the queue generates an error.

Default: LAST or 0

AP PPQ Sample Coding Statements