Syntax and Semantics

The syntax for the LIBRARY/MAINTENANCE COPY statement is described in the WFL Reference Manual. This section describes the syntax and semantics that COPYWRITE applies to the attributes which can be set in various parts of a COPY statement.
COPYWRITE is only invoked when a LIBRARY/MAINTENANCE COPY or ADD statement specifies certain combinations of attributes. The combination of attributes depends on what feature is being invoked, however in all cases a HOSTNAME must be set, on either the source or the destination volume.
The reason for this is that COPYWRITE is invoked as though it were the Native File Transfer Service, and if a HOSTNAME is not specified, WFL will not call NFT, and consequently MAGUS will not call COPYWRITE.
While the HOSTNAME is mandatory, it may also be used, for example with the AUTOUNLOAD feature.

Avoid using any attribute which WFL knows applies to a specific network protocol, because if WFL preselects the protocol, COPYWRITE will ignore the request.

Attribute	Implied Protocol
DOMAINNAME	FTP
DOCUMENTTYPE	FTAM
IPADDRESS	FTP

COPYWRITE supports only a single destination volume. In some cases, such as COPY&CATALOG it will also only allow a single source volume.

These are the attributes which may be specified on the <destination volume>.

Attribute	Value	Description

AUTOUNLOAD	ON	If the CD-ROM volume achive is successfully created, it is copied using FTP image mode to the destination specified by the HOSTNAME and USERCODE.
	OFF or DONTCARE	The CD-ROM volume archive is not copied.
FAMILYOWNER	<familyname>	Only used for the COPY&CATALOG option on Cataloging systems. It specifies the family name on which the files which are to have backup references updated, reside. See Cataloging.
HOSTNAME	<hostname>	The HOSTNAME is used with the AUTOUNLOAD attribute, and it is always required, because the COPYWRITE software is an extension to Native File Transfer.
KIND	CD	Selects the COPYWRITE software.
SCRATCHPOOL	<intrinsic name>	This attribute provides a shortcut for creating various types of CDROM image using COPYWRITE intrinsic Transforms.
SERIALNO	<serial number>	This attribute is used with a COPY&BACKUP. It specifies the serial number which will be used for the CDROM volume. The serial number is used to create the volume name in thie form, CD<serial number>_<family name>. This volume name is entered into the Volume Library and the serial number is entered into the backup reference for the file.
SINGLEUNIT	<boolean>	Only used for the COPY&CATALOG option on Cataloging systems. When specified, both the backup references (onsite and offsite) are updated. See Cataloging.
USERCODE	<log on info>	The USERCODE is used with the AUTOUNLOAD attribute and specifies the log on information for the target HOSTNAME that the CDROM volume image is copied to.
LOCKEDFILE	<boolean>	This attribute indicates that the destination volume is to be a file. It is specified when creating a self extracting archive, in which case the destination KIND is CD. It is also specified when copying CD Images and MCP structures.

These are the attributes which may be specified on the <source volume>.

Attribute	Value	Description
HOSTNAME	<hostname>	The HOSTNAME may be specified on either the source or the destination volume to ensure COPYWRITE will be called. However, only the HOSTNAME specified on the destination volume is used with the AUTOUNLOAD facility.
SERIALNO	<string>	Only used for the COPY&CATALOG option on Cataloging systems. This is the serial number used for the backup reference. If a volume library entry with this serial number already exists, the volume name must match the <source volume> name. If it does not exist, COPYWRITE will add a volume with the <source volume> name and this serial number to the volume library.
SAVEFACTOR	<integer>	Only used for the COPY&CATALOG option on Cataloging systems. When COPYWRITE detects a CDROM volume has come online for the first time, it updates the volume library attributes. This attribute specifies the value for the SAVEFACTOR in the volume library.
LOCKEDFILE	<boolean>	This attribute indicates that the source volume is a file. It is used when copying files from a CD Image on DISK or CD, and when making a copy of an entire CD Image.

These are the attributes which may be set on a file label equation, where the INTNAME is the same as the <destination volume>name.

Attribute	Value	Description
TITLE	<file title>	This attribute can be used to specify the filename and family name for the volume archive.

FILEKIND	TEXTDATA	The FILEKIND attribute only applies when data transformation is being performed. A FILEKIND of TEXTDATA transfers logical records as defined by the FILEKIND of the physical file. For example, logical records are unpacked from printer backup physical blocks and transferred. The WINDOWSNT shortcut sets this value internally
	CDATA	A FILEKIND of CDATA transfers the Library Maintenance block, as supplied by the MCP, without regard for the structure of the file. The HEXMT shortcut sets this value internally.
	DATA	A FILEKIND of DATA transfers logical records as defined by the physical attributes of the file. For example, printer backup physical blocks are transferred. In this context, the physical attributes of the file are the attributes which describe the physical file, such as MAXRECSIZE and which are stored in the disk file header.

TRANSFORM	<transform spec> (See File Attributes Programming Reference Manual)	The TRANSFORM attribute only applies when data transformation is being performed. This attribute specifies the name of an external library which is called to modify the files being copied. The type of volume being created, and the logical records provided, depend on the LABEL and FILEKIND attribute values which may either be directly set, or indirectly set by using a shortcut. A shortcut specifies a set of default attributes, including a default intrinsic transform. Label Equating the TRANSFORM attribute overrides the default, but does not affect the other attributes. See Example 12.

LABEL	STANDARD	An ISO9660 Data CD should be created. This value is set internally for the WindowsNT, Windows95, ASeries and HexMT shortcuts
	OMITTEDEOF	A LIBRARY/MAINTENANCE and JOLIET hybrid CD should be created. This value is set internally for the LibMaintJoliet shortcut.
	OMITTED	An ISO9660 and JOLIET hybrid CD should be created. This value is set internally for the ASeriesJoliet shortcut.

FAMILYOWNER	<name>	If the FAMILYOWNER is specified, then it is used to set the attribute on the CD. The FAMILYOWNER attribute is set on the CD if Publisher has the string, "UNISYS A SERIES USER, USERCODE = " <usercode>. The FAMILYOWNER attribute overrides the Publisher label equation.

MAXSUBFILES	<number>	The EstimatedDirectoryCount is set by specifying the MAXSUBFILES attribute. Normally, the Tape Directory is processed and the number of files and directories is counted, to ensure that sufficient space is reserved for volume archive structures. If a transform is used, additional directories may be created, so this attribute can be used to ensure sufficient space is reserved. In any case it will not matter because if sufficent space is not reserved, the CDR module rewrites the volume, when it cannot be generated in place, but this requires double the A-Series disk space.

DUMMYFILE	<boolean>	If the DUMMYFILE attribute is set, then copy and discard mode is selected. (See also Copy to NULL). In this mode, all data received is discarded and no CDROM volume is created. The DUMMYFILE option flags the CDR module to set the DUMMYFILE file attribute on the archive volume. This allows a TRANSFORM to be used to process the data, without creating a CDROM volume archive. This attribute is set internally for the Search shortcut.

These are the attributes which may be label equated to modify how a specific file should be copied from an ISO9660 file system with Extended Record Attributes. Each file has an INTNAME derived from it's ordinal position within the file list. The first file is called FILE000001. See Example 23 through Example 25.

Attribute	Value	Description
FILESTRUCTURE	ALIGNED180	If possible, the file will be copied ALIGNED180. If the FRAMESIZE is 8, it will be byte orieted, and if the FRAMESIZE is 48 it will be word oriented.
	STREAM	When set to STREAM and the FRAMESIZE is set to 8, and the MAXRECSIZE is set to 1, the Extended Record Attributes are ignored.
FRAMESIZE	8	File is byte oriented.
	48	File is word oriented, when FILESTRUCTURE is ALIGNED180.
MAXRECSIZE	1	When set to 1, and FRAMESIZE is 8, and FILESTRUCTURE is STREAM, any Extended Record Attributes are ignored.
FILEKIND	<filekind mnemonic>	If the structure of the file is compatible with a fixed length CANDE file, it can be coerced into the file structure which corresponds to the FILEKIND.

These are the atributes which may be label equated to a file with anINTNAME of DATAPREPARER.

Attribute	Value	Description
NOTE	<string>	The DataPreparer attribute of the CDROM volume archive is set to the value of the Note. This attribute can be seen using the Volume Attributes menu of COPYWRITE for NT.

These are the atributes which may be label equated to a file with an INTNAME of PUBLISHER.

Attribute	Value	Description
NOTE	<string>	The Publisher attribute of the CDROM volume archive is set to the value of the Note. This attribute can be seen using the Volume Attributes menu of COPYWRITE for NT.