文档CampaignCampaign自动化指南

JavaScript 脚本和模板 javascript-scripts-and-templates

Last update: Fri Jul 19 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • 主题：

创建对象：

  • 开发人员

通过脚本，可以计算值、在进程中不同任务之间交换数据，以及使用SOAP调用执行特定操作。

脚本在工作流图中无处不在：

  • 所有活动都有初始化脚本。 初始化脚本在激活活动时执行，可用于初始化变量和修改属性。

  • “JavaScript代码”活动仅用于执行脚本。

  • “测试”活动评估JavaScript表达式以激活相应的过渡。

  • 大多数文本字段都是JavaScript模板：JavaScript表达式可以包含在<%=和%>之间。 这些字段提供了一个按钮，用于打开下拉列表以帮助您输入表达式。

对象已公开 objects-exposed

在工作流上下文中执行的JavaScripts访问一系列其他全局对象。

  • 实例：表示正在执行的工作流。 此对象的架构为​ xtk：workflow。
  • 任务：表示正在执行的任务。 此对象的架构是​ xtk：workflowTask。
  • event：表示激活正在执行的任务的事件。 此对象的架构是​ xtk：workflowEvent。 对于已从多个过渡激活的​ AND-join ​类型活动，此对象未初始化。
  • 事件：表示激活当前任务的事件列表。 此对象的架构是​ xtk：workflowEvent。 此表通常包含一个元素，但可能包含多个​ AND-join ​类型的活动，这些活动已基于多个过渡激活。
  • 活动：表示正在执行的任务的模型。 此对象的架构取决于活动类型。 此对象可由初始化脚本修改，而在其他脚本中，修改具有不可确定的效果。

通过单击脚本工具栏右侧的按钮，可以在下拉列表中查看这些对象可用的属性。

CAUTION
这些对象的属性是只读的，但vars属性的子属性除外。
这些属性中的大多数只会在执行基本任务或实例被钝化后更新。 读取的值不一定与当前状态匹配，而是与以前的状态匹配。

示例

在此示例中，以及在以下示例中，创建包含​ JavaScript代码 ​活动和​ End ​活动的工作流，如下图所示。

双击​ JavaScript code ​活动并插入以下脚本：

logInfo("Label: " + instance.label)
logInfo("Start date: " + task.creationDate)

logInfo(message) ​函数在日志中插入消息。

单击​ OK ​以关闭创建向导，然后使用工作流列表右上角的操作按钮启动工作流。 在执行结束时，请查阅日志。 您应该会看到两条对应于脚本的消息：一条显示工作流的标签，另一条显示激活脚本的日期。

变量 variables

变量是​ instance、task ​和​ event ​对象的可用属性。 为这些变量授权的JavaScript类型为​ string、number ​和​ Date。

实例变量 instance-variables

实例变量(instance.vars.xxx)与全局变量类似。 所有活动都共享它们。

任务变量 task-variables

任务变量(task.vars.xxx)可与局部变量比较。 它们仅由当前任务使用。 这些变量由永久性活动用来保留数据，有时也用于在同一活动的不同脚本之间交换数据。

事件变量 event-variables

事件变量(vars.xxx)允许在工作流进程的基本任务之间交换数据。 这些变量由激活正在进行的任务的任务传递。 可以修改它们并定义新它们。 然后，它们会被传递到以下活动。

CAUTION
对于AND-join类型的活动，将合并变量，但如果同一变量定义了两次，则会发生冲突，且值仍未确定。

事件是最常用的变量，应优先使用它们而不是实例变量。

某些事件变量会被各种活动修改或读取。 这些都是字符串类型的变量。 例如，导出会使用刚刚导出的文件的全名设置​ vars.filename ​变量。 所有这些读取或修改的变量都记录在活动的关于活动的​ 输入参数 ​和​ 输出参数 ​部分中。

用例 example

NOTE
此部分中提供了其他工作流用例。

示例1

在此示例中，使用实例变量动态计算要对群体应用的分割百分比。

  1. 创建工作流并添加开始活动。

  2. 添加并配置JavaScript代码活动以定义实例变量。

    例如： instance.vars.segmentpercent = 10;

  3. 添加查询活动，并根据需要定位收件人。

  4. 添加拆分活动，并将其配置为对传入群体进行随机取样。 采样百分比可以是您选择的任何值。 在此示例中，它被设置为50%。

    正是这个百分比会根据之前定义的实例变量动态更新。

  5. 在拆分活动的高级选项卡的初始化脚本部分中，定义JS条件。 JS条件选择拆分活动中第一个过渡的随机取样百分比，并将其更新为由之前创建的实例变量设置的值。

    code language-none 
    activity.transitions.extractOutput[0].limiter.percent = instance.vars.segmentpercent;

  6. 确保在拆分活动的单独过渡中生成补码，并在每个叫客过渡之后添加结束活动。

  7. 保存并执行工作流。 根据实例变量应用动态取样。

示例2

  1. 以上例中的工作流为例，将​ JavaScript Code ​活动的脚本替换为以下脚本：

    code language-none 
    instance.vars.foo = "bar1"
vars.foo = "bar2"
task.vars.foo = "bar3"

  2. 将以下脚本添加到​ End ​活动的初始化脚本：

    code language-none 
    logInfo("instance.vars.foo = " + instance.vars.foo)
logInfo("vars.foo = " + vars.foo)
logInfo("task.vars.foo = " + task.vars.foo)

  3. 启动工作流，然后查看日志。

    code language-none 
    Workflow finished
task.vars.foo = undefined
vars.foo = bar2
instance.vars.foo = bar1
Starting workflow (operator 'admin')

此示例显示​ JavaScript代码 ​之后的活动可访问实例变量和事件变量，但无法从外部访问任务变量（“未定义”）。

在查询中调用实例变量 calling-an-instance-variable-in-a-query

在活动中指定实例变量后，您可以在工作流查询中重复使用它。

因此，若要在筛选器中调用变量​ instance.vars.xxx = "yyyy"，请输入​ $(instance/vars/xxx)。

例如：

  1. 创建通过​ JavaScript code ​定义投放内部名称的实例变量： instance.vars.deliveryIN = "DM42"。

  2. 创建定向和筛选维度为收件人的查询。 在条件中，指定您希望查找通过变量指定的投放发送的所有收件人。

    提醒一下，此信息存储在投放日志中。

    要在​ Value ​列中引用实例变量，请输入​ $(instance/vars/@deliveryIN)。

    该工作流将返回DM42投放的收件人。

高级功能 advanced-functions

除了标准的JavaScript函数之外，还有一些特殊的函数可用于处理文件、读取或修改数据库中的数据或向日志添加消息。

日志 journal

在上面的示例中详细介绍了​ logInfo(message)。 此函数向日志添加一条信息消息。

logError(message) ​向日志添加错误消息。 脚本会中断其执行，并且工作流会更改为错误状态（默认情况下，实例将暂停）。

初始化脚本 initialization-script

在某些情况下，您可以在活动执行时修改活动的属性。

大部分活动属性都可以使用JavaScript模板动态计算，或者因为工作流属性明确允许脚本计算值。

但是，对于其他属性，必须使用初始化脚本。 在执行任务之前将评估此脚本。 activity ​变量引用了与任务对应的活动。 此活动的属性可以修改，并且只影响此任务。

相关主题
工作流中的JavaScript代码示例

recommendation-more-help
cffff7e4-091f-472e-87ca-52087599f99d