FLAM4

Synopsis

HELP:   Read records from a FLAM4FILE
TYPE:   OBJECT
SYNTAX: FLAM4(NET.{},FILE['str'...],EXCLUDE='str',MEMBER='str',PRNCONTROL=DETACH/RETAIN/ERASE/REPLACE,RECCOUNT=num,RECLENGTH=num,TRUNCATE,PASSWORD/CRYPTOKEY='bin'/DEFAULT,KMLIBRARY='str',KMFUNCTION='str',KMPARAMETER='bin',CCSID='str'/DEFAULT/ASCII/EBCDIC/BOMUTF/BOMUCS/SYSTEM/LOCAL,CHRMODE=STOP/IGNORE/SUBSTITUTE/IDENTITY/TRANSLIT,SKIPEQUAL,USRTABLE='str'/NPAS/SEPA/DELA/DLAX,ONEMAP,COMBINED=NFD/NFC/AUTO/ON/OFF,BOM[=FAIL/ON/OFF],KEEPBOM,NONCHR=KEEP/REPLACE/SUBSTITUTE/IGNORE,REMOVE,RENAME='str',LANG='str',PLATFORM=WIN/UNX/ZOS/USS/VSE/BS2/MAC,OWNER='str',ENVID='str',HASH(),SIGNATURE.{},TABLE(),AVSCAN(),PREPROCESS[()...],POSTPROCESS/PSTPRO[()...],LARGER)

Description

Read FLAM4 works with a list of records from a FLAMFILE of version 4 or older. If such a record is text data, you can mark this by defining the correct CCSID. Such a definition will result in character set conversion from the provided CCSID to UTF-8 for each record. If no CCSID is provided, the record will be handled as binary data.

For FLAMFILE archives, these features are supported:

• Read all members or a dedicated member of the archive
• Print control character handling defined by a dedicated mode
• Pass phrase based or FKME based decryption technology
• Free definition of the amount of records handled as one chunk

User I/O, pre- and post-processing exits are not supported. If these features are required, please use the extended variant (XCMP/XCNV) of this command.

If you need, for example, Base64 decoding for records of a FLAMFILE, please use read.record(fdecode.base64). Read.record() can transparently read FLAMFILEs, supports base decoding and other useful features for record handling.

If you provide row specifications through the table object, each record is split into neutral FL5 table elements.

FLAMv4 does not recognise file sizes. Only FLAMv5 stores these in the system header. With FLAMv5.2, we have incorporated an extension so that file sizes can be determined during reading based on the compression size. For this purpose, the environment variable FL_4_EXPANSION_FACTOR must be defined if this is also to be applied to files smaller than 1 GiB. The default expansion factor can be set via the environment variable or its corresponding system symbol (&FL4EXPF). This is used if the expansion cannot be determined based on the first segment. If we can determine the expansion of the first segment, we increase this factor by the half of the differenz to the provided expansion factor if it is smaller than the environment variable or default and decrease it by 1 if it is larger. If the environment variable is not set the default expansion is 10 and the calculated file size (size of the compressed file multiply by expansion factor) is only accepted if this size is greater than the default allocation we make when we do not know the size. The latter was included for backward compatibility reasons and can be disabled by explicitly setting the environment variable.

Arguments

• STRING: FILE['str'...] - Name/URL of the FLAMFILE to read [required]
• STRING: EXCLUDE='str' - Exclude files or members matching the specified wildcard pattern from processing
• STRING: MEMBER='str' - Name or Index of the member in the FLAMFILE to read
• NUMBER: RECCOUNT=num - Amount of records handled in one read operation [4<128<1024]
• NUMBER: RECLENGTH=num - Maximum record length for read operation [512]
• SWITCH: TRUNCATE - Allow truncation of records [FALSE]
• STRING: PASSWORD/CRYPTOKEY='bin'/DEFAULT - Passphrase to decrypt the FLAMFILE ['']
  • DEFAULT - FLAM4 default password
• STRING: KMLIBRARY='str' - Library name for FKME ['']
• STRING: KMFUNCTION='str' - Function name of FKME ['']
• STRING: KMPARAMETER='bin' - Parameter for the call of FKME ['']
• SWITCH: SKIPEQUAL - Skip conversion if formats are equal (e.g. UTF-8 to UTF-8)
• SWITCH: KEEPBOM - Keep byte order mark for faster conversion