Skip to main content
Documentation
Documentation
Administrator Guide
Last Updated: 2023-06-23
Reference: FTP-Out Transport Properties

Reference: FTP-Out Transport Properties

Common Tab

Property
XML Attribute Name
Description
Id
id
The unique ID of the
ftp-out
 component within the assembly.
Routes Response To
routes-response-to
The destination of the response message for the
ftp-out
 transport.
Execute When
execute-when
A condition that determines whether the transport executes.
Endpoint
endpoint
Specifies the host (and optionally the port) and FTP directory to write files to.
Follows the format
ftp://FTP-directory
, where
FTP-directory
 is the target location.
Example:
ftp://ftpserver.example.org/outputDir
The directory location you specify must already exist on the FTP server.
Binary File
binary-file
Specifies whether the output files are transferred as binary.
Input File Pattern
input-file-pattern
A filename pattern for matching files of a particular type.
Example: specify
*.xls
 to pick up Excel files only.
Input Content Type
input-content-type
The media type that the runtime includes for the
content-type
 value in the message header. A media type comprises at least 2 parts: a type, a subtype, and 1 or more optional parameters. The
text
 subtype has an optional
charset
 parameter, which specifies the character encoding.
Example:
text/html; charset=UTF-8
This property is particularly useful in the case of non-XML text file formats where the media type and charset aren't explicitly stated in the file.
Output File Pattern
output-file-pattern
Specifies how the names of output files are generated. The pattern can contain literal strings as well as one or more of these tokens:
  • ${INFILE}
    , which is replaced with the name of the input file.
  • ${UUID}
    , which is replaced with a universally unique identifier.
  • ${EXT}
    , placed at the end of the pattern, which is replaced with a filename extension based on the content type of the data that's written to the assembly component's output.
Method
method
Specifies the transfer method:
  • put
    : writes files to the FTP endpoint that contains the remote directory.
  • list
    : lists all files and directories at the FTP endpoint. Use the
    Input File Pattern
     property with
    list
     to apply a pattern to the listing being returned. You can access the results of the
    list
     method using the MVEL
    ftp
     object. Example:
    ftp.list()
     returns a list of strings that contains the last listing retrieved.
  • get
    : retrieves the first file found to match the
    Input File Pattern
     property value.
  • delete
    : deletes the first file found to match the
    Input File Pattern
     property value.
    A file isn't automatically deleted from the FTP site after a
    get
     has been performed. If you wish to delete a file, you must invoke a separate method. Example: you can include a separate
    ftp-out
     transport specifically to delete the file.
Password
password
The password associated with the username used to access the FTP server.
Username
username
The username used to access the FTP server.

Advanced Tab

Property
XML Attribute Name
Description
Store Message
store-message
Specify
none
 unless otherwise advised by Workday Support.
To store messages, use Studio's
store
 step.
Transport Class
transport-class
Specifies an alternative implementation class on a per-assembly basis, if required.
You can globally change the implementation classes by editing the WEB-INF/classes/spring/assembly-bean.xml file.
Ignore Dynamic Endpoints
ignore-dynamic-endpoints
Specifies whether to ignore the dynamic WS-Addressing (WSA) value in the incoming message's header or use it to override the value in the transport's
Endpoint
 property.
Use the
set-dynamic-endpoint
 step to specify WS-Addressing details.
Passive Mode
passive-mode
Specifies whether the transport supports FTP in passive mode.
In passive mode, the FTP client initiates both connections required for the FTP transfer. The client contacts the server on the command port and issues the PASV command. The server then replies, indicating which port it's listening to for the data connection. The client then initiates the data connection from its data port to the specified server data port. Finally, the server sends back an ACK to the client's data port. In active mode, the client initiates the command connection and the server initiates the data connection.
Timeout
timeout
Specifies in milliseconds a timeout period for FTP sessions between clients and the FTP server on which the transport is listening.
If you don't specify a value, the session times out after 300000 ms (5 minutes).
Mime Types Map File
mime-types-map-file
The location of a map file for mapping between MIME types and file extensions. Use this property to:
  • Map MIME types to file extensions when the
    Method
     property is set to
    put
    .
  • Map file extensions to MIME types when the
    Method
     property is set to
    get
    .
The file for this mapping is
ccx/conf/mime.types
. You can provide your own version of this file.
This transport can generate filenames for its output files using a
${EXT}
 token placed at the end of the
output-file-pattern
 value.
Temp File Name
temp-file-name
Specifies a temporary filename. When the
Method
 property is set to
put
, the file uploads using this temporary filename. After the FTP completes, the file is renamed to the name specified by the
Output File Pattern
 property.
Close Connection
close-connection
Specifies whether disconnection occurs when the FTP action is complete.
Pool Size
pool-size
The maximum number of simultaneous connections and sessions that can be supported on a per-host basis for this component. If more than the specified number of threads attempt to connect to the same host, some are forced to wait for access to the pool.
To make the pool size unlimited, specify a negative number.
Debug
debug
Enables JSCAPE debug mode in the transport.