/n software Connectors for MuleSoft

Questions / Feedback?

OFTP Connector

Properties   Configuration Settings  

The OFTP Connector adds OFTP send and receive capabilities to your MuleSoft.

Remarks

The OFTP, or Odette File Transfer Protocol, Connector adds a complete OFTP client to your Mule Project that enables it with file download and upload capability.

OFTP Receive Connector

The OFTP Receive Connector requires certain server properties be set. You must set the OFTPServer property to the remote location of the desired OFTP server. You may also set an OFTPPort if the server is not set to the default protocol port. For client authorization, you must set the ClientSSIDCode, ClientSFIDCode, and ClientPassword properties. And, for server authentication, you must set the ServerSSIDCode, ServerSFIDCode, and ServerPassword properties.

If you want to use secure authentication with encryption to and from the server, set SecureAuthentication to True, set the Certificate property to a certificate containing your private key, and set the RecipientCert property to the server's public certificate.

The connector will connect to the OFTP server and download all files in the server's outgoing queue, and submit these to the Mule Project as individual messages.

Download Files Example

Drag and drop the OFTP Receive Connector into the source position of a flow. If you want to download from a server using OFTP version 1.2 without encryption, most of the settings can be left at their defaults.

To configure the connection, set the ClientSSIDCode, ClientSFIDCode, and ClientPassword properties to your own information, and set the ServerSSIDCode, ServerSFIDCode, and ServerPassword properties to the server's information. Then set the OFTPServer and OFTPPort properties to the server's address.

When the connector is scheduled to run, it will connect to the server, download any available files, and submit each one to the flow as a message.

OFTP Send Connector

The OFTP Send Connector also requires certain server properties be set. You must set the OFTPServer property to the remote location of the desired OFTP server. You may also set an OFTPPort if the server is not set to the default protocol port. For client authorization, you must set the ClientSSIDCode, ClientSFIDCode, and ClientPassword properties. And, for server authentication, you must set the ServerSSIDCode, ServerSFIDCode, and ServerPassword properties.

If you want to use secure authentication with encryption to and from the server, set SecureAuthentication to True, set the Certificate property to a certificate containing your private key, and set the RecipientCert property to the server's public certificate.

The connector will connect to the OFTP server whenever it has a message to send and attempt to upload the file to the server. It uses the name specified by VirtualFileName when sending to the server. If set to a value containing an empty string, a temporary filename will be used.

Upload Files Example

Drag and drop the OFTP Send Connector into the flow. If you want to upload to a server using OFTP version 1.2 without encryption, most of the settings can be left at their defaults.

To configure the connection, set the ClientSSIDCode, ClientSFIDCode, and ClientPassword properties to your own information, and set the ServerSSIDCode, ServerSFIDCode, and ServerPassword properties to the server's information. Then set the OFTPServer and OFTPPort properties to the server's address.

Set VirtualFileName and VirtualFileDate to set the propertys of the uploaded file. By default, the VirtualFileName will be set to "#[attributes.filename], which would contain the local name of a file passed to the connector by a File connector

Receiver Property List


The following is the full list of the properties of the receiver connector with short descriptions. Click on the links for further details.

CertificateThe private key certificate.
ClientPasswordThe client's password.
ClientSFIDCodeClient's SFID code.
ClientSSIDCodeThe client's SSID code.
FirewallA set of properties related to firewall access.
LogFileThe file to write logging information to at runtime.
LogModeWhat information gets logged during connector execution.
LogTypeHow information gets logged during connector execution.
OFTPPortThe port for the OFTP service (default is 3305).
OFTPServerThe domain name or IP address of the OFTP server.
OtherDefines a set of configuration settings to be used by the connector.
ReceivedFileDateThe date of the remote file received by the OFTP connector.
ReceivedFileNameThe name of the remote file received by the OFTP connector.
ReceivedFileSizeThe size of the remote file received by the OFTP connector.
RecipientCertThe recipient certificate of the message.
RuntimeLicenseSpecifies the connector runtime license key.
SecureAuthenticationWhether or not the connector should perform secure odette authentication.
ServerPasswordThe server's password.
ServerSFIDCodeServer's SFID code.
ServerSSIDCodeThe server's SSID code.
SSLAcceptServerCertInstructs the connector to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to use for client authentication during the SSL handshake.
TempPathA temporary directory where data can be stored before the connector processes it.
TimeoutA timeout for the connector.
UseSSLUse SSL to access the OFTPServer .
VersionWhich version of the OFTP protocol the component is using.

Sender Property List


The following is the full list of the properties of the sender connector with short descriptions. Click on the links for further details.

CertificateThe private key certificate.
ClientPasswordThe client's password.
ClientSFIDCodeClient's SFID code.
ClientSSIDCodeThe client's SSID code.
CompressWhether or not to compress the outgoing file.
EncryptionAlgorithmThe encryption algorithm.
FirewallA set of properties related to firewall access.
LogFileThe file to write logging information to at runtime.
LogModeWhat information gets logged during connector execution.
LogTypeHow information gets logged during connector execution.
MaxRecordSizeThe maximum length of a given record.
OFTPPortThe port for the OFTP service (default is 3305).
OFTPServerThe domain name or IP address of the OFTP server.
OtherDefines a set of configuration settings to be used by the connector.
RecipientCertThe recipient certificate of the message.
RuntimeLicenseSpecifies the connector runtime license key.
SecureAuthenticationWhether or not the connector should perform secure odette authentication.
ServerPasswordThe server's password.
ServerSFIDCodeServer's SFID code.
ServerSSIDCodeThe server's SSID code.
SignedReceiptWhether or not to require signed receipts.
SSLAcceptServerCertInstructs the connector to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to use for client authentication during the SSL handshake.
TempPathA temporary directory where data can be stored before the connector processes it.
TimeoutA timeout for the connector.
UseSSLUse SSL to access the OFTPServer .
VersionWhich version of the OFTP protocol the component is using.
VirtualFileDateThe date/time stamp for the virtual file.
VirtualFileFormatThe structure of the outgoing file.
VirtualFileNameThe virtual file name.
VirtualFileSecurityLevelThe level of security for the outgoing file.

Configuration Settings


The following is a list of configuration settings for the connector with short descriptions. Click on the links for further details.

OverwriteTempFilesWhether to overwrite files in the directory specified by TempPath.
ReceivedFileNameFormatThe name format of received files.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLSecurityFlagsFlags that control certificate verification.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLSNamedGroupsThe supported (EC)DHE groups.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
TcpNoDelayWhether or not to delay when sending packets.
UseInternalSecurityAPITells the connector whether or not to use the system security libraries or an internal implementation.

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
/n software Connectors for MuleSoft - Version 20.0 [Build 7722]