Typographical conventions

The typographical conventions specify the syntax to use in Transfer CFT commands, the parameters and their values. These rules apply equally for any additional parameter information, or information pertaining to the operating system or the transfer protocols.

Note Use the Command index to help locate a command, and the Parameter index for parameter details.

Command description

The description of each command is generally organized in parts:

  • Functional description
  • List indicating the general syntax of parameters passed with a command, grouped by categories

Example

CFTFILE [MODE = {CREATE | DELETE},]
FNAME = filename,
TYPE = {PARM | PART | CAT | LOG | ACCNT | COM},
  • Detailed description of parameters, in alphabetical order

FNAME = filename (Name of the file to which the command applies)

  • Generic example of parameter setting. Parameter setting examples are indicated in New Courier typeface.

Example of creating a parameter file:

CFTFILE TYPE = PARM,
    MODE = CREATE,
    FNAME = filename

Parameter description

There are two types of parameters mandatory and optional:

  • Mandatory parameters are followed by the word (Mandatory) in italics
  • Optional parameters (placed between square brackets [ ])

Each parameter description applies the following general syntax:

PARAMETER = value(s)

Information

SPECIFIC

Definition of the parameter

Indication of any additional information available for the value defined.

Indication of the field of application and any usage restrictions for the parameter

The information and specifics fields are optional.

Example

COPYFILE OFNAME = filename

In this command, the OFNAME parameter is mandatory. Its value corresponds to a filename.

Example

CFTSEND [NFNAME = filename]       PeSIT E CFT/CFT

In this object, the NFNAME parameter is:

  • Used to indicate a physical filename
  • Optional with no default value, the optional nature being indicated by square brackets [ ]
  • Reserved for transfer cases in PeSIT E profile between two Transfer CFTs

Parameter value notation conventions

The notation conventions generally used to describe parameter values are listed in the following table.

Type Notation Example

List of possible values 

{value, value} 

{filename, string} 

Choice 

{1 | 2} 

{CREATE | DELETE} 

Numeric field
(value indicated between a and b) 

{a..b} 

{0..255}  

Default value 

underlined 

{CREATE | DELETE} 

Optional parameter 

[PARAMETER] 

[NFNAME = filename] 

{value|text} must be indicated 

italic 

filename 

Mandatory parameter

(Mandatory)

 

Generic-type parameter values

The conventions used for generic-type values are listed in the following table.

Type Notation Example

Character type value: one single character 

c

FTYPE = c 

Numeric type value: numeric character string 

n

FLRECL = n 

Character string value: series of alphanumeric characters or series of characters between quotes 

string

SAP = string 

If the parameter is mandatory: string containing between 1 and n characters inclusive

If the parameter is optional: string containing between 0 and n characters 

stringn

PUNAME = string10
String containing between 1 and 10 characters

[COMMENT = string32]
String containing between 0 and 32 characters 

String containing between n and m characters

stringn..m 

LUNAME = string3..8
String containing between 3 and 8 characters 

String containing exactly n characters

stringn 

KEY = string21
21-character string 

Constant-type value (preset) 

VALUE 

TYPE = PESIT 

The string notation is used generically, in lists indicating the general parameter syntax for example. The stringn, stringn..m and stringn notations are used in the detailed parameter descriptions.

Parameter values for preset categories

The conventions used for values concerning preset categories are listed in the following table.

Type Notation

Compression: numeric value between 0 and 15 indicating the compression algorithm 

cpr 

Date: 8-digit string

YYYYMMDD 

File name: alphanumeric string with a maximum length of 64 characters 

filename 

Identifier: string with 1 to 8 alphanumeric characters, the initial character being a letter 

identifier 

Mask: string containing special characters indicating a "mask" 

mask 

Time: string containing between 2 and 8 digits 

HHMMSS 

Transfer identifier assigned by Transfer CFT 

transid 

Protocol variants

Specificity concerning the PeSIT protocol. A protocol dependent parameter may involve one or more of the PeSIT protocol variants, indicated as follows:

Protocol Description

PeSIT

PeSIT protocol (standard)

PeSIT CFT/CFT

PeSIT protocol used between two Transfer CFTs

Command syntax

The parameter setting commands are presented in the following format:

Syntax

Command syntax listed here [see parameters below]

Description

Each parameter setting command generates one or more binary records in the PARAMETER or PARTNER file.

Parameters

Parameter name and abbreviation

id

identifier {0..32768}

Identifies the object described by the parameter setting command.

mode

Describes the operation to be performed on the PARAMETER or PARTNER files.

  • REPLACE (default): modify the associated record or records, or create them if they do not exist; this is the default value (default)
  • CREATE: add one or more records
  • DELETE: delete one or more records

Usage rules

All the parameters required to identify the file must be specified, except in the case of DELETE where the ID parameter is sufficient.

When you select REPLACE the following occurs:

  • If the CLASS parameter is modified a new record is created
  • If the CLASS parameter is not modified the new record overwrites the existing one

Only the parameters specified in the command are taken into account. Default value are used for unspecified parameters.

The comment for the MODE parameter is common to all the parameter setting commands and is not repeated on the following pages.

Example

When available, an example is listed here.

Syntax

Command syntax listed here [see parameters below]

Command reply format

Example

The report CFTU94I SHUT _Correct indicates that the SHUT command was correctly entered in CFTUTIL.

Related Links