Automation Anywhere

Automation Anywhere

關閉內容

內容

開啟內容

針對機器人生命週期管理匯入和匯出機器人的 API

  • 已更新:5/10/2019
    • 11.3.x
    • 管理
    • Enterprise
    • API 文件

針對機器人生命週期管理匯入和匯出機器人的 API

使用匯入和匯出機器人 API 可自訂組織的機器人生命週期管理解決方案,以提供不中斷的自動化生命週期。

Enterprise 控制室使用者通常必須仰賴Enterprise 控制室以外的方式 (例如電子郵件) 將某個環境的 TaskBot 部署到另一個環境。使用匯出-匯入 API 時,您可以輕鬆引進自訂的機器人生命週期管理 (BLM) 解決方案,進而消除可能會破壞自動化生命週期的所有外部因素。

身為擁有 [匯出機器人][下載機器人] 權限的Enterprise 控制室使用者,您可以匯出機器人和其相依檔案。同樣地,身為具有 [匯入機器人][上傳機器人] 權限的使用者,您可以匯入該機器人和其相依檔案。

例如,您可以將已驗證為立即可用的機器人從預備階段環境移至生產環境。

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

請參閱匯出機器人和匯入機器人等文章,以便從您的Enterprise 控制室使用者介面使用該功能。

功能和優點

  • 機器人生命週期管理的角色型存取控制
  • 自動匯出相依項目 (檔案和機器人)
  • 稽核及追蹤來源和目標環境的合規性
  • 執行成功或是匯入和匯出失敗時的電子郵件通知

匯出

  • 如果Enterprise 控制室使用者的認證用於驗證,該使用者必須擁有 [匯出機器人] 權限
  • 如果Enterprise 控制室使用者的認證用於驗證,該使用者必須擁有機器人[下載] 權限,而且對於 MetaBot 以及要匯出的相依項目至少擁有 [執行] 權限。
  • 如果來源Enterprise 控制室中已啟用版本控制,則必須設定您想要匯出的所有機器人和相依項目的生產版本。
  • 用來執行Enterprise 控制室服務的使用者帳戶必須可存取匯出套件的位置,例如網路位置 (共用磁碟機) 或是位於Enterprise 控制室伺服器電腦上的位置。

匯入

  • 如果Enterprise 控制室使用者的認證用於驗證,該使用者必須擁有 [匯入機器人] 權限
  • 如果Enterprise 控制室使用者的認證用於驗證,該使用者對於機器人以及要匯入的相依項目必須具有 [上傳] 權限。
  • 要執行公用程式以匯入多個機器人的Enterprise 控制室使用者必須可存取 Automation Anywhere 所提供的匯出套件檔案。

API 端點

  • 匯出 - <Enterprise 控制室 URL>/v1/blm/export

    例如,https://crdevenv.com:81/v1/alm/export

  • 匯入 - <Enterprise 控制室 URL>/v1/blm/import

    例如,https://crtestenv.com:82/v1/alm/import

您可以使用 BLM 匯出/匯入 API 的上述端點來匯出及匯入單一機器人以及其所有相依項目。

匯出機器人

使用 Automation Anywhere 提供的匯出 API 來匯出單一機器人以及其相依檔案:

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

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

  2. 使用 Post 方法,並在 Body 資料中陳述認證的參數。請參考以下範例:

    {

    "username":"cradmin",

    "password":"cr@admin"

    }

  3. 按一下 [播放]/[開始]
  4. BLM 匯出 API 將運用使用驗證 API 取得的驗證權杖。此驗證權杖必須當做其中一個標頭輸入傳遞給 BLM 匯出 API。
  5. 在 Body 資料中提供 filePathdestinationPathpackageName 等參數,以匯出機器人。以下清單提供參數說明:
    • filePath - 使用此參數可指定結尾包含您想要匯出之機器人名稱的檔案路徑
    • destinationPath - 使用此參數可指定要儲存匯出套件的目的地路徑
    • packageName - 使用此參數可指定您要指派給匯出套件的套件名稱

      請參考以下範例:

      {

      "filePath":"Automation Anywhere\\My Tasks\\Finance\\Account Reconciliation.atmx",

      "destinationPath":"tempshare\\datashare\\Finance Department",

      "packageName":"Finance package"

      }

  6. 按一下 [播放]/[開始]
  7. 您可以使用多個來源,以便在以下項目中檢視匯出結果:
    • packagePathchecksum 構成的回應資料。
    • [稽核記錄] 頁面 (登陸頁面和詳細資料頁面)
    • 當您收到成功或失敗通知時的電子郵件 (如果有設定的話)

匯入機器人

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

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

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

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

    請參考以下範例:

    {

    "username":"cradmin2",

    "password":"cr@admin"

    }

  3. 按一下 [播放]/[開始]
  4. BLM 匯入 API 將運用使用驗證 API 取得的驗證權杖。此驗證權杖必須當做其中一個標頭輸入傳遞給 BLM 匯入 API。
  5. 當您的認證經過驗證後,請在 Body 資料中提供匯出期間以權杖形式產生的參數,例如 packagepathchecksum

    請參考以下範例:

    {

    "packagePath":"tempshare\\datashare\\Finance Department\\Finance Package_20171221-154403.aapkg",

    "checksum":"ZLyQ+Lbu2N+beEuXf6qd2Qi9uwi3BZxApn57C7mYjKQ="

    }

提示: 您可以複製 BLM 匯出 API 的回應,並當做輸入直接傳遞給 BLM 匯入 API,前提是套件路徑相同,而且可由 BLM 匯入 API 使用者存取。

API 回應碼

Http(s) 狀態碼 回應 - 說明 更正動作
200 已成功建立套件 不適用
400 錯誤的要求參數 使用有效參數重試
404 找不到檔案 確認檔案/機器人存在於Enterprise 控制室
501 權限錯誤 確定您擁有匯出/匯入機器人上傳/下載權限

匯入和匯出 API 公用程式

若要匯入和匯出多個機器人,您可以使用 Automation Anywhere 提供的公用程式,其中包括批次檔案和 jar 檔案*

*Java 版本 1.8 和更高版本。

匯出機器人

您可以使用Enterprise 控制室機器人生命週期管理匯出公用程式,從Enterprise 控制室存放庫匯出多個機器人。這裡解釋使用批次檔案從您的Enterprise 控制室存放庫匯出 TaskBot 的方法:

  1. 開啟 BLM 匯出批次檔案,其中包含從Enterprise 控制室匯出機器人所需的 API 命令和參數。此檔案還提供了易於使用的範例參數。
    註: 此公用程式使用 BLM 匯出 API,在背景中匯出多個機器人。請參考先決條件。BLM 匯出批次檔案
    提示: 建議您在開始匯出程序之前建立批次檔案的複本。
  2. 您現在必須在檔案中提供以下參數,以匯出 TaskBot 和相依檔案
    • 提供Enterprise 控制室執行個體當做 source_CR 參數。

      例如,http://stagingCR-mydomain.com:8081/

    • 提供您的Enterprise 控制室登入認證當做 usernamepassword 參數。

      例如,username:Mike, password:Mike@123

    • 提供 TaskBot 檔案名稱當做 export_files 參數。您可以指定用逗號分隔的多個機器人/檔案。

      例如,Automation Anywhere\\My Tasks\\Finance Bots\\Account Reconciliation_master.atmx,Automation Anywhere\\My Tasks\\Finance REM Bots\\Comparison Data.atmx

    • 提供 TaskBot 存放庫路徑名稱當做 export_directories 參數。如果要從資料夾匯出大量機器人,請使用此選項。

      例如,Automation Anywhere\\My Tasks\\Utilities Bots\\312018, Automation Anywhere\\My Tasks\\Sample Tasks\\Analytics Tasks

    • 提供 CSV 檔案名稱及其路徑當做 export_CSVs 參數。如果要從外部 .csv/.txt 檔案匯出機器人/檔案,請使用此選項。
      • 您可以合併使用檔案名稱、目錄和 .csv 檔案,以便從多個來源匯出多個檔案。

        例如,Automation Anywhere\My Tasks\Finance\Bank Account Reconcilation.atmx, Automation Anywhere\My Tasks\Banking\Audit Certification Generation.atmx, Automation Anywhere\My MetaBots\Import Customer Data.mbot, Automation Anywhere\My Docs\daily sales data.xlsx

      • 您應該至少傳遞一個參數,而不需要的參數則將值保留為空白。

        例如,SET export_CSVs=""

    • 提供套件名稱當做 package_name 參數。此檔案會儲存為壓縮檔案,用於將機器人匯入到另一個Enterprise 控制室執行個體。

      例如,Bank Account Reconciliation

    • 提供套件的目的地路徑當做 package_path 參數。
      註: 這可以是Enterprise 控制室服務使用者應具有寫入權限的共用磁碟機,也可以是Enterprise 控制室電腦路徑。
      例如,\\\\network_share\\BLM Export Packages
  3. 執行批次檔案以啟動匯出命令。
  4. 驗證是否在 package_path 參數指定的位置建立了套件。

    這個套件將由Enterprise 控制室使用者用來將機器人匯入到另一個Enterprise 控制室執行個體。

程式碼範例

SET source_CR=<Enterprise 控制室 URL>

SET username=<Enterprise 控制室使用者名稱>

SET password=<Enterprise 控制室密碼>

SET export_files="<要匯出之機器人的逗號分隔清單>"

SET export_directories="<要匯出之目錄的逗號分隔清單>"

SET export_CSVs="<要匯出其內容之 CSV 的逗號分隔清單>"

SET package_name=<匯出套件的名稱>

SET package_path=<將匯出套件的路徑>

java -jar %utility_path% -Oexport -H%source_CR% -U%username% -P%password% -N%package_name% -K%package_path% -F%export_files% -D%package_path% -C%export_CSVs%

pause

@echo off

REM *****************************參數範例***************************************

REM SET source_CR=http://123.456.78.90:8080

REM SET username=Mike

REM SET password=Mike@123

REM SET export_files="Automation Anywhere\\My Tasks\\Finance Bots\\Account Reconciliation_master.atmx,Automation Anywhere\\My Tasks\\Finance REM Bots\\Comparison Data.atmx"

REM SET export_directories="Automation Anywhere\\My Tasks\\Utilities Bots\\312018"

REM SET export_CSVs="D:\BLM\Account Reconciliation Bots.csv"

REM SET package_name=Bank Account Reconciliation

REM SET package_path=\\\\network_share\\BLM Export Packages

REM SET utility_path=D:\BLM\BLM_Export_Import_Utility-1.0.jar

匯入機器人

您可以使用Enterprise 控制室機器人生命週期管理匯入公用程式,將多個機器人匯入到Enterprise 控制室存放庫。這裡解釋使用批次檔案將 TaskBot 匯入到Enterprise 控制室存放庫的方法:

  1. 開啟 BLM 匯入批次檔案,其中包含將機器人匯入至Enterprise 控制室所需的 API 命令和參數。此檔案還提供了易於使用的範例參數。
    提示: 建議您在開始匯入程序之前建立批次檔案的複本。
  2. 您現在必須在檔案中提供以下參數,以匯入 TaskBot 和相依檔案:
    1. 提供目標Enterprise 控制室執行個體當做 target_CR 參數。

      例如,http://prodCR-mydomain.com:80/

    2. 提供您的Enterprise 控制室登入認證當做 usernamepassword 參數。

      例如,username:John.Smith, password:John@123

    3. 提供匯出套件的絕對路徑名稱當做 package_path 參數。

      例如,\\\\network_share\\BLM Export Packages

  3. 執行批次檔案以啟動匯入命令。
  4. 您可以在 BLM Logs.log 檔案中的已匯出或匯入機器人/檔案清單,驗證機器人是否已匯入到Enterprise 控制室機器人存放庫。此檔案與公用程式 (.jar 檔案) 儲存在相同資料夾中。

程式碼範例

SET target_CR=<目標Enterprise 控制室 URL>

SET username=<Enterprise 控制室使用者名稱>

SET password=<Enterprise 控制室密碼>

SET package_path=<匯出套件的絕對路徑>

java -jar %utility_path% -Oimport -S%package_path% -U%username% -P%password% -H%target_CR%

pause

@echo off

REM *****************************參數範例***************************************

REM SET target_CR=http://987.654.32.10:8080

REM SET username=John

REM SET password=John@123

REM SET package_path=\\\\network_share\\BLM Export Packages

REM SET utility_path=D:\BLM\BLM_Export_Import_Utility-1.0.jar

稽核記錄

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

傳送意見反饋