The RosettaNet Implementation Framework (RNIF) is the protocol for packaging, routing, and transferring RosettaNet XML documents.
Primarily targeting the supply chain area, manufacturing, product and material data and service processes are also addressed. Each interaction between two companies is defined by a Partner Interface Process (PIP) specification. A PIP is essentially the definition of an XML document to be exchanged with a partner and the rules of how the document is exchanged.
VersaLex RNIF supports:
- Sending and receiving v1.1 and v2.0 RNIF messages
- HTTP and HTTPs transports
- Single-action and two-action PIPs
- Synchronous and asynchronous acknowledgments
- DTD or schema validation
VersaLex RNIF does not support:
- Two-action synchronous responses
- Multi-hop/intermediaries
The following action commands are available with the VersaLex application:
Host commands | |
---|---|
PUT | Send one or more files to the host |
Local commands | |
---|---|
SYSTEM | Execute a local system command |
WAIT | Pause |
SET | Set a property |
CLEAR | Clear a string property |
LCOPY | Copy one or more local files |
LDELETE | Delete one or more local files |
LREPLACE | Replace bytes in one or more local files |
CHECK | Check for a transfer, file, or directory (Cleo VLTrader and Cleo Harmony applications only) |
SCRIPT | Execute a JavaScript File (Cleo VLTrader and Cleo Harmony applications only) |
Interfacing with VersaLex RNIF
Since each PIP is, in essence, a different document channel, a PIP code must be identified with each document to be sent and/or received. If a mailbox uses only one PIP and it is a single-action PIP, then the PIP can be automatically identified; otherwise, a PIP code must be associated with a document either via the PUT command or by using the VersaLex proprietary RosettaNet document wrapper as outlined below.
Outgoing Documents
Example wrapper for an outgoing request (single-action or two-action PIP):
<w:pip xmlns:w="http://www.cleo.com/protocols/RosettaNet/wrapper/1.0" pipCode="3A1" pipVersion="*">
<w:serviceContent>
...
PIP XML service content request document goes here
...
</w:serviceContent>
</w:pip>
Example wrapper for an outgoing response (two-action PIPs only):
<w:pip xmlns:w="http://www.cleo.com/protocols/RosettaNet/wrapper/1.0" pipCode="3A1" pipVersion="*"
pipInstanceId="1234567" actionType="response">
<w:serviceContent>
...
PIP XML service content response document goes here
...
</w:serviceContent>
</w:pip>
Element | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
<pip> | Required.
Root element.
|
||||||||||
<serviceContent> | Required.
PIP XML service content (payload). |
The service content can be specified three ways: as an XML fragment, text as part of a CDATA section, or as Base64 encoded data.
Content as XML Fragment
If the content does not have a DOCTYPE declaration (either no validation or schema validation), it can be included as an inline XML fragment:
...
<w:serviceContent>
<Pip3A1QuoteRequest>
...
</Pip3A1QuoteRequest>
</w:serviceContent>
...
Content as CDATA Section
If the content has DOCTYPE declaration, it must be wrapped in a CDATA section or encoded as Base64. The following is an example of CDATA wrapped content:
...
<w:serviceContent>
<![CDATA[
<!DOCTYPE Pip3A1QuoteRequest SYSTEM "3A1_MS_V02_00_QuoteRequest.dtd">
<Pip3A1QuoteRequest>
...
</Pip3A1QuoteRequest>
]]>
</w:serviceContent>
...
Content as Base64 Encoded Data
The content data can be encoded as Base64 data. If encoded, the attribute encoding="base64"
must be added to the <serviceContent> element.
...
<w:serviceContent encoding="base64">
[base64 content goes here]
</w:serviceContent>
...
Outgoing Documents with attachments
RNIF messages with attachments can be sent using the PUT command with the -MUL option. See RNIF Command Reference for details about using the -MUL option.
- each subfolder within the outbox is sent as one RNIF message with attachments.
- the file that starts with the name service-content_ is considered the payload. The rest of the files are attachments. If there is no file that stats with service-content_, no message is sent and an error is logged.
- if there is more than one file whose name starts with service-content_, an error is logged.
- in the generated MIME multipart message for the payload:
- the file name used for the payload strips off the service-content_ part of the name.
- the Content-ID of the header is the name of the attachment.
For example, assume you want to send RNIF messages with attachments and the outbox contains three folders with the following structure:
Three RNIF messages would be sent as follows:
- The RN with attachment folder contains three files: service-content_fileName 2s.xml is the payload. The other two files,test.edi and test – Copy.edi, are the attachments.
When the RNIF MIME multipart message is constructed the service-content_ part of the payload file name is stripped andfileName 2s.xml is used as the payload file name.
Note: If there are multiple files in the folder, only one file name should start with service-content_. - The RN without attachment folder contains only one file, which is the payload. This payload is sent without attachments.
- payload file.xml is directly under the source directory. This is sent as payload without attachments.
Incoming Documents
Incoming messages can be written in several formats. The raw content can be written as a stand-alone file or the content can be wrapped in XML as described in the previous section.
To control the format of the incoming message, use the Incoming Content Format menu and select Two-action only in the RNIF Host: RosettaNet tab. See RNIF Host: RosettaNet Tab. If Two-action only is selected, then all one-action PIPs will be written in the Original format and the two-action PIPs will follow the Incoming Content Format selection. If Two-action only is not selected, then both one-action and two-action PIPs follow the Incoming Content Format selection. If Original is selected in the Incoming Content Format pull-down menu, then the content is written in separate stand-alone files. If the pull-down selection is Wrapped XML, then the content is wrapped as specified in the previous section, with the content written as an inline XML fragment. If the selection is Wrapped CDATA, the content is saved as text within a CDATA section within the wrapper. If the selection is Wrapped BASE64, then the content is encoded as Base64 data. If the selection is MIME, the entire MIME payload is saved instead of the service content.
For a wrapped incoming message, the following attributes are added to the root <pip> element for your convenience:
Element | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
<pip> | Required.
Root element.
|
RNIF Configuration
Configure a RosettaNet host from scratch using the generic RNIF pre-configured host. Use this host only if Cleo does not have a pre-configured host for your connecting trading partner. See Cloning and activating a pre-configured host.
RNIF Host
A host's parameters specify its location and how it is reached.
RNIF Host: General Tab
Parameter | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Server Address | Either a fully qualified name (recommended) or an IP address for the HTTP host. | ||||||||||
Port | The HTTP command port. You can specify either a specific port number or -1 to indicate the default port for HTTP (80) or HTTP/s (443). | ||||||||||
Connection Type | The kind of connection you want to use for this host.
Possible values:
|
||||||||||
Forward Proxy | The address of the forward proxy you want to use for this host. Select the System Default check box to use the default proxy. See Configuring for a proxy for information about specifying a default proxy. |
||||||||||
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 the Cleo VLTrader and Cleo Harmony applications, see URI File System interface overview for information about you can use a Cleo-provided or custom URI for the Inbox and/or Outbox. See Specifying default host directories for information about setting up system-level directories and custom directory macro variables.
Note: If the host has an external association, the default directories might be managed outside of the application and not shown here.
|
RNIF Host: RosettaNet Tab
Parameter | Description |
---|---|
RNIF Version |
Indicates the version of RosettaNet to use for communications. Select v2.0 or v1.1. If you select v1.1, you have the option to enable CIDX, an XML-based standard used in the chemical industry. |
Outbound | Transmission protocol. Select HTTP to transmit over the standard HTTP protocol. Select HTTP/s to transmit using secure HTTPS protocol. If you select HTTP/s, you can select Check certificate server name to validate the name of the certificate as part of the secure transport. |
Inbound | Indicates whether your trading partner is required to use HTTP/s only for inbound file transfers. |
Resource Path | The address of the connecting RosettaNet server. If necessary, this value includes any URL parameters as well. |
Overwrite duplicate file names | Allows for unique naming of stored files. Select the check box to overwrite any files that exist in the specified Inbox. Clear the check box to append incoming files with the same name as one as an existing. Filenames are appended with a unique number beginning with 1 and incremented each time a new file is saved. |
Use default file name | Allows the incoming file to be given the name specified in its associated field. Use this option to override the file name specified by the sender. This feature is useful if the received file name must be something other than its original file name, and is common for iSeries (AS/400) platforms where the file name must be specified with a .mbr extension. You can use any of the supported macros, allowing for the incoming file to be named with a date-time stamp, for example. See Using macro variables (Destination File context) for information about applicable macros. |
Add PIP Directory to Inbox | Allows incoming messages to be sorted based on a PIP-code and PIP version number to a subdirectory (under the Inbox specified on the General tab). The subdirectory name is formatted as PIPcode_PIPVersion and is based on the incoming message. |
Incoming Content Format |
Indicates the format in which incoming documents are written. The options are
See Incoming Documents. |
Two-action only | Controls whether Incoming Content Format is used for two-action PIPs only or both one and two-action PIPs. See Incoming Documents. |
RNIF Host: Advanced Tab
See Setting advanced host properties for information about how to use and set the properties supported in all protocols. Properties available for RNIF include:
Parameter | Description |
---|---|
Add Authenticated Signer Attributes | Indicates for RNIF 1.1 whether ContentType , SigningTime , and MessageDigest authenticated attributes are added to the signature.
Possible values: |
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. Possible values: On or Off Default value: Off
|
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. Possible values: On or Off Default value: Off |
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. Possible values: On or Off Default value: Off
|
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. Possible values: On or Off Default value: Off
|
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. Possible values: On or Off Default value: On
|
Allow Missing Message Digest | When this property is enabled, the RNIF message digest is not required. Possible values: On or Off Default value: Off
|
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. Possible values: On or Off Default value: Off
|
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. Possible values: 0 - n Default value: 0 |
Connection Timeout |
The amount of time allowed for each read operation. 0 indicates no timeout |
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 -DEL option is being used, any zero length file ignored will also be deleted. Possible values: On or Off Default value: Off
|
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. Possible values: Email addresses separated by commas (,), semicolons (;), or colons ( : ). The first address should be an internal email address. Default value: The value specified for this property on the Options > Advanced panel (if set). |
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. Possible values: Email addresses separated by commas (,), semicolons (;), or colons ( : ). The first address should be an internal email address. Default value: The value specified for this property on the Options > Advanced panel (if set). |
Email On Fail | If an error occurs during a command, email the error condition. See Configuring email or execute based on results. Possible values: Email addresses separated by commas (,), semicolons (;), or colons ( : ). The first address should be an internal email address. Default value: The value specified for this property on the Options > Advanced panel (if set). |
Email On Flag | If a flagged event occurs, email the event. See Configuring email or execute based on results. Email addresses separated by commas (,), semicolons (;) or colons (:). The first address should be an internal email address. Possible values: Email addresses separated by commas (,), semicolons (;), or colons ( : ). The first address should be an internal email address. Default value: The value specified for this property on the Options > Advanced panel (if set). |
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. Possible values: On or Off Default value: On
|
Email On Successful Copy | Send an email notification after copying a file using LCOPY. See Configuring email or execute based on results. Possible values: Email addresses separated by commas (,), semicolons (;) or colons ( : ). The first address should be an internal email address. Default value: The value specified for this property on the Options > Advanced panel (if set). |
Email On Successful Receive | Send an email notification after successfully receiving a file. See Configuring email or execute based on results. Possible values: Email addresses separated by commas (,), semicolons (;) or colons ( : ). The first address should be an internal email address. Default value: The value specified for this property on the Options > Advanced panel (if set). |
Email On Successful Send | Send an email notification after successfully sending a file. See Configuring email or execute based on results. Possible values: Email addresses separated by commas (,), semicolons (;) or colons ( : ). The first address should be an internal email address. Default value: The value specified for this property on the Options > Advanced panel (if set). |
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. Possible values: System command to be executed. Default value: The value specified for this property on the Options > Advanced panel (if set). |
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. Possible values: System command to be executed. Default value: The value specified for this property on the Options > Advanced panel (if set). |
Execute On Fail | If an error occurs during a command, run a system command. See Configuring email or execute based on results. Possible values: System command to be executed. Default value: The value specified for this property on the Options > Advanced panel (if set). |
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. Possible values: System command to be executed. Default value: The value specified for this property on the Options > Advanced panel (if set). |
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. Possible values: System command to be executed. Default value: The value specified for this property on the Options > Advanced panel (if set). |
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. Possible values: System command to be executed. Default value: The value specified for this property on the Options > Advanced panel (if set). |
Fixed Record EOL Characters | End-of-line characters to be inserted and/or deleted. Possible values: 0 to n characters. Special character sequences:
|
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. Possible values: On or Off Default value: Off
|
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. Possible values: |
Fixed Record Length | The fixed record length after which end-of-line characters need to be inserted and/or deleted. Possible values: 0 - n Default value: 0 |
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. Possible values: On or Off Default value: Off
|
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 Configure > Options > Other to set the High Priority Transfers Percentage Available Bandwidth (defaults to 75). See Other system options for more information. Note: This is a Cleo Harmony and Cleo VLTrader option. Warning: If the trading partner’s bandwidth (and not Cleo Harmony's or Cleo VLTrader’s) is limiting the transfer rate, then setting High Priority will not increase the transfer rate and will only result in potentially slowing down other Cleo Harmony or Cleo VLTrader transfers. Also, do not attempt to set High Priority Incoming or Outgoing on a host where the same instance of Cleo Harmony or Cleo VLTrader is both the client and server (for example, a local looptest). Possible values:
|
Include Entire Certificate Chain in Signature | Indicates for RNIF 1.1 whether the entire certificate chain is sent in the signature. Possible values: On or Off Default value: On
|
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. Possible values: On or Off Default value: The value specified for this property on the Options > Advanced panel |
Include XML Declaration In Wrapped Data | Indicates whether the optional XML Declaration is included when the incoming content is being wrapped. Possible values: On or Off Default value: Off
|
LCOPY Archive | If specified, contains the directory for archiving LCOPY source files. Possible values: Any local or shared directory. Macros can be used. See Using macro variables (LCOPY Archive context). Default value: The value specified for this property on the Options > Advanced panel, if any. |
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. Possible values: On or Off Default value: Off
|
Macro Date Format | Specifies the date format to be used when the %date% macro is used. Possible values: See Using macro variables for information about usage and possible date/time formats. Default value: The value specified for this property on the Options > Advanced panel, if any. |
Macro Time Format | Specifies the time format to be used when the %time% macro is used. Possible values: See Using macro variables for information about usage and possible date/time formats. Default value: The value specified for this property on the Options > Advanced panel, if any. |
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 0 does 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. Possible values: 0 - n Default value: 0 |
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 0 does 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. Possible values: 0 - n Default value: 0 |
Outbox Sort | Controls the order in which multiple files are transferred for a PUT command. If System Default is specified, the value set on the Configure > Options > Advanced tab takes precedence. For Alphabetical ordering, the file extensions are not used to determine the sorted order unless they are needed to make the filenames unique. Possible values:
|
Outgoing Insert EOL Between Interchanges | If Fixed Record Outgoing Insert EOL is active, indicates to also insert EOL characters between EDI interchanges while sending the file. Possible values: On or Off Default value: Off
|
PGP Compression Algorithm | Compression method used when OpenPGP packaging (with compression) is requested through the Mailbox Packaging tab. See Configuring mailbox packaging. If System Default is specified, the value set on the Configure > Options > Advanced tab is in effect. Possible values:
|
PGP Encryption Algorithm | Encryption method used when OpenPGP packaging (with encryption) is requested through the Mailbox Packaging tab. See Configuring mailbox packaging. If System Default is specified, the value set on the Configure > Options > Advanced tab takes precedence. Possible values:
Default value: System Default |
PGP Hash Algorithm | Signing method used when OpenPGP packaging (with signing) is requested through the Configuring mailbox packaging. If System Default is specified, the value set on the Configure > Options > Advanced tab takes precedence. Possible values:
|
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. Possible values: On or Off Default value: On
|
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. Possible values: On or Off Default value: On
|
PGP V3 Signature Reset Connection After Timeout On Response | When enabled will cause an immediate reset on the socket (instead of a graceful close) when a SocketTimeoutException occurs. Possible values: On or Off Default value: On
|
Save Received Ack As Payload | Enable this property to copy the Received Ack into the Inbox and Receivedbox. |
Retry Delay | The amount of time (in seconds) before a retry should be attempted. Possible values: Any value greater than zero. Default value: 60 seconds
|
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. Possible values: On or Off Default value: On
|
Run In Test Mode | Used to enable test mode. If test mode is on, the Test setting is specified in the RosettaNet headers of outgoing messages. Possible values: On or Off Default value: On
|
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. Possible values: On or Off Default value: On
|
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. Possible values: Any cipher from the supported list. If the server does not also support the cipher, an SSL handshake error will occur. |
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). Possible values:
|
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 0 to 112 , 128 , or 256 (depending on the requirement). Note that if this value is set too high, all ciphers are filtered out causing the No suitable cipher suites are enabled exception to occur.Possible values: 0 - n bits Default value: 0
|
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. Possible values:
SSL 3.0
|
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. Possible values: On or Off Default value: On
|
Store Raw Sent Message | When this property is enabled, a copy of the outbound message is stored in the HTTP/sent directory. Possible values: On or Off Default value: Off
|
Terminate On Fail | If an error occurs during a command, stop the action. Note: Regarding non-CHECK commands: When Terminate On Fail is on, if a command fails, Email On Fail and Execute On Fail, if set, are processed, and then the action stops. When Terminate On Fail is off, if a command fails, Email On Fail and Execute On Fail, if set, are processed, and the action continues. Regarding CHECK commands: Terminate On Fail is only honored if the ConditionsMet parameter is set and the result of the CHECK is classified as Error. The CHECK command is only available in the Cleo Harmony and Cleo VLTrader applications. Possible values: On or Off Default value: On
|
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. Possible values: On or Off Default value: On
|
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. Possible values: On or Off Default value: On
|
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 Default is specified, the value set on the Configure > Options > Advanced tab takes precedence. Possible values:
System Default
|
Zip Comment | Specifies the comment to be added to the zip archive file in LCOPY -ZIP operations. Default value: The value specified for this property on the Options > Advanced panel, if set. |
Zip Compression Level | Controls the level of compression for LCOPY -ZIP operations. If System Default is specified, the value set on the Configure > Options > Advanced takes precedence Possible Values:
System Default
|
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. Possible values: On or Off Default value: On
|
RNIF Mailbox
A mailbox's parameters allow you access to the host system.
RNIF Mailbox: RosettaNet Tab
The mailbox RosettaNet tab provides the identification needed for interacting with your trading partner's RosettaNet service.
Parameter | Description | ||||
---|---|---|---|---|---|
Trading Partner Identification | Identifies your trading partner.
|
||||
My Identification | Allows you to override the default RosettaNet identifiers set in the Local Listener. | ||||
Override RosettaNet service | Enables the rest of the fields in the section. | ||||
Business Identifier | Your DUNS number or the agreed upon identifier. | ||||
Location Identifier | Your optional location to be sent in the RNIF headers |
RNIF Mailbox: PIPs Tab
Use the mailbox PIPs tab to activate and configure the Partner Interface Processes (PIPs) allowed for incoming and outgoing messages.
The Outgoing subtab is for VersaLex application-initiated PIPs and the Incoming subtab is for partner-initiated PIPs.
The Partner Interface Processes (PIPs) menu is populated with PIPs pre-defined for the system. The system can only send or receive those PIPs added to the Outgoing or Incoming lists, respectively.
- Click Add to add the selected PIP in the menu to the list. When a pre-defined PIP is added to the list, it is removed from the menu. Likewise, when a pre-defined PIP is removed from the main list, it is added back into the menu.
- Click New to define a new PIP, or one that is not in the list.
- The same PIP code with different versions is supported by the system. If a PIP of a specific version isn't specified, the first matching PIP is used. Right-click on the PIP list and select Move Up and Move Down to move the PIP up or down in the list respectively.
- Right click and select Remove to remove a PIP from the list.
- Right click and select Copy To to copy the PIP from outgoing to incoming or vice versa, or to another mailbox.
- Double-click the PIP entry in the list (or right-click and select Edit) to invoke the PIP Editor dialog box, where you can edit the rules governing a PIP. See PIP Editor.
PIP Editor
The PIP Editor is displayed when you double-click the PIP entry on the RNIF Mailbox PIP tab or right-click an entry and select Edit.
For pre-defined or newly-defined PIPs, any field can be updated. PIP specifications can be obtained from RosettaNet at http://www.rosettanet.org/Standards/RosettaNetStandards/PIPDirectory/tabid/476/Default.aspx . The values for the fields in these tabs can be obtained from these specifications.
General tab
Use the General tab to specify general naming information for the PIP.
Parameter | Description |
---|---|
PIP Code | The code that uniquely defines the PIP. |
PIP Version | The version of the PIP specification. Incoming and outgoing messages are mapped to the PIP code and version to determine the rules for processing the message. |
PIP Description | A user-friendly description of the PIP. This description is displayed in the PIP drop-down on the PIPs form. |
My Role | The initiator role. This value is found in the specification for the PIP. |
My Service | The initiator role's service. This value is found in the specification for the PIP. |
Partner Role | The message receiver's role. This value is found in the specification for the PIP. |
Partner Service | The receiver role's service. This value is found in the specification for the PIP. |
Time to Perform | The total time to perform a two-action PIP. This field is not used for single-action PIPs. The expected value is found in the specification for the PIP. This field should be of the format HH:MM:SS. |
Content tab
Use the Content tab to specify information related to sending and receiving general message parts.
Parameter | Description |
---|---|
Retries | Specify the number of times to attempt resending the request or response when sending a request or response (as applicable to two-action PIPs) results in an error or fails to receive an expected acknowledgment. |
Encryption | Specify whether no encryption is used (None), whether the service content and service content header are encrypted (Payload container), or just the service content (Payload only) is encrypted. For selections other than None, the encryption algorithm to be used is selected in the Encryption Method field. If an encryption option is selected for any of the PIPs, encryption certificates will need to be specified in the mailbox Certificates tab. See RNIF Mailbox: Certificates Tab. |
Signing | Select this check box to digitally sign messages. If Authorization Required is selected on any of the other tabs, you must select this option and sign the message. If you enable signing, the Signing Algorithm to be used can be selected and you must also specify signing certificates in the mailbox Certificates tab. See RNIF Mailbox: Certificates Tab. |
Synchronous Acks | Select this check box to receive synchronous rather than asynchronous acknowledgments to requests and responses. |
Request tab
Use the Request tab to define the rules for an incoming or outgoing message request.
Parameter | Description |
---|---|
Activity Id | The business activity name for the request. This value is found in the specification for the PIP. |
Service Action Identity | The action name for the request. This value is found in the specification for the PIP. |
Content Validation | Specify whether outgoing content (in the case of an outgoing message) or incoming content (in the case of an incoming message) is validated. Options are None, DTD, and Schema. If DTD or Schema is selected, it is expected that the DTD or schema reference are specified in the message content. Click Import to import a PIP DTD or schema file into the VersaLex application. |
Authorization Required | Select this check box to compare the signing certificate for the incoming message against the signing certificate specified in the mailbox. |
Non-repudiation Required | Select this check box to save the the original request message in the host General tab's Sentbox folder for outgoing and Receivedbox folder for incoming. See RNIF Host. |
Has Response | Select this check box if the PIP is a two-action PIP and will send a response. Clear the check box for single-action PIPs. |
Request Ack tab
Use the Request Ack tab to define the rules for a request acknowledgment.
Parameter | Description |
---|---|
Time to Acknowledge | The amount of time to wait for a request acknowledgment. If the time expires without an acknowledgment or exception, the original request is resent according to the retries rules. |
Authorization Required | Select this check box to compare the signing certificate for the incoming message against the signing certificate specified in the mailbox. |
Response tab
The Response tab defines the rules for a response message.
Parameter | Description |
---|---|
Activity Id | The business activity name for the request. This value is found in the specification for the PIP. |
Service Action Identity | The action name for the request. This value is found in the specification for the PIP. |
Content Validation | Specify whether outgoing content (in the case of an outgoing message) or incoming content (in the case of an incoming message) is validated. Options are None, DTD, and Schema. If DTD or Schema is selected, it is expected that the DTD or schema reference are specified in the message content. Click Import to import a PIP DTD or schema file into the VersaLex application. |
Authorization Required | Select this check box to compare the signing certificate for the incoming message against the signing certificate specified in the mailbox. |
Non-repudiation Required | Select this check box to save the original response message in the host General tab's Sentbox folder for outgoing and Receivedbox folder for incoming. See RNIF Host. |
Response Ack tab
Use the Response Ack tab to define the rules for response acknowledgment.
Parameter | Description |
---|---|
Time to Acknowledge | The amount of time to wait for a response acknowledgment. If the time expires without an acknowledgment or exception, the original response is resent according to the retries rules. |
Include in Time to Perform | Select the check box if the time for the response acknowledgment is included in the Time to Perform specified on the General tab. |
Authorization Required | Select this check box to compare the signing certificate for the incoming message against the signing certificate specified in the mailbox. |
RNIF Mailbox: Certificates Tab
Use this tab to associate a trading partner's signing and encryption certificates with a mailbox and override your own Local Listener's signing and encryption certificates, if necessary.
Prior to completing the mailbox's Certificates tab, you must acquire your trading partner's signing/encryption certificate(s) and create and/or provide to your trading partner your signing/encryption certificate(s) (see Acquiring your trading partner's signing and encryption certificates and Creating and providing your signing/encryption certificates.)
Parameter | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Trading Partner Certificates | Provided by the trading partner.
|
||||||||||
My Certificates | By default, the certificates you configured on the Certificates tab of the Local Listener panel are 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.
|
RNIF Mailbox: Packaging Tab
See Configuring mailbox packaging for information about payload file packaging.
RNIF Action
An action's parameters capture a repeatable transaction for your mailbox on the host system.
RNIF Action: Action Tab
Use the Action tab to configure commands within an action.
See Composing an action. Also see RNIF Command Reference.
RNIF Command Reference
PUT
Send one or more files to the host.
PUT -DEL "source" "destination" [pipCode]= .. [pipVersion]= .. [pipInstanceId]= .. [actionType]=request|response
-DEL
- If the PUT is successful, delete the local file.
"source"
-
Local source path.
- Path can be to a filename or to a directory.
-
*
and?
, or a regular expression, are supported in filename. See Using wildcards and regular expressions for additional information. - If you specify a relative path, it uses default outbox.
- You can use macro variables. See Using macro variables (Source File context) for a list of the applicable macros.
- If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
"destination"
- Remote destination path
- If a destination is not specified, this command uses the source filename.
- If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
- pipCode
- The code for a PIP specification. Not needed if only one outgoing PIP. Incoming and outgoing PIPs that can be used with a trading partner are activated and configured in the mailbox PIPs tab. See RNIF Mailbox.
- pipVersion
- Matches to a particular version of a PIP. Not needed if only one version of the PIP code is active. If no version is specified or the version is set to
*
, the first occurrence of a configured PIP is used. - pipInstanceId
- The PIP instance ID uniquely identifies each use of a PIP when documents are sent and received. Not needed for a request. This is really only needed for two-action PIPs in order to associate a response document with the original request document. If a PIP instance ID is not specified, the VersaLex application automatically generates one.
- actionType
- Specifies the type of message being sent. Valid values are
request
andresponse
. The default value isrequest
. Specifyresponse
for the response of a two-action PIP.
pipCode
, pipVersion
, pipInstanceId
, and actionType
parameters are not needed if an outgoing file wrapper is being used instead. SYSTEM
Execute a local system command.
SYSTEM "path"
- "path"
- Local command path with arguments.
- If you specify a relative path or no path, the command uses the home directory.
- See Using operating system commands in actions for additional information
SET
Change an action property value. The new value only affects the commands that follow the SET.
You can use the SET command to override any property in the RNIF Configuration at action runtime.
SET property=value
- property = value
- Action property and new value
- The property name must have no embedded spaces.
- The value specified remains in effect until it is set again or until the end of action.
- To reset property back to default value (host-level or system-level), specify
SET property
or
SET property=
- To clear a string property, use the CLEAR command
CLEAR
Clear an action property string value. The cleared value only affects the commands that follow the CLEAR.
CLEAR property
- property
- Action property name with no embedded spaces.
WAIT
Pause execution.
WAIT seconds
- Seconds
- Number of seconds to pause.
LCOPY
Copy one or more files locally.
LCOPY –DEL -REC {–UNI|–APE} {-ZIP|-UNZ} "source" "destination"
- -DEL
- If the command is successful, delete the local file.
- -REC
- Recursively search all subdirectories.
- -UNI
- Ensure the copied filename is unique.
- -APE
- Append copied file to existing destination file.
- -ZIP
- Zip all the files into one or more ZIP archive files, depending on the destination specified.
- Specify ZIP comment and compression level through Zip Comment and Zip Compression Level properties. See Setting advanced host properties.
- The ZIP archive files created through the LCOPY command conform to the standard ZIP file format. Visit http://docs.oracle.com/javase/6/docs/api/java/util/zip/package-summary.html. The ZIP file format should not be confused with other popular file compression/archive formats such as GZIP, TAR, RAR, etc. The LCOPY command works only with ZIP-formatted files. In addition to the VersaLex application, there are many other software packages that can read/write ZIP-formatted files, for example, WinZip (Windows), File Roller (Linux), PKZIP and Info-ZIP (Windows/Linux/other Unix).
- In addition to standard ZIP-formatted archives, the VersaLex application also supports password-based AES- encrypted ZIP files (128-bit, 192-bit, and 256-bit). See Cryptographic Services.
- -UNZ
- Unzip the source file(s).
- All source files must be ZIP archive files.
- You cannot use this option with the
-REC
option. - Use ZIP entry paths if Unzip Use Path is set. See Setting advanced host properties.
- The ZIP archive files created through the LCOPY command conform to the standard ZIP file format (reference http://docs.oracle.com/javase/6/docs/api/java/util/zip/package-summary.html). The ZIP file format should not be confused with other popular file compression/archive formats such as GZIP, TAR, RAR, etc. The LCOPY command works only with ZIP-formatted files. In addition to the application, there are many other software packages that can read/write ZIP-formatted files, for example, WinZip (Windows), File Roller (Linux), PKZIP and Info-ZIP (Windows/Linux/other Unix).
- In addition to standard ZIP-formatted archives, the VersaLex application also supports password-based AES- encrypted ZIP files (128-bit, 192-bit, and 256-bit). See Encryption of Zip Files for more information on this capability.
- "source"
- Source path
- Path can be to a filename or to a directory
- You can use
*
and?
, or a regular expression when you specify a filename. See Using wildcards and regular expressions for additional information. - If you specify a relative path, the command uses the default inbox.
- You can use macro variables. See Using macro variables (Source File context) for a list of the applicable macros.
- If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
- "destination"
- Destination path.
- Path can be to a filename or to a directory.
- If you specify a relative path, the command uses the default inbox.
- You can use macro variables. See Using macro variables (Source File context) for a list of the applicable macros.
- You can use a single
*
within the destination path. In this context, it is not a wildcard. Rather, it is used to substitute a source file name or a source subdirectory name. When*
is used in conjunction with both the-REC
and-ZIP
options, andZip Subdirectories Into Individual Zip Files
is enabled, then*
is substituted with each first-level subdirectory name. When*
is not used for bundling zipped subdirectories, then it is used as a shortcut for the%sourcefilename%
or%srcfilename%
macro. Only one*
is allowed in the destination path. See Setting advanced host properties. - When copying a file without the
-APE
option, or when copying a file with the-APE
option where the destination file does not already exist, a temporary file name is used while the copy operation is taking place. This temporary file is placed in the destination directory. Its name begins with the product name and ends with .tmp. Once the copy completes successfully, the temporary file is renamed to the destination name. - If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
LDELETE
Delete one or more files locally.
LDELETE "source"
- "source"
- Source path.
- Path can be a filename or a directory.
- You can use
*
and?
, or a regular expression when you specify a filename. See Using wildcards and regular expressions for additional information. - If you specify a relative path, the command uses the default inbox.
- Use of macro variables is supported. See Using macro variables (Source File context) for a list of the applicable macros.
- If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
LREPLACE
Replace bytes in one or more files locally.
LREPLACE "source" Replace="input bytes" With="output bytes"
- "source"
- Source path.
- Path can be to a filename or to a directory.
- You can use
*
and?
, or a regular expression when you specify a filename. See Using wildcards and regular expressions for additional information. - If you specify a relative path, the command uses the default inbox.
- You can use macro variables. See Using macro variables (Source File context) for a list of the applicable macros.
- If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
- "input bytes"
- List of bytes to be replaced.
- Comma separated list of byte values (0-255).
- All bytes in comma-separated list must be found in the file in listed sequence in order to be replaced.
- "output bytes"
- List of bytes to be substituted for original
input bytes
.- Comma separated list of byte values (0-255).
- If
With
parameter is omitted, then theinput bytes
are deleted from the file.
CHECK
See CHECK Command for information about this command.
SCRIPT
See SCRIPT command for information about this command.
Comment
# text...
Lines in the action starting with a # character are considered comments and will be ignored when the action executes. Lines starting with # are generally used for documentation purposes.
Comments
0 comments
Please sign in to leave a comment.