BMC Remedy Connector - Mule 4

BMC Remedy Connector v3.0

BMC Remedy 用 Anypoint Connector (BMC Connector) は、BMC Remedy AR システム Java API v8.1 で構築されており、BMC Remedy AR システム 7.x 以降と互換性があります。このコネクタは、BMC Remedy AR システムの CRUD 操作を実行する方法を公開します。

BMC Remedy Connector は、BMC Remedy AR システムの組織の情報にアクセスしたり、その情報を更新したりするためのセキュアな入口として Mule アプリケーション内で機能します。

BMC Remedy AR システムに接続するアプリケーションを構築すると、BMC Remedy AR システムが公開するいくつかの操作をアプリケーションから RPC 経由で実行できます。

リリースノート: 『BMC Remedy Connector リリースノート』
Exchange: BMC Remedy AR システムコネクタ Leaving the Site

始める前に

この情報を使用するには、BMC Remedy API、Mule、Anypoint Connector、Anypoint Studio、Mule の概念、Mule フローの要素、グローバル要素に精通している必要があります。

BMC Remedy Connector を使用するには、以下が必要になります。

BMC Remedy AR システム - BMC Remedy AR サーバーインスタンス v7.x 以降。コネクタは、BMC Remedy AR サーバー v9.1 インスタンスに対してテストされています。このドキュメントの「関連情報」セクションの「BMC インストール手順」リンクを参照してください。
BMC Remedy AR システム Java API v8.1 - このドキュメントの「関連情報」セクションのリンクを使用してダウンロードできます。

POM ファイル情報

<dependency>
  <groupId>org.mule.connectors</groupId>
  <artifactId>mule-remedy-connector</artifactId>
  <version>x.x.x</version>
  <classifier>mule-plugin</classifier>
</dependency>xml

x.x.x を使用しているコネクタに対応するバージョンに置き換えます。

最新の pom.xml ファイル情報を取得するには、 Anypoint Exchange Leaving the Site でコネクタにアクセスし、[Dependency Snippets (連動関係スニペット)] をクリックします。

Studio プロジェクトへのコネクタの追加

Anypoint Studio には、Studio プロジェクトにコネクタを追加する 2 つの方法があります。Studio タスクバーの Exchange ボタンから追加するか、[Mule Palette (Mule パレット)] ビューから追加します。

Exchange を使用してコネクタを追加する

Studio で Mule プロジェクトを作成します。
Studio タスクバーの左上にある Exchange アイコン (X) をクリックします。
Exchange で、[Login (ログイン)] をクリックし、Anypoint Platform のユーザー名とパスワードを指定します。
Exchange で、「BMC」を検索します。
コネクタを選択して [Add to project (プロジェクトに追加)] をクリックします。
画面の指示に従ってコネクタをインストールします。

Studio でコネクタに追加する

Studio で Mule プロジェクトを作成します。
[Mule Palette (Mule パレット)] ビューで、[(X) Search in Exchange ((X) Exchange 内を検索)] をクリックします。
[Add Modules to Project (モジュールをプロジェクトに追加)] で、検索項目に「BMC」と入力します。
[Available modules (使用可能なモジュール)] で、このコネクタの名前をクリックします。
[Add (追加)] をクリックします。
[Finish (完了)] をクリックします。

Studio で設定する

キャンバスの下部にある [Global Elements (グローバル要素)] タブをクリックします。
[Global Mule Configuration Elements (グローバル Mule 設定要素)] 画面で、[Create (作成)] をクリックします。
[Choose Global Type (グローバル種別の選択)] ウィザードで、[Connector Configuration (コネクタ設定)] を展開し、[Remedy Configuration (Remedy 設定)] を選択し、[OK] をクリックします。

以下の説明に従ってパラメーターを設定します。

パラメーター	説明
Name (名前)	参照する設定の名前を入力します。
Username (ユーザー名)	ユーザー名を入力します。
Password (パスワード)	パスワードを入力します。
サーバー	ログイン要求を処理する AR サーバーの IP アドレスを入力します。
Server Port (サーバーポート)	要求を処理するように AR サーバーが設定されているポート番号を入力します。
認証	認証文字列の別名を入力します。認証文字列の別名を使用して、ユーザーの正しい認証ドメインを識別できます。
Locale (ロケール)	ロケールを入力します。

パラメーター

説明

Name (名前)

参照する設定の名前を入力します。

Username (ユーザー名)

ユーザー名を入力します。

Password (パスワード)

パスワードを入力します。

サーバー

ログイン要求を処理する AR サーバーの IP アドレスを入力します。

Server Port (サーバーポート)

要求を処理するように AR サーバーが設定されているポート番号を入力します。

認証

認証文字列の別名を入力します。認証文字列の別名を使用して、ユーザーの正しい認証ドメインを識別できます。

Locale (ロケール)

ロケールを入力します。

プレースホルダー値は、プロジェクトの src/main/resources フォルダーにある設定ファイル mule-artifact.properties を参照します。ログイン情報をグローバル設定プロパティに入力するか、それらの値を含む設定ファイルを参照することができます。メンテナンスをシンプルにして、プロジェクトを再利用できるようにするために、設定ファイルを使用することをお勧めします。これらの値を別個のファイルに保存しておくと、アクセスログイン情報が異なるさまざまな環境 (本番、開発、QA など) にデプロイする必要がある場合に便利です。

[Reconnection Strategy (再接続戦略)] が含まれる [Advanced (詳細)] タブはデフォルトエントリのままにします。
[Test Connection (接続をテスト)] をクリックして、グローバル設定のパラメーターが正しいことと、Mule から BMC Remedy AR システムのインスタンスに正常に接続できることを確認します。
[OK] をクリックして、グローバルコネクタ設定を保存します。
設定は次のようになります。

XML と Maven のサポート

Studio でプロジェクトにコネクタを追加すると、名前空間、スキーマの場所、および POM ファイル情報が自動的に作成されます。Studio を使用せずに Mule アプリケーションを作成する場合は、次の情報を使用します。

名前空間: http://www.mulesoft.org/schema/mule/remedy
スキーマの場所: http://www.mulesoft.org/schema/mule/remedy/current/mule-remedy.xsd

POM ファイル情報:

<dependency>
  <groupId>com.mulesoft.connectors</groupId>
  <artifactId>mule-bmc-remedy-connector</artifactId>
  <version>x.x.x</version>
  <classifier>mule-plugin</classifier>
</dependency>xml

x.x.x を使用しているコネクタに対応するバージョンに置き換えます。

ユースケース: ユーザーの作成

この Mule フローでは、Create 操作を使用して、BMC Remedy AR システムのユーザーを作成します。

Anypoint Studio で新しい Mule プロジェクトを作成します。
次のプロパティを mule-artifact.properties ファイルに追加して Remedy ログイン情報を保持し、このファイルをプロジェクトの src/main/resources ディレクトリに置きます。
```
config.username=<Username>
config.password=<Password>
config.server=<Server>
config.serverPort=<Server Port>text
```

HTTP Listener コンポーネントをキャンバスにドラッグし、次のパラメーターを設定します。

パラメーター	値
Display Name (表示名)	HTTP
Extension Configuration (拡張機能設定)	まだ HTTP リスナー設定が作成されていない場合は、プラス記号をクリックして新しい HTTP リスナー設定を追加します。[Host (ホスト)] に localhost、[Port (ポート)] に 8081 の値を指定します。
Path (パス)	/createUser

パラメーター

値

Display Name (表示名)

HTTP

Extension Configuration (拡張機能設定)

まだ HTTP リスナー設定が作成されていない場合は、プラス記号をクリックして新しい HTTP リスナー設定を追加します。[Host (ホスト)] に localhost、[Port (ポート)] に 8081 の値を指定します。

Path (パス)

/createUser

[Transform Message] コンポーネントを HTTP リスナーの横にドラッグし、必要なデータを指定します。

データマッピングは次のようになります。
[Mule Palette (Mule パレット)] から Remedy Connector の [Create] 操作を [Transform Message] コンポーネントの横にドラッグします。
新しい Remedy グローバル要素を追加することで Remedy Connector を設定します。[Connector Configuration (コネクタ設定)] 項目の横にあるプラス記号をクリックします。

以下の表に従ってグローバル要素を設定します。

パラメーター説明値

パラメーター	説明	値
Name (名前)	参照する設定の名前を入力します。	`<Configuration_Name>`
Username (ユーザー名)	ユーザー名を入力します。	`${config.username}`
Password (パスワード)	パスワードを入力します。	`${config.password}`
サーバー	ログイン要求を処理する AR サーバーの IP を入力します。	`${config.server}`
Server Port (サーバーポート)	要求を処理するように AR サーバーが設定されているポート番号を入力します。	`${config.serverPort}`

Name (名前)

参照する設定の名前を入力します。

<Configuration_Name>

Username (ユーザー名)

ユーザー名を入力します。

${config.username}

Password (パスワード)

パスワードを入力します。

${config.password}

サーバー

ログイン要求を処理する AR サーバーの IP を入力します。

${config.server}

Server Port (サーバーポート)

要求を処理するように AR サーバーが設定されているポート番号を入力します。

${config.serverPort}

設定は次のようになります。

対応する XML 設定は次のようになります。

<remedy:config name="Remedy_Configuration" doc:name="Remedy Configuration">
	<remedy:basic-connection
	username="${config.username}"
	password="${config.password}"
	server="${config.server}"
	serverPort="${config.serverPort}" />
</remedy:config>xml

[Test Connection (接続をテスト)] をクリックして、Mule が BMC Remedy AR システムインスタンスに接続できることを確認します。正常に接続できた場合は、[OK] をクリックして設定を保存します。そうでない場合は、見直して、誤ったパラメーターを修正してからもう一度テストします。

Remedy の Create 操作のプロパティエディターで、残りのパラメーターを設定します。

パラメーター値

パラメーター	値
Display Name (表示名)	Create (作成) (または他の任意の名前)。
Extension Configuration (拡張機能設定)	Remedy_Configuration - 作成したグローバル要素への参照名。
Remedy Form Type (Remedy フォーム種別)	User (ユーザー) - 作成するフォーム種別。
エントリ	`#[payload]`

Display Name (表示名)

Create (作成) (または他の任意の名前)。

Extension Configuration (拡張機能設定)

Remedy_Configuration - 作成したグローバル要素への参照名。

Remedy Form Type (Remedy フォーム種別)

User (ユーザー) - 作成するフォーム種別。

エントリ

#[payload]

Create 操作の後に Logger コンポーネントを追加して、Mule コンソールの Create 操作から生成される ID を出力します。以下の表に従って Logger を設定します。

パラメーター値

Display Name (表示名)

Logger (ロガー) (または他の任意の名前)

Message (メッセージ)

#[payload]

レベル

INFO
プロジェクトを保存し、Mule アプリケーションとして実行します。Package Explorer でプロジェクトを右クリックし、[Run As (別のユーザーとして実行)] > [Mule Application (Mule アプリケーション)] をクリックします。
ブラウザーを開き、URL http://localhost:8081/createUser を入力して応答を確認します。生成された ID がブラウザーや Mule コンソールに表示されます。

パラメーター	値
Display Name (表示名)	Logger (ロガー) (または他の任意の名前)
Message (メッセージ)	`#[payload]`
レベル	INFO

ユースケース (XML) - ユーザーの作成

<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:remedy="http://www.mulesoft.org/schema/mule/remedy"
	xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
	xmlns:dw="http://www.mulesoft.org/schema/mule/ee/dw"
	xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns="http://www.mulesoft.org/schema/mule/core"
	xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="
http://www.mulesoft.org/schema/mule/ee/dw
http://www.mulesoft.org/schema/mule/ee/dw/current/dw.xsd
http://www.mulesoft.org/schema/mule/http
http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
http://www.mulesoft.org/schema/mule/core
http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/ee/core
http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
http://www.mulesoft.org/schema/mule/remedy
http://www.mulesoft.org/schema/mule/remedy/current/mule-remedy.xsd">

<configuration-properties file="mule-artifact.properties"/>
	<http:listener-config name="HTTP_Listener_config"
	doc:name="HTTP Listener config">
		<http:listener-connection host="localhost" port="8081" />
	</http:listener-config>

<remedy:config name="Remedy_Configuration" doc:name="Remedy Configuration">
    <remedy:basic-connection
    username="${config.username}"
    password="${config.password}"
    server="${config.server}"
    serverPort="${config.serverPort}" />
</remedy:config>
	<flow name="create-user-flow">
        <http:listener config-ref="HTTP_Listener_config"
        path="/createUser" doc:name="HTTP"/>
		<ee:transform doc:name="Transform Message">
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/java
---
[{
	"2": "Submitter1",
	"7": "Current",
	"8": "Short description1",
	"Login Name": "Mule_soft"
}]]]></ee:set-payload>
			</ee:message>
		</ee:transform>
		<remedy:create config-ref="Remedy_Configuration" type="User" doc:name="Create">
        </remedy:create>
        <logger message="#[payload]" level="INFO" doc:name="Logger"/>
    </flow>
</mule>xml
コンテンツを展開する