Automation Anywhere

Automation Anywhere

關閉內容

內容

開啟內容

用於匯入和匯出工作負載管理組態設定的 API

  • 已更新:5/10/2019

    用於匯入和匯出工作負載管理組態設定的 API

    身為Enterprise 控制室管理員或具有匯入和匯出機器人權限的使用者,您可以匯入和匯出工作負載組態設定,在不同環境中移動已驗證的組態設定。

    例如,您可以將已驗證為立即可用的佇列從預備環境移至生產環境。

    您可以根據貴組織的自動化需求,使用Enterprise 控制室匯出/匯入 REST API 來管理您在不同環境中的自動化,例如開發、測試、驗收和生產等環境。

    功能和優點

    • 工作負載管理模組的角色型存取控制
    • 稽核及追蹤來源和目標環境的合規性

    先決條件

    匯出

    • 如果Enterprise 控制室使用者的認證用於驗證,該使用者必須是管理員或應具有 [匯出機器人] 權限
    • Enterprise 控制室使用者必須是 [佇列管理員],或應該是佇列的 [擁有者] 才能匯出特定佇列
    • 由於佇列擁有者、取用者、參與者的詳細資料不是匯出的一部分,因此您需要在匯入後根據需要手動新增這些詳細資料。
    • 用於執行Enterprise 控制室服務的使用者帳戶必須具有要匯出之套件所在資料夾的讀/寫存取權限,亦即可能是網路位置 (共用磁碟機) 或本機電腦的應用程式路徑。

      例如,

      C:\Users\Public\Documents\Server Files\wlm-files\export

    • 一個套件中最多可以匯出 200 個佇列
    • 處於草稿狀態的佇列無法匯出
    • 如果任何佇列匯出失敗,則整個匯出操作將失敗。

    匯入

    • 如果Enterprise 控制室使用者的認證用於驗證,該使用者必須擁有 [匯入機器人] 權限
    • Enterprise 控制室佇列管理員可以匯入所有佇列。
    • 將使用 API 匯入多個機器人的Enterprise 控制室使用者必須具有匯出套件檔案所在之資料夾的讀取 / 寫入存取權限 (由 Automation Anywhere 提供匯出套件檔案),亦即可能是網路位置 (共用磁碟機) 或本機電腦的應用程式路徑。

      例如,

      C:\Users\Public\Documents\Server Files\wlm-files\import

    • 匯入套件的使用者預設會成為匯入佇列的擁有者。根據需要,在匯入的佇列上手動新增 [參與者][取用者] 或其他 [擁有者]
    • 如果任何先前匯入已建立佇列類別,則只要所有資料欄名稱和類型都相符,後續匯入就會使用該佇列類別。

    API 端點

    1. 匯出 - <Enterprise 控制室 URL>/v1/wlm/queues

      例如,https://crdevenv.com:81/v1/wlm/queues

    2. 匯入 - <Enterprise 控制室 URL>/v1/wlm/queues

      例如,

      https://crtestenv.com:82/v1/wlm/queues

    使用 WLM 匯出/匯入 API 的上述端點,您可以匯入和匯出佇列。

    匯出佇列

    使用由 Automation Anywhere 提供的匯出 API 來匯出佇列:

    1. 使用 POST 方法可透過 http(s)://<hostname:port>/v1/authentication 端點來產生權杖。為此,請提供Enterprise 控制室執行個體當做 [伺服器名稱] / [主機名稱] / [IP][連接埠號碼]

      例如,https://crdevenv.com:81/v1/authentication

    2. 使用 POST 方法,並在 Body 資料中陳述認證的參數。

      例如,

      {

      "username":"Mike.Lee",

      "password":"1234567890"

      }

    3. 按一下 [播放]/[開始]/[傳送]
    4. 工作負載匯出 API 將運用使用驗證 API 取得的驗證權杖。此驗證權杖必須當做其中一個標頭輸入傳遞給工作負載匯出 API。
    5. 提供要求參數 X-AuthorizationAcceptqueue-ids 當做標頭。

      例如,

      {

      "X-Authorization":"authorization token issued by Enterprise 控制室 after login",

      "Accept":"application/json/file",

      "queue-ids":"1,2,3,4,5"

      }

    6. 按一下 [播放]/[開始]/[傳送]
    7. 當回應狀態為 [200 OK] 時,表示動作成功。
    8. 從回應框架中複製套件名稱。您可以使用它來匯入佇列套件。
      提示: 請確認匯入套件具有正確的副檔名:.wlmpkg

      例如,複製 content-disposition 中所提供的 filename

      cache-control → no-cache, no-store, max-age=0, must-revalidate

      content-disposition → attachment; filename=WorkloadPackage_20180524_180900.wlmpkg

      content-length → 887

      content-type → application/aapkg

      date → Thu, 24 May 2018 12:39:00 GMT

      expires → 0

      pragma → no-cache

      x-frame-options → SAMEORIGIN

    匯入佇列

    當佇列套件成功匯出到網路磁碟機或Enterprise 控制室電腦路徑後,另一個授權使用者可以使用匯入 API 將該套件匯入到不同的Enterprise 控制室

    1. 使用 Post 方法可透過 http(s)://<hostname:port>/v1/authentication 端點來產生權杖。採用 [伺服器名稱] / [主機名稱] / [IP][連接埠號碼] 的形式來提供Enterprise 控制室執行個體。

      例如,https://crtestenv.com:82/v1/authentication

    2. 使用 POST 方法,並在要求本文中陳述認證的參數。

      請參考以下範例:

      {

      "username":"Tom.Watson",

      "password":"1234567890"

      }

    3. 按一下 [播放]/[開始]/[傳送]。
    4. 工作負載匯入 API 將運用使用驗證 API 取得的驗證權杖。此驗證權杖必須當做其中一個標頭輸入傳遞給工作負載匯入 API。
    5. 提供要求參數 X-AuthorizationContent-Type 當做標頭。

      例如,

      "X-Authorization":"authorization token issued by Enterprise 控制室 after login",

      "Content-Type":"multipart/form-data"

    6. 現在提供參數 Content-Disposition:form-data; name="upload"; filename="{file name}",以匯入要求本文中的佇列套件。

      例如,

      Content-Disposition:form-data;

      name="upload"; filename="{WorkloadPackage_20180524_180900.wlmpkg}"

    7. 按一下 [播放]/[開始]/[傳送]。
    8. 當回應狀態為 [200 OK] 時,表示動作成功。

    API 回應碼

    Http(s) 狀態碼 回應 - 說明 更正動作
    200 已成功建立套件 不適用
    400 錯誤的要求參數 使用有效參數重試
    404 找不到檔案 請確認Enterprise 控制室中有顯示佇列
    501 權限錯誤 請確認您具有必要權限

    稽核記錄

    當您匯出或匯入佇列時,Enterprise 控制室[稽核記錄] 頁面上會記錄稽核項目。

    傳送意見反饋