使用自定义函数包

通过包,您可以在Adobe Workfront Fusion中构建并运行自己的自定义逻辑,而无需离开Fusion界面。 当标准模块不能完全满足您的需要时,您可以使用函数来转换数据、进行计算、调用外部服务或封装要重复使用的例程。 然后,您可以对其进行测试、使其上线并从场景中使用它。

复杂的函数可能需要变量等资源和库等依赖项。 对于这些函数,您可以创建一个包,其中包含函数及其资源。

包可以包括:

  • 函数:在方案执行期间运行的逻辑。
  • 变量:包中的函数使用的可重用值,例如基本URL或API密钥。
  • 依赖项:函数可能依赖的外部库。
  • History:每个函数的早期版本均自动保存,可供您引用。

访问权限要求

展开可查看本文所述功能的访问权限要求。
table 0-row-2 1-row-2 2-row-2 layout-auto html-authored no-header
Adobe Workfront 包

任意 Adobe Workfront Workflow 包以及任意 Adobe Workfront 自动化和集成包

Workfront Ultimate

Workfront Prime 和 Select 包,且需额外购买 Workfront Fusion。

Adobe Workfront 许可证

标准

工作版或更高版本

产品
  • 如果您的组织使用的 Workfront Select 或 Prime 包不包含 Workfront 自动化和集成,则必须单独购买 Adobe Workfront Fusion。
  • 您必须拥有Adobe App Builder许可证才能使用自定义函数。

有关此表中信息的更多详细说明,请参阅文档中的访问权限要求

设置运行时环境连接

NOTE
这是一次性设置。

您的团队首次使用此功能时,必须设置运行这些功能的环境。 每个团队只能执行一次此操作。

  1. 单击左侧导航面板中的​ 包图标 选项卡。

    如果尚未设置环境,则会显示​ 未配置运行时环境 ​屏幕。

  2. 单击​初始化运行时

  3. 要输入默认名称以外的名称,请在​ 连接名称 ​字段中键入该名称。

  4. 选择此包将属于的Adobe App Builder项目:

    • 要选择现有项目,请开始键入项目名称,然后在此项目出现时将其选定。
    • 要创建新项目,请输入一个不存在的名称,然后单击​新建
    • 如果将此留空,Fusion将使用默认项目。
  5. 选择​继续

    Fusion完成了设置,您便可以创建包。

    您的环境将作为连接选项卡显示在页面顶部。

    环境作为连接选项卡

  6. (视情况而定)要添加其他环境,请单击加号图标,然后按照此部分中的说明操作。

  7. (视情况而定)要删除现有环境,请将鼠标悬停在环境连接选项卡上,并在出现​ X ​时单击它。

    note warning
    WARNING
    删除连接会断开Fusion与该环境的连接。 通过此连接,其中的包在Fusion中不再可用。

创建并打开资源包

  1. 单击左侧导航面板中的​ 包图标 选项卡。

  2. 选择要使用的连接的选项卡。

  3. 单击​创建包

  4. 输入名称并选择​创建

    包会自动打开。

  5. 若要稍后重新打开包,请从“包”列表中选择该包,然后选择​查看

  6. 要删除包,请从“包”列表中选择它,然后选择​删除

    note warning
    WARNING
    删除包将永久删除该包及其中的所有内容。

管理资源包

打开的软件包分为四个区域:

  • 函数:创建、测试和发布该函数。
  • 变量:配置函数的变量。
  • 依赖项:为此函数安装依赖项,如外部库。
  • 历史记录:查看每个函数的早期版本。

除了这四个区域外,顶部的“存储”计量器还可显示已使用的空间量。 每个包的总大小限制为​21 MB。 这包括函数、变量和依赖项,包括保存的版本。

如果空间不足,我们建议删除未使用的依赖项、变量或旧版本以释放一些空间。

要返回包列表,请选择包名称旁边的“上一步”箭头。

函数

函数​区域显示包中函数的列表,包括函数的名称、状态、大小以及预期的输入数。

查看和管理函数列表

要筛选“函数”列表,请执行以下操作:

  1. 通过单击​全部草稿​或​ 已发布 ​按状态筛选。
  2. 使用搜索栏搜索特定功能。

函数可以具有草稿或已发布状态。

  • 草稿:处于草稿状态的函数正在进行中。 您可以随意编辑和测试,而不会影响实时数据。
  • 已发布:已发布的版本处于活动状态。 您的方案运行函数的已发布版本。

使用草稿可让您安全地做出更改。 您可以优化和测试草稿,然后在满意时发布草稿。

状态
它的含义
Published
存在实时版本。
草稿
函数仍在进行中,或者实时函数具有您尚未发布的更改。

在“包”区域创建或编辑函数

  1. 单击左侧导航面板中的​ 包图标 选项卡。

  2. 在​ 函数 ​区域,选择​创建函数

    单击现有函数旁边的复选框,然后在页面底部的操作栏中选择​编辑

  3. (视情况而定)如果要创建新函数,请在​ 新函数 ​字段中输入该函数的名称。

  4. (可选且有条件)要重命名现有函数,请单击函数名称旁边的编辑图标,然后输入新名称。

  5. 在​ 代码 ​选项卡上,输入函数逻辑。

    创建函数时,请考虑以下事项:

    • 函数必须在JavaScript中编写。
    • 您可以读取定义的输入、重复使用变量以及调用其他函数。
    • 键入内容时,将显示建议。
  6. 若要清除函数格式,请单击​美化

  7. (可选)在​ 参数 ​选项卡上,定义函数所需的输入。

    有关输入的信息,请参阅本文中的定义输入

  8. 在​ 测试 ​选项卡上,测试您的函数。

    有关说明,请参阅本文中的测试函数

  9. 若要将此函数另存为草稿,请单击​另存为草稿

    若要发布函数,请单击​发布

    note
    NOTE
    发布函数将清除其版本历史记录。 已发布的版本将成为当前的起点,并且不再保留早期的草稿版本。
定义输入

您可以使用​ 参数 ​选项卡描述函数每次运行时所需的信息。

  1. 单击左侧导航面板中的​ 包图标 选项卡。

  2. 在​ 函数 ​区域,选择​创建函数

    单击现有函数旁边的复选框,然后在页面底部的操作栏中选择​编辑

  3. 单击​ 参数 ​选项卡。

  4. 对于要添加的每个参数,单击​ 添加参数 ​并配置以下内容:

  • 名称:输入的名称
  • 标签:测试函数时显示的用户友好名称
  • 类型:数据类型,如文本、数字、true/false或结构化对象。
  • 必需:是否必须提供值。

这些输入将成为测试时您填写的字段,以及场景在运行函数时传递的值。

测试函数

我们建议在发布函数之前对其进行测试。

  1. 单击左侧导航面板中的​ 包图标 选项卡。

  2. 在​ 函数 ​区域,选择​创建函数

    单击现有函数旁边的复选框,然后在页面底部的操作栏中选择​编辑

  3. 单击​ 测试 ​选项卡。

  4. 为每个输入输入一个值。

  5. 运行函数:

    • 选择​ 测试草稿 ​以尝试您的工作进行中版本。
    • 选择​ 执行已发布 ​以运行实时版本。
  6. 查看结果,包括是否成功、耗时以及返回的输出结果。

NOTE
Execute Published​仅在函数发布后可用。

对实时函数进行更改

发布函数后,发布​按钮将变为菜单:

  • 重新发布 — 将您的最新草稿更改推送到实时版本。
  • 取消发布 — 使函数停止服务。 您的工作将保留为草稿,以便您能够重新开始。

删除函数

  1. 单击左侧导航面板中的​ 包图标 选项卡。
  2. 单击现有函数旁边的复选框,然后在页面底部的操作栏中选择​删除
WARNING
删除函数会完全删除该函数及其历史记录。 任何使用它的方案或函数都将停止工作。

变量

变量是您的函数可使用的可重用值,例如基本URL、帐户ID或API密钥。 将这些变量存储为变量意味着,您只需设置一个值一次,然后在一个位置更新它,而无需跨多个函数更新它。

创建或编辑变量

  1. 单击左侧导航面板中的​ 包图标 选项卡。

  2. 在​ 变量 ​选项卡上,选择​新建变量

    单击要编辑的变量旁边的​ 编辑 ​图标。

  3. 填写详细信息:

    • :输入函数用来引用该值的名称。

    要重命名此变量,请更改键值。

    • :输入要存储的值。
    • 类型:选择值类型是文本、数字、布尔值(true/false)还是结构化对象。
    • 描述:输入一个可选注释,提醒您它的用途。
    • 公共:如果要在方案设计器中使用变量,请打开此选项。 关闭时,变量仅在包的函数中可用。
    • 密钥:启用此选项可隐藏敏感值,如密钥。 该值会隐藏在变量列表中,并且还会进行清理,以便在场景设计器中不会显示。 您的函数在运行时仍会收到实际值。
  4. 选择​ 创建变量 ​或​保存更改

删除变量

  1. 单击左侧导航面板中的​ 包图标 选项卡。
  2. 在​ 变量 ​选项卡上,单击要删除的变量旁边的​ 删除 ​图标。
WARNING
使用已删除变量的函数将停止工作。

依赖项

某些函数需要额外的库才能完成其工作。 依赖项​选项卡是添加和管理这些库的位置。

添加库

  1. 单击左侧导航面板中的​ 包图标 选项卡。

  2. 在​ 依赖项 ​选项卡上,输入一个或多个库名称,名称之间用逗号分隔。 您可以通过在名称(例如,axios, lodash@4.17.21)之后添加特定版本来请求该版本。

  3. 单击​安装

删除库

  1. 单击左侧导航面板中的​ 包图标 选项卡。
  2. 在​ 依赖项 ​选项卡上,单击要删除的库旁边的​ 删除 ​图标。
WARNING
依赖已删除库的功能可能会停止工作。

历史记录

每次保存函数的草稿时,Fusion都会保留一个副本。 通过​ History ​选项卡,可以查看和还原早期版本。

  1. 单击左侧导航面板中的​ 包图标 选项卡。

  2. 在​ 历史记录 ​选项卡上,选择左侧的函数以查看其保存的版本,最新版本先于。

  3. 选择一个版本可查看它当时确切包含的内容。

  4. 若要还原版本,请单击​还原为草稿

    该版本将恢复为新草稿,因此您可以在发布之前对其进行查看和测试。 实时版本将保持不变,直到您发布。

  5. 要删除某个版本,请选择该版本,单击​ 删除版本 ​并确认。

NOTE
  • 发布函数会清除其历史记录。 在发布之前,History会跟踪您在草稿处理过程中所做的更改。
  • 无法撤消删除版本。

在方案中使用包

构建函数和变量的目的是让它们在您的场景中工作。 若要使用函数和变量,请使用​ Adobe App Builder ​连接器。

  • 使用包中的函数:此模块将函数之一作为方案中的步骤运行。 选择程序包和函数,填写您定义的输入,函数的结果将传递到后面的模块。
  • 使用包中的变量:此模块将一个包变量引入方案,以便将其值映射到其他模块。

有关信息和说明,请参阅Adobe App Builder模块

recommendation-more-help
workfront-fusion-help-workfront-fusion