共用方式為


IA-Connect 場

IA-Connect 是一個機器人流程自動化“RPA”平台,它將 RPA 功能從雲添加到本地虛擬機或通過 Citrix 或 Microsoft 遠程桌面“RDS”連接。 這是用於自動化環境、會話、文件管理和配置 IA-Connect 的模塊。

此連接器適用於以下產品和區域:

服務 Class Regions
副駕駛工作室 進階 除下列區域外的所有 Power Automate 區域
     - 美國政府 (GCC)
     - 美國政府(海灣合作委員會高中)
     - 由 21Vianet 營運的中國雲
     - 美國國防部 (DoD)
邏輯應用程式 標準 所有 Logic Apps 區域, 但下列區域除外:
     - Azure Government 區域
     - Azure 中國區域
     - 美國國防部 (DoD)
Power Apps 進階 除下列區域外的所有 Power Apps 區域
     - 美國政府 (GCC)
     - 美國政府(海灣合作委員會高中)
     - 由 21Vianet 營運的中國雲
     - 美國國防部 (DoD)
Power Automate(自動化服務) 進階 除下列區域外的所有 Power Automate 區域
     - 美國政府 (GCC)
     - 美國政府(海灣合作委員會高中)
     - 由 21Vianet 營運的中國雲
     - 美國國防部 (DoD)
連絡人​​
名稱 創世紀實驗室
URL https://www.ultima.com/ultima-labs
Email IAConnect@ultima.com
連接器中繼資料
Publisher 創世紀商業
網站 https://www.ultima.com/ultima-labs
隱私策略 https://www.ultima.com/privacy-policy
類別 IT運營;生產力

IA-Connect 是一個機器人流程自動化 (RPA) 平台,可將 RPA 功能從 Power Automate 雲端流程新增至內部部署虛擬機器,或透過 Citrix 或 Microsoft 遠端桌面 (RDS) 連線。 IA-Connect 連接器提供超過 800 個動作,可讓您直接從 Power Automate 雲端流程自動化每種類型的內部部署應用程式。 所有 IA-Connect 動作都可以直接從 Power Automate 雲端流程取得,從而在雲端型應用程式和內部部署應用程式之間輕鬆整合,並能夠在 RPA 流程中利用現有的 Power Automate 條件、迴圈、動態內容、運算式和例外狀況處理。 利用 IA-Connect Connectors 還可以從 Flow 執行歷史記錄中提供完整的執行歷史記錄和可審計性,同時也無需使用單獨的應用程式/控制台/工作室來開發 RPA 流程。

先決條件

若要使用任何 IA-Connect 連接器,您必須安裝 IA-Connect 軟體。 這是 30 天的免費測試,之後您將需要 IA-Connect 許可證。

IA-Connect 軟體由兩個主要組件組成:

  • IA-Connect Orchestrator,這是 Azure WebApp,您將在自己的 Azure 租用戶中裝載。 這會處理 RPA 流程到一或多個內部部署或雲端虛擬機器的路由和安全性。

  • IA-Connect 代理程式和導向器,安裝在可存取您要自動化軟體的虛擬機器上。 此外,IA-Connect 代理程式可以在 Citrix 或 Microsoft 遠端桌面服務 (RDS) 工作階段內執行,其中 RPA 命令會透過虛擬通道傳遞到遠端工作階段中以執行。 IA-Connect 代理程式可以從網路共用執行,而且不需要安裝。

可用的 IA-Connect 連接器

可用的 IA-Connect 連接器包括:

  • IA-Connect 動態程式碼
  • IA-Connect 爪哇
  • IA-Connect JML
  • IA-Connect 大型主機
  • IA-Connect Microsoft辦公室
  • IA-Connect SAP GUI
  • IA-Connect 場
  • IA-Connect 使用者介面
  • IA-Connect 網頁瀏覽器

如何取得認證

為了獲得您的許可證並開始您的 30 天免費試用,請在我們的網站上提交請求 (https://www.ultima.com/IA-Connect/Power-Automate)。

收到試用請求後,我們將透過提供的電子郵件地址與您聯繫,以協助設定 IA-Connect 軟體並為您提供試用授權。 這是一個功能齊全的試用版,可讓您在試用期內測試自己環境中所有 9 個 IA-Connect Connector 的 800 個動作中的任何一個。

開始使用連接器

提交 IA-Connect 試用請求後,您將能夠下載包含 IA-Connect 軟件以及涵蓋安裝和設置的文件的 ZIP 文件。 我們還將根據需要與您聯繫,在安裝過程中提供支援和指導。

Support

在試用期間,您可以聯絡 Ultima Labs (IAConnect@ultima.com) 尋求支援和協助。

購買 IA-Connect 許可證後,您將收到支持代幣,這些代幣可以兌換 Ultima 位於英國的技術服務中心 (TSC) 的定制培訓或支持。

已知問題、常見錯誤和常見問題

我們的知識庫包含許多文章,涵蓋任何已知問題、使用 IA-Connect 連接器時可能發生的常見錯誤以及常見問題。 這可在 IA-Connect 試 https://support.ultima.com/ultimalabs 用期間和購買 IA-Connect 許可證時訪問,並提供訪問這些資源的帳戶。

正在建立連線

連接器支援下列驗證類型:

預設值 建立連線的參數。 所有區域 不可共享

預設

適用:所有地區

建立連線的參數。

這不是可共用的連線。 如果 Power App 與其他使用者共用,系統會明確提示其他使用者建立新連線。

名稱 類型 Description 為必填項目
API 金鑰 securestring 此 API 的 API 金鑰
IA-Connect Orchestrator 位址 字串 指定不含 HTTP(S) 元件的 IA-Connect Orchestrator 位址

節流限制

名稱 呼叫 續約期間
每個連線的 API 呼叫 100 60 秒

動作

IA-Connect 階段作業是否依名稱存在

如果指定的 IA-Connect Director 工作階段存在,則傳回。 這是將命令傳送到 IA-Connect 代理程式的階段作業。 該名稱將從早期的“附加”操作中得知。

TCP 連接埠是否回應

報告網路 TCP 連接埠是否正在回應 IA-Connect Agent 的連線嘗試。 這可能是執行 IA-Connect Agent 的電腦上的 TCP 連接埠 (為遠端主機輸入 'localhost') 或任何遠端電腦上的 TCP 連接埠。 如果 IA-Connect 代理程式成功連線到 TCP 連接埠,它會立即關閉 TCP 連線。

UnZIP 檔案

解壓縮已使用 ZIP 壓縮壓縮的檔案。

下載 HTTP 檔案

使用 HTTP(S) 將檔案下載到執行 IA-Connect Agent 的電腦。

中斷資料夾安全性繼承

中斷執行 IA-Connect Agent 之電腦上資料夾的安全性繼承。

中斷遠端工作階段的連線

如果 IA-Connect 代理程式在遠端工作階段中執行,此動作會中斷遠端工作階段的連線。 這與登出不同,會讓遠端會話在中斷連線狀態下執行。 此動作可用於您稍後要連線回遠端會話並從相同狀態繼續,而不是啟動新會話。 如果 IA-Connect 代理程式在本機執行,此動作將鎖定工作階段。

以 Base64 格式獲取文件內容

以 Base64 格式檢索指定文件的內容,這種格式適合通過 API 傳輸,並且可以輕鬆轉換回原始文本或二進制格式。

依名稱取得處理程序計數

傳回具有指定處理程序名稱的 IA-Connect 代理程式使用者階段作業中執行中的處理程序計數。

依名稱附加至 IA-Connect 階段作業

依名稱附加至指定的 IA-Connect 導向器階段作業。 這是將命令傳送到 IA-Connect 代理程式的階段作業。

依索引附加至 IA-Connect 工作階段

依索引附加至指定的 IA-Connect Director 工作階段 (例如,附加至第一個 Citrix ICA 工作階段)。 這是將命令傳送到 IA-Connect 代理程式的階段作業。

依進程識別碼取得進程

傳回具有指定處理程序 ID 的處理程序是否在 IA-Connect 代理程式使用者階段作業中執行。 程序識別碼是唯一的,因此只有一個程序可以符合識別碼。程序識別碼是動態的,並且每次啟動應用程式都不同。

保持工作階段處於活動狀態

透過以指定的間隔移動滑鼠來防止工作階段變成閒置狀態,使 IA-Connect 代理程式使用者工作階段保持運作狀態。

停止保持工作階段處於作用中狀態

停止 IA-Connect 代理程式使用者工作階段保持作用中狀態。

停用下一個躍點 IA-Connect

停用下一躍點,以便接收這些命令的代理程式處理所有未來的命令(而不是轉發到下一躍點代理程式)。

傳送密碼金鑰

將全域按鍵傳送至 IA-Connect Agent 使用者工作階段,專門用於輸入密碼。 這模擬了用戶按下鍵盤上的這些鍵。 請確定目標 Window 元素已聚焦,或錯誤的應用程式可能會收到按鍵,或被忽略。

傳送密碼金鑰事件

使用低階鍵盤驅動程式,將全域按鍵事件傳送至 IA-Connect Agent 使用者工作階段,專門用於輸入密碼。 這模擬了用戶按下鍵盤上的這些鍵。 請確定目標 Window 元素已聚焦,或錯誤的應用程式可能會收到按鍵,或被忽略。

傳送重要事件

使用低階鍵盤驅動程式,將全域按鍵事件傳送至 IA-Connect Agent 使用者工作階段。 這模擬了用戶按下鍵盤上的這些鍵。 請確定目標 Window 元素已聚焦,或錯誤的應用程式可能會收到按鍵,或被忽略。

傳送金鑰

將全域按鍵傳送至 IA-Connect Agent 使用者工作階段。 這模擬了用戶按下鍵盤上的這些鍵。 請確定目標 Window 元素已聚焦,或錯誤的應用程式可能會收到按鍵,或被忽略。

刪除 Orchestrator 自動化工作

刪除已延遲的 Orchestrator 自動化工作。

刪除 Orchestrator 自動化工作作業

提供唯一的工作作業識別碼,以刪除特定的 Orchestrator 自動化工作。

刪除代理程式執行緒

刪除代理程式執行緒或所有代理程式執行緒,如果執行緒仍在執行中,則先終止 (終止、中止) 執行緒。 代理程式執行緒可用來執行執行緒中的特定動作,允許動作長時間執行 (長於 RPA 逾時) 或與其他動作平行執行。 監視代理程式執行緒的處理程序或流程會收到「代理程式執行緒識別碼不存在」錯誤。

刪除代理程式記憶體中的密碼

刪除儲存在代理程式記憶體中的密碼,或刪除所有代理程式儲存的密碼。

刪除使用者認證

刪除 IA-Connect Agent 工作階段中使用者設定檔中的認證。 您可以從 Windows 控制台檢視認證。

刪除檔案

刪除執行 IA-Connect Agent 的電腦上的檔案。

刪除檔案

刪除指定資料夾中符合執行 IA-Connect Agent 之電腦上模式的檔案。

刪除目錄

刪除執行 IA-Connect Agent 的電腦上的目錄 (資料夾)。

取得 CSV 文字作為集合

在執行 IA-Connect Agent 的電腦上傳回 CSV 檔案作為集合 (資料表)。 只需要對 CSV 檔案的唯讀存取權。

取得 Director 用戶端類型和工作階段資訊

傳回第 1 層導向器所處理之本機或遠端工作階段的詳細資料。

取得 IA-Connect Agent 全域座標設定

擷取 IA-Connect Agent 全域座標系統組態的組態,用於顯示元素位置 (例如:在滑鼠檢查期間) 和計算滑鼠位置 (例如:執行全域滑鼠動作時)。

取得 IA-Connect Director 正常運作時間

傳回此 IA-Connect 導向器的運作時間(以秒為單位)(即導向器已執行的時間長度)。

取得 IA-Connect Director 記錄層級

傳回目前的 IA-Connect 導向器記錄層級。 記錄層級設定為 0 到 4。 0 為停用。 1 是最低的日誌層級 (也是預設值)。 4 是最高對數層級。

取得 IA-Connect 代理程式會話資訊

傳回有關 IA-Connect 代理程式使用者工作階段的資訊。

取得 IA-Connect 代理程式目前授權狀態

傳回 IA-Connect 代理程式目前是否已授權,以及授權的內容(如果已授權)。

取得 IA-Connect 代理程式程序計數

傳回目前在使用者工作階段中執行的 IA-Connect Agent 實例數目。 這對於偵測 IA-Connect Agent 是否有多個執行個體正在執行中非常有用。

取得 IA-Connect 代理程式記錄

傳回目前 IA-Connect 代理程式日誌,可以是檔案,或是讀取內容,然後以輸出變數傳回。

取得 IA-Connect 代理程式記錄層級

傳回目前 IA-Connect 代理程式記錄層級。 記錄層級設定為 1 到 4,其中 1 是最低層級,4 是最高層級。

取得 Orchestrator 狀態

擷取基本 Orchestrator 狀態。 這可用來確認 Orchestrator 可用且正在回應。

取得 Orchestrator 背景工作者清單

擷取向 IA-Connect Orchestrator 註冊的工作者清單及其即時狀態。

取得 Orchestrator 背景工作角色

擷取向 IA-Connect Orchestrator 註冊之個別工作者的詳細資料和即時狀態。

取得 Orchestrator 背景工作角色可用性狀態

擷取基本 Orchestrator 狀態。 這可用來確認 Orchestrator 可用且正在回應。

取得 Orchestrator 自動化工作

擷取特定的 Orchestrator 自動化工作。

取得 Orchestrator 自動化工作作業

提供唯一工作作業 [作業識別碼],以擷取特定的 Orchestrator 自動化工作。

取得上次輸入的資訊

取得自 IA-Connect 代理程式使用者工作階段中收到上次使用者輸入以來的時間。

取得下一個 Orchestrator 自動化工作

擷取符合指定搜尋條件的下一個 Orchestrator 自動化工作。 只能擷取「新增」和「延遲」任務 (已達到延遲日期)。 不會擷取保留工作。

取得下一個躍點狀態 IA-Connect

報告接收此命令的代理的下一跳控制器狀態。 如果啟用了下一跳,則該代理會將命令轉發到下一跳(通過下一跳控制器)。 如果停用下一躍點,則該代理程式會自行處理命令 (預設值)。

取得代理程式執行緒

傳回代理程式執行緒清單。 代理程式執行緒可用來執行執行緒中的特定動作,允許動作長時間執行 (長於 RPA 逾時) 或與其他動作平行執行。 一般而言,一旦代理程式執行緒完成並擷取其資料,代理程式執行緒就會被刪除,且不會出現在執行緒清單中。

取得儲存的密碼

擷取先前產生或儲存的密碼。

取得剪貼簿

取得 IA-Connect Agent使用者工作階段中剪貼簿的目前內容。

取得印表機清單

傳回 IA-Connect 代理程式工作階段中所有可用印表機的清單。

取得可用的 IA-Connect 課程

擷取 IA-Connect Director 工作階段的清單 (與執行 IA-Connect Agent 之工作階段的可用連線,例如本機、Microsoft RDP 或 Citrix ICA)。

取得所有 IA-Connect 命令統計資料

傳回目前儲存的所有統計資料,以瞭解 IA-Connect Agent 在目前階段作業中執行的命令。

取得所有 Orchestrator 自動化工作

擷取符合篩選條件的所有 Orchestrator 自動化工作。

取得檔案

傳回執行 IA-Connect Agent 之電腦上資料夾 (符合 CSV 模式清單) 中的檔案清單。

取得檔案大小

傳回執行 IA-Connect Agent 之電腦上檔案的大小 (以位元組為單位)。

取得檔案安全性權限

傳回目前在執行 IA-Connect Agent 之電腦上的檔案上設定的權限清單。

取得流程

傳回 IA-Connect Agent 使用者階段作業中執行中的處理程序清單。 您可以選擇性地透過提供處理程序名稱來過濾。

取得滑鼠移動方法

取得目前的滑鼠移動方法。

取得父進程識別碼

傳回具有指定處理程序 ID 的 IA-Connect Agent 使用者階段作業中任何執行中處理程序的父處理程序的處理程序 ID。

取得環境資訊

傳回 IA-Connect Agent 使用者工作階段執行環境的相關資訊。

取得用戶端主機名稱

傳回執行 IA-Connect Director 之用戶端的主機名稱。

取得目前的滑鼠座標

使用 setcursorpos API 取得 IA-Connect Agent 使用者工作階段中的目前滑鼠游標位置。

取得磁碟可用空間

傳回執行 IA-Connect Agent 之電腦上指定磁碟的可用空間量。

取得磁碟機清單

傳回執行 IA-Connect Agent 之電腦上的磁碟機清單。

取得螢幕解析度

傳回 IA-Connect 代理使用者工作階段的螢幕解析度。 對於在實體桌上型電腦或筆記型電腦上執行的 IA-Connect 本機代理程式,這將提供有關所有顯示裝置及其縮放的資訊。 在虛擬機器上,通常只會報告一個顯示器,除非虛擬機器已設定為顯示多個顯示器 (不常見)。 在遠端會話中,通常只會報告一個顯示器,即使該顯示器跨越多個本機顯示器,因為遠端會話通常會建立單一虛擬顯示器。

取得資料夾

傳回執行 IA-Connect Agent 之電腦上指定資料夾內的所有子資料夾。

取得資料夾安全性權限

傳回目前在執行 IA-Connect Agent 的電腦上資料夾上設定的權限清單。

取得進程識別碼命令列屬性

傳回 IA-Connect Agent 使用者階段作業中具有指定處理程序 ID 的任何執行中處理程序的命令列內容。

取得電腦名稱

傳回執行 IA-Connect Agent 使用者工作階段的電腦名稱。

取得電腦網域

傳回執行 IA-Connect Agent 使用者工作階段之電腦的網域。

取得預設印表機

取得 IA-Connect 代理程式階段作業中使用者的預設印表機名稱。

啟動遠端桌面工作階段 (RDS)

使用 RDP 啟動檔案啟動遠端桌面工作階段 (RDS)。

啟用 IA-Connect 下一個躍點

啟用下一個躍點,該躍點會將接收到的所有未來命令轉發到下一個躍點會話中運行的 IA-Connect 代理程式。

啟用資料夾安全性繼承

在執行 IA-Connect Agent 的電腦上的資料夾上啟用安全性繼承。

在座標之間拖曳滑鼠中鍵

在 IA-Connect 代理程式使用者工作階段中的兩個指定座標之間執行滑鼠中鍵拖曳。 目前作用中的滑鼠移動 API (mouse_event 或 setcursorpos) 用於移動滑鼠。 計算座標時會考慮 DPI 縮放和多個顯示。 滑鼠移動支援可選的抖動,使其更像人手移動。

在座標之間拖曳滑鼠右鍵

在 IA-Connect 客服專員使用者工作階段中的兩個指定座標之間執行滑鼠右鍵拖曳。 目前作用中的滑鼠移動 API (mouse_event 或 setcursorpos) 用於移動滑鼠。 計算座標時會考慮 DPI 縮放和多個顯示。 滑鼠移動支援可選的抖動,使其更像人手移動。

在座標之間拖曳滑鼠左鍵

在 IA-Connect 客服專員使用者工作階段中的兩個指定座標之間執行滑鼠左鍵拖曳。 目前作用中的滑鼠移動 API (mouse_event 或 setcursorpos) 用於移動滑鼠。 計算座標時會考慮 DPI 縮放和多個顯示。 滑鼠移動支援可選的抖動,使其更像人手移動。

在座標之間移動滑鼠

在 IA-Connect 客服專員使用者工作階段中的兩個指定座標之間移動滑鼠。 目前作用中的滑鼠移動 API (mouse_event 或 setcursorpos) 用於移動滑鼠。 計算座標時會考慮 DPI 縮放和多個顯示。 滑鼠移動支援可選的抖動,使其更像人手移動。

在座標處取得像素色彩

傳回指定座標處圖元的 RGB 色彩。

在座標處按一下滑鼠中鍵

在指定座標處按一下 IA-Connect Agent 使用者工作階段中的滑鼠中鍵。 目前作用中的滑鼠移動 API (mouse_event 或 setcursorpos) 用於移動滑鼠。 計算座標時會考慮 DPI 縮放和多個顯示。

在座標處按一下滑鼠右鍵

在指定座標處按一下 IA-Connect Agent 使用者工作階段中的滑鼠右鍵。 目前作用中的滑鼠移動 API (mouse_event 或 setcursorpos) 用於移動滑鼠。 計算座標時會考慮 DPI 縮放和多個顯示。

在座標處按一下滑鼠左鍵

在指定座標處按一下 IA-Connect 客服專員使用者工作階段中的滑鼠左鍵。 目前作用中的滑鼠移動 API (mouse_event 或 setcursorpos) 用於移動滑鼠。 計算座標時會考慮 DPI 縮放和多個顯示。

在座標處按住滑鼠中

在 IA-Connect 客服專員使用者工作階段中的指定座標處按住滑鼠中鍵指定的秒數。 目前作用中的滑鼠移動 API (mouse_event 或 setcursorpos) 用於移動滑鼠。 計算座標時會考慮 DPI 縮放和多個顯示。

在座標處按住滑鼠右鍵

在 IA-Connect 客服專員使用者工作階段中的指定座標處按住滑鼠右鍵指定的秒數。 目前作用中的滑鼠移動 API (mouse_event 或 setcursorpos) 用於移動滑鼠。 計算座標時會考慮 DPI 縮放和多個顯示。

在座標處按住滑鼠左鍵

在 IA-Connect 代理程式使用者工作階段中的指定座標處按住滑鼠左鍵指定的秒數。 目前作用中的滑鼠移動 API (mouse_event 或 setcursorpos) 用於移動滑鼠。 計算座標時會考慮 DPI 縮放和多個顯示。

在座標處雙擊滑鼠左鍵

在指定座標處按兩下 IA-Connect Agent 使用者工作階段中的滑鼠左鍵。 目前作用中的滑鼠移動 API (mouse_event 或 setcursorpos) 用於移動滑鼠。 計算座標時會考慮 DPI 縮放和多個顯示。

在螢幕上繪製矩形

在螢幕上繪製矩形,以協助識別螢幕座標,或報告螢幕座標的動作輸出。 矩形會在 5 秒後自動移除。

在資料夾上設定擁有者

在執行 IA-Connect Agent 的電腦上設定資料夾的擁有者。

執行 PowerShell 程式

啟動 PowerShell 進程,在磁碟上執行現有的腳本,或提供要執行的腳本內容。 請考慮改用「執行 PowerShell 腳本」動作,這動作功能更強大,並提供 PowerShell 腳本輸出的資料表。 如果您的 PowerShell 指令碼輸出為標準輸出或標準錯誤 (例如,使用 Write-Host 而不是傳回資料表)、需要 PowerShell 7,或以替代使用者身分執行 Active Directory 動作,且無法透過 WinRM 使用 CredSSP,請使用此動作。

執行一般 IA-Connect 代理程式命令

執行一般 IA-Connect 代理程式命令,將引數傳遞為 JSON,並將輸出資料傳回為 JSON。 當 Director 和 Inspector 的版本比 Agent 舊,因此無法理解命令時,用於執行 Agent 命令。

執行替代 IA-Connect 代理程式

從檔案位置載入代理程式可執行檔,以執行替代 IA-Connect 代理程式 (例如更新版本)。

執行替代 IA-Connect 從導向器傳送的代理程式

從 IA-Connect Director 上傳替代代理程式,然後載入替代代理程式可執行檔,以執行替代 IA-Connect 代理程式 (例如更新版本)。

執行程序

啟動進程、命令或應用程式。

寫入 CSV 檔案

在執行 IA-Connect Agent 的電腦上建立 CSV 檔案。 CSV 檔案是從集合 (表格) 或 JSON 格式的資料表建立。

寫入使用者認證

在 IA-Connect Agent 工作階段中將使用者設定檔中的認證寫入使用者設定檔中的認證,如果該認證不存在,則建立該認證。 您可以從 Windows 控制台檢視認證。

寫入文字檔案

在執行 IA-Connect Agent 的電腦上建立文字檔,並將文字寫入檔案。

將 IA-Connect 代理程式 GUI 置於最前面

將 IA-Connect 代理程式 GUI 帶到前面,使其在螢幕上可見。

將 IA-Connect 代理程式 GUI 設定為最頂層

將 IA-Connect 代理程式設定為最上層。 這意味著 IA-Connect 代理將始終在屏幕上可見,並且不能隱藏在其他應用程序窗口後面。

將密碼儲存在代理程式記憶體中

將密碼儲存到代理程式記憶體 (加密) 中,以便從支援儲存密碼的任何動作中使用密碼。 密碼僅儲存在記憶體中,並在代理程式關閉時遺失。

將所有者存檔

在執行 IA-Connect Agent 的電腦上設定檔案的擁有者。

將檔案從用戶端複製到伺服器

將檔案從本機電腦 (執行 IA-Connect Director) 複製到遠端電腦 (執行 IA-Connect Agent)。

將檔案新增至 ZIP

壓縮檔案 (將檔案儲存到壓縮封存中)。

將檔案複製到剪貼簿

將指定的本機檔案複製到 IA-Connect Agent 使用者工作階段中的剪貼簿。

將權限新增至資料夾

將權限新增至執行 IA-Connect Agent 的電腦上的資料夾。

將流程標記為完成

將流程標示為完成,這會通知 IA-Connect Orchestrator 指派的工作機器現在可用於處理其他流程。

將訊息傳送至 Web API

將訊息傳送至 Web API 並接收回應。 這可以與任何 Web API 搭配使用,但常見的用法是 REST API。 IA-Connect 支援從虛擬機器 (即存取內部部署資源) 或透過 Citrix 或 Microsoft 遠端桌面工作階段 (例如,僅從隔離環境存取 API) 將訊息傳送至 Web API。

將資料夾新增至 ZIP

將資料夾中的檔案壓縮成 ZIP 檔案 (將檔案儲存到壓縮封存中)。

將附註新增至 Orchestrator 自動化工作

將附註新增至選取的 Orchestrator 自動化工作。 此附註將傳遞至與此自動化工作連結的來源系統 (例如 ServiceNow),最常用於將詳細資料新增至票證。 如果 Orchestrator 自動化工作未連結至來源,則會引發例外狀況。

展開密碼字串

接受輸入字串,其中包含對 IA-Connect 儲存密碼的參考,並傳回該字串,並將參考取代為儲存的密碼。

展開環境變數

展開包含環境變數 (例如 %USERPROFILE% 或 %TEMP%) 的字串,以在 IA-Connect Agent 使用者工作階段中展開。

左鍵按住滑鼠

在 IA-Connect 客服專員使用者工作階段中按住滑鼠左鍵指定的秒數。

延遲現有的 Orchestrator 自動化工作

延遲已在佇列中的現有 Orchestrator 工作。 該任務將推遲到未來的指定時間。 這通常用於重新延遲現有任務(即任務之前被推遲,現在需要再次推遲)。 使用此動作可暫時暫停任務指定的時間量 (例如,如果您正在等待某項內容)。

延遲現有的 Orchestrator 自動化工作作業

延遲已在佇列中的現有 Orchestrator 工作。 該任務將推遲到未來的指定時間。 這通常用於重新延遲現有任務(即任務之前被推遲,現在需要再次推遲)。 使用此動作可暫時暫停任務指定的時間量 (例如,如果您正在等待某項內容)。

建立 Orchestrator 一次性密碼

一次性密碼提供儲存密碼的功能,該密碼可透過不可猜測的唯一 URL 擷取一次。 這通常用於與第三方共享秘密。 您可以使用 Orchestrator UI、REST API 或從流程建立一次性密碼。

建立目錄

在執行 IA-Connect Agent 的電腦上建立目錄 (資料夾)。

建立遠端桌面工作階段 (RDS) 啟動檔案

建立遠端桌面工作階段 (RDS) 啟動檔案,可用來使用指定的參數自動啟動遠端桌面工作階段,而不需要自動化遠端桌面用戶端 UI。 RDS 啟動檔案的副檔名為「.rdp」,通常稱為 RDP 檔案。

引發例外狀況

如果輸入異常狀況不是空白,請使用指定的訊息引發異常狀況。 這對於觸發流程中的例外狀況訊息 (HTTP 400) 很有用,如果先前的動作發生錯誤,則錯誤處理階段會攔截該訊息。 此例外狀況不會記錄在 IA-Connect Orchestrator 流程執行統計資料中。

從 Orchestrator 取得一般認證

擷取已儲存在 IA-Connect Orchestrator 中的一般認證。 認證可以保存使用者名稱、密碼、主機名稱、URL 和其他一般資料。

從 Orchestrator 取得流量統計資料

從 IA-Connect Orchestrator 傳回流量統計資料清單。 用於報告目的。 您可以選擇性地使用一或多個篩選器來限制傳回的結果。

從 Orchestrator 取得登入記錄

傳回 IA-Connect Orchestrator 登入記錄以供報告之用。 您可以選擇性地使用一或多個篩選器來限制傳回的結果。

從 Orchestrator 取得背景工作流程使用量熱圖

從 IA-Connect Orchestrator 傳回工作流程使用量每日熱圖。 用於報告目的。 您可以選擇性地使用一或多個篩選器來限制傳回的結果。

從 Orchestrator 取得背景工作者可用性統計資料

從 IA-Connect Orchestrator 傳回背景工作者可用性統計資料。 用於報告目的。 您可以選擇性地使用一或多個篩選器來限制傳回的結果。

從 Orchestrator 流程統計資料取得上次失敗的動作

擷取透過 IA-Connect Orchestrator 傳遞至背景工作角色的最後一個動作的詳細資料 (如果該動作失敗)。 此動作最常在錯誤處理期間使用。

從 Orchestrator 配置背景工作角色

從 IA-Connect Orchestrator 配置背景工作者。 您可以依標籤或工作者名稱 (或兩者都不,或兩者) 請求工作者,讓您更精確地選擇所需的工作者。 配置工作者後,它會指派給您的流程,並報告為執行工作。 請注意,執行配置時,Orchestrator 仍會考慮「支援的流量環境識別碼」、「支援的流量名稱」和「不支援的流量名稱」。 當多個背景工作者符合搜尋時,將套用一般負載平衡規則。

從使用者認證讀取

在 IA-Connect 代理程式工作階段中,從使用者設定檔中的認證讀取使用者名稱和密碼。 您可以從 Windows 控制台檢視認證。 使用者名稱和密碼都可以從一般認證中擷取,而只能從 Windows 認證中擷取使用者名稱。

從文件中讀取所有文本

讀取執行 IA-Connect Agent 的電腦上檔案的文字內容。

從檔案安全性中移除身分識別

從執行 IA-Connect Agent 之電腦上檔案的安全性權限中移除身分識別 (例如使用者、群組或電腦)。

從流程結果 JSON 取得失敗動作錯誤訊息

還原序列化一或多個流程 result() 運算式的 JSON 輸出,並從失敗的動作擷取第一個找到的錯誤訊息。 錯誤訊息可以以多種格式儲存在 JSON 中。 此動作會處理已知格式,並傳回第一個找到的錯誤訊息。

從資料夾安全性中移除身分識別

從執行 IA-Connect Agent 之電腦上資料夾的安全性權限中移除身分識別 (例如使用者、群組或電腦)。

截圖

擷取 IA-Connect 代理程式使用者工作階段的螢幕擷取畫面,並將其傳回為 Base64 編碼字串。

指派 Orchestrator 自動化工作

將選取的 Orchestrator 自動化工作指派給指定的使用者或群組。 此指派將傳遞至與此自動化工作連結的來源系統 (例如 ServiceNow),而且最常用於將摘記卷傳遞給不同的人員或群組,以進行其他處理。 如果 Orchestrator 自動化工作未連結至來源,則會引發例外狀況。

按名稱終止 IA-Connect 會話

終止指定的 IA-Connect Director 工作階段 (如果存在)。 這是將命令傳送到 IA-Connect 代理程式的階段作業。 該名稱將從早期的“附加”操作中得知。

擷取代理程式執行緒的狀態

擷取代理程式執行緒的狀態,並選擇性地擷取執行緒輸出資料。 代理程式執行緒可用來執行執行緒中的特定動作,允許動作長時間執行 (長於 RPA 逾時) 或與其他動作平行執行。

擺動滑鼠

將滑鼠來回移動指定的座標數目。 目前作用中的滑鼠移動 API (mouse_event 或 setcursorpos) 用於移動滑鼠。

新增 Orchestrator 延遲工作

將新的 Orchestrator 延遲工作新增至可從流量監控的佇列。 該任務將推遲到未來的指定時間。 使用此動作可暫時暫停任務指定的時間量 (例如,如果您正在等待某項內容)。

新增 Orchestrator 自動化工作

將新的 Orchestrator 自動化工作新增至可從流量監控的佇列。 工作可以準備好立即執行,也可以延遲稍後執行。

新增 Orchestrator 自動化工作作業

新增新的 Orchestrator 自動化工作,並接收作業識別碼。如果工作由外部輪詢程式或 Orchestrator 觸發程序處理,則需要特定工作名稱。 此動作與「新增 Orchestrator 自動化工作」(TasksAddNewTaskOperation) 不同,因為它會以無法猜測的作業識別碼 (Operation ID) 回應,而不是可猜測的工作識別碼。

新增新的 Orchestrator 延遲工作作業

新增新的 Orchestrator 延遲工作,並接收作業識別碼。該任務將推遲到未來的指定時間。 使用此動作可暫時暫停任務指定的時間量 (例如,如果您正在等待某項內容)。 如果工作由外部輪詢程式或 Orchestrator 觸發程序處理,則需要特定工作名稱。 此動作與「新增 Orchestrator 延遲工作」(TasksAddNewDeferral) 不同,因為它會以無法猜測的作業識別碼 (Operation Id) 回應,而不是可猜測的工作識別碼。

新增檔案權限

將權限新增至執行 IA-Connect Agent 的電腦上的檔案。

是否啟用螢幕助讀程式

傳回螢幕助讀程式是否已在 IA-Connect 代理程式使用者工作階段中啟用。

更新 Orchestrator 流程統計資料結果

更新 IA-Connect Orchestrator 中目前工作流程的結果統計資料。 這可用來修改 IA-Connect Orchestrator 中流量統計資料的最終結果,這通常用於報告目的。 這僅適用於目前的流量 (Orchestrator 會偵測到流量執行識別碼)。 您無法修改任何其他流程的統計資料。

替換 INI 文件中的變量數據

更新 INI 檔案中的單一變數。

會話是否已鎖定

報告執行 IA-Connect Agent 的工作階段是否已鎖定。

校準mouse_event

將滑鼠移動指定的像素數,然後讀取新的滑鼠位置,以校準mouse_event方法。

檔案存在嗎

報告 true 或 false 來判斷執行 IA-Connect Agent 的電腦上是否存在檔案。

殺死所有其他 IA-Connect 特工

終止目前在使用者工作階段中執行的 IA-Connect Agent 的任何其他實例。 這將確保只有一個 IA-Connect 代理程式執行個體正在執行。

清除剪貼簿

清除 IA-Connect Agent 使用者工作階段中剪貼簿的內容。

清除目錄

清除執行 IA-Connect Agent 的電腦上的目錄 (資料夾),移除目錄內儲存的所有檔案。

滑鼠中置

在 IA-Connect 客服專員使用者工作階段中按住滑鼠中鍵指定的秒數。

滑鼠中鍵

按一下 IA-Connect Agent 使用者工作階段中的滑鼠中鍵。

滑鼠中鍵向上

在 IA-Connect 客服專員使用者工作階段中釋放滑鼠中鍵。

滑鼠中鍵向下

在 IA-Connect 代理程式使用者工作階段中按下 (且不放開) 滑鼠中鍵。 若要釋放滑鼠,請使用滑鼠中鍵向上操作。

滑鼠右鍵

按一下 IA-Connect Agent 使用者工作階段中的滑鼠右鍵。

滑鼠右鍵

在 IA-Connect 客服專員使用者工作階段中按住滑鼠右鍵指定的秒數。

滑鼠右鍵向上

在 IA-Connect 代理程式使用者工作階段中釋放滑鼠右鍵。

滑鼠右鍵向下

在 IA-Connect 代理程式使用者工作階段中按下(且不放開)滑鼠右鍵。 若要釋放滑鼠,請使用滑鼠右鍵向上動作。

滑鼠左鍵

按一下 IA-Connect Agent 使用者階段作業中的滑鼠左鍵。

滑鼠左鍵向上

在 IA-Connect 客服專員使用者工作階段中釋放滑鼠左鍵。

滑鼠左鍵向下

在 IA-Connect 代理程式使用者階段作業中按下 (且不放開) 滑鼠左鍵。 若要釋放滑鼠,請使用滑鼠左鍵向上動作。

獲取 IA-Connect 代理信息

傳回 IA-Connect Agent 的屬性,包括版本號碼和 Agent 可執行檔的路徑。

獲取 IA-Connect 導演信息

傳回 IA-Connect Director 的屬性,包括版本號碼和 Director 可執行檔的路徑。

獲取鼠標乘數

擷取 IA-Connect 代理程式使用者工作階段中的全域滑鼠乘數。 這預設為 (1, 1),但可以透過「設定滑鼠乘數」操作進行更改。

產生密碼

產生密碼,其中包含範本格式中定義的字典單字、數字、符號、字元。

登出遠端工作階段

登出執行 IA-Connect Agent 的遠端工作階段。

目錄是否可存取

傳回目錄 (資料夾) 是否可存取,以及權限是否限制在 IA-Connect 代理程式所在電腦上存取該目錄。

目錄是否存在

報告 true 或 false 以顯示執行 IA-Connect Agent 的電腦上是否存在目錄 (資料夾)。

移動檔案

在執行 IA-Connect Agent 的電腦上移動檔案。

移動滑鼠以協調

將 IA-Connect 代理程式使用者工作階段中的滑鼠移至指定的圖元座標。 目前作用中的滑鼠移動 API (mouse_event 或 setcursorpos) 用於移動滑鼠。 計算座標時會考慮 DPI 縮放和多個顯示。

移動滑鼠相對

在 IA-Connect 客服專員使用者工作階段中,相對於其目前位置,將滑鼠移動指定的像素數。 目前作用中的滑鼠移動 API (mouse_event 或 setcursorpos) 用於移動滑鼠。 計算座標時會考慮 DPI 縮放和多個顯示。

等待 IA-Connect 階段作業依名稱關閉

等待指定的 IA-Connect Director 工作階段結束。 這是將命令傳送到 IA-Connect 代理程式的階段作業。 該名稱將從早期的“附加”操作中得知。

等待下一個躍點工作階段連線 IA-Connect

等待下一個躍點工作階段連線,並等待 IA-Connect Agent 在下一個躍點工作階段中執行。

等待代理程式執行緒成功完成

等候代理程式執行緒完成,並選擇性地擷取執行程輸出資料。 代理程式執行緒可用來執行執行緒中的特定動作,允許動作長時間執行 (長於 RPA 逾時) 或與其他動作平行執行。 如果代理程式執行緒完成,但失敗,則會引發例外狀況。

終止代理程式執行緒

終止(終止、中止)代理程式執行緒。 代理程式執行緒可用來執行執行緒中的特定動作,允許動作長時間執行 (長於 RPA 逾時) 或與其他動作平行執行。 不會刪除代理程式執行緒 (使用動作「刪除代理程式執行緒」來刪除執行緒),以容許監視代理程式執行緒的任何處理程序或流程收到「IA-Connect 代理程式執行緒已中止」錯誤。

終止進程

終止 IA-Connect Agent 使用者階段作業中具有指定處理程序名稱的任何執行中處理程序。

終止進程識別碼

終止 IA-Connect Agent 使用者工作階段中具有指定處理程序 ID 的執行中處理程序。處理程序 ID 是唯一的,因此只有一個處理程序可以符合識別碼。處理程序識別碼是動態的,並且每次啟動應用程式都不同。

複製檔案

複製執行 IA-Connect Agent 的電腦上的檔案。

解鎖工作階段

解除鎖定 IA-Connect Agent 正在執行的工作階段。 這需要在裝載會話的電腦上安裝 IA-Connect Unlocker 認證提供者,因為只有認證提供者可以解除鎖定電腦。

設定 IA-Connect 代理程式 GUI 不透明度

將 IA-Connect 代理程式的不透明度從 1 (可見) 設定為 0 (透明)。

設定 IA-Connect 代理程式 GUI 位置

將 IA-Connect 代理程式 GUI 的螢幕位置設定為指定位置。

設定 IA-Connect 代理程式全域座標設定

配置 IA-Connect Agent 全域座標系統,用於顯示元素位置 (例如:在滑鼠檢查期間) 和計算滑鼠位置 (例如:執行全域滑鼠動作時)。 預設值提供最新的功能,但您可以使用此動作來還原為舊版代理程式中的行為,或指定 API 使用不同的座標系統。

設定 IA-Connect 代理程式命令逾時

設定 IA-Connect Agent 將用於執行的每個命令的命令逾時。

設定 IA-Connect 代理程式記錄層級

將 IA-Connect 代理程式記錄層次設定為指定的值 (1 是最低層次,4 是最高層次)。

設定 IA-Connect 導向器日誌層級

將 IA-Connect 導向器記錄層級設定為指定的值。 記錄層級設定為 0 到 4。 0 為停用。 1 是最低的日誌層級 (也是預設值)。 4 是最高對數層級。

設定 IA-Connect 授權代碼

將舊式 (7.0 和 7.1) 代理程式網域授權上傳至 IA-Connect 代理程式。

設定 IA-Connect 授權金鑰

使用授權金鑰授權 IA-Connect Agent。 這可以是授權字串,也可以是 IA-Connect Orchestrator 中保留的授權易記名稱。

設定 Orchestrator 背景工作角色維護模式

將 IA-Connect Orchestrator 中定義的 IA-Connect 工作角色置於維護模式 (因此不會將流程指派給工作角色),或將工作角色從維護模式中移出。

設定 Orchestrator 自動化工作輸出資料

設定 Orchestrator 自動化工作的輸出資料。 當您已完成任務並希望提供輸出資料時,通常會使用,這些資料由建立任務的程序收集。

設定下一個躍點 IA-Connect Director

在雙躍點場景中配置下一躍點導向器。 只有在預設 IA-Connect 下一跳導向器設定不合適時,才需要這樣做。

設定剪貼簿

在 IA-Connect 客服專員使用者工作階段中設定剪貼簿的內容。

設定滑鼠乘數

在 IA-Connect 代理程式使用者工作階段中設定全域滑鼠乘數。 如果您在開發過程中遇到遠端桌面擴展問題,這會很有用。

設定滑鼠游標位置

將 IA-Connect 代理程式使用者階段作業中的滑鼠游標設定為指定位置。 setcursorpos API 可用來移動滑鼠,而不論所選擇的作用中滑鼠移動 API 為何。

設定滑鼠移動方式

將目前的滑鼠移動方法設定為 mouse_event 或 setcursorpos。

設定螢幕助讀程式

啟用或停用 IA-Connect Agent 使用者工作階段中的螢幕助讀程式。

設定預設印表機

在 IA-Connect 代理程式工作階段中為使用者設定預設印表機。

變更 Orchestrator 自動化工作狀態

變更選取的 Orchestrator 自動化工作狀態或其他工作內容。

轉動滑鼠滾輪

轉動 IA-Connect 代理程式使用者工作階段中的滑鼠滾輪 (正或負凹口)。

轉換矩形座標

將矩形圖元座標從虛擬轉換成實體,或將實體轉換成虛擬。 如果您想轉換一個點,只需設定右=左和底部=上即可。 實體座標會直接對應至監視器上的像素。 虛擬座標是 DPI 縮放的。 如果所有顯示裝置的底層顯示縮放比例為 100%,則實體座標和虛擬座標都相同。

連接至第 1 層 IA-Connect 階段作業

附加至接收 SOAP 和/或 REST 訊息的導向器的 IA-Connect 導向器會話。 這是將命令傳送到 IA-Connect 代理程式的階段作業。

重設 IA-Connect 指令統計資料

重設目前儲存的任何統計資料,以瞭解 IA-Connect Agent 在目前階段作業中執行的命令。

重設下一個躍點 IA-Connect 導向器設定

重設任何已設定的自訂 IA-Connect Director 設定,並恢復預設設定。

鎖定工作階段

鎖定 IA-Connect Agent 正在執行的工作階段。

關閉 IA-Connect 代理程式

關閉 IA-Connect 代理程式。 這不會影響執行 IA-Connect Agent 的使用者工作階段。

附加至最近的 IA-Connect 工作階段

附加至最近連線的 IA-Connect 導向器工作階段 (選擇性地指定類型)。 這是將命令傳送到 IA-Connect 代理程式的階段作業。

雙擊滑鼠左鍵

按兩下 IA-Connect Agent 使用者工作階段中的滑鼠左鍵。

IA-Connect 階段作業是否依名稱存在

如果指定的 IA-Connect Director 工作階段存在,則傳回。 這是將命令傳送到 IA-Connect 代理程式的階段作業。 該名稱將從早期的“附加”操作中得知。

參數

名稱 機碼 必要 類型 Description
IA-Connect 階段作業名稱
IAConnectSessionName True string

要檢查的 IA-Connect 工作階段名稱。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
IA-Connect 階段作業存在
IAConnectSessionExists boolean

如果具有指定名稱的會話存在,則傳回 true,如果不存在,則傳回 false。

TCP 連接埠是否回應

報告網路 TCP 連接埠是否正在回應 IA-Connect Agent 的連線嘗試。 這可能是執行 IA-Connect Agent 的電腦上的 TCP 連接埠 (為遠端主機輸入 'localhost') 或任何遠端電腦上的 TCP 連接埠。 如果 IA-Connect 代理程式成功連線到 TCP 連接埠,它會立即關閉 TCP 連線。

參數

名稱 機碼 必要 類型 Description
遠端主機
RemoteHost True string

要連線的電腦的 IPv4 位址、DNS 位址或主機名稱。 輸入 'localhost' 以檢查執行 IA-Connect Agent 的電腦上的 TCP 連接埠。 範例:192.168.1.10 或 www.test.com 或 vm-server19。

TCP 通訊埠
TCPPort True integer

要在指定遠端(或本機)主機上連線的TCP埠號。 TCP 連接埠必須為 1 或更高且 65535 或更低。 常見的已知連接埠範例有 80 (HTTP)、443 (HTTPS)、445 (SMB/檔案共用)。

逾時 (秒)
TimeoutInSeconds integer

等待 TCP 連線的秒數上限。 這預設為 10 秒,但大多數工作連線預計會在幾秒鐘內 (透過網際網路) 或不到一秒鐘 (區域網路) 連線。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
已連接TCP埠
TCPPortConnected boolean

如果 TCP 連接埠已連線,則設定為 true,如果 TCP 連接埠無法連線,則設定為 false。

連線錯誤訊息
ConnectionErrorMessage string

如果 TCP 連接埠無法連線,則會出現錯誤訊息。 這通常是 DNS/名稱查找錯誤或超時。

UnZIP 檔案

解壓縮已使用 ZIP 壓縮壓縮的檔案。

參數

名稱 機碼 必要 類型 Description
ZIP 檔案路徑
ZIPFilename True string

要解壓縮的 ZIP 檔案的完整路徑。 這必須可從執行 IA-Connect Agent 的階段作業存取。

解壓縮資料夾
ExtractFolder string

要解壓縮 ZIP 的資料夾的資料夾路徑。 這必須可從執行 IA-Connect Agent 的階段作業存取。

將所有文件解壓縮到單個文件夾
ExtractAllFilesToSingleFolder boolean

如果設定為True,則會忽略ZIP內的資料夾結構,並將所有檔案解壓縮到指定的資料夾中。

包含檔案正規表示式
IncludeFilesRegEx string

選擇性的正規表示式,可讓您指定應擷取哪些檔案。 僅匹配文件名。

排除檔案正規表示式
ExcludeFilesRegEx string

選擇性正規表示式,可讓您指定應從擷取中排除哪些檔案。 僅匹配文件名。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
成功擷取的檔案數
FilesExtractedSuccessfully integer

成功從 ZIP 擷取的檔案數目。

無法擷取的檔案數目
FilesFailedToExtract integer

無法從 ZIP 擷取的檔案數目。

排除的檔案數目
FilesExcluded integer

已排除的檔案數目 (如果使用「排除檔案正規表示式」輸入)。

下載 HTTP 檔案

使用 HTTP(S) 將檔案下載到執行 IA-Connect Agent 的電腦。

參數

名稱 機碼 必要 類型 Description
下載網址
DownloadURL True string

HTTP 或 HTTPS 下載 URL。

儲存檔案路徑
SaveFilename string

儲存檔名的完整路徑。 如果此欄位為空白,且您已將「將內容傳回為字串」指定為 True,則檔案將不會儲存至電腦。

覆寫現有檔案
OverwriteExistingFile boolean

如果檔案已經存在,其名稱在「儲存檔案路徑」輸入中指定,是否應該覆寫它?

傳遞驗證
PassthroughAuthentication boolean

使用者的認證是否應該傳遞至 Web 伺服器? 這通常只會用於內部內部網路網站。

使用者代理程式
UserAgent string

這允許您設置向網頁報告的用戶代理。 通常,這不是必需的,只有在網頁需要特定代理字串時才應變更。

接受
Accept string

此參數指定支援的內容類型。 只有在您下載的內容需要不同的內容類型時,才應更改此設定。

支援 TLS10
SupportTLS10 boolean

設定為 True 以支援 TLS 1.0 加密通訊協定。

支援 TLS11
SupportTLS11 boolean

設定為 True 以支援 TLS 1.1 加密通訊協定。

支援 TLS12
SupportTLS12 boolean

設定為 True 以支援 TLS 1.2 加密通訊協定。

自動解壓縮放氣
AutoDecompressDeflate boolean

某些網頁內容會使用「deflate」壓縮來傳回壓縮。 將此值設定為 True 會通知網頁伺服器支援「排氣」,如果使用此壓縮傳送內容,則會自動解壓縮。

自動解壓縮 GZip
AutoDecompressGZIP boolean

某些網頁內容會使用「GZIP」壓縮來壓縮。 將此值設定為 True 會通知網頁伺服器支援「GZIP」,如果使用此壓縮傳送內容,則會自動解壓縮。

以字串形式傳回內容
ReturnContentsAsString boolean

檔案內容應該以字串的形式傳回嗎?

傳回內容編碼
ReturnContentEncoding string

下載內容的編碼。 只有在「將內容傳回為字串」為 True 且它定義下載內容的編碼,以便正確解譯時,才會使用此選項。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
下載檔案內容
DownloadFileContents string

下載檔案的內容。

中斷資料夾安全性繼承

中斷執行 IA-Connect Agent 之電腦上資料夾的安全性繼承。

參數

名稱 機碼 必要 類型 Description
資料夾路徑
FolderPath True string

資料夾的完整路徑。 這必須可從執行 IA-Connect Agent 的階段作業存取。

將繼承轉換為明確
ConvertInheritedToExplicit boolean

任何目前繼承的權限是否應該轉換為明確權限?

Workflow
Workflow True string

在此處新增下列運算式:workflow()

中斷遠端工作階段的連線

如果 IA-Connect 代理程式在遠端工作階段中執行,此動作會中斷遠端工作階段的連線。 這與登出不同,會讓遠端會話在中斷連線狀態下執行。 此動作可用於您稍後要連線回遠端會話並從相同狀態繼續,而不是啟動新會話。 如果 IA-Connect 代理程式在本機執行,此動作將鎖定工作階段。

參數

名稱 機碼 必要 類型 Description
等待秒數
SecondsToWait integer

在向作業系統發出中斷連線指令之前等待的時間,以便 IA-Connect 代理程式可以在失去聯絡之前報告指令的完成 (這只會發生在遠端階段作業中)。

如果本機代理程式,請勿中斷連線
DoNotDisconnectIfLocalAgent boolean

如果設定為 true,且 IA-Connect 代理程式正在本機工作階段中執行 (,即直接在背景工作者上),則會以無訊息方式忽略此動作。 這很有用,因為中斷本機代理程式的連線會鎖定工作階段,因此會限制 RPA 功能,直到工作階段解除鎖定為止。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

以 Base64 格式獲取文件內容

以 Base64 格式檢索指定文件的內容,這種格式適合通過 API 傳輸,並且可以輕鬆轉換回原始文本或二進制格式。

參數

名稱 機碼 必要 類型 Description
檔案路徑
FilePath True string

檔案的完整路徑。 這必須可從執行 IA-Connect Agent 的階段作業存取。

壓縮
Compress boolean

設定為 true,GZip 會在轉換為 Base64 之前壓縮檔案內容。 檔案未變更,所有操作都在記憶體中執行。 只有在檢索 Base64 之後能夠對文件內容進行 GUnzip 壓縮時,此功能才有用(解碼回原始文件內容文本或二進位數據時)。 如果您要將 Base64 直接傳遞至接受 Base64 作為輸入且沒有 GUnzip 功能的動作,請設定為 false。

檔案大小上限
MaxFileSize integer

檔案的大小上限,超過該大小將引發例外狀況,而不是擷取檔案內容。 這可讓您避免要求代理程式擷取大型檔案的情況,這最終會導致動作逾時。設定為 -1 以停用檔案大小檢查。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
檔案內容為 Base64
FileContentsAsBase64 string

Base64 格式的檔案內容。

依名稱取得處理程序計數

傳回具有指定處理程序名稱的 IA-Connect 代理程式使用者階段作業中執行中的處理程序計數。

參數

名稱 機碼 必要 類型 Description
程序名稱
ProcessName True string

處理程序名稱。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
進程數
NumberOfProcesses integer

符合所提供處理程序名稱的處理程序數目。

依名稱附加至 IA-Connect 階段作業

依名稱附加至指定的 IA-Connect 導向器階段作業。 這是將命令傳送到 IA-Connect 代理程式的階段作業。

參數

名稱 機碼 必要 類型 Description
IA-Connect 階段作業名稱
IAConnectSessionName True string

要連線的 IA-Connect 工作階段名稱。

必須連接虛擬通道
VirtualChannelMustBeConnected boolean

IA-Connect 導向器在連結至會話時,是否應該驗證虛擬通道已連線? 這可確保 IA-Connect 代理程式在指定的工作階段中執行。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

依索引附加至 IA-Connect 工作階段

依索引附加至指定的 IA-Connect Director 工作階段 (例如,附加至第一個 Citrix ICA 工作階段)。 這是將命令傳送到 IA-Connect 代理程式的階段作業。

參數

名稱 機碼 必要 類型 Description
搜尋 IA-Connect 階段作業類型
SearchIAConnectSessionType string

要搜尋的工作階段類型,例如,任何類型的遠端工作階段的「本機代理程式」、「Microsoft RDP」、「Citrix ICA」或「遠端」。 保留空白以搜尋任何工作階段類型。

搜尋 IA-Connect 階段作業索引
SearchIAConnectSessionIndex integer

要連線的會話索引,例如第一個相符的會話類型為 1,第二個相符的會話類型為 2。

等待時間(以秒為單位)
TimeToWaitInSeconds integer

如果具有指定索引的工作階段不存在,IA-Connect 應該等待多長時間?

逾時時引發例外狀況
RaiseExceptionIfTimedout boolean

如果新的會話在逾時期間過後未連線,IA-Connect 是否應該引發例外狀況?

必須連接虛擬通道
VirtualChannelMustBeConnected boolean

IA-Connect 導向器在連結至會話時,是否應該驗證虛擬通道已連線? 這可確保 IA-Connect 代理程式在指定的工作階段中執行。

僅計算以前未見過的工作階段
OnlyCountSessionsNotSeenBefore boolean

如果設為 true,則先前執行的「取得可用的 IA-Connect 工作階段」動作 (或 IA-Connect Inspector 檢視工作階段) 看到的任何工作階段都不會計入索引。 這只允許計算「新」工作階段 (例如,附加到第一個新的 Citrix 工作階段)。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
附加 IA-Connect 工作階段名稱
AttachedIAConnectSessionName string

附加至的 IA-Connect 階段作業的名稱。

附加到工作階段
AttachedToSession boolean

如果 IA-Connect 已附加至會話,則傳回 true,如果沒有,則傳回 false。

依進程識別碼取得進程

傳回具有指定處理程序 ID 的處理程序是否在 IA-Connect 代理程式使用者階段作業中執行。 程序識別碼是唯一的,因此只有一個程序可以符合識別碼。程序識別碼是動態的,並且每次啟動應用程式都不同。

參數

名稱 機碼 必要 類型 Description
進程識別碼
ProcessId True integer

要取得的進程的進程識別碼。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
進程執行中
ProcessRunning boolean

如果找到具有所提供程序識別碼的程序,則傳回 true。

保持工作階段處於活動狀態

透過以指定的間隔移動滑鼠來防止工作階段變成閒置狀態,使 IA-Connect 代理程式使用者工作階段保持運作狀態。

參數

名稱 機碼 必要 類型 Description
X 擺動
XWiggle integer

水平移動滑鼠的像素數。

Y 擺動
YWiggle integer

垂直移動滑鼠的像素數。

擺動延遲(以秒為單位)
WiggleDelayInSeconds double

擺動時滑鼠移動之間的秒數。

閒置臨界值(以秒為單位)
IdleThresholdInSeconds integer

自移動滑鼠前最後一次輸入以來應該經過的秒數。

閒置檢查期間(以秒為單位)
IdleCheckPeriodInSeconds integer

檢查最後一次輸入時間之間的秒數(檢查是否已通過閒置閾值)。

總 keepalive 執行時間 (以秒為單位)
TotalKeepaliveRuntimeInSeconds integer

讓工作階段保持作用中的總秒數。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
指令結果
KeepSessionAliveResult boolean

命令的結果(成功或失敗)。

錯誤訊息
ErrorMessage string

如果指令不成功,則會包含傳回的錯誤訊息。

停止保持工作階段處於作用中狀態

停止 IA-Connect 代理程式使用者工作階段保持作用中狀態。

參數

名稱 機碼 必要 類型 Description
Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
指令結果
StopKeepSessionAliveResult boolean

命令的結果(成功或失敗)。

錯誤訊息
ErrorMessage string

如果指令不成功,則會包含傳回的錯誤訊息。

停用下一個躍點 IA-Connect

停用下一躍點,以便接收這些命令的代理程式處理所有未來的命令(而不是轉發到下一躍點代理程式)。

參數

名稱 機碼 必要 類型 Description
Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳送密碼金鑰

將全域按鍵傳送至 IA-Connect Agent 使用者工作階段,專門用於輸入密碼。 這模擬了用戶按下鍵盤上的這些鍵。 請確定目標 Window 元素已聚焦,或錯誤的應用程式可能會收到按鍵,或被忽略。

參數

名稱 機碼 必要 類型 Description
密碼
Password True password

要輸入的密碼,使用在 IA-Connect 代理程式使用者工作階段中的模擬按鍵。 按鍵代碼記載在「UI 使用者指南」的「傳送金鑰語法」中。 如果這是「儲存」密碼,請輸入 {IAConnectPassword:StoredPasswordIdentifier} 格式,並將「儲存密碼」輸入設定為 true。 如果這是 Orchestrator 一般認證,請輸入 {OrchestratorCredential:FriendlyName} 格式,並將「儲存的密碼」輸入設定為 true。

間隔(以毫秒為單位)
Interval integer

每次按鍵之間的毫秒數。

不要解讀符號
DontInterpretSymbols boolean

密碼中的符號是否應該被解釋為特殊鍵(例如,+ 代表 Shift,^ 代表 Ctrl)? 如果您嘗試輸入實際符號,則應將其設定為 true。

密碼包含儲存的密碼
PasswordContainsStoredPassword boolean

如果密碼是 IA-Connect 儲存的密碼識別碼 (例如:由「產生密碼」動作產生) 或 IA-Connect Orchestrator 一般認證 (例如:如果將 IA-Connect 與 PA 流程搭配使用),則設定為 true。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳送密碼金鑰事件

使用低階鍵盤驅動程式,將全域按鍵事件傳送至 IA-Connect Agent 使用者工作階段,專門用於輸入密碼。 這模擬了用戶按下鍵盤上的這些鍵。 請確定目標 Window 元素已聚焦,或錯誤的應用程式可能會收到按鍵,或被忽略。

參數

名稱 機碼 必要 類型 Description
密碼
Password True password

要使用低階鍵盤驅動程式輸入 IA-Connect Agent 使用者工作階段的密碼。 關鍵程式碼記載在「UI 使用者指南」的「傳送關鍵事件語法」中。 如果這是「儲存」密碼,請輸入 {IAConnectPassword:StoredPasswordIdentifier} 格式,並將「儲存密碼」輸入設定為 true。 如果這是 Orchestrator 一般認證,請輸入 {OrchestratorCredential:FriendlyName} 格式,並將「儲存的密碼」輸入設定為 true。

間隔(以毫秒為單位)
Interval integer

每個按鍵事件之間的毫秒數。

不要解讀符號
DontInterpretSymbols boolean

密碼中的符號是否應該被解釋為特殊鍵(例如,{SHIFT} 代表 Shift,{CTRL} 代表 Ctrl)? 如果您嘗試輸入實際符號,則應將其設定為 true。

密碼包含儲存的密碼
PasswordContainsStoredPassword boolean

如果密碼是 IA-Connect 儲存的密碼識別碼 (例如:由「產生密碼」動作產生) 或 IA-Connect Orchestrator 一般認證 (例如:如果將 IA-Connect 與 PA 流程搭配使用),則設定為 true。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳送重要事件

使用低階鍵盤驅動程式,將全域按鍵事件傳送至 IA-Connect Agent 使用者工作階段。 這模擬了用戶按下鍵盤上的這些鍵。 請確定目標 Window 元素已聚焦,或錯誤的應用程式可能會收到按鍵,或被忽略。

參數

名稱 機碼 必要 類型 Description
文字
Text True string

按下按鍵即可使用低階鍵盤驅動程式進入 IA-Connect Agent 使用者工作階段。 關鍵程式碼記載在「UI 使用者指南」的「傳送關鍵事件語法」中。 按下並釋放 escape 的範例:{Escape}。 按 Win+D 顯示桌面的範例 (按下左 Windows 鍵,按下並放開 d,鬆開左 Windows 鍵): <{LWin}d>{LWin}。 按下 CTRL+C 的範例(按下左 control,按下並釋放 c,釋放左 control): <{Ctrl}c>{Ctrl}。 請記得鬆開按下的按鍵,否則它們將保持按下狀態(例如,如果您用於 < 按下修飾鍵,請用於 > 釋放它)。

間隔(以毫秒為單位)
Interval integer

每個按鍵事件之間的毫秒數。

是密碼
IsPassword boolean

輸入是密碼值嗎? 如果是,則應使用替代的「傳送密碼金鑰事件」動作。

不要解讀符號
DontInterpretSymbols boolean

文本中的符號是否應該被解釋為特殊鍵(例如,{SHIFT} 表示 Shift,{CTRL} 表示 Ctrl)? 如果您嘗試輸入實際符號,則應將其設定為 true。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳送金鑰

將全域按鍵傳送至 IA-Connect Agent 使用者工作階段。 這模擬了用戶按下鍵盤上的這些鍵。 請確定目標 Window 元素已聚焦,或錯誤的應用程式可能會收到按鍵,或被忽略。

參數

名稱 機碼 必要 類型 Description
文字
Text True string

按下的按鍵將在 IA-Connect 代理程式使用者工作階段中進行模擬。 按鍵代碼記載在「UI 使用者指南」的「傳送金鑰語法」中。 若要輸入字母數字,只需提供文字 as-is。 按 CTRL+C 的範例:^c。 按 ALT+F 的範例:%f。

間隔(以毫秒為單位)
Interval integer

每次按鍵之間的毫秒數。

是密碼
IsPassword boolean

輸入是密碼值嗎? 如果是這樣,則應使用替代的「傳送密碼金鑰」動作。

不要解讀符號
DontInterpretSymbols boolean

文本中的符號不應被解釋為特殊鍵(例如,+ 代表 Shift,^ 代表 Ctrl)? 如果您嘗試輸入實際符號,則應將其設定為 true。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

刪除 Orchestrator 自動化工作

刪除已延遲的 Orchestrator 自動化工作。

參數

名稱 機碼 必要 類型 Description
任務標識符
TaskId True integer

要刪除的 Orchestrator 自動化工作識別碼。

更新來源系統
UpdateSourceSystem boolean

如果設定為 true (預設值),且 Orchestrator 工作已連結至來源系統 (例如 ServiceNow),則 Orchestrator 將執行 Orchestrator 的來源系統組態中指定的任何動作 (例如,關閉票證)。 如果設定為 false,或工作未連結至來源系統,則只會從 Orchestrator 中刪除工作。

傳回

名稱 路徑 類型 Description
指令結果
TasksDeleteTaskResult boolean

命令的結果(成功或失敗)。

錯誤訊息
ErrorMessage string

如果指令不成功,則會包含傳回的錯誤訊息。

刪除 Orchestrator 自動化工作作業

提供唯一的工作作業識別碼,以刪除特定的 Orchestrator 自動化工作。

參數

名稱 機碼 必要 類型 Description
作業識別碼
OperationId True string

要刪除的 Orchestrator 工作的作業識別碼。

更新來源系統
UpdateSourceSystem boolean

如果設定為 true (預設值),且 Orchestrator 工作已連結至來源系統 (例如 ServiceNow),則 Orchestrator 將執行 Orchestrator 的來源系統組態中指定的任何動作 (例如,關閉票證)。 如果設定為 false,或工作未連結至來源系統,則只會從 Orchestrator 中刪除工作。

傳回

名稱 路徑 類型 Description
指令結果
TasksDeleteTaskOperationResult boolean

命令的結果(成功或失敗)。

錯誤訊息
ErrorMessage string

如果指令不成功,則會包含傳回的錯誤訊息。

刪除代理程式執行緒

刪除代理程式執行緒或所有代理程式執行緒,如果執行緒仍在執行中,則先終止 (終止、中止) 執行緒。 代理程式執行緒可用來執行執行緒中的特定動作,允許動作長時間執行 (長於 RPA 逾時) 或與其他動作平行執行。 監視代理程式執行緒的處理程序或流程會收到「代理程式執行緒識別碼不存在」錯誤。

參數

名稱 機碼 必要 類型 Description
執行緒識別碼
ThreadId integer

如果您先前以執行緒身分執行代理程式動作,請提供執行緒識別碼以終止並刪除執行緒。 此執行緒識別碼會提供為先前執行為執行緒之動作的輸出。 如果指定的代理程式執行緒識別碼不存在,則會引發例外狀況。

刪除所有代理程式執行緒
DeleteAllAgentThreads boolean

設定為 true 可刪除所有代理程式執行緒。 設定為 false (預設值) 可刪除「執行緒 ID」輸入所指定的單一代理程式執行緒。

如果代理程式執行緒無法刪除,則引發例外狀況
RaiseExceptionIfAgentThreadFailsToDelete boolean

設定為 true,可在代理程式執行緒無法刪除時引發例外狀況。 請注意,如果代理程式執行緒在發出此動作時完成,這可能會導致引發例外狀況 (因為它在刪除時將不再存在)。 設定為 false (預設值) ,以在刪除代理程式執行緒時忽略錯誤。 輸出「已刪除的代理程式執行緒數目」將報告刪除的代理程式執行緒數目。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
已刪除的代理程式執行緒數目
NumberOfAgentThreadsDeleted integer

如果「刪除所有代理程式執行緒」為true,則此輸出將保留已刪除的代理程式執行緒數目(0 或更高)。 如果「刪除所有代理程式執行緒」為 false 且提供了代理程式執行緒 ID,則此輸出將設定為 0 或 1。

刪除代理程式記憶體中的密碼

刪除儲存在代理程式記憶體中的密碼,或刪除所有代理程式儲存的密碼。

參數

名稱 機碼 必要 類型 Description
刪除所有密碼
DeleteAllPasswords boolean

設定為 true 可刪除儲存在代理程式記憶體中的所有密碼。 設定為 false (預設值) ,以刪除符合所提供識別碼的單一密碼。

識別碼
Identifier string

要刪除的密碼的唯一識別碼。 例如:SAPGUILogon。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
指令結果
DeletePasswordInAgentMemoryResult boolean

命令的結果(成功或失敗)。

錯誤訊息
ErrorMessage string

如果指令不成功,則會包含傳回的錯誤訊息。

刪除使用者認證

刪除 IA-Connect Agent 工作階段中使用者設定檔中的認證。 您可以從 Windows 控制台檢視認證。

參數

名稱 機碼 必要 類型 Description
認證位址
CredentialAddress True string

認證的名稱/位址。

認證類型
CredentialType True string

認證類型:Windows 或一般。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
指令結果
CredentialDeleteResult boolean

命令的結果(成功或失敗)。

錯誤訊息
ErrorMessage string

如果指令不成功,則會包含傳回的錯誤訊息。

刪除檔案

刪除執行 IA-Connect Agent 的電腦上的檔案。

參數

名稱 機碼 必要 類型 Description
檔案路徑
Filename True string

檔案的完整路徑。 這必須可從執行 IA-Connect Agent 的階段作業存取。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

刪除檔案

刪除指定資料夾中符合執行 IA-Connect Agent 之電腦上模式的檔案。

參數

名稱 機碼 必要 類型 Description
目錄路徑
DirectoryPath True string

目錄 (資料夾) 的完整路徑。 這必須可從執行 IA-Connect Agent 的階段作業存取。

樣式
Pattern string

與要刪除的檔案進行比對的模式,例如,所有檔案的 .,副檔名為 .txt 的檔案的 *.txt。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
已刪除的檔案數目
NumberOfFilesDeleted integer

成功刪除的檔案數目。

無法刪除的檔案數目
NumberOfFilesFailedToDelete integer

無法刪除的檔案數目。

刪除目錄

刪除執行 IA-Connect Agent 的電腦上的目錄 (資料夾)。

參數

名稱 機碼 必要 類型 Description
目錄路徑
DirectoryPath True string

目錄 (資料夾) 的完整路徑。 這必須可從執行 IA-Connect Agent 的階段作業存取。

遞迴
Recursive boolean

目錄中的子目錄(子資料夾)和檔案也應該被刪除嗎?

Workflow
Workflow True string

在此處新增下列運算式:workflow()

取得 CSV 文字作為集合

在執行 IA-Connect Agent 的電腦上傳回 CSV 檔案作為集合 (資料表)。 只需要對 CSV 檔案的唯讀存取權。

參數

名稱 機碼 必要 類型 Description
CSV 檔案路徑
CSVFilePath True string

CSV 檔案的完整路徑。 這必須可從執行 IA-Connect Agent 的階段作業存取。

第一行是標題
FirstLineIsHeader boolean

CSV 檔案中的第一行是標頭列嗎?

修剪標頭
TrimHeaders boolean

是否應該修剪標題以刪除任何前導或尾隨空格?

允許空白列
AllowBlankRows boolean

如果設定為 true (預設值),則允許 CSV 資料中的完全空白列,並將以空白列的形式傳回。 如果設定為 false,則傳回資料中將刪除完全空白的行(檔案將保持不變)。

如有需要,請延伸欄
ExtendColumnsIfRequired boolean

如果設定為 true,並且如果資料中存在沒有相符列標題的儲存格(即儲存格多於標題行的列),則會自動建立名稱為 Column_N 的列標題(其中 N 是列索引)。 如果設定為 false (預設值),如果資料列包含沒有相符資料行的資料,則會發生例外狀況。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
CSV 資料 JSON
CSVDataJSON string

CSV 檔案的內容,JSON 格式。

取得 Director 用戶端類型和工作階段資訊

傳回第 1 層導向器所處理之本機或遠端工作階段的詳細資料。

參數

名稱 機碼 必要 類型 Description
Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
遠端用戶端類型
RemoteClientType string

遠端用戶端類型 (「本機」、「Citrix ICA」或「Microsoft RDP」)。

已連接虛擬通道
VirtualChannelConnected boolean

True,如果虛擬通道已連線,則在導向器和代理之間。

導演版
DirectorVersion string

IA-Connect Director DLL 的版本。 例如:1.67.21.0。

Director 發行版本
DirectorReleaseVersion string

IA-Connect Director 的 IA-Connect 發布版本。 例如:9.4。

代理程式版本
AgentVersion string

此導向器連線的 IA-Connect 代理EXE版本。 例如:1.74.21.0。

代理程式發行版本
AgentReleaseVersion string

此導向器所連線的 IA-Connect 代理程式的 IA-Connect 版本。 例如:9.4。

代理商已獲得許可
AgentIsLicensed boolean

True,如果此導向器連線的 IA-Connect 代理程式已獲得授權。 False,如果 IA-Connect 代理程式未獲得授權。 如果代理程式授權狀態未知,則為空值。

代理程式授權功能
AgentLicenseFeatures string

以逗號分隔的 IA-Connect 授權功能清單,指定給此導向器所連線的 IA-Connect 代理程式。 例如:JML、DEV。

導向器主機名稱
DirectorHostname string

執行 Director 的電腦主機名稱。 例如:vmrpa1。

Director NetBIOS 網域名稱
DirectorNetBIOSDomainName string

執行控制器之電腦的 NetBIOS 網域名稱。 例如:domain1。 如果電腦不是網域的成員,這通常會傳回主機名稱。

Director DNS 網域名稱
DirectorDNSDomainName string

執行 Director 之電腦的 DNS 網域名稱。 例如:domain1.myorg.local。 如果電腦不是網域的成員,這通常會傳回主機名稱。

附加到下一跳 Director
AttachedToNextHopDirector boolean

如果 IA-Connect 工作階段目前已連接至此導向器所連接的代理程式,則設定為 false。 如果導向器將所有動作(即附加)轉發給另一個導向器(連接到不同的代理程式),則設為true。 例如,如果此導向器是與本機代理程式通訊的本機導向器,但 IA-Connect 工作階段目前已連結至 Citrix,則此值將為 true。

下一個躍點導向器工作階段類型
NextHopDirectorSessionType string

如果此導向器連結至下一個躍點導向器,則此值將保留下一個躍點會話類型。 例如,如果此 Director 是與本機代理程式通訊的本機 Director,但 IA-Connect 工作階段目前已連結至 Citrix,則此值將為「Citrix ICA」,而「遠端用戶端類型」值將為「本機」(代表將動作轉送至 Citrix 的本機 Director)。

取得 IA-Connect Agent 全域座標設定

擷取 IA-Connect Agent 全域座標系統組態的組態,用於顯示元素位置 (例如:在滑鼠檢查期間) 和計算滑鼠位置 (例如:執行全域滑鼠動作時)。

參數

名稱 機碼 必要 類型 Description
Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
多顯示器功能
MultiMonitorFunctionality string

如果 IA-Connect Agent 目前設定為僅支援在主要顯示裝置上醒目提示元素和執行全域滑鼠動作,則傳回 'PrimaryMonitor'。 如果 IA-Connect 代理程式會反白顯示所有監視器上的元素,則傳回 'MultiMonitor' (自 9.4 IA-Connect 以來的預設值)。

自動設置鼠標檢查乘數
AutoSetMouseInspectionMultiplier boolean

如果 IA-Connect Agent 在 Agent 啟動時自動計算主要顯示裝置上的滑鼠檢查乘數,以及每次執行滑鼠檢查時 (自 IA-Connect 9.4 以來的預設值),則傳回 true。 如果 IA-Connect 代理程式需要手動設定滑鼠檢查乘數 (IA-Connect 9.3 及更早版本中唯一可用的選項),則傳回 false。 此選項僅在禁用多顯示器模式時才有任何作用。

自動設置全局鼠標倍增器
AutoSetGlobalMouseMultiplier boolean

如果 IA-Connect Agent 在 Agent 啟動時自動計算主要顯示裝置上的全域滑鼠移動乘數,以及每次執行滑鼠檢查時 (自 9.4 IA-Connect 以來的預設值),則傳回 true。 如果 IA-Connect 代理程式需要手動設定全域滑鼠移動乘數(IA-Connect 9.3 及更早版本中唯一可用的選項),則傳回 false。 此選項僅在禁用多顯示器模式時才有任何作用。

鼠標檢查 X 乘數
MouseInspectionXMultiplier double

目前的水平 (X) 滑鼠檢查乘數 (當代理程式反白顯示滑鼠下方的內容時)。 例如:如果 IA-Connect 在實際滑鼠 X 位置的一半處顯示檢查矩形,則此值將為 0.5。 乘數僅在停用「多監視器功能」時才有任何作用,因為當 IA-Connect 代理程式設定為多監視器感知時,乘數會動態計算。

滑鼠檢查 Y 乘數
MouseInspectionYMultiplier double

目前垂直 (Y) 滑鼠檢查乘數 (當代理程式反白顯示滑鼠下方的內容時)。 例如:如果 IA-Connect 在實際滑鼠 Y 位置的一半處顯示檢查矩形,則此值將為 0.5。 乘數僅在停用「多監視器功能」時才有任何作用,因為當 IA-Connect 代理程式設定為多監視器感知時,乘數會動態計算。

全局滑鼠 X 乘數
GlobalMouseXMultiplier double

目前水平 (X) 全域滑鼠移動乘數 (適用於代理程式移動滑鼠時)。 乘數僅在停用「多監視器功能」時才有任何作用,因為當 IA-Connect 代理程式設定為多監視器感知時,乘數會動態計算。

全局滑鼠 Y 乘數
GlobalMouseYMultiplier double

目前垂直 (Y) 全域滑鼠移動乘數 (適用於代理程式移動滑鼠時)。 乘數僅在停用「多監視器功能」時才有任何作用,因為當 IA-Connect 代理程式設定為多監視器感知時,乘數會動態計算。

全域滑鼠移動方式
GlobalMouseMoveMethod string

傳回目前的全域滑鼠移動方法 (mouse_event 或 setcursorpos)。

Java座標系
JavaCoordinateSystem string

傳回目前的 Java 座標系統,可以是 'Virtual' (預設值) 或 'Physical' (IA-Connect 9.4 中的新功能)。 虛擬座標會調整 DPI 比例,而實體座標會直接對應至圖元。 此值應該設為 Java Access Bridge 所呈現的任何座標系統。

SAP GUI 座標系統
SAPGUICoordinateSystem string

傳回目前的 SAP GUI 指令碼 API 座標系統,可以是「虛擬」(預設值)或「實體」(IA-Connect 9.4 中的新功能)。 虛擬座標會調整 DPI 比例,而實體座標會直接對應至圖元。 此值應設定為 SAP GUI 指令碼 API 所呈現的任何座標系統。

取得 IA-Connect Director 正常運作時間

傳回此 IA-Connect 導向器的運作時間(以秒為單位)(即導向器已執行的時間長度)。

參數

名稱 機碼 必要 類型 Description
Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
導向器正常運行時間(以秒為單位)
UpTimeInSeconds integer

IA-Connect 導向器已執行的秒數。

取得 IA-Connect Director 記錄層級

傳回目前的 IA-Connect 導向器記錄層級。 記錄層級設定為 0 到 4。 0 為停用。 1 是最低的日誌層級 (也是預設值)。 4 是最高對數層級。

參數

名稱 機碼 必要 類型 Description
Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
記錄層級
LoggingLevel integer

IA-Connect Director的現行記錄層級。

IA-Connect 導向器記錄檔名稱
IAConnectDirectorLogFilename string

IA-Connect 導向器記錄檔名稱。 此值對於每個啟動都是唯一的,因為它的檔案名稱中具有啟動日期和時間。

取得 IA-Connect 代理程式會話資訊

傳回有關 IA-Connect 代理程式使用者工作階段的資訊。

參數

名稱 機碼 必要 類型 Description
Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
工作階段識別碼
SessionId integer

目前的遠端使用者工作階段 ID。

工作階段類型
SessionType integer

遠端工作階段的類型,1 (Citrix)、2 (RDP) 或 0 (主控台)。

工作階段類型名稱
SessionTypeName string

遠端工作階段的類型,ICA (Citrix)、RDP 或主控台。

取得 IA-Connect 代理程式目前授權狀態

傳回 IA-Connect 代理程式目前是否已授權,以及授權的內容(如果已授權)。

參數

名稱 機碼 必要 類型 Description
Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
已獲得許可
IsLicensed boolean

如果 IA-Connect Agent 目前已授權,則傳回 true,如果未授權,則傳回 false。

授權類型
LicenseType string

正在使用的 IA-Connect 授權類型。

代理程式網域名稱
CustomerNETBIOSDomainName string

執行 IA-Connect Agent 之電腦的 NetBIOS 網域名稱 (如果依網域名稱授權 (IA-Connect 7.0 或 7.1)。

導向器主機名稱
DirectorHostnameCSV string

可安裝 IA-Connect Director 的電腦的主機名稱 (如果依主機名稱授權 (IA-Connect 7.2 之後)。

客戶顯示名稱
CustomerDisplayName string

要顯示在 IA-Connect 代理程式標題列中的客戶名稱。

廠商名稱
VendorName string

IA-Connect 廠商名稱。

授權到期日
LicenseExpiryDate string

IA-Connect 授權的到期日。

授權到期前的天數
DaysUntilLicenseExpires integer

IA-Connect 授權到期前的剩餘天數。

授權功能
LicenseFeatures string

其他授權功能,通常提供對其他功能的存取。

是 JML 授權
IsJMLLicense boolean

此授權是否提供對 JML 功能的存取權。

取得 IA-Connect 代理程式程序計數

傳回目前在使用者工作階段中執行的 IA-Connect Agent 實例數目。 這對於偵測 IA-Connect Agent 是否有多個執行個體正在執行中非常有用。

參數

名稱 機碼 必要 類型 Description
Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
進程數
NumberOfProcesses integer

目前在使用者工作階段中執行的 IA-Connect 代理程式處理程序數目。

取得 IA-Connect 代理程式記錄

傳回目前 IA-Connect 代理程式日誌,可以是檔案,或是讀取內容,然後以輸出變數傳回。

參數

名稱 機碼 必要 類型 Description
壓縮
Compress boolean

在上傳期間是否應該壓縮替代 IA-Connect 代理程式可執行檔?

僅傳回最後一個命令記錄
ReturnLastCommandOnly boolean

IA-Connect 代理程式記錄是否應該限制為最後一個命令的結果,而不是整個記錄?

將日誌儲存至檔案
SaveLogToFile boolean

IA-Connect Agent 日誌是否應該儲存為檔案?

將日誌內容放在資料項目中
PlaceLogContentInDataItem boolean

記錄的內容是否應該在輸出變數中傳回?

本機儲存資料夾
LocalSaveFolder string

要儲存 IA-Connect Agent 登入的資料夾的檔案路徑。

使用代理程式記錄檔名稱
UseAgentLogFilename boolean

記錄檔的名稱是否應該與代理程式上的記錄檔名稱相同? 如果設定為 false,則您可以設定「本機儲存檔案名稱」來指定檔案名稱。

本機儲存檔案名稱
LocalSaveFilename string

僅 IA-Connect 代理程式日誌的本機儲存檔的檔名。 只有在「使用代理程式記錄檔名」設定為 false 時,才會使用此選項。

要讀取的位元組數上限
MaxBytesToRead integer

從代理程式記錄檔讀取的位元組數上限 (從結尾向後)。 可以將其設定為 0 或 -1 以擷取整個日誌。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
代理程式記錄內容
IAConnectAgentLogContentsBase64 string

IA-Connect 代理程式記錄的內容。

本機儲存的記錄檔名稱
IAConnectAgentLogFilenameOnly string

已儲存記錄檔名稱的路徑。

取得 IA-Connect 代理程式記錄層級

傳回目前 IA-Connect 代理程式記錄層級。 記錄層級設定為 1 到 4,其中 1 是最低層級,4 是最高層級。

參數

名稱 機碼 必要 類型 Description
Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
記錄層級
LoggingLevel integer

IA-Connect 代理程式的目前記錄層級。

IA-Connect 代理程式記錄檔名稱
IAConnectAgentLogFilename string

IA-Connect 代理程式記錄檔名。 此值對於每次啟動 IA-Connect 代理程式都是唯一的,因為它的檔案名稱中具有啟動日期和時間。

取得 Orchestrator 狀態

擷取基本 Orchestrator 狀態。 這可用來確認 Orchestrator 可用且正在回應。

傳回

名稱 路徑 類型 Description
Orchestrator 版本
OrchestratorVersion string

Orchestrator 軟體版本。

Orchestrator 啟動錯誤
NumberOfStartupErrors integer

Orchestrator 啟動錯誤的數目。

Orchestrator 運作時間(以秒為單位)
UptimeInSeconds integer

Orchestrator 已執行的秒數。

取得 Orchestrator 背景工作者清單

擷取向 IA-Connect Orchestrator 註冊的工作者清單及其即時狀態。

參數

名稱 機碼 必要 類型 Description
僅返回活體員工
OnlyReturnLiveWorkers boolean

設定為 true,以僅傳回即時工作者 (主動連線至 Orchestrator 的工作者)。

傳回

名稱 路徑 類型 Description
協調器背景工作角色
OrchestratorWorkers array of object

向 IA-Connect Orchestrator 註冊的工作者清單及其即時狀態。

身份識別碼
OrchestratorWorkers.Id integer
名稱
OrchestratorWorkers.Name string
CurrentFlowDisplayName
OrchestratorWorkers.CurrentFlowDisplayName string
實時狀態
OrchestratorWorkers.LiveStatus boolean
LiveStatusLastContactTicks
OrchestratorWorkers.LiveStatusLastContactTicks integer
自上次接觸以來的秒數
OrchestratorWorkers.SecondsSinceLastContact integer
維護模式
OrchestratorWorkers.MaintenanceMode boolean
Priority
OrchestratorWorkers.Priority integer
代理程式已授權
OrchestratorWorkers.AgentIsLicensed boolean
IsAvailableForWork
OrchestratorWorkers.IsAvailableForWork boolean
工人人數
NumberOfOrchestratorWorkers integer

回應中的 Orchestrator 工作者數目。

取得 Orchestrator 背景工作角色

擷取向 IA-Connect Orchestrator 註冊之個別工作者的詳細資料和即時狀態。

參數

名稱 機碼 必要 類型 Description
搜尋工作者識別碼
SearchWorkerId integer

要擷取之背景工作角色的識別碼。 設定為 1 或更高的值,以擷取具有該特定 ID 之工作者的詳細資訊。如果您不想依 ID 擷取工作者,請設定為 0。

搜尋工作人員名稱
SearchWorkerName string

要擷取的工作者的名稱。 如果您不想依名稱擷取背景工作者,請設定為空白或空值。

傳回

名稱 路徑 類型 Description
工作者識別碼
WorkerId integer

此背景工作者的內部 Orchestrator 識別碼。

工作人員名稱
WorkerName string

此背景工作者的內部 Orchestrator 名稱。

工作人員描述
WorkerDescription string

此工作角色的內部 Orchestrator 說明。

目前流程顯示名稱
CurrentFlowDisplayName string

此工作正在處理之流程的顯示名稱,如果工作者處於閒置狀態,則為空白。

工作人員即時狀態
LiveStatus boolean

True,如果背景工作者目前已連線至 Orchestrator 並回應輪詢。 False,如果背景工作者未連線。

上次聯絡勾號
LiveStatusLastContactTicks integer

Orchestrator 最後一次與背景工作者接觸的時間 (以刻度為單位)。 這是自 1 月 1 日午夜 12:00:00 UTC 以來經過的 100 納秒間隔數,0001 年。 這是通用的、通用的、時間格式。

自上次聯絡以來的秒數
SecondsSinceLastContact integer

自 Orchestrator 上次與背景工作者聯絡以來經過的時間 (以秒為單位)。 這代表與「上次接觸刻度」相同的時間點,但以相對秒數表示。

處於維護模式的工作人員
MaintenanceMode boolean

True,如果背景工作者目前處於維護模式。 False,如果背景工作者未處於維護模式。

工作人員優先順序
Priority integer

1 或更高的整數值,代表指派給工作者的優先順序。 優先順序 1 是最高優先順序。 流程將傳送給具有最高優先順序的可用工作者。 多個 Worker 可以具有相同的優先順序,而 Orchestrator 將使用「Worker 負載平衡方法」(請參閱「網站設定」)來選擇可用的 Worker。

背景工作者逾時 (以秒為單位)
TimeoutInSeconds integer

Orchestrator 在逾時之前,應等待來自 IA-Connect Director 的 REST API 回應多長時間 (以秒為單位)。

Worker 已獲得許可
AgentIsLicensed boolean

True,如果工作人員目前已獲得許可。 如果工作人員沒有執照,則為 False。 Null,如果 Orchestrator 不知道背景工作者是否已獲得授權 (可能沒有回應,可能是非常舊的代理程式,不會在輪詢中提供即時授權更新)。

代理程式授權功能
AgentLicenseFeatures string

特定代理授權功能。 例如:JML 用於 Joiner、Mover、Leaver 授權。

工作人員可以工作
IsAvailableForWork boolean

True,如果工作人員可以工作,這表示工作人員可以接受傳入的工作。 如果工作者不是,則為 False。 可用於工作的決定因素是 a) 工作者狀態是否為作用中,b) 工作者是否處於維護模式,c) 工作者是否已獲得許可,d) 工作者目前是否正在處理流程。

背景工作連線類型 ID
WorkerConnectionTypeId integer

已設定背景工作角色連線類型的識別碼,用於將背景工作角色連線至 Orchestrator。 這可以是 1 表示「Azure WCF 轉送」,2 表示「Azure 混合式連線」,3 表示「Azure 虛擬網路 (VNet)」,4 表示「直接」。

背景工作角色連線類型名稱
WorkerConnectionTypeName string

已設定背景工作角色連線類型的名稱,用於將背景工作節點連線至 Orchestrator。 這可以是 AzureWCFRelay、AzureHybridConnection、AzureVNet、Direct。

導向器 REST API URL
DirectorRestApiUrl string

如果設定的連線類型是混合式連線、VNet 或直接,則此屬性會包含背景工作角色 REST API URL,這通常是 HTTP,因為 HTTP 流量會在 HTTPS 通道內加密 (例如混合式連線或內部部署資料閘道) 。 如果設定的連線類型是 Azure WCF 轉送,則此屬性會包含 WCF 轉送 URL。

Azure 服務匯流排命名空間
AzureServiceBusNamespace string

如果設定的連線類型是 Azure WCF 轉送,則這包含 Azure 服務匯流排命名空間。

Azure WCF 轉送名稱
AzureWCFRelayName string

如果設定的連線類型是 Azure WCF 轉送,則此屬性會包含 Azure WCF 轉送名稱。

代理程式連線類型名稱
IAConnectAgentConnectionTypeName string

代理程式連線類型的名稱。 這可以是“本地代理”、“Citrix ICA”或“Microsoft RDP”。

附加到下一跳控制器
AttachedToNextHopDirector boolean

如果連線至 Orchestrator 的導向器 (通常是由本機代理程式裝載的導向器) 正在將動作轉送至下一躍點導向器 (通常是 Citrix ICA 或 Microsoft RDP 導向器),則此內容會設定為 True。 如果導向器直接將動作傳送至其所連接的代理程式 (通常是本機代理程式),則此屬性會設定為 False。

下一躍點導向器工作階段類型
NextHopDirectorSessionType string

如果連線至 Orchestrator 的導向器 (通常是由本機代理程式裝載的導向器) 將動作轉送至下一躍點導向器 (通常是 Citrix ICA 或 Microsoft RDP 導向器),則此內容將保留連線類型的名稱,即「Citrix ICA」或「Microsoft RDP」。

導演版
DirectorVersion string

IA-Connect Director 的內部版本,可處理 REST API 介面,並為在 IA-Connect Worker 上執行的 IA-Connect 代理程式提供 IA-Connect Inspector。

代理程式版本
AgentVersion string

在 IA-Connect 工作者上執行的 IA-Connect 代理程式的內部版本。

Director 發行版本
DirectorReleaseVersion double

IA-Connect Director 的 IA-Connect 版版本,可處理 REST API 介面,並為在 IA-Connect Worker 上執行的 IA-Connect 代理程式提供 IA-Connect Inspector。

代理程式發行版本
AgentReleaseVersion double

在 IA-Connect 工作者上執行的 IA-Connect 代理程式的 IA-Connect 版本。

導向器主機名稱
DirectorHostname string

代管 IA-Connect Director 之作業系統的主機名稱。 這是工作者的主機名稱,通常與工作者名稱相同。

Director NETBIOS域名
DirectorNetBIOSDomainName string

裝載 IA-Connect Director 的作業系統的 NETBIOS 網域名稱,這是 IA-Connect 代理程式的元件,在 IA-Connect 背景工作角色上執行。 對於工作群組,這通常是工作者主機名稱。 對於 Active Directory 網域,這是網域 NetBIOS 名稱。 例如:MYDOMAIN。

Director DNS 網域名稱
DirectorDNSDomainName string

裝載 IA-Connect Director 的作業系統的 DNS 網域名稱,這是 IA-Connect 代理程式的元件,在 IA-Connect Worker 上執行。 對於工作群組,這通常是空白的。 對於 Active Directory 網域,這是網域 DNS 名稱。 例如:mydomain.local。

支援的流程環境識別碼數目
SupportedFlowEnvironmentIdsCount integer

如果背景工作者設定為僅處理來自指定流程環境識別碼的流程,則此屬性會保留清單中支援的流程環境識別碼數目。 如果背景工作者可以處理來自任何環境的流程,則此屬性會保留 0。

支援的流程名稱數目
SupportedFlowNamesCount integer

如果背景工作者設定為僅處理具有特定名稱的流程,則此屬性會保留清單中支援的流程名稱數目。 如果背景工作者可以處理具有任何名稱的流程,則此屬性會保留 0。

不支援的流程名稱數目
UnsupportedFlowNamesCount integer

如果背景工作者設定為拒絕處理具有特定名稱的流程,則此屬性會保留清單中不支援的流程名稱數目。 如果背景工作者未設定為拒絕特定流程,則此屬性會保留 0。

背景工作者標籤數目
WorkerTagsCount integer

如果背景工作者設定了某些標籤,則此屬性會保留清單中的標籤數目。 如果背景工作角色沒有標籤,則此屬性會保留 0。

Worker 必要標籤數目
WorkerMandatoryTagsCount integer

如果背景工作者配置了一些必要標籤,則此屬性會保留清單中必要標籤的數目。 如果工作角色沒有必要標籤,則此屬性會保留 0。

取得 Orchestrator 背景工作角色可用性狀態

擷取基本 Orchestrator 狀態。 這可用來確認 Orchestrator 可用且正在回應。

傳回

名稱 路徑 類型 Description
工作人員總數
TotalWorkersCount integer

Orchestrator 中定義的 IA-Connect 工作者數目,無論它們是否正在運作。

可用工作人員數目
AvailableWorkersCount integer

Orchestrator 中定義的 IA-Connect 工作者數目,可用於工作。 可用表示他們正在回應、已授權、未處於維護模式、目前未執行流程 (自動化)。 這是可用於接受新傳入工作的工作人員數量。

不可用的工作人員人數
UnavailableWorkersCount integer

Orchestrator 中定義的 IA-Connect 工作角色數目,這些工作角色無法用於工作。 這等於工作人員總數減去可用工作人員數量。

執行流程的背景工作者數目
WorkersRunningFlowsCount integer

在 Orchestrator 中定義的 IA-Connect 工作角色數目,這些工作角色正在執行流程 (自動化)。 這些工人無法上班,因為他們很忙。

處於維護模式的工作人員數量
WorkersInMaintenanceModeCount integer

Orchestrator 中定義的處於維護模式的 IA-Connect 工作者數目。 這些工作人員無法工作,因為他們已手動配置為不接受新工作。

現場工作人員人數
LiveWorkersCount integer

在 Orchestrator 中定義的 IA-Connect 工作者數目,這些工作者正在回應。 這些工作者可能可用,也可能無法工作,因為他們可能未授權、處於維護模式或執行流程 (自動化)。

持牌工人人數
LicensedWorkersCount integer

在 Orchestrator 中定義的 IA-Connect 工作角色數目,這些背景工作角色正在回應且已授權。 授權的 Worker 將一律回應,因為 Orchestrator 只有在 Worker 回應時才知道 Worker 的授權狀態 (因此會通知 Orchestrator 其狀態)。 如果背景工作者停止回應,Orchestrator 將不再將其視為已授權。 這些工作者可能可用,也可能無法工作,因為他們可能處於維護模式或執行流程 (自動化)。

取得 Orchestrator 自動化工作

擷取特定的 Orchestrator 自動化工作。

參數

名稱 機碼 必要 類型 Description
任務標識符
TaskId True integer

您要擷取的 Orchestrator 工作識別碼。

將狀態變更為
StatusChange string

如果設定為「已擷取」:擷取任務時,任務狀態將變更為「已檢索」,以防止其他動作嘗試執行相同的任務。 如果設定為「不執行任何動作」,則不會變更任務狀態。

傳回

名稱 路徑 類型 Description
自動化名稱
AutomationName string

擷取的 Orchestrator 工作的名稱。

作業識別碼
OperationId string

擷取的 Orchestrator 工作的作業識別碼。 此作業識別碼 (或工作識別碼) 可用來稍後擷取工作。 作業識別碼是唯一的、不可猜測的字串,限制了第三方猜測他們未建立之作業識別碼的能力。

延遲日期和時間
DeferralDateTime string

排定擷取的 Orchestrator 工作準備就緒的日期和時間。 這將以 UTC 格式作為字串傳回。

延遲儲存的資料
DeferralStoredData string

延遲工作時儲存的選擇性資料。 這通常是您繼續流程/流程所需的資料。

延遲計數
DeferralCount integer

這項任務被推遲的頻率。 對於從未延遲的新任務,這通常為 0,對於延遲的任務,這通常為 1 或多個。 每次再次延遲延遲工作時,Orchestrator 都會自動增加此數字。

任務輸入資料
TaskInputData string

建立工作時儲存的選擇性資料。 這通常是用來啟動流程/流程的資料,但您可以將此欄位用於任何目的。 這可以格式化為您選擇的任何文本格式,例如 JSON 或 XML 或原始文本。

任務輸出資料
TaskOutputData string

自動化在處理工作時儲存的選用資料。 這可以格式化為您選擇的任何文本格式,例如 JSON 或 XML 或原始文本。

Priority
Priority integer

此 Orchestrator 工作的優先順序層級 (1 表示最高層級)。

自動化任務狀態
AutomationTaskStatus string

擷取的 Orchestrator 工作狀態。

工藝階段
ProcessStage string

延遲後自動化流程/流程應繼續的點。 這是一個可選的字串值,對於特定流程/流程來說是唯一的。 延遲程序/流程中的條件將使用它來決定下一步要執行的步驟。 例如:如果您希望流程/流程在延遲後繼續時在「交換」階段繼續,請輸入值「交換」。

接收日期和時間
ReceivedDateTime string

Orchestrator 最初收到工作的日期和時間。 這將以 UTC 格式作為字串傳回。

距離延期日期的分鐘數
MinutesUntilDeferralDate integer

距離此任務的延遲日期(即此任務準備好執行的時間)的分鐘數。 如果此工作已準備好執行,則分鐘數將為 0。

保留
OnHold boolean

如果工作處於保留狀態,則設定為 true。 「取得下一個 Orchestrator 自動化工作」動作永遠不會擷取保留工作,因此不會在一般工作工作流程中處理。

來源類型名稱
SourceTypeName string

任務來源的名稱。 「Web UI」代表透過UI手動輸入的任務。 「REST API」代表透過 Orchestrator 的 REST API 建立的工作。 「ServiceNow」 代表從 Orchestrator 的內部「來源」ServiceNow 整合建立的工作。

來源易記名稱
SourceFriendlyName string

如果工作是從 Orchestrator 內部「來源」整合建立的 (例如 ServiceNow),則會保留該來源的易記名稱。

來源票證標識符
SourceTicketId string

如果工作是從 Orchestrator 內部「來源」整合建立的 (例如 ServiceNow),則會保留來源票證的識別碼。 針對 ServiceNow,這會保留目錄工作sys_id。

來源票證子 ID
SourceTicketSubId string

如果工作是從 Orchestrator 內部「來源」整合建立的 (例如 ServiceNow),則會保留來源票證的識別碼。 針對 ServiceNow,這會保留要求專案sys_id。

組織
Organisation string

此任務與該任務相關的組織。 通常用於搜尋和篩選任務。

部門
Department string

此作業與相關聯的部門。 通常用於搜尋和篩選任務。

Description
Description string

此工作的說明。 通常用於搜尋和篩選任務。

Tags
Tags string

指派給此工作的一或多個標籤的選用清單。 通常用於對任務進行分類以進行搜索和過濾。 不區分大小寫。 每行一個。

取得 Orchestrator 自動化工作作業

提供唯一工作作業 [作業識別碼],以擷取特定的 Orchestrator 自動化工作。

參數

名稱 機碼 必要 類型 Description
作業識別碼
OperationId True string

您要擷取之 Orchestrator 工作的作業識別碼。

傳回

名稱 路徑 類型 Description
自動化名稱
AutomationName string

擷取的 Orchestrator 工作的名稱。

延遲日期和時間
DeferralDateTime string

排定擷取的 Orchestrator 工作準備就緒的日期和時間。 這將以 UTC 格式作為字串傳回。

延遲儲存的資料
DeferralStoredData string

延遲工作時儲存的選擇性資料。 這通常是您繼續流程/流程所需的資料。

延遲計數
DeferralCount integer

這項任務被推遲的頻率。 對於從未延遲的新任務,這通常為 0,對於延遲的任務,這通常為 1 或多個。 每次再次延遲延遲工作時,Orchestrator 都會自動增加此數字。

任務輸入資料
TaskInputData string

建立工作時儲存的選擇性資料。 這通常是用來啟動流程/流程的資料,但您可以將此欄位用於任何目的。 這可以格式化為您選擇的任何文本格式,例如 JSON 或 XML 或原始文本。

任務輸出資料
TaskOutputData string

自動化在處理工作時儲存的選用資料。 這可以格式化為您選擇的任何文本格式,例如 JSON 或 XML 或原始文本。

Priority
Priority integer

此 Orchestrator 工作的優先順序層級 (1 表示最高層級)。

自動化任務狀態
AutomationTaskStatus string

擷取的 Orchestrator 工作狀態。

工藝階段
ProcessStage string

延遲後自動化流程/流程應繼續的點。 這是一個可選的字串值,對於特定流程/流程來說是唯一的。 延遲程序/流程中的條件將使用它來決定下一步要執行的步驟。 例如:如果您希望流程/流程在延遲後繼續時在「交換」階段繼續,請輸入值「交換」。

接收日期和時間
ReceivedDateTime string

Orchestrator 最初收到工作的日期和時間。 這將以 UTC 格式作為字串傳回。

距離延期日期的分鐘數
MinutesUntilDeferralDate integer

距離此任務的延遲日期(即此任務準備好執行的時間)的分鐘數。 如果此工作已準備好執行,則分鐘數將為 0。

保留
OnHold boolean

如果工作處於保留狀態,則設定為 true。 「取得下一個 Orchestrator 自動化工作」動作永遠不會擷取保留工作,因此不會在一般工作工作流程中處理。

組織
Organisation string

此任務與該任務相關的組織。 通常用於搜尋和篩選任務。

部門
Department string

此作業與相關聯的部門。 通常用於搜尋和篩選任務。

Description
Description string

此工作的說明。 通常用於搜尋和篩選任務。

Tags
Tags string

指派給此工作的一或多個標籤的選用清單。 通常用於對任務進行分類以進行搜索和過濾。 不區分大小寫。 每行一個。

取得上次輸入的資訊

取得自 IA-Connect 代理程式使用者工作階段中收到上次使用者輸入以來的時間。

參數

名稱 機碼 必要 類型 Description
Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
上次輸入總秒數
LastInputTotalSeconds integer

自上次輸入以來經過的秒數。

上次輸入總分鐘數
LastInputTotalMinutes integer

自上次輸入以來經過的分鐘數。

上次輸入的總小時數
LastInputTotalHours integer

自上次輸入以來經過的小時數。

取得下一個 Orchestrator 自動化工作

擷取符合指定搜尋條件的下一個 Orchestrator 自動化工作。 只能擷取「新增」和「延遲」任務 (已達到延遲日期)。 不會擷取保留工作。

參數

名稱 機碼 必要 類型 Description
自動化名稱
AutomationName string

保留空白以傳回具有任何名稱的 Orchestrator 自動化工作。 輸入值以僅擷取具有此自動化名稱的任務。

自動化名稱
AutomationNames array of string

如果您需要傳回符合兩個或多個自動化名稱中任何一個的 Orchestrator 工作,請在此清單中輸入名稱,而不是輸入「自動化名稱」。

最低優先順序層級
MinimumPriorityLevel integer

僅傳回具有指定優先順序層級或更高優先順序的 Orchestrator 自動化工作。 例如:設定 2 將傳回優先順序等級為 1 和 2 的任務。

將狀態變更為
StatusChange string

如果設定為「已擷取」:擷取任務時,任務狀態將變更為「已檢索」,以防止其他動作嘗試執行相同的任務。 如果設定為「不執行任何動作」,則不會變更任務狀態。

距離延期日期的分鐘數
MinutesUntilDeferralDate integer

僅傳回可在指定分鐘數內執行的 Orchestrator 自動化工作。 如果您只想要現在準備好執行的自動化任務,請設定為 0。

忽略 SLA
IgnoreSLA boolean

將此設定為 true 可忽略已在工作上設定的任何 SLA。 預設情況下,具有即將違反 SLA 的任務優先於其他所有任務。

排除工作標識碼
ExcludeTaskIds array of integer

要從處理中排除的工作 ID 清單。

傳回

名稱 路徑 類型 Description
擷取的工作
TaskRetrieved boolean

如果擷取了任務,則設為 true。 如果沒有符合搜尋條件的任務,則設定為 false。

任務標識符
TaskId integer

擷取的 Orchestrator 自動化工作的識別碼。

作業識別碼
OperationId string

擷取的 Orchestrator 工作的作業識別碼。 此作業識別碼 (或工作識別碼) 可用來稍後擷取工作。 作業識別碼是唯一的、不可猜測的字串,限制了第三方猜測他們未建立之作業識別碼的能力。

自動化名稱
AutomationNameOutput string

擷取的自動化作業名稱。

延遲日期和時間
DeferralDateTime string

排定擷取的 Orchestrator 工作準備就緒的日期和時間。 這將以 UTC 格式作為字串傳回。

延遲儲存的資料
DeferralStoredData string

延遲工作時儲存的選擇性資料。 這通常是您繼續流程/流程所需的數據,但您可以將此欄位用於任何目的。

延遲計數
DeferralCount integer

這項任務被推遲的頻率。 對於從未延遲的新任務,這通常為 0,對於延遲的任務,這通常為 1 或多個。 每次再次延遲延遲工作時,Orchestrator 都會自動增加此數字。

任務輸入資料
TaskInputData string

建立工作時儲存的選擇性資料。 這通常是用來啟動流程/流程的資料,但您可以將此欄位用於任何目的。 這可以格式化為您選擇的任何文本格式,例如 JSON 或 XML 或原始文本。

任務輸出資料
TaskOutputData string

自動化在處理工作時儲存的選用資料。 這可以格式化為您選擇的任何文本格式,例如 JSON 或 XML 或原始文本。

Priority
Priority integer

此 Orchestrator 工作的優先順序層級 (1 表示最高層級)。

自動化任務狀態
AutomationTaskStatus string

擷取的 Orchestrator 工作狀態。

工藝階段
ProcessStage string

延遲處理程序/流程在延遲之後應該繼續的點。 這是一個可選的字串值,對於特定流程/流程來說是唯一的。 延遲程序/流程中的條件將使用它來決定下一步要執行的步驟。

接收日期和時間
ReceivedDateTime string

Orchestrator 最初收到工作的日期和時間。 這將以 UTC 格式作為字串傳回。

距離延期日期的分鐘數
MinutesUntilDeferralDateOutput integer

距離此任務的延遲日期(即此任務準備好執行的時間)的分鐘數。 如果此工作已準備好執行,則分鐘數將為 0。

來源類型名稱
SourceTypeName string

任務來源的名稱。 「Web UI」代表透過UI手動輸入的任務。 「REST API」代表透過 Orchestrator 的 REST API 建立的工作。 「ServiceNow」 代表從 Orchestrator 的內部「來源」ServiceNow 整合建立的工作。

來源易記名稱
SourceFriendlyName string

如果工作是從 Orchestrator 內部「來源」整合建立的 (例如 ServiceNow),則會保留該來源的易記名稱。

來源票證標識符
SourceTicketId string

如果工作是從 Orchestrator 內部「來源」整合建立的 (例如 ServiceNow),則會保留來源票證的識別碼。 針對 ServiceNow,這會保留目錄工作sys_id。

來源票證子 ID
SourceTicketSubId string

如果工作是從 Orchestrator 內部「來源」整合建立的 (例如 ServiceNow),則會保留來源票證的識別碼。 針對 ServiceNow,這會保留要求專案sys_id。

組織
Organisation string

此任務與該任務相關的組織。 通常用於搜尋和篩選任務。

部門
Department string

此作業與相關聯的部門。 通常用於搜尋和篩選任務。

Description
Description string

此工作的說明。 通常用於搜尋和篩選任務。

Tags
Tags string

指派給此工作的一或多個標籤的選用清單。 通常用於對任務進行分類以進行搜索和過濾。 不區分大小寫。 每行一個。

取得下一個躍點狀態 IA-Connect

報告接收此命令的代理的下一跳控制器狀態。 如果啟用了下一跳,則該代理會將命令轉發到下一跳(通過下一跳控制器)。 如果停用下一躍點,則該代理程式會自行處理命令 (預設值)。

參數

名稱 機碼 必要 類型 Description
檢查下一個躍點導向器是否正在執行
CheckNextHopDirectorIsRunning boolean

下一躍點需要與代理程式在同一部電腦上執行中的 IA-Connect 導向器。 如果此設定為true,代理程式將檢查下一跳導向器是否如所述執行。 如果此設定為false,代理程式將不會執行任何檢查,而只會檢查下一躍點狀態。

檢查下一個躍點代理程式是否正在執行
CheckNextHopAgentIsRunning boolean

下一個躍點需要與代理程式相同的電腦上執行中的 IA-Connect Director,以及下一個躍點工作階段中執行中的 IA-Connect Agent。 如果此設定為true,代理程式將檢查下一個躍點代理程式是否如所述執行。 如果此設定為false,代理程式將不會執行任何檢查,而只會檢查下一躍點狀態。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
已啟用下一躍點
NextHopEnabled boolean

如果目前已啟用下一個躍點,則傳回 true。

作用中下一個躍點導向器位址
ActiveNextHopDirectorAddress string

作用中下一躍點導向器的位址 (如果正在使用)。

作用中下一跳導向器 TCP 連接埠
ActiveNextHopDirectorTCPPort integer

作用中下一躍點導向器的TCP埠(如果正在使用)。

作用中下一個躍點導向器使用 HTTPS
ActiveNextHopDirectorUsesHTTPS boolean

如果作用中的下一個躍點導向器使用 HTTPS,則傳回 true。

作用中下一個躍點導向器正在執行中
ActiveNextHopDirectorIsRunning boolean

如果作用中的下一個躍點導向器正在執行,則傳回 true,如果未執行,則傳回 false。

作用中下一個躍點導向器 URL
ActiveNextHopDirectorURL string

作用中下一個躍點導向器的 URL。

作用中的下一個躍點代理程式正在執行中
ActiveNextHopAgentIsRunning boolean

如果作用中的下一個躍點代理程式正在執行,則傳回 true,如果未執行,則傳回 false。

取得代理程式執行緒

傳回代理程式執行緒清單。 代理程式執行緒可用來執行執行緒中的特定動作,允許動作長時間執行 (長於 RPA 逾時) 或與其他動作平行執行。 一般而言,一旦代理程式執行緒完成並擷取其資料,代理程式執行緒就會被刪除,且不會出現在執行緒清單中。

參數

名稱 機碼 必要 類型 Description
排序順序
SortOrder string

代理程式執行緒輸出清單的排序順序。 支援的排序順序為 'None'、'ThreadStartTime'、'ThreadStartTime_Desc'、'ThreadEndTime'、'ThreadEndTime_Desc'、'ThreadId'、'ThreadId_Desc'、'ThreadActionName'、'ThreadActionName_Desc'、'ThreadRuntime'、'ThreadRuntime_Desc'。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
代理程式執行緒數目
NumberOfAgentThreads integer

仍在執行或可供擷取的代理程式執行緒數目。 一般而言,一旦代理程式執行緒完成並擷取其資料,代理程式執行緒就會被刪除,且不會出現在執行緒清單中。

代理程式執行緒
AgentThreads array of object

代理程式執行緒清單和所有可用的執行緒資訊 (內部執行緒資料除外)。

ThreadId
AgentThreads.ThreadId integer
IAConnectActionName
AgentThreads.IAConnectActionName string
執行緒開始日期時間UTC
AgentThreads.ThreadStartDateTimeUTC date-time
執行緒已完成日期時間UTC
AgentThreads.ThreadCompletedDateTimeUTC date-time
ThreadRuntimeInSeconds
AgentThreads.ThreadRuntimeInSeconds integer
執行緒已啟動
AgentThreads.ThreadStarted boolean
執行緒運行
AgentThreads.ThreadRunning boolean
執行緒已完成
AgentThreads.ThreadCompleted boolean
執行緒成功
AgentThreads.ThreadSuccess boolean
ThreadStatus訊息
AgentThreads.ThreadStatusMessage string
執行緒錯誤訊息
AgentThreads.ThreadErrorMessage string

取得儲存的密碼

擷取先前產生或儲存的密碼。

參數

名稱 機碼 必要 類型 Description
密碼識別碼
PasswordIdentifier string

儲存密碼的識別碼。 這些密碼僅儲存在記憶體中,並在代理關閉時遺失。 例如:MyExchangePassword。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
純文字密碼
PlainTextPassword string

純文字密碼。 如果密碼是打算透過簡訊或電子郵件(例如)傳輸的一次性密碼,因此需要 as-is查看,則可能需要純文字密碼。

取得剪貼簿

取得 IA-Connect Agent使用者工作階段中剪貼簿的目前內容。

參數

名稱 機碼 必要 類型 Description
Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
剪貼簿資料
ClipboardData string

剪貼簿中包含的資料。

取得印表機清單

傳回 IA-Connect 代理程式工作階段中所有可用印表機的清單。

參數

名稱 機碼 必要 類型 Description
列出本機印表機
ListLocalPrinters boolean

本地打印機應該退回嗎?

列出網路印表機
ListNetworkPrinters boolean

網路印表機應該退回嗎?

返回詳細信息
ReturnDetailedInformation boolean

是否應該傳回每台印表機的位置、連接埠名稱、驅動程式名稱和狀態等詳細資訊?

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
印表機 JSON
PrintersJSON string

找到的所有印表機的清單,以 JSON 格式。

印表機數量
NumberOfPrinters integer

找到的印表機數目。

取得可用的 IA-Connect 課程

擷取 IA-Connect Director 工作階段的清單 (與執行 IA-Connect Agent 之工作階段的可用連線,例如本機、Microsoft RDP 或 Citrix ICA)。

參數

名稱 機碼 必要 類型 Description
Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
IA-Connect 工作階段JSON
IAConnectSessionsJSON string

所有 IA-Connect 工作階段的清單,格式為 JSON。

IA-Connect 會話數
NumberOfIAConnectSessions integer

開啟的 IA-Connect 工作階段總數。

本地 IA-Connect 時段數
NumberOfLocalIAConnectSessions integer

開啟的本機 IA-Connect 階段作業數目。

Citrix ICA IA-Connect 工作階段數
NumberOfCitrixICAIAConnectSessions integer

開啟的 Citrix ICA IA-Connect 工作階段數目。

Microsoft RDP IA-Connect 工作階段數
NumberOfMicrosoftRDPIAConnectSessions integer

開啟Microsoft RDP IA-Connect 工作階段數目。

取得所有 IA-Connect 命令統計資料

傳回目前儲存的所有統計資料,以瞭解 IA-Connect Agent 在目前階段作業中執行的命令。

參數

名稱 機碼 必要 類型 Description
Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
命令統計資料 JSON
CommandStatsJSON string

IA-Connect 代理程式在目前工作階段中執行的命令清單,以 JSON 格式。 此清單將包含每個動作的名稱及其執行次數。

取得所有 Orchestrator 自動化工作

擷取符合篩選條件的所有 Orchestrator 自動化工作。

參數

名稱 機碼 必要 類型 Description
自動化名稱篩選器
AutomationName string

輸入值以僅擷取具有此自動化名稱的任務。 保留空白以傳回具有任何名稱的 Orchestrator 自動化工作 (即停用此篩選器)。

自動化工作狀態篩選器
AutomationTaskStatus string

依指定的自動化任務狀態篩選自動化任務。 將欄位保留空白以傳回所有自動化任務狀態(即停用此篩選器)。

依屬性查詢篩選
FilterByPropertyQuery string

使用查詢字串篩選自動化工作。 這與 Orchestrator 工作 UI 中的「依屬性篩選」輸入相同。 將欄位保留空白,以不依屬性篩選(即停用此篩選器)。 搜尋篩選器的格式必須為「屬性條件值」。 僅支援單一搜尋篩選器 (您無法使用 and、or)。 支援的屬性包括:name、org、dept、tags、stage、ticketid。 支援的條件是等於、包含、不等於、不包含。 例如:名稱等於新入門者,名稱包含入門,組織不等於 Acme,部門包含銷售。

距離延期日期的分鐘數
MinutesUntilDeferralDate integer

僅傳回可在指定分鐘數內執行的 Orchestrator 自動化工作。 如果您只想要現在準備好執行的自動化任務,請設定為 0。 如果您想要擷取任務,而不論延遲為何,請保留空白。

最低優先順序層級
MinimumPriorityLevel integer

僅傳回具有指定優先順序層級或更高優先順序的 Orchestrator 自動化工作。 例如:設定 2 將傳回優先順序等級為 1 和 2 的任務。

依延遲日期排序
SortByDeferralDate boolean

設定為 true 以傳回依延遲日期和時間排序的資料。 設定為 false ,以依儲存順序傳回資料。

擷取保留工作
RetrieveOnHoldTasks boolean

如果設定為 true (預設值,為了回溯相容性),即使工作處於保留狀態,也會擷取工作。 如果設定為 false,則不會擷取保留工作。

跳過
Skip integer

如果擷取數百個結果,您可以使用 Skip 和 MaxResults 來擷取結果區塊。 略過 指定在傳回區塊中的第一個項目之前要略過的結果數。 將 [略過] 設定為 0 會從頭開始傳回結果。

最大結果
MaxResults integer

如果擷取數百個結果,您可以使用 Skip 和 MaxResults 來擷取結果區塊。 MaxResults 指定在處理 Skip 輸入之後要傳回的結果數目上限,或 0 以傳回所有結果。

排除任務資料
ExcludeTaskData boolean

如果設定為 true,則不會在回應中傳回工作資料屬性 (TaskData、DeferralStoredData、TaskOutputData)。 如果您的任務有大量儲存的資料,這可以大幅減少回應的大小。

傳回

名稱 路徑 類型 Description
自動化任務
AutomationTasks array of object

包含符合指定搜尋準則的所有 Orchestrator 自動化工作的資料表。 資料表是一種常見的 .NET 資料格式,但將 Null 儲存為 DbNull。 IA-Connect PowerShell 模組透過將大多數 DbNull 字串轉換為 '' 來解決此問題。 來自 Orchestrator 的日期時間回應將採用字串格式。

items
AutomationTasks object
自動化任務數量
NumberOfAutomationTasks integer

傳回的自動化任務數目。

取得檔案

傳回執行 IA-Connect Agent 之電腦上資料夾 (符合 CSV 模式清單) 中的檔案清單。

參數

名稱 機碼 必要 類型 Description
目錄路徑
DirectoryPath True string

目錄 (資料夾) 的完整路徑。 這必須可從執行 IA-Connect Agent 的階段作業存取。

模式CSV
PatternsCSV True string

要比對的檔案模式的逗號分隔清單,例如 . 對於所有檔案,或 '.txt.docx ' 代表副檔名為 .txt 或 .docx 的檔案。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
檔案JSON
FilesJSON string

資料夾中包含的檔案清單,採用 JSON 格式。

成功讀取的檔案數
NumberOfFilesReadSuccessfully integer

成功讀取的檔案數目。

讀取失敗的檔案數
NumberOfFilesFailedToRead integer

無法讀取的檔案數目。

取得檔案大小

傳回執行 IA-Connect Agent 之電腦上檔案的大小 (以位元組為單位)。

參數

名稱 機碼 必要 類型 Description
檔案路徑
Filename True string

檔案的完整路徑。 這必須可從執行 IA-Connect Agent 的階段作業存取。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
檔案大小
FileSize integer

檔案的大小 (以位元組為單位)。

取得檔案安全性權限

傳回目前在執行 IA-Connect Agent 之電腦上的檔案上設定的權限清單。

參數

名稱 機碼 必要 類型 Description
檔案路徑
FilePath True string

檔案的完整路徑。 這必須可從執行 IA-Connect Agent 的階段作業存取。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
安全性許可權 JSON
SecurityPermissionsJSON string

目前在指定檔案上設定的許可權,採用 JSON 格式。

取得流程

傳回 IA-Connect Agent 使用者階段作業中執行中的處理程序清單。 您可以選擇性地透過提供處理程序名稱來過濾。

參數

名稱 機碼 必要 類型 Description
程序名稱
ProcessName string

程序名稱的選用篩選器。

取得進程指令行
GetProcessCommandLine boolean

如果設定為 true,則會傳回進程命令列詳細資料。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
進程數
NumberOfProcesses integer

在使用者工作階段中執行的處理程序數目。

處理 JSON
ProcessesJSON string

在使用者工作階段中執行的處理程序清單,採用 JSON 格式。

取得滑鼠移動方法

取得目前的滑鼠移動方法。

參數

名稱 機碼 必要 類型 Description
Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
滑鼠移動方法
MouseMoveMethod string

傳回目前的滑鼠移動方法 (mouse_event 或 setcursorpos)。

取得父進程識別碼

傳回具有指定處理程序 ID 的 IA-Connect Agent 使用者階段作業中任何執行中處理程序的父處理程序的處理程序 ID。

參數

名稱 機碼 必要 類型 Description
進程識別碼
ProcessId True integer

子進程的進程識別碼。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
父進程識別碼
ParentProcessId integer

父進程的進程識別碼。

父進程仍在執行中
ParentProcessStillRunning boolean

如果父進程仍在執行且尚未結束,則傳回 true。

父處理程序名稱
ParentProcessName string

父進程的進程名稱。

取得環境資訊

傳回 IA-Connect Agent 使用者工作階段執行環境的相關資訊。

參數

名稱 機碼 必要 類型 Description
Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
作業系統主要版本
OSVersionMajor integer

作業系統主要版本。

作業系統次要版本
OSVersionMinor integer

作業系統次要版本。

作業系統組建版本
OSVersionBuild integer

作業系統組建版本。

作業系統為 64 位元
OSIs64Bit boolean

如果作業系統是 64 位,則傳回 true。

處理器計數
ProcessorCount integer

處理器計數。

實體 RAM 總計 (MB)
TotalPhysicalRAMInMB integer

實體 RAM 的數量 (以 MB 為單位)。

虛擬 RAM 總計 (MB)
TotalVirtualRAMInMB integer

虛擬 RAM 的數量 (以 MB 為單位)。

可用的實體 RAM(MB)
AvailablePhysicalRAMInMB integer

目前可用的實體 RAM 數量 (以 MB 為單位)。

可用的虛擬 RAM (MB)
AvailableVirtualRAMInMB integer

目前可用的虛擬 RAM 數量 (以 MB 為單位)。

作業系統全名
OSFullName string

作業系統全名,例如 Microsoft Windows Server 2019 Standard。

已安裝的 UI 文化特性名稱
InstalledUICultureName string

作業系統隨附的使用者介面語言,例如 en-US。

目前的 UI 文化特性名稱
CurrentUICultureName string

預設使用者介面語言,例如 en-US。

目前的文化特性名稱
CurrentCultureName string

預設使用者地區設定,例如 en-GB。

取得用戶端主機名稱

傳回執行 IA-Connect Director 之用戶端的主機名稱。

參數

名稱 機碼 必要 類型 Description
Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
用戶端主機名稱
ClientHostname string

執行 IA-Connect Director 之用戶端的主機名稱。

取得目前的滑鼠座標

使用 setcursorpos API 取得 IA-Connect Agent 使用者工作階段中的目前滑鼠游標位置。

參數

名稱 機碼 必要 類型 Description
Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
X 像素
X integer

X 座標值 (以像素為單位)。

Y 像素
Y integer

Y 座標值 (以像素為單位)。

取得磁碟可用空間

傳回執行 IA-Connect Agent 之電腦上指定磁碟的可用空間量。

參數

名稱 機碼 必要 類型 Description
磁碟機代號
DriveLetter True string

要檢查的磁碟磁碟機代號。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
磁碟可用空間位元組
FreeSpaceBytes integer

可用磁碟空間量 (以位元組為單位)。

磁碟可用空間 KB
FreeSpaceKB integer

可用磁碟空間量,以 KB 為單位。

磁碟可用空間 MB
FreeSpaceMB integer

可用磁碟空間量,以兆位元組為單位。

磁碟可用空間 GB
FreeSpaceGB integer

可用磁碟空間量,以 GB 為單位。

取得磁碟機清單

傳回執行 IA-Connect Agent 之電腦上的磁碟機清單。

參數

名稱 機碼 必要 類型 Description
Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
驅動 JSON
DrivesJSON string

執行 IA-Connect Agent 的電腦上的磁碟機清單,採用 JSON 格式。

取得螢幕解析度

傳回 IA-Connect 代理使用者工作階段的螢幕解析度。 對於在實體桌上型電腦或筆記型電腦上執行的 IA-Connect 本機代理程式,這將提供有關所有顯示裝置及其縮放的資訊。 在虛擬機器上,通常只會報告一個顯示器,除非虛擬機器已設定為顯示多個顯示器 (不常見)。 在遠端會話中,通常只會報告一個顯示器,即使該顯示器跨越多個本機顯示器,因為遠端會話通常會建立單一虛擬顯示器。

參數

名稱 機碼 必要 類型 Description
Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
水平解析度
HorizontalResolution integer

主螢幕的水平實體解析度。 實體座標會直接對應至監視器上的像素。

垂直解析度
VerticalResolution integer

主螢幕的垂直實體解析度。 實體座標會直接對應至監視器上的像素。

螢幕數量
NumberOfScreens integer

此階段作業中的畫面數目。

第二顯示水平分辨率
SecondDisplayHorizontalResolution integer

第二個螢幕的水平實體解析度 (如果偵測到)。 實體座標會直接對應至監視器上的像素。

第二顯示器垂直解析度
SecondDisplayVerticalResolution integer

第二個螢幕的垂直實體解析度 (如果偵測到)。 實體座標會直接對應至監視器上的像素。

第三顯示水平分辨率
ThirdDisplayHorizontalResolution integer

第三個螢幕的水平實體解析度 (如果偵測到)。 實體座標會直接對應至監視器上的像素。

第三顯示垂直解析度
ThirdDisplayVerticalResolution integer

第三個螢幕的垂直實體解析度(如果偵測到)。 實體座標會直接對應至監視器上的像素。

第四顯示水平分辨率
FourthDisplayHorizontalResolution integer

第四個螢幕的水平實體解析度(如果偵測到)。 實體座標會直接對應至監視器上的像素。

第四個顯示器垂直解析度
FourthDisplayVerticalResolution integer

第四個螢幕的垂直實體解析度 (如果偵測到)。 實體座標會直接對應至監視器上的像素。

虛擬螢幕左邊緣像素
VirtualScreenLeftEdgePixels integer

整個虛擬顯示器的左邊緣(所有偵測到的顯示器)。 虛擬座標是 DPI 縮放的。

虛擬螢幕頂部邊緣像素
VirtualScreenTopEdgePixels integer

整個虛擬顯示器的頂部邊緣(所有偵測到的顯示器)。 虛擬座標是 DPI 縮放的。

虛擬螢幕寬度像素
VirtualScreenWidthPixels integer

整個虛擬顯示器(所有偵測到的顯示器)的寬度。 虛擬座標是 DPI 縮放的。

虛擬螢幕高度像素
VirtualScreenHeightPixels integer

整個虛擬顯示器(所有偵測到的顯示器)的高度。 虛擬座標是 DPI 縮放的。

主要顯示器縮放比例
PrimaryDisplayScaling double

主要顯示器的 DPI 縮放乘數以小數表示。 例如:100% 會傳回為 1.0,125% 會傳回為 1.25。

第二個顯示縮放
SecondDisplayScaling double

第二個顯示的 DPI 縮放乘數以小數表示。 例如:100% 會傳回為 1.0,125% 會傳回為 1.25。

第三個顯示縮放
ThirdDisplayScaling double

第三個顯示的 DPI 縮放乘數以小數表示。 例如:100% 會傳回為 1.0,125% 會傳回為 1.25。

第四次顯示縮放
FourthDisplayScaling double

第四個顯示的 DPI 縮放乘數以十進位表示。 例如:100% 會傳回為 1.0,125% 會傳回為 1.25。

實體螢幕左邊緣像素
PhysicalScreenLeftEdgePixels integer

整個實體顯示器的左邊緣 (所有偵測到的顯示器)。 實體座標會直接對應至監視器上的像素。

實體螢幕上緣像素
PhysicalScreenTopEdgePixels integer

整個實體顯示器的頂部邊緣(所有偵測到的顯示器)。 實體座標會直接對應至監視器上的像素。

實體螢幕寬度像素
PhysicalScreenWidthPixels integer

整個實體顯示器的寬度 (所有偵測到的顯示器)。 實體座標會直接對應至監視器上的像素。

實體螢幕高度像素
PhysicalScreenHeightPixels integer

整個實體顯示器(所有偵測到的顯示器)的高度。 實體座標會直接對應至監視器上的像素。

主要顯示器左邊緣像素
PrimaryDisplayLeftEdgePixels integer

主顯示器的左側實體邊緣。 實體座標會直接對應至監視器上的像素。

主要顯示器頂部邊緣像素
PrimaryDisplayTopEdgePixels integer

主要顯示器的頂端實體邊緣。 實體座標會直接對應至監視器上的像素。

第二個顯示左邊緣像素
SecondDisplayLeftEdgePixels integer

第二個顯示器的左實體邊緣 (如果偵測到)。 實體座標會直接對應至監視器上的像素。

第二個顯示頂部邊緣像素
SecondDisplayTopEdgePixels integer

第二個顯示器的頂端實體邊緣 (如果偵測到的話)。 實體座標會直接對應至監視器上的像素。

第三顯示左邊緣像素
ThirdDisplayLeftEdgePixels integer

第三個顯示器的左實體邊緣 (如果偵測到)。 實體座標會直接對應至監視器上的像素。

第三顯示頂部邊緣像素
ThirdDisplayTopEdgePixels integer

第三個顯示器的頂部實體邊緣(如果偵測到)。 實體座標會直接對應至監視器上的像素。

第四個顯示左邊緣像素
FourthDisplayLeftEdgePixels integer

第四個顯示器的左實體邊緣 (如果偵測到的話)。 實體座標會直接對應至監視器上的像素。

第四個顯示頂部邊緣像素
FourthDisplayTopEdgePixels integer

第四個顯示器的頂部實體邊緣(如果偵測到)。 實體座標會直接對應至監視器上的像素。

取得資料夾

傳回執行 IA-Connect Agent 之電腦上指定資料夾內的所有子資料夾。

參數

名稱 機碼 必要 類型 Description
目錄路徑
DirectoryPath True string

目錄 (資料夾) 的完整路徑。 這必須可從執行 IA-Connect Agent 的階段作業存取。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
資料夾JSON
FoldersJSON string

資料夾中包含的子資料夾清單,採用 JSON 格式。

成功讀取的資料夾數目
NumberOfFoldersReadSuccessfully integer

成功讀取的子資料夾數目。

無法讀取的資料夾數目
NumberOfFoldersFailedToRead integer

無法讀取的子資料夾數目。

取得資料夾安全性權限

傳回目前在執行 IA-Connect Agent 的電腦上資料夾上設定的權限清單。

參數

名稱 機碼 必要 類型 Description
資料夾路徑
FolderPath True string

資料夾的完整路徑。 這必須可從執行 IA-Connect Agent 的階段作業存取。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
安全性許可權 JSON
SecurityPermissionsJSON string

目前在指定資料夾上設定的許可權,以 JSON 格式。

取得進程識別碼命令列屬性

傳回 IA-Connect Agent 使用者階段作業中具有指定處理程序 ID 的任何執行中處理程序的命令列內容。

參數

名稱 機碼 必要 類型 Description
進程識別碼
ProcessId True integer

要從中擷取指令行內容的處理程序識別碼。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
進程命令列
ProcessCommandLine string

程序的命令列屬性。

處理程序引數
ProcessArguments string

啟動程序時使用的引數。

處理目前工作目錄
ProcessCurrentWorkingDirectory string

進程目前工作目錄。

處理程序映像路徑名稱
ProcessImagePathName string

啟動程序之可執行檔的路徑。

取得電腦名稱

傳回執行 IA-Connect Agent 使用者工作階段的電腦名稱。

參數

名稱 機碼 必要 類型 Description
Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
電腦名稱
MachineName string

執行 IA-Connect Agent 使用者工作階段的電腦名稱。

取得電腦網域

傳回執行 IA-Connect Agent 使用者工作階段之電腦的網域。

參數

名稱 機碼 必要 類型 Description
Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
網域名稱
DomainName string

執行 IA-Connect Agent 使用者工作階段之機器的 NetBIOS 網域名稱。

DNS 網域名稱
DNSDomainName string

執行 IA-Connect Agent 使用者工作階段之電腦的 DNS 網域名稱。

取得預設印表機

取得 IA-Connect 代理程式階段作業中使用者的預設印表機名稱。

參數

名稱 機碼 必要 類型 Description
Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
預設印表機名稱
DefaultPrinterName string

使用者預設印表機的名稱。

啟動遠端桌面工作階段 (RDS)

使用 RDP 啟動檔案啟動遠端桌面工作階段 (RDS)。

參數

名稱 機碼 必要 類型 Description
RDP 檔案路徑
RDPFilePath True string

RDP 檔案的完整路徑 (可以預先存在,也可以使用動作建立:「建立遠端桌面工作階段 (RDS) 啟動檔案」)。

信任遠端電腦
TrustRemoteComputer boolean

設定為 true 可將遠端位址 (在 RDP 檔案中設定) 標記為受信任 (在 Windows 登錄中),主要用於裝置重新導向目的,消除您在啟動 RDP 檔案時可能收到的快顯視窗。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
指令結果
LaunchRemoteDesktopSessionResult boolean

命令的結果(成功或失敗)。

錯誤訊息
ErrorMessage string

如果指令不成功,則會包含傳回的錯誤訊息。

啟用 IA-Connect 下一個躍點

啟用下一個躍點,該躍點會將接收到的所有未來命令轉發到下一個躍點會話中運行的 IA-Connect 代理程式。

參數

名稱 機碼 必要 類型 Description
下一躍點導向器位址
NextHopDirectorAddress string

如果「下一個躍點導向器位址是 localhost」、「下一個躍點導向器位址是主機名稱」、「下一個躍點導向器位址是 FQDN」或「下一個躍點導向器位址已命名管道」參數都沒有,則下一個躍點 IA-Connect 導向器的選擇性位址會將命令轉送至。

下一躍點導向器 TCP 連接埠
NextHopDirectorTCPPort integer

下一個躍點導向器接聽的 TCP 埠 (執行代理程式之電腦上的導向器)。

下一個躍點導向器使用 HTTPS
NextHopDirectorUsesHTTPS boolean

如果下一個躍點導向器使用 HTTPS,則設定為 True,如果不是,則設定為 false。

下一個躍點導向器位址是localhost
NextHopDirectorAddressIsLocalhostname boolean

下一個躍點導向器位址 (相對於代理程式) 是 'localhost'。

下一躍點導向器位址為主機名稱
NextHopDirectorAddressIsHostname boolean

下一個躍點導向器位址是執行代理程式的電腦的主機名稱 (即執行代理程式和導向器的電腦)。

下一個躍點導向器位址是 FQDN
NextHopDirectorAddressIsFQDN boolean

下一個躍點導向器位址是執行代理程式的電腦的完整網域名稱 (FQDN) (也就是執行代理程式和導向程式的電腦) 。

依會話識別碼遞增下一個躍點導向器 TCP 連接埠
IncrementNextHopDirectorTCPPortBySessionId boolean

若要確保下一躍點導向器 TCP 連接埠是唯一的 (如果有多個平行會話使用來自相同主機的下一躍點),可以將工作階段 ID 新增至下一躍點導向器 TCP 連接埠。

啟用前停用
DisableBeforeEnable boolean

在再次啟用之前,是否應該停用雙跳 (如果目前處於作用中狀態) ? 如果設為 true (預設值) ,則任何新的雙躍點啟用指示都會取代先前的指示。 如果設定為 false,這將啟用三躍點,因為雙躍點 IA-Connect 代理程式會接收指令。

檢查下一個躍點導向器是否正在執行
CheckNextHopDirectorIsRunning boolean

下一躍點需要與代理程式在同一部電腦上執行中的 IA-Connect 導向器。 如果此設定為 true,代理程式將檢查下一個躍點導向器是否如所述執行,如果下一個躍點導向器未執行,則無法啟用下一個躍點。 如果此設定為false,則代理程式將不會執行任何檢查,而只會啟用下一躍點。

檢查下一個躍點代理程式是否正在執行
CheckNextHopAgentIsRunning boolean

下一個躍點需要與代理程式相同的電腦上執行中的 IA-Connect Director,以及下一個躍點工作階段中執行中的 IA-Connect Agent。 如果此設定為 true,則代理程式將檢查下一個躍點代理程式是否如所述執行,如果下一個躍點代理程式未執行,則無法啟用下一個躍點。 如果此設定為false,則代理程式將不會執行任何檢查,而只會啟用下一躍點。

下一個躍點導向器位址名為pipe
NextHopDirectorAddressIsNamedPipe boolean

下一個躍點導向器位址 (相對於代理程式) 使用具名管道,而不是 TCP/IP Web 服務。 這是避免在第一躍點上使用 TCP/IP 埠的預設值。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
作用中下一個躍點導向器位址
ActiveNextHopDirectorAddress string

作用中下一躍點導向器的位址 (如果正在使用)。

作用中下一跳導向器 TCP 連接埠
ActiveNextHopDirectorTCPPort integer

作用中下一躍點導向器的TCP埠(如果正在使用)。

作用中下一個躍點導向器使用 HTTPS
ActiveNextHopDirectorUsesHTTPS boolean

如果作用中的下一個躍點導向器使用 HTTPS,則傳回 true。

作用中下一個躍點導向器 URL
ActiveNextHopDirectorURL string

作用中下一個躍點導向器的 URL。

啟用資料夾安全性繼承

在執行 IA-Connect Agent 的電腦上的資料夾上啟用安全性繼承。

參數

名稱 機碼 必要 類型 Description
資料夾路徑
FolderPath True string

資料夾的完整路徑。 這必須可從執行 IA-Connect Agent 的階段作業存取。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

在座標之間拖曳滑鼠中鍵

在 IA-Connect 代理程式使用者工作階段中的兩個指定座標之間執行滑鼠中鍵拖曳。 目前作用中的滑鼠移動 API (mouse_event 或 setcursorpos) 用於移動滑鼠。 計算座標時會考慮 DPI 縮放和多個顯示。 滑鼠移動支援可選的抖動,使其更像人手移動。

參數

名稱 機碼 必要 類型 Description
開始 X 像素
StartXCoord True integer

起始 X 座標值 (以像素為單位)。

起始 Y 像素
StartYCoord True integer

起始 Y 座標值 (以像素為單位)。

結束 X 像素
EndXCoord True integer

結束 X 座標值 (以像素為單位)。

結束 Y 像素
EndYCoord True integer

結束 Y 座標值 (以像素為單位)。

步數
NumberOfSteps integer

拖曳動作應分割成的步驟數。

總時間(以秒為單位)
TotalTimeInSeconds double

拖曳動作從開始到結束所花費的總時間。

最大移動像素抖動
MaximumMovementPixelJitter integer

執行拖曳動作時的最大像素抖動。 值為 1 或更高可啟用移動抖動。 每個步驟的抖動都會平滑,以避免運動中的尖峰。 此輸入的值控制任何特定點的抖動最大值,限制滑鼠可以偏離路徑的距離。 值越高,拖曳動作的「平滑」程度就越低。 每個點的抖動只能偏離先前的抖動值 -2 到 2 之間 (預設) ,因此無論您將最大值設定為什麼,最大可能的抖動都是 2 x NumberOfSteps。

最大終端像素抖動
MaximumEndPixelJitter integer

拖曳動作結束時的最大像素抖動。 值越高,到達終點座標時的阻力就越不精確。

最大移動像素抖動增量
MaximumMovementPixelJitterDelta integer

如果使用滑鼠移動抖動(最大移動像素抖動為 1 或更高),則每個點的最大抖動可能會偏離前一個點。 這用於確保抖動平滑。 值越大,平滑度越差。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

在座標之間拖曳滑鼠右鍵

在 IA-Connect 客服專員使用者工作階段中的兩個指定座標之間執行滑鼠右鍵拖曳。 目前作用中的滑鼠移動 API (mouse_event 或 setcursorpos) 用於移動滑鼠。 計算座標時會考慮 DPI 縮放和多個顯示。 滑鼠移動支援可選的抖動,使其更像人手移動。

參數

名稱 機碼 必要 類型 Description
開始 X 像素
StartXCoord True integer

起始 X 座標值 (以像素為單位)。

起始 Y 像素
StartYCoord True integer

起始 Y 座標值 (以像素為單位)。

結束 X 像素
EndXCoord True integer

結束 X 座標值 (以像素為單位)。

結束 Y 像素
EndYCoord True integer

結束 Y 座標值 (以像素為單位)。

步數
NumberOfSteps integer

拖曳動作應分割成的步驟數。

總時間(以秒為單位)
TotalTimeInSeconds double

拖曳動作從開始到結束所花費的總時間。

最大移動像素抖動
MaximumMovementPixelJitter integer

執行拖曳動作時的最大像素抖動。 值為 1 或更高可啟用移動抖動。 每個步驟的抖動都會平滑,以避免運動中的尖峰。 此輸入的值控制任何特定點的抖動最大值,限制滑鼠可以偏離路徑的距離。 值越高,拖曳動作的「平滑」程度就越低。 每個點的抖動只能偏離先前的抖動值 -2 到 2 之間 (預設) ,因此無論您將最大值設定為什麼,最大可能的抖動都是 2 x NumberOfSteps。

最大終端像素抖動
MaximumEndPixelJitter integer

拖曳動作結束時的最大像素抖動。 值越高,到達終點座標時的阻力就越不精確。

最大移動像素抖動增量
MaximumMovementPixelJitterDelta integer

如果使用滑鼠移動抖動(最大移動像素抖動為 1 或更高),則每個點的最大抖動可能會偏離前一個點。 這用於確保抖動平滑。 值越大,平滑度越差。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

在座標之間拖曳滑鼠左鍵

在 IA-Connect 客服專員使用者工作階段中的兩個指定座標之間執行滑鼠左鍵拖曳。 目前作用中的滑鼠移動 API (mouse_event 或 setcursorpos) 用於移動滑鼠。 計算座標時會考慮 DPI 縮放和多個顯示。 滑鼠移動支援可選的抖動,使其更像人手移動。

參數

名稱 機碼 必要 類型 Description
開始 X 像素
StartXCoord True integer

起始 X 座標值 (以像素為單位)。

起始 Y 像素
StartYCoord True integer

起始 Y 座標值 (以像素為單位)。

結束 X 像素
EndXCoord True integer

結束 X 座標值 (以像素為單位)。

結束 Y 像素
EndYCoord True integer

結束 Y 座標值 (以像素為單位)。

步數
NumberOfSteps integer

拖曳動作應分割成的步驟數。

總時間(以秒為單位)
TotalTimeInSeconds double

拖曳動作從開始到結束所花費的總時間。

最大移動像素抖動
MaximumMovementPixelJitter integer

執行拖曳動作時的最大像素抖動。 值為 1 或更高可啟用移動抖動。 每個步驟的抖動都會平滑,以避免運動中的尖峰。 此輸入的值控制任何特定點的抖動最大值,限制滑鼠可以偏離路徑的距離。 值越高,拖曳動作的「平滑」程度就越低。 每個點的抖動只能偏離先前的抖動值 -2 到 2 之間 (預設) ,因此無論您將最大值設定為什麼,最大可能的抖動都是 2 x NumberOfSteps。

最大終端像素抖動
MaximumEndPixelJitter integer

拖曳動作結束時的最大像素抖動。 值越高,到達終點座標時的阻力就越不精確。

最大移動像素抖動增量
MaximumMovementPixelJitterDelta integer

如果使用滑鼠移動抖動(最大移動像素抖動為 1 或更高),則每個點的最大抖動可能會偏離前一個點。 這用於確保抖動平滑。 值越大,平滑度越差。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

在座標之間移動滑鼠

在 IA-Connect 客服專員使用者工作階段中的兩個指定座標之間移動滑鼠。 目前作用中的滑鼠移動 API (mouse_event 或 setcursorpos) 用於移動滑鼠。 計算座標時會考慮 DPI 縮放和多個顯示。 滑鼠移動支援可選的抖動,使其更像人手移動。

參數

名稱 機碼 必要 類型 Description
開始 X 像素
StartXCoord True integer

起始 X 座標值 (以像素為單位)。

起始 Y 像素
StartYCoord True integer

起始 Y 座標值 (以像素為單位)。

結束 X 像素
EndXCoord True integer

結束 X 座標值 (以像素為單位)。

結束 Y 像素
EndYCoord True integer

結束 Y 座標值 (以像素為單位)。

步數
NumberOfSteps integer

移動動作應中斷的步驟數。

總時間(以秒為單位)
TotalTimeInSeconds double

移動動作從開始到結束所花費的總時間。

最大移動像素抖動
MaximumMovementPixelJitter integer

執行拖曳動作時的最大像素抖動。 值為 1 或更高可啟用移動抖動。 每個步驟的抖動都會平滑,以避免運動中的尖峰。 此輸入的值控制任何特定點的抖動最大值,限制滑鼠可以偏離路徑的距離。 值越高,拖曳動作的「平滑」程度就越低。 每個點的抖動只能偏離先前的抖動值 -2 到 2 之間 (預設) ,因此無論您將最大值設定為什麼,最大可能的抖動都是 2 x NumberOfSteps。

最大終端像素抖動
MaximumEndPixelJitter integer

拖曳動作結束時的最大像素抖動。 值越高,到達終點座標時的阻力就越不精確。

最大移動像素抖動增量
MaximumMovementPixelJitterDelta integer

如果使用滑鼠移動抖動(最大移動像素抖動為 1 或更高),則每個點的最大抖動可能會偏離前一個點。 這用於確保抖動平滑。 值越大,平滑度越差。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

在座標處取得像素色彩

傳回指定座標處圖元的 RGB 色彩。

參數

名稱 機碼 必要 類型 Description
左 X 像素
LeftXPixels True integer

要讀取的像素的 X 位置。 在單一顯示器上,最左邊的 X 像素為 0。 在多顯示器顯示器上,最左邊的 X 圖元可能是負值 (視標示為主要顯示器的顯示器,以及相對於其他顯示器的位置而定)。

前 Y 像素
TopYPixels True integer

要讀取的像素的 Y 位置。 在單一顯示器上,最頂端的 Y 圖元為 0。 在多顯示器顯示器上,最頂端的 Y 圖元可能是負數 (取決於標示為主要顯示器的顯示器,以及它相對於其他顯示器的位置)。

隱藏代理程式
HideAgent boolean

設定為 true 可自動隱藏代理程式 (如果可見),以確保它不會遮擋正在讀取的像素。

使用實體座標
UsePhysicalCoordinates boolean

設定為 true 以指定提供的座標是實體座標 (未調整 DPI,因此符合顯示器上的實體圖元) 。 設定為 false (預設值) ,以指定提供的座標是虛擬的 (DPI 縮放) 。 UIA、Java 和 Web 動作通常使用虛擬座標。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
紅色值
RedValue integer

傳回像素的紅色值,從 0 (無紅色) 到 255 (全紅色)。

綠色價值
GreenValue integer

傳回像素的綠色值,從 0 (無綠色) 到 255 (全綠色)。

藍色值
BlueValue integer

傳回像素的藍色值,從 0 (無藍色) 到 255 (全藍色)。

Alpha值
AlphaValue integer

傳回像素的 alpha 值,從 0 (完全透明) 到 255 (完全不透明)。

RRGGBB 十六進位值
RRGGBBHexValue string

傳回圖元的 RRGGBB 十六進位值。 例如:FF0000是全紅色,00FF00是全綠色,0000FF是藍色,000000是黑色,FFFFFF是全白色。

AARRGGBB 十六進位值
AARRGGBBHexValue string

傳回像素的 AARRGGBB 十六進位值,該值與 RRGGBB 相同,但開頭包含十六進位 alpha 值。 對於完全不透明的像素(最常見的),這將保留值 FFRRGGBB。 例如:FFFF0000是完全不透明的全紅色。

在座標處按一下滑鼠中鍵

在指定座標處按一下 IA-Connect Agent 使用者工作階段中的滑鼠中鍵。 目前作用中的滑鼠移動 API (mouse_event 或 setcursorpos) 用於移動滑鼠。 計算座標時會考慮 DPI 縮放和多個顯示。

參數

名稱 機碼 必要 類型 Description
X 像素
XCoord True integer

X 座標值 (以像素為單位)。

Y 像素
YCoord True integer

Y 座標值 (以像素為單位)。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

在座標處按一下滑鼠右鍵

在指定座標處按一下 IA-Connect Agent 使用者工作階段中的滑鼠右鍵。 目前作用中的滑鼠移動 API (mouse_event 或 setcursorpos) 用於移動滑鼠。 計算座標時會考慮 DPI 縮放和多個顯示。

參數

名稱 機碼 必要 類型 Description
X 像素
XCoord True integer

X 座標值 (以像素為單位)。

Y 像素
YCoord True integer

Y 座標值 (以像素為單位)。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

在座標處按一下滑鼠左鍵

在指定座標處按一下 IA-Connect 客服專員使用者工作階段中的滑鼠左鍵。 目前作用中的滑鼠移動 API (mouse_event 或 setcursorpos) 用於移動滑鼠。 計算座標時會考慮 DPI 縮放和多個顯示。

參數

名稱 機碼 必要 類型 Description
X 像素
XCoord True integer

X 座標值 (以像素為單位)。

Y 像素
YCoord True integer

Y 座標值 (以像素為單位)。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

在座標處按住滑鼠中

在 IA-Connect 客服專員使用者工作階段中的指定座標處按住滑鼠中鍵指定的秒數。 目前作用中的滑鼠移動 API (mouse_event 或 setcursorpos) 用於移動滑鼠。 計算座標時會考慮 DPI 縮放和多個顯示。

參數

名稱 機碼 必要 類型 Description
X 像素
XCoord True integer

X 座標值 (以像素為單位)。

Y 像素
YCoord True integer

Y 座標值 (以像素為單位)。

秒數保持
SecondsToHold True double

按住滑鼠中鍵的秒數。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

在座標處按住滑鼠右鍵

在 IA-Connect 客服專員使用者工作階段中的指定座標處按住滑鼠右鍵指定的秒數。 目前作用中的滑鼠移動 API (mouse_event 或 setcursorpos) 用於移動滑鼠。 計算座標時會考慮 DPI 縮放和多個顯示。

參數

名稱 機碼 必要 類型 Description
X 像素
XCoord True integer

X 座標值 (以像素為單位)。

Y 像素
YCoord True integer

Y 座標值 (以像素為單位)。

秒數保持
SecondsToHold True double

按住滑鼠右鍵的秒數。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

在座標處按住滑鼠左鍵

在 IA-Connect 代理程式使用者工作階段中的指定座標處按住滑鼠左鍵指定的秒數。 目前作用中的滑鼠移動 API (mouse_event 或 setcursorpos) 用於移動滑鼠。 計算座標時會考慮 DPI 縮放和多個顯示。

參數

名稱 機碼 必要 類型 Description
X 像素
XCoord True integer

X 座標值 (以像素為單位)。

Y 像素
YCoord True integer

Y 座標值 (以像素為單位)。

秒數保持
SecondsToHold True double

按住滑鼠左鍵的秒數。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

在座標處雙擊滑鼠左鍵

在指定座標處按兩下 IA-Connect Agent 使用者工作階段中的滑鼠左鍵。 目前作用中的滑鼠移動 API (mouse_event 或 setcursorpos) 用於移動滑鼠。 計算座標時會考慮 DPI 縮放和多個顯示。

參數

名稱 機碼 必要 類型 Description
X 像素
XCoord True integer

X 座標值 (以像素為單位)。

Y 像素
YCoord True integer

Y 座標值 (以像素為單位)。

延遲(以毫秒為單位)
DelayInMilliseconds integer

每次點擊之間的延遲,以毫秒為單位。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

在螢幕上繪製矩形

在螢幕上繪製矩形,以協助識別螢幕座標,或報告螢幕座標的動作輸出。 矩形會在 5 秒後自動移除。

參數

名稱 機碼 必要 類型 Description
矩形左邊緣螢幕像素X座標
RectangleLeftPixelXCoord True integer

要顯示的矩形的左圖元邊緣。 可以是虛擬或實體像素,具體取決於輸入「座標是實體的」。

矩形右邊緣螢幕像素 X 座標
RectangleRightPixelXCoord True integer

要顯示的矩形的右圖元邊緣。 可以是虛擬或實體像素,具體取決於輸入「座標是實體的」。

矩形上緣螢幕像素 Y 座標
RectangleTopPixelYCoord True integer

要顯示的矩形的頂端像素邊緣。 可以是虛擬或實體像素,具體取決於輸入「座標是實體的」。

矩形底緣螢幕像素Y座標
RectangleBottomPixelYCoord True integer

要顯示的矩形底部像素邊緣。 可以是虛擬或實體像素,具體取決於輸入「座標是實體的」。

筆顏色
PenColour string

要繪製的矩形的顏色(例如紅色、綠色、藍色、黃色、紫色或橙色)或字符串十六進制代碼(例如 #FF0000)。

手寫筆粗細像素
PenThicknessPixels integer

醒目提示矩形框線的粗細 (以像素為單位)。

顯示秒數
SecondsToDisplay integer

顯示矩形的秒數。

坐標是物理的
CoordinatesArePhysical boolean

如果提供的座標是實體螢幕座標,則設定為 true。 如果提供的座標是虛擬的,則設定為 false。 如果基礎顯示縮放比例為 100%,則實體座標和虛擬座標都相同。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
指令結果
DrawRectangleOnScreenResult boolean

命令的結果(成功或失敗)。

錯誤訊息
ErrorMessage string

如果指令不成功,則會包含傳回的錯誤訊息。

在資料夾上設定擁有者

在執行 IA-Connect Agent 的電腦上設定資料夾的擁有者。

參數

名稱 機碼 必要 類型 Description
資料夾路徑
FolderPath True string

資料夾的完整路徑。 這必須可從執行 IA-Connect Agent 的階段作業存取。

使用者身分識別
UserIdentity True string

要指派所有權的使用者身分識別。 這可以是「使用者名稱」、「網域\使用者名稱」或「username@domainfqdn」的形式。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

執行 PowerShell 程式

啟動 PowerShell 進程,在磁碟上執行現有的腳本,或提供要執行的腳本內容。 請考慮改用「執行 PowerShell 腳本」動作,這動作功能更強大,並提供 PowerShell 腳本輸出的資料表。 如果您的 PowerShell 指令碼輸出為標準輸出或標準錯誤 (例如,使用 Write-Host 而不是傳回資料表)、需要 PowerShell 7,或以替代使用者身分執行 Active Directory 動作,且無法透過 WinRM 使用 CredSSP,請使用此動作。

參數

名稱 機碼 必要 類型 Description
PowerShell 可執行檔
PowerShellExecutable string

PowerShell 可執行檔的路徑。 保留預設值 'PowerShell.exe' ,以執行預設的 PowerShell 可執行檔,如 Windows 路徑中所定義。 針對 PowerShell 5.x 使用 '%SYSTEMROOT%\system32\WindowsPowerShell\v1.0\PowerShell.exe'。 針對 PowerShell 7 使用 'C:\Program Files\PowerShell\7\pwsh.exe'。 IA-Connect 代理程式會展開路徑中的任何環境變數。

PowerShell 腳本檔案路徑
PowerShellScriptFilePath string

要執行之現有 PowerShell 指令碼的路徑。 PowerShell 指令碼應該可由 IA-Connect 代理程式存取 (亦即,如果代理程式在遠端工作階段中執行,則指令碼應該位於遠端系統上,或可從遠端系統存取)。 或者,將此輸入保留空白,並在輸入 'PowerShell 腳本內容' 中提供 PowerShell 腳本的內容。 IA-Connect 代理程式會展開路徑中的任何環境變數。

PowerShell 腳本內容
PowerShellScriptContents string

要執行的 PowerShell 指令碼內容,而不是提供現有 PowerShell 指令碼的路徑。

工作資料夾
WorkingDirectory string

PowerShell 腳本的工作資料夾/目錄。 IA-Connect 代理程式會展開路徑中的任何環境變數。

不建立視窗
CreateNoWindow boolean

如果設定為 true (預設值) ,PowerShell 腳本將會以不可見的方式執行。 如果設定為 false,則會出現 PowerShell 腳本視窗。 如果 PowerShell 腳本提示輸入,而且您打算使用 UIA 和全域滑鼠和鍵盤動作來與之互動,這可能會很有用。

視窗樣式
WindowStyle string

如果 PowerShell 腳本設定為可見執行,請提供視窗樣式 (正常、最大化、最小化或隱藏)。

等待進程
WaitForProcess boolean

IA-Connect 代理程式應該等候 PowerShell 腳本完成嗎? 依預設,此設定為 true,以允許 IA-Connect 代理程式從指令碼取得輸出。 設定為 false 表示 fire-and-forget。

重新導向標準輸出
RedirectStandardOutput boolean

如果設定為 true (預設值),指令碼的標準輸出將會重新導向,讓代理程式在 StandardOutput 變數中傳回它。 如果您希望將指令碼的輸出傳回代理程式(例如,從 Write-Host的輸出),這非常有用。

重新導向標準誤差
RedirectStandardError boolean

如果設定為 true,指令碼的標準錯誤將會重新導向,讓代理程式在 StandardError 變數中傳回它。

將標準誤差重新導向至輸出
RedirectStandardErrorToOutput boolean

如果設定為 true,指令碼的標準錯誤將重新導向至標準輸出,並將它們合併為單一輸出。

標準輸出編碼
StandardOutputEncoding string

提供標準輸出編碼(UTF8、UTF7、UTF16、ASCII 或 UTF16BE)。

標準錯誤編碼
StandardErrorEncoding string

提供標準錯誤編碼(UTF8、UTF7、UTF16、ASCII 或 UTF16BE)。

RunAs 網域名稱
RunAsDomain string

以使用者身分執行的網域。 如果未指定網域,則使用者名稱的格式應為username@domainFQDN。

RunAs 用戶名
RunAsUsername string

執行身分使用者的使用者名稱。

RunAs 密碼
RunAsPassword password

執行身分使用者的密碼。

RunAs 載入使用者設定檔
RunAsLoadUserProfile boolean

是否應該載入以使用者身分執行的 Windows 使用者設定檔?

RunAs 提升
RunAsElevate boolean

PowerShell 腳本應該以提升許可權執行嗎? 您可能很難接受提升要求。

逾時 (秒)
TimeoutInSeconds integer

等候 PowerShell 指令碼完成的秒數上限。

PowerShell 指令碼暫存資料夾
PowerShellScriptTempFolder string

根據預設,如果您在輸入 'PowerShell 指令碼內容' 中提供 PowerShell 指令碼,IA-Connect 代理程式會透過 -File 輸入將指令碼儲存至檔案 '%TEMP%\IA-Connect\TempPowerShell-{Date}-{Time}.ps1', passes it to PowerShell.exe,並在指令碼完成時刪除檔案。 如果您使用 RunAs 使用者名稱,則此預設路徑可能無法接受,因為 RunAs 使用者可能無法存取執行 IA-Connect Agent 的帳戶設定檔。 使用此輸入來提供替代資料夾。 例如:「%SYSTEMDRIVE% emp」。 IA-Connect 代理程式會展開路徑中的任何環境變數。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
進程開始
ProcessStarted boolean

如果 PowerShell 腳本程式 (PowerShell.exe) 已啟動,則傳回 true。

結束代碼
ExitCode integer

傳回 PowerShell 腳本程式 (PowerShell.exe) 結束碼。

進程逾時
ProcessTimedOut boolean

如果 PowerShell 腳本程式 (PowerShell.exe) 逾時,則傳回 true。

進程識別碼
ProcessId integer

已啟動之 PowerShell 腳本進程 (PowerShell.exe) 的進程識別碼。

標準輸出
StandardOutput string

標準輸出內容。

標準錯誤
StandardError string

標準誤差內容。

執行一般 IA-Connect 代理程式命令

執行一般 IA-Connect 代理程式命令,將引數傳遞為 JSON,並將輸出資料傳回為 JSON。 當 Director 和 Inspector 的版本比 Agent 舊,因此無法理解命令時,用於執行 Agent 命令。

參數

名稱 機碼 必要 類型 Description
IA-Connect 代理程式指令名稱
CommandName True string

IA-Connect 代理程式指令的內部名稱。 命令名稱清單可由動作 'GetAgentActionsInClass' 提供。

輸入 JSON
InputJSON string

IA-Connect 代理程式命令的輸入,採用 JSON 格式。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
輸出JSON
OutputJSON string

IA-Connect 代理程式命令的輸出,採用 JSON 格式。

執行替代 IA-Connect 代理程式

從檔案位置載入代理程式可執行檔,以執行替代 IA-Connect 代理程式 (例如更新版本)。

參數

名稱 機碼 必要 類型 Description
檔名
Filename True string

通往替代 IA-Connect Agent.exe 的完整路徑要運行。 此路徑必須可從目前執行 IA-Connect Agent 的階段作業存取。

Arguments
Arguments string

執行時要傳遞給 IA-Connect Agent.exe 的任何選擇性引數。

載入記憶體
LoadIntoMemory boolean

替代 IA-Connect 代理程式是否應該在記憶體中執行? 如果設定為 true,則會將新的 Agent 載入到記憶體中,並在現有 Agent 的組件中執行。 如果設定為 false,則新的代理程式會以正常程序的形式執行,而現有的代理程式 EXE 將會結束。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

執行替代 IA-Connect 從導向器傳送的代理程式

從 IA-Connect Director 上傳替代代理程式,然後載入替代代理程式可執行檔,以執行替代 IA-Connect 代理程式 (例如更新版本)。

參數

名稱 機碼 必要 類型 Description
本機檔案名稱
LocalFilename True string

可從 IA-Connect 導向器存取的替代 IA-Connect Agent.exe 的完整路徑。

遠端檔案名稱
RemoteFilename string

複製替代 IA-Connect Agent.exe 位置的完整路徑 (在遠端系統上)。 如果未指定,則會選擇暫存檔案名稱。 如果將替代 IA-Connect 代理程式載入記憶體,則不會建立此檔案 (因為不需要),除非您將「即使從記憶體執行也儲存到磁碟」設定為 true。 只有當您想要使用 IA-Connect 的動態程式碼動作時,才會將此設定為 true,而這些動作需要「參考執行彙編」(例如存取 IA-Connect 內部方法)。

壓縮
Compress boolean

在上傳期間是否應該壓縮替代 IA-Connect 代理程式可執行檔?

Arguments
Arguments string

執行時要傳遞給 IA-Connect Agent.exe 的任何選擇性引數。

許可降級
PermitDowngrade boolean

是否應該允許舊版的 IA-Connect 代理程式?

略過版本檢查
SkipVersionCheck boolean

是否應該完全不檢查 IA-Connect 代理程式的版本(現有和新版本),導致新版本在所有場景中都使用(甚至是相同的版本)?

載入記憶體
LoadIntoMemory boolean

替代 IA-Connect 代理程式是否應該在記憶體中執行? 如果設定為 true,則會將新的 Agent 載入到記憶體中,並在現有 Agent 的組件中執行。 如果設定為 false,則新的代理程式會以正常程序的形式執行,而現有的代理程式 EXE 將會結束。

即使從記憶體執行也能儲存到磁碟
SaveToDiskEvenIfRunningFromMemory boolean

替代 IA-Connect 代理程式是否應該儲存至磁碟,即使它在記憶體中執行? 只有當您想要使用 IA-Connect 的動態程式碼動作時,才會將此設定為 true,而這些動作需要「參考執行彙編」(例如存取 IA-Connect 內部方法)。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
複製的替代檔案
AlternativeFileCopied boolean

報告是否使用替代 IA-Connect 代理程式。

執行程序

啟動進程、命令或應用程式。

參數

名稱 機碼 必要 類型 Description
程序名稱
ProcessName True string

要執行的程序。 例如 notepad.exe 或 C:\windows\system32\notepad.exe。 IA-Connect 代理程式會展開路徑中的任何環境變數。

Arguments
Arguments string

啟動應用程式時要使用的任何命令列引數。

工作資料夾
WorkingDirectory string

進程的工作資料夾/目錄。 IA-Connect 代理程式會展開路徑中的任何環境變數。

使用 Shell execute
UseShellExecute boolean

是否應該使用作業系統殼層來啟動程式?

不建立視窗
CreateNoWindow boolean

該過程應該在沒有窗口的情況下啟動嗎?

視窗樣式
WindowStyle string

提供視窗樣式 (正常、最大化、最小化或隱藏)。

等待進程
WaitForProcess boolean

我們應該等待該過程完成嗎? 這可能僅在運行需要先完成才能繼續的程序或腳本時使用。

重新導向標準輸出
RedirectStandardOutput boolean

標準輸出應該重新導向嗎?

重新導向標準誤差
RedirectStandardError boolean

標準誤差應該重新導向嗎?

將標準誤差重新導向至輸出
RedirectStandardErrorToOutput boolean

標準誤差應該重定向到輸出嗎?

標準輸出編碼
StandardOutputEncoding string

提供標準輸出編碼(UTF8、UTF7、UTF16、ASCII 或 UTF16BE)。

標準錯誤編碼
StandardErrorEncoding string

提供標準錯誤編碼(UTF8、UTF7、UTF16、ASCII 或 UTF16BE)。

RunAs 網域名稱
RunAsDomain string

以使用者身分執行的網域。 如果未指定網域,則使用者名稱的格式應為username@domainFQDN。

RunAs 用戶名
RunAsUsername string

執行身分使用者的使用者名稱。

RunAs 密碼
RunAsPassword password

執行身分使用者的密碼。

RunAs 載入使用者設定檔
RunAsLoadUserProfile boolean

是否應該載入以使用者身分執行的 Windows 使用者設定檔?

RunAs 提升
RunAsElevate boolean

該過程應該以提升權限運行嗎?

逾時 (秒)
TimeoutInSeconds integer

等待程序完成的最大秒數。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
進程開始
ProcessStarted boolean

如果程序已啟動,則傳回 true。

結束代碼
ExitCode integer

傳回進程結束碼。

進程逾時
ProcessTimedOut boolean

如果進程逾時,則傳回 true。

進程識別碼
ProcessId integer

已啟動之程序的程序 ID。

標準輸出
StandardOutput string

標準輸出內容。

標準錯誤
StandardError string

標準誤差內容。

寫入 CSV 檔案

在執行 IA-Connect Agent 的電腦上建立 CSV 檔案。 CSV 檔案是從集合 (表格) 或 JSON 格式的資料表建立。

參數

名稱 機碼 必要 類型 Description
屬性
Properties object
輸入資料表JSON
InputTableJSON string

要寫入 CSV 檔案的資料表,採用 JSON 格式。

輸出 CSV 檔案路徑
CSVFilePath True string

CSV 檔案的完整路徑。 這必須可從執行 IA-Connect Agent 的階段作業存取。

輸出編碼
OutputEncoding string

寫入 CSV 檔案時要使用的文字編碼格式。 支援的編碼有 UTF8、UTF7、Unicode 和 ASCII。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
指令結果
WriteCollectionToCSVFileResult boolean

命令的結果(成功或失敗)。

錯誤訊息
ErrorMessage string

如果指令不成功,則會包含傳回的錯誤訊息。

寫入使用者認證

在 IA-Connect Agent 工作階段中將使用者設定檔中的認證寫入使用者設定檔中的認證,如果該認證不存在,則建立該認證。 您可以從 Windows 控制台檢視認證。

參數

名稱 機碼 必要 類型 Description
認證位址
CredentialAddress True string

認證的名稱/位址。

使用者名
UserName True string

認證用戶名稱。

密碼
Password True string

認證密碼。

認證類型
CredentialType True string

認證類型:Windows 或一般。

認證持續性
CredentialPersistence string

認證持續性:工作階段 (僅針對此登入工作階段持續)、LocalMachine (跨工作階段為此使用者持續存在,並僅在此電腦上重新啟動) 或企業 (可以在電腦之間漫遊)。

對稱加密金鑰
SymmetricKey string

用於加密認證的選用對稱加密金鑰。 只有在您知道金鑰的情況下,才能擷取此認證。 只能與通用憑證一起使用。

將密碼儲存為識別碼
StorePasswordAsIdentifier string

如果提供識別碼,則此密碼也會加密儲存在代理程式內,以便日後任何可使用儲存憑證的命令擷取/使用。 這些密碼僅儲存在記憶體中,並在代理關閉時遺失。 例如:MyExchangePassword。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
指令結果
CredentialWriteResult boolean

命令的結果(成功或失敗)。

錯誤訊息
ErrorMessage string

如果指令不成功,則會包含傳回的錯誤訊息。

寫入文字檔案

在執行 IA-Connect Agent 的電腦上建立文字檔,並將文字寫入檔案。

參數

名稱 機碼 必要 類型 Description
檔案路徑
Filename True string

檔案的完整路徑。 這必須可從執行 IA-Connect Agent 的階段作業存取。

要寫的文字
TextToWrite string

要寫入檔案的文字內容。

附加現有檔案
AppendExistingFile boolean

如果檔案已經存在,是否應該將要寫入的新文字附加到現有檔案的結尾?

編碼
Encoding string

提供檔案編碼 (Unicode、UTF8、UTF7 或 ASCII) 或將預設值 (UTF8) 留空。

如有需要,請建立資料夾
CreateFolderIfRequired boolean

如果「檔案路徑」參數中提供的儲存檔案的資料夾不存在,是否應該建立此資料夾?

Workflow
Workflow True string

在此處新增下列運算式:workflow()

將 IA-Connect 代理程式 GUI 置於最前面

將 IA-Connect 代理程式 GUI 帶到前面,使其在螢幕上可見。

參數

名稱 機碼 必要 類型 Description
專注
Focus boolean

IA-Connect 代理程式 GUI 應該重點關注嗎?

全局滑鼠左鍵點擊
GlobalLeftMouseClick boolean

是否應該使用全局滑鼠左鍵點擊將代理程式置於最前面? 這可確保在作業系統可能限制焦點方法的情況下,將事件帶到前面,從而防止應用程式將自己帶到前面。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

將 IA-Connect 代理程式 GUI 設定為最頂層

將 IA-Connect 代理程式設定為最上層。 這意味著 IA-Connect 代理將始終在屏幕上可見,並且不能隱藏在其他應用程序窗口後面。

參數

名稱 機碼 必要 類型 Description
TopMost boolean

IA-Connect 代理程式應該設定為最頂層 (true) 還是應該停用最頂層 (false)?

Workflow
Workflow True string

在此處新增下列運算式:workflow()

將密碼儲存在代理程式記憶體中

將密碼儲存到代理程式記憶體 (加密) 中,以便從支援儲存密碼的任何動作中使用密碼。 密碼僅儲存在記憶體中,並在代理程式關閉時遺失。

參數

名稱 機碼 必要 類型 Description
識別碼
Identifier True string

密碼的唯一識別碼。 如果標識符已經在使用中,則會覆寫它。 例如:SAPGUILogon。 使用片語 {IAConnectPassword:Identifier} 擷取密碼。

密碼
Password True password

要儲存的密碼。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
指令結果
StorePasswordInAgentMemoryResult boolean

命令的結果(成功或失敗)。

錯誤訊息
ErrorMessage string

如果指令不成功,則會包含傳回的錯誤訊息。

將所有者存檔

在執行 IA-Connect Agent 的電腦上設定檔案的擁有者。

參數

名稱 機碼 必要 類型 Description
檔案路徑
FilePath True string

檔案的完整路徑。 這必須可從執行 IA-Connect Agent 的階段作業存取。

使用者身分識別
UserIdentity True string

要指派所有權的使用者身分識別。 這可以是「使用者名稱」、「網域\使用者名稱」或「username@domainfqdn」的形式。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

將檔案從用戶端複製到伺服器

將檔案從本機電腦 (執行 IA-Connect Director) 複製到遠端電腦 (執行 IA-Connect Agent)。

參數

名稱 機碼 必要 類型 Description
用戶端檔案路徑
ClientFilePath True string

要從中複製檔案的檔案路徑 (在執行 IA-Connect Director 的本機電腦上)。

伺服器檔案路徑
ServerFilePath True string

要將檔案複製到的檔案路徑 (在執行 IA-Connect Agent 的電腦上)。

壓縮
Compress boolean

複製時文件應該壓縮嗎?

Workflow
Workflow True string

在此處新增下列運算式:workflow()

將檔案新增至 ZIP

壓縮檔案 (將檔案儲存到壓縮封存中)。

參數

名稱 機碼 必要 類型 Description
要新增至 ZIP 的來源檔案路徑
SourceFilenameToAddToZIP True string

要新增至 zip 的檔案的檔案路徑。 這必須可從執行 IA-Connect Agent 的階段作業存取。

輸出 ZIP 檔案路徑
OutputZIPFilename True string

ZIP 應輸出到的檔案路徑。 這必須可從執行 IA-Connect Agent 的階段作業存取。

將文件名添加到 ZIP 中的文件夾
AddFilenameToFolderInZIP string

如果要將來源檔案新增至 ZIP 檔案中的資料夾,請在此處輸入資料夾名稱。

要新增至 ZIP 註解的來源檔案名稱
SourceFilenameToAddToZIPComment string

此檔案的選用註解已新增至 ZIP。

壓縮
Compress boolean

壓縮時文件應該壓縮嗎?

新增至現有的 ZIP 檔案
AddToExistingZIPFile boolean

設定為 True 以新增至現有的 ZIP 檔案。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

將檔案複製到剪貼簿

將指定的本機檔案複製到 IA-Connect Agent 使用者工作階段中的剪貼簿。

參數

名稱 機碼 必要 類型 Description
檔案名稱
Filepath True string

要複製到剪貼簿的本機檔案的檔案路徑。

剪下
Cut boolean

如果設定為 true,則檔案將被剪切而不是複製。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
指令結果
CopyFileToClipboardResult boolean

命令的結果(成功或失敗)。

錯誤訊息
ErrorMessage string

如果指令不成功,則會包含傳回的錯誤訊息。

將權限新增至資料夾

將權限新增至執行 IA-Connect Agent 的電腦上的資料夾。

參數

名稱 機碼 必要 類型 Description
資料夾路徑
FolderPath True string

資料夾的完整路徑。 這必須可從執行 IA-Connect Agent 的階段作業存取。

身份
Identity True string

要指派權限的身分 (例如使用者、群組或電腦)。 這可以是「使用者名稱」、「網域\使用者名稱」或「username@domainfqdn」的形式。

權限
Permission True string

提供要指派的權限 (讀取、讀取和執行、修改或完全控制) ,或將預設值保留空白 (讀取)。

套用至資料夾
ApplyToFolder boolean

權限是否應該套用至資料夾本身?

套用至子資料夾
ApplyToSubFolders boolean

權限應該傳播到子資料夾嗎?

套用至檔案
ApplyToFiles boolean

權限是否應該套用至資料夾內的檔案?

Deny
Deny boolean

權限是否被拒絕?

Workflow
Workflow True string

在此處新增下列運算式:workflow()

將流程標記為完成

將流程標示為完成,這會通知 IA-Connect Orchestrator 指派的工作機器現在可用於處理其他流程。

參數

名稱 機碼 必要 類型 Description
Workflow
Workflow True string

在此處新增下列運算式:workflow()

將訊息傳送至 Web API

將訊息傳送至 Web API 並接收回應。 這可以與任何 Web API 搭配使用,但常見的用法是 REST API。 IA-Connect 支援從虛擬機器 (即存取內部部署資源) 或透過 Citrix 或 Microsoft 遠端桌面工作階段 (例如,僅從隔離環境存取 API) 將訊息傳送至 Web API。

參數

名稱 機碼 必要 類型 Description
URL
URL string

要傳送訊息的 API 完整 URL。 例如: https://myapi.remotesystem.com/path/action

方法
Method string

要使用的 HTTP 方法。 這需要符合遠端 API 的預期內容。

逾時 (秒)
TimeoutInSeconds integer

等待回應的秒數。 如果在收到 HTTP 回應之前達到逾時,則會引發例外狀況。

內容類型
ContentType string

訊息本文中傳輸資料的內容類型 (如果有的話)。 這必須符合遠端 API 的預期內容。 如果呼叫預期內文中有 JSON 承載的 REST API,則內容類型可能是 application/json;charset=utf-8 的 charset=utf-8 中。

接受
Accept string

回應資料可接受的格式。 這必須符合遠端 API 的預期內容。 如果呼叫傳回 JSON 承載的 REST API,則接受值可能是 application/json。 若要接受任何回應,請輸入 /

訊息內文
MessageBody string

如果呼叫預期訊息本文中資料的 Web API (與 PUT、POST、PATCH 通用) ,請在此輸入中輸入本文的內容。 如果呼叫 REST API,則可能包含 JSON 資料。 如果呼叫預期 JSON 資料的 REST API,但未傳送任何資料,您可能需要輸入 {} 此輸入。 默認情況下,使用 UTF-8 編碼,但您可以使用“編碼”輸入來更改此編碼。

傳輸編碼
TransmitEncoding string

傳輸訊息本文的編碼 (如果有的話)。 UTF 編碼用於傳輸 Unicode 資料。 BE 是大端。

回應編碼
ResponseEncoding string

回應本文中回應資料的編碼 (如果有的話)。 響應編碼很可能與傳輸編碼匹配。 UTF 編碼用於傳輸 Unicode 資料。 BE 是大端。

緩衝區大小
BufferSize integer

從輸出串流讀取的每一個個別大小。 這不太可能需要修改。 這不會限制回應的大小;它是一個塊大小。

房產
Property string
價值觀
Value string
交涉 TLS 1.0
NegotiateTLS10 boolean

如果使用 HTTPS 和 TLS 1.0 安全性,則設定為 true 應該與遠端系統協商。 您可以協議多個 TLS 安全層次,並且將使用用戶端與遠端系統之間的最高通用協議層次。 警告:TLS 1.0 已被取代,因此除非遠端系統不支援更高層級 (可能較舊且可能未修補),且您瞭解並接受安全性風險,否則不應啟用。

交涉 TLS 1.1
NegotiateTLS11 boolean

如果使用 HTTPS 和 TLS 1.1 安全性,則設為 true,則應與遠端系統協商安全性。 您可以協議多個 TLS 安全層次,並且將使用用戶端與遠端系統之間的最高通用協議層次。 警告:TLS 1.1 已被取代,因此除非遠端系統不支援更高層級 (可能是舊的且可能未修補),而且您瞭解並接受安全性風險,否則您不應啟用。

交涉 TLS 1.2
NegotiateTLS12 boolean

如果使用 HTTPS 和 TLS 1.2 安全性,則設為 true,則應與遠端系統交涉。 您可以協議多個 TLS 安全層次,並且將使用用戶端與遠端系統之間的最高通用協議層次。 TLS 1.2 是建議的最低安全層級。

交涉 TLS 1.3
NegotiateTLS13 boolean

如果使用 HTTPS 和 TLS 1.3 安全性,則設為 true,則應與遠端系統協商安全性。 您可以協議多個 TLS 安全層次,並且將使用用戶端與遠端系統之間的最高通用協議層次。 TLS 1.3 僅支援 Windows 11 和更新版本,以及 Server 2022 和更新版本。

保持活力
KeepAlive boolean

如果應啟用keep-allive,則設定為true。 如果您在短時間內(不到一分鐘)向同一端點提出多個 API 請求,這會重複使用 TCP 連線,從而提高效能。 如果您只打算進行單一 API 呼叫,或 API 呼叫之間的時間超過一分鐘,請設定為 false。 如果配置不正確,危害很小,因為它只會影響性能。

預計 100 人繼續
Expect100Continue boolean

如果您使用 POST 要求、傳送大量資料,並想要在傳送資料之前判斷伺服器是否會接受要求,請設定為 true。 False 在大多數情況下效果最佳,因為它減少了發送到伺服器的資料包數量,從而縮短了回應時間。

傳回回應標頭
ReturnResponseHeaders boolean

如果您希望 IA-Connect 代理程式在回應中傳回從遠端系統接收的 HTTP 標頭,請設為 true。 回應將採用 JSON 格式。 只有在您想要處理資訊的回應標頭(例如傳回的 cookie)時才使用此功能,因為它會增加回應的大小。

以執行緒身分執行
RunAsThread boolean

如果設定為 false,IA-Connect 代理程式會立即執行動作,並在動作完成時傳回結果,但如果花費的時間超過背景工作者/RPA 命令逾時,則會失敗。 如果設為 true,IA-Connect 代理程式會以代理程式執行緒的形式執行此動作,並監視它,直到它完成為止。 這可讓動作執行的時間超過背景工作角色/RPA 命令逾時的時間。

等待執行緒
WaitForThread boolean

只有在「以執行緒身分執行」設定為 true 時才使用。 將此輸入設定為 true 以等候代理程式執行緒完成;代理程式將等待「超時(以秒為單位)」指定的時間。 設定為false可略過等待;代理將繼續在背景執行操作,但也可以進行下一個操作。 然後,您可以使用動作 '等候代理程式執行緒順利完成' 來等候代理程式執行緒完成,然後重新執行此動作,並將輸入 '擷取執行緒 ID 的輸出資料' 設為 代理程式執行緒 ID。

擷取執行緒識別碼的輸出資料
RetrieveOutputDataFromThreadId integer

如果您先前將「等候執行緒」設定為 false (這會導致代理程式在背景執行緒中執行等候),請提供代理程式執行緒識別碼以擷取結果。 此代理程式執行緒識別碼將由先前呼叫此動作提供。 否則,請設定為 0 (預設值)。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
回應狀態碼
ResponseStatusCode integer

HTTP 回應碼。 常見的成功回應是 200 (確定)、201 (建立)、202 (已接受)。 3xx 回應碼是重新導向訊息。 4xx 回應碼是用戶端錯誤訊息 (例如,如果要求發生錯誤)。 5xx 回應碼是伺服器錯誤訊息。 4xx 和 5xx 回應碼通常不會出現在此輸出中,因為會改為引發異常狀況。

回應訊息
ResponseMessage string

來自 HTTP 回應本文的回應訊息內容。

回應內容類型
ResponseContentType string

回應本文的內容類型,如果有回應本文,以及是否提供了類型。

回應標頭 JSON
ResponseHeadersJSON string

如果輸入「傳回回應標頭」設定為true,則此輸出將包含JSON格式的HTTP回應標頭。 只有在您想要處理資訊的回應標頭(例如傳回的 cookie)時才使用此功能,因為它會增加回應的大小。

執行緒識別碼
ThreadId integer

如果您已將「等候執行緒」設定為 false (這會導致代理程式在背景執行緒中執行等候),則此輸出會保留代理程式執行緒識別碼,可用來監視動作的處理程序,並在稍後執行緒完成時擷取結果。

將資料夾新增至 ZIP

將資料夾中的檔案壓縮成 ZIP 檔案 (將檔案儲存到壓縮封存中)。

參數

名稱 機碼 必要 類型 Description
要新增至 ZIP 的來源資料夾
SourceFolderToAddToZIP True string

要新增至 zip 的資料夾路徑。 這必須可從執行 IA-Connect Agent 的階段作業存取。

輸出 ZIP 檔案路徑
OutputZIPFilename True string

ZIP 應輸出到的檔案路徑。 這必須可從執行 IA-Connect Agent 的階段作業存取。

將檔案新增至 ZIP 中的資料夾
AddFilesToFolderInZIP string

如果要將來源檔案新增至 ZIP 檔案中的資料夾,請在此處輸入資料夾名稱。

壓縮
Compress boolean

壓縮時應該壓縮文件夾嗎?

新增至現有的 ZIP 檔案
AddToExistingZIPFile boolean

設定為 True 以新增至現有的 ZIP 檔案。

包含子資料夾
IncludeSubfolders boolean

來源資料夾內的子資料夾也應該新增至 ZIP 嗎?

包含檔案正規表示式
IncludeFilesRegEx string

選擇性的正規表示式,可讓您指定應擷取哪些檔案。 僅匹配文件名。

排除檔案正規表示式
ExcludeFilesRegEx string

選擇性正規表示式,可讓您指定應從擷取中排除哪些檔案。 僅匹配文件名。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
成功新增的檔案數目
FilesAddedSuccessfully integer

成功新增至 ZIP 的檔案數目。

排除的檔案數目
FilesExcluded integer

已排除的檔案數目 (如果使用「排除檔案正規表示式」輸入)。

將附註新增至 Orchestrator 自動化工作

將附註新增至選取的 Orchestrator 自動化工作。 此附註將傳遞至與此自動化工作連結的來源系統 (例如 ServiceNow),最常用於將詳細資料新增至票證。 如果 Orchestrator 自動化工作未連結至來源,則會引發例外狀況。

參數

名稱 機碼 必要 類型 Description
任務標識符
TaskId True integer

要新增附註的 Orchestrator 工作識別碼。

附註文字
NoteText True string

筆記短信。

筆記類型
NoteType string

如果來源系統支援不同的註記類型 (例如,工作註記、結尾註記或註解),請在此處輸入註記類型。 這將根據來源系統的不同而有不同的解釋。 目前支援的類型有 'WorkNote' (預設值)、'CloseNote'、'Comment'。 如果只有一種類型的筆記,請輸入“WorkNote”。 如果您有自訂工作筆記,請輸入「其他」。

附註類型其他
NoteTypeOther string

如果您有自訂筆記類型,請選擇「筆記類型」為「其他」,然後在此欄位中輸入自訂類型。

傳回

名稱 路徑 類型 Description
指令結果
TasksAddNoteResult boolean

命令的結果(成功或失敗)。

錯誤訊息
ErrorMessage string

如果指令不成功,則會包含傳回的錯誤訊息。

展開密碼字串

接受輸入字串,其中包含對 IA-Connect 儲存密碼的參考,並傳回該字串,並將參考取代為儲存的密碼。

參數

名稱 機碼 必要 類型 Description
輸入字串
InputString string

包含 IA-Connect 儲存密碼識別碼的輸入字串。 例如:「歡迎新入職者,您的新帳戶密碼是 {IAConnectPassword:GeneratedPassword}」,其中「GeneratedPassword」是儲存的 IA-Connect 密碼的名稱。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
輸出字串
OutputString string

輸出字串,其中包含輸入字串,其密碼識別碼已取代為實際密碼。 例如:“歡迎新入行者,您的新帳戶密碼是 Fantastic12Monkeys!

展開環境變數

展開包含環境變數 (例如 %USERPROFILE% 或 %TEMP%) 的字串,以在 IA-Connect Agent 使用者工作階段中展開。

參數

名稱 機碼 必要 類型 Description
輸入字串
InputString True string

包含環境變數的輸入字串。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
輸出字串
OutputString string

具有任何環境變數的字串已展開。

左鍵按住滑鼠

在 IA-Connect 客服專員使用者工作階段中按住滑鼠左鍵指定的秒數。

參數

名稱 機碼 必要 類型 Description
秒數保持
SecondsToHold True double

按住滑鼠左鍵的秒數。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

延遲現有的 Orchestrator 自動化工作

延遲已在佇列中的現有 Orchestrator 工作。 該任務將推遲到未來的指定時間。 這通常用於重新延遲現有任務(即任務之前被推遲,現在需要再次推遲)。 使用此動作可暫時暫停任務指定的時間量 (例如,如果您正在等待某項內容)。

參數

名稱 機碼 必要 類型 Description
任務標識符
TaskId True integer

要延遲 (或再次延遲) 的現有 Orchestrator 自動化工作的識別碼。

延遲時間 (以分鐘為單位)
DeferralTimeInMinutes integer

自動化任務應該延遲多少分鐘。

延遲儲存的資料
DeferralStoredData string

要與此工作一起儲存的選用資料。 當程序/流程從延遲繼續時,它將可供使用。 這通常用於儲存您在流程/流程期間計算的資料,這些資料需要在延遲後再次可用。 您可以自由地以任何格式儲存數據,但 JSON 是一種常用的格式。

工藝階段
ProcessStage string

延遲後自動化流程/流程應繼續的點。 這是一個可選的字串值,對於特定流程/流程來說是唯一的。 延遲程序/流程中的條件將使用它來決定下一步要執行的步驟。 例如:如果您希望流程/流程在延遲後繼續時在「交換」階段繼續,請輸入值「交換」。

Priority
Priority integer

設定此工作的優先順序層級 (1 為最高層級)。

將工作擱置
TaskOnHold boolean

如果您將此值設定為 true,則任務將處於保留狀態,因此即使達到延遲日期,也不會在一般任務工作流程中處理。 您可以稍後使用「變更 Orchestrator 自動化工作狀態」動作來變更「保留」狀態。

傳回

名稱 路徑 類型 Description
指令結果
TasksDeferExistingTaskResult boolean

命令的結果(成功或失敗)。

錯誤訊息
ErrorMessage string

如果指令不成功,則會包含傳回的錯誤訊息。

延遲現有的 Orchestrator 自動化工作作業

延遲已在佇列中的現有 Orchestrator 工作。 該任務將推遲到未來的指定時間。 這通常用於重新延遲現有任務(即任務之前被推遲,現在需要再次推遲)。 使用此動作可暫時暫停任務指定的時間量 (例如,如果您正在等待某項內容)。

參數

名稱 機碼 必要 類型 Description
作業識別碼
OperationId True string

要延遲 (或再次延遲) 的 Orchestrator 工作的作業識別碼。

延遲時間 (以分鐘為單位)
DeferralTimeInMinutes integer

自動化任務應該延遲多少分鐘。

延遲儲存的資料
DeferralStoredData string

要與此工作一起儲存的選用資料。 當程序/流程從延遲繼續時,它將可供使用。 這通常用於儲存您在流程/流程期間計算的資料,這些資料需要在延遲後再次可用。 您可以自由地以任何格式儲存數據,但 JSON 是一種常用的格式。

工藝階段
ProcessStage string

延遲後自動化流程/流程應繼續的點。 這是一個可選的字串值,對於特定流程/流程來說是唯一的。 延遲程序/流程中的條件將使用它來決定下一步要執行的步驟。 例如:如果您希望流程/流程在延遲後繼續時在「交換」階段繼續,請輸入值「交換」。

Priority
Priority integer

設定此工作的優先順序層級 (1 為最高層級)。

傳回

名稱 路徑 類型 Description
指令結果
TasksDeferExistingTaskOperationResult boolean

命令的結果(成功或失敗)。

錯誤訊息
ErrorMessage string

如果指令不成功,則會包含傳回的錯誤訊息。

建立 Orchestrator 一次性密碼

一次性密碼提供儲存密碼的功能,該密碼可透過不可猜測的唯一 URL 擷取一次。 這通常用於與第三方共享秘密。 您可以使用 Orchestrator UI、REST API 或從流程建立一次性密碼。

參數

名稱 機碼 必要 類型 Description
友善名稱
FriendlyName True string

這是一個描述性名稱,純粹用於識別此一次性秘密。 此名稱的唯一用途是在 Orchestrator UI 的密碼清單中檢視。

密碼值
SecretValue password

您希望透過一次性 URL 共用和提供的一次性秘密值。

檢索短語 1
RetrievalPhrase1 password

這是透過唯一URL擷取一次性密碼所需的片語。 如果留空,則不需要檢索短語。 擷取階段區分大小寫。

檢索短語 2
RetrievalPhrase2 password

這是透過唯一URL擷取一次性密碼所需的第二個片語。 如果留空,則不需要檢索短語。 擷取階段區分大小寫。

刪除前的擷取次數上限
MaximumRetrievalsBeforeDeletion integer

在從 Orchestrator 中刪除此一次性密碼之前,可以擷取多少次? 依預設,此值會設定為 1 (一次性)。 只有在多人需要存取此密碼時,才設定為較高的值。

秘密有開始日期
SecretHasAStartDate boolean

如果密碼在特定日期和時間之前無法擷取,請啟用。

秘密開始日期和時間
SecretStartDateTime date-time

此密碼可供擷取的日期和時間。 日期和時間以 dd/MM/yyyy HH:mm 格式輸入,並以 UTC/GMT+0 儲存和處理。 例如:「2022-01-24T07:00:00」將阻止在 2022 年 1 月 24 日 07:00 UTC (GMT+0) 之前擷取一次性密碼 (您將收到 404)。 或者,使用「秘密開始時間前的小時數」輸入。 使用此輸入時,您必須將「秘密有開始日期」設定為 true,否則將忽略輸入。

距離秘密開始時間的小時數
HoursUntilSecretStartTime integer

此密碼可供檢索的小時數。 或者,使用「秘密開始日期和時間」輸入。 使用此輸入時,您必須將「秘密有開始日期」設定為 true。

秘密有到期日
SecretHasAnExpiryDate boolean

如果密碼應在一段時間後自動刪除,則啟用,無論密碼是否已擷取。

秘密到期日期和時間
SecretExpiryDateTime date-time

自動刪除此密碼的日期和時間,無論是否已擷取。 日期和時間以 yyyy-MM-ddTHH:mm:ss 格式輸入,並以 UTC / GMT+0 儲存和處理。 例如:「2022-01-24T07:00:00」會在 2022 年 1 月 24 日 07:00 UTC (GMT+0) 刪除一次性密碼。 或者,使用「秘密到期前的小時數」輸入。 使用此輸入時,您必須將「秘密有到期日」設定為 true,否則將忽略輸入。

秘密到期前的小時數
HoursUntilSecretExpiry integer

此密碼之前的小時數將自動刪除,無論它是否已被擷取。 或者,使用「秘密到期日期和時間」輸入。 使用此輸入時,您必須將「秘密有到期日」設定為 true。

傳回

名稱 路徑 類型 Description
擷取網址
RetrievalURL string

一次性 URL,用來擷取一次性密碼。

擷取識別碼
RetrievalId string

唯一的擷取 ID。此一次性 URL 是從此唯一 ID 建置。如果您需要在自訂案例中建構自己的URL,此標識碼可能很有用。

建立目錄

在執行 IA-Connect Agent 的電腦上建立目錄 (資料夾)。

參數

名稱 機碼 必要 類型 Description
目錄路徑
DirectoryPath True string

目錄 (資料夾) 的完整路徑。 這必須可從執行 IA-Connect Agent 的階段作業存取。

如果已存在,則為錯誤
ErrorIfAlreadyExists boolean

如果目錄(文件夾)已經存在 IA-Connect 是否應該引發錯誤?

Workflow
Workflow True string

在此處新增下列運算式:workflow()

建立遠端桌面工作階段 (RDS) 啟動檔案

建立遠端桌面工作階段 (RDS) 啟動檔案,可用來使用指定的參數自動啟動遠端桌面工作階段,而不需要自動化遠端桌面用戶端 UI。 RDS 啟動檔案的副檔名為「.rdp」,通常稱為 RDP 檔案。

參數

名稱 機碼 必要 類型 Description
遠端位址
RemoteAddress True string

要連接的遠端系統位址。 這可以是 IP 位址、主機名稱或完整網域名稱 (FQDN)。

輸出資料夾路徑
OutputFolderPath True string

儲存 RDP 檔案的資料夾。

RDP 檔案名稱
RDPFileName True string

將在輸出資料夾路徑中建立的 RDP 檔案名稱。

如果已存在,則覆寫 RDP 檔案
OverwriteRDPFileIfAlreadyExists boolean

設定為 true 可自動覆寫任何具有相同資料夾/檔案名稱的 RDP 檔案。 如果已存在具有相同資料夾/檔案名稱的現有 RDP 檔案,則不應建立新的 RDP 檔案,請設定為 false。

信任遠端電腦
TrustRemoteComputer boolean

設定為 true 可將遠端位址標記為受信任 (在 Windows 登錄中),主要用於裝置重新導向目的,消除啟動 RDP 檔案時可能收到的快顯視窗。

存放憑證
StoreCredentials boolean

設定為 true 以建立使用者認證來保存遠端桌面驗證詳細資料。 這可以讓您連接到遠端桌面系統,而無需提示進行身份驗證。

UserName
UserName string

如果儲存認證以保存遠端桌面驗證詳細資料,這可讓您指定要儲存在認證中的使用者名稱。

密碼
Password string

如果儲存認證以保存遠端桌面驗證詳細資訊,這允許您指定要儲存在認證中的密碼。

認證類型
CredentialType string

如果儲存認證以保存遠端桌面驗證詳細資料,則可讓您指定認證類型:Windows 或一般。 若要儲存 RDP 認證,您通常會建立 Windows 認證。

認證持續性
CredentialPersistence string

如果儲存認證以保存遠端桌面驗證詳細資料,這可讓您指定認證持續性:工作階段 (僅針對此登入工作階段持續)、LocalMachine (跨工作階段為此使用者保留,並僅在此電腦上重新啟動) 或企業 (可以在電腦之間漫遊)。 建立 RDP 檔案時的預設值為「工作階段」。

重新導向印表機
RedirectPrinters boolean

本機工作階段中的印表機是否應該對應至遠端桌面工作階段? 此設定可能會在遠端強制執行,因此不會生效。

重新導向所有磁碟機
RedirectAllDrives boolean

本機工作階段中的所有磁碟機代號 (例如 C:) 是否應該對應至遠端桌面工作階段? 此設定可能會在遠端強制執行,因此不會生效。

重新導向剪貼簿
RedirectClipboard boolean

剪貼簿是否應該在本機和遠端系統之間共用,允許在兩個系統之間複製和貼上? 此設定可能會在遠端強制執行,因此不會生效。

全螢幕
Fullscreen boolean

遠端桌面工作階段是否應該是全螢幕。

桌面寬度
DesktopWidth integer

如果遠端桌面工作階段不是全螢幕,則遠端桌面工作階段的寬度 (以像素為單位)。

桌面高度
DesktopHeight integer

如果遠端桌面工作階段不是全螢幕,則遠端桌面工作階段的高度 (以像素為單位)。

使用多顯示器
UseMultiMonitor boolean

如果全螢幕遠端桌面平台工作階段應該只使用單一監視器,請設定為 false。 如果全螢幕遠端桌面平台工作階段應該使用所有監視器,請設定為 true。 對單一監視器系統(以及大多數虛擬機器)沒有影響。

工作階段顏色深度
SessionBPP integer

遠端桌面工作階段的色彩深度,以每像素位元 (BPP) 為單位)。 數字越高,顏色越多。 支援的值為 15、16、24、32。

智慧尺寸
SmartSizing boolean

設定為 true,讓本機電腦自動調整遠端會話的內容,以符合視窗大小。 設定為 false 以不自動縮放。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
RDP 檔案路徑
RDPFilePath string

產生的 RDP 檔案的完整路徑。

引發例外狀況

如果輸入異常狀況不是空白,請使用指定的訊息引發異常狀況。 這對於觸發流程中的例外狀況訊息 (HTTP 400) 很有用,如果先前的動作發生錯誤,則錯誤處理階段會攔截該訊息。 此例外狀況不會記錄在 IA-Connect Orchestrator 流程執行統計資料中。

參數

名稱 機碼 必要 類型 Description
輸入例外狀況
InputException string

如果此輸入異常狀況不是空字串,則會引發異常狀況,並提供「異常狀況訊息」。 如果此輸入例外狀況為空白,則此動作將不執行任何動作。

異常訊息
ExceptionMessage string

要引發的例外狀況訊息。

傳回

名稱 路徑 類型 Description
指令結果
RaiseExceptionResult boolean

命令的結果(成功或失敗)。

錯誤訊息
ErrorMessage string

如果指令不成功,則會包含傳回的錯誤訊息。

從 Orchestrator 取得一般認證

擷取已儲存在 IA-Connect Orchestrator 中的一般認證。 認證可以保存使用者名稱、密碼、主機名稱、URL 和其他一般資料。

參數

名稱 機碼 必要 類型 Description
友善名稱
FriendlyName string

儲存在 Orchestrator 中的認證易記名稱。

擷取純文字密碼
RetrievePlainTextPassword boolean

如果勾選,則如果已停用 Orchestrator 一般認證設定 [不公開密碼』 (允許擷取密碼),則指定 Orchestrator 一般認證的密碼將以純文字形式傳回。 建議不要以純文字形式擷取密碼,而是使用支援已儲存密碼的 IA-Connect 動作 (例如:「將密碼輸入 UIA 動作」),其中 Orchestrator 會在執行階段將密碼直接插入動作中。

傳回

名稱 路徑 類型 Description
用戶名稱
Username string

一般認證中保留的使用者名稱。

純文字密碼
PlainTextPassword string

以純文字字串形式保存在一般認證中的密碼。 Orchestrator 密碼會以加密方式儲存,但會以純文字形式傳回,以允許您將其傳遞給需要密碼的動作。

主機名稱
Hostname string

一般認證中保留的主機名稱或網域名稱 (如果使用)。

URL
Url string

一般認證中保留的 URL(如果使用)。

泛型屬性 1
GenericProperty1 string

如果使用,則保留在一般認證中的一般屬性。 這可用來儲存可能與認證相關聯的資料。

泛型屬性 2
GenericProperty2 string

如果使用,則保留在一般認證中的一般屬性。 這可用來儲存可能與認證相關聯的資料。

泛型屬性 3
GenericProperty3 string

如果使用,則保留在一般認證中的一般屬性。 這可用來儲存可能與認證相關聯的資料。

從 Orchestrator 取得流量統計資料

從 IA-Connect Orchestrator 傳回流量統計資料清單。 用於報告目的。 您可以選擇性地使用一或多個篩選器來限制傳回的結果。

參數

名稱 機碼 必要 類型 Description
最近天數內
WithinLastNumberOfDays integer

篩選結果,以僅擷取在最後指定天數內開始的結果。 設定為 0 以不篩選。

流程名稱
SearchFlowName string

篩選結果,以僅擷取具有指定流程名稱的結果。 設定為空白,不依流程名稱篩選。

流程上次動作結果
SearchFlowLastActionResult boolean

篩選結果,以僅擷取具有指定最後一個動作結果的結果。 設定為 true 可僅擷取成功的流程。 設定為 false 以僅擷取失敗的流程。 請勿將值/設定為空白,以免依流程上次動作結果進行篩選。

流程開始時間開始時段
SearchFlowStartTimeStartWindow date-time

篩選結果,以僅擷取在指定開始時間之後開始的結果。 設定為空白以不篩選。 例如:「2022-01-24T07:00:00」會傳回 2022 年 1 月 24 日 07:00 小時或之後啟動之流量的所有 Orchestrator 流量統計資料。 所有日期時間均以 UTC (GMT+0) 為單位,因此您可能想要使用 [轉換日期時間] 動作將當地時間轉換為 UTC。

流程開始時間結束時段
SearchFlowStartTimeEndWindow date-time

篩選結果,以僅擷取在指定開始時間之前開始的結果。 設定為空白以不篩選。 例如:「2022-01-25T07:00:00」會傳回 2022 年 1 月 25 日 07:00 或之前啟動之流量的所有 Orchestrator 流量統計資料。 所有日期時間均以 UTC (GMT+0) 為單位,因此您可能想要使用 [轉換日期時間] 動作將當地時間轉換為 UTC。

傳回

名稱 路徑 類型 Description
Orchestrator 流程統計資料 JSON
OrchestratorFlowStatsJSON string

所有 Orchestrator 流程統計資料的清單,採用 JSON 格式。

流量統計資料數量
NumberOfOrchestratorFlowStats integer

傳回的 Flow 統計資料數目。

從 Orchestrator 取得登入記錄

傳回 IA-Connect Orchestrator 登入記錄以供報告之用。 您可以選擇性地使用一或多個篩選器來限制傳回的結果。

參數

名稱 機碼 必要 類型 Description
最近天數內
WithinLastNumberOfDays integer

篩選結果,以僅擷取指定天數內的 Orchestrator 登入。 設定為 0 以不篩選。

電子郵件地址
SearchByEmail string

篩選結果,以僅擷取具有指定電子郵件地址的 Orchestrator 登入。 設定為空白,不依電子郵件地址篩選。

登入歷史記錄時間開始視窗
SearchLoginHistoryTimeStartWindow date-time

篩選結果,以僅擷取指定開始時間之後的 Orchestrator 登入。 設定為空白以不篩選。 例如:「2022-01-24T07:00:00」會傳回 2022 年 1 月 24 日 07:00 小時或之後的所有 Orchestrator 登入。 所有日期時間均以 UTC (GMT+0) 為單位,因此您可能想要使用 [轉換日期時間] 動作將當地時間轉換為 UTC。

登入歷史記錄時間結束窗口
SearchLoginHistoryTimeEndWindow date-time

篩選結果,以僅擷取指定開始時間之前的 Orchestrator 登入。 設定為空白以不篩選。 例如:「2022-01-25T07:00:00」會傳回 2022 年 1 月 25 日 07:00 或之前的所有 Orchestrator 登入。 所有日期時間均以 UTC (GMT+0) 為單位,因此您可能想要使用 [轉換日期時間] 動作將當地時間轉換為 UTC。

傳回

名稱 路徑 類型 Description
Orchestrator 登入記錄 JSON
OrchestratorLoginHistoryJSON string

符合指定篩選條件的所有 Orchestrator 登入清單 (JSON 格式)。

Orchestrator 登入次數
NumberOfOrchestratorLogins integer

傳回的 Orchestrator 登入數目。

從 Orchestrator 取得背景工作流程使用量熱圖

從 IA-Connect Orchestrator 傳回工作流程使用量每日熱圖。 用於報告目的。 您可以選擇性地使用一或多個篩選器來限制傳回的結果。

參數

名稱 機碼 必要 類型 Description
流程開始時間開始時段
SearchStartDateStartWindow True date-time

篩選結果,以僅擷取指定開始日期之後的背景工作流程使用量熱圖 (會忽略時間元件)。 設定為空白以不篩選。 例如:「2022-01-24T00:00:00」會傳回 2022 年 1 月 24 日或之後啟動的流程的背景工作者熱圖。 所有日期時間均以 UTC (GMT+0) 為單位,因此您可能想要使用 [轉換日期時間] 動作將當地時間轉換為 UTC。

流程開始時間結束時段
SearchStartDateEndWindow True date-time

篩選結果,以僅擷取指定開始日期之前的工作流程使用情形熱圖 (忽略時間元件)。 設定為空白以不篩選。 例如:「2022-01-25T00:00:00」會傳回 2022 年 1 月 25 日或之前啟動的 Flow 背景工作者熱圖。 所有日期時間均以 UTC (GMT+0) 為單位,因此您可能想要使用 [轉換日期時間] 動作將當地時間轉換為 UTC。

時區分鐘偏移 UTC
TimeZoneMinutesOffsetFromUTC integer

與 UTC 的時區偏移 (以分鐘為單位),以對齊每日熱圖。 例如:如果您指定 60 分鐘,則每日熱圖會從 01:00 UTC 執行至 01:00 UTC。

IA-Connect 工作人員名稱
WorkerNames string

要傳回熱圖的 IA-Connect 工作者名稱清單,採用 JSON 或 CSV 格式。 如果保留空白,則會針對 Orchestrator 目前已知的所有背景工作者產生熱圖。 例如:[{“WorkerName”: “Worker1”}、{“WorkerName”: “Worker2”}] (JSON 資料表格式)、 [“Worker1”、“Worker2”] (JSON 陣列格式) 或 Worker1,Worker2 (CSV 格式)。

傳回

名稱 路徑 類型 Description
背景工作流程使用量熱圖JSON
WorkerFlowUsageHeatmapJSON string

工作流程使用量熱圖,採用 JSON 格式。

工作流程使用情形熱圖項目數目
NumberOfWorkerFlowUsageHeatmapItems integer

傳回的工作流程使用情熱圖項目數目。 每位工人每天一件物品。

從 Orchestrator 取得背景工作者可用性統計資料

從 IA-Connect Orchestrator 傳回背景工作者可用性統計資料。 用於報告目的。 您可以選擇性地使用一或多個篩選器來限制傳回的結果。

參數

名稱 機碼 必要 類型 Description
最近天數內
WithinLastNumberOfDays integer

篩選結果,以僅擷取在最後指定天數內開始的結果。 設定為 0 以不篩選。

流程名稱
SearchFlowName string

篩選結果,以僅擷取具有指定流程名稱的結果。 設定為空白,不依流程名稱篩選。

流程開始時間開始時段
SearchFlowStartTimeStartWindow date-time

篩選結果,以僅擷取在指定開始時間之後開始的結果。 設定為空白以不篩選。 例如:「2022-01-24T07:00:00」會傳回 2022 年 1 月 24 日 07:00 小時或之後啟動之流量的所有 Orchestrator 流量統計資料。 所有日期時間均以 UTC (GMT+0) 為單位,因此您可能想要使用 [轉換日期時間] 動作將當地時間轉換為 UTC。

傳回

名稱 路徑 類型 Description
背景工作者可用性統計資料 JSON
WorkerAvailabilityStatsJSON string

背景工作者可用性統計資料清單,採用 JSON 格式。

工作者可用性統計資料數目
NumberOfWorkerAvailabilityStats integer

傳回的工作人員可用性統計資料數目。

從 Orchestrator 流程統計資料取得上次失敗的動作

擷取透過 IA-Connect Orchestrator 傳遞至背景工作角色的最後一個動作的詳細資料 (如果該動作失敗)。 此動作最常在錯誤處理期間使用。

參數

名稱 機碼 必要 類型 Description
Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
指派給流程執行的背景工作者
WorkerAllocatedToFlowRun boolean

如果有指派給此流程執行的背景工作角色,則傳回 true,因此可以提供上次動作錯誤的相關資訊。 如果沒有指派給此流程執行的背景工作角色 (從未配置背景工作角色,或背景工作角色現在可供另一個流程執行使用),則傳回 false,因此無法提供上次錯誤的相關資訊。

最後一個動作失敗
LastActionFailed boolean

如果此流程執行中的最後一個動作 (在配置給此流程執行的背景工作角色上執行) 失敗,則傳回 true:此動作的其他輸出將保留詳細資料。 如果此流程執行中的最後一個動作未失敗,則傳回 false:其他輸出將為空白。

上次失敗的動作要求路徑
LastFailedActionRequestPath string

如果此流程執行中的最後一個動作 (在配置給此流程執行的背景工作者上執行) 失敗,則此輸出將包含動作要求路徑。 這可用來判斷哪個動作失敗。 如果此流程執行中的最後一個動作未失敗,則此值將為空白。

上次失敗的動作錯誤訊息
LastFailedActionErrorMessage string

如果此流程執行中的最後一個動作 (在配置給此流程執行的工作角色上執行) 失敗,則此輸出將包含錯誤訊息。 如果此流程執行中的最後一個動作未失敗,則此值將為空白。

從 Orchestrator 配置背景工作角色

從 IA-Connect Orchestrator 配置背景工作者。 您可以依標籤或工作者名稱 (或兩者都不,或兩者) 請求工作者,讓您更精確地選擇所需的工作者。 配置工作者後,它會指派給您的流程,並報告為執行工作。 請注意,執行配置時,Orchestrator 仍會考慮「支援的流量環境識別碼」、「支援的流量名稱」和「不支援的流量名稱」。 當多個背景工作者符合搜尋時,將套用一般負載平衡規則。

參數

名稱 機碼 必要 類型 Description
Worker 標籤
WorkerTag string

要配置之工作者的選擇性標籤。 標籤可讓您將工作者分類為群組。 標籤名稱不區分大小寫。 您可以在不同的行中輸入多個標籤來指定多個標籤,然後分配機制將考慮具有任何這些標籤的任何背景工作者(只需要一個標籤匹配)。 您可以使用萬用字元:標籤*格式(例如萬用字元:JML*)執行萬用字元搜索,並使用格式RegEx:TagExpression(例如正則表達式:^JML)執行正則表達式搜尋。

工作人員名稱
WorkerName string

要配置之工作者的選擇性名稱。 工作人員名稱不區分大小寫。 您可以在不同的行中輸入多個工作者,然後分配機制將考慮具有匹配名稱的任何工作者。 您可以使用格式 Wildcard: Name* (例如 Wildcard: vmrpa*) 執行萬用字元搜尋,並使用 RegEx: Expression 格式 (例如 RegEx: ^vmrpa) 執行正則運算式搜尋。

如果背景工作者無法立即使用,則引發例外狀況
RaiseExceptionIfWorkerNotImmediatelyAvailable boolean

如果設定為 true 且無法配置適當的 Worker,則會引發例外狀況。 如果設定為 false (預設值) 且無法配置合適的背景工作角色,則 Orchestrator 將傳回 HTTP 狀態碼 500,導致 PA 流程根據「重試原則」等待。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
已配置的工作人員名稱
WorkerNameAllocated string

已配置之工作者的名稱。 如果未配置工作人員,則為空白。

從使用者認證讀取

在 IA-Connect 代理程式工作階段中,從使用者設定檔中的認證讀取使用者名稱和密碼。 您可以從 Windows 控制台檢視認證。 使用者名稱和密碼都可以從一般認證中擷取,而只能從 Windows 認證中擷取使用者名稱。

參數

名稱 機碼 必要 類型 Description
認證位址
CredentialAddress True string

認證的名稱/位址。

認證類型
CredentialType True string

認證類型:Windows 或一般。

對稱加密金鑰
SymmetricKey string

用於解密認證密碼的選用對稱加密金鑰 (如果認證已使用金鑰加密,則使用)。 只能與一般認證搭配使用,因為無法擷取 Windows 認證的密碼。

將密碼儲存為識別碼
StorePasswordAsIdentifier string

如果提供識別碼,則檢索到的憑據密碼將加密存儲在代理程序中,以便以後由任何可以使用存儲憑據的命令檢索/使用。 這些密碼僅儲存在記憶體中,並在代理關閉時遺失。 只能與一般認證搭配使用,因為無法擷取 Windows 認證的密碼。 例如:MyExchangePassword。

不要傳回密碼
DontReturnPassword boolean

如果設定為 true,則不會傳回認證密碼。 如果您要將密碼儲存在代理程式中以供進一步命令使用 (即「將密碼儲存為識別碼」為 true),但實際上不需要知道工作流程中的密碼,這非常有用。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
使用者名
UserName string

認證用戶名稱。

密碼
Password string

認證密碼。

從文件中讀取所有文本

讀取執行 IA-Connect Agent 的電腦上檔案的文字內容。

參數

名稱 機碼 必要 類型 Description
檔案路徑
Filename True string

檔案的完整路徑。 這必須可從執行 IA-Connect Agent 的階段作業存取。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
檔案文字內容
FileTextContents string

檔案的文字內容。

從檔案安全性中移除身分識別

從執行 IA-Connect Agent 之電腦上檔案的安全性權限中移除身分識別 (例如使用者、群組或電腦)。

參數

名稱 機碼 必要 類型 Description
檔案路徑
FilePath True string

檔案的完整路徑。 這必須可從執行 IA-Connect Agent 的階段作業存取。

要移除的身分識別
IdentityToRemove True string

要移除的使用者或群組身分識別。 這可以是「使用者名稱」、「網域\使用者名稱」或「username@domainfqdn」的形式。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
權限已移除
PermissionWasRemoved boolean

如果成功移除權限,則傳回 true。

從流程結果 JSON 取得失敗動作錯誤訊息

還原序列化一或多個流程 result() 運算式的 JSON 輸出,並從失敗的動作擷取第一個找到的錯誤訊息。 錯誤訊息可以以多種格式儲存在 JSON 中。 此動作會處理已知格式,並傳回第一個找到的錯誤訊息。

參數

名稱 機碼 必要 類型 Description
流程結果 JSON
PowerAutomateResultJSON True array of string

JSON 陣列,應包含一或多個流程 result() 運算式的輸出。 如果您只處理單一流程 result() 運算式的輸出,只需將其輸入到第一個陣列項目中即可。

搜尋狀態
SearchStatus string

包含錯誤訊息之動作的狀態。 只有在您搜尋的狀態與預設值「失敗」不同的狀態時,才應變更此設定。

傳回

名稱 路徑 類型 Description
動作錯誤訊息
ActionErrorMessage string

傳回從結果 JSON 擷取的動作錯誤訊息。 如果找不到錯誤訊息,則會傳回空白值。

動作名稱
ActionName string

傳回與錯誤訊息相關聯的動作名稱。

動作代碼
ActionCode string

傳回與錯誤訊息相關聯之動作的結果代碼。

從資料夾安全性中移除身分識別

從執行 IA-Connect Agent 之電腦上資料夾的安全性權限中移除身分識別 (例如使用者、群組或電腦)。

參數

名稱 機碼 必要 類型 Description
資料夾路徑
FolderPath True string

資料夾的完整路徑。 這必須可從執行 IA-Connect Agent 的階段作業存取。

要移除的身分識別
IdentityToRemove True string

要移除的使用者或群組身分識別。 這可以是「使用者名稱」、「網域\使用者名稱」或「username@domainfqdn」的形式。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
權限已移除
PermissionWasRemoved boolean

如果成功移除權限,則傳回 true。

截圖

擷取 IA-Connect 代理程式使用者工作階段的螢幕擷取畫面,並將其傳回為 Base64 編碼字串。

參數

名稱 機碼 必要 類型 Description
全螢幕
Fullscreen boolean

螢幕截圖應該包括整個螢幕嗎?

左 X 像素
LeftXPixels integer

如果未擷取整個螢幕的螢幕擷取畫面,則螢幕擷取畫面應該從開始位置的 X 值 (以像素為單位)。 在單一顯示器上,最左邊的 X 像素為 0。 在多顯示器顯示器上,最左邊的 X 圖元可能是負值 (視標示為主要顯示器的顯示器,以及相對於其他顯示器的位置而定)。

前 Y 像素
TopYPixels integer

如果未截取整個螢幕的螢幕截圖,則螢幕截圖應從該位置開始的 Y 值(以像素為單位)。 在單一顯示器上,最頂端的 Y 圖元為 0。 在多顯示器顯示器上,最頂端的 Y 圖元可能是負數 (取決於標示為主要顯示器的顯示器,以及它相對於其他顯示器的位置)。

寬度像素
WidthPixels integer

如果不截取整個螢幕的螢幕截圖,則螢幕截圖從起始位置開始的寬度。

高度像素
HeightPixels integer

如果不是截取整個螢幕的螢幕截圖,則是螢幕截圖從起始位置開始的高度。

圖像格式
ImageFormat string

提供圖像格式(PNG、JPG、BMP 或 GIF)。

使用顯示設備
UseDisplayDevice boolean

IA-Connect 代理程式是否應該考慮顯示裝置資訊? 這將更好地與 DPI 縮放配合使用,並將提供對多個顯示器的支持。

發生錯誤時引發例外狀況
RaiseExceptionOnError boolean

如果設定 true:如果螢幕擷取畫面失敗 (例如,如果工作階段已鎖定) ,IA-Connect Agent 會引發例外狀況。 如果設定 false:如果螢幕擷取畫面失敗,IA-Connect 會傳回空白點陣圖,並填入「螢幕擷取畫面成功」和「螢幕擷取畫面錯誤訊息」輸出。

隱藏代理程式
HideAgent boolean

設定為 true 可自動隱藏代理程式 (如果可見),以確保它不會遮擋螢幕擷取畫面。

使用實體座標
UsePhysicalCoordinates boolean

設定為 true 以指定提供的座標是實體座標 (未調整 DPI,因此符合顯示器上的實體圖元) 。 設定為 false (預設值) ,以指定提供的座標是虛擬的 (DPI 縮放) 。 UIA、Java 和 Web 動作通常使用虛擬座標。

顯示裝置識別碼
DisplayDeviceId integer

只有在輸入「使用顯示裝置」設定為 true 時,此輸入才有效。 設定為 0 (預設值) 以包含所有監視器。 設定為 1 以僅包含主要監視器。 設定為 2 或更高,以僅包含相關的輔助顯示器。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
螢幕影像為 Base64
ScreenBitmapBase64 string

螢幕影像是 Base64 編碼字串。 這可以使用提供的實用程序“Base64 到點陣圖”查看。

截圖成功
ScreenshotSuccessful boolean

如果螢幕截圖成功,則設定為 true。 如果螢幕擷取畫面失敗,且 [發生錯誤時引發例外狀況] 設定為 false,則設定為 false。 如果螢幕擷取畫面失敗,且「錯誤時引發例外狀況」設定為 true,則會引發例外狀況。

螢幕截圖錯誤訊息
ScreenshotErrorMessage string

如果螢幕擷取畫面失敗,且「錯誤時引發例外狀況」設定為 false,則此輸出欄位會保留錯誤訊息。 這是將「錯誤時引發例外狀況」設定為 true 的替代方法,如果執行螢幕擷取畫面時發生錯誤,則會導致例外狀況。

指派 Orchestrator 自動化工作

將選取的 Orchestrator 自動化工作指派給指定的使用者或群組。 此指派將傳遞至與此自動化工作連結的來源系統 (例如 ServiceNow),而且最常用於將摘記卷傳遞給不同的人員或群組,以進行其他處理。 如果 Orchestrator 自動化工作未連結至來源,則會引發例外狀況。

參數

名稱 機碼 必要 類型 Description
任務標識符
TaskId True integer

要指派的 Orchestrator 工作識別碼。

指派給使用者 ID
AssignToUserId string

要指派任務的使用者識別碼。 如果將作業指派給使用者,且您知道使用者 ID,請使用此輸入。請同時使用使用者 ID 或使用者名稱輸入,而不是兩者,或者如果指派給群組,請將此輸入保留空白。

指派給使用者名稱
AssignToUserName string

要指派任務的使用者名稱。 如果將工作指派給使用者,而且您知道使用者名稱,請使用此輸入。 使用使用者 ID 或使用者名稱輸入,而不是兩者,或者如果指派給群組,請將此輸入保留空白。

指派給群組識別碼
AssignToGroupId string

要指派任務的群組 ID。 如果將任務指派給群組,且您知道群組 ID,請使用此輸入。請使用群組 ID 或群組名稱輸入,而不是兩者,或者如果指派給使用者,請將此輸入保留空白。

指派給群組名稱
AssignToGroupName string

要指派任務的群組名稱。 如果將任務指派給群組,而且您知道群組名稱,請使用此輸入。 使用群組 ID 或群組名稱輸入,而不是兩者,或者如果指派給使用者,請將此輸入保留空白。

移除使用者指派 (如果空白)
RemoveUserAssignmentIfBlank boolean

如果使用者指派欄位為空白且此欄位設定為 true,則會移除任何目前指派的使用者,否則使用者指派將保持不變。

移除群組指派(如果空白)
RemoveGroupAssignmentIfBlank boolean

如果群組指派欄位為空白,且此欄位設定為 true,則會移除任何目前指派的群組,否則群組指派將保持不變。

傳回

名稱 路徑 類型 Description
指令結果
TasksAssignTaskResult boolean

命令的結果(成功或失敗)。

錯誤訊息
ErrorMessage string

如果指令不成功,則會包含傳回的錯誤訊息。

按名稱終止 IA-Connect 會話

終止指定的 IA-Connect Director 工作階段 (如果存在)。 這是將命令傳送到 IA-Connect 代理程式的階段作業。 該名稱將從早期的“附加”操作中得知。

參數

名稱 機碼 必要 類型 Description
IA-Connect 階段作業名稱
IAConnectSessionName True string

要終止 IA-Connect 階段作業的名稱。

成功時附加至第 1 層 IA-Connect 工作階段
AttachToTier1IAConnectSessionOnSuccess boolean

如果 IA-Connect 階段作業已成功關閉,是否應該連線回第 1 層 IA-Connect 階段作業 (接收 SOAP 和/或 REST 訊息的導向器的 IA-Connect 導向器工作階段) ?

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
IA-Connect 會話被終止
IAConnectSessionKilled boolean

如果具有指定名稱的會話已終止,則傳回 true,如果未終止,則傳回 false。

附加的第 1 層 IA-Connect 工作階段名稱
AttachedTier1IAConnectSessionName string

已連線至的第 1 層 IA-Connect 階段作業的名稱。

擷取代理程式執行緒的狀態

擷取代理程式執行緒的狀態,並選擇性地擷取執行緒輸出資料。 代理程式執行緒可用來執行執行緒中的特定動作,允許動作長時間執行 (長於 RPA 逾時) 或與其他動作平行執行。

參數

名稱 機碼 必要 類型 Description
執行緒識別碼
ThreadId True integer

如果您先前以執行緒身分執行代理程式動作,請提供執行緒識別碼以擷取執行緒的狀態。 此執行緒識別碼會提供為先前執行為執行緒之動作的輸出。

擷取執行緒輸出資料
RetrieveThreadOutputData boolean

設定為 true 以 JSON 格式擷取執行緒輸出資料。 建議呼叫用來建立執行緒的相同動作,將輸入「擷取執行緒 ID 的輸出資料」設定為執行緒 Id,但此選項可讓您直接擷取執行緒輸出資料,並選擇性地不刪除資料。

擷取輸出資料後刪除執行緒
ClearOutputDataFromMemoryOnceRead boolean

如果執行緒已順利完成,且已擷取輸出資料 (請參閱輸入 '擷取執行緒輸出資料') ,請將此輸入設為 true ,以在傳回結果之後刪除執行緒。 這將刪除執行緒輸出資料和執行緒本身,因此您將無法再次查詢執行緒。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
線程已啟動
ThreadStarted boolean

如果執行緒已啟動,則為 True。 如果線程尚未啟動,則為 False,這表示線程立即啟動後出現了問題。

執行緒正在執行中
ThreadRunning boolean

如果執行緒目前正在執行,則為 True。 如果執行緒從未啟動 (極不可能) 或執行程現在已完成,則為 False。

線程完成
ThreadCompleted boolean

如果執行緒已完成,則為 True。 如果執行緒從未啟動 (極不可能) 或執行緒仍在執行中,則為 False。

執行緒成功
ThreadSuccess boolean

如果執行緒已順利完成,則為 True。 如果執行緒從未啟動 (極不可能)、執行緒仍在執行中或執行緒失敗,則為 False。

執行緒執行時間(以秒為單位)
ThreadRuntimeInSeconds integer

執行緒執行的總秒數。

IA-Connect 動作名稱
IAConnectActionName string

以執行緒形式執行的 IA-Connect 代理程式動作的內部名稱。

執行緒狀態訊息
ThreadStatusMessage string

描述執行緒狀態的文字字串。 此訊息是根據 ThreadStarted、ThreadRunning、ThreadCompleted、ThreadSuccess 屬性計算。 此文字字串與語言無關(它不會變更以符合地區設定)。

執行緒錯誤訊息
ThreadErrorMessage string

如果執行緒失敗,此輸出會包含錯誤訊息。

執行緒輸出資料JSON
ThreadOutputJSON string

如果「擷取執行緒輸出資料」設定為 true,則此輸出會保留 JSON 格式的原始執行緒輸出資料。

擺動滑鼠

將滑鼠來回移動指定的座標數目。 目前作用中的滑鼠移動 API (mouse_event 或 setcursorpos) 用於移動滑鼠。

參數

名稱 機碼 必要 類型 Description
X 擺動
XWiggle integer

水平移動滑鼠的像素數。

Y 擺動
YWiggle integer

垂直移動滑鼠的像素數。

擺動延遲(以秒為單位)
WiggleDelayInSeconds double

滑鼠移動之間的秒數。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

新增 Orchestrator 延遲工作

將新的 Orchestrator 延遲工作新增至可從流量監控的佇列。 該任務將推遲到未來的指定時間。 使用此動作可暫時暫停任務指定的時間量 (例如,如果您正在等待某項內容)。

參數

名稱 機碼 必要 類型 Description
設定自動化名稱
SetAutomationName string

如果您想要使用流程名稱作為任務名稱,請選取 [自動],或選取 [手動],然後在 [自動化名稱] 欄位中輸入名稱以使用該名稱。

自動化名稱
AutomationName string

只有在「設定自動化名稱」欄位中選擇「手動」時,才會使用此選項。 提供易記名稱,以協助稍後識別工作或將它與特定流程相關聯。 多個任務可以使用相同的自動化名稱。

延遲時間 (以分鐘為單位)
DeferralTimeInMinutes integer

自動化任務應該延遲多少分鐘。

任務輸入資料
TaskInputData string

任務啟動時可供任務使用的選用資料。 您可以自由地以任何格式儲存數據,但 JSON 是一種常用的格式。

延遲儲存的資料
DeferralStoredData string

要與此工作一起儲存的選用資料。 當程序/流程從延遲繼續時,它將可供使用。 這通常用於儲存您在流程/流程期間計算的資料,這些資料需要在延遲後再次可用。 您可以自由地以任何格式儲存數據,但 JSON 是一種常用的格式。

工藝階段
ProcessStage string

延遲後自動化流程/流程應繼續的點。 這是一個可選的字串值,對於特定流程/流程來說是唯一的。 延遲程序/流程中的條件將使用它來決定下一步要執行的步驟。 例如:如果您希望流程/流程在延遲後繼續時在「交換」階段繼續,請輸入值「交換」。

Priority
Priority integer

設定此工作的優先順序層級 (1 為最高層級)。

將工作擱置
TaskOnHold boolean

指定任務的「保留」狀態。 設定為「保留」的工作將不會由「取得下一個 Orchestrator 自動化工作」動作擷取,因此不會在一般工作工作流程中處理。

組織
Organisation string

或者,指定與此任務相關聯的組織。 通常用於搜尋和篩選任務。

部門
Department string

或者,指定與此工作相關聯的部門。 通常用於搜尋和篩選任務。

Description
Description string

或者,指定此工作的描述。 通常用於搜尋和篩選任務。

Tags
Tags string

要指派給此工作的一或多個標籤的選用清單。 通常用於對任務進行分類以進行搜索和過濾。 不區分大小寫。 每行一個。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
任務標識符
TaskId integer

所建立延遲工作的識別碼。

新增 Orchestrator 自動化工作

將新的 Orchestrator 自動化工作新增至可從流量監控的佇列。 工作可以準備好立即執行,也可以延遲稍後執行。

參數

名稱 機碼 必要 類型 Description
設定自動化名稱
SetAutomationName string

如果您想要使用流程名稱作為任務名稱,請選取 [自動],或選取 [手動],然後在 [自動化名稱] 欄位中輸入名稱以使用該名稱。

自動化名稱
AutomationName string

只有在「設定自動化名稱」欄位中選擇「手動」時,才會使用此選項。 提供易記名稱,以協助稍後識別工作或將它與特定流程相關聯。 多個任務可以使用相同的自動化名稱。 如果工作由外部輪詢程式或 Orchestrator 觸發程序處理,則需要特定工作名稱。

任務輸入資料
TaskInputData string

任務啟動時可供任務使用的選用資料。 您可以自由地以任何格式儲存數據,但 JSON 是一種常用的格式。

工藝階段
ProcessStage string

自動化流程/流程應開始的點。 這是一個可選的字串值,對於特定流程/流程來說是唯一的。 流程/流程中的條件將使用它來決定下一步要執行的步驟。 例如:如果您想要流程/流程從「交換」階段開始,請輸入值「交換」。

Priority
Priority integer

設定此自動化工作的優先順序層級 (1 為最高層級)。

SLA (幾分鐘內)
SLA integer

設定 SLA 所需的分鐘數。 如果您沒有 SLA,請將此設定為 0。 根據預設,接近 SLA 結尾的自動化工作將優先於其他工作。

將工作擱置
TaskOnHold boolean

指定任務的「保留」狀態。 設定為「保留」的工作將不會由「取得下一個 Orchestrator 自動化工作」動作擷取,因此不會在一般工作工作流程中處理。

組織
Organisation string

或者,指定與此任務相關聯的組織。 通常用於搜尋和篩選任務。

部門
Department string

或者,指定與此工作相關聯的部門。 通常用於搜尋和篩選任務。

Description
Description string

或者,指定此工作的描述。 通常用於搜尋和篩選任務。

Tags
Tags string

要指派給此工作的一或多個標籤的選用清單。 通常用於對任務進行分類以進行搜索和過濾。 不區分大小寫。 每行一個。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
任務標識符
TaskId integer

已建立之 Orchestrator 自動化工作的識別碼。 此工作識別碼可用於稍後擷取工作。

新增 Orchestrator 自動化工作作業

新增新的 Orchestrator 自動化工作,並接收作業識別碼。如果工作由外部輪詢程式或 Orchestrator 觸發程序處理,則需要特定工作名稱。 此動作與「新增 Orchestrator 自動化工作」(TasksAddNewTaskOperation) 不同,因為它會以無法猜測的作業識別碼 (Operation ID) 回應,而不是可猜測的工作識別碼。

參數

名稱 機碼 必要 類型 Description
自動化名稱
AutomationName string

提供易記名稱,以協助稍後識別工作或將它與特定流程相關聯。 多個任務可以使用相同的自動化名稱。

任務輸入資料
TaskInputData string

任務啟動時可供任務使用的選用資料。 您可以自由地以任何格式儲存數據,但 JSON 是一種常用的格式。

工藝階段
ProcessStage string

自動化流程/流程應開始的點。 這是一個可選的字串值,對於特定流程/流程來說是唯一的。 流程/流程中的條件將使用它來決定下一步要執行的步驟。 例如:如果您想要流程/流程從「交換」階段開始,請輸入值「交換」。

Priority
Priority integer

設定此自動化工作的優先順序層級 (1 為最高層級)。

SLA (幾分鐘內)
SLA integer

設定 SLA 所需的分鐘數。 如果您沒有 SLA,請將此設定為 0。 根據預設,接近 SLA 結尾的自動化工作將優先於其他工作。

組織
Organisation string

或者,指定與此任務相關聯的組織。 通常用於搜尋和篩選任務。

部門
Department string

或者,指定與此工作相關聯的部門。 通常用於搜尋和篩選任務。

Description
Description string

或者,指定此工作的描述。 通常用於搜尋和篩選任務。

Tags
Tags string

要指派給此工作的一或多個標籤的選用清單。 通常用於對任務進行分類以進行搜索和過濾。 不區分大小寫。 每行一個。

傳回

名稱 路徑 類型 Description
作業識別碼
OperationId string

已建立之 Orchestrator 自動化工作的作業識別碼。 此作業識別碼可用於稍後擷取工作。 作業識別碼是唯一的、不可猜測的字串,限制了第三方猜測他們未建立之作業識別碼的能力。

新增新的 Orchestrator 延遲工作作業

新增新的 Orchestrator 延遲工作,並接收作業識別碼。該任務將推遲到未來的指定時間。 使用此動作可暫時暫停任務指定的時間量 (例如,如果您正在等待某項內容)。 如果工作由外部輪詢程式或 Orchestrator 觸發程序處理,則需要特定工作名稱。 此動作與「新增 Orchestrator 延遲工作」(TasksAddNewDeferral) 不同,因為它會以無法猜測的作業識別碼 (Operation Id) 回應,而不是可猜測的工作識別碼。

參數

名稱 機碼 必要 類型 Description
自動化名稱
AutomationName string

提供易記名稱,以協助稍後識別工作或將它與特定流程相關聯。 多個任務可以使用相同的自動化名稱。

延遲時間 (以分鐘為單位)
DeferralTimeInMinutes integer

自動化任務應該延遲多少分鐘。

任務輸入資料
TaskInputData string

任務啟動時可供任務使用的選用資料。 您可以自由地以任何格式儲存數據,但 JSON 是一種常用的格式。

延遲儲存的資料
DeferralStoredData string

要與此工作一起儲存的選用資料。 當程序/流程從延遲繼續時,它將可供使用。 這通常用於儲存您在流程/流程期間計算的資料,這些資料需要在延遲後再次可用。 您可以自由地以任何格式儲存數據,但 JSON 是一種常用的格式。

工藝階段
ProcessStage string

自動化流程/流程應開始的點。 這是一個可選的字串值,對於特定流程/流程來說是唯一的。 流程/流程中的條件將使用它來決定下一步要執行的步驟。 例如:如果您想要流程/流程從「交換」階段開始,請輸入值「交換」。

Priority
Priority integer

設定此自動化工作的優先順序層級 (1 為最高層級)。

組織
Organisation string

或者,指定與此任務相關聯的組織。 通常用於搜尋和篩選任務。

部門
Department string

或者,指定與此工作相關聯的部門。 通常用於搜尋和篩選任務。

Description
Description string

或者,指定此工作的描述。 通常用於搜尋和篩選任務。

Tags
Tags string

要指派給此工作的一或多個標籤的選用清單。 通常用於對任務進行分類以進行搜索和過濾。 不區分大小寫。 每行一個。

傳回

名稱 路徑 類型 Description
作業識別碼
OperationId string

已建立的 Orchestrator 延遲工作的作業識別碼。 此作業識別碼可用於稍後擷取工作。 作業識別碼是唯一的、不可猜測的字串,限制了第三方猜測他們未建立之作業識別碼的能力。

新增檔案權限

將權限新增至執行 IA-Connect Agent 的電腦上的檔案。

參數

名稱 機碼 必要 類型 Description
檔案路徑
FilePath True string

檔案的完整路徑。 這必須可從執行 IA-Connect Agent 的階段作業存取。

身份
Identity True string

要指派權限的使用者或群組身分。 這可以是「使用者名稱」、「網域\使用者名稱」或「username@domainfqdn」的形式。

權限
Permission True string

提供要指派的權限 (讀取、讀取和執行、修改或完全控制) ,或將預設值保留空白 (讀取)。

Deny
Deny boolean

權限是否被拒絕?

Workflow
Workflow True string

在此處新增下列運算式:workflow()

是否啟用螢幕助讀程式

傳回螢幕助讀程式是否已在 IA-Connect 代理程式使用者工作階段中啟用。

參數

名稱 機碼 必要 類型 Description
Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
已啟用螢幕助讀程式
ScreenReaderEnabled boolean

如果已啟用螢幕助讀程式,則傳回 true。

更新 Orchestrator 流程統計資料結果

更新 IA-Connect Orchestrator 中目前工作流程的結果統計資料。 這可用來修改 IA-Connect Orchestrator 中流量統計資料的最終結果,這通常用於報告目的。 這僅適用於目前的流量 (Orchestrator 會偵測到流量執行識別碼)。 您無法修改任何其他流程的統計資料。

參數

名稱 機碼 必要 類型 Description
流程上次動作成功
FlowLastActionSuccess boolean

設定為 true 以指定 Orchestrator 流程統計資料中的最後一個動作成功。 設定為 false 以指定 Orchestrator 流程統計資料中的最後一個動作為失敗。 如果您不想更新流程上次動作狀態,請將此欄位保留空白 (例如:如果您只想更新上次動作代碼。

流程最後一個動作錯誤訊息
FlowLastActionErrorMessage string

如果指定 Flow last 動作失敗,請在此處提供錯誤訊息。

流程最後一個動作程式碼
FlowLastActionCode integer

要指派給流程統計資料的選用代碼。這通常用作錯誤碼 (例如,區分系統和商務例外狀況) ,但也可以用作成功碼。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
指令結果
UpdateOrchestratorFlowStatsResultResult boolean

命令的結果(成功或失敗)。

錯誤訊息
ErrorMessage string

如果指令不成功,則會包含傳回的錯誤訊息。

替換 INI 文件中的變量數據

更新 INI 檔案中的單一變數。

參數

名稱 機碼 必要 類型 Description
INI 檔案路徑
InputFilename True string

INI 檔案的完整路徑。 這必須可從執行 IA-Connect Agent 的階段作業存取。

輸出 INI 檔案路徑
OutputFilename string

如果您想要將更新的 INI 檔案寫入替代檔案,請在此處輸入輸出檔案的完整路徑。 輸入 INI 檔案將不會修改 - 輸出 INI 檔案將保留變更。

INI 搜尋區段
SearchSection string

保存要變更之變數的區段的選擇性名稱。

INI 搜尋變數名稱
SearchVariable string

要更新的變數名稱。

替換資料
ReplaceData string

要將變數更新為的取代資料。

INI 檔案編碼
InputFilenameEncoding string

提供 INI 檔案編碼 (Unicode、UTF8、UTF7 或 ASCII) 或指定編碼值 (例如西歐為 1252)。

如果輸入檔案不存在,請建立新檔案
CreateNewFileIfNotExists boolean

如果輸入檔案不存在,是否應該建立新的檔案?

等於之前的寫入空間
WriteSpaceBeforeEquals boolean

應該在等號 ( = ) 號之前寫空格嗎?

等於之後的寫入空間
WriteSpaceAfterEquals boolean

空格應該寫在等號 ( = ) 號之後嗎?

Workflow
Workflow True string

在此處新增下列運算式:workflow()

會話是否已鎖定

報告執行 IA-Connect Agent 的工作階段是否已鎖定。

參數

名稱 機碼 必要 類型 Description
Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
工作階段已鎖定
SessionIsLocked boolean

如果執行 IA-Connect Agent 的階段作業已鎖定,則設為 true。

校準mouse_event

將滑鼠移動指定的像素數,然後讀取新的滑鼠位置,以校準mouse_event方法。

參數

名稱 機碼 必要 類型 Description
校準大小(以像素為單位)
CalibrationSizeInPixels integer

滑鼠將移動以進行校準的像素數。 值越低,校準的準確性就越低。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
滑鼠 X 乘數
MouseXMultiplier double

滑鼠 X 乘數值。 值 1.0 表示沒有乘數。

鼠標 Y 乘數
MouseYMultiplier double

滑鼠 Y 乘數值。 值 1.0 表示沒有乘數。

檔案存在嗎

報告 true 或 false 來判斷執行 IA-Connect Agent 的電腦上是否存在檔案。

參數

名稱 機碼 必要 類型 Description
檔案路徑
Filename True string

檔案的完整路徑。 這必須可從執行 IA-Connect Agent 的階段作業存取。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
檔案存在
FileExists boolean

如果檔案存在,則傳回 true,如果不存在,則傳回 false。

殺死所有其他 IA-Connect 特工

終止目前在使用者工作階段中執行的 IA-Connect Agent 的任何其他實例。 這將確保只有一個 IA-Connect 代理程式執行個體正在執行。

參數

名稱 機碼 必要 類型 Description
Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
被擊殺的特工人數
NumberOfAgentsKilled integer

已終止的 IA-Connect 代理程式處理程序數目。

無法擊殺的特工數量
NumberOfAgentsFailedToKill integer

無法終止 IA-Connect 代理程式處理程序數目。

清除剪貼簿

清除 IA-Connect Agent 使用者工作階段中剪貼簿的內容。

參數

名稱 機碼 必要 類型 Description
Workflow
Workflow True string

在此處新增下列運算式:workflow()

清除目錄

清除執行 IA-Connect Agent 的電腦上的目錄 (資料夾),移除目錄內儲存的所有檔案。

參數

名稱 機碼 必要 類型 Description
目錄路徑
DirectoryPath True string

目錄 (資料夾) 的完整路徑。 這必須可從執行 IA-Connect Agent 的階段作業存取。

遞迴
Recursive boolean

所有子資料夾也應該清除嗎?

刪除頂層
DeleteTopLevel boolean

最上層資料夾也應該刪除嗎?

Workflow
Workflow True string

在此處新增下列運算式:workflow()

滑鼠中置

在 IA-Connect 客服專員使用者工作階段中按住滑鼠中鍵指定的秒數。

參數

名稱 機碼 必要 類型 Description
秒數保持
SecondsToHold True double

按住滑鼠中鍵的秒數。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

滑鼠中鍵

按一下 IA-Connect Agent 使用者工作階段中的滑鼠中鍵。

參數

名稱 機碼 必要 類型 Description
Workflow
Workflow True string

在此處新增下列運算式:workflow()

滑鼠中鍵向上

在 IA-Connect 客服專員使用者工作階段中釋放滑鼠中鍵。

參數

名稱 機碼 必要 類型 Description
Workflow
Workflow True string

在此處新增下列運算式:workflow()

滑鼠中鍵向下

在 IA-Connect 代理程式使用者工作階段中按下 (且不放開) 滑鼠中鍵。 若要釋放滑鼠,請使用滑鼠中鍵向上操作。

參數

名稱 機碼 必要 類型 Description
Workflow
Workflow True string

在此處新增下列運算式:workflow()

滑鼠右鍵

按一下 IA-Connect Agent 使用者工作階段中的滑鼠右鍵。

參數

名稱 機碼 必要 類型 Description
Workflow
Workflow True string

在此處新增下列運算式:workflow()

滑鼠右鍵

在 IA-Connect 客服專員使用者工作階段中按住滑鼠右鍵指定的秒數。

參數

名稱 機碼 必要 類型 Description
秒數保持
SecondsToHold True double

按住滑鼠右鍵的秒數。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

滑鼠右鍵向上

在 IA-Connect 代理程式使用者工作階段中釋放滑鼠右鍵。

參數

名稱 機碼 必要 類型 Description
Workflow
Workflow True string

在此處新增下列運算式:workflow()

滑鼠右鍵向下

在 IA-Connect 代理程式使用者工作階段中按下(且不放開)滑鼠右鍵。 若要釋放滑鼠,請使用滑鼠右鍵向上動作。

參數

名稱 機碼 必要 類型 Description
Workflow
Workflow True string

在此處新增下列運算式:workflow()

滑鼠左鍵

按一下 IA-Connect Agent 使用者階段作業中的滑鼠左鍵。

參數

名稱 機碼 必要 類型 Description
Workflow
Workflow True string

在此處新增下列運算式:workflow()

滑鼠左鍵向上

在 IA-Connect 客服專員使用者工作階段中釋放滑鼠左鍵。

參數

名稱 機碼 必要 類型 Description
Workflow
Workflow True string

在此處新增下列運算式:workflow()

滑鼠左鍵向下

在 IA-Connect 代理程式使用者階段作業中按下 (且不放開) 滑鼠左鍵。 若要釋放滑鼠,請使用滑鼠左鍵向上動作。

參數

名稱 機碼 必要 類型 Description
Workflow
Workflow True string

在此處新增下列運算式:workflow()

獲取 IA-Connect 代理信息

傳回 IA-Connect Agent 的屬性,包括版本號碼和 Agent 可執行檔的路徑。

參數

名稱 機碼 必要 類型 Description
Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
IA-Connect 代理程式版本
IAConnectAgentVersion string

IA-Connect 代理程式的完整版本號碼。

DotNet CLR 版本
DotNetCLRVersion string

DotNet Common Language Runtime (CLR) 版本。

IA-Connect 代理程式以使用者名稱執行
IAConnectAgentRunAsUsername string

執行 IA-Connect Agent 的使用者工作階段的使用者名稱。

IA-Connect 代理程式以使用者網域身分執行
IAConnectAgentRunAsUserdomain string

執行 IA-Connect Agent 之使用者工作階段的使用者網域。

IA-Connect 代理程式路徑
IAConnectAgentPath string

IA-Connect Agent 可執行檔的完整路徑。

IA-Connect Agent 是 64 位元進程
IAConnectAgentIs64bitProcess boolean

如果 IA-Connect 代理程式是 64 位元處理程序,則傳回 true,如果不是,則傳回 false。

IA-Connect 代理程式發行版本
IAConnectAgentReleaseVersion string

IA-Connect 代理程式發行版本,例如 8.0。

IA-Connect 代理程式 RPA 命令逾時
IAConnectAgentRPACommandTimeout integer

IA-Connect 代理程式 RPA 命令逾時。 預設為 30 秒,可以使用「設定 IA-Connect 代理程式命令逾時」動作進行設定。

IA-Connect 代理程式記錄檔名稱
IAConnectAgentLogFilename string

IA-Connect 代理程式記錄檔名。 此值對於每次啟動 IA-Connect 代理程式都是唯一的,因為它的檔案名稱中具有啟動日期和時間。

獲取 IA-Connect 導演信息

傳回 IA-Connect Director 的屬性,包括版本號碼和 Director 可執行檔的路徑。

參數

名稱 機碼 必要 類型 Description
Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
IA-Connect 導演版
IAConnectDirectorVersion string

IA-Connect Director 的完整版本號。

DotNet CLR 版本
DotNetCLRVersion string

DotNet Common Language Runtime (CLR) 版本。

IA-Connect Director 以使用者名稱執行
IAConnectDirectorRunAsUsername string

執行 IA-Connect Director 的使用者工作階段使用者名稱。

IA-Connect Director 以使用者網域身分執行
IAConnectDirectorRunAsUserdomain string

執行 IA-Connect 導向器所在之使用者工作階段的使用者網域。

IA-Connect 導演路徑
IAConnectDirectorPath string

IA-Connect Director 可執行檔的完整路徑。

IA-Connect Director 是 64 位元製程
IAConnectDirectorIs64bitProcess boolean

如果 IA-Connect 導向器是 64 位進程,則傳回 true,如果不是,則傳回 false。

IA-Connect Director 發行版本
IAConnectDirectorReleaseVersion string

IA-Connect Director 發行版本,例如 8.0。

IA-Connect 導向器記錄檔名稱
IAConnectDirectorLogFilename string

IA-Connect 導向器記錄檔名稱。 此值對於每次啟動 IA-Connect Director 都是唯一的,因為它的檔名中有啟動日期和時間。

獲取鼠標乘數

擷取 IA-Connect 代理程式使用者工作階段中的全域滑鼠乘數。 這預設為 (1, 1),但可以透過「設定滑鼠乘數」操作進行更改。

參數

名稱 機碼 必要 類型 Description
Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
X 乘數
MouseXMultiplier double

目前水平 (X) 全域滑鼠乘數 (當代理程式移動滑鼠時)。 乘數僅在禁用“多顯示器功能”時才有任何效果。

Y 乘數
MouseYMultiplier double

目前垂直 (Y) 全域滑鼠乘數 (適用於代理程式移動滑鼠時)。 乘數僅在禁用“多顯示器功能”時才有任何效果。

滑鼠移動方法
MouseMoveMethod string

傳回目前的全域滑鼠移動方法 (mouse_event 或 setcursorpos)。

產生密碼

產生密碼,其中包含範本格式中定義的字典單字、數字、符號、字元。

參數

名稱 機碼 必要 類型 Description
密碼格式
PasswordFormat True string

使用符號描述的產生密碼的格式。 符號“w”代表字典單詞,“u”代表大寫字典單詞,“n”代表數字,“s”代表符號,“l”代表小寫字母,“L”代表大寫字母,“z”不代表任何內容(在組合中有用)。 例如,wnnwsl 可能會產生 Pluto35Marmite!b。 一個數字後跟兩個或多個大括號中的符號將創建該數量符號的隨機組合。 例如,8(Lln) 可能會產生 6hP2AxP0,而 4(Lsz) 可能會產生 S!-A(LssL 符號)或可能產生 J$(Lszz 符號)。 單引號內的字元會 as-is使用。 例如,w'--'w'_'nn 可能會產生 Jersey--Mountain_64。

最小長度
MinimumLength integer

產生密碼的長度下限。 如果產生的密碼太短,則會新增額外的字典單字,直到達到長度為止。 如果沒有長度下限要求,請設定為 0。

以純文字形式傳回
ReturnAsPlainText boolean

設定為 true 以純文字形式傳回密碼。

將密碼儲存為識別碼
StorePasswordAsIdentifier string

如果提供識別碼,則此密碼將加密儲存在 Orchestrator 或代理程式中 (請參閱「產生時間」),以便日後任何可以使用儲存認證的命令擷取/使用。 如果由代理程式產生,則這些密碼只會儲存在記憶體中,並在關閉代理程式時遺失。 例如,可以使用 {IAConnectPassword:MyExchangePassword} 擷取 MyExchangePassword。

支援的符號
SupportedSymbols string

可讓您提供以產生密碼格式使用符號 's' 時要隨機使用的符號清單。 如果未指定,則會使用內建清單。 例如:!$()*。

嘗試使用唯一密碼
AttemptUniquePasswords boolean

將 Orchestrator 或代理程式設定為 true (預設值) (請參閱「產生時間」),以避免重複隨機數序列,從而確保產生的密碼在特定工作階段中盡可能是唯一的。 如果由代理程式產生,則不保證個別代理程式之間有唯一的密碼,或者代理程式已關閉或重新啟動,因此您應該始終使用複雜的密碼來確保密碼是高度隨機的(例如:wnnws 比 wnw 更隨機)。

產生於
GenerateAt string

指定將產生密碼的 IA-Connect 元件。

最小小寫
MinimumLowercase integer

密碼中必須存在的最小小寫字元數。 如果無法做到這一點(例如,如果密碼格式沒有足夠的 l、w 或 u 符號),則會引發例外。 設定為 0 表示沒有最小值。

最小大寫
MinimumUppercase integer

密碼中必須存在的最小大寫字元數。 如果無法做到這一點(例如,如果密碼格式沒有足夠的 L、w 或 u 符號),則會引發例外。 設定為 0 表示沒有最小值。

最小人數
MinimumNumbers integer

密碼中必須存在的最小數字數。 如果無法做到這一點(例如,如果密碼格式沒有足夠的 n 個符號),則會引發例外。 設定為 0 表示沒有最小值。

最小符號
MinimumSymbols integer

密碼中必須存在的最小符號數。 如果無法做到這一點(例如,如果密碼格式沒有足夠的 s 符號),則會引發例外。 設定為 0 表示沒有最小值。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
純文字密碼
PlainTextPassword string

如果要求,則為純文字密碼。 密碼可能會以純文字形式要求,因為密碼是一次性密碼,旨在透過簡訊或電子郵件(例如)傳輸,因此需要 as-is查看。

登出遠端工作階段

登出執行 IA-Connect Agent 的遠端工作階段。

參數

名稱 機碼 必要 類型 Description
等待秒數
SecondsToWait integer

向作業系統發出登出指令之後等待的時間,以便 IA-Connect 代理程式可以報告指令的完成。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

目錄是否可存取

傳回目錄 (資料夾) 是否可存取,以及權限是否限制在 IA-Connect 代理程式所在電腦上存取該目錄。

參數

名稱 機碼 必要 類型 Description
目錄路徑
DirectoryPath True string

目錄 (資料夾) 的完整路徑。 這必須可從執行 IA-Connect Agent 的階段作業存取。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
目錄可存取
DirectoryAccessible boolean

如果目錄可存取,則傳回 true,如果無法存取,則傳回 false。

未經授權的目錄存取
DirectoryAccessUnauthorised boolean

如果目錄無法存取,則傳回 true,因為權限限制了對它的存取,如果沒有,則傳回 false。

目錄是否存在

報告 true 或 false 以顯示執行 IA-Connect Agent 的電腦上是否存在目錄 (資料夾)。

參數

名稱 機碼 必要 類型 Description
目錄路徑
DirectoryPath True string

目錄 (資料夾) 的完整路徑。 這必須可從執行 IA-Connect Agent 的階段作業存取。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
目錄存在
DirectoryExists boolean

如果目錄(資料夾)存在,則傳回 true,如果不存在,則傳回 false。

移動檔案

在執行 IA-Connect Agent 的電腦上移動檔案。

參數

名稱 機碼 必要 類型 Description
來源檔案路徑
SourceFilePath True string

來源檔案的完整路徑。 這必須可從執行 IA-Connect Agent 的階段作業存取。

目的地檔案路徑
DestFilePath True string

檔案應移至之目的地的完整路徑。 這必須可從執行 IA-Connect Agent 的階段作業存取。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

移動滑鼠以協調

將 IA-Connect 代理程式使用者工作階段中的滑鼠移至指定的圖元座標。 目前作用中的滑鼠移動 API (mouse_event 或 setcursorpos) 用於移動滑鼠。 計算座標時會考慮 DPI 縮放和多個顯示。

參數

名稱 機碼 必要 類型 Description
X 像素
XCoord True integer

要將滑鼠移動到的 X 座標值 (以像素為單位)。

Y 像素
YCoord True integer

要將滑鼠移動到的 Y 座標值 (以像素為單位)。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

移動滑鼠相對

在 IA-Connect 客服專員使用者工作階段中,相對於其目前位置,將滑鼠移動指定的像素數。 目前作用中的滑鼠移動 API (mouse_event 或 setcursorpos) 用於移動滑鼠。 計算座標時會考慮 DPI 縮放和多個顯示。

參數

名稱 機碼 必要 類型 Description
X 像素
XCoord True integer

從目前位置開始移動滑鼠的 X 像素數。

Y 像素
YCoord True integer

從目前位置開始移動滑鼠的 Y 像素數。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

等待 IA-Connect 階段作業依名稱關閉

等待指定的 IA-Connect Director 工作階段結束。 這是將命令傳送到 IA-Connect 代理程式的階段作業。 該名稱將從早期的“附加”操作中得知。

參數

名稱 機碼 必要 類型 Description
IA-Connect 階段作業名稱
IAConnectSessionName True string

要檢查的 IA-Connect 工作階段名稱。

等待時間(以秒為單位)
TimeToWaitInSeconds integer

如果沒有指定類型的會話 (如果指定了特定類型) ,IA-Connect 應該等待多長時間?

逾時時引發例外狀況
RaiseExceptionIfTimedout boolean

如果新的會話在逾時期間過後未連線,IA-Connect 是否應該引發例外狀況?

成功時附加至第 1 層 IA-Connect 工作階段
AttachToTier1IAConnectSessionOnSuccess boolean

如果 IA-Connect 階段作業已成功關閉,是否應該連線回第 1 層 IA-Connect 階段作業 (接收 SOAP 和/或 REST 訊息的導向器的 IA-Connect 導向器工作階段) ?

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
IA-Connect 會議已結束
IAConnectSessionClosed boolean

如果具有指定名稱的會話已關閉,則傳回 true,如果未關閉,則傳回 false。

附加的第 1 層 IA-Connect 工作階段名稱
AttachedTier1IAConnectSessionName string

已連線至的第 1 層 IA-Connect 階段作業的名稱。

等待下一個躍點工作階段連線 IA-Connect

等待下一個躍點工作階段連線,並等待 IA-Connect Agent 在下一個躍點工作階段中執行。

參數

名稱 機碼 必要 類型 Description
下一躍點導向器位址
NextHopDirectorAddress string

如果「下一個躍點導向器位址是 localhost」、「下一個躍點導向器位址是主機名稱」、「下一個躍點導向器位址是 FQDN」或「下一個躍點導向器位址已命名管道」參數都沒有,則下一個躍點 IA-Connect 導向器的選擇性位址會將命令轉送至。

下一躍點導向器 TCP 連接埠
NextHopDirectorTCPPort integer

下一個躍點導向器接聽的 TCP 埠 (執行代理程式之電腦上的導向器)。

下一個躍點導向器使用 HTTPS
NextHopDirectorUsesHTTPS boolean

如果下一個躍點導向器使用 HTTPS,則設定為 True,如果不是,則設定為 false。

下一個躍點導向器位址是localhost
NextHopDirectorAddressIsLocalhostname boolean

下一個躍點導向器位址 (相對於代理程式) 是 'localhost'。

下一躍點導向器位址為主機名稱
NextHopDirectorAddressIsHostname boolean

下一個躍點導向器位址是執行代理程式的電腦的主機名稱 (即執行代理程式和導向器的電腦)。

下一個躍點導向器位址是 FQDN
NextHopDirectorAddressIsFQDN boolean

下一個躍點導向器位址是執行代理程式的電腦的完整網域名稱 (FQDN) (也就是執行代理程式和導向程式的電腦) 。

依會話識別碼遞增下一個躍點導向器 TCP 連接埠
IncrementNextHopDirectorTCPPortBySessionId boolean

若要確保下一躍點導向器 TCP 連接埠是唯一的 (如果有多個平行會話使用來自相同主機的下一躍點),可以將工作階段 ID 新增至下一躍點導向器 TCP 連接埠。

等待時間(以秒為單位)
SecondsToWait double

等待下一個躍點工作階段連線的秒數上限。

下一個躍點導向器位址名為pipe
NextHopDirectorAddressIsNamedPipe boolean

下一個躍點導向器位址 (相對於代理程式) 使用具名管道,而不是 TCP/IP Web 服務。 這是避免在第一躍點上使用 TCP/IP 埠的預設值。

停用現有的下一個躍點
DisableExistingNextHop boolean

在再次啟用之前,是否應該停用雙跳 (如果目前處於作用中狀態) ? 如果設為 true (預設值) ,則任何新的雙躍點啟用指示都會取代先前的指示。 如果設定為 false,這將啟用三躍點,因為雙躍點 IA-Connect 代理程式會接收指令。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
已連線下一個躍點工作階段
NextHopSessionConnected boolean

如果超過等待時間上限之前連線的下一個躍點會話,則傳回 true。

等待代理程式執行緒成功完成

等候代理程式執行緒完成,並選擇性地擷取執行程輸出資料。 代理程式執行緒可用來執行執行緒中的特定動作,允許動作長時間執行 (長於 RPA 逾時) 或與其他動作平行執行。 如果代理程式執行緒完成,但失敗,則會引發例外狀況。

參數

名稱 機碼 必要 類型 Description
執行緒識別碼
ThreadId True integer

如果您先前以執行緒身分執行代理程式動作,請提供執行緒識別碼以擷取執行緒的狀態。 此執行緒識別碼會提供為先前執行為執行緒之動作的輸出。

等待執行緒的秒數
SecondsToWaitForThread True integer

等待執行程完成的秒數。 如果執行緒在此時間內尚未完成,則會引發例外狀況 (除非「如果執行緒未完成,則引發例外狀況」設定為 false)。

擷取執行緒輸出資料
RetrieveThreadOutputData boolean

設定為 true 以 JSON 格式擷取執行緒輸出資料。 建議呼叫用來建立執行緒的相同動作,將輸入「擷取執行緒 ID 的輸出資料」設定為執行緒 Id,但此選項可讓您直接擷取執行緒輸出資料,並選擇性地不刪除資料。

擷取輸出資料後刪除執行緒
ClearOutputDataFromMemoryOnceRead boolean

如果執行緒已順利完成,且已擷取輸出資料 (請參閱輸入 '擷取執行緒輸出資料') ,請將此輸入設為 true ,以在傳回結果之後刪除執行緒。 這將刪除執行緒輸出資料和執行緒本身,因此您將無法再次查詢執行緒。

如果執行緒未完成,則引發例外狀況
RaiseExceptionIfThreadNotCompleted boolean

如果設定為 true,且執行緒尚未在指定的時間內完成,則會引發例外狀況。 如果設定為 false,此動作將等待到要求的時間(讓執行緒完成)並報告執行緒狀態(請參閱輸出「執行緒正在執行」等)。 如果執行緒完成,但失敗,一律會引發例外狀況。

如果執行緒錯誤,則引發例外狀況
RaiseExceptionIfThreadError boolean

如果設定為 true(預設行為),且執行緒有錯誤狀況 (執行緒已完成但未成功),則會引發例外狀況,並刪除執行程。 如果設定為 false,則錯誤將儲存在輸出「執行緒錯誤訊息」中,且不會刪除執行緒 (您應該在適當時使用動作 '刪除代理程式執行緒' 來刪除執行緒)。

每次通話等待的秒數
SecondsToWaitPerCall integer

「等待執行緒的秒數」將分解為較小的時間片段,以避免逾時。 此選用輸入可讓您指定較小時間片的大小。 請勿設定為大於 RPA 逾時 80% 的值,否則您可能會收到逾時錯誤。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
線程已啟動
ThreadStarted boolean

如果執行緒已啟動,則為 True。 如果線程尚未啟動,則為 False,這表示線程立即啟動後出現了問題。 只有在「如果執行程未完成時引發例外狀況」設定為 false 時才有用,因為否則如果執行緒在指定的等候時間內未完成,則會引發例外狀況。

執行緒正在執行中
ThreadRunning boolean

如果執行緒目前正在執行,則為 True。 如果執行緒從未啟動 (極不可能) 或執行程現在已完成,則為 False。 只有在「如果執行程未完成時引發例外狀況」設定為 false 時才有用,因為否則如果執行緒在指定的等候時間內未完成,則會引發例外狀況。

線程完成
ThreadCompleted boolean

如果執行緒已完成,則為 True。 如果執行緒從未啟動 (極不可能) 或執行緒仍在執行中,則為 False。 只有在「如果執行程未完成時引發例外狀況」設定為 false 時才有用,因為否則如果執行緒在指定的等候時間內未完成,則會引發例外狀況。

執行緒成功
ThreadSuccess boolean

如果執行緒已順利完成,則為 True。 如果執行緒從未啟動 (極不可能)、執行緒仍在執行中或執行緒失敗,則為 False。 只有在「如果執行程未完成時引發例外狀況」設定為 false 時才有用,因為否則如果執行緒在指定的等候時間內未完成,則會引發例外狀況。

執行緒執行時間(以秒為單位)
ThreadRuntimeInSeconds integer

執行緒執行的總秒數。

IA-Connect 動作名稱
IAConnectActionName string

以執行緒形式執行的 IA-Connect 代理程式動作的內部名稱。

執行緒狀態訊息
ThreadStatusMessage string

描述執行緒狀態的文字字串。 此訊息是根據 ThreadStarted、ThreadRunning、ThreadCompleted、ThreadSuccess 屬性計算。 此文字字串與語言無關(它不會變更以符合地區設定)。

執行緒錯誤訊息
ThreadErrorMessage string

如果執行緒失敗,此輸出會包含錯誤訊息。 只有在「如果執行緒錯誤時引發例外狀況」設定為 false 時才有用,因為否則如果執行緒發生錯誤,就會引發例外狀況。

執行緒輸出資料JSON
ThreadOutputJSON string

如果「擷取執行緒輸出資料」設定為 true,則此輸出會保留 JSON 格式的原始執行緒輸出資料。

終止代理程式執行緒

終止(終止、中止)代理程式執行緒。 代理程式執行緒可用來執行執行緒中的特定動作,允許動作長時間執行 (長於 RPA 逾時) 或與其他動作平行執行。 不會刪除代理程式執行緒 (使用動作「刪除代理程式執行緒」來刪除執行緒),以容許監視代理程式執行緒的任何處理程序或流程收到「IA-Connect 代理程式執行緒已中止」錯誤。

參數

名稱 機碼 必要 類型 Description
執行緒識別碼
ThreadId True integer

如果您先前以執行緒身分執行代理程式動作,請提供執行緒識別碼以終止執行緒 (永久停止執行執行緒)。 此執行緒識別碼會提供為先前執行為執行緒之動作的輸出。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
指令結果
KillAgentThreadResult boolean

命令的結果(成功或失敗)。

錯誤訊息
ErrorMessage string

如果指令不成功,則會包含傳回的錯誤訊息。

終止進程

終止 IA-Connect Agent 使用者階段作業中具有指定處理程序名稱的任何執行中處理程序。

參數

名稱 機碼 必要 類型 Description
程序名稱
ProcessName True string

殺戮的過程。 例如記事本。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
終止的處理程序數目
NumberOfProcessesKilled integer

已終止的處理程序數目。

終止進程識別碼

終止 IA-Connect Agent 使用者工作階段中具有指定處理程序 ID 的執行中處理程序。處理程序 ID 是唯一的,因此只有一個處理程序可以符合識別碼。處理程序識別碼是動態的,並且每次啟動應用程式都不同。

參數

名稱 機碼 必要 類型 Description
程序識別碼
ProcessID True integer

要終止的進程的進程 ID。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
終止的處理程序數目
NumberOfProcessesKilled integer

已終止的處理程序數目。

複製檔案

複製執行 IA-Connect Agent 的電腦上的檔案。

參數

名稱 機碼 必要 類型 Description
來源檔案路徑
SourceFilePath True string

來源檔案的完整路徑。 這必須可從執行 IA-Connect Agent 的階段作業存取。

目的地檔案路徑
DestFilePath True string

檔案應複製到的目的地的完整路徑。 這必須可從執行 IA-Connect Agent 的階段作業存取。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

解鎖工作階段

解除鎖定 IA-Connect Agent 正在執行的工作階段。 這需要在裝載會話的電腦上安裝 IA-Connect Unlocker 認證提供者,因為只有認證提供者可以解除鎖定電腦。

參數

名稱 機碼 必要 類型 Description
解鎖密碼
UnlockPassword True string

解除鎖定目前工作階段的密碼。 這是登入目前鎖定之工作階段之帳戶的 Windows 使用者密碼。 如果這是「儲存」密碼,請輸入 {IAConnectPassword:StoredPasswordIdentifier} 格式,並將「儲存密碼」輸入設定為 true。 如果這是 Orchestrator 一般認證,請輸入 {OrchestratorCredential:FriendlyName} 格式,並將「儲存的密碼」輸入設定為 true。

密碼包含儲存的密碼
PasswordContainsStoredPassword boolean

如果密碼是 IA-Connect 儲存的密碼識別碼 (例如:由「產生密碼」動作產生) 或 IA-Connect Orchestrator 一般認證 (例如:如果將 IA-Connect 與 PA 流程搭配使用),則設定為 true。

偵測是否鎖定
DetectIfLocked True boolean

IA-Connect 代理程式是否嘗試偵測工作階段是否已鎖定。 如果設定為 true,且未偵測到會話已鎖定,則此動作只會執行任何動作 (因為無事可做)。 只有在 IA-Connect 錯誤偵測工作階段是否已鎖定,而且您想要強制嘗試解除鎖定 (如果工作階段未鎖定,則會失敗) 時,才設定為 false。

偵測認證提供者
DetectCredentialProvider True boolean

IA-Connect 代理程式是否應該在傳送解除鎖定要求之前嘗試偵測 IA-Connect Unlocker 認證提供者的存在。 只有在 IA-Connect 認證提供者存在且正在執行,但由於某種原因,IA-Connect Agent 未偵測到它時,您才應該停用此功能。

等待解鎖的幾秒鐘
SecondsToWaitForUnlock integer

IA-Connect 代理程式應等待桌面平台已成功解除鎖定的證據 (透過偵測桌面平台解除鎖定狀態) 多長時間 (以秒為單位)。 預設情況下,這最多為 5 秒。 設定為 0 可停用此功能並繼續,而不檢查桌面是否已解鎖。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
已執行工作階段解除鎖定
SessionUnlockPerformed boolean

如果工作階段已鎖定且已執行解除鎖定動作,則設為 true。 如果工作階段未鎖定,則設定為 false,且「偵測是否鎖定」設定為 true,導致未執行任何動作。

設定 IA-Connect 代理程式 GUI 不透明度

將 IA-Connect 代理程式的不透明度從 1 (可見) 設定為 0 (透明)。

參數

名稱 機碼 必要 類型 Description
不透明度
Opacity True double

要設定的不透明度值,介於 1 (可見) 和 0 (透明) 之間。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

設定 IA-Connect 代理程式 GUI 位置

將 IA-Connect 代理程式 GUI 的螢幕位置設定為指定位置。

參數

名稱 機碼 必要 類型 Description
X
X True integer

要將代理程式設定為的 X 座標,以像素為單位。

Y True integer

要將代理程式設定為的 Y 座標,以像素為單位。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

設定 IA-Connect 代理程式全域座標設定

配置 IA-Connect Agent 全域座標系統,用於顯示元素位置 (例如:在滑鼠檢查期間) 和計算滑鼠位置 (例如:執行全域滑鼠動作時)。 預設值提供最新的功能,但您可以使用此動作來還原為舊版代理程式中的行為,或指定 API 使用不同的座標系統。

參數

名稱 機碼 必要 類型 Description
多顯示器功能
MultiMonitorFunctionality string

設為「僅限主要顯示器」(PrimaryMonitor) 可還原為舊版行為,這僅支援在主要顯示器裝置上醒目提示元素和執行全域滑鼠動作 (IA-Connect 9.3 及更早版本中唯一可用的模式)。 設定為「所有顯示器」(MultiMonitor) 可在所有顯示器上醒目提示元素並執行全域滑鼠動作,並自動偵測每個顯示器上的 DPI 縮放 (自 9.4 IA-Connect 以來的預設值)。 設定為「未設定」(NotSet) 以不進行任何變更。

自動設置鼠標檢查乘數
AutoSetMouseInspectionMultiplier string

設定為「自動」(1)(自 9.4 IA-Connect 起的預設值),以在代理程式啟動時和每次執行滑鼠檢查時自動計算主顯示裝置上的滑鼠檢查乘數。 設定為「手動」(0) 以要求手動設定檢查乘數(IA-Connect 9.3 及更早版本中唯一可用的選項)。 設定為空白或「NotSet」以保持此選項不變。 此選項僅在停用「多顯示器功能」時才有任何效果。

自動設置全局鼠標倍增器
AutoSetGlobalMouseMultiplier string

設定為「自動」(1)(自 9.4 IA-Connect 起的預設值),以在代理程式啟動時和每次執行滑鼠檢查時自動計算主顯示裝置上的全域滑鼠移動乘數。 設定為「手動」(0) 以要求手動設定全局滑鼠移動乘數(IA-Connect 9.3 及更早版本中唯一可用的選項)。 設定為空白或「NotSet」以保持此選項不變。 此選項僅在停用「多顯示器功能」時才有任何效果。

鼠標檢查 X 乘數
MouseInspectionXMultiplier double

要設定的水平 (X) 滑鼠檢查乘數 (當代理程式反白顯示滑鼠下方的內容時)。 例如:如果 IA-Connect 在實際滑鼠 X 位置的一半處顯示檢查矩形,請設定值 0.5。 設定為 0 可保持目前值不變。 此選項僅在禁用“多顯示器功能”和禁用“自動設置鼠標檢查乘數”時才有任何作用。

滑鼠檢查 Y 乘數
MouseInspectionYMultiplier double

要設定的垂直 (Y) 滑鼠檢查乘數 (當代理程式反白顯示滑鼠下方的內容時)。 例如:如果 IA-Connect 在實際滑鼠 Y 位置的一半處顯示檢查矩形,請設定值 0.5。 設定為 0 可保持目前值不變。 此選項僅在禁用“多顯示器功能”和禁用“自動設置鼠標檢查乘數”時才有任何作用。

全局滑鼠 X 乘數
GlobalMouseXMultiplier double

要設定的水平 (X) 全域滑鼠移動乘數 (適用於代理程式移動滑鼠時)。 設定為 0 可保持目前值不變。 此選項僅在停用「多顯示器功能」時才有任何效果。

全局滑鼠 Y 乘數
GlobalMouseYMultiplier double

要設定的垂直 (Y) 全域滑鼠移動乘數 (適用於代理程式移動滑鼠時)。 設定為 0 可保持目前值不變。 此選項僅在停用「多顯示器功能」時才有任何效果。

申請 mouse_event
GlobalMouseMultiplierApplyToMouseEvent boolean

這會指定是否要將全域滑鼠乘數值套用至 mouse_event 方法。 此選項僅在停用「多顯示器功能」時才有任何效果。

套用至 SetCursorPos
GlobalMouseMultiplierApplyToSetCursorPos boolean

此引數會指定是否要將全域滑鼠乘數值套用至 SetCursorPos 方法。 此選項僅在停用「多顯示器功能」時才有任何效果。

套用至目前滑鼠移動方法
GlobalMouseMultiplierApplyToCurrentMouseMoveMethod boolean

此引數指定是否要將全域滑鼠乘數值套用至目前的滑鼠移動方法 (例如:如果 SetCursorPos 是目前的滑鼠移動方法,則乘數會套用至 SetCursorPos)。 如果設定為 true,則會忽略輸入 'Apply to mouse_event' 和 'Apply to SetCursorPos'。 此選項僅在停用「多顯示器功能」時才有任何效果。

Java座標系
JavaCoordinateSystem string

設定為「虛擬」(IA-Connect 9.3 及更早版本中的預設且唯一可用選項),以通知代理程式 Java 存取橋接器正在提供虛擬 (DPI 縮放) 座標。 設定為「實體」,以通知代理程式 Java Access Bridge 正在提供實體座標 (直接對應至像素)。 設定為「未設定」(NotSet) 以不進行任何變更。

SAP GUI 座標系統
SAPGUICoordinateSystem string

設定為「虛擬」(IA-Connect 9.3 及更早版本中的預設且唯一可用選項),以通知代理程式 SAP GUI 指令碼 API 正在提供虛擬 (DPI 縮放) 座標。 設定為「實體」,以通知代理程式 SAP GUI 指令碼 API 正在提供實體座標 (直接對應至像素)。 設定為「未設定」(NotSet) 以不進行任何變更。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
指令結果
SetAgentGlobalCoordinateConfigurationResult boolean

命令的結果(成功或失敗)。

錯誤訊息
ErrorMessage string

如果指令不成功,則會包含傳回的錯誤訊息。

設定 IA-Connect 代理程式命令逾時

設定 IA-Connect Agent 將用於執行的每個命令的命令逾時。

參數

名稱 機碼 必要 類型 Description
命令超時時間(秒)
CommandTimeoutInSeconds True integer

IA-Connect 代理程式將使用的命令逾時。 如果讀取或寫入大量數據,不妨增加逾時時間。

終止逾時的 RPA 命令執行緒
TerminateTimedoutRPACommandThreads boolean

如果命令執行緒逾時,是否應該終止它?

Workflow
Workflow True string

在此處新增下列運算式:workflow()

設定 IA-Connect 代理程式記錄層級

將 IA-Connect 代理程式記錄層次設定為指定的值 (1 是最低層次,4 是最高層次)。

參數

名稱 機碼 必要 類型 Description
記錄層級
LoggingLevel True integer

IA-Connect 代理程式應設定的記錄層級。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

設定 IA-Connect 導向器日誌層級

將 IA-Connect 導向器記錄層級設定為指定的值。 記錄層級設定為 0 到 4。 0 為停用。 1 是最低的日誌層級 (也是預設值)。 4 是最高對數層級。

參數

名稱 機碼 必要 類型 Description
記錄層級
LoggingLevel True integer

IA-Connect 導向器應設定的記錄層級。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

設定 IA-Connect 授權代碼

將舊式 (7.0 和 7.1) 代理程式網域授權上傳至 IA-Connect 代理程式。

參數

名稱 機碼 必要 類型 Description
客戶 NetBIOS 網域名稱
CustomerNETBIOSDomainName True string

執行 IA-Connect Agent 之電腦的 NetBIOS 網域名稱。

客戶顯示名稱
CustomerDisplayName True string

要顯示在 IA-Connect 代理程式標題列中的客戶名稱。

廠商名稱
VendorName True string

IA-Connect 廠商名稱。

授權到期日
LicenseExpiryDate True string

IA-Connect 授權的到期日。

啟動碼
ActivationCode True string

IA-Connect 授權的啟動碼。

儲存在登錄中
StoreInRegistry boolean

IA-Connect 許可證是否應該暫時儲存在註冊表中? 這可確保 IA-Connect 代理程式在使用者工作階段期間獲得授權,即使代理程式已關閉並重新啟動也是如此。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

設定 IA-Connect 授權金鑰

使用授權金鑰授權 IA-Connect Agent。 這可以是授權字串,也可以是 IA-Connect Orchestrator 中保留的授權易記名稱。

參數

名稱 機碼 必要 類型 Description
授權金鑰
LicenseString True string

IA-Connect 授權金鑰字串或 IA-Connect Orchestrator 中保留的授權易記名稱 (如果透過 IA-Connect Orchestrator 控制 IA-Connect)。

儲存在登錄中
StoreInRegistry boolean

IA-Connect 許可證是否應該暫時儲存在註冊表中? 這可確保 IA-Connect 代理程式在使用者工作階段期間獲得授權,即使代理程式已關閉並重新啟動也是如此。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
授權到期前的天數
DaysUntilLicenseExpires integer

IA-Connect 授權到期前的剩餘天數。

設定 Orchestrator 背景工作角色維護模式

將 IA-Connect Orchestrator 中定義的 IA-Connect 工作角色置於維護模式 (因此不會將流程指派給工作角色),或將工作角色從維護模式中移出。

參數

名稱 機碼 必要 類型 Description
工作者識別碼
WorkerId integer

工作者的 ID。 這是 Orchestrator 內部的整數值 (1 或更高)。 您可以在 Orchestrator UI 中檢視背景工作者詳細資料,並在瀏覽器 URL 中尋找 ID,以判斷背景工作者的 ID。 如果您想要依名稱搜尋工作人員,請將此值設定為 0,然後在「工作人員名稱」欄位中輸入名稱。

工作人員名稱
WorkerName string

工作人員的名稱。 這會導致 Orchestrator 在其背景工作角色清單中搜尋具有指定名稱的背景工作角色。 依名稱搜尋時,將「Worker ID」設定為 0 (以停用使用 Worker Id)。

維護模式
MaintenanceMode boolean

設定為 true (預設值) 以啟用維護模式,因此不會將流程指派給背景工作者。 設定為 false 以離開維護模式,允許將流程指派給背景工作者 (假設背景工作者未被其他規則拒絕)。

傳回

名稱 路徑 類型 Description
指令結果
SetOrchestratorWorkerMaintenanceModeResult boolean

命令的結果(成功或失敗)。

錯誤訊息
ErrorMessage string

如果指令不成功,則會包含傳回的錯誤訊息。

設定 Orchestrator 自動化工作輸出資料

設定 Orchestrator 自動化工作的輸出資料。 當您已完成任務並希望提供輸出資料時,通常會使用,這些資料由建立任務的程序收集。

參數

名稱 機碼 必要 類型 Description
任務標識符
TaskId True integer

要新增附註的 Orchestrator 工作識別碼。

任務輸出資料
TaskOutputData string

輸出資料字串。 這可以格式化為您選擇的任何文本格式,例如 JSON 或 XML 或原始文本。 您可以在 Orchestrator UI 中檢視輸出資料字串,或透過 TasksGetTask REST API 存取。

傳回

名稱 路徑 類型 Description
指令結果
TasksSetOutputDataResult boolean

命令的結果(成功或失敗)。

錯誤訊息
ErrorMessage string

如果指令不成功,則會包含傳回的錯誤訊息。

設定下一個躍點 IA-Connect Director

在雙躍點場景中配置下一躍點導向器。 只有在預設 IA-Connect 下一跳導向器設定不合適時,才需要這樣做。

參數

名稱 機碼 必要 類型 Description
已啟用 SOAP
SOAPEnabled boolean

是否應該在下一躍點 Director 上啟用 SOAP 介面?

已啟用 REST
RESTEnabled boolean

是否應該在下一跳Director上啟用REST介面?

已啟用網頁伺服器
WebServerEnabled boolean

是否應該在下一躍點 Director 上啟用 Web 伺服器 (用於裝載 IA-Connect Inspector) ?

director 僅限本地主機
DirectorIsLocalhostOnly boolean

導向器 SOAP 和 REST 介面是否應該只接聽 'localhost'? 這應該設定為 true,因為沒有其他電腦需要與這些介面通訊。

SOAP TCP 連接埠
SOAPTCPPort integer

如果啟用了 SOAP 介面,它應該在哪個 TCP 連接埠上運行(預設為 8002)?

REST TCP 連接埠
RESTTCPPort integer

如果啟用了REST介面,它應該在哪個TCP埠上運行(默認為8002)?

SOAP 使用 HTTPS
SOAPUsesHTTPS boolean

SOAP 介面是否使用 HTTPS(而不是 HTTP)? 如果設定為 True,則第一躍點電腦上需要憑證,以促進 HTTPS。 這可以與用於 REST 的憑證共用。

REST 使用 HTTPS
RESTUsesHTTPS boolean

REST 介面是否使用 HTTPS(而不是 HTTP)? 如果設定為 True,則第一躍點電腦上需要憑證,以促進 HTTPS。 這可以與用於 SOAP 的憑證共用。

依 SessionId 遞增導向器 TCP 連接埠
IncrementDirectorTCPPortBySessionId boolean

若要確保導向器 TCP 連接埠是唯一的 (如果有多個平行會話使用來自同一第一躍點主機的雙躍點),可以將第一躍點會話 ID 新增至導向器 TCP 連接埠。 只有在第一躍點導向器上啟用 SOAP 或 REST 時,才需要這樣做,而且通常不會啟用這些,因為預設會使用具名管道。

SOAP 使用使用者驗證
SOAPUsesUserAuthentication boolean

如果您想要 HTTP SOAP TCP 埠使用使用者鑑別,請設為 True。 請參閱 IA-Connect 安裝指南,以取得如何設定此設定的資訊。

REST 使用使用者驗證
RESTUsesUserAuthentication boolean

如果您希望 HTTP REST TCP 埠使用使用者驗證,請設定為 True。 請參閱 IA-Connect 安裝指南,以取得如何設定此設定的資訊。

已啟用名為管道的命令
CommandNamedPipeEnabled boolean

第一躍點代理程式是否應該使用具名管道與第一躍點導向器通訊? 這是預設的通訊方法。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

設定剪貼簿

在 IA-Connect 客服專員使用者工作階段中設定剪貼簿的內容。

參數

名稱 機碼 必要 類型 Description
新的剪貼簿資料
NewClipboardData string

要在剪貼簿中設定的資料。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

設定滑鼠乘數

在 IA-Connect 代理程式使用者工作階段中設定全域滑鼠乘數。 如果您在開發過程中遇到遠端桌面擴展問題,這會很有用。

參數

名稱 機碼 必要 類型 Description
X 乘數
MouseXMultiplier double

要設定的水平 (X) 全域滑鼠乘數 (當代理程式移動滑鼠時)。 乘數僅在禁用“多顯示器功能”時才有任何效果。

Y 乘數
MouseYMultiplier double

要設定的垂直 (Y) 全域滑鼠乘數 (當代理程式移動滑鼠時)。 乘數僅在禁用“多顯示器功能”時才有任何效果。

申請 mouse_event
ApplyToMouseEvent boolean

此引數指定是否要將全域滑鼠乘數值套用至 mouse_event 方法。

套用至 SetCursorPos
ApplyToSetCursorPos boolean

此引數會指定是否要將全域滑鼠乘數值套用至 SetCursorPos 方法。

套用至目前滑鼠移動方法
ApplyToCurrentMouseMoveMethod boolean

此引數指定是否要將全域滑鼠乘數值套用至目前的滑鼠移動方法 (例如:如果 SetCursorPos 是目前的滑鼠移動方法,則乘數會套用至 SetCursorPos)。 如果設定為 true,則會忽略輸入 'Apply to mouse_event' 和 'Apply to SetCursorPos'。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

設定滑鼠游標位置

將 IA-Connect 代理程式使用者階段作業中的滑鼠游標設定為指定位置。 setcursorpos API 可用來移動滑鼠,而不論所選擇的作用中滑鼠移動 API 為何。

參數

名稱 機碼 必要 類型 Description
X 像素
X True integer

X 座標值 (以像素為單位)。

Y 像素
Y True integer

Y 座標值 (以像素為單位)。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

設定滑鼠移動方式

將目前的滑鼠移動方法設定為 mouse_event 或 setcursorpos。

參數

名稱 機碼 必要 類型 Description
設定滑鼠移動方式
MouseMoveMethod True string

提供滑鼠移動方法(mouse_event或setcursorpos)。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

設定螢幕助讀程式

啟用或停用 IA-Connect Agent 使用者工作階段中的螢幕助讀程式。

參數

名稱 機碼 必要 類型 Description
啟用螢幕助讀程式
EnableScreenReader boolean

如果設定為 true,則會啟用螢幕助讀程式。 如果設定為 false,則螢幕助讀程式將會停用。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

設定預設印表機

在 IA-Connect 代理程式工作階段中為使用者設定預設印表機。

參數

名稱 機碼 必要 類型 Description
預設印表機名稱
DefaultPrinterName True string

使用者預設印表機的名稱。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

變更 Orchestrator 自動化工作狀態

變更選取的 Orchestrator 自動化工作狀態或其他工作內容。

參數

名稱 機碼 必要 類型 Description
任務標識符
TaskId True integer

要修改的 Orchestrator 工作識別碼。

自動化任務新狀態
AutomationTaskStatus string

指定自動化任務的新任務狀態,如果您不想變更現有任務的狀態,請保留空白。 如果您想要延遲現有工作,請改用動作 [延遲現有的 Orchestrator 自動化工作]。

將工作擱置
TaskOnHold boolean

指定任務的「保留」狀態。 只有新的或延遲的工作可以保留,因此如果您嘗試將任何其他工作狀態置於保留狀態,則會引發例外狀況。

清除任務輸入資料
EraseTaskInputData boolean

如果您將此值設定為 true,則會清除任何作業輸入資料。 這通常用於為已完成或失敗的任務節省儲存空間,因為不再需要原始資料。

清除延遲儲存的資料
EraseDeferralStoredData boolean

如果您將此值設定為 true,則會清除任何延遲儲存的資料。 這通常用於為已完成或失敗的任務節省儲存空間,因為不再需要原始資料。

更新來源系統
UpdateSourceSystem boolean

如果您將此值設定為 true,且 Orchestrator 工作已連結至來源系統 (例如 ServiceNow),則 Orchestrator 會執行 Orchestrator 的來源系統組態中指定的任何動作 (例如,關閉票證)。

任務關閉原因
TaskClosureReason string

為「已完成」或「失敗」任務提供任務關閉原因,這些任務將儲存在任務中。 此外,如果 Orchestrator 工作連結至來源系統 (例如 ServiceNow),則您要變更狀態,且「更新來源系統」設定為 true,則原因也會傳遞至來源系統 (例如,作為 ServiceNow 工作筆記)。 只有已完成或失敗的工作才能有關閉原因,因此如果您嘗試為任何其他任務狀態設定關閉原因,則會引發例外狀況。

傳回

名稱 路徑 類型 Description
指令結果
TasksChangeTaskStatusResult boolean

命令的結果(成功或失敗)。

錯誤訊息
ErrorMessage string

如果指令不成功,則會包含傳回的錯誤訊息。

轉動滑鼠滾輪

轉動 IA-Connect 代理程式使用者工作階段中的滑鼠滾輪 (正或負凹口)。

參數

名稱 機碼 必要 類型 Description
車輪轉動
WheelTurns True integer

要執行的車輪轉數。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

轉換矩形座標

將矩形圖元座標從虛擬轉換成實體,或將實體轉換成虛擬。 如果您想轉換一個點,只需設定右=左和底部=上即可。 實體座標會直接對應至監視器上的像素。 虛擬座標是 DPI 縮放的。 如果所有顯示裝置的底層顯示縮放比例為 100%,則實體座標和虛擬座標都相同。

參數

名稱 機碼 必要 類型 Description
矩形左邊緣螢幕像素X座標
RectangleLeftPixelXCoord True integer

要轉換的矩形的左圖元邊緣。 可以是虛擬或實體像素,視轉換類型而定。

矩形上緣螢幕像素 Y 座標
RectangleTopPixelYCoord True integer

要轉換的矩形的上端像素邊緣。 可以是虛擬或實體像素,視轉換類型而定。

矩形右邊緣螢幕像素 X 座標
RectangleRightPixelXCoord True integer

要轉換的矩形的右圖元邊緣。 可以是虛擬或實體像素,視轉換類型而定。

矩形底緣螢幕像素Y座標
RectangleBottomPixelYCoord True integer

要轉換的矩形的底部像素邊緣。 可以是虛擬或實體像素,視轉換類型而定。

轉換類型
ConversionType True string

轉換類型:從實體到虛擬 (PhysicalToVirtual 或 P2V) 或虛擬到實體 (VirtualToPhysical 或 V2P)。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
轉換後的矩形左邊緣螢幕像素 X 座標
ConvertedRectangleLeftPixelXCoord integer

轉換後矩形的左圖元邊緣。 可以是虛擬或實體像素,視轉換類型而定。

轉換後的矩形上緣螢幕像素 Y 座標
ConvertedRectangleTopPixelYCoord integer

轉換後矩形的頂端像素邊緣。 可以是虛擬或實體像素,視轉換類型而定。

轉換後的矩形右邊緣螢幕像素 X 座標
ConvertedRectangleRightPixelXCoord integer

轉換後矩形的右圖元邊緣。 可以是虛擬或實體像素,視轉換類型而定。

轉換後的矩形底緣螢幕像素 Y 座標
ConvertedRectangleBottomPixelYCoord integer

轉換後矩形的底部像素邊緣。 可以是虛擬或實體像素,視轉換類型而定。

轉換後的矩形寬度
ConvertedRectangleWidth integer

轉換後矩形的寬度 (以像素為單位)。 可以是虛擬或實體像素,視轉換類型而定。

轉換後的矩形高度
ConvertedRectangleHeight integer

轉換後矩形的高度 (以像素為單位)。 可以是虛擬或實體像素,視轉換類型而定。

連接至第 1 層 IA-Connect 階段作業

附加至接收 SOAP 和/或 REST 訊息的導向器的 IA-Connect 導向器會話。 這是將命令傳送到 IA-Connect 代理程式的階段作業。

參數

名稱 機碼 必要 類型 Description
必須連接虛擬通道
VirtualChannelMustBeConnected boolean

IA-Connect 導向器在連結至會話時,是否應該驗證虛擬通道已連線? 這可確保 IA-Connect 代理程式在指定的工作階段中執行。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
附加的第 1 層 IA-Connect 工作階段名稱
AttachedTier1IAConnectSessionName string

已連線至的第 1 層 IA-Connect 階段作業的名稱。

重設 IA-Connect 指令統計資料

重設目前儲存的任何統計資料,以瞭解 IA-Connect Agent 在目前階段作業中執行的命令。

參數

名稱 機碼 必要 類型 Description
Workflow
Workflow True string

在此處新增下列運算式:workflow()

重設下一個躍點 IA-Connect 導向器設定

重設任何已設定的自訂 IA-Connect Director 設定,並恢復預設設定。

參數

名稱 機碼 必要 類型 Description
Workflow
Workflow True string

在此處新增下列運算式:workflow()

鎖定工作階段

鎖定 IA-Connect Agent 正在執行的工作階段。

參數

名稱 機碼 必要 類型 Description
在動作閒置分鐘後鎖定
LockAfterMinutesOfActionInactivity integer

如果設定為大於 0 的值,代理程式不會立即鎖定,而是會在指定的動作閒置分鐘數 (代理程式未收到任何動作) 後鎖定。 這會阻止代理程式在有許多連續執行的流程時持續鎖定和解除鎖定。 設定為 0 可立即鎖定。 預設值為 5 分鐘。

鎖定後等待的秒數
SecondsToWaitAfterLock integer

鎖定後,等待指定的秒數。 這可讓工作階段有時間完全鎖定。 如果您預期鎖定後立即發生解鎖事件(即另一個會話啟動)的可能性,如果前一個會話仍在鎖定,則通常會使用此功能。 僅當「動作閒置分鐘後鎖定」設定為 0 (導致立即鎖定) 時才使用。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
指令結果
LockSessionResult boolean

命令的結果(成功或失敗)。

錯誤訊息
ErrorMessage string

如果指令不成功,則會包含傳回的錯誤訊息。

關閉 IA-Connect 代理程式

關閉 IA-Connect 代理程式。 這不會影響執行 IA-Connect Agent 的使用者工作階段。

參數

名稱 機碼 必要 類型 Description
等待秒數
SecondsToWait integer

在發出關閉指令之前等待的時間,以便 IA-Connect 代理程式可以報告指令的完成。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

附加至最近的 IA-Connect 工作階段

附加至最近連線的 IA-Connect 導向器工作階段 (選擇性地指定類型)。 這是將命令傳送到 IA-Connect 代理程式的階段作業。

參數

名稱 機碼 必要 類型 Description
搜尋 IA-Connect 階段作業類型
SearchIAConnectSessionType string

要搜尋的工作階段類型,例如,任何類型的遠端工作階段的「本機代理程式」、「Microsoft RDP」、「Citrix ICA」或「遠端」。 保留空白以搜尋任何工作階段類型。

等待時間(以秒為單位)
TimeToWaitInSeconds integer

如果沒有指定類型的會話 (如果指定了特定類型) ,IA-Connect 應該等待多長時間?

逾時時引發例外狀況
RaiseExceptionIfTimedout boolean

如果新的會話在逾時期間過後未連線,IA-Connect 是否應該引發例外狀況?

必須連接虛擬通道
VirtualChannelMustBeConnected boolean

IA-Connect 導向器在連結至會話時,是否應該驗證虛擬通道已連線? 這可確保 IA-Connect 代理程式在指定的工作階段中執行。

僅計算以前未見過的工作階段
OnlyCountSessionsNotSeenBefore boolean

如果設為 true,則先前執行的「取得可用的 IA-Connect 工作階段」動作 (或 IA-Connect Inspector 檢視工作階段) 看到的任何工作階段都不會計入索引。 這只允許計算「新」工作階段 (例如,附加到第一個新的 Citrix 工作階段)。

Workflow
Workflow True string

在此處新增下列運算式:workflow()

傳回

名稱 路徑 類型 Description
附加 IA-Connect 工作階段名稱
AttachedIAConnectSessionName string

附加至的 IA-Connect 階段作業的名稱。

附加到工作階段
AttachedToSession boolean

如果 IA-Connect 已附加至會話,則傳回 true,如果沒有,則傳回 false。

雙擊滑鼠左鍵

按兩下 IA-Connect Agent 使用者工作階段中的滑鼠左鍵。

參數

名稱 機碼 必要 類型 Description
延遲(以毫秒為單位)
DelayInMilliseconds integer

每次點擊之間的延遲,以毫秒為單位。

Workflow
Workflow True string

在此處新增下列運算式:workflow()