HP OpenVMS Systems Documentation

With the /PRIORITY qualifier, sets the priority of one or more queued task elements. With the /STATE qualifier, sets the state of one or more queued task elements.

Format

SET ELEMENT element-id queue-name

Command Qualifiers	Defaults
/[NO]CONFIRM	/NOCONFIRM
/EXCLUDE=(keyword[,...])	None
/PRIORITY=n	None
/SELECT=(keyword[,...])	None
/STATE=[NO]HOLD	None

Privileges Required

Write access to the queue repository file. If the queue repository file has the default protection from the CREATE QUEUE command, you need the OpenVMS SYSPRV privilege or the UIC [1,4] to set characteristics.

Parameters

element-id

The element identification of the queued task element whose characteristics you want to set. Either specify an element ID or use the wildcard character (*). The element ID for a task is returned by the ACMS$QUEUE_TASK service.

You can specify all or part of the element ID. If you specify only part of an element ID, the characteristics of all queued task elements whose IDs contain the specified characters are set. For example, if MY_NODE is specified as the element ID, all elements queued from node MY_NODE are set with the characteristics you specify. Display the element ID of a queued task element by using the SHOW ELEMENT command with the /FULL qualifier. The SHOW ELEMENT command is described in SHOW ELEMENT Command (ACMSQUEMGR„).

If you use the wildcard character (*) in place of an element ID, the characteristics of all queued task elements are set. When using the wildcard character, you can also use the /SELECT qualifier or the /EXCLUDE qualifier to choose a group of queued task elements for which to set characteristics. See Compaq ACMS for OpenVMS Writing Applications for information about the ACMS$QUEUE_TASK service.

queue-name

The name of the queue that contains the queue task elements. A queue name can be any valid RMS file name containing 1 through 39 alphanumeric characters.

Qualifiers

/[NO]CONFIRM

/CONFIRM displays each queued task element selected for modification and prompts you to confirm that you want the characteristics of the queued task element modified. Answer the prompt by entering one of the following:

• Y or y---for yes
• N or n---for no
• Q or q---for quit (exits the command without modifying the queued task element)
• A or a---for always (modifies all remaining queued task elements without displaying the confirmation prompt)
• RETURN---for the default

The default is /NOCONFIRM.

/EXCLUDE=(keyword[,...])

Allows you to exclude a queued task element or group of queued task elements from being modified by the SET ELEMENT command. Specify the exclusion criteria with keywords to the /EXCLUDE qualifier. You must use at least one keyword with the /EXCLUDE qualifier. Specify more than one keyword by separating the keywords with a comma and enclosing them in parentheses. You can use the /EXCLUDE qualifier to limit the scope of the SET ELEMENT command when you specify a wildcard character (*) instead of an element ID.

The /EXCLUDE qualifier takes precedence over the /SELECT qualifier. Therefore, if a queued task element matches the selection criteria but is excluded by the exclusion criteria, the characteristics of the queued task elements are not modified.

Specify one or more of the following keywords:

• APPLICATION=(application-spec[,...])
  Excludes queued task elements containing the specified application. Specify more than one application specification by separating the specifications with a comma and enclosing them in parentheses.
• BEFORE=time
  Excludes queued task elements queued before the specified time. You can specify absolute time, combination time, or the keyword argument TODAY or YESTERDAY. See OpenVMS User's Manual for more information about absolute and combination time.
• PRIORITY=(n[,...])
  Excludes queued task elements having the specified priority. Valid priority values are 0 through 255. Specify more than one priority value by separating the values with a comma and enclosing them in parentheses.
• SINCE=time
  Excludes queued task elements queued since the specified time. You can specify absolute time, combination time, or the keyword argument TODAY or YESTERDAY. See OpenVMS User's Manual for more information about absolute and combination time.
• STATE=[NO]HOLD
  If you specify /EXCLUDE=STATE=HOLD, the ACMSQUEMGR excludes queued task elements that are currently on hold. If you specify /EXCLUDE=STATE=NOHOLD, the ACMSQUEMGR excludes queued task elements that are not on hold.

• TASK=(task-name[,...])
  Excludes all queued task elements having the specified task name. Specify more than one task name by separating the task names with a comma and enclosing them in parentheses.
• USERNAME=(enqueuer-user-name[,...])
  Excludes all queued task elements that have the specified enqueuer user name. The enqueuer user name is the user name explicitly or implicitly specified with the ACMS$QUEUE_TASK service. See Compaq ACMS for OpenVMS Writing Applications for information about the ACMS$QUEUE_TASK service.

/PRIORITY=n

Specifies the priority of the queued task element. You can specify a priority of 0 through 255. Tasks with the highest numerical priority are processed by the QTI first.

/SELECT=(keyword[,...])

Limits the SET ELEMENT command to queued task elements that match the selection criteria. Specify the selection criteria with keywords to the /SELECT qualifier. Specify more than one keyword by separating the keywords with a comma and enclosing them in parentheses. You must specify at least one keyword with the /SELECT qualifier. Use the /SELECT qualifier to limit the scope of the SET ELEMENT command when you specify a wildcard character (*) instead of an element ID.

You can specify one or more of the following keywords:

• APPLICATION=(application-spec[,...])
  Sets the characteristics of queued task elements containing the specified application. Specify more than one application specification by separating the specifications with a comma and enclosing them in parentheses.
• BEFORE=time
  Sets the characteristics of queued task elements queued before the specified time. You can specify absolute time, combination time, or the keyword argument TODAY or YESTERDAY. See OpenVMS User's Manual for more information about absolute and combination time.
• PRIORITY=(n[,...])
  Sets the characteristics of queued task elements having the specified priority. Valid priority values are 0 through 255. Specify more than one priority value by separating the values with a comma and enclosing them in parentheses.
• SINCE=time
  Sets the characteristics of queued task elements queued since the specified time. You can specify absolute time, combination time, or the keyword argument TODAY or YESTERDAY. See OpenVMS User's Manual for more information about absolute and combination time.
• STATE=[NO]HOLD
  If you use /SELECT=STATE=HOLD, the ACMSQUEMGR sets only the characteristics of queued task elements currently on hold. If you use /SELECT=STATE=NOHOLD, the ACMSQUEMGR sets only the characteristics of queued task elements that are not on hold.

• TASK=(task-name[,...])
  Sets the characteristics of queued task elements that have the specified task name. Specify more than one task name by separating the task names with a comma and enclosing them in parentheses.
• USERNAME=(enqueuer-user-name[,...])
  Sets the characteristics of queued task elements that have the specified enqueuer user name. The enqueuer user name is the user name explicitly or implicitly specified with the ACMS$QUEUE_TASK service. See Compaq ACMS for OpenVMS Writing Applications for information about the ACMS$QUEUE_TASK service.

/STATE=[NO]HOLD

The /STATE=HOLD qualifier places the specified queued task element on hold. Queued task elements on hold cannot be dequeued. The /STATE=NOHOLD qualifier releases the specified queued task element from the hold state. If you do not include the qualifier, the hold state of the queued task element is unchanged.

Notes

You must use either the /PRIORITY qualifier or the /STATE qualifier with the SET ELEMENT command.

Examples

ACMSQUEMGR> SET ELEMENT MY_NODE:28C00082-0000000E -
_ACMSQUEMGR> ACCT_QUEUE /PRIORITY=255

      

This command sets the priority of the queued task element having the element ID MY_NODE:28C00082-0000000E to 255. Priority 255 is the highest priority you can assign a task.

ACMSQUEMGR> SET ELEMENT MY_NODE:: FAST_QUEUE -
_ACMSQUEMGR> /STATE=HOLD/SELECT=APPLICATION=IN_STOCK

      

This command places all queued task elements containing the application IN_STOCK on hold, provided they were queued from node MY_NODE and are stored in queue FAST_QUEUE.

ACMSQUEMGR> SET ELEMENT MY_NODE: PAY_QUE -
_ACMSQUEMGR> /EXCLUDE=APPLICATION=PAYROLL /STATE=HOLD

      

This command places all queued task elements queued from node MY_NODE in queue PAY_QUE on hold, excluding those queued task elements containing the application PAYROLL.

With a qualifier, dynamically sets the queue state. The changes to the queue state take effect immediately.

Format

SET QUEUE queue-name

Command Qualifiers	Defaults
/DEQUEUE=keyword	Current queue state
/ENQUEUE=keyword	Current queue state

Privileges Required

Write access to the queue repository file. If the queue repository file has the default protection from the CREATE QUEUE command, you need the OpenVMS SYSPRV privilege or the UIC [1,4] to modify the queue.

Parameters

queue-name

The name of the queue whose state you want to set. A queue name can be any valid RMS file name containing 1 through 39 alphanumeric characters.

Qualifiers

/DEQUEUE=keyword

Allows or disallows the dequeuing of all queued task elements in the queue. Specify one of the following keywords with the /DEQUEUE qualifier:

• SUSPENDED
  The /DEQUEUE=SUSPENDED qualifier prohibits the QTI and ACMS$DEQUEUE_TASK service from dequeuing queued task elements in the queue until the queue state is resumed. The default is whatever is defined in the queue definition file (ACMSQDF.DAT) when the queue was created.
• RESUMED
  The /DEQUEUE=RESUMED qualifier allows the QTI and ACMS$DEQUEUE_TASK service to resume dequeuing queued task elements in the queue. The default is whatever is defined in the queue definition file (ACMSQDF.DAT) when the queue was created.

/ENQUEUE=keyword

Enables or disables the queuing of queued task elements to a queue. Specify one of the following keywords with the /ENQUEUE qualifier:

• SUSPENDED
  The /ENQUEUE=SUSPENDED qualifier prohibits the ACMS$QUEUE_TASK service from queuing queued task elements to the queue until the queue is resumed. The default is whatever is currently defined in the queue definition file.

• RESUMED
  The /ENQUEUE=RESUMED qualifier allows the ACMS$QUEUE_TASK service to resume queuing queued task elements to the queue. The default is whatever is currently defined in the queue definition file.

Notes

You must use either the /DEQUEUE qualifier or the /ENQUEUE qualifier with the SET QUEUE command. Otherwise, the SET QUEUE command has no effect and you receive an error message.

Examples

ACMSQUEMGR> SET QUEUE MILL_QUE /ENQUEUE=SUSPENDED
      

This command prevents the ACMS$QUEUE_TASK service from queuing tasks to queue MILL_QUE.

ACMSQUEMGR> SET QUEUE INVENTORY_QUE /DEQUEUE=SUSPENDED
      

This command prevents the ACMS$DEQUEUE_TASK service and the QTI from dequeuing queued task elements in queue INVENTORY_QUE.

Displays information about one or more queued task elements in a queue.

Format

SHOW ELEMENT element-id queue-name

Command Qualifiers	Defaults
/BRIEF	/BRIEF
/EXCLUDE=(keyword[,...])	None
/FULL	/BRIEF
/OUTPUT[=file-spec]	SYS$OUTPUT
/SELECT=(keyword[,...])	None
/TOTAL_ONLY	/BRIEF

Privileges Required

Read access to the queue repository file. If the queue repository file has the default protection from the CREATE QUEUE command, you need the OpenVMS SYSPRV privilege or the UIC [1,4] to display information about the queued task element.

Parameters

element-id

The element ID of the queued task element you want to display information about, or the wildcard character (*). If you use the wildcard character, ACMSQUEMGR displays all queued task elements for a queue.

You can specify all or part of the element ID. If you specify only part of an element ID, the ACMSQUEMGR displays all queued task elements whose IDs contain the specified characters. The element ID for a task is returned by the ACMS$QUEUE_TASK service. Determine the element ID of a queued task element by specifying the SHOW ELEMENT command with the /FULL qualifier.

When using the wildcard character, you can also use the /SELECT qualifier or /EXCLUDE qualifier to select a group of queued task elements to display.

queue-name

The name of the queue containing the queued task elements. A queue name can be any valid RMS file name containing 1 through 39 alphanumeric characters.

Qualifiers

/BRIEF

Provides a brief display of queued task information. /BRIEF is the default.

/EXCLUDE=(keyword[,...])

Allows you to exclude a queued task element or group of queued task elements from being displayed. Specify the exclusion criteria with keywords to the /EXCLUDE qualifier. You must use at least one keyword with the /EXCLUDE qualifier. Specify more than one keyword by separating the keywords with a comma and enclosing them in parentheses. Use the /EXCLUDE qualifier to limit the scope of the SHOW ELEMENT command when you use the wildcard character (*) instead of an element ID.

The /EXCLUDE qualifier takes precedence over the /SELECT qualifier. Therefore, if a queued task element matches the selection criteria but is excluded by the exclusion criteria, that queued task element is not displayed.

Specify one or more of the following keywords:

• APPLICATION=(application-spec[,...])
  Excludes queued task elements in the specified application from being displayed. Specify more than one application specification by separating the specifications with a comma and enclosing them in parentheses.
• BEFORE=time
  Excludes queued task elements queued before the specified time. You can specify absolute time, combination time, or the keyword argument TODAY or YESTERDAY. See OpenVMS User's Manual for more information about absolute and combination time.
• PRIORITY=(n[,...])
  Excludes queued task elements having the specified priority. Valid priority values are 0 through 255. Specify more than one priority value by separating the values with a comma and enclosing them in parentheses.
• SINCE=time
  Excludes queued task elements queued since the specified time. You can specify absolute time, combination time, or the keyword argument TODAY or YESTERDAY. See OpenVMS User's Manual for more information about absolute and combination time.
• STATE=[NO]HOLD
  If you use /EXCLUDE=STATE=HOLD, the ACMSQUEMGR excludes queued task elements that are currently on hold. If you use /EXCLUDE=STATE=NOHOLD, the ACMSQUEMGR excludes queued task elements that are not on hold.
• TASK=(task-name[,...])
  Excludes all queued task elements that have the specified task name. Specify more than one task name by separating the task names with a comma and enclosing them in parentheses.
• USERNAME=(enqueuer-user-name[,...])
  Excludes all queued task elements that have the specified enqueuer user name. The enqueuer user name is the user name explicitly or implicitly specified with the ACMS$QUEUE_TASK service. See Compaq ACMS for OpenVMS Writing Applications for information about the ACMS$QUEUE_TASK service.

/FULL

Provides a full display of queued task element information. If you do not use the /FULL qualifier, the ACMSQUEMGR displays only brief information. The default is /BRIEF.

/OUTPUT[=file-spec]

Specifies a file specification where you want to send the SHOW output. Specify a full file specification, including device, directory, file name, and file type. If you specify an incomplete file specification, ACMSQUEMGR uses the file ACMSQUEMGR.LIS as the default output file. If you do not use the /OUTPUT qualifier, ACMSQUEMGR sends the output to the default device, SYS$OUTPUT.

/SELECT=(keyword[,...])

Limits the SHOW ELEMENT command to queued task elements that match the selection criteria. Specify the selection criteria with keywords to the /SELECT qualifier. Specify more than one keyword by separating the keywords with a comma and enclosing them in parentheses. You must specify at least one keyword with the /SELECT qualifier. Use the /SELECT qualifier to limit the scope of the SHOW ELEMENT command when you use the wildcard character (*) instead of an element ID.

You can specify one or more of the following keywords:

• APPLICATION=(application-spec[,...])
  Displays only queued task elements containing the specified application. Specify more than one application specification by separating the specifications with a comma and enclosing them in parentheses.
• BEFORE=time
  Displays only queued task elements queued before the specified time. You can specify absolute time, combination time, or the keyword argument TODAY or YESTERDAY. See OpenVMS User's Manual for more information about absolute and combination time.
• PRIORITY=(n[,...])
  Displays only queued task elements having the specified priority. Valid priority values are 0 through 255. Specify more than one priority value by separating the values with a comma and enclosing them in parentheses.
• SINCE=time
  Displays queued task elements queued since the specified time. You can specify absolute time, combination time, or the keyword argument TODAY or YESTERDAY. See OpenVMS User's Manual for more information about absolute and combination time.
• STATE=[NO]HOLD
  If you use /SELECT=STATE=HOLD, the ACMSQUEMGR displays only queued task elements currently on hold. If you use /SELECT=STATE=NOHOLD, the ACMSQUEMGR displays only queue task elements not on hold.
• TASK=(task-name[,...])
  Displays all queued task elements having the specified task name. Specify more than one task name by separating the task names with a comma and enclosing them in parentheses.
• USERNAME=(enqueuer-user-name[,...])
  Displays all queued task elements having the specified enqueuer user name. The enqueuer user name is the user name explicitly or implicitly specified with the ACMS$QUEUE_TASK service. See Compaq ACMS for OpenVMS Writing Applications for information about the ACMS$QUEUE_TASK service.

/TOTAL_ONLY

Displays only the total number of queued task elements that meet the selection criteria specified with the /SELECT qualifier.

Notes

The /BRIEF, /FULL, and /TOTAL_ONLY qualifiers are mutually exclusive; you can specify only one of these qualifiers on each SHOW ELEMENT command.

Examples

ACMSQUEMGR> SHOW ELEMENT MY_NODE:: PAYROLL_QUEUE /FULL
ACMS Queued Tasks                  Current Date/Time:  1-MAY-1991 13:21:31.13

Task: CHANGE_EMPLOYEE                       State:    HOLD
Appl: PAYROLL                               Priority: 5
Username:   NORTH                           Enq Time:  1-MAY-1991 10:13:17.71
Queue Name: PAYROLL_QUEUE
Element Id: MY_NODE::28C00082-0000000F-FDE272E0-0090AB3F
Error Cnt:  0

Task: HIRE_EMPLOYEE                         State:    NOHOLD
Appl: PAYROLL                               Priority: 12
Username:   JONES                           Enq Time:  1-MAY-1991 10:13:16.85
Queue Name: PAYROLL_QUEUE
Element Id: MY_NODE::28C00082-0000000E-FD5F3920-0090AB3F
Error Cnt:  0
Queued Task total for this display: 2

      

This example displays full information about all queued task elements queued from node MY_NODE:: in queue PAYROLL_QUEUE.

ACMSQUEMGR> SHOW ELEMENT * YAK_QUE -
_ACMSQUEMGR> /BRIEF /SELECT=(SINCE=TODAY,TASK=TASK1)
      

Displays brief information about all queued task elements in queue YAK_QUE that were queued today and that contain task TASK1.

ACMSQUEMGR> SHOW ELEMENT * BANK_QUE /EXCLUDE=STATE=HOLD
      

Displays all queued task elements in queue BANK_QUE that are not currently on hold.