> ## Documentation Index
> Fetch the complete documentation index at: https://docs.arc.cdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# HL7 MLLP Connector

> Configuration and usage guide for the CData Arc HL7 MLLP connector.

export const SampleFilesTab = () => <>
    <p><em>Uploading a sample file allows for easy mapping in any connected CSV Map or XML Map connectors.</em></p>

    <p>Use the <strong>Sample Files</strong> tab to generate a source or destination XML template for use in a <a href="/26.2/self-hosted/en/connectors/map">CSV Map</a> or <a href="/26.2/self-hosted/en/connectors/xml-map/xml-map">XML Map</a> connector. Click <strong>Add Sample File</strong>.</p>

    <p style={{
  paddingLeft: '1.5rem',
  marginTop: '0.25rem',
  marginBottom: '0.25rem'
}}>1. If you already have an example file that reflects the expected format and structure of your data, choose <strong>File Upload</strong> and browse to your file. Alternatively, select <strong>Manually Create</strong> to create a file directly in the application. If you choose <strong>Manually Create</strong>, give your sample file a name. Click <strong>Next</strong>.</p>
    <p style={{
  paddingLeft: '1.5rem',
  marginTop: '0.25rem',
  marginBottom: '0.25rem'
}}>2. If you browsed to an existing file, the <strong>View File</strong> tab is populated with its contents. If you chose to manually create a file, enter your sample data on this tab. Click <strong>Next</strong>.</p>
    <p style={{
  paddingLeft: '1.5rem',
  marginTop: '0.25rem',
  marginBottom: '0.25rem'
}}>3. The <strong>Translate and Preview</strong> tab displays a preview of your sample data converted to XML. When you are satisfied with your sample, click <strong>Add</strong>.</p>
  </>;

export const EdiUploadTestFile = ({fileFormat = "EDI", documentType}) => {
  const docLabel = documentType || fileFormat;
  return <>
      <p>Follow these steps to generate an XML representation of an input file:</p>
      <p style={{
    paddingLeft: '1.5rem',
    marginTop: '0.25rem',
    marginBottom: '0.25rem'
  }}>1. In the <strong>Transactions</strong> tab of the connector, click the <strong>More</strong> dropdown and click <strong>Upload Test File</strong>.</p>
      <p style={{
    paddingLeft: '1.5rem',
    marginTop: '0.25rem',
    marginBottom: '0.25rem'
  }}>2. Navigate to a file on disk that you want to model as XML, select it, and click <strong>OK</strong>.</p>
      <p style={{
    paddingLeft: '1.5rem',
    marginTop: '0.25rem',
    marginBottom: '0.25rem'
  }}>3. Connect the {fileFormat} connector to an XML Map connector in the flow. This connection can go in either direction: inbound to the XML Map connector, or outbound from the XML Map connector.</p>
      <p>The XML Map connector automatically detects the structure of the test file. Based on where you placed the {fileFormat} connector, the file appears in the <strong>Source File</strong> or <strong>Destination File</strong> drop-down menu of the XML Map connector.</p>
      <Note>XML Map connectors require both a source and destination template, so the remaining template must be set based on the structure the data originates from, or the structure it should be converted to. For example, if the data from the {docLabel} document needs to be inserted into a database, the other template in the XML Map connector would be the XML model of a database insert. See the XML Map connector's <a href="/26.2/self-hosted/en/connectors/xml-map/xml-map-designer">Using the Mapping Editor</a> for more information on creating the mapping between two template files.</Note>
    </>;
};

export const EdiXmlMapIntro = ({fileFormat = "EDI"}) => <p>In accordance with Arc convention, the {fileFormat} connector does one of two things: it receives XML input or generates XML output. To ensure that the input and output files have the correct XML structure, CData strongly recommends that you use the <a href="/26.2/self-hosted/en/connectors/xml-map/xml-map">XML Map connector</a> as the previous step in the flow when generating outbound {fileFormat} documents, or as the following step in the flow when receiving inbound {fileFormat} documents. The interaction between the XML Map connector and the {fileFormat} connector is made simple by the <strong>Upload Test File</strong> feature described below.</p>;

export const CommonProxySettings = () => <>
    <p>These are a collection of settings that identify and authenticate to the proxy through which the connection should be routed. By default, this section uses the global settings on the <a href="/26.2/self-hosted/en/getting-started/administration/settings/proxy-settings">Proxy Settings</a> portion of the <a href="/26.2/self-hosted/en/getting-started/administration/settings/security">Security Settings</a> page. Clear the checkbox to supply settings specific to your connector.</p>
    <table>
      <thead>
        <tr><th>Setting</th><th>Description</th></tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>Proxy Type</strong></td>
          <td>The protocol used by a proxy-based firewall.</td>
        </tr>
        <tr>
          <td><strong>Proxy Host</strong></td>
          <td>The name or IP address of a proxy-based firewall.</td>
        </tr>
        <tr>
          <td><strong>Proxy Port</strong></td>
          <td>The TCP port for a proxy-based firewall.</td>
        </tr>
        <tr>
          <td><strong>Proxy User</strong></td>
          <td>The user name to use to authenticate with a proxy-based firewall.</td>
        </tr>
        <tr>
          <td><strong>Proxy Password</strong></td>
          <td>A password used to authenticate to a proxy-based firewall.</td>
        </tr>
        <tr>
          <td><strong>Authentication Scheme</strong></td>
          <td>Leave the default <strong>None</strong> or choose from one of the following authentication schemes: <strong>Basic</strong>, <strong>Digest</strong>, <strong>Proprietary</strong>, or <strong>NTLM</strong>.</td>
        </tr>
      </tbody>
    </table>
  </>;

export const SlasTab = ({siteName = "CData Arc"}) => <>
    <p><em>Settings related to configuring Service Level Agreements (SLAs).</em></p>
    <p>
      SLAs enable you to configure the volume you expect connectors in your flow to send or receive, and to set the time frame in which you expect that volume to be met. {siteName} sends emails to warn the user when an SLA is not met, and marks the SLA as <em>At Risk</em>, which means that if the SLA is not met soon, it will be marked as <em>Violated</em>. This gives the user an opportunity to step in and determine the reasons the SLA is not being met, and to take appropriate actions. If the SLA is still not met at the end of the at-risk time period, the SLA is marked as violated, and the user is notified again.
    </p>
    <p>
      To define an SLA, toggle <strong>Expected Volume</strong> on, then click the <strong>Settings</strong> tab.
    </p>
    <img src="/public/images/sla_empty.png" alt="SLA Empty" />
    <ul>
      <li>If your connector has separate send and receive actions, use the radio buttons to specify which direction the SLA pertains to.</li>
      <li>In the <strong>Expect at least</strong> portion of the window:
        <ul>
          <li>Set the minimum number of transactions you expect to be processed (the volume)</li>
          <li>Use the <strong>Every</strong> fields to specify the time frame</li>
          <li>Indicate when the SLA should go into effect. If you choose <strong>Starting on</strong>, complete the date and time fields.</li>
          <li>Check the boxes for the days of the week that you want the SLA to be in effect. Use the dropdown to choose <strong>Everyday</strong> if necessary.</li>
        </ul>
      </li>
      <li>In the <strong>Set status to 'At Risk'</strong> portion of the window, specify when the SLA should be marked as at risk.
        <ul>
          <li>By default, notifications are not sent until an SLA is in violation. To change that, check <strong>Send an 'At Risk' notification</strong>.</li>
        </ul>
      </li>
    </ul>
    <p>
      The following example shows an SLA configured for a connector that expects to receive 1000 files every day Monday-Friday. An at-risk notification is sent 1 hour before the end of the time period if the 1000 files have not been received.
    </p>
    <img src="/public/images/sla_defined.png" alt="SLA Configuration Example" />
    <Note>
      You can turn off SLA alerts if necessary. This can be useful during maintenance windows. Click <strong>Settings</strong> on the navbar, then navigate to <strong>Alerts &gt; General Alerts</strong>. Click the tablet and pencil icon to edit, and uncheck the <strong>SLA Alerts</strong> setting.
    </Note>
  </>;

export const AlertsTab = ({siteNameShort = "Arc"}) => <>
    <p><em>Settings related to configuring alerts.</em></p>
    <p>
      Before you can execute Service Level Agreements (SLAs), you need to set up email alerts for notifications. By default, {siteNameShort} uses the global settings on the <a href="/26.2/self-hosted/en/getting-started/administration/settings/alerts">Alerts</a> tab. To use other settings for this connector, toggle <strong>Override global setting</strong> on.
    </p>
    <p>
      By default, error alerts are enabled, which means that emails are sent whenever there is an error. To turn them off, uncheck the <strong>Enable</strong> checkbox.
    </p>
    <p>
      Enter a <strong>Subject</strong> (mandatory), then optionally enter a comma-separated list of <strong>Recipient</strong> emails.
    </p>
  </>;

export const Message = () => <>
    <p><em>Message settings determine how the connector searches for messages and manages them after processing.</em></p>
    <table>
      <thead>
        <tr><th>Setting</th><th>Description</th></tr>
      </thead>
      <tbody>
        
          <tr>
            <td><strong>Save to Sent Folder</strong></td>
            <td>Check this to copy files processed by the connector to the Sent folder for the connector.</td>
          </tr>
        
        <tr>
          <td><strong>Sent Folder Scheme</strong></td>
          <td>Instructs the connector to group files in the <strong>Sent</strong> folder according to the selected interval. For example, the <strong>Weekly</strong> option instructs the connector to create a new subfolder each week and store all sent files for the week in that folder. The blank setting instructs the connector to save all files directly in the <strong>Sent</strong> folder. For connectors that process many transactions, using subfolders can help keep files organized and improve performance.</td>
        </tr>
      </tbody>
    </table>
  </>;

export const MiscConnector = () => <>
    <p><em>Miscellaneous settings are for specific use cases.</em></p>
    <table>
      <thead>
        <tr>
          <th>Setting</th>
          <th>Description</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>Other Settings</strong></td>
          <td>Enables you to configure hidden connector settings in a semicolon-separated list (for example, <code>setting1=value1;setting2=value2</code>). Normal connector use cases and functionality should not require the use of these settings.</td>
        </tr>
      </tbody>
    </table>
  </>;

export const Logging = () => <>
    <p><em>Settings that govern the creation and storage of logs.</em></p>
    <table>
      <thead>
        <tr>
          <th>Setting</th>
          <th>Description</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>Log Level</strong></td>
          <td>The verbosity of logs generated by the connector. When you request support, set this to <strong>Debug</strong>.</td>
        </tr>
        <tr>
          <td><strong>Log Subfolder Scheme</strong></td>
          <td>Instructs the connector to group files in the Logs folder according to the selected interval. The <strong>Weekly</strong> option (which is the default) instructs the connector to create a new subfolder each week and store all logs for the week in that folder. Leaving this setting blank tells the connector to save all logs directly in the Logs folder. For connectors that process many transactions, using subfolders helps keep logs organized and improves performance.</td>
        </tr>
        <tr>
          <td><strong>Log Messages</strong></td>
          <td>Check this to have the log entry for a processed file include a copy of the file itself. If you disable this, you might not be able to download a copy of the file from the <strong>Transactions</strong> tab.</td>
        </tr>
      </tbody>
    </table>
  </>;

export const ProfileLogging = () => <>
    <p><em>Settings that govern the creation and storage of logs.</em></p>
    <table>
      <thead>
        <tr>
          <th>Setting</th>
          <th>Description</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>Log Level</strong></td>
          <td>The verbosity of logs generated by the connector. When you request support, set this to <strong>Debug</strong>.</td>
        </tr>
        <tr>
          <td><strong>Log Rotate Interval</strong></td>
          <td>The number of days to wait before creating a new log file.</td>
        </tr>
        <tr>
          <td><strong>Log Delete Interval</strong></td>
          <td>The number of days to wait before deleting old log files.</td>
        </tr>
      </tbody>
    </table>
  </>;

export const MacrosExamples = ({extraMacros = []}) => <>
    <p>
      Some macros, such as %Ext% and %ShortDate%, do not require an argument, but others do. All
      macros that take an argument use the following syntax: <code>%Macro:argument%</code>
    </p>

    <p>Here are some examples of the macros that take an argument:</p>

    <ul>
      <li>%Header:headername%: Where <code>headername</code> is the name of a header on a message.</li>
      <li>%Header:mycustomheader% resolves to the value of the <code>mycustomheader</code> header set on the input message.</li>
      <li>%Header:ponum% resolves to the value of the <code>ponum</code> header set on the input message.</li>
      <li>%RegexFilename:pattern%: Where <code>pattern</code> is a regex pattern. For example, <code>%RegexFilename:^([\w][A-Za-z]+)%</code> matches and resolves to the first word in the filename and is case insensitive (<code>test_file.xml</code> resolves to <code>test</code>).</li>
      <li>%Vault:vaultitem%: Where <code>vaultitem</code> is the name of an item in the <a href="/26.2/self-hosted/en/getting-started/administration/settings/global-settings-vault">vault</a>. For example, <code>%Vault:companyname%</code> resolves to the value of the <code>companyname</code> item stored in the vault.</li>
      <li>%DateFormat:format%: Where <code>format</code> is an accepted date format (see <a href="/26.2/self-hosted/en/scripting/value-formatters/date-formatters#sample-date-formats">Sample Date Formats</a> for details). For example, <code>%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%</code> resolves to the date and timestamp on the file.</li>
      {extraMacros.filter(item => item.example).map(item => <li key={`ex-${item.name}`}>{item.example}</li>)}
    </ul>

    <p>You can also create more sophisticated macros, as shown in the following examples:</p>

    <ul>
      <li>Combining multiple macros in one filename: <code>%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%%EXT%</code></li>
      <li>Including text outside of the macro: <code>MyFile_%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%</code></li>
      <li>Including text within the macro: <code>%DateFormat:'DateProcessed-'yyyy-MM-dd_'TimeProcessed-'HH-mm-ss%</code></li>
    </ul>
  </>;

export const MacrosTable = ({siteName = "CData Arc", extraMacros = []}) => <>
    <p>
      Using macros in file naming strategies can enhance organizational efficiency and contextual
      understanding of data. By incorporating macros into filenames, you can dynamically include
      relevant information such as identifiers, timestamps, and header information, providing
      valuable context to each file.
    </p>

    <p>{siteName} supports these macros, which all use the following syntax: <code>%Macro%</code>.</p>

    <table>
      <thead>
        <tr><th>Macro</th><th>Description</th></tr>
      </thead>
      <tbody>
        <tr><td>ConnectorID</td><td>Evaluates to the ConnectorID of the connector.</td></tr>
        <tr><td>Ext</td><td>Evaluates to the file extension of the file currently being processed by the connector.</td></tr>
        <tr><td>Filename</td><td>Evaluates to the filename (extension included) of the file currently being processed by the connector.</td></tr>
        <tr><td>FilenameNoExt</td><td>Evaluates to the filename (without the extension) of the file currently being processed by the connector.</td></tr>
        <tr><td>MessageId</td><td>Evaluates to the MessageId of the message being output by the connector.</td></tr>
        <tr><td>RegexFilename:<em>pattern</em></td><td>Applies a RegEx pattern to the filename of the file currently being processed by the connector.</td></tr>
        <tr><td>Header:<em>headername</em></td><td>Evaluates to the value of a targeted header (<code>headername</code>) on the current message being processed by the connector.</td></tr>
        <tr><td>LongDate</td><td>Evaluates to the current datetime of the system in long-handed format (for example, Wednesday, January 24, 2024).</td></tr>
        <tr><td>ShortDate</td><td>Evaluates to the current datetime of the system in a yyyy-MM-dd format (for example, 2024-01-24).</td></tr>
        <tr><td>DateFormat:<em>format</em></td><td>Evaluates to the current datetime of the system in the specified format (<code>format</code>). See <a href="/26.2/self-hosted/en/scripting/value-formatters/date-formatters#date-formats-with-literal-characters">Sample Date Formats</a> for the available datetime formats.</td></tr>
        <tr><td>Vault:<em>vaultitem</em></td><td>Evaluates to the value of the specified vault item.</td></tr>
        {extraMacros.map(item => <tr key={item.name}>
            <td>{item.name}</td>
            <td>{item.description}</td>
          </tr>)}
      </tbody>
    </table>
  </>;

export const Performance = () => <>
    <p><em>Settings related to the allocation of resources to the connector.</em></p>
    <table>
      <thead>
        <tr>
          <th>Setting</th>
          <th>Description</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>Max Workers</strong></td>
          <td>The maximum number of worker threads consumed from the threadpool to process files on this connector. If set, this overrides the default setting on the <a href="/26.2/self-hosted/en/getting-started/administration/settings/performance-settings">Performance Settings</a> portion of the <a href="/26.2/self-hosted/en/getting-started/administration/settings/advanced-settings">Advanced Settings</a> page.</td>
        </tr>
        <tr>
          <td><strong>Max Files</strong></td>
          <td>The maximum number of files sent by each thread assigned to the connector. If set, this overrides the default setting on the <a href="/26.2/self-hosted/en/getting-started/administration/settings/performance-settings">Performance Settings</a> portion of the <a href="/26.2/self-hosted/en/getting-started/administration/settings/advanced-settings">Advanced Settings</a> page.</td>
        </tr>
      </tbody>
    </table>
  </>;

export const companyName = "CData";

export const siteNameShort = "Arc";

export const siteName = "CData Arc";

export const fileFormat = "HL7 MLLP";
export const documentType = "HL7";

Health Level-7 is a set of standards for the transfer of clinical data used by hospitals and other healthcare providers. HL7 MLLP connectors support generating and parsing HL7 documents in conjunction with MLLP as the transport protocol.

## Key Capabilities

* Healthcare data exchange using HL7 over MLLP (Minimal Lower Layer Protocol) transport
* Embedded MLLP server functionality with SSL/TLS encryption support
* Bidirectional HL7 document translation between HL7 and XML formats
* MSH header validation with configurable application and facility identifiers
* Automatic acknowledgment handling with retry and resend capabilities for reliable delivery

## Overview

HL7 MLLP connectors provide two sets of functionality:

* File transfer over the MLLP transport protocol
* EDI document parsing and generation according to the HL7 EDI standard

An HL7 MLLP connection is configured in two places. Configure the HL7 MLLP [Profiles](../getting-started/administration/profiles) page with the settings that identify {siteNameShort} as an HL7 and MLLP entity. Then configure individual HL7 MLLP connectors with the HL7 and MLLP details for each trading partner.

When an HL7 MLLP connector receives an inbound message from a trading partner, it verifies the HL7 identification details to confirm that the document was sent from and to the expected parties. Then it translates the document into XML for further processing in a {siteNameShort} flow.

When an HL7 MLLP connector sends files to a trading partner:

* XML files are translated to HL7 before being sent
* HL7 documents are sent as-is

{companyName} strongly recommends that you use the HL7 MLLP connector in conjunction with the [XML Map connector](./xml-map/xml-map) to ensure that input and output XML is formatted correctly. See [Use with the XML Map Connector](#use-with-the-xml-map-connector) for more information.

## Profile Configuration

The HL7 MLLP Profile must be configured before connections can be established with individual HL7 MLLP connectors. Click **Profiles** on the navbar, then click the **HL7 MLLP** tab.

### HL7 MLLP Profile Tab

#### Server Configuration

*Settings for hosting a local MLLP server.*

| Setting                    | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Port**                   | The port on which to listen for incoming MLLP connections.                                                                                                                                                                                                                                                                                                                                                                                                      |
| **Use SSL/TLS**            | Whether to require incoming connections to use SSL/TLS encryption for transport security.                                                                                                                                                                                                                                                                                                                                                                       |
| **TLS Server Certificate** | The public key certificate used to verify the identity of a TLS/SSL server. If the target server uses TLS/SSL, set this field to the certificate that identifies the server. If the server's certificate is not available, you can leave this setting blank to allow the underlying OS/JVM to perform certificate validation, or set it to `Any Certificate` to implicitly trust the server's identity. (This field only appears if you check **Use SSL/TLS**.) |

#### HL7 Personal Ids

| Setting                                    | Description                                                                           |
| ------------------------------------------ | ------------------------------------------------------------------------------------- |
| **Application Namespace Id (MSH3.1)**      | The application Id that identifies the local namespace for the HL7 protocol exchange. |
| **Application Universal Id (MSH3.2)**      | The local application universal Id for the HL7 protocol exchange.                     |
| **Application Universal Id Type (MSH3.3)** | A type qualifier to provide context to the local application universal Id.            |
| **Facility Namespace Id (MSH4.1)**         | The facility Id that identifies the local namespace for the HL7 protocol exchange.    |
| **Facility Universal Id (MSH4.2)**         | The local facility universal Id for the HL7 protocol exchange.                        |
| **Facility Universal Id Type (MSH4.3)**    | A type qualifier to provide context to the local facility universal Id.               |

#### Other Settings

*Settings that rarely need to be modified.*

| Setting                | Description                                                                                                            |
| ---------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| **Inactivity Timeout** | The amount of time (in seconds) that the server allows clients to remain inactive before the connection is terminated. |

#### Logging

<ProfileLogging />

#### Miscellaneous

<MiscConnector />

## Connector Configuration

Once you configure the global HL7 MLLP profile settings, create and configure individual HL7 MLLP connectors for each trading partner on the Flows page.

### Settings Tab

#### Connector Settings

*Settings related to the core operation of the connector.*

| Setting                   | Description                                                                                                    |
| ------------------------- | -------------------------------------------------------------------------------------------------------------- |
| **Connector Id**          | The static, unique identifier for the connector.                                                               |
| **Connector Type**        | Displays the connector name and a description of what it does.                                                 |
| **Connector Description** | An optional field to provide a free-form description of the connector and its role in the flow.                |
| **Remote Host**           | The hostname or IP address of your remote host.                                                                |
| **Port**                  | The port on which to listen for incoming MLLP connections.                                                     |
| **Version**               | The version of MLLP being used.                                                                                |
| **Connection Timeout**    | The length of time (in seconds) the connector waits for a connection response before throwing a timeout error. |
| **Use SSL/TLS**           | Whether to require incoming connections to use SSL/TLS encryption for transport security.                      |

#### HL7 Configuration

*Settings related to the message headers. When converting HL7 documents into XML, the document headers are validated against these settings; when generating HL7 documents from XML, these settings are used to generate document headers.*

| Setting                                    | Description                                                                                                    |
| ------------------------------------------ | -------------------------------------------------------------------------------------------------------------- |
| **Application Namespace Id (MSH5.1)**      | In conjunction with the other 5.X elements, identifies the application on the remote side of the HL7 exchange. |
| **Application Universal Id (MSH5.2)**      | In conjunction with the other 5.X elements, identifies the application on the remote side of the HL7 exchange. |
| **Application Universal Id Type (MSH5.3)** | In conjunction with the other 5.X elements, identifies the application on the remote side of the HL7 exchange. |
| **Facility Namespace Id (MSH6.1)**         | In conjunction with the other 6.X elements, identifies the facility on the remote side of the HL7 exchange.    |
| **Facility Universal Id (MSH6.2)**         | In conjunction with the other 6.X elements, identifies the facility on the remote side of the HL7 exchange.    |
| **Facility Universal Id Type (MSH6.3)**    | In conjunction with the other 6.X elements, identifies the facility on the remote side of the HL7 exchange.    |

#### Acknowledgments

*Settings related to generating and requesting acknowledgments.*

| Setting                 | Description                                                       |
| ----------------------- | ----------------------------------------------------------------- |
| **Acknowledgment Type** | Whether or not acknowledgments should be generated and requested. |

### Sample Files Tab

<SampleFilesTab />

### Advanced Tab

#### EDI Delimiters

*Settings that specify which characters separate elements, segments, and so on.*

| Setting                         | Description                                                                                                                                                                                                     |
| ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Data Element Separator**      | The character that separates individual data elements in the document.                                                                                                                                          |
| **Component Element Separator** | The character that separates elements within a composite data structure in the document.                                                                                                                        |
| **Segment Terminator**          | The character that indicates the end of a segment in the document.                                                                                                                                              |
| **Release Char**                | The character that *releases* (escapes) the next character, overriding its usual meaning. This allows reserved characters to appear as data within documents, as long as they are preceded by the Release Char. |
| **Repetition Char**             | The character that indicates repetition of element values.                                                                                                                                                      |
| **Suffix**                      | Appended to the **Segment Terminator** to distinguish segments.                                                                                                                                                 |

#### Proxy Settings

<CommonProxySettings />

#### Advanced Settings

*Settings not included in the previous categories.*

| Setting                      | Description                                                                                                                                                                                                                                                                                                                                                                                |
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Generate Description As**  | When translating HL7 into XML, descriptions of the HL7 segments and elements can be provided as context for the HL7 data. Use this dropdown to choose whether to add this context as an XML comment or as XML attributes.                                                                                                                                                                  |
| **Processing Delay**         | The amount of time (in seconds) by which the processing of files placed in the **Transactions** tab is delayed. This is a legacy setting. Best practice is to [use a File connector](../flows/designing-a-flow#interacting-with-the-local-file-system) to manage local file systems instead of this setting.                                                                               |
| **Strict Schema Validation** | Whether the connector should Ignore, Warn, or Fail when the following are detected: repeat counts above the allowed number, missing required elements or segments, invalid qualifier and code values, disallowed element lengths, and invalid element values.                                                                                                                              |
| **Local File Scheme**        | A scheme for assigning filenames to messages that are output by the connector. You can use macros in your filenames dynamically to include information such as identifiers and timestamps. For more information, see [Macros](#macros).                                                                                                                                                    |
| **TLS Enabled Protocols**    | The list of TLS/SSL protocols supported when establishing outgoing connections. Best practice is to only use TLS protocols. SSL v2 and SSL v3 are considered vulnerable and should only be used if your partner does not support higher versions. Keep in mind that TLS v1.3 is not universally adopted, and might be refused if the destination server does not support it.               |
| **Validate Identifiers**     | When checked, the connector ensures that the identifiers in the translated document match the identifiers specified in the connector configuration.                                                                                                                                                                                                                                        |
| **Duplicate File Action**    | How the connector should behave when it receives a message with a control number that the connector has seen before (a duplicate). When set to `Ignore`, the connector silently skips the duplicate and continues processing. When set to `Warn`, the connector processes the file but returns a warning. When set to `Fail`, the connector does not accept the file and returns an error. |
| **Upload Schema**            | Use this to upload a schema and install it in the connector's Schema folder. If a schema already exists, you are asked if you want to overwrite it.                                                                                                                                                                                                                                        |
| **Reset State**              | EDI connectors keep track of control numbers that have been used and increment that number to ensure that future runs do not duplicate data. Use this button to reset the counter to its initial state without changing any of the configured settings.                                                                                                                                    |

#### Message

<Message />

#### Logging

<Logging />

#### Miscellaneous

<MiscConnector />

### Automation Tab

#### Automation Settings

*Settings related to the automatic processing of files by the connector.*

| Setting                  | Description                                                                                                                                                                                                                                                                                                                                                                                                     |
| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Send**                 | Whether files arriving at the connector are automatically sent as HL7 or XML messages.                                                                                                                                                                                                                                                                                                                          |
| **Retry Interval**       | The number of minutes before a failed send is retried. A retry is triggered when the server does not respond to a send attempt, or responds negatively to communicate that the file was not received.                                                                                                                                                                                                           |
| **Max Attempts**         | The maximum number of times the connector processes the input file. Success is based on a successful server acknowledgement and validation of the receipt (when requested synchronously). If you set this to 0, the connector retries the file indefinitely.                                                                                                                                                    |
| **Resend Interval**      | The number of minutes before unacknowledged messages are resent. A resend is triggered when the server receives the file, but an asynchronous MDN receipt is not provided within the expected timeframe.                                                                                                                                                                                                        |
| **Max Attempts (async)** | The maximum number of times the connector processes the input file when asynchronous receipts are requested. Success is based on the return of an asynchronous receipt within the **Resend Interval** after a successful server acknowledgement. If a successful server acknowledgement is not returned, **Max Attempts** is applied instead. If this is set to 0, the connector resends the file indefinitely. |

#### Performance

<Performance />

### Alerts Tab

<AlertsTab />

### SLAs Tab

<SlasTab />

## Generating HL7 Documents

When generating HL7 files from XML, the connector applies transaction headers based on the [HL7 Personal Ids](#hl7-personal-ids) on the HL7 MLLP Profile tab, and the [HL7 Configuration](#hl7-configuration) in the connector. The remaining data comes from XML input files. See [Use with the XML Map Connector](#use-with-the-xml-map-connector) for more information on generating the appropriate XML input files.

Files that arrive in the **Transactions** tab for the connector are packaged into HL7 documents and sent out over MLLP. Files can arrive in the **Transactions** tab either by dropping the file directly into the folder path on disk, or by connecting another {siteNameShort} connector to the HL7 MLLP connector in the flow.

## HL7 to XML

When converting HL7 documents into XML, the application verifies the interchange headings from the inbound document against the [HL7 Personal Ids](#hl7-personal-ids) on the HL7 MLLP Profile tab, and the [HL7 Configuration](#hl7-configuration) in the connector. The XML generated from the HL7 document is placed in the **Transactions** tab to be passed along in the flow for further processing. See [Use with the XML Map Connector](#use-with-the-xml-map-connector) for more information on processing the translated XML.

## Use With the XML Map Connector

<EdiXmlMapIntro fileFormat={fileFormat} />

### Upload Test File

<EdiUploadTestFile fileFormat={fileFormat} documentType={documentType} />

## Macros

<MacrosTable />

### Examples

<MacrosExamples />