Flow definition: Target

The following tables describe the fields and parameters available in flow definition, target side, in Central Governance and CFTUTIL.

Transfer properties

CG field CG values

API 

flow

CFTUTIL parameter Description
Transfer priority LOW,
MEDIUM,
HIGH,
CUSTOM

transferPriority

Integer 0 .. 255 customTransferPriorityEnabled TRUE,

FALSE

CFTRECV, pri

LOW >0
MEDIUM>128
HIGH> 255
CUSTOM> integer between 0...255

Transfer priorities are equivalent to integer values ranging from 0 (low) to 255 (high).

When Transfer CFT reaches the maximum number of transfers allowed, it queues transfers. When an incoming transfer is finished and a slot is available for a new transfer, the system selects the one with the highest priority.

Bandwidth allocation LOW,
MEDIUM, HIGH

bandwidth

LOW,

MEDIUM,

HIGH

CFTRECV, cos
LOW >3
MEDIUM>2
HIGH> 1

The amount of bandwidth allocated to this flow. The value you select determines the data transfer rate for this flow.

Transfer state Ready,
On hold,
Kept

transferState

DISP,

HOLD,

KEEP

CFTRECV, state

Ready (D) > DISP
On hold (H) >HOLD
Kept (K) >KEEP

Indicates the state of the transfer request: Ready, On Hold, Kept.
Field is available in UI only if the initiator is the target.

If the initiator is the source, on the target side the transfer state has the value Ready and the field cannot be configured in the Central Governance UI.

User id string, max 32, empty by default userId CFTRECV, userid Identifier of the transfer owner. If this parameter is not defined, its default value is the system userid of the Transfer CFT.
Sender User id string, max 32, empty by default idOfFileSender CFTSEND, suser Identifier of the user sending the file.
Receiver User id string, max 32, empty by default idOfFileReceiver CFTSEND, ruser Identifier of the user receiving the file.
Detect duplicate transfers string max 512, empty by default detectDuplicateTransfers CFTRECV, duplicat This field is used in detecting duplicate transfers and may contain a list of symbolic variables separated by a period ".".

Sending application

string, max 48 char sappl CFTSEND, sappl

Id of the application sending the file

If the character string is enclosed in double quotation marks (" "), the value is considered case-sensitive and used as is.

Receiving application

string, max 48 char rappl CFTRECV, rappl

Id of the application receiving the file.

If the character string is enclosed in double quotation marks (" "), the value is considered case-sensitive and used as is.

On file not found Abort transfer, Ignore transfer

fileNotFound

ABORT,

IGNORE

CFTSEND, filenotfound

Abort transfer > ABORT

Ignore transfer > IGNORE

Specify whether the flow fails if the file to transfer is not found.
No file exists Create,
Cancel

noFileExistsCreationRule

CREATE,

ABORT

CFTRECV, see Transfer CFT configuration for no file exists, file exists

Specifies the action taken if the received file does not already exist.
Create – The file is created.
Cancel – The transfer is refused.
File exists

Delete,
Cancel,
Overwrite, Overwrite only if empty,

Overwrite after receiving temporary file,

Retry renaming after receiving temporary file

 

fileExistsCreationRule DELETE,

ABORT,

OVERWRITE,

OVERWRITE_IF_EMPTY,

RENAME,

RETRYRENAME

 

CFTRECV, see Transfer CFT configuration for no file exists, file exists

Specifies the action taken if the received file exists.
Delete – The existing file is deleted.
Cancel – The transfer is refused.
Overwrite – The existing file is overwritten.
Overwrite only if empty – The existing file is overwritten only if it contains no data.

Overwrite after receiving temporary file - UNIX only: Existing file is overwritten after receiving the temporary file. The user who performs the transfer must have rights to rename the temporary file name into the file to overwrite.

Retry renaming after receiving temporary file - If no file exists, the file is created. If the file exists, after receiving the temporary file, multiple attempts are made to rename the temporary file with the file name.

Aborted transfer Keep,
Delete

abortedTransfer

KEEP,

DELETE

CFTRECV, rkerror Specifies the action taken if a transfer is terminated due to a file creation error on the target.
Keep – The transfer remains in the transfer list.
Delete – The transfer is removed from the transfer list.
Delete file on purge Ready (D) ,
Transferring (C), On Hold (H),
Kept (K), Transferred (T), Executed (X)

fileDeletionOnPurge

D,

C,

H,

K,

T,

X

CFTRECV, fdelete

Ready (D) >D
Transferring (C) > C
On Hold (H) > H
Kept (K) > K
Transferred (T) > T
Executed (X) > X
Indicates the transfer states of files that will be deleted when you remove the associated transfers from the transfer list or when you purge the transfer list. You can select any combination of statuses. If you do not select anything, files are not deleted even when the associated transfers are removed from the transfer list.
Ready – The transfer is available and can start immediately.
Transferring – The transfer is being executed.
On hold – The transfer was interrupted due to an error, such as a network failure, or by a user.
Kept – The transfer was suspended by Transfer CFT or by a user.
Transferred – The transfer was successfully completed.
Executed – The transfer was ended by an application or user.
Purge completed transfer Yes, No

purgeCompletedTransfer

YES,

NO

CFTSEND, delete Indicates whether a completed transfer is purged from the transfer list or kept.
Maximum transfer duration [0; 32767] maxDuration CFTRECV, MAXDURATION Zero (0) indicates a file transfer never times out.
Start date   minDate CFTRECV, MINDATE

Mapping example: 01 Apr 2014 --> CFT: 20140401 11 Jan 2017 --> CFT: 20170111

If the value is not indicated, Transfer CFT populates it with 10000101.

Start time   minTime CFTRECV, MINTIME

Mapping example: 3:12:11 --> CFT : 13121100 00:00:01 --> CFT : 00000100

MINTIME default 00:00:00

End date   maxDate CFTRECV, MAXDATE If a value is not specified, Transfer CFT uses 99991231.
End time   maxTime CFTRECV, MAXTIME MAXTIME default 23:59:59
Transfer steps reported

Default, All, First and last,

None

visibilityMessageLevel

DEFAULT,

ALL,

FIRST_AND_LAST,

NONE

CFTSEND, trk

Default > UNDEFINED

All > ALL

First and last > SUMMARY

None > NO

Specify the level of transfer process step details to send as events to the Sentinel service.

File properties > files

Indicates whether you are sending a single file or multiple files.

CG field CG values

API

flow

CFTUTIL‑parameter Description
Filename string max 512,
Default value: pub\&IDF.&IDTU.&FROOT.RCV
targetFileName CFTRECV, fname Specify the file name or full path name for the received file or files. This field is required if the initiator of the flow is the source. Default value: pub\&IDF.&IDTU.&FROOT.RCV
Temporary file string max 512 temporaryFile CFTRECV, wfname

Specify the name of the temporary file used during the transfer. When the transfer is complete, the temporary file is renamed using the name defined in the Filename field. If you do not specify a value, Transfer CFT directly creates the file with the name specified in the Filename field.

If the File exists parameter is set to Overwrite after receiving temporary file, Temporary file becomes required.

Working directory string max 512 workingDir CFTRECV/WORKINGDIR Indicates the path to the directory for received files in process and temporary files.
Receiving file size [0; 2147483647] receivingFileSize CFTRECV, FSPACE Specify the size allocation in kilobytes of the incoming file. If set to 0, Transfer CFT allocates space according to the file size specified by the sender at the protocol level. The parameter is available only for z/OS computers.
Storage account string max 32 storageAccount CFTRECV, STORAGEACCOUNT This parameter points to credentials configured in Transfer CFT (stored in the UCONF dictionary) to use to Amazon S3 services.

File properties > file type

Note The corresponding flow API parameter for Windows and Linux is fileType.
CG value CFTUTIL parameter Description
Binary CFTRECV, ftype=B, fcode=BINARY, fcharset="", ncharset="" Specify whether the file is a binary file.
Text

CFTRECV, see Transfer CFT configuration for FTYPE on Windows and Linux

Configuration for FTYPE=TEXT

Specify whether the file is a text file.

Stream text CFTSEND, ftype=J Specify whether the file is a text file sent in Stream CFT mode.

File properties > File encoding

Note The corresponding Transfer CFT flow API parameter is fileType.
CG field CFTUTIL parameter Description
File type
  • Binary: Specify whether the file is a binary file.
  • Text: Specify whether the file is a text file. An End of Record Character field displays when you select Text for Windows/Linux. See details.
  • Stream text: Specify whether the file is a text file sent in Stream CFT mode.
  • Autodetect (the following encoding/transcoding options do not display)
Note See Target transfer properties for minor variations for the z/OS and IBM i platforms.
Encoding CFTRECV, ncharset

Represents how the data in the file to be sent is encoded.

If you select Custom, the Encoding charset field is displayed where you can enter the character set.

Transcoding CFTRECV, fcharset

Represents how the data in the file is encoded while it is being sent to the target.

If you select Custom, the Transcoding field is displayed where you can enter the character set.

Translation table XLATE Indicates the translation table to use when receiving a file. Displays when:
  • File type = Text or Stream Text
  • Encoding = ASCII or EBCDIC
  • Transcoding = ASCII or EBCDIC

File properties > record format

CG value CFTUTIL parameter Description
Record type

CFTSEND, see Transfer CFT configuration for record format

Specify whether the records in the file are fixed or variable length. Selecting Autodetect automatically identifies the record type.
Padding character FPAD Specify the character to use to pad the record. This character is added to the end of the record until it reaches the maximum length as defined in the Maximum record length field. If you do not provide a value, the default character is a space.
Trimming character Specify the character to use to remove padding characters from the end of the record. For example, if the trimming character is a space and there are 5 spaces at the end of the record, all 5 spaces are removed. If you do not provide a value, the record is unchanged.
Maximum record length FLRECL If you select Default OS value, Transfer CFT interprets maximum record length as:
  • On Windows, 512 characters
  • On Linux or UNIX, 512 characters for text files; 4096 characters for binary files
If you select Custom, enter a value in the provided field.
File attributes check FCHECK Enables you to reject an incoming transfer if local file attributes do not match the virtual file attributes.
  • NO (default value) - Transfer CFT behavior is unchanged, and no check is performed.
  • YES - A record check is performed.

Specific parameters > Configure specific parameters for each target

CG field CG values

CG Flow API

CFTUTIL parameter Description
Configure specific parameters for each target Yes/No enableCustomProperties true, false No mapping  

Processing scripts > post-processing

CG field CG values

API

flow

CFTUTIL parameter Description
Script > Filename if Custom, Filename field: string of max 512c

For GUI Script=None

postProcessingFileName=””

postProcessingFileUsage=existing_file

postProcessingFileContent_button=Browse postScript=none postProcessingFileContent=””

 

For GUI Script=Custom postProcessingFileName=existing_file_name

postProcessingFileUsage=existing_file

postProcessingFileContent_button=Browse

postScript=none postProcessingFileContent=””

 

For GUI Script=Custom postProcessingFileName=uploaded_file_name postProcessingFileUsage=”upload_file” postProcessingFileContent_button=Browse postScript=custom

postProcessingFileContent=file_b64_encoded

CFTRECV, exec

Specify the script to be executed after the file is received.

  • z/OS: Filename length not to exceed 10 chars
  • IBM i: Filename name must contain the sequence of blocks 8 chars + "."
  • IBM i + z/OS: Upload only EBCDIC-encoded files. Upload of other files results in deployment failure.
Apply to group of files On main request,
For each file in group,
Both

postProcessingApplyToGroup

LIST,

SUBF,

FILE

CFTSEND, execsub
On main request -> LIST
For each file in group -> SUBF
Both -> FILE
This field is displayed if you enabled a broadcast list in source transfer properties.
Values – On main request | For each target in the list | Both
On main request – Executes the script only on the main request.
For each target in the list – Executes the script only for each target in the list.
Both – Executes the script both for the main request and for each target in the list.
Apply to collect list On main request,
For each source in the list,
Both

postProcessingApplyToDistribList

DEST,

CHILDREN,

PART

CFTDEST, exec

On main request > DEST

For each source in the list > CHILDREN

Both > PART

This field is displayed if you enabled a collect list in target transfer properties.
On main request – Executes the script only on the main request.
For each source in the list – Executes the script only for each source in the list.
Both – Executes the script both for the main request and for each source in the list.

Processing scripts > acknowledgment

CG field CG values

API 

flow

CFTUTIL parameter Description
Script > Filename if Custom, Filename field: string of max 512c

For GUI Script=None

acknowledgementFileName=”” acknowledgementFileUsage=existing_file acknowledgementFileContent_button=Browse acknowledgementScript=none acknowledgementFileContent=””

 

For GUI Script=Custom acknowledgementFileName=existing_file_name acknowledgementFileUsage=existing_file acknowledgementFileContent_button=Browse acknowledgementScript=none acknowledgementFileContent=””

 

For GUI Script=Custom acknowledgementFileName=uploaded_filename acknowledgementFileUsage=”upload_file” acknowledgementFileContent_button=Browse acknowledgementScript=custom acknowledgementFileContent=file_b64encoded

CFTRECV, ackexec

Specify the script to be executed after the file is received and post-processing is complete.

  • z/OS: Filename length not to exceed 10 chars
  • IBM i: Filename name must contain the sequence of blocks 8 chars + "."
  • IBM i + z/OS: Upload only EBCDIC-encoded files. Upload of other files results in deployment failure.
State Require,
Ignore

acknowledgementState

REQUIRE,

IGNORE

CFTRECV, ackstate
Require > REQUIRE
Ignore > IGNORE
Indicate if the transfer must wait for an acknowledgment.
Require – The transfer must wait for an acknowledgment before it can be considered complete.
Ignore – The transfer can be considered complete, even if an acknowledgement is not received.
Apply to collect list On main request,
For each source in the list,
Both

acknowledgementApplyToDistribList

DEST,

CHILDREN,

PART

CFTDEST, execa

On main request > DEST

For each source in the list > CHILDREN
Both > PART

This field is displayed if you enabled a collect list in target transfer properties.
On main request – Executes the script only on the main request.
For each source in the list – Executes the script only for each source in the list.
Both – Executes the script both for the main request and for each source in the list.

Processing scripts > error

CG field CG values

API

flow

CFTUTIL parameter Description
Script > Filename if Custom, Filename field: string of max 512c

For GUI Script=None

errorFileName=””

errorFileUsage=existing_file

errorFileContent_button=Browse

errorScript=none errorFileContent=””

 

For GUI Script=Custom

errorFileName=existing_file_name errorFileUsage=existing_file errorFileContent_button=Browse errorScript=none errorFileContent=””

 

For GUI Script=Custom errorFileName=uploaded_filename errorFileUsage=”upload_file”

errorFileContent_button=Browse errorScript=custom errorFileContent=file_b64encoded

CFTRECV, exece

Specify the script to be executed if an error occurs when a file is received.

  • z/OS: Filename length not to exceed 10 chars
  • IBM i: Filename name must contain the sequence of blocks 8 chars + "."
  • IBM i + z/OS: Upload only EBCDIC-encoded files. Upload of other files results in deployment failure.

Processing > exit task

CG field CG values

API

flow

CFTUTIL parameter Description
File exit STRING max_length=32 exit CFTEXIT, exit Defines the exit task script to execute. Value can contain alphanumeric characters and may include !#%&()*+-./\:;=?@ []^_{|}~<>$

 

Central Governance | Document Directory

Related Links