IBM Interact Outbound Gateway for IBM Universal Behavior Exchange の使用
IBM® Interact Outbound Gateway for IBM Universal Behavior Exchange を使用するには、Interact、UBX、およびゲートウェイを構成する必要があります。
以下の構成を構成の一例として使用してください。
UBX をアウトバウンド・チャネルとして使用する場合、Interact は、UBX にイベントをパブリッシュするパブリッシャー・タイプのエンドポイントとして機能します。UBX から、それらのイベントをサブスクライバーに送信できます。
構成を始める前に、ホスト・マシンへのアウトバウンド・アクセスを要求してください。ホスト・マシンへのネット経由のアクセスを可能にする必要があります。
UBX でのエンドポイントとイベントの登録
- UBX で、「エンドポイント」タブに移動します。「新規エンドポイントの登録」をクリックして認証鍵を取得します。パブリッシャー・エンドポイントとイベント追加には、UBX から生成された認証鍵を使用する必要があります。サブスクライバー・エンドポイント用に、UBX で新しい認証鍵を生成する必要があります。鍵を書き留めておいてください。
- パブリッシャー・エンドポイントを登録します。
- REST API クライアント・ツールを開きます。
- メソッドとして PUT を選択します。
- 次のヘッダーを指定します。
Content-Type : application/json Accept-Charset : UTF-8 Authorization : Bearer 520301d7-7855-4ea7-b19d-0b395c1e6ae4 (authKey generated in UBX)
- 次の URL を指定します。
URL: https://ubx-qa1-api.adm01.com/v1/endpoint
- 本文に、パブリッシャー・エンドポイントの適切な名前を指定します。
以下に例を示します。
{ "name":"Interact_Publisher", "description":"Endpoint for server created on 30thJan", "providerName":"IBM", "url":"", "endpointTypes":{ "event":{ "source":{ "enabled":true } } }, "marketingDatabasesDefinition":{ "marketingDatabases":[ { "name":"IDSync", "identifiers":[ { "name":"interactprofileid", "type":"INTERACTID" } ] } ] } }
- イベントを登録します。本文で渡す [イベント] コードを書き留めておいてください。これは ubxContentMapping.properties ファイルにマッピングされる必要があります。これには大/小文字の区別があります。
- REST API クライアント・ツールを開きます。
- メソッドとして POST を選択します。
- 前の手順でエンドポイントに使用したものと同じヘッダーを指定します。
- 次の URL を指定します。
URL: https://ubx-qa1-api.adm01.com/v1/eventtype
- 本文では、イベントの適切な名前を指定します。
以下に例を示します。
{ "name": "recommendedOffer", "description": "recommended contact frm UBX", "code": "recommendedOffer"}
注: 渡されたイベント・コードは、ubxContentMapping.properties ファイルでマップされていなければなりません。イベント・コードには大/小文字の区別があります。
- サブスクライバー・エンドポイントを追加します。
- REST API クライアント・ツールを開きます。
- メソッドとして PUT を選択します。
- 前の手順でエンドポイントに使用したものと同じヘッダーを指定します。
- サブスクライバー・エンドポイントを登録するために、UBX で新しい認証鍵を作成します。
- 次の URL を指定します。
URL: https://ubx-qa1-api.adm01.com/v1/endpoint
- 本文に、パブリッシャー・エンドポイントの適切な名前を指定します。
以下に例を示します。
{ "name":"UBX_Subscriber", "description":"UBX_Subscriber for Subscribing Events ", "providerName":"IBM", "url":"http://ubxeventconsumer.mybluemix.net/ubxeventconsumer", "endpointTypes":{ "event":{ "source":{ "enabled":true }, "destination":{ "enabled":true, "url":"http://ubxeventconsumer.mybluemix.net /ubxeventconsumer", } } }, "marketingDatabasesDefinition": { "marketingDatabases":[ { "name":"IDSync", "identifiers":[ { "name":"interactprofileid", "type":"INTERACTID" } ] } ] }
- パブリッシャーとサブスクライバーのエンドポイント、およびイベントを追加したら、UBX でパブリッシャーのイベントをサブスクライバーにサブスクライブさせる必要があります。
- UBX で、「イベント」タブの「イベントをサブスクライブ」をクリックします。
- イベントと宛先を選択します。
- 「サブスクライブ」をクリックします。
Interact およびゲートウェイの構成
- Interact | triggeredMessage | gateways 構成プロパティーで、UBX ゲートウェイを追加します。ClassPath を file:///root/opt/OMO/lib/OMO_OutboundGateway_UBX.jar に設定し、ClassName を次の値に設定します。
com.ibm.interact.offerorchestration.outboundgateway.ubx. UBXOutboundGateway
- ホスト・マシン上の OMO_OutboundGateway_UBX.zip ファイルを unzip し、解凍されたパス上の UBX jar を指すようにします。
- Interact | triggeredMessage | gateways | [gatewayName] | Parameter Data で、OMO-conf_outbound_common_httpConnectionConfig をパラメーターとして追加します。「値」を file:///opt/Interact<version>/Interact/OMO/conf/outbound/common/httpConnectionConfig.properties に設定します。これは、Interact のインストール・ディレクトリーです。ゲートウェイ・インストーラーは、Interact がインストールしたディレクトリーにゲートウェイ・ディレクトリーをダウンロードします。
Interact のフォルダーの httpConnectionConfig.properties ファイルに、タイムアウトを指定します。
以下に例を示します。
HTTP 接続を使用するように OMO が構成されている場合、オプションで HTTP プロキシを Interactとエンドポイント間の認証を使用して構成することができます。アウトバウンド・ゲートウェイのプロキシーを有効にするには、次のプロパティーの値を更新します。connectTimeoutMs=180000
proxyHost=<プロキシー・サーバーの IP アドレス>
proxyPort=<プロキシー・サーバーのリスニング・ポート>
targetUsername=<プロキシー・サーバーに接続するためのユーザー名。認証が必要ない場合はブランクのまま>
targetPassword=<プロキシー・サーバーに接続するためのパスワード。認証が必要ない場合はブランクのまま> - Interact | triggeredMessage | gateways | [gatewayName] | Parameter Data で、OMO-conf_outbound_ubx_ubxConfig をパラメーターとして追加します。「値」を、Interact フォルダー内の ubxConfig.properties ファイルのパスに設定します。
ubxConfig.properties ファイルで、ubxURL、authKey、および interactProfileIdFieldName を指定します。
以下に例を示します。authKey=912586bf-190d-48f9-8488-26f1bf532ef3 [Auth Key used to register publisher endpoint and event in UBX] interactProfileIdFieldName=interactprofileid [Field name from the ubxContentMapping.properties file]
- Interact | triggeredMessage | gateways | [gatewayName] | Parameter Data で、OMO-conf_outbound_ubx_ubxContentAdditionalAttributes をパラメーターとして追加します。「値」を、Interact フォルダー内の ubxContentAdditionalAttributes.properties ファイルのパスに設定します。
- Interact | triggeredMessage | gateways | [gatewayName] | Parameter Data で、OMO-conf_outbound_ubx_ubxContentMapping をパラメーターとして追加します。「値」を、Interact フォルダー内の ubxContentMapping.properties ファイルのパスに設定します。
ubxContentMapping.properties ファイル内の interactprofileid と eventName の値を更新します。
イベント名は 3 つの形式で指定できます。二重引用符で囲まれた値は、静的な値になります。offer.offerAttributeName 形式の値は、オファー属性 offerAttributeName にマップされます。profile.profileAttributeName 形式の値は、プロファイル属性 profileAttributeName にマップされます。イベント名の値は、UBX でイベントの登録に使用したコードと一致しなければなりません。これには大/小文字の区別があります。
以下に例を示します。
eventName="abandoned_shopping_carts" eventName=offer.Card eventName=profile.EMAIL
- Interact | triggeredMessage | channel 構成プロパティーで、チャネルを追加します。
- Campaign | partitions | partition [n] |Interact | outboundChannels で、設計時と同じチャネルを定義します。
- アプリケーション・サーバーを再始動します。
- イベント名を使用して、これまでの手順で追加したチャネルを使用するトリガー・メッセージ・ルールを作成します。
- 対話式チャネルを配置します。
- API テスト・クライアントから、トリガー・メッセージ・ルールが構成された対話式チャネルのセッションを開始し、UBX に向けてオファーをトリガーするイベント通知を開始します。