Substitution variables for use with user-defined Connect:Direct processes
We can define values to substitute in to user-defined Connect:Direct processes by using intrinsic symbolic variables that are specific to Managed File Transfer.
To follow the Connect:Direct naming convention, all intrinsic symbolic variables used by Managed File Transfer have the format %FTE followed by five uppercase alphanumeric characters. For more information about intrinsic symbolic variables, see the Connect:Direct product documentation.
When creating a process to transfer files from a Connect:Direct node to the Connect:Direct bridge system, we must use the intrinsic variable %FTETFILE as the value of TO FILE in the Connect:Direct process. When creating a process to transfer files to a Connect:Direct node from the Connect:Direct bridge system, we must use the intrinsic variable %FTEFFILE as the value of FROM FILE in the Connect:Direct process. These variables contain the temporary file paths that the Connect:Direct bridge agent uses for transfers into and out of the Managed File Transfer network.
| Variable name | Description |
|---|---|
| %FTESAGNT | The name of the Managed File Transfer source agent. This variable is set only for transfers from a Managed File Transfer Agent to a Connect:Direct node. |
| %FTEDAGNT | The name of the Managed File Transfer destination agent. This variable is set only for transfers from a Connect:Direct node to a Managed File Transfer Agent. |
| %FTEPNODE | The Connect:Direct primary node name. The value is always the name of the Connect:Direct node that is part of the Connect:Direct bridge. |
| %FTEPPLAT | The platform that the Connect:Direct primary node runs on. Possible values for this variable are UNIX and WINDOWS. This information is provided by the Connect:Direct bridge agent. |
| %FTEPUSER | The Connect:Direct primary node user identifier to use in the Connect:Direct process. This information is taken from the ConnectDirectCredentials.xml file. |
| %FTEPPASS | The password to use with the user name defined by the %FTEPUSER variable. This information is taken from the ConnectDirectCredentials.xml file. |
| %FTESNODE | The Connect:Direct secondary node name. The value is always the name of the Connect:Direct node that the file is transferred to or from. |
| %FTESPLAT | The platform that the Connect:Direct secondary node runs on. Possible values for this variable are UNIX, WINDOWS, and ZOS. This information is taken from the ConnectDirectNodeProperties.xml file. |
| %FTESUSER | The Connect:Direct secondary node user identifier to use in the Connect:Direct process. This information is taken from the ConnectDirectCredentials.xml file. |
| %FTESPASS | The password to use with the user name defined by the %FTESUSER variable. This information is taken from the ConnectDirectCredentials.xml file. |
| %FTEFFILE | The source file name. This variable is set only for Connect:Direct processes that are submitted at a per-file
scope.
When transferring files from a Managed File Transfer Agent to a Connect:Direct node, the value is the fully qualified location of the file on the same system as the Connect:Direct bridge. When transferring files from a Connect:Direct node to a Managed File Transfer Agent, the value is the name of the file that is specified as the source file in the Managed File Transfer transfer request. |
| %FTEFDISP | The disposition of the source file when the process is complete. The value of
this variable is platform dependent and equivalent to the values for MFT transfer request. This variable is set only for
Connect:Direct processes that are submitted at a per-file
scope.
When transferring files from a Managed File Transfer Agent to a Connect:Direct node, the action of deleting or not deleting the source file is performed by the Managed File Transfer bridge agent. When transferring files from a Connect:Direct node to a Managed File Transfer Agent, the action of deleting or not deleting the source file must be performed by the Connect:Direct process. |
| %FTEFCP | The code page to use for the source file. This variable is set only for
Connect:Direct processes that are submitted at a per-file
scope.
When transferring files from a Managed File Transfer Agent to a Connect:Direct node, this value is UTF-8 or, if the transfer is a binary transfer, the value is not set. When transferring files from a Connect:Direct node to a Managed File Transfer Agent, this value is specified by Connect:Direct or, if the transfer is a binary transfer, the value is not set. |
| %FTEFSYSO | The Connect:Direct SYSOPTS for the source of the transfer. If the remote Connect:Direct node is on Linux, UNIX, or Windows, this value contains information about the code page and data type of the source of the transfer. If the remote node is on z/OS, this value contains additional information. |
| %FTEFNODE | Identifies the Connect:Direct node where the source file resides. This will be set to a value of either: PNODE or SNODE. |
| %FTETFILE | The destination file name. This variable is set only for Connect:Direct processes that are submitted at a per-file
scope.
When transferring files from a Managed File Transfer Agent to a Connect:Direct node, the value is the name of the file that is specified as the destination file in the Managed File Transfer transfer request. When transferring files from a Connect:Direct node to a Managed File Transfer Agent, the value is the fully qualified name of the location to write the file to on the same system as the Connect:Direct bridge. |
| %FTETDISP | The disposition of the destination file. The value of this variable is
platform dependent and equivalent to the values for Connect:Direct transfer request. This variable is set only for
Connect:Direct processes that are submitted at a per-file
scope.
When transferring files from a Managed File Transfer Agent to a Connect:Direct node, the action of creating a file or replacing an existing file must be performed by the Connect:Direct process. When transferring files from a Connect:Direct node to a Managed File Transfer Agent, the action of creating a file or replacing an existing file is performed by the Managed File Transfer bridge agent. |
| %FTETCP | The code page to use for the destination file. This variable is set only for
Connect:Direct processes that are submitted at a per-file
scope.
When transferring files from a Managed File Transfer Agent to a Connect:Direct node, this value is specified by Connect:Direct or, if the transfer is a binary transfer, the value is not set. When transferring files from a Connect:Direct node to a Managed File Transfer Agent, this value is UTF-8 or, if the transfer is a binary transfer, the value is not set. |
| %FTETSYSO | The Connect:Direct SYSOPTS for the destination of the transfer. If the remote Connect:Direct node is on UNIX, Connect:Direct, or Windows, this value contains information about the code page and data type of the destination of the transfer. If the remote node is on Windows, this value contains additional information. |
| %FTETNODE | Identifies the Connect:Direct node where the destination file is to reside. This will be set to a value of either: PNODE or SNODE. |
| %FTEDTYPE | The data type or mode of the transfer. Possible values for this variable are text or binary. This variable is set only for Connect:Direct processes that are submitted at a per-file scope. |
| %FTETRID | The 48-character hexadecimal transfer ID from the Managed File Transfer transfer. |
| %FTEJOBN | The job name from the Managed File Transfer transfer request. The value of this variable is truncated to 256 characters and can be used in the process accounting data. |
| %FTEPNAME | The Connect:Direct process name generated by the Managed File Transfer bridge agent. The value of this variable is 8 alphanumeric characters. The value always starts with an alphabetic character. |
| %FTEMETA(key) | A metadata from the Managed File Transfer transfer request. The value of key is the key of the metadata. The value of key is not case sensitive. A key of ABC is the treated the same as a key of abc. If both ABC and abc are defined as metadata keys, the value of the second metadata defined overwrites the value of the first metadata defined. |
| Variable name | Description |
|---|---|
| %FTEFDCB | The value of the DCB parameter at the source of the transfer. |
| %FTEFSPCE | The value of the SPACE parameter at the source of the transfer. |
| %FTEFLBEL | The value of the LABEL parameter at the source of the transfer. |
| %FTEFUNIT | The value of the UNIT parameter at the source of the transfer. |
| %FTEFVOL | The value of the VOL parameter at the source of the transfer. |
| %FTEFDACL | The value of the DATACLAS parameter at the source of the transfer. |
| %FTETDCB | The value of the DCB parameter at the destination of the transfer. |
| %FTETSPCE | The value of the SPACE parameter at the destination of the transfer. |
| %FTETLBEL | The value of the LABEL parameter at the destination of the transfer. |
| %FTETUNIT | The value of the UNIT parameter at the destination of the transfer. |
| %FTETVOL | The value of the VOL parameter at the destination of the transfer. |
| %FTETDACL | The value of the DATACLAS parameter at the destination of the transfer. |
| %FTETDSTY | The value of the DSNTYPE parameter at the destination of the transfer. |
| %FTETLIKE | The value of the LIKE parameter at the destination of the transfer. |
| %FTETMGCL | The value of the MGMTCLAS parameter at the destination of the transfer. |
| %FTETSTCL | The value of the STORCLAS parameter at the destination of the transfer. |