| Oracle® Enterprise Manager Connectors統合ガイド 12c リリース2 (12.1.0.2) B70511-02 |
|
 前 |
 次 |
この章では、ヘルプ・デスク・コネクタを作成し、Enterprise Managerと統合するために必要な情報を提供します。この章の内容は次のとおりです。
Enterprise Manager Cloud Control 12cには、管理コネクタ・フレームワーク(コネクタ・フレームワークとも呼ばれる)が導入され、開発者はメタデータ(XMLおよびXSL)に基づいてヘルプ・デスク・コネクタを作成できます。
このフレームワークで作成されるヘルプ・デスク・コネクタには、次の機能が継承されます。
自動チケッティング: Enterprise Manager内でインシデントがトリガーされた場合は常に自動的にチケットをオープンまたは更新するよう、コネクタに記述できます。チケットが作成または更新されるようにインシデント・ルールを指定できます。
手動チケッティング: Enterprise Manager内のオープン・インシデントに基づき、Enterprise Managerコンソールから手動でチケットを作成できます。コネクタにより、インシデントおよびチケット・テンプレートに基づいて、チケットに詳細が移入されます。
ユーザー独自のヘルプ・デスク・システムでこれらのチケッティング機能を使用するには、一連のメタデータ・ファイルを提供する必要があります。表1-1にヘルプ・デスク・コネクタの作成に必要なメタデータ・ファイルのカテゴリを示します。
表1-1 メタデータ・ファイルのカテゴリ
| カテゴリ | タイプ | 説明 |
|---|---|---|
|
コネクタ記述子 |
XML |
チケッティング・システムの統合をカスタマイズできます。このファイル内での構成UIページの作成方法をXMLで記述します。 |
|
チケット・リクエスト・テンプレート |
XMLまたはXLS |
イベントのコンテキスト内でのチケットの記入方法を記述します。チケット・テンプレートでは、XSL/XML言語で、チケットの作成および更新時のEnterprise Managerのインシデント・データ・フィールドから対応するチケット・データ・フィールドへのマッピングを説明してします。 |
|
レスポンス・テンプレート |
XSL |
チケッティング・システムWebサービスのレスポンス・データを、チケット・コネクタ・フレームワークに対応した形式に正規化します。 |
チケッティング・コネクタの作成は2ステップのプロセスで、デプロイメント記述子を作成し、データ管理用の適切なテンプレートを準備します。デプロイメント記述子には、次の情報が含まれます。
Enterprise Managerで必要な基本構成パラメータ
コネクタ・フレームワークが外部システムと通信する方法を定義する、Webサービスの仕様
サービス・メソッドの仕様
サービス・メソッドは、メソッド名とWebサービス・エンドポイントをバインドするのに使用します。createTicket、updateTicketおよびgetTicketは、チケッティング・コネクタ用のサポートされているメソッド名です。
テンプレート登録の仕様
テンプレートは、この要素に指定した情報に基づいて登録されます。コネクタ・デプロイメント記述子には、最大50個のテンプレート登録要素で構成されるオプションのリストを指定できます。
SOAPヘッダー認証の仕様
|
注意: コネクタ記述子の名前は、connectorDeploy.xmlにする必要があります。 |
コネクタ記述子XMLファイルを定義して、コネクタ・メタデータおよびコネクタの構成プロパティ(Webサービスのエンドポイントおよび認証スキーマなど)を記述します。
記述子を作成する際の重要な留意点は次のとおりです。
コネクタ記述子ファイル名は、connectorDeploy.xmlにする必要があります。
XMLファイルは、スキーマconnectorDeploy.xsdに準拠する必要があります。
リファレンス実装は、付録A「チケッティング・コネクタのサンプル」のサンプルconnectorDeploy.xmlを参照してください。
次の表では、conenctorDeploy.xsdの各セクションとその実行内容を説明します。
表1-2 コネクション記述子メタデータの詳細
| メタデータ・セクション | 説明 |
|---|---|
<SOAPHeaderAuthentication> <Username required="true"> <VariableName>USERNAME</VariableName> <DisplayName>Remedy Username</DisplayName> </Username> <Password> <VariableName>PASSWORD</VariableName> <DisplayName>Remedy Password</DisplayName> </Password> <AuthVariable> <VariableName>AUTHENTICATION</VariableName> <DisplayName>Authentication</DisplayName> </AuthVariable> <AuthVariable> <VariableName>LOCALE</VariableName> <DisplayName>Locale</DisplayName> </AuthVariable> <AuthVariable> <VariableName>TIMEZONE</VariableName> <DisplayName>Timezone</DisplayName> </AuthVariable> <SOAPHeader> <![CDATA[ <urn:AuthenticationInfo xmlns:urn="urn:HelpDesk_Submit_Service"> <urn:userName>$USERNAME$</urn:userName> <urn:password>$PASSWORD$</urn:password> <urn:authentication>$AUTHENTICATION$</urn:authentication> <urn:locale>$LOCALE$</urn:locale> <urn:timeZone>$TIMEZONE$</urn:timeZone> </urn:AuthenticationInfo> ]]> </SOAPHeader> </SOAPHeaderAuthentication> |
(オプション)このセクションでは、外部システムWebサービスの認証スキーマを記述できます。 EMの「管理コネクタの構成」ページの認証セクションは、このセクションに基づいて生成されます。 ユーザー名、パスワードおよび追加のテキスト・フィールドは、このセクションに基づいて移入されます。
|
<Name>Remedy Service Desk Connector</Name> <Version>12.1.0.1.0</Version> <EMCompatibleVersion>12.1.0.1.0</EMCompatibleVersion> <Description>Remedy Integration with Enterprise Manager</Description> <Category>TicketingConnector</Category> |
コネクタ・タイプの名前要素値とバージョン要素値の組合せにより、EM内のコネクタ・インスタンスは一意に定義されるため、同一のものを定義する際には適切に配慮する必要があります。 EMCompatibleVersion要素は、<release specific value>と同等です。 たとえば、12Cリリースの場合は12.1.0.1.0です。 外部システム統合の要素カテゴリは、次の値のいずれかです。 EventConnector TicketingConnector この場合、値はTicketingConnectorになります。 |
<ConnectivityTestVariable> <VariableName>TICKET_ID</VariableName> <DisplayName>Ticket ID</DisplayName> </ConnectivityTestVariable> |
ConnectivityTestVaiableは、チケッティングの必須要素です。 定義した変数名は、初期構成ステップで接続を検証するためにgetTicketメソッドによって使用されます。 |
<ExternalURL> <Pattern> <![CDATA[http://$WEB_SERVER$/arsys/forms/$ARSERVER_NAME$/$FORM_NAME$/?qual=%27Incident%20Number*%27=%22@Incident_Number@%22]]> </Pattern> <ConfigVariable required="true"> <VariableName>WEB_SERVER</VariableName> <DisplayName>Web Server</DisplayName> </ConfigVariable> <ConfigVariable required="true"> <VariableName>FORM_NAME</VariableName> <DisplayName>HelpDesk Case Form Name</DisplayName> </ConfigVariable> <ConfigVariable required="true"> <VariableName>ARSERVER_NAME</VariableName> <DisplayName>ARServer Name</DisplayName> </ConfigVariable> </ExternalURL> |
このセクションでは、チケット・コネクタ・フレームワークを構成して独自のチケッティング・システムに対するチケットURLを作成できます。 <Pattern>タグの値には、URL文字列と、ARSERVER_NAME、FORM_NAME、WEB_SERVERなどのユーザー構成の変数をその文字列に挿入する方法が記述されます。 各<ConfigVariable>タグのWebconsoleセクションには、テキスト・ボックスとラベルのペアが挿入されます。(図1-2) URLパターン文字列には、各ユーザー変数にユーザーが提供する値が適宜挿入されます。"X"というユーザー変数が存在する場合は、チケットURLが生成される際に、ユーザー入力値で"[X]"が置き換えられます。 |
<Service> <Method>createTicket</Method> <WebServiceEndpoint> <![CDATA[http://[midtier_server]/arsys/services/ARService?server=[servername]&webService=HPD_IncidentInterface_Create_WS]]> </WebServiceEndpoint> </Service> <Service> <Method>updateTicket</Method> <WebServiceEndpoint> <![CDATA[http://[midtier_server]/arsys/services/ARService?server=[servername]&webService=HPD_IncidentInterface_WS]]> </WebServiceEndpoint> </Service> <Service> <Method>getTicket</Method> <WebServiceEndpoint> <![CDATA[http://[midtier_server]/arsys/services/ARService?server=[servername]&webService=HPD_IncidentInterface_get_WS]]> </WebServiceEndpoint> </Service> |
このセクションで、チケッティング・システムWebサービス固有の構成を指定できます。 <WebServiceEndpoint>タグでは、デフォルトのWebサービス・エンドポイント文字列が「管理コネクタ」ページの「Webサービス」セクションに表示されるように記述されます。 メソッドでは、EM固有のサービス名の1つが定義されます。 SoapActionでは、外部システムで呼び出す必要がある操作が定義されます。 詳細は、「サービス定義」を参照してください。 |
<TemplateRegistration> <FileName>getTicket_request.xml</FileName> <InternalName>getTicket</InternalName> <TemplateName>Get Ticket</TemplateName> <TemplateType>OutboundXML</TemplateType> <Description>This is the request xml file for getTicket method</Description> </TemplateRegistration> <TemplateRegistration> <FileName>getTicket_response.xsl</FileName> <InternalName>getTicket</InternalName> <TemplateName>Get Ticket</TemplateName> <TemplateType>InboundXSL</TemplateType> <Description>This is the response xsl file for getTicket method</Description> </TemplateRegistration> <TemplateRegistration> <FileName>createTicket_response.xsl</FileName> <InternalName>createTicket</InternalName> <TemplateName>Create Ticket Reponse</TemplateName> <TemplateType>InboundXSL</TemplateType> <Description>This is the create ticket response template. </Description> </TemplateRegistration> <TemplateRegistration> <FileName>templates/Remedy_DefaultCategory.xsl</FileName> <InternalName>Remedy_DefaultCategory.xsl</InternalName> <TemplateName>Remedy Default Category </TemplateName> <TemplateType>OutboundXSL</TemplateType> <Description>This is the Remdy default category template. </Description> </TemplateRegistration> |
このセクションでは、コネクタ・テンプレートが追加されます。テンプレートには2つのタイプがあります。1.リクエスト・テンプレートおよび2.レスポンス・テンプレート(createTicketメソッドとgetTicketメソッド用)です。 詳細は、「テンプレート定義」を参照してください。 |
<SOAPHeaderAuthentication>
<Username required="true">
<VariableName>USERNAME</VariableName>
<DisplayName>Username</DisplayName>
</Username>
<Password>
<VariableName>PASSWORD</VariableName>
<DisplayName> Password</DisplayName>
</Password>
<AuthVariable> <VariableName>AUTHENTICATION</VariableName> <DisplayName>Authentication</DisplayName>
</AuthVariable>
<AuthVariable>
<VariableName>LOCALE</VariableName>
<DisplayName>Locale</DisplayName>
</AuthVariable>
<AuthVariable>
<VariableName>TIMEZONE</VariableName>
<DisplayName>Timezone</DisplayName>
</AuthVariable>
<SOAPHeader>
<![CDATA[
]]>
</SOAPHeader>
</SOAPHeaderAuthentication>
|
(オプション)このセクションでは、外部システムWebサービスの認証スキーマを記述できます。 EMの「管理コネクタの構成」ページの認証セクションは、このセクションに基づいて生成されます。 ユーザー名、パスワードおよび追加のテキスト・フィールドは、このセクションに基づいて移入されます。 < < |
サポートされているイベント・コネクタ・サービス操作は次のとおりです。
createTicket
外部システムでチケットを作成します。
updateTicket
イベントの更新を外部システムに転送します。
getTicket
Enterprise Managerとのチケット・コネクタの接続を検証するサービス・メソッドです。
コネクタ記述子でのサービス名は、前述で定義した名前と完全に一致する必要があり、大/小文字を区別します。
サービス設定の例を次に示します。
<Service> <Method>createTicket</Method> <WebServiceEndpoint> <![CDATA[http://[midtier_server]/arsys/services/ARService?server=[servername]&webService=HPD_IncidentInterface_Create_WS]]></WebServiceEndpoint> </Service>
テンプレートには、リクエストの送信時およびレスポンスの受信時に変換されるデータが含まれます。テンプレートは、Enterprise Managerの特定のサービス操作についてXMLまたはXSLファイルとして定義できます。
チケッティング・コネクタのテンプレート実装は、次のようにさらに分類できます。
表1-3 チケット実装
| 実装タイプ | 説明 | 例 |
|---|---|---|
|
サービス・メソッド |
これらのテンプレートは、定義されたサービス・メソッドにのみ適用できます。 |
<TemplateRegistration> <FileName>getTicket_request.xml</FileName> <InternalName>getTicket</InternalName> <TemplateName>Get Ticket</TemplateName> <TemplateType>OutboundXML</TemplateType> <Description>This is the request xml file for getTicket method</Description> </TemplateRegistration> <TemplateRegistration> |
|
デフォルト |
これらのテンプレートは、createTicketまたはupdateTicketのいずれかのリクエスト・サービス・メソッドで使用できます。 |
<TemplateRegistration> <FileName>templates/Remedy_DefaultCategory.xsl</FileName> <InternalName>Remedy_DefaultCategory.xsl</InternalName> <TemplateName>Remedy Default Category </TemplateName> <TemplateType>OutboundXSL</TemplateType> <Description>This is the Remdy default category template. </Description> </TemplateRegistration> |
テンプレートを定義するためのガイドラインは次のとおりです。
メソッド固有のテンプレートには、メソッド名と同じ内部名(大/小文字を区別)が必要です。
デフォルト・テンプレートには、任意の内部名を指定できます。
テンプレート・タイプは次のとおりです。
InboundXSL for response xsl, OutboundXSL for request xsl, and OutboundXML for request xml
テンプレート・ファイル名は重要ではありませんが、次の名前を使用することをお薦めします。
<methodName>_request.xml, <methodName>_request.xsl, and <methodName>_response.xsl.
テンプレート登録XMLまたはXSLのコーディングは、次の情報によって決まります。
定義された一連のスキーマ定義(XSD)
ターゲット外部システムの属性
次の表に、Enterprise Managerイベント・コネクタのスキーマ定義を示します。
表1-4 Enterprise Managerイベント・コネクタのスキーマ定義
| 名前 | 説明 |
|---|---|
|
EMIncident.xsd |
コネクタ・フレームワークによって使用可能になるEMインシデントを定義します。 |
|
ConnectorCommon.xsd |
SourceObjInfoTypeなど、その他すべてのxsdで使用されるすべてのデータ型を定義します。 |
|
createTicket_response.xsd |
createTicketおよびupdateTicketレスポンス用のレスポンス・スキーマです。 |
|
getTicket_response.xsd |
getTicketメソッド用のレスポンス・スキーマです。 |
|
PublishTicket.xsd |
publishTicketリクエスト操作用のスキーマです。 |
リクエスト・テンプレートを定義する際の重要なポイントは次のとおりです。
getTicketサービスには、リクエストXMLテンプレート・ファイルの定義のみ必要です。
テンプレート・リクエストXMLは、渡される情報がコネクタ・テスト変数要素としてすでに定義されている場合に使用されます。コネクタ・テスト変数は、登録時にコネクタ・デプロイメント記述子XMLによって定義できます。
createTicketサービスおよびupdateTicketサービスでは、コネクタ・デプロイメント記述子XMLによって定義されるデフォルトXSLテンプレート・ファイルが使用されます。
テンプレート・リクエストXSLは、Enterprise Manager内で生成されるイベント属性およびインシデント属性を使用してリクエストを生成する場合に使用されます。これらのリクエストには、Enterprise Manager内のイベント・オブジェクトおよびインシデント・オブジェクトとチケッティング・システムの属性とのマッピングが必要です。
テンプレート・リクエストXSLの定義は、すでにリクエストXMLを定義している場合、オプションです。
原則として、このシナリオは必要ありません。
EMIncident.xsdおよびEMEvent.xsdスキーマを使用すると、チケッティング・リクエストの作成時にマッピングで使用できるようにするEnterprise Managerのフィールドを決定できます。
レスポンス・テンプレートを定義する際の重要なポイントは次のとおりです。
レスポンス・テンプレート(XSL)は、チケッティング・コネクタ・テンプレートXSD表に定義されているXSDに基づいて定義できます。
テンプレート・レスポンスXSLはオプションです。
レスポンス変換(XSL)が定義されていない場合、外部システムによって返されるレスポンスXML内のデータはいずれも保持されません。外部システム・レスポンス・データに関係していない操作の場合、これは理想的な実装です。
createTicketおよびupdateTicketサービスに対しては、createTicket_response.xsdスキーマを使用して外部システムからのレスポンスをEnterprise Managerが認識できるレスポンスに変換する方法を決定できます。
変換後、Enterprise Managerでは、<TicketId>が必要とされ、値に応じて適切なステータスが更新されます。
Null以外
EMインシデント・マネージャ・グリッドで、インシデントが関連付けられたticketIdが保持され、適切なステータス・メッセージに注釈が付けられます。
Null
EMインシデント・マネージャ・グリッドで、インシデントが関連付けられたエラー・メッセージに注釈が付けられます。
Remedy 7のチケッティング・コネクタ実装は、次のサンプル・テンプレート・ファイルを参照してください。
コネクタをデプロイするために、Enterprise Managerでは自己更新機能が使用されます。この機能はコンソールからアクセスできますが、Enterprise Manager環境にコネクタをインポートするための機能です。コネクタをデプロイするには、次の手順を実行します。
コネクタjarファイルを準備します。
XMLおよびXSLテンプレート・ファイルをすべて1つの.jarファイルとしてパッケージします。
<name>_connector.jar ---> connectorDeploy.xml --->template1.xml --->template2.xsl ….. ….. --->templateN.xsl
マニフェスト・ファイルを作成します。
自己更新マニフェスト・ファイルのキー属性は次のとおりです。
EntityType
値はcore_connectorです。
EntityTypeVersion
現行リリース・バージョンです。値は12.1.0.1.0です。
Attribute @Name=connector_type
コネクタ・タイプ名です。
Attribute @Name=connector_category
カテゴリ・タイプは、TicketingConnectorまたはEventConnectorです。
ArchiveList
この要素には、コネクタ設定の一部であるアーカイブのリストが含まれます。一般に、コネクタjarは1つ存在しますが、特殊な実装の場合は追加のjar (アダプタまたはエージェント)が存在することがあります。このような場合、コネクタ固有のjarは定義リストの最初のjarである必要があります。これは必須要件です。
次の例に、connector_manifest.xmlファイルのコードを示します。
<EntityInstanceList xmlns="http://www.oracle.com/EnterpriseGridControl/SelfUpdateManifest"> <EntityInstance xmlns="http://www.oracle.com/EnterpriseGridControl/SelfUpdateManifest" EntityTypeVersion="11.2.0.1.0" EntityType="core_connector" Maturity="PRODUCTION" Vendor="Oracle" PluginID="oracle.sysman.core"> <Description> <![CDATA[ BMC Remedy Service Desk Connector - 12.1.0.2.0 ]]> </Description> <AttributeList> <Version>12.1.0.2.0</Version> <Attribute Name="connector_type" Value="Sample SCOM Connector" Label="Sample SCOM Connector" /> <Attribute Name="connector_category" Value="EventConnector" Label="Event Connector" /> </AttributeList> <Readme> <![CDATA[ Oracle Management Connector for SCOM integrates Oracle Enterprise Manager Cloud Control's proactive alert detect ion and resolution features with BMC's Remedy 7.0 Service Desk capabilities to provide a seamless workflow for incident mana gement and resolution. Change Logs: 12.1.0.2.0 - Miscellaneous bug fixes - Performance enhancements ]]> </Readme> <DependsOn /> <ArchiveList> <Archive Filename="scomconnector.jar" IsMDS="false" /> <Archive Filename="SCOM_webservices_adapter.jar" IsMDS="false" /> </ArchiveList> <CustomData> <![CDATA[ ]]> </CustomData> </EntityInstance> </EntityInstanceList>
属性の詳細リストは、次の場所にある自己更新スキーマ定義を参照してください。
$ORACLE_HOME/sysman/emSDK/core/selfupdate/model/SelfUpdateManifest.xsd
emedkツールを構成します。
emedkツールは、EM UIから指示に従って構成できます。パスは、「設定」 > 「拡張性」 > 「開発キット」です。
自己更新アーカイブを準備します。
これにはコネクタjarファイルおよびコネクタ用のマニフェスト・ファイルが必要です。自己更新を準備するには、次のユーティリティをコールして自己更新アーカイブ・ファイルを作成します。
edktool prepare_update
-manifest "manifest xml"
-archivedir "archives directory"
-out "output file or directory"
[-typexml "update type xml"]
表1-6に、ユーティリティで使用可能なオプションを示します。
表1-6 自己更新ユーティリティのオプション
| オプション | 説明 |
|---|---|
|
|
更新が記述されている自己更新マニフェスト・ファイル。 |
|
|
マニフェスト・ファイルに指定されているアーカイブ・ファイルがあるディレクトリ。 |
|
|
自己更新アーカイブのディレクトリまたはファイル名。ディレクトリが指定されている場合、ファイル名は自動生成されます。 |
|
|
更新タイプxmlへのオプション・パス。 |
次の例では、マニフェスト・ファイル/u01/connector/connector_manifest.xmlに基づいて自己更新アーカイブを/u01/sarディレクトリに作成しています。connector_manifest.xmlで参照されるアーカイブは、ディレクトリ/u01/connector/archivesから取得されます。
edkUtil prepare_update
-manifest /u01/connector/connector1_manifest.xml
-archivedir /u01/connector/archives
-out /u01/sar/sample_connector.zip
次のemcliコマンドのいずれかをコールして、Enterprise Managerにコネクタ・アーカイブをインポートします。
edktool import_update -file=\ file\ -omslocal
emcli import_update -file=\ file\ -host=\ hostname\ [-credential_set_name=\ setname\ ] | -credential_name=\ name\ -credential_owner=\ owner\
これらのコマンドにより、自己更新アーカイブ・ファイルがEnterprise Managerにインポートされます。正常にインポートされると、更新が次のアクションを促す「ダウンロード」ステータスで自己更新ホームに表示されます。
表1-7に、このコマンドで使用可能なオプションを示します。
表1-7 コネクタ・アーカイブ・コマンドのオプション
| オプション | 説明 |
|---|---|
|
-file |
更新アーカイブ・ファイルの完全なパス名 |
|
-omslocal |
ファイルがOMSからアクセス可能であることを示すフラグ |
|
-host |
ファイルが使用可能なホスト・ターゲットのターゲット名 |
|
-credential_set_name |
ホスト・ターゲットのリポジトリに格納されている優先資格証明のセット名。次のいずれかです。
|
|
-credential_name |
リポジトリに格納されている名前付き資格証明の名前。このオプションは、-credential_ownerオプションとともに指定する必要があります。 |
|
-credential_owner |
リポジトリに格納されている名前付き資格証明の所有者。このオプションは、-credential_nameオプションとともに指定する必要があります。 |
emcliコマンドの使用例をいくつか次に示します。
例1
ファイルsample_connector.zipをインポートします。ファイルは、OMSホストに存在している必要があります。複数のOMSが設定されている場合、リクエストはどのOMSでも処理できるため、ファイルはリクエストを処理するOMSからアクセスできる必要があります。通常、これは、すべてのOMSからアクセス可能な共有の場所にファイルを保存しておく必要があることを意味します。
emcli import_update -file=\ /u01/sar/sample_connector.zip -omslocal
例2
host1.example.comホストに存在するファイルsample_connector.zip.zipをインポートします。ホストは、Enterprise Managerの管理対象ホスト・ターゲットであり、このホストのエージェントは起動し実行中である必要があります。リモート・ファイルの取得には、ホストhost1.example.comの非特権優先資格証明が使用されます。
emcli import_update -file=\ /u01/sar/sample_connector.zip -host=\ host1.example.com\ -credential_set_name=\ HostCredsNormal\
例3
host1.example.comホストに存在するファイルsample_connector.zipをインポートします。ホストは、Enterprise Managerの管理対象ホスト・ターゲットであり、このホストのエージェントは起動し実行中である必要があります。リモート・ファイルの取得には、ユーザー\ admin1\が所有する名前付き資格証明\ host1_creds\が使用されます。
emcli import_update -file=\ /u01/sar/sample_connector.zip\ -host=\ host1.example.com\ -credential_name=\ host1_creds\ -credential_owner=\ admin1\
「自己更新」ホームページに移動します。
コネクタは「ダウンロード」と表示されます。
コネクタの行を選択し、「適用」をクリックしてコネクタをデプロイします。
