Dslink-Saas系統(tǒng)操作手冊

Dslink-Saas系統(tǒng)操作手冊

一、數(shù)據(jù)主頁

1、搜索連接器。

2、連接流、連接器、觸發(fā)器、執(zhí)行動作數(shù)量視覺圖

3、根據(jù)當前用戶準薦對應(yīng)的連接器

4、系統(tǒng)消息通知

圖示:

二、連接器市場

1、連接器類型

連接器分為四大類、每個類型下面的連接器乂通過功能性進行分類展示

O

2、連接器展示

展示具體功能分類下面的連接器，如果當前用戶訂閱了某個連接器，就會被標注出來

3、連接器搜索

可以根據(jù)服務(wù)商名稱或者連接器名稱進行搜索查詢

4、連接器市場詳情

顯示連接器的服務(wù)商、描述詳情。左側(cè)展示連接器下面發(fā)布的觸發(fā)器資源和對應(yīng)的描

述信息，右側(cè)展示執(zhí)行動作資源與對應(yīng)的描述信息，在這個頁面可以對連接器進行訂閱使用

和取消訂閱功能

*

三、連接流市場

功能研發(fā)中…

四、我的連接

1、連接器

1.1、新增連接器

用戶可以根據(jù)自己掌握的資源或者公司組織提供的業(yè)務(wù)上的資源進行新增特定場景分

類的連接器，可以選擇四種進行新增，當前僅支持《應(yīng)用連接器》，在創(chuàng)建連接器的時候

需要選擇一個對應(yīng)的場景分類

*Ma*

1.2,連接器展示

添加的連接器會在貝面展示，展示的屬性有連接器名稱、連接器類型、連接器關(guān)聯(lián)

的類目、連接器的狀態(tài)、還有連接器的操作功能。連接器展示分為自建連接器、訂閱連接

器，訂閱連接器就是用戶自己在連接器訂閱的連接器資源，來進行使用，訂閱連接器分為免

費與收費兩種，在訂閱的時候需要進行相關(guān)的配置。

??費?IR?C

1.3、連接器查詢

在連接器展示頁面，可以快速的查詢到自己需要使用的連接器信息，可以選擇連接器

類型，杳詢連接器的名稱3

■MTV

?1

on*

on3U?

1.4,連接器詳情

在功能中展示連接器的圖標，連接器名稱、連接港描述。顯示使用到當前連接器資源

的連接流看板。下面左側(cè)顯示當前連接器的觸發(fā)器信息、，添加觸發(fā)器入口，右側(cè)顯示當前連

接器的執(zhí)行動作資源列表，添加執(zhí)行動作入口。通過‘更多'可以進入觸發(fā)器或者執(zhí)行動作

詳情列表。

1.5,連接器編輯

點擊連接器編輯功能，可以修改連接器的基本信息。

o三

1.6、連接器發(fā)布、下架

點擊連接器上架、下架功能，可以將連接器發(fā)布到連接器市場、或者從連接器市場下

架。

?I

1.7.連接器刪除

1.8、觸發(fā)器

1.8.1、新增觸發(fā)器

新增觸發(fā)器，填寫觸發(fā)器名稱信息與描述。配置觸發(fā)器數(shù)據(jù)模型，可以直接通過正

確的json文件導入，可以動態(tài)添加參數(shù)字段、與字段類型，字段標題與字段描述，數(shù)據(jù)字

段的必選與非必選。字段類型支持string,number,arrayobject-,boolean五種類型，

在類型未object時候，可以繼續(xù)添加其子節(jié)點

6S”

1.8.2、觸發(fā)器展示

新增的觸發(fā)器會顯示觸發(fā)器名稱、觸發(fā)器描述、觸發(fā)器狀態(tài)以及觸發(fā)器的操作功能

?I

1.8.3、觸發(fā)器查詢

在觸發(fā)器頁面可以通過觸發(fā)器名稱進行一個模糊查詢相關(guān)的觸發(fā)器

Z1T*no”

wow

1.8.4、觸發(fā)器編輯

點擊編輯功能，用戶可以重新定義觸發(fā)器名稱、描述信息，和數(shù)據(jù)模型配置。

IKZS

MW

1.8.5、觸發(fā)器發(fā)布

點擊觸發(fā)器發(fā)布功能，可以將當前的觸發(fā)器發(fā)布到連接器市場中進行資源共享，前

提是連接器需要先發(fā)布。

1.8.6、觸發(fā)器刪除

點擊觸發(fā)器刪除操作，可以將觸發(fā)器資源進行刪除，注意的是刪除操作是不可逆的。

1.8.7、觸發(fā)器詳情

點擊觸發(fā)器名稱可以進入到觸發(fā)器詳情，可以顯示已經(jīng)配置好的觸發(fā)器信息。

1.9、執(zhí)行動作

191、新增執(zhí)行動作

新增執(zhí)行動作分為三步：

1、填寫基本信息，執(zhí)行動作名稱、執(zhí)行動作描述、創(chuàng)建方式，鑒權(quán)方式，填寫接口路徑,

填寫密鑰，填寫動作類型

2、填寫入?yún)⑴渲?，入?yún)⑴渲冒埱箢^、請求體、URL查詢參數(shù)、URL路徑參數(shù)，可以通

過json數(shù)據(jù)文件進行導入生成，也可以手動進行動態(tài)數(shù)據(jù)字段、數(shù)據(jù)類型、數(shù)據(jù)標題、數(shù)

據(jù)描述添加。

3、出參的配置，可以通過json數(shù)據(jù)格式文件進行生成，也可以通過手動去動態(tài)添加數(shù)據(jù)字

段、字段類型、字段標題、字段描述等信息。調(diào)用成功規(guī)范，可以去動態(tài)設(shè)置返回的數(shù)據(jù)成

功狀態(tài)標志，判斷返回的結(jié)果數(shù)據(jù)是否是一個成功的狀態(tài)。

^^3

192、執(zhí)行動作展示

新增的執(zhí)行動作會顯示執(zhí)行動作名稱、執(zhí)行動作描述、執(zhí)行動作狀態(tài)以及執(zhí)行動作

的操作功能

193、執(zhí)行動作查詢

在執(zhí)行動作頁面可以通過執(zhí)行動作名稱進行一個模糊查詢到相關(guān)的執(zhí)行動作

194、執(zhí)行動作編輯

點擊編輯功能，用戶可以重新定義執(zhí)行動作名稱、描述信息，和三個步驟中的數(shù)據(jù)

定義。

三an

195、執(zhí)行動作發(fā)布與下架

點擊執(zhí)行動作發(fā)布功能，可以將當前的執(zhí)行動作發(fā)布到連接器市場中進行資源共享,

前提是連接器需要先發(fā)布，同時也可以將已經(jīng)發(fā)布的執(zhí)吁動作下架。

MBWE11

196、執(zhí)行動作刪除

點擊執(zhí)行動作刪除操作，可以將執(zhí)行動作資源進行刪除，注意的是刪除操作是不可

逆的。

1.9.7、執(zhí)行動作詳情

點擊執(zhí)行動作名稱可以進入到觸發(fā)器詳情，可以顯示己經(jīng)配置好的執(zhí)行動作信息。

1.9.8、調(diào)用成功規(guī)范

設(shè)置執(zhí)行動作出參的調(diào)用規(guī)范，在連接流運行過程中，會通過調(diào)用成功規(guī)范來校驗執(zhí)

行動作是否執(zhí)行成功。如圖所示：

2、連接流

2.1、新增連接流

新建連接流分為兩步，一是填寫連接流基本信息，包含連接流名稱、連接流描述、選

擇控制臺（下面做控制臺解釋），二是配置具體流程，這兩步也可以分開來操作。

1、創(chuàng)建連接流基本信息

2、創(chuàng)建單條具體連接流程，用戶可以點擊十號選擇連接器、選擇連接器的觸發(fā)器，配置觸

發(fā)器中的數(shù)據(jù)。選擇連接器的時候，這里可以選擇自建連援器和已訂閱的三方連接器來使用。

數(shù)據(jù)字段可以配置為默認值、表達式。接著可以選擇執(zhí)行動作，同樣可以選擇自建連接器或

者已訂閱的三方連接器中的執(zhí)行動作，然后進行數(shù)據(jù)配置，執(zhí)行動作的數(shù)據(jù)字段可以動態(tài)的

做連接映射、固定值和表達式。

二

二

』

3、創(chuàng)建分支連接流，操作步驟跟創(chuàng)建單條步驟是一樣的，只是在每個節(jié)點可以擴展多個分

支出來，根據(jù)設(shè)置的條件或者條件組來設(shè)置連接流程的走向。

2.2、連接流展示

連接流展示功能會顯示出自建連接流和己訂閱連接流，顯示連接流名稱、連接流描述、

創(chuàng)建人、創(chuàng)建時間、連接流狀態(tài)、連接流操作功能。

2.3、連接流查詢

在連接流展示頁面，可以快速的查詢到自己需要使月的連接流信息，根據(jù)連接流的名稱

查詢。

O"ma

MM

2.4、連接流詳情

點擊連接流名稱可以查看已經(jīng)配置的連接流程詳情。

2.5、連接流編輯

點擊連接流編輯功能，可以對已經(jīng)配置的連接流基本信息、具體流程進行修改。

2.6、連接流發(fā)布

點擊連接流發(fā)布功能，可以將已經(jīng)配置好的連接流發(fā)布到連接流市場讓其他用戶安裝

使用（暫未開放）。

田K

0I

逢i—■□

2.7、連接流刪除

點擊連接流刪除功能，可以刪除已經(jīng)配置好的連接流，前提是這個連接流是沒有被發(fā)

布和沒有在運行中狀態(tài)。

3、連線映射

3.1、多級出參

3.2、字段映射

如果上級業(yè)務(wù)節(jié)點的數(shù)據(jù)字段是當前節(jié)點入?yún)⑺枰臄?shù)據(jù)，這時候可以做一個連線映

射上，如果上級出參數(shù)據(jù)的一個字段需要被當前節(jié)點入?yún)⒍鄠€節(jié)點使用到，還可以做一個一

對多的映射。

4、公式面板

在設(shè)置流程節(jié)點條件的時候、設(shè)置入?yún)⒆侄伪磉_式的時候需要用到表達式，這里可以在

公式面板中使用到」經(jīng)存在的場景內(nèi)置函數(shù)、四目運算將，邏輯運算。

4.1、四目運算表達式

這里可以通過力口、減、乘、除來進行數(shù)據(jù)的計算設(shè)置。

4.2、內(nèi)置函數(shù)表達式

內(nèi)置函數(shù)代表許多需要對返回的出參數(shù)據(jù)做一個操作的場景，例如時間字段處理，生

成，字符串轉(zhuǎn)換，數(shù)值比較，計算等等。面板下方式函數(shù)使用的提示。

4.3、邏輯運算表達式

邏輯運算可以結(jié)合運算表達式和函數(shù)表達式一起使用，例如通過函數(shù)計算出值然后與一

個設(shè)置的值或者固定的值進行一個大于、小于、等于的判斷。

5、控制臺

5.1、控制臺新增

填寫控制臺名稱、控制臺描述可以新增控制臺。

o三

5.2、控制臺顯示

顯示控制臺卡片信息，控制臺名稱、控制臺描述、連接流數(shù)量信息、運行統(tǒng)計。

5.3、控制臺導入

功能待研發(fā)

5.4、控制臺導出

功能待研發(fā)

5.5、基本信息

顯示當前控制臺的基本信息

5.6、連接流配置

5.6.1＞連接流顯示

顯示當前控制臺的連接流程信息，連接流ID、連接流名稱、連接流描述、連接流運

行的狀態(tài)、操作功能。

5.6.2、任務(wù)配置

填寫配置任務(wù)名稱、運行時間配置運行時間是一個范圍，可以提前設(shè)置，延遲運行，

配置類型有三種1、選擇執(zhí)行配置2、選擇執(zhí)行時間（只執(zhí)行一次）3、輸入執(zhí)行配置，就

是cron表達式。

5.6.3、運行（可延遲運行）

根據(jù)配置的任務(wù)時間來運行，可以提前設(shè)置好時間，到了時間自動運行

5.6.4、連接流觸發(fā)

連接流的觸發(fā)方式有兩種，一種是通過配置任務(wù)時間定時運行，或者在某個時刻運

行一次。第二種是通過觸發(fā)器的方式觸發(fā)連接流運行（這個方式會在后面給出觸發(fā)方式）。

5.7、運行記錄

記錄當前控制臺運行中的連接流程的運行記錄（目前這個運行記錄保留7天時間），

可以通過運行記錄來查看連接流程的正常日志和錯誤日志，發(fā)生錯誤的流程節(jié)點，可錯誤的

詳細信息，簡單排查問題。

5.7.1、運行記錄顯示

顯示所有運行記錄列表、流程名稱、調(diào)用類型、觸發(fā)時間、執(zhí)行狀態(tài)、運

行時耗、失敗原因、查看詳情。

,1

5.7.2、運行記錄查詢

可以選擇失敗記錄、成功記錄、所有記錄,可以選擇某一個連接流，可以

選擇一個時間范圍。

，,?

MWiwixai-

M?[HIM

■■l

5.7.3、運行記錄詳情

點擊運行記錄詳情，會展示每個流程節(jié)點的運行情況，單擊進入，可以查

看錯誤碼信息，請求頭、請求體，響應(yīng)頭、響應(yīng)體等信息，可以通過錯誤信息查

看到錯誤原因。

?xs

五、數(shù)據(jù)管理

功能待研發(fā)…

六、上架釘釘連接器案例

1、打開釘釘開放平臺

鏈接：

1、查詢用戶詳情功能

源6??叩me

?”

2、在dslink-saas中新增執(zhí)行動作，接口路徑填寫釘釘開放文檔中基本信息中的數(shù)據(jù)，如圖:

、打打開版平Nwiwn

m1」.?

B<xlye?

O

3、根據(jù)釘釘開放文檔，需要Query參數(shù)、Body參數(shù)

\UIJRBIVHH??n

■?*

Qu?ry>0

a?■a?e

l?W

>r.T'^WW

入6?oc”：：f.

4、接下來配置dslink-saa