FILETDSP 🚀

Name

filetdsp

Location

The CLI executable is available at:

<installation_dir>/app/bin

Purpose

Dispatches on or more local files into a queue.

Synopsis

• filetdsp [options] <QueueManagerName> <QueueName> <FileSpec>

• filetdsp -h

Description

The filetdsp command dispatches a local file or a directory into a specified queue.

During the dispatch operation the command associates metadata with the file and applies the file handling options specified by the user.

This command is provided to ensure backward compatibility with legacy automation and operational scripts. See Compatibility Command Line Interfaces to map QueueManagerName and QueueName concepts into Data Mover Smart concepts.

Arguments

Argument	Description	Required
QueueManagerName	Name of the Queue Manager hosting the queue	Yes
QueueName	Name of the queue to be listed	Yes
FileSpec	File or directory to be dispatched	Yes

Argument semantics and constraints

• FileSpec can be a single file or a directory

• when FileSpec refers to a file, the file is dispatched as-is

• when FileSpec refers to a directory the behavior depends on the specified options

• the -o ZDIR option must be used with a directory

• when -o ZDIR is specified:

  • directory contents, including sub-directories, are dispatched a single file

  • dispatched file has MsgModality Spazio Matadata and DMS Content type attribute set to BINARY

  • dispatched file has FileType Spazio Metadata and DMS record structure attribute set to STREAM

  • it is not possible to set -o DAta and/or -o CRLF flags

  • the dispatched file can only be acquired and unpacked on a DMS system that has the same operating system as that where the dispatched directory originated

• when -o EXTernal is specified, the external destination file name must be specified in -f

Options

Option	Parameter	Description
[-w]	MsgFileId	Optional metadata associated with the file; it can be used as a filter when retrieving the file.
[-c]	CorrelID	Optional metadata associated with the file; it can be used as a filter when retrieving the file.
[-s]	Sender	Optional metadata associated with the file; it can be used as a filter when retrieving the file.
[-n]	UserClass	Optional metadata associated with the file; it can be used as a filter when retrieving the file.
[-u]	UserId	User registered in Data Mover Smart.
[-p]	UserPwd	Password of the UserId.
[-f]	ExternalDestFileName	Specifies the external destination file name.
[-G]	CodePage	Specifies a code page number.
[-o]	NOBanner	Ignored.
[-o]	DAta | BInary	Specifies the file encoding; DAta must be used for ASCII text files. Otherwise, BInary is used. The default is BInary.
[-o]	CLRF | LF | NOEor	Specifies the end-of-record type for DAta files only.
[-o]	FIx | VAr	Specifies the record type: FIx for fixed record length files, VAr for files with variable record length. The default is STREAM.
[-o]	BYRec	Dispatches file(s) by record.
[-o]	EOF	Specifies platform defined EOF. Default is NONE. Ignored.
[-o]	ZDIR	Compresses the contents of a directory into a single file before queue insertion. The directory is specified in the filespec parameter.
[-o]	LEave	Original file is not moved; a link is stored in the repository.
[-o]	REMOve	Original file is copied into the repository and deleted from source.
[-o]	DELElocfile	Original file is not moved; a link is stored and the local file is deleted after transport completion.
[-o]	🚀 EXTernal	The file is written to the external destination specified in the -f parameter. This parameter is supported only for Virtual Paths that have a remote PR4 push action configured. To write the file on a file system external to the Data Mover Smart storage class, a rule using the Move to Filesystem action must be defined with Absolute path type set to Metadata and value ext-filename. See the Move to Filesystem page.
-O	MaxLen| RecLen	Specifies maximum or fixed record length (includes EOR for text files).
-x	Priority(num)	Specifies file priority.
-x	Description(string)	Specifies a description.
-x	CCSID(string)	Specifies original character set name or alias.
-x	ExpiryAfterPut(num)	Time (seconds) the file remains in the queue after put.
-x	ExpiryAfterGet(num)	Time (seconds) the file remains in the queue after first get.
-x	Language(ENG|ITA)	Specifies the language used for log output.
-x	🚀 EDestFType(SF)	Specifies the type of external destination file (-f option must be set also). SF for Sequential File.
-x	🚀 SFFrmt(F|FB|V|VB)	Mandatory for EDestFType(SF), it defines the file format as Fix or Block Fix or Variable or Block Variable.
-x	🚀 SFRLen(num)	Mandatory for EDestFType(SF), it defines the record length for Fix files and the max record length for Variable files.
-x	🚀 SFBSize	Mandatory for EDestFType(SF) in case of Block files. For Block Fix files BSize is a multiple of SFRLen. For Block Variable files, Bsize has to be greater than SFRLen + 4 (as first 4 bytes are used to store the following record length).
-x	🚀 SFSpace(KB|MB|GB|CYL|TRK|BLK)	Mandatory for EDestFType(SF).
-x	🚀 SFPSpace(num)	Mandatory for EDestFType(SF). Primary Space.
-x	🚀 SFSSpace(num)	Mandatory for EDestFType(SF). Secondary Space.
-x	🚀 SFDisp(REP|CRE|RNOC|REUSE)	Optional for EDestFType(SF). Disposition: values REPLACE or CREATE or REPLACE_NO_CREATE or REUSE.
-x	🚀 SFNDisp(CATL|UNCATL|KEEP|DEL)	Optional for EDestFType(SF). Normal disposition: values CATLG or UNCATLG or KEEP or DELETE.
-x	🚀 SFCDisp(CATL|UNCATL|KEEP|DEL)	Optional for EDestFType(SF). Conditional disposition: values CATLG or UNCATLG or KEEP or DELETE.
-x	🚀 SFSpaceAttr(RLSE|CONTIG|MXIG|ALX)	Optional for EDestFType(SF).
-x	🚀 SFSerNum(string)	Optional for EDestFType(SF).
-x	🚀 SFUnit(string)	Optional for EDestFType(SF).
-x	🚀 SFExpDate|SFRetPer(yyyyddd|dddd)	Optional for EDestFType(SF). Expiration date or retention period.
-v		Enables verbose output to standard output. Ignored.
-l	LogFileName	Writes log output to specified file (or default log file if omitted).

Option usage rules

• multiple -o and -x options can be specified

• options are processed cumulatively

• file handling options (LEave, REMove, DELElocFile) are mutually exclusive

• metadata options (-w, -c, -s, -n, -x) are associated with each dispatched file

Exit status

Code	Legacy code	Meaning
0	SP0000	Success
1	SP6001	Invalid number of arguments/incorrect usage
1	SP2085	Queue name does not exist
1	SP8002	Queue Manager does not exist
3	SP6301	Specified file not found or a directory has been provided, but ZDIR option is not specified