AS3 Connectors support sending and receiving files via the AS3 protocol.
Each AS3 Connector is configured to exchange files with a single AS3 trading partner. AS3 Connectors use the FTP protocol to transfer files, and add security and verification through digital encryption and signatures. Configuring an AS3 trading relationship requires exchanging AS3-specific profile details, such as AS3 identifiers and digital certificates, and the connection details for the target FTP server.
This section contains all of the configurable connector properties.
Trading Partner Info
Settings for identifying and connecting to a specific AS3 trading partner.
- Connector Id The static, unique identifier for the connector.
- Connector Type Displays the connector name and a description of what it does.
- Connector Description An optional field to provide a free-form description of the connector and its role in the flow.
- AS3 Identifier The AS3 identifier specific to the target trading partner.
Settings that identify the local AS3 profile.
- Local AS3 Identifier Your AS3 identifier.
- Private Certificate The certificate used to decrypt incoming messages and sign outgoing messages.
- Certificate Password The password required to access the local private certificate.
Settings related to connection parameters for the target FTP server.
- Host The hostname or IP address of the FTP server.
- Port The port on which to connect to the FTP server.
- User The username credential for logging in to the FTP server.
- Password The password credential for logging in to the FTP server.
- TLS Type How to negotiate TLS/SSL when connecting to the server. Choose Explicit to establish a plain text connection where TLS/SSL is then started with an explicit command. Choose Implicit to immediately negotiate TLS/SSL without establishing a plain text connection.
- Send Message Security Whether to sign and/or encrypt outgoing AS3 messages. CData strongly recommends you use signatures and encryption.
- Receive Message Security Whether to require that signatures and encryption are present for incoming AS3 messages. An error is thrown if a received message does not have a required security parameter.
- Compression Whether to compress the payload of outgoing messages.
- Connection Timeout The length of time (in seconds) the connector waits for a connection response before throwing a timeout error.
Settings related to requesting MDNs when sending AS3 messages.
- Request MDN Receipt Whether an MDN receipt should be returned in response to outgoing AS3 messages. CData strongly recommends that you request MDN receipts.
- MDN Path The folder path on the server where the partner uploads MDN receipts.
- Security Whether the MDN receipt should include a signature block verifying the message integrity and identity of the recipient. Again, CData strongly recommends you use this option.
Settings related to how outgoing AS3 messages are uploaded.
- Remote Path The folder path on the remote FTP server where outgoing messages should be uploaded.
Settings related to how incoming AS3 messages are downloaded.
- Remote Path The folder path on the remote FTP server from which incoming messages should be downloaded.
- File Mask A glob pattern that determines which files within the Remote Path should be downloaded (for example, *.txt).
- Delete files Whether files should be deleted from the FTP server after they are successfully downloaded.
Trading Partner Certificates
Settings related to the public certificates provided by the trading partner.
- Encryption Certificate The public key certificate used for AS3 encryption when sending messages. This certificate must be paired with the trading partner’s private certificate, and the trading partner should provide a public key certificate when sharing AS3 configuration details.
- Verification Certificate The public certificate used to verify AS3 signatures when receiving messages. This field is often unnecessary; most AS3 parties use the same private certificate for both signing and decrypting. If this field is not specified, the application uses the Encryption Certificate to verify signatures.
- TLS Server Certificate The public certificate used to verify the identity of an SSL/TLS server. This is only necessary if the FTP server requires FTPS (FTP over TLS/SSL). If the trading partner does not provide a TLS server certificate, you can leave this setting blank to allow the underlying OS/JVM to perform certificate validation, or it can be set to Any Certificate to unconditionally trust the target server’s identity.
Settings related to the automatic processing of files by the connector.
- Upload Whether files arriving at the connector should automatically be uploaded.
- Retry Interval The number of minutes before a failed upload is retried.
- Max Attempts The maximum number of times the connector processes the input file. Success is measured based on a successful server acknowledgement, and validation of the receipt (when requested synchronously). If you set this to 0, the connect retries the file indefinitely.
- Resend Interval The number of minutes before unacknowledged messages are resent. A resend is triggered when the server receives the file, but an asynchronous MDN receipt is not provided within the expected timeframe.
- Max Attempts (async) The maximum number of times the connector processes the input file when asynchronous receipts are requested. Success is based on the return of an asynchronous receipt within the Resend Interval after a successful server acknowledgement. If a successful server acknowledgement is not returned, Max Attempts is applied instead. If this is set to 0, the connector resends the file indefinitely.
- Download Whether the connector should automatically poll the remote download path(s) for files to download.
- Download Interval The interval between automatic download attempts.
- Minutes Past the Hour The minutes offset for an hourly schedule. Only applicable when the interval setting above is set to Hourly. For example, if this value is set to 5, the automation service downloads at 1:05, 2:05, 3:05, etc.
- Time The time of day that the attempt should occur. Only applicable when the interval setting above is set to Daily, Weekly, or Monthly.
- Day The day on which the attempt should occur. Only applicable when the interval setting above is set to Weekly or Monthly.
- Minutes The number of minutes to wait before attempting the download. Only applicable when the interval setting above is set to Minute.
- Cron Expression A five-position string representing a cron expression that determines when the attempt should occur. Only applicable when the interval setting above is set to Advanced.
Settings related to the allocation of resources to the connector.
- Max Workers The maximum number of worker threads consumed from the threadpool to process files on this connector. If set, this overrides the default setting on the Settings > Automation page.
- Max Files The maximum number of files sent by each thread assigned to the connector. If set, this overrides the default setting on the Settings > Automation page.
TLS Client Authentication
Settings related to client authentication when two-way SSL authentication is required.
- Use Profile Whether to use the Private Certificate configured on the Profiles page as the TLS certificate for client authentication.
- Private Certificate The private certificate presented during TLS client authentication. Only applicable if you are not using the same private certificate from the Profiles page.
- Certificate Password The password required to access the TLS client certificate.
These options allow you to execute custom commands on the remote server at various times during connector execution.
- After Connect Execute this command directly after connecting.
- After Get Execute this command after downloading each file.
- After Put Execute this command after uploading each file.
- Before Get Execute this command before downloading each file.
- Before Put Execute this command before uploading each file.
Note: During processing, the macros %SourceFilename% and %SourceFilenameNoExt% resolve to the name of the current file and the name of the current file without an extension.
Example: After downloading, you need to move each file from the download folder to a History subfolder. Use the After Get field to supply the
The available commands are described below:
onerror: Pass the
failargument to instruct the connector to treat errors that come from the custom scripts as errors for the overall transaction. Wthout
failthe connector logs any exceptions and continues processing.
cd: Change directory.
mkdir: Create directory.
move: Rename or move file.
rm: Delete or remove file.
rmdir: Remove directory.
These are a collection of settings that identify and authenticate to the proxy through which the AS3 connection should be routed. By default, this section uses the global settings on the Settings Page. Clear the checkbox to supply settings specific to your AS3 connector.
- Proxy Type The protocol used by a proxy-based firewall.
- Proxy Host The name or IP address of a proxy-based firewall.
- Proxy Port The TCP port for a proxy-based firewall.
- Proxy User The user name to use to authenticate with a proxy-based firewall.
- Proxy Password A password used to authenticate to a proxy-based firewall.
- Authentication Scheme Leave the default None or choose from one of the following authentication schemes: Basic, Digest, Proprietary, or NTLM.
Settings not included in the previous categories.
- Active Mode Whether to enable Active or Passive mode on the remote FTP server. Passive mode is less likely to result in firewall interference with the connection.
- Clear Command Channel Check this to send FTP commands using a cleartext channel instead of an encrypted channel.
- Clear Data Channel Check this to have the application use a clear data channel when communicating with the FTP server.
- Encryption Algorithm The algorithm to use when encrypting outgoing AS3 messages.
- EPSV Check this to use extended passive mode. This might be necessary if you need to use a protocol other than IPv4.
- Excluded Extensions A comma-delimited list of file extensions that should not be processed by the connector.
- FSwitch Used in conjunction with Simple Dir List. Check this to restrict the directory listing to files only.
- Local File Scheme A scheme for assigning filenames to messages that are output by the connector. You can use the following macros to reference contextual information:
%ConnectorId%, %Filename%, %FilenameNoExt%, %Ext%, %ShortDate%, %LongDate%, %RegexFilename%, %DateFormat%, %Header%.
For example: %FilenameNoExt%_%ShortDate%%Ext%
- Processing Delay The amount of time (in seconds) by which the processing of files placed in the Input folder is delayed. This is a legacy setting. Best practice is to use a File connector to manage local file systems instead of this setting.
- Prot for Implicit TLS Tells the server that the data channel is protected for implicit TLS connections. Select the TLS type on the Settings tab.
- Remote Host Address for Passive Only applicable when Active Mode is not set. Leave the blank to have the application parse the remote host to send replies from the previous server response. When this is checked, the application uses the value of the RemoteHost setting instead.
- Signature Algorithm The algorithm to use when signing outgoing messages. The same algorithm is requested for the corresponding MDN receipts.
- Simple Dir List Check this when you need a simple directory listing command for servers that send back long responses that cannot be parsed. After you set this, if the connector is still unable to parse the directory listing, add the FSwitch setting to restrict the directory listing to files only.
- TLS Enabled Protocols The list of TLS/SSL protocols supported when establishing outgoing connections. Best practice is to only use TLS protocols. Some obsolete operating systems do not support TLS 1.2.
Message settings determine how the connector searches for messages and manages them after processing. You can save messages to your Sent folder or you can group them based on a Sent folder scheme, as described below.
- Save to Sent Folder A toggle that instructs the connector to keep a copy of sent messages in the Sent folder.
- Sent Folder Scheme Instructs the connector to group files in the Sent folder according to the selected interval. For example, the Weekly option instructs the connector to create a new subfolder each week and store all sent files for the week in that folder. The blank setting instructs the connector to save all files directly in the Sent folder. For connectors that process many transactions, using subfolders can help keep files organized and improve performance.
Settings that govern the creation and storage of logs.
- Log Level The verbosity of logs generated by the connector. When you request support, set this to Debug.
- Log Subfolder Scheme Instructs the connector to group files in the Logs folder according to the selected interval. For example, the Weekly option instructs the connector to create a new subfolder each week and store all logs for the week in that folder. The blank setting tells the connector to save all logs directly in the Logs folder. For connectors that process many transactions, using subfolders helps keep logs organized and improves performance.
- Log Messages Check this to have the log entry for a processed file include a copy of the file itself. If you disable this, you might not be able to download a copy of the file from the Input or Output tabs.
Miscellaneous settings are for specific use cases.
- Other Settings Enables you to configure hidden connector settings in a semicolon-separated list (for example,
setting1=value1;setting2=value2). Normal connector use cases and functionality should not require the use of these settings.
Establishing a Connection
To connect to the remote FTP server, specify the Host, Port, User, Password, and TLS Type required by the server. Use the Test Connection button to verify that the connection parameters are correct.
Once connected, set the upload and download Remote Path so that files are placed in and read from the appropriate location to communicate with the trading partner.