ページの先頭行へ戻る
SystemwalkerService Catalog Manager V14g アプリケーションサービス機能アプリケーション開発ガイド
Systemwalker
付録B テクニカルサービス定義のXMLファイル要素
前次

付録B テクニカルサービス定義のXMLファイル要素

テクニカルサービス定義とは、アプリケーションをテクニカルサービスとしてアプリケーションサービス機能に登録するために必要な情報です。テクニカルサービス定義は、XMLファイルを使って定義します。このファイルは、XMLスキーマTechnicalServices.xsdに準拠して作成します。TechnicalServices.xsdは、アプリケーションサービス機能のインテグレーションパックに含まれています。詳細は、“付録A インテグレーションパック”を参照してください。

本章では、テクニカルサービス定義に利用する要素と属性の意味を説明します。それぞれの構文はTechnicalServices.xsdを参照してください。

TechnicalServices

テクニカルサービス定義ファイルにおいて最上層となる要素です。

TechnicalService

アプリケーションをアプリケーションサービス機能のテクニカルサービスとして登録するために必要なすべての情報を記載します。

属性

例

<TechnicalService
   accessType="PLATFORM" 
   baseUrl="http://myserver.example.com:7777/myservice"
   build="25.01.2010"
   descriptionUrl="http://www.myServiceInfo.example.com"
   id="SampleService"   
   loginPath="/login"
   provisioningType="SYNCHRONOUS"   
   provisioningUrl=
       "http://myserver.example.com:8090/axis/services/MyProvisioningService?wsdl"
   version="1.00">

AccessInfo

accessTypeがDIRECTの場合はAccessInfoが必須です。

ユーザーがアクセスする方法を、localeに指定した言語で記述します。この情報が必要なのは、ダイレクトアクセスではユーザーがアプリケーションサービス経由でアプリケーションにアクセスするわけではないためです。

たとえばアプリケーションのWebユーザーインターフェースやログインページのURLなど、アクセスに必要な情報を提供するために使用します。

ここで定義したテキストは、アプリケーションサービス機能のユーザーインターフェースに表示されます。また、サービスの利用者に配信されるメールにも記載されます。複数の言語を使って定義することが可能です。

属性

locale：enやen-USなどのロケールコードを指定します（必須）。（enは英語、en-USは英語（米国）です）

LocalizedDescription

テクニカルサービス定義ファイル内に定義した各要素の目的や説明を記述するテキストです。locale属性ごとに、複数のテキストを用意できます。

LocalizedDescriptionは、以下の要素の下層の要素として記述します。

属性

locale：enやen-USなどのロケールコードを指定します。（enは英語、en-USは英語（米国）です）

例 

   <LocalizedDescription locale="en">
      Our Service supports you in ...
   </LocalizedDescription>

LocalizedLicense

カスタマーに表示するサービス利用規約を、localeに指定した言語で記述します。locale属性ごとに、複数のテキストを用意できます。

テクノロジープロバイダー、サービスを販売するサプライヤー、およびサービス利用を利用申請するカスタマーのアプリケーションサービス機能のユーザーインターフェースに、サービス利用規約として表示されます。

属性

locale：enやen-USなどのロケールコードを指定します（必須）。（enは英語、en-USは英語（米国）です）

例 

   <LocalizedLicense locale="en">
      Please read this software license agreement ... The license terms
      are applied for the concession of the rights ...
   </LocalizedLicense>

LocalizedName

ユーザーロールまたは操作を、localeに指定した言語で記述します。locale属性ごとに、複数のテキストを用意できます。

ロール名は、テクノロジープロバイダー、サービスを販売するサプライヤー、およびカスタマーがユーザーをサービスに割り当てる際、アプリケーションサービス機能のユーザーインターフェースに表示されます。オペレーション名は、カスタマーがサービスの利用を開始する際、あるいはテクノロジープロバイダーがアプリケーションサービス機能のユーザーインターフェースを使用してテクニカルサービス定義を更新する際に表示されます。

属性

locale：enやen-USなどのロケールコードを指定します（必須）。（enは英語、en-USは英語（米国）です）

ParameterDefinition

インスタンスのプロビジョニング処理を実行する際、アプリケーションに渡すパラメーターを宣言します。

サプライヤーはパラメーターを使用することで、機能構成やサービス内容の異なる複数のサービス仕様を提供できます。中でも、ENUMERATION型のパラメーターを利用すると、さまざまな選択肢を提供できるようになります。たとえば、MEMORY_STORAGEパラメーターを宣言し、1GB、2GB、4GBを用意し、これらを、最小記憶量、中間記憶量、最大記憶量という3つの選択肢に割り当てます。すると、サプライヤーが価格モデルを定義するとき、この３種類の選択肢を利用できます。また、カスタマーがサービスに利用申請する際にも、この３つの選択肢を利用できるようになります。

アプリケーションサービス機能は、インスタンスのプロビジョニング処理を呼び出すとき、テクニカルサービス定義に宣言されている全パラメーターを渡します。それ以降の処理は、アプリケーションに委ねられます。特に、パラメーターに応じてサービスの使用を制限するような場合は、アプリケーションがその制限を確実に守る必要があります。

たとえば、ユーザーの作成可能な最大ファイル数を制限するMAX_FILE_NUMBERパラメーターを宣言した場合、アプリケーションはファイルの最大数を超えないよう正確に追跡する必要があります。

属性

例

   <ParameterDefinition 
      configurable="true"
      default="2"
      id="MEMORY_STORAGE"
      mandatory="false"
      valueType="ENUMERATION">

      <Options>
         <Option id="1">
            <LocalizedOption locale="en">Minimum Storage （1GB）
            </LocalizedOption>
         </Option>
         <Option id="2">
            <LocalizedOption locale="en">Medium Storage （2GB）
            </LocalizedOption>
         </Option>
         <Option id="3"> 
            <LocalizedOption locale="en">Maximum Storage （4GB）
            </LocalizedOption>
         </Option>
      </Options>
   </ParameterDefinition>

   <ParameterDefinition 
       configurable="true" 
       default="200" 
       id="MAX_FOLDER_NUMBER2" 
       mandatory="true" 
       maxValue="500" 
       minValue="12" 
       valueType="INTEGER">
    <LocalizedDescription locale="en">
       Number of folders that can be created.</LocalizedDescription>
   </ParameterDefinition>

Event

イベントを宣言します。アプリケーションサービス機能はイベント発生の通知を受け取れるようになります。アプリケーションサービス機能のパブリックWebサービスAPIでイベント通知を実装した場合のみ必要です。

アプリケーションサービス機能では、従量制の価格モデルや、課金などにイベントを利用できます。詳細は“3.2 アプリケーションサービス機能のイベント管理との統合”を参照してください。

属性

id：イベントのID（必須）。テクニカルサービス内のイベントで一意となるIDを指定します。
40文字以内で指定します。先頭と末尾の空白、および以下の文字は使用できません。
   ! " # $ % & ' * + , / : ; < = > ? \ ^ `

例 

   <Event id="FILE_DOWNLOAD">
      <LocalizedDescription locale="en">
         File Download
      </LocalizedDescription>
   </Event>

Role

サービスのユーザーロールを宣言します。ユーザーロールに応じて異なるアクセス権をサービスが提供する場合に使用します。ユーザーロールは、サービスとして提供するアプリケーションのアクセス権に対応づけるために使用します。

アプリケーションサービス機能では、ユーザーロールや、そのイベントに対する価格モデルを作成することも可能です。

属性

id：ユーザーロールのID（必須）。テクニカルサービス内のユーザーロールで一意となるIDを定義します。

40文字以内で指定します。先頭と末尾の空白、および以下の文字は使用できません。
   ! " # $ % & ' * + , / : ; < = > ? \ ^ `

例 

   <Role id="ADMIN">
      <LocalizedName locale="en">Administrator</LocalizedName> 
      <LocalizedDescription locale="en">
        Administrators have full access to all data entities 
        and can execute administrative tasks such as 
        role assignments and user creation.
      </LocalizedDescription>
   </Role>

   <Role id="GUEST">
      <LocalizedName locale="en">Guest</LocalizedName> 
      <LocalizedDescription locale="en">
         Guests only have limited read access.
      </LocalizedDescription>
   </Role>

Operation

テクニカルサービスが提供する操作を宣言します。

属性

例

   <Operation id="BACKUP" type="SYNCHRONOUS" 
              actionURL="http://myserver.example.com:7777/myOperation.wsdl">
      <LocalizedName locale="en">Backup</LocalizedName>
      <LocalizedDescription locale="en">
         Performs a backup of the subscription data.
      </LocalizedDescription>
   </Operation>
前次
Copyright 2011 FUJITSU LIMITED