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

# TSV 端口

> 将制表符分隔值 (TSV) 文件转换为 XML，并能从 XML 生成 TSV 文件，支持可配置的分隔符、编码和列映射。

export const format_1 = "TSV"

export const format_0 = "TSV"

export const DelimitedXmlMapTransformation = ({format = "CSV"}) => <>
    <p>许多数据转换工作流将 {format} 端口与 <a href="/26.2/self-hosted/zh/connectors/xml-map/xml-map">XML Map 端口</a>结合使用。</p>

    <p>通常，数据以 {format} 格式进入工作流，并以其它某种格式（例如，数据库插入、EDI 文件或插入 CRM 或 ERP 数据源）退出工作流，反之亦然。知行之桥使用一种简化的方法来满足这些数据转换的要求：</p>

    <ul>
      <li>将输入格式建模为 XML</li>
      <li>将输出格式建模为 XML</li>
      <li>使用 XML Map 端口在输入 XML 和输出 XML 之间进行映射</li>
    </ul>

    <p>因此，{format} 端口常与工作流中的 XML Map 端口相邻：</p>

    <ul>
      <li>当 {format} 文件是流程的<em>输入</em>时，{format} 端口将 {format} 文件转换为 XML，然后将该 XML 传递到 XML Map 端口进行转换</li>
      <li>当 {format} 文件是流程的<em>输出</em>时，{format} 端口从 XML Map 端口接收 XML 并将其转换为 {format} 文件</li>
    </ul>

    <p>XML Map 端口需要用于映射输入/源和映射输出/目标的示例 XML 结构。可以使用 <a href="#sample-files-tab">示例文件</a> 选项卡上传示例文件。然后，将 {format} 端口连接到流程中的 XML Map 端口。此连接可以双向进行：入站到 XML Map 端口，或从 XML Map 端口出站。</p>

    <p>XML Map 端口会自动检测测试文件的结构。根据放置 {format} 端口的位置，文件将显示在 XML Map 端口的 <strong>源文件</strong> 或 <strong>目标文件</strong> 下拉菜单中。</p>

    <Note>此测试文件的结构应代表未来的文件。换句话说，由 {format} 端口（然后是 XML Map 端口）处理的所有 {format} 文件应具有与测试文件相同的列。可能需要设置多个 {format} 端口和多个 XML Map 端口来处理不同的 {format} 结构。</Note>
  </>;

export const DelimitedPrintView = ({format = "CSV", printPreviewImage}) => {
  const img = printPreviewImage || `${format.toLowerCase()}_print_preview.png`;
  return <>
      <p>在端口的 <strong>交易</strong> 选项卡上查看 {format} 文档时，可以以打印预览格式或原始数据格式进行查看。默认情况下，文档以预览格式显示，如下图所示：</p>

      <img src={`/public/images/${img}`} width="800" />

      <p>预览格式以易于阅读的布局显示数据。使用右上角的 <strong>原始视图</strong>（Raw View）开关可以查看未格式化的文档。</p>
    </>;
};

export const DelimitedAutomationSettings = () => <>
    <p><em>与端口自动处理文件相关的设置。</em></p>

    <table>
      <thead>
        <tr><th>设置</th><th>描述</th></tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>发送 (Send)</strong></td>
          <td>到达端口的消息是否自动进行处理。</td>
        </tr>
      </tbody>
    </table>
  </>;

export const DelimitedProcessingDelay = () => <table>
    <thead>
      <tr><th>设置</th><th>描述</th></tr>
    </thead>
    <tbody>
      <tr>
        <td><strong>延迟处理</strong></td>
        <td>放置在<strong>交易</strong>选项卡中的文件的处理被延迟的时间量（以秒为单位）。这是一个遗留设置。最佳实践是<a href="/26.2/self-hosted/zh/flows/designing-a-flow#interacting-with-the-local-file-system">使用 File 端口</a>来管理本地文件系统，而不是此设置。</td>
      </tr>
    </tbody>
  </table>;

export const DelimitedSampleFiles = () => <>
    <p><em>上传示例文件可以方便地在任何连接的 CSV Map 或 XML Map 端口中进行映射。</em></p>

    <p>使用 <strong>示例文件</strong> 选项卡生成用于 <a href="/26.2/self-hosted/zh/connectors/map">CSV Map</a> 或 <a href="/26.2/self-hosted/zh/connectors/xml-map/xml-map">XML Map</a> 端口的源或目标 XML 模板。单击 <strong>添加示例文件</strong>。</p>

    <ol>
      <li>如果您已有反映数据预期格式和结构的示例文件，请选择 <strong>文件上传</strong> 并浏览到您的文件。或者，选择 <strong>手动创建</strong> 直接在应用程序中创建文件。如果您选择 <strong>手动创建</strong>，请为示例文件命名。单击 <strong>下一步</strong>。</li>
      <li>如果您浏览到现有文件，<strong>查看文件</strong> 选项卡将填充其内容。如果您选择手动创建文件，请在此选项卡上输入示例数据。单击 <strong>下一步</strong>。</li>
      <li><strong>翻译和预览</strong> 选项卡显示将示例数据转换为 XML 的预览。当您对示例满意时，单击 <strong>添加</strong>。</li>
    </ol>
  </>;

export const DelimitedOtherSettings = () => <table>
    <thead>
      <tr><th>设置</th><th>描述</th></tr>
    </thead>
    <tbody>
      <tr>
        <td><strong>本地文件方案</strong></td>
        <td>用于为端口输出的消息分配文件名的方案。可以在文件名中动态使用宏来包含标识符和时间戳等信息。有关更多信息，请参阅 <a href="#macros">宏</a>。</td>
      </tr>
      <tr>
        <td><strong>行分隔符</strong></td>
        <td>用于表示行结束的字符序列。默认情况下，这由系统决定，但可以使用此设置覆盖系统行为。使用 <code>CR</code> 或 <code>\r</code> 表示回车符，使用 <code>LF</code> 或 <code>\n</code> 表示换行符。</td>
      </tr>
    </tbody>
  </table>;

export const DelimitedConnectorSettings = ({format = "CSV"}) => {
  const lower = format.toLowerCase();
  return <table>
      <thead>
        <tr><th>设置</th><th>描述</th></tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>存在列标题</strong></td>
          <td>{format} 文件是否包含一行标题，为文件中的值提供名称或上下文。</td>
        </tr>
        <tr>
          <td><strong>记录名称</strong></td>
          <td>
            转换为 XML 时表示 {format} 文件中的一行的元素名称。可以使用以下宏：%ConnectorID%、%FilenameNoExt%、%RegexFilename:% 和 %Header:%。有关更多详细信息，请参阅 <a href={`#converting-${lower}-to-xml`}>将 {format} 转换为 XML</a>。
          </td>
        </tr>
      </tbody>
    </table>;
};

export const DelimitedOverview = ({format = "CSV"}) => {
  const lower = format.toLowerCase();
  return <>
      <p>XML 是知行之桥用于处理工作流中数据的主要格式。因此，将 {format} 文件转换为 XML 是作为工作流中进一步处理的过渡步骤，或者在操作 XML 之后将 XML 转换为 {format} 文件也很有用。这两个操作都可以通过 {format} 端口来完成。</p>

      <p>更多关于 {format} 转换为 XML 的信息，请参考 <a href={`#converting-${lower}-to-xml`}>{format} 转 XML</a> 部分；将 XML 转换为 {format} 的详细信息，请参考 <a href={`#converting-xml-to-${lower}`}>XML 转 {format}</a> 部分。</p>
    </>;
};

export const NameDescription = ({extraRows}) => <table>
    <thead>
      <tr>
        <th>设置</th>
        <th>描述</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><strong>端口 Id</strong></td>
        <td>端口的静态、唯一标识符。</td>
      </tr>
      <tr>
        <td><strong>端口类型</strong></td>
        <td>显示端口类型及其用途的描述。</td>
      </tr>
      <tr>
        <td><strong>端口描述</strong></td>
        <td>一个可选字段，用于提供端口及其在流中的角色的自由格式描述。</td>
      </tr>
      {extraRows}
    </tbody>
  </table>;

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>
  </>;

TSV 端口可将制表符分隔值 (TSV) 文件转换为 XML，并能从 XML 生成 TSV 文件。

## 核心功能

* 双向 TSV/XML 转换，支持可配置的分隔符和编码
* 具备表头检测和自定义列映射能力
* 支持多种字符编码及特殊字符处理

## 概述

<DelimitedOverview format="TSV" />

## 端口配置

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

### 设置选项卡

#### 配置

*与端口 ID 和描述相关的设置。*

<NameDescription />

#### 端口设置

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

<DelimitedConnectorSettings format="TSV" />

#### 其他设置

*先前类别中未包含的设置。*

<DelimitedOtherSettings />

### 样本文件选项卡

<DelimitedSampleFiles />

### 高级设置选项卡

<DelimitedProcessingDelay />

#### 消息

<Message />

#### 日志

<Logging />

#### 杂项设置

<MiscConnector />

### 自动化选项卡

#### 自动化设置

<DelimitedAutomationSettings />

#### 性能

<Performance />

### 告警选项卡

<AlertsTab />

### SLA 选项卡

<SlasTab />

## TSV 转换为 XML

当 {format_0} 文件转换为 XML，得到的 XML 将包含以下结构：

```xml theme={null}
<Items>
  <Record>
    <field_0></field_0>
    <field_1></field_1>
    <field_2></field_2>
  </Record>
</Items>
```

原始文件中的每一行（记录）都成为根元素 `Items` 的子元素。所有记录元素的名称由[端口设置](#connector-settings)中设置的 **记录名称** 选项确定。每个记录元素都有与输入文件每行中的值相对应的子元素。

某些 {format_0} 文件包含一行消息头信息，为文件中的值提供上下文。当启用 **存在列标题** 设置时，将解析此标题行，并将解析后的标题用作值元素（记录元素的子元素）的元素名称。否则，值元素将被赋予通用名称，例如 `field_0`、`field_1` 等。

## XML 转换为 TSV

要将 XML 转换为 {format_1} 文件，输入 XML 必须具有“平面”结构。这意味着，忽略 `Items` 根元素，XML 结构的深度为 2。例如：

```xml theme={null}
<Items>
  <film>
    <title>Citizen Kane</title>
    <year>1941</year>
    <runtime>119</runtime>
  </film>
  <film>
    <title>Sharknado</title>
    <year>2013</year>
    <runtime>86</runtime>
  </film>
</Items>
```

XML 解释如下：

* 根元素的子元素在结果文件中被视为记录（行）
* 每个记录元素的子元素被视为每行中的值

如果启用 **存在列标题** 选项，则会将标题行插入到生成的 {format_1} 文件中，其中包含每个值元素的名称，以提供值的上下文。在上面的示例中，此标题行将由 `title`、`year` 和 `runtime` 组成。

## 打印预览

<DelimitedPrintView format="TSV" />

## TSV 转换：使用 XML Map 端口

<DelimitedXmlMapTransformation format="TSV" />

## 宏

<MacrosTable />

### 示例

<MacrosExamples />