跳转至

Configure Workshop application(配置 Workshop 应用程序)

:::callout{theme="warning"} Prior to July 2022, Foundry Rules (previously known as Taurus) required users to provide extra configuration in the Workshop Application. This section is only relevant if you deployed Foundry Rules prior to July 2022. :::

After deploying the rules workflow template, follow these steps to configure the Rules Workshop application:

All screenshots use notional data.

  1. Configure inputs: In the Workshop module generated by deploying the workflow template, select the Rule Editor widget in the Rules tab.

  2. The set of Permitted object types will by default contain the selected source object from the workflow template. However, to make additional object types available within Foundry Rules, select on the object set variable and then select Combine with another object set.

  3. If you wish to add datasets in addition to objects, select the Add Dataset button, and then enter the input dataset RID and a display name, which will later be used to reference the input dataset in the pipeline.
  4. Any additional objects or datasets added here will also need to be added to the transforms pipeline later as part of configuring the transforms pipeline.

    Adding additional input objects to Workshop app

  5. Add rule Actions: If a rule Action was configured while deploying the workflow template, then there will already be one rule Action configured. To add additional rule Actions, first create them in the Ontology Manager and then add them by clicking Add Rule actions.

    Configuring the available rule actions

Learn more about configuring rule Actions

  1. Enable optional features: To customize the functionality of Foundry Rules, several options are available in the Rule Editor widget configuration in the Workshop app. Toggle these options to either enable or disable advanced features, as described in the optional features documentation.

  2. Configure diffing when viewing proposals: To get the proposal widget to display diffs correctly, add the following type classes to the relevant proposal object properties. These type classes are added to properties of the object type rather than to any Action parameters.

  3. For every property that you want to display in the Proposal Reviewer widget, add a foundry-rules.property-diff-for:ID_OF_NEW_PROPERTY type class to the current property.

  4. For example, suppose the property new_rule_name on the proposal object represents the new value for the rule name, and the property current_rule_name on the proposal object represents the old value. The current_rule_name property should be annotated with foundry-rules.property-diff-for:new_rule_name.

    Example type class name and kind added to a property in ontology app

After completing the above steps, learn how to configure the transforms pipeline you created to suit your workflow.


中文翻译


配置 Workshop 应用程序

:::callout{theme="warning"} 在 2022 年 7 月之前,Foundry Rules(原名 Taurus)要求用户在 Workshop 应用程序中提供额外配置。本节仅适用于您在 2022 年 7 月之前部署了 Foundry Rules 的情况。 :::

部署规则工作流模板后,请按照以下步骤配置 Rules Workshop 应用程序:

所有截图均使用模拟数据。

  1. 配置输入: 在部署工作流模板生成的 Workshop 模块中,选择 Rules 选项卡中的 Rule Editor 小组件。

  2. 允许的对象类型(Permitted object types) 默认会包含工作流模板中选定的 对象。但若要在 Foundry Rules 中提供更多对象类型,请选择对象集变量,然后选择 与其他对象集合并(Combine with another object set)

  3. 如果希望在对象之外添加数据集,请选择 添加数据集(Add Dataset) 按钮,然后输入输入数据集的 RID 和显示名称,该名称后续将用于在管道中引用输入数据集。
  4. 此处添加的任何其他对象或数据集,后续也需要作为配置转换管道的一部分添加到转换管道中。

    向 Workshop 应用程序添加额外输入对象

  5. 添加规则操作(Rule Actions): 如果在部署工作流模板时已配置了规则操作,则此处会有一个已配置的规则操作。要添加更多规则操作,请先在 Ontology Manager 中创建它们,然后点击 添加规则操作(Add Rule actions) 进行添加。

    配置可用的规则操作

了解更多关于配置规则操作的信息。

  1. 启用可选功能: 为自定义 Foundry Rules 的功能,Workshop 应用程序中的 Rule Editor 小组件配置提供了多个选项。如可选功能文档所述,切换这些选项可启用或禁用高级功能。

  2. 配置提案查看时的差异对比: 为使提案小组件正确显示差异,请为相关的 提案对象 属性添加以下类型类(type classes)。这些类型类添加到 对象类型 的属性上,而非任何 操作参数(Action parameters)

  3. 对于希望在 Proposal Reviewer 小组件中显示的每个属性,请为 当前 属性添加一个 foundry-rules.property-diff-for:ID_OF_NEW_PROPERTY 类型类。

  4. 例如,假设提案对象上的属性 new_rule_name 表示规则名称的新值,而属性 current_rule_name 表示旧值。则 current_rule_name 属性应标注为 foundry-rules.property-diff-for:new_rule_name

    在 Ontology 应用程序中为属性添加类型类名称和种类的示例

完成上述步骤后,请了解如何配置您创建的转换管道以适配您的工作流。