ページの先頭行へ戻る
SystemwalkerService Catalog Manager アプリケーション開発ガイド
Systemwalker

付録A 請求データファイル

Systemwalker Service Catalog Managerでのサービスの利用の料金は、サービスごと、サービス利用部門ごと、購入済サービスごとに定義された料金設定に基づいて計算されます。

サービス提供部門は、特定期間の1つ以上のサービス利用部門の請求データをエクスポートできます。また、サービス提供部門は、自分のサービスをサービス仲介部門経由で購入したサービス利用部門の請求データにもアクセスできます。エクスポートしたデータは経理システムなどに回送し、さらに処理を行います。

エクスポートした結果はXMLファイルに格納されます。これを請求データファイルと呼びます。請求データファイルのフォーマットは、XMLスキーマファイルのBillingResult.xsdに準拠します。このファイルは、Systemwalker Service Catalog Managerのインテグレーションパッケージに含まれています。

請求データファイルの名前は、<日付>BillingData.xmlです。<日付>の部分は、作成日を示します。

この付録では、請求データファイルに含まれる要素と属性の意味について説明します。

BillingDetails

請求データファイルのトップレベルのコンテナ要素です。購入済サービスごとに、請求ファイルにBillingDetails要素が追加されます。

BillingDetails要素には、以下の下位要素が格納されます。

BillingDetails要素には、以下の属性があります。

Periodp

請求期間を示します。

Period要素には、以下の属性があります。

例:

<Period startDateIsoFormat="2012-08-31T22:00:00.000Z" startDate="1346450400000"
endDateIsoFormat="2012-09-30T22:00:00.000Z" endDate="1349042400000"/>

OrganizationDetails

エクスポートした請求データの対象になっているサービス利用部門の詳細情報を提供します。

OrganizationDetails要素には、以下の下位要素が格納されます。

Email

組織のE-mailアドレスを示します。(データ型: string).

Name

組織の名前を示します。(データ型: string)

Address

組織の住所を示します。(データ型: string).

Paymenttype

組織が利用している購入済サービスに対する支払種別を示します。(データ型: string).

例:

<BillingDetails key="10002">
  ...
  <OrganizationDetails>
<Email>info@company.com</Email>
<Name>company</Name>
<Address>Street</Address>
<Paymenttype>INVOICE</Paymenttype>
</OrganizationDetails>
... </BillingDetails>

Subscriptions

現在に請求期間においてサービス利用部門が利用した購入済サービスに対する請求データが格納されます。

Subscriptions要素には、組織が利用した購入済サービスごとにSubscription要素が格納されます。この要素では、関連する購入済サービスの料金とカスタム属性が示されます。Subscription要素のPriceModel要素には、購入済サービスの料金設定に対する請求データが格納されます。

Subscription要素には、以下の属性があります。

例:

<BillingDetails key="10002">
  ...
  <Subscriptions>
<Subscription id="Mega Office Basic" purchaseOrderNumber="12345">
<PriceModels>
<PriceModel id="14001">
...
</PriceModel>
</PriceModels>
</Subscription>
</Subscriptions>
... </BillingDetails>

Udas

組織や購入済サービスについての追加情報を保存するための、カスタム属性が格納されます。これは、たとえば、サービス利用部門からの収入が算入されるプロフィットセンターを示すために使用します。

OrganizationDetails要素とSusbscriptionDetails要素は、Udas要素を含むことができます。

Udas要素には、各カスタム属性に対応するUda要素が格納されます。

A Uda要素には、以下の属性があります。

例:

<BillingDetails key="10002">
  ...
  <Subscriptions>
    <Subscription id="Mega Office Basic" purchaseOrderNumber="12345">
      ...
      <Udas>
<Uda id="Profit Center" value="My Company"/>
</Udas>
</Subscription> </Subscriptions> ... </BillingDetails>

PriceModel

購入済サービスの利用料金を計算するために使用した、請求データに対する料金設定が格納されます。

PriceModel要素は、すべてのSubscription要素に含まれています。PriceModel要素には、以下の下位要素が格納されます。

PriceModel要素には、以下の属性があります。

UsagePeriod

購入済サービスの実際の利用期間を示します。利用期間は、サービス利用部門がサービスを購入した時点で開始し、購入済サービスを解約した時点で終了します。

UsagePeriod要素は、PriceModel要素内に格納されます。

A UsagePeriod要素には、以下の属性があります。

例:

<PriceModel calcurationMode="PRO_RATA" id="14001">
  <UsagePeriod endDate="1306879200000"
  endDateIsoFormat="2011-05-31T22:00:00.000Z" startDate="1304755088065"
  startDateIsoFormat="2011-05-07T07:58:08.065Z"/>
    ...
</PriceModel

GatheredEvents

現在の購入済サービスの利用期間中に発生したすべての請求対象イベントの料金を示します。これには、たとえば、アプリケーションへの利用者のログイン、ログアウトや、特定のトランザクションの完了、特定のデータの作成または削除などが含まれます。どのようなイベントが利用可能なのかは、アプリケーションの実装と統合の方法に依存します。

GatheredEvents要素は、PriceModel要素内に格納されます。

A GatheredEvents要素には、以下の下位要素が格納されます。

Event

各イベントに対応するEvent要素が、GatheredEventsに格納されます。

Event要素には、以下の属性があります。

Event要素には、以下の下位要素が格納されます。

Description

イベントの説明が格納されます。

SingleCost

料金設定で定義された、イベントの料金を示します。イベントに段階料金が定義されている場合には、この属性は省略されます。

A SingleCost要素には、以下の属性があります。

NumberOfOccurence

イベントが何回発生したかを示します。

NumberOfOccurence要素には、以下の属性があります。

CostForEventType

請求期間中のイベントの料金の総計を示します。

A CostForEventType要素には、以下の属性があります。

GatheredEventsCosts

このGatheredEvents要素中の全イベントの料金の総計を示します。

A GatheredEventsCosts要素には、以下の属性があります。

例:

<PriceModel calcurationMode="PRO_RATA" id="14001">
  ...
  <GatheredEvents>
    <Event id="USER_LOGOUT_FROM_SERVICE">
      <Description xml:lang="en">Logout of a user from the service.</Description>
      <SingleCost amount="100.00"/>
      <NumberOfOccurrence amount="3"/>
      <CostForEventType amount="300.00"/>
    </Event>
    ...
    <GatheredEventsCosts amount="1200.00"/>
</GatheredEvents> ... </PriceModel>

PeriodFee

この利用期間中での購入済サービスの利用料金を示します。

各購入済サービスに対して、サービス単価を定義することができます。

月単位、週単位、1日単位、または1時間単位の期間がサポートされています。サービス単価は、利用者、イベント、またはその他の使用データには左右されません。

料金の計算は、価格モデルで選択された費用計算オプションに依存します(“PriceModel”を参照)。

PeriodFee要素は、PriceModel要素内に格納されます。

PeriodFee要素には、以下の属性があります。

例:

<PriceModel calcurationMode="PRO_RATA" id="14001">
  ...
  <PeriodFee basePeriod="MONTH" basePrice="10.00" factor="0.4020212567204301" price="4.02"/>
... </PriceModel>

UserAssignmentCosts

購入済サービスに割り当てられた利用者に対する料金を示します。

購入済サービスに割り当てられた利用者それぞれに対して請求期間ごとにサービス利用部門が支払う必要がある料金を定義することができます。月単位、週単位、1日単位、および1時間単位の期間がサポートされています。利用者単位のサービス単価は、アクセス種別がログインアクセス、ユーザーアクセスのサービスに対してのみ定義することができます。

料金の計算は、価格モデルで選択された費用計算オプションに依存します(“PriceModel”を参照)。

UserAssignmentCosts要素は、PriceModel要素に格納されます。

A UserAssignmentCosts要素には、以下の属性があります。

UserAssignmentCosts要素内には、以下の下位要素が格納されます。

UserAssignmentCostsByUser

利用者が購入済サービスに割り当てられた利用期間の割合を示します。

A UserAssignmentCostsByUser要素には、以下の属性があります。

例:

<PriceModel calcurationMode="PRO_RATA" id="18000">
  ...
  <UserAssignmentCosts basePeriod="MONTH" basePrice="19.00"  factor="0.5337726052867383"
numberOfUsersTotal="2" total ="50.00" price="10.14">
<UserAssignmentCostsByUser factor="1.0499215949820788E-4" userId="admin"/>
<UserAssignmentCostsByUser factor="0.5336676131272401" userId="miller"/>
</UserAssignmentCosts> ... </PriceModel>

OneTimeFee

サービスに対する初期導入価格を示します。

初期導入価格は、購入済サービスの最初の請求期間でサービス利用部門が支払う必要がある料金を定義します。この料金は、最初の請求期間に対する料金の総計に算入されます。初期導入価格は、利用者数、イベント、またはその他の利用データには左右されません。

OneTimeFee要素は、PriceModel要素内に格納されます。

A OneTimeFee要素には、以下の属性があります。

例:

<PriceModel calcurationMode="PRO_RATA" id="14001">
  ...
  <OneTimeFee amount="10.00" baseAmount="10.00" factor="1"/>
... </PriceModel>

PriceModelCosts

現在の利用期間での購入済サービスに対する料金の総計を示します。割引が設定されている場合には、料金の正味金額はDiscount要素に格納されます(“Discount”を参照)。

PriceModelCosts要素は、PriceModel要素内に格納されます。

A PriceModelCosts要素には、以下の属性があります。

例:

<PriceModel calcurationMode="PRO_RATA" id="14001">
  ...
  <PriceModelCosts currency="EUR" grossAmount="990.00" amount="900.00"/>
</PriceModel>

Parameters

購入済サービスに対して定義されているパラメーターの料金を示します。

料金設定には、サービスのパラメーターとオプションの料金を定義することができます。どのようなパラメーターやオプションが利用可能であるかは、アプリケーションの実装と統合方法に依存します。

サービス提供部門は、パラメーターとオプションのそれぞれについて料金を定義し、それらが購入済サービス単位で請求されるのか、購入済サービスに割り当てられた利用者単位で請求されるのかを指定することができます。数値パラメーターは料金の乗数になります。論理型のパラメーターについては、値が真であれば乗数は1となります。それ以外の場合には、乗数は0となります。

料金の計算は、価格モデルで選択された費用計算オプションに依存します(“PriceModel”を参照)。

時間単位の料金の場合には、サービス利用部門は、たとえその時間単位の途中でパラメータやオプションの値を変更としても、常にその時間単位の開始時点で有効だったパラメータに対して課金されます。

数値パラメーターについては、購入済サービス単位で段階料金を適用することができます。パラメーターの値に応じて、異なる料金を定義することができます。

Parameters要素は、PriceModel要素内に格納されます。

Parameters要素には、以下の下位要素が格納されます。

Parameter

各パラメーターに対応するParameter要素が、Parameters要素内に格納されます。

Parameter要素には、以下の属性があります。

Parameter要素には、以下の下位要素が格納されます。

ParameterUsagePeriod

パラメーターに対する実際の利用期間を示します。パラメーターの利用期間の開始は、利用者が料金設定のパラメーターを指定し、サービスを購入した時点です。パラメーターの値が変更された場合には、その時点で利用期間が開始になります。

A ParameterUsagePeriod要素には、以下の属性があります。

ParameterValue

パラメーターの料金とデータ型を示します。

ParameterValue要素には、以下の属性があります。

PeriodFee

利用期間中の、パラメーターの使用に対する料金を示します。

PeriodFee要素には、以下の属性があります。

UserAssignmentCosts

料金設定で定義された利用者ごとの料金に基づいた、購入済サービスへの利用者の割り当てに関する料金を示します。

UserAssignmentCosts要素には、以下の属性があります。

ParameterCosts

パラメーターの使用に対する料金の総計を示します。

ParameterCosts要素には、以下の属性があります。

ParametersCosts

全パラメーターに対する料金の総計を示します。

A ParametersCosts要素には、以下の属性があります。

例:

<Parameters>
  ...
<Parameter id="MAX_FOLDER_NUMBER2">
<ParameterUsagePeriod endDate="1306879200000" endDateIsoFormat="2011-05-31T22:00:00.000Z"
startDate="1304755088065" startDateIsoFormat="2011-05-07T07:58:08.065Z"/>
<ParameterValue amount="200" type="INTEGER"/>
<PeriodFee basePeriod="MONTH" basePrice="0.00"
factor="0.5337789669205496" price="0.00" valueFactor="200.0"/>
<UserAssignmentCosts basePeriod="MONTH" basePrice="0.00"
factor="0.5337726052867383" total ="0.00" price="0.00" valueFactor="200.0"/>
<ParameterCosts amount="0.00"/>
</Parameter>
...
<ParametersCosts amount="600.00"/>
</Parameters>

Options

パラメーターのオプションに対する料金を示します。

Options要素は、Parameter要素内に格納されます。

各オプションに対応するOption要素が、Options要素内に格納されます。

Option要素には、以下の属性があります。

Option要素には、以下の下位要素が格納されます。

PeriodFee

利用期間中の、パラメーターのオプションの使用に関する料金を示します。

PeriodFee要素には、以下の属性があります。

UserAssignmentCosts

利用者のサービスへの割り当てに関するパラメーターのオプションの料金です。これは、料金設定で定義されたそのオプションに対する利用者単位の料金に基づきます。

UserAssignmentCosts要素には、以下の属性があります。

OptionCosts

パラメーターのオプションの使用に対する料金の総計を示します。

OptionCosts要素には、以下の属性があります。

例:

<Parameter id="MEMORY_STORAGE">
  ...
  <Options>
<Option id="2">
<PeriodFee basePeriod="MONTH" basePrice="100.00" factor="1.0" price="100.00"/>
<UserAssignmentCosts basePeriod="MONTH" basePrice="0.00" factor="1.0" total ="0.00" price="0.00"/>
<OptionCosts amount="100.00"/>
</Option>
</Options>
... </Parameter>

RoleCosts

サービスロールに対する料金を示します。

アプリケーションにロールが定義されている場合には、異なる利用者に対して特定の権限を与えるためにロールを使用することができます。ロールは、技術サービス定義においてサービスロールとして指定されます。アプリケーションでは、サービスロールを対応する権限にマッピングすることができます。

固定料金の場合には、たとえ利用者のロールの割り当てが期間中に変更されたとしても、常に期間の開始時点で有効だった価格で料金が計算されます。

RoleCosts要素は、UserAssignmentCosts要素内に格納されます(UserAssignmentCosts要素は、PriceModel要素、Parameters要素、またはOption要素の下位要素になります)。

RoleCosts要素には、以下の属性があります。

各サービスロールに対するRoleCosts要素内に、RoleCost要素が格納されます。

RoleCost要素には、以下の属性があります。

例:

<Parameter id="MEMORY_STORAGE">
  ...
  <RoleCosts total="0.00">
<RoleCost basePrice="0.00" factor="0.4020087753882915" id="USER" price="0.00"/>
<RoleCost basePrice="0.00" factor="0.8040175186678614" id="ADMIN" price="0.00"/>
</RoleCosts>
... </Parameter>

SteppedPrices

利用者の割り当て、イベント、またはパラメーターに対する、段階料金を示します。

段階料金により、異なる料金係数が適用される範囲を定義することができます。以下のそれぞれに対して、段階の限界値、すなわち範囲の上限が設定できます。

段階料金は、料金設定の他の要素には左右されません。

SteppedPrices要素は、UserAssignmentCosts要素内、イベント要素内、またはPeriodFee要素内に格納されます(UserAssignmentCosts要素はPriceModel要素の下位要素、PeriodFeeはParameters要素の下位要素です)。

SteppedPrices要素には、以下の属性があります。

SteppedPrices要素には、料金の各段階に対応するSteppedPrice要素が格納されます。

SteppedPrice要素には、以下の属性があります。

例:

<PriceModel calcurationMode="PRO_RATA" id="350001">
  ...
  <UserAssignmentCosts basePeriod="MONTH" factor="2.707940780619112"
  numberOfUsersTotal="4" price="1283.18">
    <SteppedPrices amount="1283.18">
<SteppedPrice additionalPrice="0.00" basePrice="500.00" freeAmount="0"
limit="2" stepAmount="1000.00" stepEntityCount="2"/>
<SteppedPrice additionalPrice="1000.00" basePrice="400.00"
freeAmount="2" limit="3" stepAmount="283.18" stepEntityCount="0.707940780619112"/>
<SteppedPrice additionalPrice="1400.00" basePrice="300.00"
freeAmount="3" limit="null" stepAmount="0.00" stepEntityCount="0"/>
</SteppedPrices>
</UserAssignmentCosts> ... </PriceModel>

Discount

サービス利用部門に与えられる割引を示します。

割引は、現在および将来の月に対して有効になります。割引の期間を限定することもできます。期限が切れる前に、サービス利用部門はE-mailで通知されます。サービス利用部門は、これにより、対処をおこなったり、サービス提供部門に連絡したりすることができます。

割引は、割引期間内に生成される購入済サービスに対するすべての請求データに対して、通常の合計料金から減額されるパーセント率として定義されます。

Discount要素は、OverallCosts要素とPriceModelCosts要素に格納されます。

Discount要素には、以下の属性があります。

例:

<PriceModel calcurationMode="PRO_RATA" id="14001">
  ...
  <PriceModelCosts currency="EUR" grossAmount="990.00" amount="900.00">
    <Discount discountNetAmount="100.00" netAmountAfterDiscount="900.00"
netAmountBeforeDiscount="1000.00" percent="10.00"/>
</PriceModelCosts> </PriceModel>

VAT

適用される付加価値税率を示します。

サービス提供部門は、サービス利用部門のすべての料金に適用される基本的な付加価値税率を定義することができます。この基本的な付加価値税率に加えて、国別あるいはサービス利用部門別の付加価値税率を定義することもできます。以下の設定が可能です。

付加価値税率の設定により、サービス利用部門に対する料金の計算は以下の影響を受けます。

VAT要素は、OverallCosts要素とPriceModelCosts要素に格納されます。

VAT要素には、以下の属性があります。

例:

<PriceModel calcurationMode="PRO_RATA" id="14001">
  ...
  <PriceModelCosts currency="EUR" grossAmount="990.00" amount="900.00">
    <VAT amount="90.00" percent="10.00"/>
  </PriceModelCosts>
</PriceModel>

OverallCosts

現在の請求期間中のすべての購入済サービスに対して、サービス利用部門が支払う必要がある料金の総計が格納されます。料金は、料金設定で指定された通貨で示されます。割引が指定されている場合には、料金の正味額はDiscount要素(“Discount”を参照)で示されます。

OverallCosts要素には、以下の属性があります。

例:

<BillingDetails key="10002">
  ...
  <OverallCosts currency="EUR" grossAmount="990.00" netAmount="900.00"/>
</BillingDetails>