概述
本“最佳实践”系列概述了 Workiva 平台数据管理套件中各种工件的推荐通用实践。请记住，这些只是一般性指导原则，可能需要根据具体、独特的用例进行调整。这些建议旨在帮助您改善工作区内的组织结构。让我们先来探讨一下这些命名规则。
连接、 链 和 环境的命名约定
链中的连接
在创建链式连接时，必须建立最佳命名约定，以确保清晰区分 各个环境。
- 连接器名称： 为连接器提供一个描述性名称，清楚地表明其用途和功能。
- 工作区类型： 指定连接器正在使用的工作区或项目。
- 连接器的环境： 明确标识连接器所对应的环境（例如，开发、生产）。
例子：
- SFTP 连接 | SEC 报告 | 非生产环境
- 描述： 在非生产环境（如开发、QA、沙箱等）中，为 SEC 报告工作区解决方案建立与 SFTP 服务器的连接。
- SFTP 连接 | SEC 报告 | 生产环境
- 描述： 在生产环境中建立与 SEC 报告工作区解决方案的 SFTP 服务器的连接。
这种命名规则便于在不同环境中轻松识别和管理连接。它确保特定环境中的 Chains 只与适当的源进行交互，从而增强安全性和可靠性。 非生产 连接可以在非生产、开发和测试环境中使用。
这种命名规则应始终如一地应用于所有连接，无论它们是核心连接还是高级连接。通过在不同环境中保持连接命名的一致性，您可以简化链的提升过程，并实现跨工作区的链的无缝执行。
链结产生器
在 Workiva 平台上构建链时，保持良好的命名规范至关重要。清晰一致的命名策略有助于更高效地浏览 Chains，尤其是在工作流程数量不断增长的情况下。本节概述了根据链的目的、来源系统、频率和工作流程层次结构命名链的最佳实践。
目的和来源系统
确定链条的目的
请思考以下问题来定义链条的目的：
- Chain 中使用的是哪种类型的数据？
- 该链能否跨多个流程使用（即，它是否是一条实用链）？
- 当前使用的数据源系统是什么？
频率
指定链的频率
命名链时，务必标明其运行频率，尤其是如果计划自动运行的话。我们建议遵循以下准则：
- 指明该链是否按需运行。
- 请具体说明该链条是按日、周、季度还是年运行。
层次结构
组织复杂的链式构建
在由多个工作流组成的链式构建中，通常会有一个顶级链，其中包含按顺序执行的多个子链。按编号命名规则对这些链进行排序。
编号命名规则示例：
1.0 顶级链1.1 执行数据集1.2 将数据加载到 Wdata 表中1.3 刷新传入连接
这种方法可以帮助用户快速识别工作流程中的操作顺序，并根据数字顺序自动组织工作区中的链。
链命名约定的实际示例
公用事业链
实用链是由多个其他工作流执行的常见工作流，例如 将数据加载到 Wdata 表中。为确保实用工具链在工作区顶部醒目显示，请考虑以下命名约定：
0.0 - [实用链名称] | [流程] | 实用链0.1 - [实用链名称] | [流程] | 实用链0.2 - [实用链名称] | [流程] | 实用链
源系统
“源系统”一词指的是数据的来源，它可以包括各种系统，例如 ERP（企业资源计划）、EPM（企业绩效管理）、HR（人力资源）和会计系统，或者它是基于文件的，例如来自 SFTP/FTP 的数据。
以下示例展示了三个源系统的组织结构：
- 工作日
- 1.0 - [链名称/流程] | Workday | [频率]
- 1.1 - [链名称/流程] | Workday | [频率]
- 1.2 - [链名称/流程] | Workday | [频率]
- 树液
- 2.0 - [链名称/流程] | SAP | [频率]
- 2.1 - [链名称/流程] | SAP | [频率]
- 2.2 - [链名称/流程] | SAP | [频率]
- Netsuite
- 3.0 - [链名称/进程] | Netsuite | [频率]
- 3.1 - [链名称/进程] | Netsuite | [频率]
- 3.2 - [链名称/进程] | Netsuite | [频率]
对于包含大量链的工作区，为了清晰和便于组织，请使用以下命名约定示例：
这种结构确保了清晰、一致的命名约定和组织，从而可以根据其流程和执行频率更容易地识别和管理实用程序链和源系统链。
环境命名约定
环境使您能够轻松地规划、测试和部署工作流程。这简化了将软件开发生命周期 (SDLC) 最佳实践应用于自动化流程的过程。创建环境时，我们建议使用以下简化的命名约定来清楚地标识每个 环境的用途。这有助于用户快速了解每个环境的预期用途。
环境类型和命名规则
- 开发（DEV）
- 用途：用于开发新的供应链和工艺流程。开发者可以在开发（DEV）环境中安全地进行创建和实验。
- 示例：
DEV
- 测试（或沙箱）
- 用途：专门用于测试和质量保证流程。质量保证团队可以在测试环境中进行审查和测试。
- 示例：
测试
- 生产（Production）
- 目的：适用于已经过测试、改进并准备在生产环境中部署的流程。
-
示例：
PROD
笔记
- 多个链可以具有相同的名称，但每个链都由称为 GUID
的唯一标识符来
区分。 - 每个工作区都有一个唯一的 ID（见 URL），因此多个工作区可以具有相同的名称。但我们不建议这样做，因为这可能会让用户感到困惑。
- Chains、Workspace 和 Workspace Environment 命名了所有支持的空间和 Workiva 标准字符集。
- 姓名长度：
- 链 名称的最大长度为100个字符。
注意： 复制链时，会自动添加字符“-- 复制”。如果由此产生的名称长度超过 100 个字符，则不会复制该链。 - 链式命令 （节点）名称最多可包含 255 个字符。
- 工作 区名称的最大长度为 50 个字符。
- 工作区环境 名称的最大长度为 25 个字符。
- 链 名称的最大长度为100个字符。
总结
使用这些简化的命名规则有助于保持结构化且易于导航的环境设置。它确保每个环境的用途都很明确，从而减少混乱，提高开发、测试和部署阶段的效率。