Available Actions in the Actions API

BarTender REST API 提供 REST 端點,您可以使用這些端點以 YAML 或 JSON 格式或現有的舊版 BTXML 指令碼執行各種動作。

BarTender REST API 中可用的動作與您可以在 BarTender Designer、Integration Builder 和 Process Builder 中執行的動作基本相同。如果您偏好使用圖形化使用者介面來設定自動化,則可以使用這些應用程式。但使用 REST API,您能夠以程式設計方式執行動作。

BarTender REST API 支援下列動作。

關閉列印動作

動作

描述

PrintBTWAction

列印 BarTender 文件。

PrintBTXMLScriptAction

使用 BTXML 指令碼列印一或多個 BarTender 文件。

PrintCommandScriptAction

使用命令列和資料的組合列印 BarTender 文件。

關閉轉換動作

動作

描述

BTXMLPrintResponseToIBMWebSphereAction

將從執行的最後一個 BarTender 指令接收到的 BTXML 指令碼回應轉換為 IBM WebSphere Sensor Events。

IBMWebSphereToBTXMLAction

將傳入的 IBM WebSphere Sensor Events 轉換為 BTXML 指令碼。

IBMWebSphereToBTXMLWithPrintStatusAction

將傳入的 IBM WebSphere Sensor Events 轉換為包含列印狀態的 BTXML 指令碼。

InsertAfterEndAction

在內容結束時插入特定文字或字元。

InsertBeforeStartAction

在內容開始前插入特定文字或字元。

OraclePrintRequestToBTXMLAction

將傳入的 Oracle XML 要求轉換為 BTXML 指令碼。

SAPAIIToBTXMLAction

將傳入的 SAP AII XML 轉換為 BTXML 指令碼。

SearchAndDeleteAction

在內容中搜尋特定文字或字元並將其刪除。

SearchAndDeleteEverythingAfterAction

在內容中搜尋特定文字或字元並刪除其之後的所有內容。

SearchAndDeleteEverythingBeforeAction

在內容中搜尋特定文字或字元並刪除其之前的所有內容。

SearchAndInsertAfterAction

在內容中搜尋特定文字或字元並將其插入指定的文字之後。

SearchAndInsertBeforeAction

在內容中搜尋特定文字或字元並將其插入指定的文字之前。

SearchAndReplaceAction

在內容中搜尋特定文字或字元並將其取代為指定的文字。

TransformXMLUsingXSLTAction

使用 XSLT 樣式表轉換自訂或專有 XML 格式。

關閉輸入動作

動作

描述

ReadFileAction

讀取任何受支援檔案系統上的檔案內容,包括 FTP、Web 和雲端儲存。

ReadFromNetworkSocketAction

從 TCP 或 UDP 通訊端讀取傳入的資料。

ReadFromSerialPortAction

從序列埠讀取以尋找傳入的資料。

WaitForFileAction

等待檔案出現在指定的資料夾中,然後再執行後續動作。

關閉輸出動作

動作

描述

SendEmailAction

傳送電子郵件訊息。

SendToMessageQueueAction

將訊息傳送至 Microsoft Message Queuing (MSMQ) 服務中。

SendToNetworkSocketAction

透過 TCP 或 UDP 通訊端傳送資料。

SendToSerialPortAction

將資訊寫入序列埠。

SendWebServiceRequestAction

向 Web 服務(REST 或 SOAP)傳送 HTTP 要求。

WriteFileAction

將內容寫入檔案。

WriteMessageToLogAction

將資訊傳送至訊息日誌。

關閉執行動作

動作

描述

ActionGroup / GroupActions

管理和執行一組動作。

BarTenderCommandLineAction

使用命令列介面列印 BarTender 文件。

BarTenderProcessAction

執行在 BarTender Process Builder 中建立的流程檔案。

ConditionActions

根據條件結果為 true 或 false 執行動作。

DecrementVariableAction

每次執行動作時,依指定值遞減變數。

ForEachFileInArchiveActions

對封存資料夾中與指定篩選條件相符的所有檔案執行一個或一組動作。

ForEachFileInFolderActions

對資料夾中與指定篩選條件相符的所有檔案執行一個或一組動作。

ForLoopActions

透過遞增或遞減變數,針對指定的迴圈執行群組中的動作。

GoToAction

跳至特定動作以繼續進行處理。

IncrementVariableAction

依指定值遞增變數。

PowerShellCommandAction

執行 Windows PowerShell 指令 (指令碼)。

PrintBTWAction

列印 BarTender 文件。

PrintBTXMLScriptAction

使用 BTXML 指令碼列印一或多個 BarTender 文件。

PrintCommandScriptAction

使用命令列和資料的組合列印 BarTender 文件。

RunAsUserActions

使用指定的認證執行一組動作。

SelectCaseAction

根據指定條件評估要執行的 Case 子動作。

SetMultipleVariablesAction

設定一或多個變數的值。

SetVariableAction

設定一個變數的值。

ShellCommandAction

執行可用於執行作業系統指令或第三方公用程式的 Shell 指令。

StopAction

停止目前整合中的所有動作。

WaitAction

指定等待動作完成所經過的時間間隔。您可以使用此動作在循序執行的動作中建立暫停。

WaitForFileAction

等待檔案出現在指定的資料夾中,然後再執行後續動作。

WhileLoopActions

只要滿足條件,就繼續執行群組中的動作。

WorkflowTransitionAction

使用指定的轉換,將 Librarian 檔案在其工作流程中從一種狀態移動至另一種狀態。

關閉檔案動作

動作

描述

AddFilesToArchiveAction

將資料夾中的一或多個檔案新增至封存中。

CopyFileAction

將一或多個檔案從一個位置複製到另一個位置。

CopyFolderAction

將資料夾複製到另一個資料夾位置。

CreateFolderAction

建立資料夾。

DeleteFileAction

刪除一或多個檔案。

DeleteFolderAction

刪除資料夾。

ExtractFilesFromArchiveAction

將封存中的一或多個檔案擷取至指定的資料夾中。

ForEachFileInArchiveActions

對封存資料夾中與指定篩選條件相符的所有檔案執行一個或一組動作。

ForEachFileInFolderActions

對資料夾中與指定篩選條件相符的所有檔案執行一個或一組動作。

MoveFileAction

將一或多個檔案從一個位置移動至另一個位置。

MoveFolderAction

將資料夾從一個位置移動至另一個位置。

ReadFileAction

讀取任何受支援檔案系統上的檔案內容,包括 FTP、Web 和雲端儲存。

RenameFileAction

重新命名檔案。

RenameFolderAction

重新命名資料夾。

WriteFileAction

將內容寫入檔案。

WorkflowTransitionAction

使用指定的轉換,將 Librarian 檔案在其工作流程中從一種狀態移動至另一種狀態。

關閉資料庫動作

動作

描述

DeleteDatabaseRecordAction

從連接的資料庫中刪除一或多筆記錄。

ExecuteSQLAction

執行 SQL 指令碼。

ForEachDatabaseRecordActions

對資料庫查詢中的每筆記錄執行動作。

InsertDatabaseRecordAction

在連線的資料庫中插入資料庫記錄。

TransformTextToRecordSetAction

將文字或文字檔案轉換為記錄集。

UpdateDatabaseRecordsAction

更新一或多筆資料庫記錄。

To help you automate these actions by using the YAML file format, a YAML actions reference is provided as follows: