> ## 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.

# Peppol Connector

> Configuration and usage guide for the CData Arc Peppol connector, which enables secure automated exchange of e-invoices and business documents over the Peppol network.

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/cloud/en/getting-started/administration/settings/proxy-settings">Proxy Settings</a> portion of the <a href="/26.2/cloud/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/cloud/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 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 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/cloud/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/cloud/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/cloud/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/cloud/en/getting-started/administration/settings/performance-settings">Performance Settings</a> portion of the <a href="/26.2/cloud/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/cloud/en/getting-started/administration/settings/performance-settings">Performance Settings</a> portion of the <a href="/26.2/cloud/en/getting-started/administration/settings/advanced-settings">Advanced Settings</a> page.</td>
        </tr>
      </tbody>
    </table>
  </>;

export const siteNameShort = "Arc";

export const siteName = "CData Arc";

The Peppol connector enables secure, automated exchange of e-invoices and other business documents over the Peppol (Pan-European Public Procurement Online) network. This connector allows organizations to integrate their systems with the Peppol eDelivery infrastructure directly from within {siteNameShort}, streamlining compliance with electronic procurement and invoicing mandates across Europe and beyond. The network facilitates the transmission of critical business documents through standardized Universal Business Language (UBL) formats and secure [AS4](./as4) protocol messaging.

The Peppol network operates on a four-corner model architecture consisting of the sender, the sender's Access Point (AP), the receiver's AP, and the final receiver. This distributed infrastructure ensures reliable and standardized communication pathways for electronic procurement processes across international boundaries, with Access Points serving as certified gateways that handle the secure transmission of documents between participants on the network.

## Key Capabilities

* Pan-European e-invoicing and e-procurement network integration using AS4-based four-corner model architecture
* Universal Business Language (UBL) format support with automatic message routing based on party identifiers
* SMP integration for dynamic endpoint discovery with certificate-based encryption and digital signatures

## Overview

A Peppol connection is configured in two places. Configure the Peppol [Profiles](../getting-started/administration/profiles) page with a local party identifier and a private certificate. Then configure individual Peppol connectors with connection settings specific to a single trading partner. When an input file is processed by a Peppol connector, it is packaged and sent to the specified trading partner.

When {siteNameShort} receives a file over Peppol, it attempts to route the file to a specific Peppol connector. The application uses the Peppol party identifiers in the Peppol message to determine which Peppol connector should receive the file. When a file is routed to a Peppol connector, that file is placed in the connector's Transactions tab, and is passed along to the next connected connector in the flow (when there is one).

### Prerequisites

Before you can configure and use the Peppol connector, you must complete the following:

1. Go to [https://Peppol.org/](https://Peppol.org/) to register and complete the certification to become a Peppol access point.

2. Register with an external SMP (Service Metadata Publisher). You must either register with an existing SMP or host your own.

## Profile Configuration

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

### Peppol Profile Tab

#### Personal Id

*Settings for identifying the local profile.*

| Setting              | Description                                                                                   |
| -------------------- | --------------------------------------------------------------------------------------------- |
| **Party Identifier** | The Party Id used by {siteNameShort} in AS4 Peppol exchanges. Identifiers are case-sensitive. |

#### Personal Certificate

*Settings related to the private decryption and signature certificate.*

| Setting                          | Description                                                                                                                                                                                                                                                                                                                                               |
| -------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Private Certificate**          | The certificate used to decrypt incoming messages and sign outgoing messages. Never share this certificate with external parties. Click the **Create Certificate** button to generate a self-signed certificate that is ready to use in a Peppol transaction: a corresponding public key is also generated with the same filename and a `.cer` extension. |
| **Private Certificate Password** | The password required to access the **Private Certificate**.                                                                                                                                                                                                                                                                                              |

#### Application URLs

*Settings and displayed values related to accessing {siteNameShort} from the public web.*

| Setting           | Description                                                                                                                                                                          |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Receiving URL** | The URL at which {siteNameShort} listens for incoming Peppol messages. Share this URL with all your trading partners. It is in this format: `<application_base_URL>/pub/Peppol.rsb`. |

## Connector Configuration

Once you configure the global Peppol profile settings, create and configure individual Peppol connectors for each trading partner on the [Flows](../flows/flows) page.

### Settings Tab

#### Configuration

| 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.                                                                                    |
| **Peppol ID**             | The unique identifier of the trading partner you are exchanging documents with. This is how you connect to the Peppol network, which enables secure and targeted message exchange. |

#### Advanced Settings

| Setting               | Description                                                                                                                                                                                                                             |
| --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **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). |

### Advanced Tab

#### Other Settings

*Settings not included in the previous categories.*

| Setting                      | Description                                                                                                                                                                                                                                                                           |
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Duplicate Message Action** | How the connector should behave when it receives a Peppol message with a Message Id that the connector has seen before. The connector detects duplicate messages by remembering Message Ids that have been received within the number of minutes specified in **Duplicate Interval**. |
| **Duplicate Interval**       | The number of minutes that a message with the same Message Id is considered a duplicate. If you set this to 0, the Message Ids are stored until the server is restarted.                                                                                                              |

#### Proxy Settings

<CommonProxySettings />

#### 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 Peppol 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. |

#### Performance

<Performance />

### Alerts Tab

<AlertsTab />

### SLAs Tab

<SlasTab />

### Transactions Tab

This tab lists all messages associated with the connector. Use the search bar to find specific messages, or click the funnel icon to apply a filter. You can filter by time, message direction, and/or status.

## Sending Documents

When sending documents, the following occurs:

* The connector uses the **Peppol Id** to look up the metadata (such as the endpoint and certificates) for the partner that has that ID.
* The receiver defined in the Standard Business Document Header (SBDH) of the outbound message must match the **Peppol Id** of the connector where the message being sent.
  * You can configure the SBDH using an [XML Map](./xml-map/xml-map) connector when it is connected as the input to a Peppol connector.
* The metadata that is returned from the lookup is used by the connector to send the document to the partner.

## Receiving Documents

When receiving documents, the steps described in [Sending](#sending-documents) happen in reverse:

* Your partner's Peppol AP looks up the metadata details that you provided to the SMP you registered with.
* That metadata is used by your partner's Peppol AP to send you the message(s). When a message reaches {siteNameShort}, the engine looks at the sender **Peppol Id** defined in the message SBDH, then routes the message to the Peppol connector that is configured with that **Peppol Id**.

## Macros

<MacrosTable />

### Examples

<MacrosExamples />