Reference: SFTP-Out Transport Properties
Common Tab
Property | XML Attribute Name | Description |
|---|---|---|
Id
| id
| The unique ID of the sftp-out component within the assembly. |
Routes Response To
| routes-response-to
| The destination of the response message for the sftp-out transport. |
Execute When
| execute-when
| Specifies 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 sftp://SFTP-directory , where SFTP-directory is the target location.Example: sftp://sftpserver.example.org/outputDir The directory location you specify must already exist on the server. |
Dual Authentication
| dual-authentication
| Specifies whether to enforce dual authentication with both a username/password combination and a private key. The default value is false , which means that a user can authenticate with either a private key or a username/password combination, but not both.
If the property is set to false and a user enters a private key (by configuring the private key properties of the sftp-out component), then the authentication automatically uses that key value and the username, ignoring the password field. If the property is set to false and no private key is configured then the authentication uses the username/password combination.If the property is set to true then the authentication uses both the private key value and username/password combination. |
Host Key Fingerprint
| host-key-fingerprint
| The encryption key that the FTP server will use for SSH communications. |
Username
| username
| The username used to access the FTP server. |
Password
| password
| The password associated with the username used to access the FTP server. |
Binary File
| binary-file
| Specifies whether the output files are transferred as binary. |
Explicit SSL
| explicit-ssl
| Connection type: explicit SSL (AUTH TLS) or implicit SSL (AUTH SSL). Set to true to use explicit SSL. |
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:
|
Method
| method
| Specifies the transfer method:
|
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. |
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
| Specifies the location of a map file for mapping between MIME types and file extensions. Use this property to:
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. |