RCCDOWN

RCCDOWN downloads a list of files from a single mainframe PDS.

Syntax

RCCDOWN(platform,CCtype,viewType,host,port,view,listOfFullyQualifiedFileName,localPDS,TSCdirectory,distributedUserName,client_codepage,server_codepage,client_rt_codepage,esc_chars,timeout,cq_id,cq_passwd,cq_dbset,verbose_option)

Arguments

You can use the following arguments when you run the RCCDOWN function.

platform: The name of the platform that contains the DevOps Code ClearCase® VOB. Allowable values: WINDOWS or UNIX®.
CCtype: The type of DevOps Code ClearCase environment. Allowable values: UCM or NONUCM.
viewType: The type of DevOps Code ClearCase view. Allowable values: SNAPSHOT or DYNAMIC.
host: The TCP/IP address or DNS name of the machine that contains the DevOps Code ClearCase VOB. This address must be a valid TCP/IP address or DNS name.
port: The TCP/IP port number used to contact the host specified by the host argument. Allowable values: 0-65535.
view: The DevOps Code ClearCase view used to access the fully qualified file name. This argument is required only when the platform is UNIX and the view type is DYNAMIC. Otherwise, the argument is null.
listOfFullyQualifiedFileName: The list of files to download. Fully qualified file name entries in the list are delimited with X'00'. All files included in the list must have the same file type extension.
localPDS: The name of the local mainframe PDS.
TSCdirectory: The name of the directory on the host machine from which TSO Client was started.
distributedUserName: The user ID on the distributed system on which you are running DevOps Code ClearCase and the server component of TSO Client.
client_codepage: The code page for the input, output, and build script files on the client. Code page conversion occurs only on text files. This argument is optional.
server_codepage: The code page used on the server. This argument is optional.
client_rt_codepage: The code page for the distributed system's locale. This option defaults to the same value as is specified with the client codepage client_codepage argument. This argument is optional.
esc_chars: A list of characters to escape during conversion of characters between ASCII and EBCDIC code pages. This argument is optional.
timeout: The number of minutes that the server waits for an invoked build script to return before stopping the build event. This argument is optional.
cq_id: A ClearQuest® user ID. This argument is optional.
cq_passwd: The password for the ClearQuest user ID. This argument is optional.
cq_dbset: The name of the schema repository to be used by ClearQuest. This argument is optional.
verbose_option: The message verbosity. The value for this argument can be -V, -V -V, or -V -V -V. This argument is optional.

Result

The following table lists the return and reason codes that result from running the RCCDOWN function; it also provides a description of the meaning of the codes.

Table 1. Result of running the RCCDOWN function
Return code	Reason code	Description
0	600	Processing successful.
8	611	Required argument missing.
	612	Invalid argument value.
	614	Distributed command failure.
	616	Improper number of arguments.
	617	Invalid file type.
	618	Invalid multiple file types.
	619	Null file type in name.
	621	Invalid multiple directories.
	622	Invalid file name in list.
12	698	Internal error.
12	699	Internal error.

Example

Download the COBOL programs pg1 and pg2 from the mainframe PDS userID.tsc.cbl to the DevOps Code ClearCase VOB testvob.

The VOB resides on a UNIX machine with a domain name of TEST.onsome.domain.com.

The server component of TSO Client is installed in var/tmp/samples/ and is running with auth mode 0, using port 4000. The NONUCM, DYNAMIC view is nonucmview.

You could use one of the following REXX™ commands to invoke the RCCDOWN API function:

pltf = ‘UNIX'
cctype = ‘NONUCM'
vtype = ‘DYNAMIC'
host = ‘TEST.onsome.domain.com''
port = ‘4000'
view = ‘nonucmview'
hex0 = ‘00'x
files = ‘/var/tmp/testvob/dir1/pg1.cbl'hex0'/var/tmp/testvob/dir1/pg2.cbl'
lpds = ‘userID.tsc.cbl'
dir = ‘/var/tmp/samples/userID'
disuser = ‘userone'
Parse Value RCCDOWN(pltf,cctype,vtype,host,port,view,files,lpds,dir,disuser) 
With rccret rccrsn rccmsg

Output

For a list of the output data sets corresponding to the RCCLOG1 and RCCERR file names, see RCCUALOC.

Note: RCCOUT is not an output file for this API function.

For a description of the log entries in RCCLOG1, see RCCULOG.

For an example listing of the log, see Example of a log entry.

RCCOUT contains verification that the list of files was checked out.