SHOW-CCOPY-SESSION

Display information on CCOPY sessions

Component:	CCOPY
Functional area:	Pubset and MRSCAT management
Domain:	STORAGE-MANAGEMENT
Privileges:	TSOS HSMS-ADMINISTRATION

Function

The user can obtain information on all existing CCOPY sessions using the SHOW-CCOPY-SESSION command (as of CCOPY V3.0A). Output can be directed to either SYSOUT or SYSLST. The INFORMATION operand can be used in order to define whether only the attributes of the installed CCOPY sessions are to be output (e.g. identification, status, name and size of work file) or whether the relevant objects (files and job variables) are to be displayed as well.

The command supports structured output in S variables (see "Output in S variables").

Format

SHOW-CCOPY-SESSION                                                                                                                               

SESSION-ID = *ALL / <alphanum-name 8..8>
,INFORMATION = *ATTRIBUTES / *OBJECTS-AND-ATTRIBUTES
,OUTPUT = *SYSOUT / *SYSLST(...)
	*SYSLST(...)
		|	SYSLST-NUMBER = *STD / <integer 1..99>

Operands

SESSION-ID = *ALL / <alphanum-name 8..8>
Specifies whether information is to be output on all CCOPY sessions or only on a specific CCOPY session.

SESSION-ID = *ALL
Information is to be output on all CCOPY sessions

SESSION-ID = <alphanum-name 8..8>
Information is to be output on the specified CCOPY session only.

INFORMATION = *ATTRIBUTES / *OBJECTS-AND-ATTRIBUTES
Defines the scope of the information that is to be output for each CCOPY session that is selected.

INFORMATION = *ATTRIBUTES
The attributes of the installed CCOPY sessions are output (e.g. identification, status, name and size of the work file).

INFORMATION = *OBJECTS-AND-ATTRIBUTES
The same information is output as with INFORMATION=*ATTRIBUTES, but with additional information on the objects (e.g. object name, object type and object status).

OUTPUT = *SYSOUT / *SYSLST(...)
Defines the destination to which the information is output.

OUTPUT = *SYSOUT
Output is directed into the SYSOUT system file.

OUTPUT = *SYSLST(...)
Output is directed into the SYSLST system file.

SYSLST-NUMBER = *STD /<integer 1..99>
For SYSLST-NUMBER=*STD, output is directed to SYSLST or into a SYSLST file whose name consists of “SYSLST” and a number between 1 and 99 (SYSLST01 to SYSLST99).

Return codes

(SC2)	SC1	Maincode	Meaning
	00	CMD0001	No error
	32	CMD2009	VAS / OPS reports an internal error
	32	DCH0005	Internal error occurred when setting / releasing a lock in the CCOPY subsystem
	32	DCH000D	System error occurred on program execution
	32	DCH000E	System error during output in S variable
	64	CMD0216	User not privileged
	64	DCH0006	No CCOPY session
	64	DCH0007	Invalid SESSION-ID
	130	OPS0001	Insufficient storage for output in S variable

Output in S variables

Output information	Name of the S variable	T	Contents
Creation date	var(*LIST).CRE-DATE	S	<c-string 10..10: yyyy-mm-dd>
Creation time	var(*LIST).CRE-TIME	S	<c-string 8..8: hh:mm:ss>
Runtime environment *HOST= local *CCS= shared pubset network	var(*LIST).ENVIR	S	*HOST *CCS
Number of objects	var(*LIST).NUM-OF-OBJECT	I	<integer 0..2147483647>
Number of objects already backed up	var(*LIST).OBJECT-PROCESS	I	<integer 0..2147483647>
Object status *OMIT=object will not be backed up *SEL-FOR-SAVE=object will be backed up *SAVE-START=backing up *SAVE-ABORT=backup aborted *OBJECT-SAVE=object has been backed up *WORK-FILE=object is a work file and will not be backed up	var(*LIST).OBJECT-STA	S	*OMIT' *SEL-FOR-SAVE *SAVE-START *SAVE-ABORT *OBJECT-SAVE *WORK-FILE
Number of objects to be backed up	var(*LIST).OBJECT-TO-SAVE	I	<integer 0..2147483647>
Fully qualified object name	var(*LIST).OBJECT(*LIST). OBJECT-NAME	S	<c-string 1..54>
Object type *FILE=file *FGGI=file generation index *FGG=file generation group *JV=job variable	var(*LIST).OBJECT(*LIST). OBJECT-TYPE	S	*FILE *FGGI *FGG *JV
CCOPY session ID (eight characters long)	var(*LIST).SESSION-ID	S	<c-string 8..8>
Status of CCOPY session *IN-CRE=being created *RUN=running *BACKUP-IN-PROGRESS=backing up *TERM=terminated *ABORT=aborted	var(*LIST).STA	S	*IN-CRE *RUN *BACKUP-IN-PROGRESS *TERM *ABORT
Fully qualified name of work file	var(*LIST).WORK-FILE-NAME	S	<c-sting 1..54>
Size of work file	var(*LIST).WORK-FILE-SIZE	I	<integer 0..2147483647>

Examples

Output format for INFORMATION=*ATTRIBUTES

======================== CCOPY - SESSION - DATA ==========================
SESSION-ID = 00010001     STATUS = RUNNING                      ENV = HOST
CRE-DATE = 2012-03-31     CRE-TIME = 12:00:00
OBJECTS-TO-SAVE = 10      OBJECTS-PROCESSED = 7
WORK-FILE-NAME = <work file>
WORK-FILE-SIZE = 48 KB

An output block as shown in this example is issued for every CCOPY session (if SESSION-ID=*ALL was specified) or for the session chosen.

Output format for INFORMATION=*OBJECTS-AND-ATTRIBUTES

======================== CCOPY - SESSION - DATA ==========================
SESSION-ID = 00010001     STATUS = RUNNING                      ENV = HOST
CRE-DATE = 2012-03-31     CRE-TIME = 12:00:00
OBJECTS-TO-SAVE = 10      OBJECTS-PROCESSED = 7
WORK-FILE-NAME = <work file>
WORK-FILE-SIZE = 48 KB
------------------------ OBJECTS ------------- TYPE ------- STATUS -------
<filename>                                     FILE      SELECTED-FOR-SAVE
<filename>                                     FILE      SELECTED-FOR-SAVE
<filename>                                     FGGI      SELECTED-FOR-SAVE
<filename>                                     JV        SELECTED-FOR-SAVE
<filename>                                     FILE      SELECTED-FOR-SAVE
...