Wrapped Serial (RS-232)

The Wrapped Serial communication point transfers messages utilizing a serial (RS/232) port. Messages are wrapped with a user-defined header and/or trailer.

Refer to Serial Port Problems on UNIX for details about common problems when running serial communication points on Unix.

Serial communication points are only available on Windows and Linux (unavailable on HPUX, Solaris and AIX).

Supported Operational Modes: All.

Input Mode Properties

Property	Description
Port Name	Specifies the name of the port to which you want to connect: `COM3` (default). `LPT1`. `LPT2` - Windows® environment only.
Baud Rate	Specifies the speed of the serial connection between `50` and `115200` baud (the default is `9600` baud).
Data Bits	Specifies the number of data-bits (the default is `8`).
Stop Bits	Specifies the number of stop-bits (the default is `1`).
Parity	Specifies the data parity mode: `Even`. `Mark`. `None` (default). `Odd`. `Space`.
Flow Control	Specifies the Flow Control mode: `None` (default). `RTS/CTS`. `XON/XOFF`.
Init Sequence	The sending/expected sequence pairs which will be used for the serial transport initialization before sending the message to the remote host. This property only accepts unescaped ASCII characters with the exception of the following escape sequences: `\t`, `\n`, `\r`, and `\b`. All other escape sequences are ignored. If you want to use a specific hexadecimal byte sequence, you can use a tool such as a HEX editor to create the byte sequences and paste them as ASCII text into the property field (even if the ASCII characters are non-printable). Unprintable characters may display incorrectly in the editor, but the actual byte sequence is recorded in the property. If you want to use this communication point to listen for a response without first having sent a byte sequence, then populate the Expected Sequence field as normal and leave the Sending Sequence field blank.
Init Timeout	How long (in milliseconds) to wait for the init sequence to be processed. (`0` (zero) means no limit).
Log Connections	Whether to log connections: `True` - establishing and dropping of all connections to the communication point are logged to the log file specified in the Connection Log File property. `False` (default). Use of this logging facility slows the communication point down considerably. It is intended for debugging purposes and should not generally be used.
Log Data	Whether to log data: `True` - all data passed over the connections of the communication point is logged to the log file. This is potentially a large amount of data. `False` (default).
Log Data As Hex	Whether to log data in hexadecimal form: `True` - the hexadecimal representation of the data is logged to the log file. `False` (default) - the data is logged exactly as it is as it passes over the communication point connection.
Connection Log File	The full file name (path and file name) of the file on the server to which to log the information.
Extra Information	Whether to log extra information: `None`. `Log Time` (default) - log timestamps with each event.
Incoming Wrapper	Message wrapping around messages received over the socket connection. `Minimal` - HL7 minimal LLP protocol. `User` (default) - user-defined header and/or trailer. Refer to Wrapper Options for details.
Strip Wrapping	Whether or not to strip the wrapping off received messages: `True` (default). `False`. Refer to Strip Wrapping for details.
Incoming Header	Defines the header that identifies the start of a message on the socket connection. Only available when the Incoming Wrapper field is set to `User`. This property only accepts unescaped ASCII characters with the exception of the following escape sequences: `\t`, `\n`, `\r`, and `\b`. All other escape sequences are ignored. If you want to use a specific hexadecimal byte sequence, you can use a tool such as a HEX editor to create the byte sequences and paste them as ASCII text into the property field (even if the ASCII characters are non-printable). Unprintable characters may display incorrectly in the editor, but the actual byte sequence is recorded in the property.
Incoming Trailer	Defines the trailer that identifies the end of a message on the socket connection. Only available when the Incoming Wrapper field is set to `User`. This property only accepts unescaped ASCII characters with the exception of the following escape sequences: `\t`, `\n`, `\r`, and `\b`. All other escape sequences are ignored. If you want to use a specific hexadecimal byte sequence, you can use a tool such as a HEX editor to create the byte sequences and paste them as ASCII text into the property field (even if the ASCII characters are non-printable). Unprintable characters may display incorrectly in the editor, but the actual byte sequence is recorded in the property.
Incoming Endian-ness	The incoming endian-ness: `Big` - most significant byte first endian order. `Little` - least significant byte first endian order. Only available when the Incoming Wrapper field is set to `User`. Certain codes used in the header and trailer definitions can output binary data.

Output Mode Properties

Property	Description
Port Name	Options: `COM3`, `LPT1`, `LPT2`. (Windows® environment only). Identifies the name of the port to which to connect.
Baud Rate	Options: `50 - 115200`. Default: `9600` Identifies the speed of the serial connection.
Data Bits	The number of data-bits. Default: `8`.
Stop Bits	The number of stop-bits. Default: `1`.
Parity	Options: `Even`, `Mark`, `None`, `Odd`, `Space` . Default: `None` Identifies the data parity mode.
Flow Control	Options: `None`, `RTS/CTS`, `XON/XOFF`. Default: `None` The type of flow control to use.
Init Sequence	The sending/expected sequence pairs which will be used for the serial transport initialization before sending the message to the remote host. This property only accepts unescaped ASCII characters with the exception of the following escape sequences: `\t`, `\n`, `\r`, and `\b`. All other escape sequences are ignored. If you want to use a specific hexadecimal byte sequence, you can use a tool such as a HEX editor to create the byte sequences and paste them as ASCII text into the property field (even if the ASCII characters are non-printable). Unprintable characters may display incorrectly in the editor, but the actual byte sequence is recorded in the property.
Init Timeout	How long (in milliseconds) to wait for the initialization sequence to be processed. (0 (zero) means no limit).
Log Connections	Options: `True`, `False`. Default: `False` If `True`, establishing and dropping of all connections to the communication point are logged to the log file specified in the Connection Log File field. Use of this logging facility slows the communication point down considerably. It is intended for debugging purposes and should not generally be used.
Log Data	Options: `True`, `False`. Default: `False` If `True`, all data passed over the connections of the communication point is logged to the log file. This is potentially a lot of data.
Log Data As Hex	Options: `True`, `False`. Default: `False` If `True`, the hexadecimal representation of the data is logged to the log file. If `False` , the data is logged exactly as it is as it passes over the communication point connection.
Connection Log File	The full file name (path and file name) of the file on the server to which to log the information.
Extra Information	Options: `None`, `Log Time`. Default: `Log Time` If set to `Log Time`, the timestamps will be logged with each event.
Outgoing Wrapper	Options: `Minimal`, `User`. Default: `User` Message wrapping around messages received over the socket connection. `Minimal` - HL7 minimal LLP protocol. `User`- user-defined header and/or trailer. Refer to Wrapper Options, described in General Communication Point Properties, for details.
Outgoing Header	Only available when the Outgoing Wrapper field is set to `User`. This property defines the header that identifies the start of a message on the socket connection. This property only accepts unescaped ASCII characters with the exception of the following escape sequences: `\t`, `\n`, `\r`, and `\b`. All other escape sequences are ignored. If you want to use a specific hexadecimal byte sequence, you can use a tool such as a HEX editor to create the byte sequences and paste them as ASCII text into the property field (even if the ASCII characters are non-printable). Unprintable characters may display incorrectly in the editor, but the actual byte sequence is recorded in the property.
Outgoing Trailer	Only available when the Outgoing Wrapper field is set to `User`. This property defines the trailer that identifies the end of a message on the socket connection. This property only accepts unescaped ASCII characters with the exception of the following escape sequences: `\t`, `\n`, `\r`, and `\b`. All other escape sequences are ignored. If you want to use a specific hexadecimal byte sequence, you can use a tool such as a HEX editor to create the byte sequences and paste them as ASCII text into the property field (even if the ASCII characters are non-printable). Unprintable characters may display incorrectly in the editor, but the actual byte sequence is recorded in the property.
Outgoing Endian-ness	Options: `Big` (most significant byte first), `Little` (least significant byte first) endian order. Only available when the Outgoing Wrapper field is set to `User`. Certain codes used in the header and trailer definitions can output binary data.

Bidirectional, In->Out and Out->In Mode

The configuration properties for the Wrapped Serial (RS/232) communication point in Bidirectional, In->Out and Out->In modes is a combination of the properties described above.

Refer to Out->In and In->Out Properties for general details on a communication point's In->Out and Out->In modes.