跳到主要内容

FaaS 连接器 - 钉钉开放平台 - 批量删除表单实例

注意:不建议以 HTTP 连接器的形式在前端数据源中直接使用此 OpenAPI,请参考此案例配置 FaaS 连接器后方可使用。否则会导致 systemToken 参数的泄露,威胁应用的数据安全。

1. 使用场景

本例开发语言:NodeJS

本例介绍一下如何使用钉钉开放平台 OpenAPI 实现数据批量删除表单实例。

2. 实现功能

2.1. 申请钉钉开放平台应用凭证及接口权限

若已申请,可忽略此步骤。

准备工作 - 宜搭自定义连接器鉴权凭证申请及接口权限申请 | 钉钉宜搭·帮助中心

2.2. 创建并配置 FaaS 连接器

本例用到的连接器:批量删除表单实例 - 开放平台

注意:

  1. 如果选择不执行校验规则、关联业务规则和第三方服务回调(executeExpression:false),那么同步 / 异步单次批量删除表单实例允许的数量是 500 条。
  2. 如果选择执行校验规则、关联业务规则和第三方服务回调(executeExpression:true
    1. 如果选择同步(asynchronousExecution:false),允许单次 50 条。
    2. 如果选择异步(asynchronousExecution:true),允许单次 300 条。

详见:2022.04.21 版本更新-OpenAPI 全新升级 | 钉钉宜搭·帮助中心

2.2.1. 创建 FaaS 连接器

2.2.2. 配置连接器基本信息和开发语言

2.2.3. 配置连接器执行动作

注意解析 Body 并配置成功标志位。

{
"formUuid" : "String",
"appType" : "String",
"asynchronousExecution" : true,
"formInstanceIdList" : "Array",
"executeExpression" : false
}
{
"success": true,
"error": ""
}

2.3. 开发 FaaS 连接器

2.3.1. 前往云 IDE 开发并在 dingOpenApiUtil.js 文件中添加代码

添加完毕后需保存。

Windows:Ctrl + S
Mac:Command + S

batchRemoveFormData: async function (batchRemoveFormDataInputs) {
let client = createClient();
let batchRemovalByFormInstanceIdListHeaders = new $dingtalkyida_1_0.BatchRemovalByFormInstanceIdListHeaders({});
batchRemovalByFormInstanceIdListHeaders.xAcsDingtalkAccessToken = innerGetAccessToken();
let batchRemovalByFormInstanceIdListRequest = new $dingtalkyida_1_0.BatchRemovalByFormInstanceIdListRequest(batchRemoveFormDataInputs);
try {
const result = await client.batchRemovalByFormInstanceIdListWithOptions(batchRemovalByFormInstanceIdListRequest, batchRemovalByFormInstanceIdListHeaders, new $Util.RuntimeOptions({}));
return result;
} catch (err) {
if (!Util.empty(err.code) && !Util.empty(err.message)) {
// err 中含有 code 和 message 属性,可帮助开发定位问题
return {
code: err.code,
message: err.message
}
}
throw err;
}
return null;
},

2.3.2. 将 faasEntry.js 文件中的代码完全替换

注意根据实际情况修改固定参数。

appKey、appSecret 为 2.1 申请的应用凭证。

systemToken 可直接在宜搭 应用设置 - 部署运维 中找到。

const { openApi: OpenAPIUtil, yidaConnector: YidaConnectorUtil, httpUtil: HttpUtil } = require('./utils');
const { ConnectorTypeEnum } = YidaConnectorUtil;
// 注意:涉及数据安全的参数(如:appKey、appSecret、systemToken)一定要在服务端发送,不可在前端数据源里传入。
const appKey = 'XXXXXXXXXXXXXX';
const appSecret = 'XXXXXXXXXXXXXXXXXXXXXXXXXXX';
const systemToken = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';

module.exports = async function (faasInputs, context) {
// 这里的 inputs 跟你配置连接器时的 Body 参数及字段格式保持一致
const { inputs = {}, yidaContext = {} } = faasInputs || {};
const userId = yidaContext ? yidaContext['userId'] : ''; // 从连接器上下文获取调用人的 userId
const corpId = yidaContext ? yidaContext['corpId'] : ''; // 从连接器上下文获取调用组织的 corpId
const accessToken = yidaContext ? yidaContext['accessToken'] : '';
const consumeCode = yidaContext ? yidaContext['consumeCode'] : '';
OpenAPIUtil.setAccessToken(accessToken);
await OpenAPIUtil.getCustomAccessTokenThenCache(appKey, appSecret); // 获取调用连接器的 accessToken
YidaConnectorUtil.setConsumeCode(consumeCode);
inputs['systemToken'] = systemToken;
inputs['userId'] = userId;
return await batchDeleteFormData(inputs).then((result) => {
const { message = '' } = result;
return {
success: !message,
content: null,
error: message,
};
}).catch((error) => {
return {
success: false,
content: null,
error: error,
};
});
};

async function batchDeleteFormData(inputs) {
return await OpenAPIUtil.batchRemoveFormData(inputs);
}

2.4. 部署 FaaS 连接器

注意保存添加的代码。

当提示代码部署成功即完成 FaaS 连接器云 IDE 开发。

2.5. 返回连接器配置并点击保存

2.6. 在宜搭页面配置数据源和使用数据源

2.6.1. 获取数据展示在表格中

可参考下述案例,本例是对下述案例删除数据功能的升级。

自定义页面表格实现数据管理页功能 | 钉钉宜搭·帮助中心

2.6.2. 在数据源中选择刚刚创建的连接器

2.6.3. 配置批量删除确认弹窗

配置如下:

2.6.4. 配置顶部操作并绑定下述函数

// 批量删除弹窗
export function onBatchDeleteDataDialog() {
const { selectedRowKeys = [] } = this.state;
if (!selectedRowKeys.length) {
this.utils.toast({
title: '当前未选中任何数据',
type: 'warning',
});
return;
}
this.$('dialog_lpjg5aha').show(() => {
this.$('numberField_lpjg8ky1').setValue(selectedRowKeys.length);
});
}

2.6.5. 配置批量删除弹窗动作并绑定下述函数

// 确认批量删除
export function onBatchDeleteDataOk() {
const { selectedRowKeys = [] } = this.state;
this.$('dialog_lpjg5aha').set('confirmState', 'LOADING'); // 开启对话框加载状态
// 批量删除表单数据
this.dataSourceMap.batchDeleteData.load({
inputs: JSON.stringify({
body: {
formUuid, // 数据表formUuid
appType: pageConfig.appType, // 应用 appType
formInstanceIdList: selectedRowKeys, // 需要删除的数据实例id列表
asynchronousExecution: true, // 是否需要异步执行该任务
executeExpression: false, // 是否需要触发表单绑定的校验规则、关联业务规则和第三方服务回调
},
}),
}).then((res) => {
this.$('dialog_lpjg5aha').set('confirmState', 'NORMAL'); // 关闭对话框加载状态
const { success, error } = res;
if (success) {
this.$('dialog_lpjg5aha').hide();
this.utils.toast({
title: '批量删除成功',
type: 'success',
});
setTimeout(() => {
this.setState({
loading: true,
selectedRowKeys: [],
});
this.getData(); // 获取数据
}, 1000);
} else {
this.utils.toast({
title: error,
type: 'success',
});
}
}).catch(({ message }) => {
this.utils.toast({
title: message,
type: 'error',
});
this.$('dialog_lpjg5aha').set('confirmState', 'NORMAL'); // 关闭对话框加载状态
});
}

3. 实现效果

4. 在线试玩

Copyright © 2024钉钉(中国)信息技术有限公司和/或其关联公司浙ICP备18037475号-4