プライマリ・コンテンツに移動
Oracle® Fusion Middleware Oracle Reports ServicesレポートWeb公開ガイド
12c (12.2.1.2)
E82763-01
  ドキュメント・ライブラリへ移動
ライブラリ
製品リストへ移動
製品
目次へ移動
目次
索引へ移動
索引

前
 
次
 

19.3 Oracle ReportsのWebサービスの操作

Oracle Reportsでは、XMLを使用して定義して記述されたパブリック・インタフェースとバインディングを持つWebサービスとしてRWWebServiceサーブレットが公開されます。これらのパブリック・インタフェースとバインディングは、WSDLを介してネットワーク全体に発行されます。

19.3.1 Oracle Enterprise Managerを使用したRWWebServiceのテスト

Oracle Enterprise ManagerでRWWebserviceをテストするには、次の手順を実行します。

  1. Oracle Enterprise Managerにログインします。

  2. 「WebLogicドメイン」にナビゲートします。

  3. 「WebLogicドメイン」メニューから「Webサービス」「Webサービスのテスト」を選択します。

    「Webサービスのテスト」ページが表示されます。

  4. WSDLのURLを入力し、「WSDL解析」をクリックします。

  5. 起動するWebサービス操作を選択します。

  6. 該当するフィールドに有効な値を入力します。

  7. 「Webサービスのテスト」をクリックします。

    「Webサービスのレスポンス」が表示されます。

  8. 値を編集する場合は、「リクエスト」タブをクリックし、ステップ6および7を実行します。

RWWebServiceのエンドポイントでは、次の操作がサポートされています。

19.3.1.1 getAPIVersion

getAPIVersion()操作では、Reports Serverのバージョンの詳細をXMLフォーマットで返します。この操作にはパラメータは必要ありません。


注意:

getAPIVersionは、SOAPレスポンス全体を結果とともに(文字列で)返す唯一の操作です。runJobなどの他の操作では、SOAPレスポンス内に埋め込まれたXMLブロックとしてレスポンスが返されます。

getAPIVersionレスポンスを表示する手順は、次のとおりです。

  1. Oracle Enterprise Managerの「Webサービスのテスト」ページにナビゲートします。第19.3.1項「Oracle Enterprise Managerを使用したRWWebServiceのテスト」のステップ1から3を参照してください。

  2. 「操作」ドロップダウン・リストから、「getAPIVersion」を選択します。

    「テスト」ページにパラメータは表示されません。

  3. 「Webサービスのテスト」をクリックします。

    SOAPレスポンスが、「レスポンス」タブに表示されます。

次は、getAPIVersion操作のレスポンス例です。

<?xml version="1.0" encoding="UTF-8" ?> 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"   
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <SOAP-ENV:Body>
    <ns1:getAPIVersionResponse
      xmlns:ns1="http://oracle.reports.rwclient/RWWebService.wsdl"
      SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
      <return xsi:type="xsd:string">11.1.1.1.0</return> 
    </ns1:getAPIVersionResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

19.3.1.2 getServerInfo

getServerInfo(String serverName, String authId)操作では、2つのパラメータを使用し、Reports Serverの情報をXMLフォーマットで返します。

有効なパラメータは、次のとおりです。

  • serverName: NULLでない有効なサーバー名です。指定されたサーバーがネットワークで稼動していない場合、この操作によってエラーが発生します。

  • authId: ユーザー名/パスワード形式の文字列で、セキュリティ保護されたサーバーに指定する必要があります。セキュリティ保護されていないサーバーの場合、このパラメータは無視されます。

getServerInfoレスポンスを表示する手順は、次のとおりです。

  1. Oracle Enterprise Managerの「Webサービスのテスト」ページにナビゲートします。第19.3.1項「Oracle Enterprise Managerを使用したRWWebServiceのテスト」のステップ1から3を参照してください。

  2. 「操作」ドロップダウン・リストから、「getServerInfo」を選択します。

    「テスト」ページに「入力引数」セクションの関連パラメータ・フィールドが表示されます。

  3. Reports Server名(arg0)とauthId (arg1)を入力します。

  4. 「Webサービスのテスト」をクリックします。

    SOAPレスポンスが、「レスポンス」タブに表示されます。

次は、getServerInfo操作の出力例です。

<?xml version = '1.0' encoding = 'ISO-8859-1' standalone = 'yes'?>
<serverInfo name="repserv" version="11.1.1.1.0">
   <host>incq246bc</host>
   <processId>2588</processId>
   <startTime>27-May-2003 10:09:34</startTime>
   <queue maxQueueSize="1000"/>
   <engine id="rwEng" activeEngine="1" runningEngine="0"/>
   <engine id="rwURLEng" activeEngine="1" runningEngine="0"/>
   <performance>
      <property name="successfulJobs" value="6"/>
      <property name="currentJobs" value="0"/>
      <property name="futureJobs" value="0"/>
      <property name="transferredJobs" value="0"/>
      <property name="failedJobs" value="0"/>
      <property name="AverageResponseTime" value="2124"/>
      <property name="executionTimeToDate" value=""/>
   </performance>
</serverInfo>

19.3.1.3 getJobInfo

getJobInfo(Integer jobId, String serverName, String authId)操作では、ジョブ情報をXMLフォーマットで返します。

有効なパラメータは、次のとおりです。

  • jobId: 情報が必要なジョブのJob IDです。

  • serverName: NULLでない有効なサーバー名の値を指定する必要があります。指定されたサーバーがネットワークで稼動していない場合、この操作によってエラーが発生します。

  • authId: ユーザー名/パスワード形式の文字列で、セキュリティ保護されたサーバーに指定する必要があります。セキュリティ保護されていないサーバーの場合、このパラメータは無視されます。

getJobInfoレスポンスを表示する手順は、次のとおりです。

  1. Oracle Enterprise Managerの「Webサービスのテスト」ページにナビゲートします。第19.3.1項「Oracle Enterprise Managerを使用したRWWebServiceのテスト」のステップ1から3を参照してください。

  2. 「操作」ドロップダウン・リストから、「getJobInfo」を選択します。

    「テスト」ページに「入力引数」セクションの関連パラメータ・フィールドが表示されます。

  3. jobId (arg0)、Reports Server名(argm1)およびauthId (arg2)を入力します。

  4. 「Webサービスのテスト」をクリックします。

    SOAPレスポンスが、「レスポンス」タブに表示されます。

次は、job id=3を指定した場合のgetJobInfo操作の出力例です。

<?xml version = '1.0' encoding = 'ISO-8859-1' standalone = 'yes'?>
<serverQueues>
   <job id="3" queueType="past">
      <name>test.rdf</name>
      <type>report</type>
      <status code="4">Finished successfully</status>
      <owner>RWUser</owner>
      <server>repserv</server>
      <destination>
         <desType>cache</desType>
         <desFormat>html</desFormat>
         <file>21748116.htm</file>
         <file>217481161.jpg</file>
         <file>217481160.jpg</file>
      </destination>
      <timingInfo>
         <queued>27-May-2003 10:21:50</queued>
         <started>27-May-2003 10:21:50</started>
         <finished>27-May-2003 10:21:51</finished>
      </timingInfo>
   </job>
 </serverQueues>

19.3.1.4 killJob

killJob(Integer jobId, String serverName, String authId)操作では、指定されたジョブIDに基づいてジョブを削除し、操作のステータスをXMLフォーマットで返します。

有効なパラメータは、次のとおりです。

  • jobId: 情報が必要なジョブのJob IDです。

  • serverName: NULLでない有効なサーバー名の値を指定する必要があります。指定されたサーバーがネットワークで稼動していない場合、この操作によってエラーが発生します。

  • authId: ユーザー名/パスワード形式の文字列で、セキュリティ保護されたサーバーに指定する必要があります。セキュリティ保護されていないサーバーの場合、このパラメータは無視されます。

killJobレスポンスを表示する手順は、次のとおりです。

  1. Oracle Enterprise Managerの「Webサービスのテスト」ページにナビゲートします。第19.3.1項「Oracle Enterprise Managerを使用したRWWebServiceのテスト」のステップ1から3を参照してください。

  2. 「操作」ドロップダウン・リストから、「killJob」を選択します。

    「テスト」ページに関連パラメータ・フィールドが表示されます。

  3. jobId (arg0)、Reports Server名(arg1)、およびauthId (arg2)を入力します。

  4. 「Webサービスのテスト」をクリックします。

    SOAPレスポンスが、「レスポンス」タブに表示されます。

次は、Job ID=3を指定した場合のkillJob操作の出力例です。

<?xml version = '1.0' encoding = 'ISO-8859-1' standalone = 'yes'?>
<serverQueues>
   <job id="3" queueType="past">
      <name>test.rdf</name>
      <type>report</type>
      <status code="7">Canceled upon user request</status>
      <owner>RWUser</owner>
      <server>repserv</server>
      <destination>
         <desType>cache</desType>
         <desFormat>html</desFormat>
      </destination>
      <timingInfo>
         <queued>27-May-2003 10:21:50</queued>
         <started>27-May-2003 10:21:50</started>
         <finished>27-May-2003 10:22:00</finished>
      </timingInfo>
   </job>
</serverQueues>

19.3.1.5 runJob

runJob(String commandLine, Boolean synchronous)操作では、commandLineパラメータの一部として指定されたReports Serverに対してジョブを実行します。


注意:

Oracle ReportsのWebサービスでは、ジョブの出力や実際のレポートが返されません。

有効なパラメータは、次のとおりです。

  • commandLine: ジョブを送信するための完全なコマンドライン構文です。例:

    server=repserv report=test.rdf destype=file desname=output.pdf desformat=pdf         userid=scott/tiger@oraDB
    

    注意:

    コマンドライン・パラメータでは、paramform=yesを指定できません。パラメータの実際の値をcommandLine引数の一部として渡す必要があります。

  • synchronous: ジョブを同期で実行するかどうかを指定するBOOLEANオブジェクトです。

runJobレスポンスを表示する手順は、次のとおりです。

  1. Oracle Enterprise Managerの「Webサービスのテスト」ページにナビゲートします。第19.3.1項「Oracle Enterprise Managerを使用したRWWebServiceのテスト」のステップ1から3を参照してください。

  2. 「操作」ドロップダウン・リストから、「runJob」を選択します。

    「テスト」ページに関連パラメータ・フィールドが表示されます。

  3. コマンドライン構文を入力します(arg0)。また、ジョブを同期で実行するかどうか(T/F、Y/N)を指定します(arg1)。

  4. 「Webサービスのテスト」をクリックします。

    SOAPレスポンスが、「レスポンス」タブに表示されます。

次は、runJob操作の出力例です。

<?xml version = '1.0' encoding = 'ISO-8859-1' standalone = 'yes'?>
<serverQueues>
   <job id="7" queueType="current">
      <name>test.rdf</name>
      <type>report</type>
      <status code="1">Waiting in the queue</status>
      <owner>RWUser</owner>
      <server>repserv</server>
      <destination>
         <desType>file</desType>
         <desName>output.pdf</desName>
         <desFormat>pdf</desFormat>
      </destination>
      <timingInfo>
         <queued>27-May-2003 10:22:00</queued>
         <started>27-May-2003 10:22:00</started>
         <finished>27-May-2003 10:22:00</finished>
      </timingInfo>
   </job>
</serverQueues>