工作流中的 JavaScript 代码示例 javascript-in-workflows

Last update: Fri Mar 22 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

主题：
Workflows

创建对象：

Developer

以下示例说明如何在工作流中使用JavaScript代码：

写入数据库
查询数据库
使用静态SOAP方法触发工作流
使用非静态SOAP方法与数据库交互

了解详情关于静态和非静态SOAP方法。

在这些示例中，使用ECMAScript for XML (E4X)扩展。使用此扩展，可以在同一脚本中组合JavaScript调用和XML基元。

要尝试这些示例，请执行以下步骤：

创建工作流并将以下活动添加到工作流中：
1. 开始活动
2. JavaScript代码活动
3. 结束活动
了解详情关于构建工作流。
将JavaScript代码添加到活动中。了解详情。
保存工作流。
测试示例：
1. 启动工作流。了解详情。
2. 打开日记帐。了解详情。

示例1：写入数据库 write-example

要写入数据库，可以使用静态 Write 上的方法 xtk:session 架构：

以XML撰写写入请求。

写入记录：

调用 Write 上的方法 xtk:session 架构。

note important
IMPORTANT
如果您使用Adobe Campaign v8，我们建议您将暂存机制与摄取和数据更新/删除的API `Write` Snowflake表中的方法。了解更多信息。

将XML代码作为写入请求的参数传递。

步骤1：编写写入请求

您可以添加、更新和删除记录。

插入记录

因为 insert 操作是默认操作，无需指定。

将此信息指定为XML属性：

要修改的表的模式
要填充的表字段

例如：

var myXML = <recipient xtkschema="nms:recipient"
    firstName="Isabel"
    lastName="Garcia"
    email="isabel.garcia@mycompany.com"/>

更新记录

使用 _update 操作。

将此信息指定为XML属性：

要修改的表的模式
要更新的表字段
标识要更新的记录所需的关键参数

例如：

var myXML = <recipient xtkschema="nms:recipient"
    status="Client"
    email="isabel.garcia@mycompany.com"
    operation="_update"
    _key="@email"/>

删除记录

使用 DeleteCollection 方法。了解详情。

指定以下信息：

要修改的表的模式
此 where 以XML元素的形式标识要更新的记录所需的子句

例如：

xtk.session.DeleteCollection(
    "nms:recipient",
    <where>
        <condition expr="[@email] = 'isabel.garcia@mycompany.com'"/>
    </where>,
    false
    )

第2步：写入记录

调用非静态 Write 上的方法 xtk:session 架构：

xtk.session.Write(myXML)

此方法未返回任何值。

将完整代码添加到工作流中的JavaScript代码活动：

var myXML = <recipient xtkschema="nms:recipient"
    firstName="Isabel"
    lastName="Garcia"
    email="isabel.garcia@mycompany.com"/>

xtk.session.Write(myXML)

本视频说明如何写入数据库：

https://video.tv.adobe.com/v/18472/?learn=on

示例2：查询数据库 read-example

要查询数据库，可以使用非静态 xtk:queryDef 实例方法：

以XML格式编写查询。
创建查询对象。
运行查询。

步骤1：撰写查询

指定的XML代码 queryDef 实体。

语法：

<queryDef schema="nms:recipient" operation="">
    <!-- select, where, and orderBy clauses as XML elements -->
</queryDef>

指定以下信息：

要读取的表的模式
操作
要返回的列，在 select 子句
条件，在 where 子句
过滤条件，在 orderBy 子句

您可以使用以下操作：

操作

结果

select

零个或多个元素将作为集合返回。

getIfExists

返回一个元素。如果不存在匹配元素，则会返回空元素。

get

返回一个元素。如果不存在匹配元素，则会返回错误。

count

匹配的记录数以元素形式返回，其中具有 count 属性。

写入 select， where、和 orderBy 子句作为XML元素：

select 子句

指定要返回的列。例如，要选择人员的名字和姓氏，请编写以下代码：

code language-xml
`<select> <node expr="@firstName"/> <node expr="@lastName"/> </select>`

使用 nms:recipient 架构，元素会以以下形式返回：

code language-xml
`<recipient firstName="Bo" lastName="Didley"/>`

where 子句

要指定条件，请使用 where 子句。例如，要选择位于培训文件夹，您可以编写以下代码：

code language-xml
`<where> <condition expr="[folder/@label]='Training'"/> </where>`

组合多个表达式时，在第一个表达式中使用布尔运算符。例如，要选择名为Isabel Garcia的所有人员，您可以编写以下代码：

code language-xml
`<condition boolOperator="AND" expr="@firstName='Isabel'"/> <condition expr="@lastName='Garcia'"/>`

orderBy 子句

要对结果集进行排序，请指定 orderBy 子句作为XML元素 sortDesc 属性。例如，要按升序对姓氏进行排序，您可以编写以下代码：

code language-xml
`<orderBy> <node expr="@lastName> sortDesc="false"/> </orderBy>`

步骤2：创建查询对象

要通过XML代码创建实体，请使用 create(content) 方法：

var query = xtk.queryDef.create(
    <queryDef schema="nms:recipient" operation="select">
    …
    </queryDef>)

为添加前缀 create(content) 具有要创建的实体的架构的方法。

此 content 参数是一个字符串参数，是可选的。此参数包含描述实体的XML代码。

步骤3：运行查询

执行以下步骤：

调用 ExecuteQuery 上的方法 queryDef 实体：

code language-javascript
`var res = query.ExecuteQuery()`

处理结果：
1. 反复查看的结果 select 操作，使用循环构造。
2. 使用测试结果 getIfExists 操作。
3. 使用 count 操作。

的结果 `select` 操作

所有匹配项都将作为集合返回：

<recipient-collection>
    <recipient email="jane.smith@mycompany.com">
    <recipient email="john.harris@mycompany.com">
</recipient-collection>

要循环查看结果，请使用 for each 循环：

for each (var rcp in res:recipient)
    logInfo(rcp.@email)

循环包括一个本地收件人变量。对于收件人集合中返回的每个收件人，都会打印出收件人的电子邮件。了解详情关于 logInfo 函数。

的结果 `getIfExists` 操作

每个匹配都作为元素返回：

<recipient id="52,378,079">

如果没有匹配项，则返回空元素：

<recipient/>

您可以引用主键节点，例如 @id 属性：

if (res.@id !=undefined)
    { // match was found
    …
    }

的结果 `get` 操作

一个匹配项作为元素返回：

<recipient id="52,378,079">

如果没有匹配项，则会返回错误。

TIP

如果您知道有匹配项，请使用 get 操作。否则，请使用 getIfExists 操作。如果使用此最佳实践，则错误会显示意外问题。如果您使用 get 操作，请勿使用 try…catch 语句。该问题由工作流的错误处理过程处理。

的结果 `count` 操作

具有的元素 count 属性被返回：

<recipient count="200">

要使用结果，请参阅 @count 属性：

if (res.@count > 0)
    { // matches were found
    …
    }

对于 select 操作，请将此代码添加到工作流中的JavaScript代码活动：

var myXML =
<queryDef schema="nms:recipient" operation="select">
    <select>
        <node expr="@firstName"/>
        <node expr="@lastName"/>
    </select>
</queryDef>

var query = xtk.queryDef.create(myXML)

var res = query.ExecuteQuery()

for each (var rcp in res.recipient)
    logInfo(rcp.@firstName + " " + rcp.@lastName)

因为 select 操作是默认操作，无需指定。

本视频说明如何从数据库读取：

https://video.tv.adobe.com/v/18475/?learn=on

触发工作流 trigger-example

例如，您可以在技术工作流中以编程方式触发工作流，或处理用户在Web应用程序页面上输入的信息。

工作流触发通过使用事件起作用。您可以将这些功能用于事件：

要发布事件，您可以使用静态 PostEvent 方法。了解详情。
要接收事件，您可以使用 External signal 活动。了解详情。

您可以通过不同方式触发工作流：

您可以内联触发工作流，即从的主脚本 JavaScript code 活动。

另一个工作流完成后，您可以触发该工作流：

将初始化脚本添加到 End 初始工作流的活动。

添加 External signal 活动。

完成初始工作流后，将发布事件。将激活传出过渡并填充事件变量。然后，目标工作流接收该事件。

note tip
TIP
作为最佳实践，在向活动添加脚本时，请将活动名称用双连字符括起来，例如， `-- end --`. 了解详情关于工作流最佳实践。

的语法 PostEvent 方法：

PostEvent(
    String     //ID of the target workflow
    String     //Name of the target activity
    String     //Name of the transition to be activated in case of multiple transitions
    XML        //Event parameters, in the <variables/> element
    Boolean    //To trigger the target workflow only once, set this parameter to true.
)

在本例中，工作流完成后，会将简短文本传递给信号的活动 wkfExampleReceiver 工作流：

var strLabel = "Adobe Campaign, Marketing that delivers"
xtk.workflow.PostEvent(
    "wkfExampleReceiver",
    "signal",
    "",
    <variables strLine={strLabel}/>,
    false)

因为最后一个参数设置为 false， wkfExampleReceiver 每次完成初始工作流时，都会触发工作流。

在触发工作流时，请牢记以下原则：

此 PostEvent 命令以异步方式运行。命令位于服务器队列中。方法会在事件发布后返回。
必须启动目标工作流。否则，错误将写入日志文件。
如果目标工作流已暂停，则 PostEvent 命令将排入队列，直到工作流恢复。
触发的活动不要求任务正在执行。

本视频说明如何使用静态API方法：

https://video.tv.adobe.com/v/18481/?learn=on

本视频说明如何触发工作流：

https://video.tv.adobe.com/v/18485/?learn=on

与数据库交互 interact-example

以下示例显示如何执行这些操作：

使用 get 和 create 架构上使用非静态SOAP方法的方法
创建执行SQL查询的方法
使用 write 插入、更新和删除记录的方法

执行以下步骤：

定义查询：
- 使用检索实体 create 方法 — 例如， xtk:workflow 架构。了解详情。
- 使用 queryDef 方法发出SQL查询。
使用运行查询 ExecuteQuery 方法。了解详情。

使用 for each 循环以检索结果。

的语法 `queryDef` 方法与 `select` 子句

<queryDef schema="schema_key" operation="operation_type">
    <select>
        <node expr="expression1">
        <node sql="expression2">
    </select>
    <where>
        <condition expr="expression1"/>
        <condition sql="expression2"/>
    </where>
    <orderBy>
        <node expr="expression1">
        <node sql="expression2">
    </orderBy>
    <groupBy>
        <node expr="expression1">
        <node sql="expression2">
    </groupBy>
    <having>
        <condition expr="expression1"/>
        <condition sql="expression2"/>
    </having>
</queryDef>

`Create` 方法

示例1：选择记录并写入日记帐

位于中的工作流的内部名称 wf示例 已选择文件夹。结果按内部名称升序排序，并写入日志。

var query = xtk.queryDef.create(
    <queryDef schema="xtk:workflow" operation="select">
        <select>
            <node expr="@internalName"/>
        </select>
        <where>
            <condition expr="[folder/@name]='wfExamples'"/>
        </where>
        <orderBy>
            <node expr="@internalName" sortDesc="false"/>
        </orderBy>
    </queryDef>
    )

var res = query.ExecuteQuery()
for each (var w in res.workflow)
    logInfo(w.@internalName)

示例2：删除记录

将选择名为Chris Smith的所有收件人的名字、姓氏、电子邮件和ID。结果按电子邮件升序排序，并写入日志。 A delete 操作用于删除选定的记录。

// Build the query, create a query object and hold the object in a variable
var query = xtk.queryDef.create(
        <queryDef schema="nms:recipient" operation="select">
            <select>
                <node expr="@firstName"/>
                <node expr="@lastName"/>
                <node expr="@email"/>
                <node expr="@id"/>
            </select>
            <where>
                <condition expr="[folder/@label]='Recipients'"/>
                <condition expr="[@lastName]='Smith'"/>
                <condition expr="[@firstName]='Chris'"/>
            </where>
            <orderBy>
                <node expr="@email" sortDesc="false"/>
            </orderBy>
        </queryDef>
)

//Run the query using the ExecuteQuery method against the created object
var res = query.ExecuteQuery()

//Loop through the results, print out the person's name and email, then delete the records
for each (var rec in res.recipient)
    {
     logInfo("Delete record = Email: " + rec.@email + ', ' + rec.@firstName + ' ' + rec.@lastName)
     xtk.session.Write(<recipient xtkschema="nms:recipient" _operation="delete" id={rec.@id}/>)
    }

示例3：选择记录并写入日记帐

在此示例中，使用非静态方法。其信息存储在中的所有收件人的电子邮件和出生年份 1234 已选择文件夹及其电子邮件域名以“adobe”开头的。结果按出生日期降序排序。收件人的电子邮件将写入日志。

var query = xtk.queryDef.create(
<queryDef schema="nms:recipient" operation="select">
    <select>
        <node expr="@email"/>
        <node sql="sEmail"/>
        <node expr="Year(@birthDate)"/>
    </select>
    <where>
        <condition expr="[@folder-id] = 1234 and @domain like 'adobe%'"/>
        <condition sql="iFolderId = 1234 and sDomain like 'adobe%'"/>
    </where>
    <orderBy>
        <node expr="@birthDate" sortDesc="true"/>
    </orderBy>
</queryDef>
)

var res = query.ExecuteQuery()
for each (var w in res.recipient)
    logInfo(w.@email)

`Write` 方法

您可以插入、更新和删除记录。您可以使用 Write Adobe Campaign方法。由于此方法为静态方法，因此您无需创建对象。您可以使用以下操作：

此 update 操作
此 insertOrUpdate 操作，使用 _key 用于标识要更新的记录的参数

如果您不指定 收件人 然后，如果存在匹配项，则会在任何子文件夹中更新记录。否则，将在根目录中创建记录 收件人 文件夹。
此 delete 操作

IMPORTANT

如果您使用Adobe Campaign v8，我们建议您将暂存机制与摄取和 数据更新/删除 的API Write Snowflake表中的方法。了解更多信息。

示例1：插入或更新记录

xtk.session.Write(
<recipient
    xtkschema="nms:recipient"
    _operation="insertOrUpdate" _key="@email"
    lastName="Lennon"
    firstName="John"
    email="johnlennon@thebeatles.com"
/>
)

示例2：删除记录

此示例将静态方法与非静态方法结合使用。

var query=xtk.queryDef.create(
<queryDef schema="nms:recipient" operation="select">
    <select>
        <node expr="@Id"/>
    </select>
    <where>
        <condition expr="[@email]='johnlennon@thebeatles.com'"/>
    </where>
</queryDef>
);

var res = query.ExecuteQuery()
for each (var w in res.recipient) {
xtk.session.Write(
    <recipient xtkschema="nms:recipient" _operation="delete" id={w.@id}/>
);
}

本视频说明如何使用非静态API方法：

https://video.tv.adobe.com/v/18477/?learn=on

本视频演示了在工作流中使用非静态API方法的示例：

https://video.tv.adobe.com/v/18476/?learn=on

工作流中的 JavaScript 代码示例 javascript-in-workflows

示例1：写入数据库 write-example

步骤1：编写写入请求

插入记录

更新记录

删除记录

第2步：写入记录

示例2：查询数据库 read-example

步骤1：撰写查询

步骤2：创建查询对象

步骤3：运行查询

的结果 `select` 操作

的结果 `getIfExists` 操作

的结果 `get` 操作

的结果 `count` 操作

触发工作流 trigger-example

与数据库交互 interact-example

的语法 `queryDef` 方法与 `select` 子句

`Create` 方法

示例1：选择记录并写入日记帐

示例2：删除记录

示例3：选择记录并写入日记帐

`Write` 方法

示例1：插入或更新记录

示例2：删除记录

相关主题

API文档

工作流中的 JavaScript 代码示例 javascript-in-workflows

示例1：写入数据库 write-example

步骤1：编写写入请求

插入记录

更新记录

删除记录

第2步：写入记录

示例2：查询数据库 read-example

步骤1：撰写查询

步骤2：创建查询对象

步骤3：运行查询

的结果 select 操作

的结果 getIfExists 操作

的结果 get 操作

的结果 count 操作

触发工作流 trigger-example

与数据库交互 interact-example

的语法 queryDef 方法与 select 子句

Create 方法

示例1：选择记录并写入日记帐

示例2：删除记录

示例3：选择记录并写入日记帐

Write 方法

示例1：插入或更新记录

示例2：删除记录

相关主题

API文档

的结果 `select` 操作

的结果 `getIfExists` 操作

的结果 `get` 操作

的结果 `count` 操作

的语法 `queryDef` 方法与 `select` 子句

`Create` 方法

`Write` 方法