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

# PDF 端口

> 知行之桥PDF Label 端口的配置和使用指南。

export const SlasTab = ({siteName = "知行之桥"}) => <>
    <p><em>与配置服务级别协议 (SLA) 相关的设置。</em></p>
    <p>
      SLA 允许配置预期流程中端口发送或接收的数据量，并设置预期达到该数据量的时间范围。当 SLA 未达到时，{siteName} 会发送电子邮件警告用户，并将 SLA 标记为 <em>存在风险</em>，这意味着如果 SLA 未能尽快达到，则会被标记为 <em>已违反</em>。这让用户有机会介入并确定 SLA 未达到的原因，并采取适当的措施。如果在风险时间段结束时仍未达到 SLA，则会将 SLA 标记为已违反，并再次通知用户。
    </p>
    <p>
      要定义 SLA，请启用 <strong>预期数据量</strong>，然后点击 <strong>设置</strong> 选项卡。
    </p>
    <img src="/public/images/sla_empty.png" alt="SLA Empty" />
    <ul>
      <li>如果端口具有单独的发送和接收操作，请使用单选按钮指定 SLA 适用的方向。</li>
      <li>在窗口的 <strong>预计至少</strong> 部分中：
        <ul>
          <li>设置预计处理的最小事务数量（交易量）</li>
          <li>使用 <strong>每个</strong> 字段指定时间范围</li>
          <li>指示 SLA 生效的时间。如果选择 <strong>开始于</strong>，请填写日期和时间字段。</li>
          <li>勾选希望 SLA 生效的星期几对应的复选框。如有必要，请使用下拉菜单选择 <strong>每天</strong>。</li>
        </ul>
      </li>
      <li>在窗口的 <strong>将状态设置为“有风险”</strong> 部分中，指定应将 SLA 标记为有风险的时间。
        <ul>
          <li>默认情况下，只有在违反 SLA 的情况下才会发送通知。要更改此设置，请勾选 <strong>发送“有风险”通知</strong>。</li>
        </ul>
      </li>
    </ul>
    <p>
      以下示例显示了为端口配置的 SLA，该端口预计在周一至周五每天接收 1000 个文件。如果尚未收到 1000 个文件，则会在时间段结束前 1 小时发送风险通知。
    </p>
    <img src="/public/images/sla_defined.png" alt="SLA Configuration Example" />
    <Note>
      如果有必要，可以关闭 SLA 通知。这在维护窗口期间非常有用。点击导航栏上的 <strong>设置</strong>，然后跳转到 <strong>通知 &gt; 通用通知</strong>。点击平板和铅笔图标进行编辑，并取消勾选 <strong>SLA 通知</strong> 设置。
    </Note>
  </>;

export const AlertsTab = ({siteNameShort = "知行之桥"}) => <>
    <p><em>与配置通知相关的设置。</em></p>
    <p>
      在执行服务级别协议 (SLA) 之前，需要设置电子邮件通知以接收通知。默认情况下，{siteNameShort} 使用 <a href="/26.2/self-hosted/zh/getting-started/administration/settings/alerts">通知</a> 选项卡上的全局设置。要为此端口使用其他设置，请启用 <strong>覆盖全局设置</strong>。
    </p>
    <p>
      默认情况下，错误通知处于启用状态，这意味着每当出现错误时都会发送电子邮件。要关闭错误通知，请取消选中 <strong>启用</strong> 复选框。
    </p>
    <p>
      输入 <strong>主题</strong>（必填），然后（可选）输入以逗号分隔的 <strong>收件人</strong> 电子邮件列表。
    </p>
  </>;

export const Message = () => <>
    <p><em>消息设置确定端口如何搜索消息并在处理后管理它们。</em></p>
    <table>
      <thead>
        <tr><th>设置</th><th>描述</th></tr>
      </thead>
      <tbody>
        
          <tr>
            <td><strong>保存到已发送文件夹</strong></td>
            <td>选中此项可将端口处理的文件复制到该端口的“已发送”文件夹中。</td>
          </tr>
        
        <tr>
          <td><strong>已发送文件夹方案</strong></td>
          <td>端口根据选定的时间间隔对 <strong>已发送</strong> 文件夹中的文件进行分组。例如，<strong>Weekly</strong> 选项指示端口每周创建一个新的子文件夹，并将本周发送的所有文件存储在该文件夹中。空白设置告诉端口将所有文件直接保存在 <strong>已发送</strong> 文件夹中。对于处理许多事务的端口，使用子文件夹可以帮助保持文件有序并提高性能。</td>
        </tr>
      </tbody>
    </table>
  </>;

export const MiscConnector = () => <>
    <p><em>特殊设置适用于特定用例。</em></p>
    <table>
      <thead>
        <tr>
          <th>设置</th>
          <th>描述</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>其他设置</strong></td>
          <td>允许在以分号分隔的列表中配置隐藏的端口设置，例如 <code>setting1=value1;setting2=value2</code>。正常的端口用例和功能不需要使用这些设置。</td>
        </tr>
      </tbody>
    </table>
  </>;

export const Logging = () => <>
    <p><em>用于管理日志创建和存储的设置。</em></p>
    <table>
      <thead>
        <tr>
          <th>设置</th>
          <th>描述</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>日志级别</strong></td>
          <td>指定要记录在端口日志目录中的信息类型：
            <ul>
              <li><b>None</b> - 不创建任何日志。</li>
              <li><b>Error</b> - 仅当端口遇到错误时才创建日志。</li>
              <li><b>Warning</b> - 仅当端口发出警告时才创建日志。</li>
              <li><b>Info</b> - 记录工作流的一般信息，包括任何错误和警告（如果适用）。</li>
              <li><b>Debug</b> - 记录成功和失败工作流的详细调试信息。</li>
              <li><b>Trace</b> - 记录成功和失败工作流的详细跟踪信息。</li>
            </ul>
            <strong>请注意：</strong><strong>Debug</strong> 和 <strong>Trace</strong> 级别的日志可能会记录敏感信息，包括消息内容和 SSL 证书。尽管连接属性（例如密码）被屏蔽了，但在与您的组织外部共享它们之前，请查看此级别的日志以避免泄漏敏感信息。</td>
        </tr>
        <tr>
          <td><strong>日志文件夹结构</strong></td>
          <td>指示端口根据选定的时间间隔将日志文件夹中的文件分组。例如，<strong>Weekly</strong> 选项指示端口每周创建一个新的子文件夹，并将该周的所有日志存储在该文件夹中。空白设置告诉端口将所有日志直接保存在日志文件夹中。对于处理许多事务的端口，使用子文件夹有助于保持日志的有序性并提高性能。</td>
        </tr>
        <tr>
          <td><strong>保留消息副本</strong></td>
          <td>指示端口在日志目录中保存最新消息副本的切换。请注意，端口每个子文件夹只保留一个消息，并且端口在再次运行时会覆盖以前保存的消息。</td>
        </tr>
      </tbody>
    </table>
  </>;

export const MacrosExamples = ({extraMacros = []}) => <>
    <p>
      某些宏（例如 %Ext% 和 %ShortDate%）不需要参数，但其他宏则需要。所有带有参数的宏都使用以下语法：<code>%Macro:argument%</code>
    </p>

    <p>以下是带有参数的宏的一些示例：</p>

    <ul>
      <li>%Header:headername%：其中 <code>headername</code> 是消息上消息头的名称。</li>
      <li>%Header:mycustomheader% 解析为输入消息上设置的 <code>mycustomheader</code> 消息头的值。</li>
      <li>%Header:ponum% 解析为输入消息上设置的 <code>ponum</code> 消息头的值。</li>
      <li>%RegexFilename:pattern%：其中 <code>pattern</code> 是正则表达式模式。例如，<code>%RegexFilename:^([\w][A-Za-z]+)%</code> 匹配并解析为文件名中的第一个单词，并且不区分大小写（<code>test_file.xml</code> 解析为 <code>test</code>）。</li>
      <li>%Vault:vaultitem%：其中 <code>vaultitem</code> 是 <a href="/26.2/self-hosted/zh/getting-started/administration/settings/global-settings-vault">vault</a> 中项目的名称。例如，<code>%Vault:companyname%</code> 解析为存储在保管库中的 <code>companyname</code> 项的值。</li>
      <li>%DateFormat:format%：其中 <code>format</code> 是可接受的日期格式（有关详细信息，请参阅 <a href="/26.2/self-hosted/zh/scripting/value-formatters/date-formatters#sample-date-formats">示例日期格式</a>）。例如，<code>%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%</code> 解析为文件上的日期和时间戳。</li>
      {extraMacros.filter(item => item.example).map(item => <li key={`ex-${item.name}`}>{item.example}</li>)}
    </ul>

    <p>还可以创建更复杂的宏，如以下示例所示：</p>

    <ul>
      <li>将多个宏组合在一个文件名中：<code>%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%%EXT%</code></li>
      <li>包括宏之外的文本：<code>MyFile_%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%</code></li>
      <li>在宏中包含文本：<code>%DateFormat:'DateProcessed-'yyyy-MM-dd_'TimeProcessed-'HH-mm-ss%</code></li>
    </ul>
  </>;

export const MacrosTable = ({siteName = "知行之桥", extraMacros = []}) => <>
    <p>
      在文件命名策略中使用宏可以提高组织效率和对数据的上下文理解。通过将宏合并到文件名中，可以动态地包含相关信息，例如标识符、时间戳和消息头信息，从而为每个文件提供有价值的上下文。这有助于确保文件名反映对组织重要的详细信息。
    </p>

    <p>{siteName} 支持这些宏，它们都使用以下语法：<code>%Macro%</code>。</p>

    <table>
      <thead>
        <tr><th>宏</th><th>描述</th></tr>
      </thead>
      <tbody>
        <tr><td>ConnectorID</td><td>替换为端口的 ConnectorID。</td></tr>
        <tr><td>Ext</td><td>替换为端口当前正在处理的文件的文件扩展名。</td></tr>
        <tr><td>Filename</td><td>替换为端口当前正在处理的文件的文件名（包括扩展名）。</td></tr>
        <tr><td>FilenameNoExt</td><td>替换为端口当前正在处理的文件的文件名（不带扩展名）。</td></tr>
        <tr><td>MessageId</td><td>计算端口输出的消息的 MessageId。</td></tr>
        <tr><td>RegexFilename:<em>pattern</em></td><td>将正则表达式模式应用于端口当前正在处理的文件的文件名。</td></tr>
        <tr><td>Header:<em>headername</em></td><td>替换为端口正在处理的当前消息的目标消息头（<code>headername</code>）的值。</td></tr>
        <tr><td>LongDate</td><td>以常规格式计算系统的当前日期时间（例如，2024 年 1 月 24 日星期三）。</td></tr>
        <tr><td>ShortDate</td><td>以 yyyy-MM-dd 格式计算系统的当前日期时间（例如 2024-01-24）。</td></tr>
        <tr><td>DateFormat:<em>format</em></td><td>以指定格式（<code>format</code>）计算系统的当前日期时间。有关可用的日期时间格式，请参阅 <a href="/26.2/self-hosted/zh/scripting/value-formatters/date-formatters#date-formats-with-literal-characters">示例日期格式</a>。</td></tr>
        <tr><td>Vault:<em>vaultitem</em></td><td>计算指定保管库项目的值。</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>与端口资源分配相关的设置。</em></p>
    <table>
      <thead>
        <tr>
          <th>设置</th>
          <th>描述</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>最大工作线程数</strong></td>
          <td>此端口上处理文件时从线程池中消耗的最大工作线程数。如果设置，则会覆盖 <a href="/26.2/self-hosted/zh/getting-started/administration/settings/advanced-settings">高级设置</a> 页面的 <a href="/26.2/self-hosted/zh/getting-started/administration/settings/performance-settings">性能设置</a> 部分的默认设置。</td>
        </tr>
        <tr>
          <td><strong>最大文件数</strong></td>
          <td>分配给端口的每个线程发送的最大文件数。如果设置，则会覆盖 <a href="/26.2/self-hosted/zh/getting-started/administration/settings/advanced-settings">高级设置</a> 页面的 <a href="/26.2/self-hosted/zh/getting-started/administration/settings/performance-settings">性能设置</a> 部分的默认设置。</td>
        </tr>
      </tbody>
    </table>
  </>;

export const siteNameShort = "知行之桥";

export const siteName = "知行之桥";

PDF 端口支持使用 PDF 模板从 XML 生成丰富的可视化业务表单作为 PDF 文档。

## 核心功能

* 支持通过基于模板的字段映射，从 XML 输入生成 PDF 表单
* 支持多页输出、选择性页面生成以及条形码字段集成
* 支持 Code39、Code128、GS1-128 和 QR 码等条形码类型，并具备高级配置选项

## 概述

PDF 端口将 XML 输入转换为 PDF 输出。XML 元素名称与 PDF 模板中的表单字段名称匹配。每个 XML 元素的值会填入相应的表单字段，以生成 PDF 输出文件。

## 端口配置

本节包含所有可配置的端口属性。

### 设置选项卡

#### 配置

\_与端口核心操作相关的设置。

| 设置        | 说明                                                                                                          |
| --------- | ----------------------------------------------------------------------------------------------------------- |
| **端口 ID** | 端口的静态唯一标识符。                                                                                                 |
| **端口类型**  | 显示端口名称及其功能说明。                                                                                               |
| **端口说明**  | 可选字段，用于自由描述端口及其在工作流中的角色。                                                                                    |
| **模板文件**  | 用作输出模板的 PDF 文件。此文件必须具有名称与传入 XML 数据匹配的表单字段。这些字段还必须按照端口生成的所有 PDF 文件所需的格式排列。下面的[示例](#示例)显示了 XML 和模板文件如何协同生成输出。 |

#### 其他设置

| 设置         | 说明                                                            |
| ---------- | ------------------------------------------------------------- |
| **本地文件方案** | 为端口输出的消息分配文件名的方案。可以在文件名中使用宏，动态包含标识符和时间戳等信息。有关更多信息，请参见[宏](#宏)。 |

### 高级选项卡

#### 其他设置

| 设置       | 说明                                                                                                                                      |
| -------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| **处理延迟** | 放入**交易**选项卡的文件延迟处理的时长（秒）。这是一个旧版设置。最佳实践是[使用 File 端口](../flows/designing-a-flow#interacting-with-the-local-file-system)管理本地文件系统，而不是使用此设置。 |

#### 消息

<Message />

#### 日志

<Logging />

#### 其他设置

<MiscConnector />

### 自动化选项卡

#### 自动化设置

\_与端口自动处理文件相关的设置。

| 设置     | 说明               |
| ------ | ---------------- |
| **发送** | 到达端口的消息是否会被自动处理。 |

#### 性能

<Performance />

### 告警选项卡

<AlertsTab />

### SLA 选项卡

<SlasTab />

## 生成 PDF 文档

PDF 端口读取 XML 输入文件，并使用这些 XML 文件中的数据生成与[设置选项卡](#设置选项卡)中指定的**模板文件** PDF 文档匹配的 PDF 文档。这些 XML 输入文件的结构应与下面描述的结构或下一节中描述的[旧结构](#旧-xml-格式)匹配。

### XML 格式

下面是一个 XML 输入文件示例：

```xml theme={null}
<Items>
  <PDF>
    <FormField1>Some data</FormField1>
    <BarcodeField type="code39">>5789337490548932</BarcodeField>
  </PDF>
</Items>
```

如上例所示，XML 应与以下结构匹配：

* 根目录下有一个 *Items* 元素
* 一个 *PDF* 子元素代表一个 PDF 文档
* 在 *PDF* 元素内，每个元素与要动态填充数据的表单字段名称匹配

每个表单字段的名称（即 *PDF* 元素内元素使用的名称）来自**模板文件** PDF 文档。此模板中用于标记表单字段的值应作为元素名称，以确保正确的数据注入到生成 PDF 的相应字段中。

#### 多页输出

如果模板文件 PDF 包含多个页面，则端口在处理 XML 输入文件时会自动生成适当数量的页面。此外，也可以从单个 XML 文件生成模板文件的多个副本，此时附加副本会作为同一输出文件的多个 PDF 页面追加。

要将模板文件的多个副本生成到多页输出中，只需重复根 *Items* 元素的直接子元素 *PDF*。此位置的每个 *PDF* 元素都被视为模板文件的单独实例，因此应包含填写模板所需的所有命名表单字段值。

#### 输出页面子集

如果模板文件 PDF 包含多个页面，则端口支持通过在 XML 输入文件中指定相应页面来生成这些模板页面的子集。输入文档根目录中的 *Items* 元素接受 *pages* 属性，该属性包含逗号分隔的页码列表（从零开始计数），用于指定输出中应包含的页面。

例如，如果模板文件包含 4 页，并且输出中只应包含第一页和最后一页，则 XML 输入文件如下所示：

```xml theme={null}
<Items pages="0,3">
  <PDF>
    <FormField1>Some data</FormField1>
  </PDF>
</Items>
```

### 条形码

条形码字段（应包含条形码数据的表单字段）的处理方式与其他表单字段相同：条形码字段在 PDF 模板中有一个标签，该标签应作为输入 XML 中的元素名称。此外，条形码字段应具有 *type* 属性，用于确定要生成的条形码类型。端口支持四种条形码类型：

* code39
* code128
* gs1128
* qrcode

然后，将条形码的数字数据作为相应命名元素的 XML 值提供。

#### 高级条形码配置

除了在 XML 输入文件中指定条形码类型外，还可以直接在 PDF 模板文件中配置条形码。创建和编辑用于保存条形码的表单字段时，可以将配置信息添加到字段工具提示中，以影响生成的条形码。此配置信息应始终采用以下格式：

`$$parameter1:value,parameter2:value$$`

条形码支持以下参数：

* **barcode**：条形码类型（使用上一节所述的 *type* 属性时冗余）
* **qrcodeversion**：当条形码类型设置为 *qrcode* 时 QR 码的版本
* **eclevel**：使用 QR 码时的纠错级别。可接受的值为 *L*（低）、*M*（中）、*Q*（四分位）和 *H*（高）
* **quietzone**：条形码周围的空白缓冲区。该值应为整数，表示最小条形尺寸的倍数（建议值为 10 或更高）

以下参数不常用，仅应在条形码有特殊要求时使用：

* **heightnarrowratio**：最窄条相对于条形码高度的宽度；必须指定为高度为 1 的比率（例如 '0.05' 表示 1/20）
* **widenarrowratio**：最窄条相对于最宽条宽度的宽度；必须指定为最宽条为 1 的比率（例如 '0.2' 表示 1/5）
* **spacebarratio**：条形码中空白相对于条形宽度的宽度；必须指定为条形宽度为 1 的比率（默认值为 1）

## 示例

下面是一个示例 XML 输入文件、PDF **模板文件** 以及生成的 PDF 输出。

<Note>下面的模板文件图像来自 Adobe Pro 表单编辑器，其中显示每个表单字段的名称。请记住，模板文件中的字段名称必须与 XML 中的元素标签匹配。</Note>

### 输入 XML

```xml theme={null}
<Items>
  <PDF>
    <From1>WAREHOUSE 5B</From1>
    <To1>CLEARING HOUSE 14C</To1>
    <CarrierRoutingBarcode type="code39">5789337490548932</CarrierRoutingBarcode>
    <CarrierRoutingNumber>5789337490548932</CarrierRoutingNumber>
    <CarrierName>Fedex</CarrierName>
    <PRO_num>12345</PRO_num>
    <BOL_num>54321</BOL_num>
    <PO_num>87E112CA</PO_num>
    <ProductID_num>EE12FUZZY</ProductID_num>
    <Quantity>4</Quantity>
    <POBarcode type="code39">99123445215586</POBarcode>
    <PO_num_2>99123445215586</PO_num_2>
    <Carton_num>1</Carton_num>
    <Carton_total>1</Carton_total>
    <LotID>8821445</LotID>
    <SSCCNumber>2709667490538981</SSCCNumber>
    <SSCCBarcode type="code39">2709667490538981</SSCCBarcode>
  </PDF>
</Items>
```

### 模板文件

<img src="https://mintcdn.com/qiao/bVtjD3fvHFZBo1vE/public/images/label_1010_screenshot.png?fit=max&auto=format&n=bVtjD3fvHFZBo1vE&q=85&s=4f140a859da1227a46af285e03b1a516" alt="PDF 模板" width="692" height="748" data-path="public/images/label_1010_screenshot.png" />

### 输出

<img src="https://mintcdn.com/qiao/bVtjD3fvHFZBo1vE/public/images/label_1010_filled.png?fit=max&auto=format&n=bVtjD3fvHFZBo1vE&q=85&s=416e10717a99fd5a07a0651fb8266b5c" alt="PDF 示例" width="656" height="707" data-path="public/images/label_1010_filled.png" />

## 旧 XML 格式

除了[生成 PDF 文档](#生成-pdf-文档)中描述的 XML 格式外，端口还支持旧的 XML 输入文件结构，以保持向后兼容。知行软件建议你在设计新工作流时使用上一节中描述的语法。

以下是旧 XML 格式示例：

```xml theme={null}
<Items>
	<Item name="BillAddressLine1">Wayne Tech Plant 1</Item>
	<Item name="BillAddressLine2">100 Wayne Ave.</Item>
	<Item name="BillAddressLine3">Chapel Hill, NC 27514</Item>
	<Item name="ShipAddressLine1">Same as billing address</Item>
</Items>
```

在此结构中，根 *Items* 元素的所有子元素都应命名为 *Item*，并且 *name* XML 属性应与 PDF 模板文件中的表单字段名称匹配。前几节中描述的相同 XML 属性也可用于旧格式（例如用于指定条形码字段的 *type*，以及用于生成输出页面子集的 *pages*）。

## 宏

<MacrosTable />

### 示例s

<MacrosExamples />