Use generic AS3 Hosts to specify an AS3 installation based on a specific AS3/FTP server product.
This includes the product's specific server choreography, or the commands needed to successfully log in to the remote server and send and receive files. The product choreography for each generic AS3 host was established during AS3 interoperability testing with the server products, and a generic host for all interoperability-certified AS3 products is included in the VersaLex installation. Since these hosts were created for a test environment, you might need to adjust some settings and commands to establish successful file transfers in a production environment. If it is available, use a pre-configured host specific to your trading partner's remote server. This makes for a faster and easier set up of your installation.
The AS3 standard provides the ability to securely transport EDI (and other data, including binary and XML) to a remote host over FTP, guaranteeing that the message has not been changed in-transit and has been received and can be read only by the intended trading partner. An Message Disposition Notification (MDN) receipt further guarantees that the intended trading partner has received the message.
AS3 uses the FTP protocol as its transport mechanism to send and receive files over the Internet. VersaLex uses the PUT/GET action commands to transport the secure data to/from the remote host.
AS3 Configuration
A host describes the remote server of your trading partner to which messages will be sent. The host's parameters specify its location and how it is reached. Your remote trading partner should have provided information to you in the form of a URL, which you will use to configure the host parameters.
This section describes how to configure a generic AS3 pre-configured host.
AS3 Host
The following sections describe how to configure any of the generic AS3 hosts. A host describes the remote server of your trading partner to which messages will be sent. The host's parameters specify its location and how it is reached.
AS3 Host: General Tab
The host General tab for an AS3 Host contains the fields described in detail below. The default values of these fields vary per generic or pre-configured host. For pre-configured hosts, the fields on the General tab typically remain unchanged unless you need to either connect through a forward proxy or change the Default Directories.
- Server Address
- Either a fully qualified name (recommended) or an IP address.
- Port
- The port on the server where your trading partner will receive your messages.
- Connection Type
- The kind of connection you want to use for this host.
- Forward Proxy
- The address of the forward proxy you want to use for this host.
- Default Directories
- Modify the default directories, if necessary. You can use macro variables from the drop-down lists. See Using Macro Variables for a list of the applicable macros (Default Host Directory context) and example usage. For Cleo VLTrader and Cleo Harmony, see URI File System interface overview for information about you can use a Cleo-provided or custom URI for the Inbox and Outbox. See Specifying default host directories for information about setting up system-level directories and custom directory macro variables.
Note: If the host is has an external association, the default directories might be managed outside of VersaLex and not shown here.
- Inbox
- Default directory for incoming files. Enter a value directly or click … to navigate to and select a directory.
- Outbox
- Default directory for outgoing files. Enter a value directly or click … to navigate to and select a directory.
- Sentbox
- If specified, default directory for retaining sent files. Files are a copy of the original source file; any file manipulations performed as part of the send are not reflected in the sentbox copies. Enter a value directly or click … to navigate to and select a directory.
- Receivedbox
- If specified, default directory for retaining received files. Files are a copy of the final destination file; any file manipulations performed as part of the receive are reflected in the receivedbox copies. Enter a value directly or click … to navigate to and select a directory.
AS3 Host: AS3 Tab
Use the AS3 tab to specify values for AS3-specific parameters.
- Overwrite duplicate file names
- Disabled for AS3.
- Use default file name
- Disabled for AS3.
- Add Content-Type Directory to Inbox
- Allows you to sort incoming messages based on content-type to a subdirectory under the Inbox specified on the Generaltab. Specify each of the Content-Types you want to direct to specific subdirectories by entering a name in the Directory field. You can specify directories for Content-Types of: EDIFACT, X12, XML, Binary, Plain Text, EDI Consent and Other (a default for messages with all other Content-Types you might receive). You can specify the same subdirectory for multiple Content-Types. You can also leave Directory entries blank, which causes any received messages of that Content-Type to be stored in the Inbox specified on the General tab.
For IBM i / iSeries (AS/400) usage, see AS/400 Setup and installation or AS/400 PC network access setup for information on configuring the Content-Type Inbox settings to access the Native File System (NFS).
Note: If you use this feature, incoming messages are placed in the specified folder based on the content type specified in the HTTP header of the message. VersaLex does not check the actual content of the message to determine its content type.
AS3 Host: FTP Tab
- Security Modes
- If the AS3/FTP server requires use of the Secure Socket Layer (SSL), select a security mode.
- Default Data Type
- The data type used when transferring files to and from the FTP server. The only valid Data Type for AS3 commands is Binary.
- Data Channel Mode
- The default behavior for opening data port connections between the AS3 client and AS3/FTP server.
- Active mode
- Client listens for an inbound connection from the server during data transfers. The Low Port / High Port, if left at 0/0, will be a random number between 1024-65535; otherwise specify a specific range. Because this is active mode, this port range must be open inbound on your firewall.
- Passive mode
- Server listens for an outbound connection from the client during data transfers. The server indicates the IP address and port number. The AS3/FTP server will cycle through port numbers, usually a subset of 1024-65535. Substitute Passive IP Address indicates that VersaLex should ignore the IP address specified by the server and reuse the command port address instead. This might be necessary if the server is advertising an internal rather than an external IP address.
AS3 Host: Advanced Tab
The host's Advanced tab contains several property settings fields. These settings typically do not affect the ability to connect to a host. However, you might want to change some of these settings when configuring a runtime environment.
See Setting advanced host properties for information about how to use and set the properties supported in all protocols. Properties available for AS3 include:
- Abort In Process Transfers
- Indicates that the FTP server supports the ABORT command when a data transfer is interrupted.
- Add Mailbox Alias Directory to Inbox
- Appends a subdirectory at the end of the host's configured inbox directory. This allows files received through different mailboxes to be kept separate.
- Add Mailbox Alias Directory to Outbox
- Appends a subdirectory at the end of the host's configured outbox directory. This allows files to be sent through different mailboxes to be kept separate.
- Add Mailbox Alias Directory to Receivedbox
- Appends a subdirectory at the end of the host's configured receivedbox directory. This allows files that have been sent through different mailboxes to be kept separate.
- Add Mailbox Alias Directory to Sentbox
- Appends a subdirectory at the end of the host's configured sentbox directory. This allows files that have been sent through different mailboxes to be kept separate.
- Allow Actions To Run Concurrently
- Normally, actions and host actions within the same host are allowed to run concurrently. You can use this property to not allow actions and host actions to run concurrently.
Note: This is a Cleo Harmony and Cleo VLTrader option.
- Allow Duplicate Incoming Message IDs
- Ignores messages with duplicate message IDs and allows reprocessing of the message.
- Avoid List Command When Space In Path
- When using the retrieving nested subdirectories (GET –REC option) and any of the nested subdirectories have spaces, indicates that the FTP server does not properly handle spaces in the LIST command path and that CDs should be used to avoid the issue.
- Base64 Encode Content
- Base64 is the encoding format used by Multi-purpose Internet Mail Extension (MIME) for transmitting non-text material over text-only communications channels. Base64 is based on a 64-character subset of US-ASCII, enabling 6 bits to be represented per printable character.
- Canonicalize Inbound Signed Content
- When this option is selected, a canonicalizer is used to ensure that ‘\r’ and ‘\n’ characters always occur together as ‘\r\n’. This option may be used when the inbound signature hash verification fails and the trading partner is using OpenSSL to sign its messages.
- Command Retries
- If an error or exception occurs during a command, the number of times the command should be retried.
Note: Command Retries does not apply to exceptions related to TCP/IP or ISDN dial-up connections. This is because dial-up connections are managed by the framework so that they can be shared across actions.
- Compression- Signing Order
- When both signing and compression are enabled, indicates which is applied first.
- Connection Keep Alive Timeout (seconds)
- Allows the connection to the server to remain open while the message is being processed by sending NOOP commands every nseconds. This setting may be lowered if the connection to the server is being closed before the message can be fully processed.
- Connection Timeout
- The amount of time allowed for each read operation.
- Data Socket Accept Timeout
- The amount of time allowed for each read operation on the data port.
- Delete Zero Length Files
- Indicates whether files received that are zero-length (<= 5 bytes) should be deleted rather than processed.
- Disable Address Resolution
- Indicates to connect directly to an IP address if the IP address is known and a DNS lookup is not desired.
- Do Not Send Zero Length Files
- Indicates whether zero length files to be sent to the server should be ignored rather than processed. If the
-DELoption is being used, any zero length file ignored will also be deleted. - Email On Check Conditions Met
- Send an email notification after running a CHECK command where the overall conditions of the check are met. See Configuring email or execute based on results.
Note: This is a Cleo Harmony and Cleo VLTrader option.
- Email On Check Conditions Not Met
- Send an email notification after running a CHECK command where the overall conditions of the check are not met. See Configuring email or execute based on results.
Note: This is a Cleo Harmony and Cleo VLTrader option.
- Email On Fail
- If an error occurs during a command, email the error condition. See Configuring email or execute based on results.
- Email On Flag
- If a flagged event occurs, email the event. See Configuring email or execute based on results.
- Email On Repetitive Action Failures
- When "Email On Fail" is enabled and the same failure occurs each time an action is run for a specific host, leaving this option unchecked suppresses emailing of the same alert multiple times. If the same email alert continues to be suppressed after 24 hours, the suppressed email alert will be sent every 24 hours and after every system restart if the failure occurs again. When the failure is resolved an email alert will be sent.
Note: This feature only suppresses multiple emails if the same failure occurs multiple times in a row. Suppression is not maintained across synchronized hosts.
- Email On Successful Copy
- Send an email notification after copying a file using LCOPY. See Configuring email or execute based on results.
- Email On Successful Receive
- Send an email notification after successfully receiving a file. See Configuring email or execute based on results.
- Email On Successful Send
- Send an email notification after successfully sending a file. See Configuring email or execute based on results.
- Execute On Check Conditions Met
- After executing a CHECK command where the overall conditions are met, run a system command. See Configuring email or execute based on results.
Note: This is a Cleo Harmony and Cleo VLTrader option.Note: Note that if multiple files contribute to the conditions being met, and one of the file macros is in the command (e.g., %file%), the system command will be executed repeatedly - once for each file.
- Execute On Check Conditions Not Met
- After executing a CHECK command where the overall conditions are not met, run a system command. See Configuring email or execute based on results.
Note: This is a Cleo Harmony and Cleo VLTrader option.
- Execute On Fail
- If an error occurs during a command, run a system command. See Configuring email or execute based on results.
- Execute On Repetitive Action Failures
-
When Execute On Fail is enabled and the same failure occurs each time an action is run for a specific host, leaving this option unchecked suppresses multiple executions of the Execute On Fail command. If suppression of execution of the command for this failure continues after 24 hours, the suppressed Execute On Fail command will be executed every 24 hours and after a system restart if the failure occurs again. When the failure is resolved, the Execute On Fail command will be executed again. Users must account for this by including the %status% macro variable for the Execute On Fail command (see Using macro variables) and then checking for a success or failure.
Note: This feature only suppresses multiple executions of the Execute On Fail command if the same failure occurs multiple times in a row. Suppression is not maintained across synchronized hosts. - Execute On Successful Copy
- After successfully copying a file using LCOPY, run a system command. This command may be used for post-processing the file. See Configuring email or execute based on results.
- Execute On Successful Receive
- After successfully receiving a file, run a system command. This command may be used for post-processing the file. See Configuring email or execute based on results.
- Execute On Successful Send
- After successfully sending a file, run a system command. This command may be used for post-processing the file. See Configuring email or execute based on results.
- Explicit SSL Command
- Indicates the AUTH command to be used when the Security Mode specified on the Host/FTP tab is “SSL Explicit”.
- Explicit SSL Post Command
- A command or set of commands to be issued after the Explicit SSL Command and login sequence. The PBSZ and PROTcommands (“PBSZ 0;PROT P”) are required by some servers regardless of the AUTH type used and are necessary for data channel protection (AUTH TLS or AUTH TLS-C).
- File List Parse Method
- The NLST commands on some FTP servers do not return a standard file list.
- Fixed Record EOL Characters
- End-of-line characters to be inserted and/or deleted.
- Fixed Record Incoming Delete EOL
- If Fixed Record EOL Characters has been specified and Fixed Record Length is greater than 0, indicates to look for and delete EOL characters while receiving a file.
Note: When using FTP ASCII mode, standard EOL characters may already be changing if transferring between Windows and Unix platforms.
- Fixed Record Incoming Insert EOL
- If Fixed Record EOL Characters has been specified and Fixed Record Length is greater than 0, indicates to insert EOL characters while receiving a file.
Fixed Record Incoming Delete EOL and Fixed Record Incoming Insert EOL are mutually exclusive properties.
- Fixed Record Length
- The fixed record length after which end-of-line characters need to be inserted and/or deleted.
- Fixed Record Outgoing Insert EOL
- If Fixed Record EOL Characters has been specified and Fixed Record Length is greater than 0, indicates to insert EOL characters while sending a file.
Note: When using FTP ASCII mode, standard EOL characters may already be changing if transferring between Windows and Unix platforms.
- Get Number of Files Limit
- Limits the number of files retrieved from a server directory listing by one GET command.
- High Priority
- Indicates whether incoming and/or outgoing transfers through the host should be treated as high priority. When both high priority and regular priority transfers are active, the high priority transfers get a larger portion of the available bandwidth. Go to to set the
High Priority Transfers Percentage Available Bandwidth(defaults to 75). See Other system options for more information. - Ignore Exception After Quit
- Indicates to ignore any I/O errors that occur when attempting to read the SMTP server response after issuing a QUIT command.
- Ignore Retrieve Error Code
- Indicates an FTP server response code (after an FTP RETR request) that should not be treated as an error condition. This property is useful when the absence of a file on the server is not considered an error.
CAUTION: If the server uses the same error code for multiple reasons, this property can potentially mask unknown error conditions.
- Include Failure In Subject Of Email
- When specified, the exception message will be included in the email that is generated on failure.
Note: If the exception message exceeds 256 characters, it will be truncated.
- Include Filename In Store Unique Command
- Indicates whether the FTP server expects a starting filename to be included when using the store unique option (PUT -UNI).
- Interim Retrieve
- Indicates to set result of any successfully retrieved file to Interim Success rather than Success. This would normally be used when transfer logging is being monitored by a backend system to allow coordination of any post processing of the received file that needs to occur prior to setting the transfer status to Success.
- Issue Command After Opening Data Connection
- Indicates to issue the retrieve, store, or list command until after the data port connection has been established rather than before.
- Keepalive Noop Command (seconds)
- Indicates the amount of time in-between issuing NOOP commands on the command port while a transfer is active on the data port. 0 indicates to not issue NOOPs.
- LCOPY Archive
- If specified, contains the directory for archiving LCOPY source files.
- Log Individual LCOPY Results To Transfer Logging
- When this option is enabled, a
<send>and<receive>result is logged to the transfer log for each file copied.Note: This is a Cleo Harmony and Cleo VLTrader option. - Macro Date Format
- Specifies the date format to be used when the
%date%macro is used. - Macro Time Format
- Specifies the time format to be used when the
%time%macro is used. - Maximum Incoming Transfer Rate (kbytes/s)
- Sets the maximum incoming transfer rate in Kbytes (1024 bytes) per second for each mailbox or host. The default value of
0does not limit the transfer rate. The Maximum Incoming Transfer Rate system setting might also limit the transfer rates. The system Maximum Incoming Transfer Rate value is used unless this setting is more restrictive. For simultaneous transfers, the number of active transfers also affects individual transfer rates. See Advanced system options. - Maximum Outgoing Transfer Rate (kbytes/s)
- Sets the maximum outgoing transfer rate in Kbytes (1024 bytes) per second for each mailbox or host. The default value of
0does not limit the transfer rate. The system setting might also limit the transfer rates. The system Maximum Outgoing Transfer Rate value is used unless this setting is more restrictive. For simultaneous transfers, the number of active transfers will also affect individual transfer rates. See Advanced system options for more information about Maximum Outgoing Transfer Rate. - Next File On Fail
- When a download fails, indicates whether a wildcarded GET should proceed to the next available file rather than terminate if the server is still connected.
- Only Retrieve First Available File
- Indicates a GET * should only retrieve the first available file from the server.
- Only Retrieve Last Available File
- Indicates a GET * should only retrieve the last available file from the server.
- Outbox Sort
- Controls the order in which multiple files are transferred for a PUT command. If
System Defaultis specified, the value set on the tab takes precedence. ForAlphabeticalordering, the file extensions are not used to determine the sorted order unless they are needed to make the filenames unique. - Outgoing Insert EOL Between Interchanges
- If
Fixed Record Outgoing Insert EOLis active, indicates to also insert EOL characters between EDI interchanges while sending the file. - Partner Email Address
- The email address of the trading partner for this trading relationship. When set, this address is automatically used to send your local profile information and/or certificates to your trading partner. See Emailing a profile to your trading partner.
- Password Automatic Update (days)
- If greater than zero and
Password Update Formathas been set, the number of days after which the software will generate and apply a new FTP password. - Password Update Format
- If supported by the server, the format of the PASS command value when changing a user's password. The server dictates the format.
- PGP Compression Algorithm
- Compression method used when OpenPGP packaging (with compression) is requested through the Mailbox Packaging tab. See Configuring mailbox packaging. If
System Defaultis specified, the value set on the tab is in effect. - PGP Encryption Algorithm
- Encryption method used when OpenPGP packaging (with encryption) is requested through the Mailbox Packaging tab. See Configuring mailbox packaging. If
System Defaultis specified, the value set on the tab takes precedence. - PGP Hash Algorithm
- Signing method used when OpenPGP packaging (with signing) is requested through the Configuring mailbox packaging. If
System Defaultis specified, the value set on the tab takes precedence. - PGP Integrity Check
- When OpenPGP encrypting (see Configuring mailbox packaging), include an integrity check on encrypted data. Can be disabled for compatibility with certain OpenPGP implementation.
- PGP Signature Verification
- Indicates whether or not signed inbound PGP messages should verified when inbound OpenPGP packaging is requested through the Mailbox Packaging tab. See Configuring mailbox packaging. In general, this property should be enabled.
- PGP V3 Signature
- Post Get Command
- Post Put Command
-
In an action, specify commands to be executed only after a successful GET or PUT as post-get or post-put commands, respectively. When using this property, use a SET command within the action before the GET or PUT command rather than the Advanced tab.
The Post Put Command can be set to QUIT, which allows a disconnect and reconnect between file uploads when necessary.
- Pre Get Command
- Pre Put Command
- In an action, specify commands to be executed before a GET or PUT as pre-get or pre-put commands, respectively. This has the benefit of keeping the log results relative to just GETs and PUTs (especially important for Cleo VLTrader and Cleo Harmony GETtransfer logging). In addition, for the PUT, it avoids connecting and logging into the server when there are no files to send. When using this property, use a SET command within the action before the GET or PUT command rather than the Advanced tab.
- Pre Put Change Directory
- For PUT commands whose destination contains a directory path, forces an explicit CWD request to the destination directory path prior to issuing the STORE request.
Some FTP servers treat directories as logical rather than physical directories, and require directories be set only through a
CWDrequest. - Pre Put Command For First File Only
- If a Pre Put Command is specified, indicates whether to execute them before each file being transferred by the PUT or only before the first file transfer.
- Resume Failed Transfers
- When selected and a transfer fails (and Command Retries > 0), attempt to resume the transfer on a retry. If OpenPGP is enabled on the packaging tab (see Configuring mailbox packaging), the entire file is transferred instead of resuming with a partial file. The server must support the
FEAT,SIZE, andREST STREAMextensions to FTP. For more information, visit http://tools.ietf.org/html/rfc3659. - Retain Temporary Inbound Message Files
-
Leaves any files that are used while processing inbound messages in the temp\ folder. The default action is to delete these files after processing has completed. These files may be helpful for problem diagnosis.
Note: These temporary files are retained for seven days. - Retrieve Directory Sort
- Used to control the order in which files are downloaded from the FTP server. Using this property does cause the LIST command rather than the NLST command to be used when VersaLex is determining the available file list – which might be a problem if the server responds with different lists (e.g. NLST only lists files not previously downloaded while LIST lists all files regardless). Windows and Unix/Linux FTP servers are supported.
- Retrieve Last Failed File First
- If a file download previously failed and you are attempting to GET a list of files again, this property indicates whether the previously failed file should be attempted first.
- Retry Delay
- The amount of time (in seconds) before a retry should be attempted.
- Reuse SSL Session
- Indicates the command port SSL session should be reused when possible for any subsequent data port SSL connections. This setting does not affect the reuse of command port SSL sessions.
- Reuse SSL Sessions Across Actions
- If selected, SSL sessions from previous connections to the same destination (address and port number) may be resumed to avoid costly negotiation. If unselected, only SSL sessions used in the current action to the same destination may be resumed. When unselected, a new SSL session is created for the initial command port connection.
- RSA-OAEP Key Algorithm Parameter
-
Represents the type of mask generation and hash generation functions that are applied when the RSAES-OAEP key algorithm is in use. See RFC4055 for a further description of the mask and hash generation functions.
- SSL Allow Legacy Renegotiation
- When selected, legacy renegotiation is allowed. If this property is not selected, the extension described in RFC5746 is used for renegotiation and the server must also support this extension. See RFC5746 for a description of the extension and the vulnerability it addresses.
- SSL Cipher
- Indicates a specific cipher to be used with the server for SSL key exchange, encryption, and hashing. If not set, the list of supported ciphers is presented to the server and the server picks one.
- SSL Maximum Protocol Version
- Specifies the maximum protocol version allowed. By default, this field is blank, designating that Cleo Harmony, Cleo VLTrader, or Cleo LexiCom will select the most recent version (currently TLS 1.2).
- SSL Minimum Encryption Key Size
- Specifies the minimum encryption key size allowed when selecting an SSL cipher. To prevent use of low- or medium-strength ciphers, change from the default value of
0to112,128, or256(depending on the requirement). Note that if this value is set too high, all ciphers are filtered out causing theNo suitable cipher suites are enabledexception to occur. - SSL Minimum Protocol Version
- Specifies the minimum protocol version allowed. SSL 3.0 is the default value for compatibility with servers that do not support the more recent TLS versions 1.0, 1.1, and 1.2.
- SSL Use Record Splitting
- Indicates whether to use 1/n-1 record splitting in CBC mode as a countermeasure against the Rizzo/Duong BEAST (Browser Exploit Against SSL/TLS) attack against the SSL 3.0 / TLS 1.0 protocol. Must be turned off if the SSL library on the other side of the connection does not support the feature.
- Store Raw Sent Message
- When this property is enabled, a copy of the outbound message is stored in the HTTP/sent directory.
- Terminate On Fail
- If an error occurs during a command, stop the action.
Note:
Regarding non-CHECK commands: When
Terminate On Failis on, if a command fails,Email On FailandExecute On Fail, if set, are processed, and then the action stops. WhenTerminate On Failis off, if a command fails,Email On FailandExecute On Fail, if set, are processed, and the action continues.Regarding CHECK commands:
Terminate On Failis only honored if theConditionsMetparameter is set and the result of the CHECK is classified asError. The CHECK command is only available in the Cleo Harmony and Cleo VLTrader applications. - Unzip Use Path
- Indicates whether or not zip entry paths should be used for LCOPY -UNZIP operations. When enabled, the entry's path is added to the destination path, unless the entry contains an absolute path. In this case, the absolute path is used in place of the destination path.
- Use Content Type For File Extension
- By default, inbound messages that do not specifically contain the name of the target file to be saved are stored using the value of the
Message-ID(of that message) with the .file extension. When this option is selected, inbound messages without a target file name specifier is stored using theMessage-IDand the appropriate file extension based on the Content-Type of the message. - Use EPRT and EPSV
- Indicates to use Extended Port (EPRT) and Extended Passive (EPSV) commands for IPv6-style network addressing. EPRT/EPSV is used regardless of this setting if the host address is or resolves to an IPv6-style address.
- Use External IP Address in PORT request
- Indicates for active (aka port) mode that the external rather than the local IP address should be included in data port requests to the FTP server.
- Use Folded Headers For Outbound Messages
- Enables or disables automatic line wrapping of HTTP headers exceeding 76 characters. By default headers are not folded since some non-Cleo product remote hosts using Microsoft Internet Information Server (IIS) cannot handle folded headers properly. Unless your host has been pre-configured to enable folded headers, leave this setting cleared!
- Use NLST
- During a
GET *command, indicates that VersaLex should use an NLST command rather than LIST when getting the list of files available for download. - Use SMIME Over FTP Headers
- Allows message compatibility with non-standard (pre-AS3) servers. When set, the AS3-To and AS3-From headers specified for that trading partner are translated to To and From headers before the message is sent.
- Wait For Execute On
- Indicates whether execution should wait for processing to complete within an Execute On Fail, Execute On Successful Copy,Execute On Successful Receive, or Execute On Successful Send command. Note that this option does not apply to native AS400 execution.
- XML Encryption Algorithm
- The method used to encrypt/decrypt files when XML Encryption packaging is requested through the Mailbox Packaging tab. See Configuring mailbox packaging . If
System Defaultis specified, the value set on the tab takes precedence. - Zip Comment
- Specifies the comment to be added to the zip archive file in LCOPY -ZIP operations.
- Zip Compression Level
- Controls the level of compression for LCOPY -ZIP operations. If
System Defaultis specified, the value set on the takes precedence - Zip Subdirectories Into Individual Zip Files
- Indicates whether or not subdirectories should be bundled for LCOPY –ZIP –REC operations. When enabled, each first-level subdirectory (and all of its descendents) will be bundled together into an individual zip file. The name of this zip file may optionally reflect the subdirectory name if an asterisk (
*) is placed in the destination path. Any files that are directly off the source root directory will not be copied.
AS3 Mailbox
Mailbox parameters allow you access to the remote host and define the security of files being sent.
You can use the AS3 mailbox wizard to configure your system for the most common setup. See Using the wizard to create a host or mailbox.
AS3 Mailbox: AS3 Tab
Select encryption and signing for sending messages and optional security for receiving messages. If an MDN receipt is required, you can also select the format and delivery method of that receipt.
- Request
- Specify the S/MIME format for messages to send to the remote host.
- Unsigned / unencrypted (neither Encrypted nor Signed selected)
- Signed (only Signed selected)
- Encrypted (only Encrypted selected)
- Signed / Encrypted (both Signed and Encrypted selected)
- Receipt
- Enables the MDN Receipt section. See MDN Receipt.
- Encryption Algorithm
- When Encrypted is selected, the Encryption Algorithm field is enabled and allows you to choose the encryption algorithm for the message to be sent to the remote host. The remote host must be able to decrypt the message using the algorithm you choose. For a non-VersaLex trading partner, it is important to verify that your trading partner can use the selected algorithm prior to sending an encrypted message. The default encryption method is TripleDES. See Cryptographic Services for more information on choosing an encryption algorithm.
- Key Algorithm
- When Encrypted is selected, the Key Algorithm field is enabled and allows you to choose the algorithm to encrypt the content encryption key with the public key of your trading partner’s encryption certificate. Your trading partner uses the private key of their encryption certificate to decrypt the content encryption key that is subsequently used to decrypt the content of the message.
- Signature Algorithm
- When Signed is selected, the Signature Algorithm is used to encrypt the hash value of the signature with the private key of your signing certificate. Your trading partner uses the public key of your signing certificate to decrypt the hash value of the signature that authenticates you as the sender of the message. When RSA is selected, the selected Hash/MIC Algorithm is used to determine the appropriate signature algorithm; for example, rsaEncryption, sha256WithRSAEncryption, sha384WithRSAEncryption orsha512WithRSAEncryption. If RSASSA-PSS is selected, the combination of the private key of your signing certificate and the hash algorithm is used in conjunction with the RSASSA-PSS algorithm to secure the signature.
- Hash/MIC Algorithm
- When Signed in the Request section is selected, the combination of the signature algorithm and the selected hash algorithm is used to secure the signature.
Note: If the RSASSA-PSS signature algorithm is used and the SHA-512 hash algorithm is selected, the strength of the signature algorithm of your signing certificate must be SHA256withRSA or better.
- Compress Content
- When Compress is selected, the message will be compressed using ZLIB compression. Compression is generally used for large files so that the message will conserve bandwidth and be transferred more efficiently and securely over the Internet.
- Inbound Message Security
- Indicates how inbound messages should be received.
- MDN Receipt
- Attributes of the Message Disposition Notification (MDN) receipt you requested.
AS3 Mailbox: Certificates Tab
Associate a trading partner's signing and encryption certificates with this AS3 mailbox and override the signing and encryption certificates defined in the Local Listener, if necessary.
You must acquire your trading partner's signing and encryption certificates and provide yours to your trading partner. See Acquiring your trading partner's signing and encryption certificates and Creating and providing your signing/encryption certificates.
- Trading Partner's Certificates
-
- Encryption Certificate
- The name of the file containing your Trading Partner's encryption certificate. Specify a value or click Browse to navigate to the file you want to select.
- Signing Certificate
- Select the check box to enable the field.
- Use encryption certificate
- Indicates that your trading partner uses the same certificate for signing and encryption, which is the general practice among most trading partners. When you select this check box, the Signing Certificate field is populated with the same certificate you selected in the Encryption Certificate field.
If the remote host is capable of receiving Certificate Exchange Messages (CEM) or you want to email your certificates to your trading partner, you can send your user and SSL certificates to the remote host by clicking Exchange Certificates.
- My Certificates
-
- Override Local Listener Certificates
- Enables fields where you specify signing and encryption certificates to use with this particular partner instead of the certificates you configured for the Local Listener. See Configuring certificates for Local Listener.
- Exchange Certificates
- Displays the Certificate Exchange dialog box, which allows you to send your user and SSL certificates to your trading partner. See Exchanging certificates with your trading partner.
- Signing Certificate Alias
- The name of the signing certificate registered with the VersaLex application through the Certificate Manager. The certificate must be the same as the one exchanged with your remote trading partners, unless you want to override it at the Mailbox level. See Local HTTP Users Configuration.
- Encryption Certificate Alias
- The certificate for decrypting your trading partner’s messages, if you have created or obtained a separate certificate.
- Use signing certificate
- Select this check box to use the same certificate for signing and decrypting your trading partner's messages. The Encryption Certificate Alias and Password are populated to match the Signing Certificate Alias and disabled.
- Exchange Certificates
- Invokes the Certificate Exchange dialog box. If you override the default the certificates, you must exchange these alternate certificates with your trading partner.
Overriding AS3 Local Listener Certificates
By default, the certificates you configured on the Certificates tab of the Local Listener panel will be the certificates used to sign messages sent to your trading partner and decrypt messages received from your trading partner. See Configuring certificates for Local Listener.
Use Override Local Listener Certificates to select alternate certificates for signing and decrypting messages with this particular trading partner. If you do override the default the certificates, don't forget to export and exchange these alternate certificates with your trading partner.
AS3 Mailbox: FTP Tab
- Login
-
- User Name
- Password
- FTP Account
- Credentials for authentication to the FTP server. Select No Password Required if there is no password required for authentication.
- Headers
-
- AS3-From
- AS3-To
- Enter the AS3-From and AS3-To names for this trading relationship.
Note: The values in the AS3-From and AS3-To fields are determined and agreed upon as part of initially setting up the trading relationship. These fields can be company-specific, such as DUNS number, or an agreed-upon identification string. The AS3-From / AS3-To combination is case-sensitive and must be unique across all hosts defined in your system because it is used to determine in which Inbox messages are stored when received from remote hosts.
- Subject
- Identifies the message and is returned in the human-readable section of an MDN, if requested.
- Content-Type
- Optional. The format of the message being sent. Used by the sending and receiving applications to properly assemble and parse the message. Choose from the following:
- EDIFACT
- X12
- XML
- Binary
- Plain Text
- EDI Consent
Note: If Content-Type is not specified or if multiple payloads are attached in the message, the Content-Type is detected based first on file content and then the file extension. Detectable types include application/edifact, application/edi-x12, application/edi-tradacoms, application/xml (text/xml), application/pdf, application/msword,application/x-msexcel, application/rtf, application/zip, image/bmp, image/gif, image/tiff, image/jpeg,text/plain, text/html, and video/mpg.
AS3 Mailbox: Security Tab
If a Security Mode is specified in the host's FTP tab, a remote host can issue client certificates. If so, import the client certificate using Certificate management and then specify or browse for the imported certificate's alias and password.
AS3 Action
An action's parameters define a repeatable transaction for your mailbox designated for the host system.
AS3 Action: Action Tab
Use the Action tab to configure commands within the action. See Composing an action. See also FTP Command Reference for further information.
Verifying Your AS3 Names
When configuring a client to exchange messages with a Cleo VLTrader or Cleo Harmony AS3 server, you can use the following SITE command to verify the client has correctly defined the AS3-To and AS3-From names. The command syntax is:
SITE VERIFY AS3-To: ‘your-AS3-To-name’, AS3-From: ‘your-AS3-From-name’If your AS3 names are properly configured, the server returns a positive response. Otherwise, a failure response is returned.
When using a VersaLex client, you can use the %as3.to% and %as3.from% macros in place of your-AS3-To-name and your-AS3-From-name, and so on.
SITE VERIFY AS3-To: %as3.to%, AS3-From: %as3.from%
AS3-Specific Directories
The following additional directories are created either during the AS3 installation or as needed by the application:
| Directory | Purpose |
|---|---|
|
lostandfound\ |
Default inbox where incoming data is deposited when the application cannot determine where to put it. |
|
AS3\ |
Location where raw (unprocessed) incoming and outgoing messages are stored. Incoming messages are located in the AS3\received directory and outgoing messages are located in the AS3\sent directory. These files can be helpful in diagnosing problems. Old files should be deleted or archived by the user, if necessary. The AS3\unsent directory contains raw header, data and message setup information files. These files are used if a message needs to be retransmitted, and are deleted automatically by the application once the message transfer has either completed successfully or has failed due to timeouts, exceptions, or the number of retries has been exhausted. The AS3\mdn directory contains subdirectories for received (and optionally sent) MDNs. This directory can be changed on the AS3 Service Panel. MDNs can be automatically archived by the application or manually archived by the user from the MDNs tab on the listener panel. Archived MDNs are stored inAS3\mdn\received\archive\mdn.zip or AS3\mdn\sent\archive\mdn.zip. The AS3\data directory contains an AS3msgs.txt file used by the application to determine the receipt of duplicate messages. Entries in this file are retained for the time interval configured on the AS3 Service panel . |
|
temp\ |
Temporary location where incoming messages can be stored while being processed by the application. By default, they are deleted automatically once the message has been completely processed; however, these files can be kept for problem diagnosis by using the Retain Temporary Inbound Message Files host-level Advanced property. These temporary files will automatically be deleted after 7 days. |
Comments
0 comments
Please sign in to leave a comment.