IM-RPA 利用ガイド 第6版 2022-12-01

IM-RPA 利用ガイド 第6版 2022-12-01

7.2. 設定ファイル

7.2.1. UiPath連携設定

7.2.1.1. 概要

UiPath連携 に関する設定です。
モジュール
UiPath連携
フォーマットファイル(xsd)
WEB-INF/schema/im-uipath-config.xsd
設定場所
WEB-INF/conf/im-uipath-config.xml
<?xml version="1.0" encoding="UTF-8"?>
<im-uipath-config
    xmlns="http://intra-mart.co.jp/uipath/im-uipath-config"
    mlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://intra-mart.co.jp/uipath/im-uipath-config ../schema/im-uipath-config.xsd ">

  <!-- UiPath Automation Cloud版のOrchestratorに接続する場合 -->
  <orchestrator id="default" use-insecure-ssl="true" automation-cloud="true">
    <url>https://cloud.uipath.com/XXXXXXXX</url>
    <tenancyName>DefaultTenant</tenancyName>

    <webhook>
      <secret>[input your secret key]</secret>
    </webhook>
  </orchestrator>

  <!-- オンプレミス版のUiPath Orchestratorに接続する場合 -->
  <orchestrator id="default_on_premises" use-insecure-ssl="true" automation-cloud="false">
    <url>https://xxx.xxx.xxx.xxx/</url>
    <tenancyName>Default</tenancyName>

    <authentication>
      <username>username</username>
      <password>password</password>
    </authentication>

    <webhook>
      <secret>[input your secret key]</secret>
    </webhook>
  </orchestrator>

</im-uipath-config>

7.2.1.2. リファレンス

7.2.1.2.1. テナント別設定

タグ名 orchestrator
テナント毎の UiPath Orchestrator接続に関する設定を定義します。

【設定項目】

<im-uipath-config>
  <orchestrator id="default" use-insecure-ssl="true" automation-cloud="true"></orchestrator>
</im-uipath-config>

必須項目 ×
複数設定
設定値・設定する内容 orchestrator タグを親とするタグ
単位・型 なし
省略時のデフォルト値 なし
親タグ im-uipath-config

【属性】

属性名 説明 必須 デフォルト値
id
テナントID
このタグの設定の対象となるテナントIDを指定してください。
なし
use-insecure-ssl
セキュアでないSSLを利用するか否か
UiPath Orchestratorへの接続に自己署名証明書を用いたhttpsプロトコルを利用する場合は true を設定してください。
× なし
automation-cloud
UiPath Automation Cloud版Orchestratorへ接続するか否か
オンプレミス版のUiPath Orchestratorへ接続する場合は false を、UiPath Automation Cloud版Orchestratorへ接続する場合は true を設定してください。
× false

7.2.1.2.2. URL設定

タグ名 url
UiPath OrchestratorのURLを設定します。

【設定項目】

<im-uipath-config>
  <orchestrator id="default" use-insecure-ssl="true" automation-cloud="true">
    <url>https://xxx.xxx.xxx.xxx/</url></orchestrator>
</im-uipath-config>

必須項目
複数設定 ×
設定値・設定する内容
UiPath OrchestratorのURL
オンプレミス版のUiPath Orchestratorへ接続する場合はホスト名を含むURLを設定してください。
UiPath Automation Cloud版Orchestratorへ接続する場合は、通常以下の形式のURLを設定してください。
https://cloud.uipath.com/<%組織コード%>
単位・型 URL
省略時のデフォルト値 なし
親タグ orchestrator

7.2.1.2.3. テナント名設定

タグ名 tenancyName
UiPath Orchestratorのテナント名を設定します。

【設定項目】

<im-uipath-config>
  <orchestrator id="default" use-insecure-ssl="true" automation-cloud="true">
    <tenancyName>Default</tenancyName></orchestrator>
</im-uipath-config>

必須項目
複数設定 ×
設定値・設定する内容 UiPath Orchestrator上で管理するテナント名
単位・型 文字列
省略時のデフォルト値 なし
親タグ orchestrator

7.2.1.2.4. 認証設定

タグ名 authentication
オンプレミス版UiPath Orchestratorへの接続時の認証設定です。
UiPath Automation Cloud版Orchestratorへ接続する場合は必要ありません。

【設定項目】

<im-uipath-config>
  <orchestrator id="default" use-insecure-ssl="true" automation-cloud="false"><authentication></authentication>
  </orchestrator>
</im-uipath-config>

必須項目 x
複数設定 ×
設定値・設定する内容 authentication タグを親とするタグ
単位・型 なし
省略時のデフォルト値 なし
親タグ orchestrator

7.2.1.2.5. ユーザ名設定

タグ名 username
オンプレミス版UiPath Orchestratorへの接続時のユーザ名設定です。

【設定項目】

<im-uipath-config>
  <orchestrator id="default" use-insecure-ssl="true" automation-cloud="false"><authentication>
      <username>username</username></authentication>
  </orchestrator>
</im-uipath-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 UiPath Orchestratorへ接続する際のユーザ名
単位・型 文字列
省略時のデフォルト値 なし
親タグ authentication

7.2.1.2.6. パスワード設定

タグ名 password
オンプレミス版UiPath Orchestratorへの接続時のパスワード設定です。

【設定項目】

<im-uipath-config>
  <orchestrator id="default" use-insecure-ssl="true" automation-cloud="false"><authentication><password>your password</password>
    </authentication>
  </orchestrator>
</im-uipath-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 UiPath Orchestratorへ接続する際のパスワード
単位・型 文字列
省略時のデフォルト値 なし
親タグ authentication

7.2.1.2.7. Webhook設定

タグ名 webhook
UiPath OrchestratorのWebhookに関する設定です。

【設定項目】

<im-uipath-config>
  <orchestrator id="default" use-insecure-ssl="true" automation-cloud="true"><webhook></webhook>
  </orchestrator>
</im-uipath-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 webhook タグを親とするタグ
単位・型 なし
省略時のデフォルト値 なし
親タグ orchestrator

7.2.1.2.8. シークレット設定

タグ名 secret
UiPath OrchestratorのWebhookに記述するシークレット(共通鍵)の設定です。
UiPath連携機能では、この値を用いてWebhookリクエストの送信元が正しいUiPath Orchestratorであるか検証を行います。

【設定項目】

<im-uipath-config>
  <orchestrator id="default" use-insecure-ssl="true" automation-cloud="true"><webhook>
      <secret>[input your secret key]</secret>
    </webhook>
  </orchestrator>
</im-uipath-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 UiPath OrchestratorのWebhookに記述するシークレット
単位・型 文字列
省略時のデフォルト値 なし
親タグ webhook

7.2.2. OAuthプロバイダ設定

7.2.2.1. 概要

OAuthプロバイダ に関する設定です。
モジュール
UiPath連携
フォーマットファイル(xsd)
WEB-INF/schema/oauth-provider-config.xsd
設定場所
WEB-INF/conf/oauth-provider-config/im-uipath.xml
<?xml version="1.0" encoding="UTF-8"?>
<oauth-provider-config xmlns="http://www.intra-mart.jp/system/oauth/client/config/oauth-provider-config"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.intra-mart.jp/system/oauth/client/config/oauth-provider-config ../schema/oauth-provider-config.xsd ">
  <oauth-providers>
    <oauth-provider id="default">
      <provider-type>uipath</provider-type>
      <name message-cd="CAP.Z.IWP.UIPATH.OAUTH.PROVIDER.NAME">UiPath Automation Cloud API</name>
      <description message-cd="CAP.Z.IWP.UIPATH.OAUTH.PROVIDER.DESCRIPTION">Allows you to use the UiPath Automation Cloud API.</description>
      <icon-path>im_uipath/images/im_uipath.png</icon-path>
      <oauth-config>
        <authz-end-point>https://cloud.uipath.com/identity_/connect/authorize</authz-end-point>
        <token-end-point>https://cloud.uipath.com/identity_/connect/token</token-end-point>
        <client-id>XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX</client-id>
        <client-secret>XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX</client-secret>
        <scope>OR.Jobs OR.Folders OR.Execution OR.Queues offline_access</scope>
      </oauth-config>
      <extra-config />
    </oauth-provider>
  </oauth-providers>
</oauth-provider-config>

7.2.2.2. リファレンス

リファレンスは、「設定ファイルリファレンス」 - 「プロバイダ設定」を参照してください。
以下の箇所を編集する必要があります。
  • oauth-provider タグの id 属性
    UiPath連携設定 内、orchestrator タグの id 属性と一致させてください。
  • client-id タグ
    UiPath Automation Cloudに登録した外部アプリケーションの「アプリケーションID」を指定してください。
  • client-secret タグ
    UiPath Automation Cloudに登録した外部アプリケーションの「アプリ シークレット」を指定してください。