Flow definition: Source

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

Transfer properties

CG 

field

CG 

values

API

flow

CFTUTIL 

parameter

Description

Implicit send

See the Description Note to the right.

YES, NO

implicitSend

true, false

On source: CFTSEND, IMPL

 

Direction = Receiver pulls file > YES

 

Direction = Sender pushes file > NO

 

On relays: CFTSEND, IMPL

Yes > YES

No > NO

The implicit mode allows you to have a file continually available for partners to perform a pickup.

 

Note There is no field in the Central Governance UI for an implicit send in the source.

For a relay, the field is visible in the send properties when:

  • The relay is not a store and forward.
  • The direction between the relay and the target is “receiver pulls file”.
Transfer priority LOW,
MEDIUM,
HIGH,
CUSTOM

transferPriority

Integer 0 .. 255 customTransferPriorityEnabled TRUE, FALSE

CFTSEND, 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 ongoing transfer is finished, and a slot is available for a new transfer, the system selects the one with the highest priority.
Transfer priority is available when the source is the initiator.
Bandwidth allocation LOW,
MEDIUM, HIGH

bandwidth

LOW,

MEDIUM,

HIGH

CFTSEND, 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

CFTSEND, 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 source.
If target is the initiator, in source side the transfer state is ready and the field cannot be configured in the Central Governance UI.
User id string, max 32, empty by default userId

CFTSEND, 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.

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.

Detect duplicate transfers string max 512, empty by default detectDuplicateTransfers CFTSEND, duplicat This field is used in detecting duplicate transfers and may contain a list of symbolic variables separated by a period ".".
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.
On file modification Continue transfer,
Stop transfer

fileModificationDuringTransfer

SHR,

CHECK

CFTSEND , fdisp
Continue transfer > SHR
Stop transfer> CHECK
Available only in source side.
Specify what happens if files are modified during the transfer.
Action after transfer

Delete file,
Delete file content,

None,

Archive file

actionAfterTransfer

NONE,

DELETE,

ERASE,

ARCHIVE

CFTSEND, faction

Delete file > Delete
Delete file content > Erase

None> None (default)

Archive file >

Archive

Specifies what happens to the file in source side when the transfer is complete.

  • Delete file – Deletes the file.
  • Delete file content – Removes the contents of the file but leaves the "end of file" mark at the beginning of the file.
  • None – No action is performed on the file.
  • Archive file - Moves the file after the transfer completes.
Archive filename string max 512, empty by default ARCHIVE

CFTSEND, faction

 

Archive

Path to the location where you want to archive (move) the file after a transfer. You can use the &FROOT&(-.)FSUF syntax to preserve the original filename.

Delete file on purge Ready (D) ,
Transferring (C), On Hold (H),
Kept (K), Transferred (T), Executed (X)

fileDeletionOnPurge

D,

C,

H,

K,

T,

X

CFTSEND, 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.
Additional information string max 512, empty by default additionalInformation CFTSEND, parm Use this field for any information you want to provide.
Maximum transfer duration [0; 32767] maxDuration CFTSEND, MAXDURATION Zero (0) indicates a file transfer never times out.
Serialization phase Executed, None, Post-processing serializationPhase CFTSEND, SERIAL Executed > X None > ' ' Post-processing > Y
  • ' ': No serialization occurs
  • Executed: Done
  • Y: Post-processing
Activation period

Enable:

Yes , No

 

When enabled there are 4 fields:

Start date: <yyyy-mm-dd>

Start time: <hh:mm:ss>

End date: <yyyy-mm-dd>

End time: <hh:mm:ss>

enableActivationPeriod

NO, YES

Disabled:

MINDATE = '10000101',

MAXDATE = '99991231',

MINTIME = '00000000',

MAXTIME = '23595999',

Enabled:

MINDATE = <CG field value>,

MAXDATE = <CG field value>,

MINTIME = <CG field value>,

MAXTIME = <CG field value>

Defines the interval when transfers can occur by setting a start date and time and an end date and time.

  • Disabled (No): default values
  • Enabled (Yes): Uses the values defined in the CG fields
Start date   minDate CFTSEND, MINDATE

Example of the mapping: 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 CFTSEND, MINTIME

Example of the mapping: 3:12:11 --> CFT : 13121100 00:00:01 --> CFT : 00000100

MINTIME default 00:00:00

End date   maxDate CFTSEND, MAXDATE If a value is not specified, Transfer CFT uses 99991231.
End time   maxTime CFTSEND, 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.

PeSIT properties

CG field CG values

API

flow

CFTUTIL parameter Description

Compress file

Yes,
No
Protocols → properties → compression 15, 0 CFTSEND, ncomp

Yes → 15
No → 0
Indicates whether files are compressed before they are transferred.
Same value will be used for the compression on target side for the field CFTRECV, ncomp.

File properties > Filename

Indicates whether you are sending one or more files.

CG field

CG values

CG Flow API

CFTUTIL parameter

Description

Single - > Path

string max 512

sentFileName

CFTSEND, fname

Indicate the single file to be sent.

Multiple > Path

string max 512

Path

CFTSEND, fname

If you selected Multiple, the value you enter can be:
A directory name – All of the files in this directory are transferred.
A generic file name, including wildcard characters – Only files that match are transferred. For example, mydirectory/toto*.

Multiple > File list

string max 512

fileList

CFTSEND, selfname

This field is displayed if you selected Multiple in the Files field.
Specify the name of the file that contains the list of files to be transferred. This file is also referred to as an indirection file. It must contain one file name per record, and that name must start in the first column of the file. The file names contained in the file must not contain an asterisk (*).
When specifying a file here, the Path field is also required.

Multiple > Filter type

characters

max 255

  CFTSEND, filtertype

This field is displayed if you select Multiple in File properties > Filename > File. Specify the pattern matching algorithm type to use to filter the list of files to be transferred (None, Wildcard, Regular expression).

Selecting Wildcard or Regular expressions displays a filter field where you can enter the filter characters.

Multiple > Archive name

string max 512,
&IDF.&idtu.rcv

archiveName

CFTSEND, wfname

Name of the file that contains the set of files to be transmitted. Archive files are sent between systems that have the same operating system (grouped mode). The archive file is created automatically by Transfer CFT at the time of the transfer. The file created is a zip file on Windows systems, and a tar file on Linux/UNIX systems. Because Windows systems do not have default compression utilities, Transfer CFT for Windows includes zip and unzip utilities.

Working directory

string max 512

Workingdir

CFTSEND/WORKINGDIR

Indicates the path to the directory for sent files in process and temporary files.

File name sent

string max 512

physicalFile

CFTSEND, nfname

Specify the name of the physical file that is to be used during transmission over the network.

Storage account string max 32 storageAccount CFTSEND, STORAGEACCOUNT This parameter points to credentials configured in Transfer CFT (stored in the UCONF dictionary) to use to Amazon S3 services.

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 text mode.
  • See Source file properties for minor variations for the z/OS and IBM i platforms.
Encoding

CFTSEND, ncharset

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

If you select Custom, the Encoding charset field displays for you to enter the character set.

Transcoding CFTSEND, fcharset

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

If you select Custom, the Transcoding charset field displays for you to 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
Network file type CFTSEND, NTYPE Designates the file type (in protocol terms) for the receiving partner.

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.
Maximum record length CFTSEND Operating system limited record length. If you select Custom, enter the maximum record length in bytes (between 0 and 32767).
Network record type CFTSEND, NRECFM

File record format defined in protocol terms:

  • Autodetect (default)
  • Fixed
  • Variable
  • Undefined
Maximum network record length CFTSEND, NLRECL Truncates  the record of a sent file to this value if the record size exceeds this value.

Specific parameters > Configure specific parameters for each source

CG field CG values

CG Flow API

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

Processing > pre-processing

CG field CG values

CG Flow API

CFTUTIL parameter Description
Script > Filename Upload new file > script to upload
Use existing file > Filename field: string of max 512

For GUI Script=None

preProcessingFileName=””

preProcessingFileUsage=existing_file

preProcessingFileContent_button=Browse

preScript=none

preProcessingFileContent=””

 

For GUI Script=Custom

preProcessingFileName=existing_file_name preProcessingFileUsage=existing_file preProcessingFileContent_button=Browse preScript=none preProcessingFileContent=””

 

For GUI Script=Custom preProcessingFileName=uploaded_file_name preProcessingFileUsage=”upload_file” preProcessingFileContent_button=Browse preScript=custom preProcessingFileContent=file_b64_encoded

CFTSEND, preexec

Specify the script to be executed before the file is transferred.

  • 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 Ready,
On hold

preProcessingState

DISP,

HOLD

CFTSEND, prestate
Ready >DISP : default
On hold > HOLD
Indicate the status of the transfer on the source. The script is run only if the transfer is in the specified state.
Ready – Indicates that the transfer is available and can start immediately.
On hold – Indicates that the transfer is deferred until a remote receive request is accepted, or until a local START command changes this transfer to the ready state.
Apply to broadcast list On main request,
For each target in the list,
Both

preProcessingApplyToDistribList

DEST,

CHILDREN,

PART

CFTDEST, execpre

On main request > DEST For each target in the list > CHILDREN
Both > PART
This field is displayed if you enabled a broadcast list in source transfer properties.
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.
Execution policy

List

File

Subf

execsubpre CFTSSEND, execsubpre

Defines the execution policy for a pre-processing script, and determines how the transfer requests are treated, and the order in which this occurs.

  • LIST: (default) Triggers the pre-processing procedure first on the generic request, before launching the requests on the list
  • FILE: Triggers the pre-processing procedure for each request in the list as well as for the generic request
  • SUBF: Triggers the pre-processing procedure for each request in the list, except the generic request

Processing > post-processing

CG field CG values

API 

flow

CFTUTIL parameter Description
Script > Filename Upload new file > script to upload
Use existing file > 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

CFTSEND, exec

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

  • 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 configure multiple files 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 broadcast list On main request,
For each target in the list,
Both

postProcessingApplyToDistribList

DEST,

CHILDREN,

PART

CFTDEST, exec

On main request > DEST For each target in the list > CHILDREN
Both > PART
This field is displayed if you configure multiple files in source transfer properties.
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.

Processing > acknowledgment

CG field CG values

API

flow

CFTUTIL parameter Description
Script > Filename Upload new file > script to upload
Use existing file > 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

CFTSEND, ackexec

Specify the script to be executed after an acknowledgement is received for a sent file.

  • 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

CFTSEND, 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 acknowledgment is not received.
Apply to group of files On main request,
For each file in group,
Both

acknowledgementApplyToGroup

LIST,

SUBF,

FILE

CFTSEND, execsub
On main request -> LIST
For each file in group -> SUBF
Both -> FILE
This field is displayed if you configure multiple files 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 broadcast list On main request,
For each target in the list,
Both

acknowledgementApplyToDistribList

DEST,

CHILDREN,

PART

CFTDEST, execa

On main request > DEST For each target in the list > CHILDREN
Both > PART
This field is displayed if you enabled a broadcast list in source transfer properties.
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.

Processing > error

CG field CG values

API

flow

CFTUTIL parameter Description
Script > Filename Upload new file > script to upload
Use existing file > 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

CFTSEND, exece

Specify the script to be executed after an error occurs during a transfer.

  • 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