跳转到内容
Developer Portal

工作流步骤类型

此模块允许您创建自定义工作流步骤类型，以扩展 Crowdin Enterprise 中默认工作流步骤列表。 安装此应用后，新的工作流步骤类型将在工作流编辑器中可用，可将其添加到工作流和模板中，从而实现更高程度的自定义和灵活性。

访问权限

Section titled “访问权限”

您可以将此模块的访问权限授予以下用户类别之一：

  • 仅限组织管理员
  • 组织项目中的所有用户
  • 选定用户

结构

Section titled “结构”
manifest.json
{
  "modules": {
    "workflow-step-type": [
      {
        "key": "custom-workflow-step",
        "name": "Custom Workflow Step",
        "logo": "/logo.png",
        "description": "A sample custom step for Crowdin Enterprise workflows",
        "boundaries": {
          "input": {
            "title": "Input Strings",
            "ports": [
              "untranslated",
              "translated",
              "approved",
              "all",
              "false",
              "true",
              "skipped",
              "initial"
            ]
          },
          "outputs": [
            {
              "title": "Processed Strings",
              "port": "translated"
            },
            {
              "title": "Unprocessed Strings",
              "port": "untranslated"
            }
          ]
        },
        "editorMode": "comfortable",
        "updateSettingsUrl": "/settings/custom-workflow-step",
        "deleteSettingsUrl": "/delete/custom-workflow-step",
        "url": "/workflow-step/custom-workflow-step",
        "environments": [
          "crowdin-enterprise"
        ]
      }
    ]
  }
}

属性

Section titled “属性”
key

类型： string

必填： 是

描述： Crowdin 应用内的模块标识符。

name

类型： string

必填： 是

描述： 模块的可读名称。

logo

类型： string

必填： 是

描述： 自定义 AI 徽标的相对 URL，将显示在 Crowdin Enterprise 界面中。
建议分辨率为 48x48 像素。

description

类型： string

必填： 是

描述： 模块功能的人类可读说明。
该描述将在 Crowdin Enterprise 界面中显示。

boundaries

类型： object

必填： 是

描述： 定义工作流步骤的输入和输出端口，决定字符串进入和退出步骤的方式。

boundaries.input

类型： object

必填： 是

描述： 指定工作流步骤输入数据的属性，包括可用端口。

boundaries.input.title

类型： string

必填： 是

描述： 工作流步骤输入部分的标题。

boundaries.input.ports

类型： array

必填： 是

允许值： untranslated、translated、approved、all、false、true、skipped、initial

描述： 定义此工作流步骤可处理的字符串状态。

boundaries.outputs

类型： array

必填： 是

描述： 指定工作流步骤的可能输出，决定已处理字符串的后续流向。

boundaries.outputs.[]

类型： object

必填： 是

描述： 定义工作流步骤的输出。 数组中的每个对象包含：

  • title（string）– 工作流步骤输出部分的标题。
  • port（string）– 用于连接输出的端口类型。
editorMode

类型： string

必填： 否

允许值： side-by-side、comfortable、multilingual

描述： 定义此工作流步骤的 Crowdin Enterprise 编辑器模式。

updateSettingsUrl

类型： string

必填： 否

描述： 用于在用户在工作流编辑器中保存更改后发送已更新工作流步骤设置的相对 URL。 如果自定义工作流步骤具有配置，则使用此项。

deleteSettingsUrl

类型： string

必填： 否

描述： 用于在工作流编辑器中删除工作流步骤的相对 URL。

url

类型： string

必填： 否

描述： 用于配置工作流步骤设置的 iframe 的相对 URL。

environments

类型： string

允许值： crowdin-enterprise

描述： 可安装模块的环境集合。
此参数在跨产品的应用程序中必需。

应用与 Crowdin 之间的通信

Section titled “应用与 Crowdin 之间的通信”

工作流步骤类型模块依赖 Webhook 和 API 方法与 Crowdin Enterprise 进行通信。 包含此模块的应用还必须定义 Webhook 模块，以接收与字符串相关的事件（即 string.status_on_step.recalculation_triggered）并进行相应处理。

从 Crowdin 接收 Webhook 事件

Section titled “从 Crowdin 接收 Webhook 事件”

每当字符串到达应用提供的自定义工作流步骤时，Crowdin Enterprise 会定期向应用的 Webhook 模块发送批量 Webhook 负载。

此负载包含 string.status_on_step.recalculation_triggered 事件，并包含所有需要外部处理的相关字符串（例如，基于 AI 的校对）。

string.status_on_step.recalculation_triggered 事件的 Webhook 负载示例：

{
  "events": [
    {
      "event": "string.status_on_step.recalculation_triggered",
      "stringStatus": {
        "status": "NEED_PROCESS",
        "output": "",
        "originEvent": "string.added",
        "organizationId": "200007777",
        "translation": {
          "id": 1106423,
          "identifier": "058eb6ea2bdcc79a6a7208783c8bfb50",
          "key": "string_1",
          "text": "Not all videos are shown to users. See more",
          "type": "text",
          "context": "string_1",
          "maxLength": "50",
          "isHidden": false,
          "isDuplicate": false,
          "masterStringId": null,
          "revision": 1,
          "hasPlurals": false,
          "labelIds": [],
          "url": "https://umbrella.crowdin.com/editor/173/743/en-et#1106423",
          "createdAt": "2024-10-29T10:47:13+00:00",
          "updatedAt": null,
          "file": {
            "id": 743,
            "name": "umbrella_app.xml",
            "title": null,
            "type": "android8",
            "path": "/umbrella_app.xml",
            "status": "active",
            "revision": "1",
            "branch": {
              "id": null
            },
            "directory": {
              "id": null
            },
            "project": null
          },
          "project": {
            "id": 173,
            "userId": 1,
            "sourceLanguageId": "en",
            "targetLanguageIds": [
              "uk",
              "et"
            ],
            "identifier": "d3026ae4cff9820bc140a210d23b35ad",
            "name": "Project Name",
            "createdAt": "2024-10-25T14:37:47+00:00",
            "updatedAt": "2024-10-25T14:37:47+00:00",
            "lastActivity": "2025-01-30T09:32:58+00:00",
            "description": "",
            "url": "https://umbrella.crowdin.com/u/projects/173",
            "cname": null,
            "languageAccessPolicy": null,
            "visibility": null,
            "publicDownloads": null,
            "logo": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAJY...<truncated>...BBQmCC",
            "isExternal": false,
            "externalType": null,
            "hasCrowdsourcing": false,
            "groupId": 1
          }
        },
        "sourceLanguage": {
          "id": "en",
          "name": "English",
          "editorCode": "en",
          "twoLettersCode": "en",
          "threeLettersCode": "eng",
          "locale": "en-US",
          "androidCode": "en-rUS",
          "osxCode": "en.lproj",
          "osxLocale": "en",
          "textDirection": "ltr",
          "dialectOf": null
        },
        "affectedLanguage": {
          "id": "et",
          "name": "Estonian",
          "editorCode": "et",
          "twoLettersCode": "et",
          "threeLettersCode": "est",
          "locale": "et-EE",
          "androidCode": "et-rEE",
          "osxCode": "et.lproj",
          "osxLocale": "et",
          "textDirection": "ltr",
          "dialectOf": null
        },
        "workflowStep": {
          "id": 1035,
          "title": "AI Review",
          "type": "Application",
          "languages": [],
          "applicationModule": {
            "applicationIdentifier": "custom-workflow-step",
            "moduleKey": "review-step"
          }
        },
        "user": {
          "id": "1",
          "username": "john_smith",
          "fullName": "John Smith",
          "avatarUrl": "https://avatar-url.com/avatar/1/small/1bc07ce78f415990547ba1b4fd5ac8a8_default.png"
        }
      }
    }
  ]
}

处理字符串并更新其状态

Section titled “处理字符串并更新其状态”
  1. 应用逻辑 - 应用根据其内部逻辑处理收到的字符串（例如，将其发送到 AI 服务或执行自定义验证）。
  2. 通过 API 更新字符串状态 - 处理完成后，应用调用 Crowdin Enterprise 的私有 API 更新自定义工作流步骤上每个字符串的状态。 此操作将字符串路由到相应的工作流步骤输出。

API 方法

Section titled “API 方法”

以下是用于管理自定义工作流步骤上字符串状态的 API 方法。 更新字符串状态方法是必填的，因为它会最终确定字符串状态并将其路由到正确的工作流输出。 另一个可用方法获取当前字符串状态是可选的，但可帮助处理应用中的边界情况或高级逻辑。

更新字符串状态

使用此端点更新已到达您的自定义工作流步骤的字符串的状态。

Crowdin Enterprise
PATCH https://{organization_domain}.api.crowdin.com/api/v2/projects/{projectId}/workflow-steps/{stepId}/languages/{languageId}/status
参数必填类型描述
organization_domain是string您的 Crowdin Enterprise 组织域名。
projectId是integer您的 Crowdin Enterprise 项目的数字标识符。
stepId是integer自定义工作流步骤的数字标识符。
languageId是string目标语言代码。

请求正文（示例）：

[
  {
    "op": "replace",
    "path": "/1106423/output",
    "value": "translated"
  },
  {
    "op": "replace",
    "path": "/1106430/output",
    "value": "approved"
  }
]

响应示例：

{
  "data": [
    {
      "data": {
        "stringId": 1106423,
        "languageId": "uk",
        "stepId": 889,
        "status": "DONE",
        "output": "true"
      }
    },
    {
      "data": {
        "stringId": 1106430,
        "languageId": "uk",
        "stepId": 889,
        "status": "DONE",
        "output": "true"
      }
    }
  ]
}
获取当前字符串状态

获取自定义工作流步骤上字符串的当前状态。

Crowdin Enterprise
GET https://{organization_domain}.api.crowdin.com/api/v2/projects/{projectId}/workflow-steps/{stepId}/languages/{languageId}/status
参数必填类型描述
organization_domain是string您的 Crowdin Enterprise 组织域名。
projectId是integer您的 Crowdin Enterprise 项目的数字标识符。
stepId是integer自定义工作流步骤的数字标识符。
languageId是string目标语言代码。

响应示例：

{
  "data": [
    {
      "data": {
        "stringId": 1106423,
        "languageId": "uk",
        "stepId": 889,
        "status": "DONE",
        "output": "true"
      }
    },
    {
      "data": {
        "stringId": 1106430,
        "languageId": "uk",
        "stepId": 889,
        "status": "DONE",
        "output": "true"
      }
    }
  ]
}

在工作流编辑器中配置工作流步骤

Section titled “在工作流编辑器中配置工作流步骤”

用户可以在 Crowdin Enterprise 工作流编辑器中配置或删除自定义工作流步骤：

  • 更新设置（updateSettingsUrl）

    • 当用户在工作流编辑器中更改步骤设置后点击保存时，Crowdin Enterprise 会向清单中定义的 updateSettingsUrl 发送 POST 请求。
    • 应用返回 2XX 状态以确认已成功处理更新后的配置。

  • 删除步骤（deleteSettingsUrl）

    • 当用户在工作流编辑器中删除步骤时，Crowdin Enterprise 会向 deleteSettingsUrl 发送 DELETE 请求。
    • 应用可安全删除与已删除工作流步骤相关的所有已存储设置，并返回 2XX 状态以确认成功。

在您的应用中实现设置界面

Section titled “在您的应用中实现设置界面”

如果工作流步骤通过界面提供任何设置，则需要实现工作流步骤配置的验证和保存功能。

验证方法

Section titled “验证方法”

在您的自定义工作流步骤的 iframe 界面中，需要实现一个用于验证步骤配置的方法：

window.formRef = {
  validateForm: () => {
    // Validate settings form
    return true;
  },
}

每当 Crowdin Enterprise 在保存前检查设置是否有效时，都会调用此方法。

保存设置

Section titled “保存设置”

要保存工作流步骤的配置，请使用以下方法：

window.currentFormData = settings;
AP.formDataUpdated(settings)；
本页面对你有帮助吗？