HSMS / ARCHIVE V12.0 (en)

&pagelevel(4)&pagelevel

This statement is used to display requests in the request file. Each HSMS user can check the current status of his own requests. The HSMS administrator can output all requests and evaluate the load on the HSMS subsystem.

The requests displayed in the output mask can be deleted by marking them with a special delete flag (as an alternative to the DELETE-REQUEST statement).

The request file of the SF environment is managed in the home pubset, but the request file of each SM environment in the relevant SM pubset. The preset value ENVIRONMENT= *ALL causes the requests to be output from the SF environment and all existing SM environments. To obtain the requests only from a particular environment you must enter the relevant value in the ENVIRONMENT operand. Furthermore there are consequences for shared pubset operation.

Archiving and EXPORT requests are global requests which are always entered in the
HSMS global request file. If only these requests are to be output the user whose standard pubset is an SM pubset must enter the value *SINGLE-FEATURE in the ENVIRONMENT operand.
COPY-SAVE-FILE requests are entered in the target environment. To output such requests therefore, you must specify the target environment in SHOW-REQUESTS.

The screen masks for the SF and the SM environment are very similar. The screen mask for the SM environment displays information about the processing inhibits on SM pubsets.

In addition to output to SYSOUT or SYSLST, the statement also supports structured output to an S variable.

This statement has different formats for nonprivileged users and HSMS administrators. Privileged operands or operand values are marked with ^*P).

Format

SHOW-REQUESTS

Alias: SHR

REQUEST-NAME = *ANY / <name 1..8>
,ENVIRONMENT = ALL / STD / NODE-STD / SINGLE-FEATURE / *SYSTEM-MANAGED(...)
	*SYSTEM-MANAGED(...)
		\|	CATALOG-ID = <cat-id>
,REQUEST-DATE = INTERVAL(...) / LATEST / <date with-compl>(...)
	*INTERVAL(...)
		\|	CREATED-BEFORE = LATEST-DATE / <date with-compl> / <integer -99999..0 days*>
		\|	,CREATED-AFTER = EARLIEST-DATE / <date with-compl> / <integer -99999..0 days*>
	<date with-compl>(...)
		\|	TIME = <time>
,REQUEST-ORIGIN^P) = BS2000(...) / *NODE-CL(...)
	*BS2000(...)
		\|	USER-ID = OWN / ALL / <name 1..8>
	*NODE-CL(...)
		\|	NODE-ID= *ALL / <posix-filename 1..48 without-wild>
,REQUEST-STATE = ANY / COMPLETED / ACCEPTED / STARTED / *INTERRUPTED
,ARCHIVE-NAME = *ALL / <filename 1..22 without-cat-gen-vers>
,INFORMATION = SUMMARY / ALL
,OUTPUT = NONE / list-poss(2): SYSOUT / *SYSLST
,STRUCTURE-OUTPUT = SYSINF / NONE / <composed-name 1..255>(...)
	<composed-name 1..255>(...)
		\|	WRITE-MODE = REPLACE / EXTEND

^*P) Privileged operand or operand value

REQUEST-NAME =
Serves to select the requests to be displayed using the request name as the selection criterion.
The default name specified via the action statement or assigned by HSMS is extended internally by a prefix formed by the user ID and a suffix in the form of a time stamp. Since the name by itself need not be unique, it can be used to refer to more than one request at a time.

REQUEST-NAME = *ANY
The requests are to be selected irrespective of their names.

REQUEST-NAME = <name 1..8>
Displays only requests with the specified name.

ENVIRONMENT =
Defines the HSMS environment from which requests are output.

ENVIRONMENT = *ALL
The requests from the SF environment and from all existing SM environments are output. The screen masks for information output are formatted exactly as for the output for a particular HSMS environment. If no requests can be shown for one of the environments displayed no particular message to this effect is issued. A message is output only if no requests at all can be displayed.

ENVIRONMENT = *STD
The HSMS statement relates to the default environment for DMS requests:

For privileged users: *STD is set to the value *SINGLE-FEATURE.
For nonprivileged users: *STD is the environment that is associated with the user’s default pubset (the default pubset is defined in the user catalog).

ENVIRONMENT = *NODE-STD
The HSMS statement relates to the default environment for node requests:

For privileged users: *NODE-STD is set to the value *SINGLE-FEATURE.
For nonprivileged users: *NODE-STD is set to the value of the environment in which the home directory of the user is defined.

ENVIRONMENT = *SINGLE-FEATURE
Only the requests from the SF environment are output.

ENVIRONMENT = *SYSTEM-MANAGED(...)
Only the requests from the specified SM pubset environment are output.

CATALOG-ID = <cat-id>
Catalog ID of the SM pubset to which the HSMS statement applies.

REQUEST-DATE =
Serves to select the requests to be displayed using the creation date as the selection criterion.

REQUEST-DATE = *INTERVAL(...)
The requests to be displayed are to be selected using a time interval as the selection criterion. The interval includes all requests created between CREATED-AFTER and CREATED-BEFORE.
Unless otherwise specified, all requests, starting with the one created first (*EARLIEST-DATE) up to the one created last (*LATEST-DATE), are selected.

CREATED-BEFORE = *LATEST-DATE
The requests are to be displayed irrespective of whether they were created before a specific date.

CREATED-BEFORE = <date with-compl>
Displays only requests created on or before the specified date.

CREATED-BEFORE = <integer -99999..0 days>
Displays only requests created on or before the specified relative date.

CREATED-AFTER = *EARLIEST-DATE
The requests are to be restarted irrespective of whether they were created after a specific date.

CREATED-AFTER = <date with-compl>
Displays only requests created on or after the specified date.

CREATED-AFTER = <integer -99999..0 days>
Displays only requests created on or after the specified relative date.

REQUEST-DATE = *LATEST
Displays only the most recently generated requests.

REQUEST-DATE = <date with-compl>(...) / <integer -99999..0 days>(...)
The requests to be displayed are selected using the date and time of their creation as the selection criterion.

TIME = <time>
Time specification in the format hh:mm:ss

REQUEST-ORIGIN =
This operand is only available to the HSMS administrator.
The requests to be selected are displayed according to their place of origin: by default this is the central BS2000 host (DMS and node requests).

REQUEST-ORIGIN = *BS2000(...)
The requests were issued on the BS200 host by a BS2000 user.

USER-ID =
Serves to select the requests to be displayed using the user ID under which they were created as the selection criterion.

USER-ID = *OWN
Displays only requests created under the user’s own ID (or, in the case of the HSMS administrator, under SYSHSMS).

USER-ID = *ALL
Requests from all users are to be displayed.

USER-ID = <name 1..8>
Only requests of the specified user ID are to be displayed.

REQUEST-ORIGIN = *NODE-CL(...)
This operand only exists for compatibility reasons.

REQUEST-STATE =
Selects the requests using their processing state as the selection criterion.

REQUEST-STATE = *ANY
Selects the requests irrespective of their processing state.

REQUEST-STATE = *COMPLETED
Displays only completed requests.

REQUEST-STATE = *ACCEPTED
Displays only requests which were accepted for processing but have not yet been started.

REQUEST-STATE = *STARTED
Displays only requests currently being processed.

REQUEST-STATE = *INTERRUPTED
Displays only requests whose processing was interrupted.

ARCHIVE-NAME =
Only for archive owners:
The requests to be displayed can be selected in the specified environment according to the archive for which they were created. In the case of requests where two archives are involved (copying), the request is assigned to the target archive.

ARCHIVE-NAME = *ALL
The requests to be displayed are selected irrespective of the archive.

ARCHIVE-NAME = <filename 1..22 without-cat-gen-vers>
Only requests referring to this archive are displayed.

INFORMATION =
Specifies the scope of information that is to be output.

INFORMATION = *SUMMARY
Summary information is output for each request. If output is sent to SYSOUT then one or more requests can be selected for full information display.

Details on the content of the screen mask are provided in the section "Output for requestswhich were issued at a BS2000 host (summary)".

INFORMATION = *ALL
More detailed information is output for each request.

Details on the content of the screen mask are provided in the section "Output for requestswhich were issued on a BS2000 host (all information)".

OUTPUT =
Determines the output medium for the desired information. Output generally takes place to SYSLST for batch requests.

OUTPUT = *SYSOUT
The information is output to the logical system file SYSOUT, i.e. it is normally displayed on the screen in interactive mode.

OUTPUT = *SYSLST
The information is output to the logical system file SYSLST. Each mask comprises 43 lines.

OUTPUT = *NONE
The information is not output in text format.

STRUCTURE-OUTPUT =
Controls structured output in S variables (for the variable layout see "Output in S variables").

STRUCTURE-OUTPUT = *SYSINF
Structured output is directed to the SYSINF S variable stream.

STRUCTURE-OUTPUT = *NONE
No structured output takes place.

STRUCTURE-OUTPUT = <composed-name 1..255>(...)
Name of the S variable that is to be used for the structured output.

WRITE-MODE =
Determines whether the output should replace or complement the current content of the S variables.

WRITE-MODE = *REPLACE
The current content of the S variable is to be replaced by the new output.

WRITE-MODE = *EXTEND
The new output extends the current content of the S variable.

Layout of the screen masks

Output for requests which were issued at a BS2000 host (summary)

//SHOW-REQUESTS ...,REQUEST-ORIGIN=*BS2000,...,INFORMATION=*SUMMARY

 SHOW-REQUEST INFORMATION=SUMMARY     USER-ID       = @@@@@@@@
 REQUEST-NAME = @@@@@@@@              REQUEST-DATE  = @@@@@@@@@ @@@@@@@@ @@@@@@@@
 ENVIRONMENT  = @@@@@@@@              REQUEST-STATE = @@@@@@@@@@@
 --------------------------------------------------------------------------------
 M USER-ID  DATE       TIME     REQUEST   STATE       SUB-STATE          HOST/TSN
   @@@@@@@@ @@@@@@@@@@ @@@@@@@@ @@@@@@@@  @@@@@@@@@@@ @@@@@@@@@@@@@@@@@  @@@@@@@@
   @@@@@@@@ @@@@@@@@@@ @@@@@@@@ @@@@@@@@  @@@@@@@@@@@ @@@@@@@@@@@@@@@@@  @@@@@@@@
   @@@@@@@@ @@@@@@@@@@ @@@@@@@@ @@@@@@@@  @@@@@@@@@@@ @@@@@@@@@@@@@@@@@  @@@@@@@@
   @@@@@@@@ @@@@@@@@@@ @@@@@@@@ @@@@@@@@  @@@@@@@@@@@ @@@@@@@@@@@@@@@@@  @@@@@@@@
   @@@@@@@@ @@@@@@@@@@ @@@@@@@@ @@@@@@@@  @@@@@@@@@@@ @@@@@@@@@@@@@@@@@  @@@@@@@@
   @@@@@@@@ @@@@@@@@@@ @@@@@@@@ @@@@@@@@  @@@@@@@@@@@ @@@@@@@@@@@@@@@@@  @@@@@@@@
   @@@@@@@@ @@@@@@@@@@ @@@@@@@@ @@@@@@@@  @@@@@@@@@@@ @@@@@@@@@@@@@@@@@  @@@@@@@@
   @@@@@@@@ @@@@@@@@@@ @@@@@@@@ @@@@@@@@  @@@@@@@@@@@ @@@@@@@@@@@@@@@@@  @@@@@@@@
   @@@@@@@@ @@@@@@@@@@ @@@@@@@@ @@@@@@@@  @@@@@@@@@@@ @@@@@@@@@@@@@@@@@  @@@@@@@@
   @@@@@@@@ @@@@@@@@@@ @@@@@@@@ @@@@@@@@  @@@@@@@@@@@ @@@@@@@@@@@@@@@@@  @@@@@@@@
   @@@@@@@@ @@@@@@@@@@ @@@@@@@@ @@@@@@@@  @@@@@@@@@@@ @@@@@@@@@@@@@@@@@  @@@@@@@@
   @@@@@@@@ @@@@@@@@@@ @@@@@@@@ @@@@@@@@  @@@@@@@@@@@ @@@@@@@@@@@@@@@@@  @@@@@@@@
   @@@@@@@@ @@@@@@@@@@ @@@@@@@@ @@@@@@@@  @@@@@@@@@@@ @@@@@@@@@@@@@@@@@  @@@@@@@@
   @@@@@@@@ @@@@@@@@@@ @@@@@@@@ @@@@@@@@  @@@@@@@@@@@ @@@@@@@@@@@@@@@@@  @@@@@@@@
   @@@@@@@@ @@@@@@@@@@ @@@@@@@@ @@@@@@@@  @@@@@@@@@@@ @@@@@@@@@@@@@@@@@  @@@@@@@@
   @@@@@@@@ @@@@@@@@@@ @@@@@@@@ @@@@@@@@  @@@@@@@@@@@ @@@@@@@@@@@@@@@@@  @@@@@@@@
 --------------------------------------------------------------------------------
 NEXT-PAGE : +   (+, -, ++, --, E)   M : / = DELETE-REQUEST, ? = ALL-INFORMATION
 @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@

Key:

Column	Values	Meaning
M		Mark column for selecting the requests which are either to be displayed with all their information in a separate mask or are to be deleted: file not selected = blank; delete request = “/”; all information = “?” or another character, but not “/” (the branch from a detailed mask takes place in accordance with the current assignment in the NEXT-PAGE field)
NEXT-PAGE		Input field for scrolling within an environment, for leaving an environment and for specifying the return address:
	+	Next page of the current environment
	-	Previous page of the current environment
	++	Last page of the current environment
	--	First page of the current environment
	E	Return to the previous environment
	Blank	Same page of the current environment
USER-ID		User ID under which the request was created
DATE		Creation date of the request in the format YYYY-MM-DD
TIME		Creation time of the request in the format HH:MM:SS
REQUEST		Name of the request (freely selectable by the user); default names are:
		Action statement	Default name
		ARF#yyyy	ARCHIVE-FILES
		ANF#yyyy	ARCHIVE-NODE-FILES
		BCF#yyyy	BACKUP-FILES
		BFV#yyyy	BACKUP-FILE-VERSIONS
		BNF#yyyy	BACKUP-NODE-FILES
		CES#yyyy	COPY-EXPORT-SAVE-FILE
		EXF#yyyy	EXPORT-FILES
		IMF#yyyy	IMPORT-FILES
		CNF#yyyy	COPY-NODE-SAVE-FILE
		CSF#yyyy	COPY-SAVE-FILE
		MGF#yyyy	MIGRATE-FILES
		MSV#yyyy	MOVE-SAVE-FILES
		RMF#yyyy	RECALL-MIGRATED-FILES
		RCR#yyyy	REPAIR-CATALOG-BY-RESTORE
		RFR#yyyy	REPLACE-SAVE-FILE-BY-RESTORE
		RLE#yyyy	RESTORE-LIBRARY-ELEMENTS
		RSF#yyyy	RESTORE-FILES
		RNF#yyyy	RESTORE-NODE-FILES
		UES#yyyy	UPDATE-EXPORT-SAVE-FILE
		yyyy: TSN of the calling user task
STATE		Request status (for details see SUBSTATE)
	INCOMPLETE	Request not accepted (error during acceptance)
	ACCEPTED	Request accepted by HSMS
	STARTED	Request being processed; additional information in SUBSTATE:
		COLLECTED	Processed by collector request
		START-ARCHIVE	Request transferred to ARCHIVE
		ARCHIVE-COMPLETED	Request completed by ARCHIVE
		START-REPORT	Report creation started
		SENT-TO-MASTER	Request sent to master of shared pubset
		MASTER-REPLIED	Reply to request received from master of shared pubset
		MASTER-NO-CONNECT	Master of shared pubset has not replied (crash). Request stopped.
		MASTER-TIMEOUT	Master of shared pubset failed to reply within specified time. Request stopped.
		IN-TRANSMIT	Report is ready; it just needs to be sent to the active node.
		IN-DELETE	Pseudo substatus ¹
	COMPLETED	Request processed by HSMS; Additional information in SUBSTATE:
		WITH-WARNINGS	Processed with warnings
		WITH-ERRORS	Processed with errors
STATE (cont.)	INTERRUPTED	Request interrupted during processing. It can be restarted after cause is eliminated; additional information in SUBSTATE:
		MASTER-NO-CONNEC	Master of shared pubset has not replied (crash). Request stopped.
		MASTER-TIMEOUT	Master of shared pubset failed to reply within specified time. Request stopped.
		MASTER-REPLIED	Master of shared pubset failed after response. Request stopped.
		BACK-SERV-NO-CONN	Backup server has not replied (crash). Request stopped.
		BACK-SERV-TIMEOUT	Backup server failed to reply within specified time. Request stopped.
		BACK-SERV-REPLIED	Backup server failed after response. Request stopped.
		START-ARCHIVE	Request transferred to ARCHIVE
	CANCELLED	Request was canceled before it was started.
SUBSTATE		Additional information on request status (for possible values see STATE)
HOST/TSN		Information about a possible request lock: Blank: No current lock. ’LOC-xxxx’: The request is locked by the local host; xxx is the TSN of the executing server task (if one exists Other string BCAM name of the remote host that is currently locking the request.

¹	If a DELETE-REQUESTS statement is issued for a request with the status “STARTED”, the substatus of the request is set to “IN-DELETE” while the request is being deleted.

Output for requests which were issued on a BS2000 host (all information)

//SHOW-REQUESTS ...,REQUEST-ORIGIN=*BS2000,...,INFORMATION=*ALL

 SHOW-REQUEST INFORMATION=ALL         USER-ID       = @@@@@@@@
 REQUEST-NAME = @@@@@@@@              REQUEST-DATE  = @@@@@@@@@ @@@@@@@@ @@@@@@@@
 ENVIRONMENT  = @@@@@@@@              REQUEST-STATE = @@@@@@@@@@@
 --------------------------------------------------------------------------------
   USER-ID  DATE       TIME     REQUEST   STATE       SUB-STATE          HOST/TSN
   @@@@@@@@ @@@@@@@@@@ @@@@@@@@ @@@@@@@@  @@@@@@@@@@@ @@@@@@@@@@@@@@@@@  @@@@@@@@
 --------------------------------------------------------------------------------
  ACTION          : @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  ARCHIVE-NAME    : @@@@@@@@@@@@@@@@@@@@@@
  REPORT-FILENAME : @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  CONTROL-JV-NAME : @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  DESCRIPTOR      : @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ 
  SIMULATED   : @@@    WAITING-USER-TSN : @@@@           HSMS-VERSION : @@@
  EXPRESS     : @@@    CCOPY-SESSION-ID : @@@@@@@@
  FROM-REMOTE : @@@    TO-MASTER-HOST   : @@@@@@@@
  RESTARTED   : @@@
  PRIORITY    : @@@
 --------------------------------------------------------------------------------
 NEXT-PAGE :     (+, -, ++, --, E)
 @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@

Key:

Column	Values	Meaning
USER-ID		User ID under which the request was created
DATE		Date when the request was created
TIME		Time when the request was created
REQUEST		See key to previous screen
STATE and SUBSTATE		See key to previous screen
HOST/TSN		See key to previous screen
ACTION		HSMS statement (e.g. BACKUP-FILES) or command (e.g. IMPLICIT-RECALL)
ARCHIVE-NAME		Name of the involved archive. If no archive is involved (e.g. in the event of an implicit recall), a hyphen is output. If two archives are involved (e.g. in the event of a COPY-SAVE-FILE), only the target archive is output.
REPORT-FILENAME		Name of the DMS file to which the report is to be output. If the user has specified PRINTER as the output medium in the HSMS statement, PRINTER is output. If no report has been requested, a hyphen is output.
CONTROL-JV-NAME		Name of the job variable assigned to the request.
DESCRIPTOR		Any user-defined text for the console.
SIMULATED		Indicates whether the request is simulated.
	YES	The request is simulated.
	NO	The request is not simulated.
WAITING-USER-TSN
HSMS-VERSION		Functional version of the request. This information is useful in shared pubset configurations if different versions of the HSMS subsystem are running on the various sharers.
EXPRESS		Indicates whether the request is processed as an express request.
	YES	The request is processed as an express request.
	NO	The request is not processed as an express request.
CCOPY-SESSION-ID		If a CCOPY session is involved, its ID is output. The session is closed until completion of the CCOPY request and *CLOSED is output. If no CCOPY session is involved, a hyphen is output.
FROM-REMOTE		Indicates whether the request was sent from a slave host.
	YES	The request was sent from a slave host.
	NO	The request was not sent from a slave host.
TO-MASTER-HOST		If the request was sent to a master host for processing, this field contains the BCAM name of the master host. Otherwise a hyphen is output.
RESTARTED		Indicates whether the request has been restarted.
	YES	The request has been restarted.
	NO	The request has not been restarted.
PRIORITY		Processing priority of the request
PRIORITY	1..255	The values are only available during the processing of the request.

Output in S variables

All variables are of the data type string.

Name of the S variable	Content	Corresponding field in the screen mask	Footnote
var(*LIST).USER-ID	<string 1..8>	USER-ID	²⁾
var(*LIST).NODE-ID	<string 1..48>	NODE-ID	³⁾
var(*LIST).USER-NUM	<integer>	USER#	^{1) 3)}
var(*LIST).REPLY-IP-ADDR	<string 1..15>	REPLY-IP-ADDR	³⁾
var(*LIST).PORT	<integer>	PORT#	^{1) 3)}
var(*LIST).BSPI-ID	<string 1..12>	BSPI-ID	³⁾
var(*LIST).REQ-NAME	<string 1..8>	NAME
var(*LIST).REQ-DESCRIPTOR	<string 1..60>
var(*LIST).DATE	<string 10..10>	DATE
var(*LIST).TIME	<string 8..8>	TIME
var(*LIST).SIMULATION	YES NO	IND(1)
var(*LIST).EXPRESS	YES NO	IND(2)
var(*LIST).RESTART	YES NO	IND(3)
var(LIST).ENVIRONMENT SINGLE-FEATURE with SF pubset Catid with SM pubset	*SINGLE-FEATURE <string 1..4>	ENVIRONMENT
var(*LIST).FROM-REM	YES NO	IND(4)
var(*LIST).STA	<string 1..11>	STATE
var(*LIST).SUB-STA	<string 1..17>	SUB-STATE
var(*LIST).PROCESSOR-NAME	*LOCAL <string 1..8>
var(*LIST).SERVER-TSN	<string 4..4>	TSN
var(*LIST).MASTER-HOST	<string 1..8>		⁵⁾
var(*LIST).WAIT-USER-TSN	<string 4..4>		⁶⁾
var(*LIST).ACTION	<string 3..3>
var(*LIST).ARCHIVE-NAME	<string 1..22>		⁶⁾
var(*LIST).PRIO	<integer>		¹⁾
var(*LIST).CCOPY-SESSION-ID	<string 1..8>		⁷⁾
var(*LIST).CONTR-JV	*NONE <string 1..54>
var(*LIST).REPORT-OUT	*PRINTER <string 1..54>
var(*LIST).MIN-HSMS-VERSION	<string 3..3>

¹⁾	The integer values are output in string format.
²⁾	Element only output if REQUEST-ORIGIN=*BS2000.
³⁾	Element only output if REQUEST-ORIGIN=*NODE-CL (operand value only exists for compatibility reasons).
⁴⁾	TSN not available.
⁵⁾	Useable output only if the request is sent to a master; otherwise output with blank character string
⁶⁾	Useable output only if relevant; otherwise output with blank character string
⁷⁾	Useable output only for CCOPY requests; otherwise output with blank character string

For more detailed information on S variables, refer to the manual “Commands” [5].

Your Browser is not longer supported

Please use Google Chrome, Mozilla Firefox or Microsoft Edge to view the page correctly

SHOW-REQUESTS Show requests

Format

Layout of the screen masks

Output in S variables