30日間の無料評価版をお試しいただけます。

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

Anchor
top
top

 

こちらでは、全体的な管理レポートwebサービスについて紹介します。

 

 こちらでは、全体的な管理レポートwebサービスについて紹介します。 

基礎的な関数

Expand
titleTEST

こちらの関数は、webサービスが機能しているかどうかのテストに使用します。

 こちらの関数は、レポートwebサービスが機能しているかをテストするために使用します。


リクエスト要素

以下の要素は、こちらのリクエストとともに渡されます。

リクエスト要素データ型説明

LoginId

String

Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。

このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト(プライマリー)組織に所属していなくてはいけません。

Password

String

上記アカウントのパスワードです。

OrgId

Integer

Yellowfin内のデフォルト(プライマリー)組織IDです。常に、「1」に設定します。

ReportRequestStringwebサービス関数です。TEST」に設定します。
OrgRefStringクライアント組織内部参照IDです。(オプション設定)
 


リクエストの例

以下のSOAPの例は、こちらの呼び出しに渡すことのできるパラメーターを示しています。

Code Block
languagexml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:remoteReportCall>
        <arg0>
            <loginId>admin@yellowfin.com.au</loginId>
            <password>test</password>
            <orgId>1</orgId>
            <reportRequest>TEST</reportRequest>          
         </arg0>
      </web:remoteReportCall>
   </soapenv:Body>
</soapenv:Envelope>
 


応答要素

返される応答には、これらのパラメーターが含まれます。

応答要素データ型説明

StatusCode

String

Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。

  • SUCCESS
  • FAILURE
 


応答の例

サービスは、今回のSOAPの例に基づき、以下の応答を返します。

Code Block
languagexml
themeEclipselanguagexml
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:remoteReportCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
         <return>
            <canDrill>false</canDrill>
            <dashboardEnabled>false</dashboardEnabled>
            <errorCode>0</errorCode>
            <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
            <messages>Connection Tested Successfully</messages>
            <messages>Unknown Or Unsupported Request: TEST</messages>
            <messages>Web Service Request Complete</messages>
            <private>false</private>
            <sessionId>f78fe29edb19bbfe45626c2203249f4b</sessionId>
            <statusCode>SUCCESS</statusCode>
         </return>
      </ns2:remoteReportCallResponse>
   </S:Body>
</S:Envelope>
 


手順

Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。

Expand
title詳細手順
  • 管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの呼び出しを実行するための基礎的なリクエストです。

    Code Block
    languagejava
    themeEclipse
    languagejava
    ReportServiceRequest rsr = new ReportServiceRequest();
     
    rsr.setLoginId("admin@yellowfin.com.au");
    rsr.setPassword("test");
    rsr.setOrgId(new Integer(1));
     
    rsr.setReportRequest("TEST");


  • 特定のクライアント組織を指定する必要がある場合は、こちらのコードを追加します。


    Code Block
     code
    language
    java
    themeEclipselanguagejava
    rsr.setOrgRef("org1");      // search for the report in this client org


  • リクエストを構成したら、呼び出しを実行します。

    Code Block
    languagejava
    ReportServiceResponse rs=rsc.remoteReportCall(rsr);

    レポートwebサービスを初期化します。実行方法の詳細は、こちらを参照してください。

 


  • 返される応答には、StatusCodeパラメーターが含まれますより詳細な情報は、応答パラメーターの表を参照してください。

 
  • 詳細は、応答パラメーターの表を参照してください。


完成例

以下は、こちらの関数の完成例です。こちらを使用するには、以下の手順に従います。

  1. コードをコピーして、「ws_test_reportservices.jsp」として保存します。
  2. root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
  3. 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
  4. インターネットブラウザから、「http://<host>:<port>/ws_test_reportservices.jsp」を実行します。

Code Block
languagejava
themeEclipse
languagejava
<%          
/*              ws_test_reportservices.jsp              */
%>
<%@ page language="java" contentType="text/html; charset=UTF-8" %>
<%@ page import="com.hof.util.*, java.util.*, java.text.*" %>
<%@ page import="com.hof.web.form.*" %>
<%@ page import="com.hof.mi.web.service.*" %>
<%@ page import="javax.xml.bind.JAXBContext" %>
<%@ page import="javax.xml.bind.Marshaller" %>
<%@ page import="java.io.StringWriter" %>
<%@ page import="javax.xml.bind.JAXBElement" %>
<%@ page import="javax.xml.namespace.QName" %>
<%
     
 
    ReportService rsc = new ReportService();   //("localhost", 8080, "admin@yellowfin.com.au", "test", "/services/ReportService");
    ReportServiceRequest rsr = new ReportServiceRequest();
    rsr.setLoginId("admin@yellowfin.com.au");
    rsr.setPassword("test");
    rsr.setOrgId(new Integer(1));
    rsr.setReportRequest("TEST");
    rsr.setOrgRef("1");
     
     
    ReportServiceResponse rs=rsc.remoteReportCall(rsr);
    if ("SUCCESS".equals(rs.getStatusCode())) {
          JAXBContext context = JAXBContext.newInstance(ReportServiceResponse.class);
            Marshaller m = context.createMarshaller();
            m.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE); // To format XML
            JAXBElement<ReportServiceResponse> rootElement = new JAXBElement<ReportServiceResponse>(new QName("ReportServiceResponse"), ReportServiceResponse.class, rs);
            m.marshal(rootElement,out);
        //out.write("Success");
    } else {
        out.write("Failure");
        out.write(" Code: " + rs.getErrorCode());
    }
%>


...

Expand
titleINFO

こちらのwebサービスは、指定したレポートの詳細を取得します。

 


リクエスト要素

以下の要素は、こちらのリクエストとともに渡されます。

リクエスト要素データ型説明

LoginId

String

Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。

このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト(プライマリー)組織に所属していなくてはいけません。

Password

String

上記アカウントのパスワードです。

OrgId

Integer

Yellowfin内のデフォルト(プライマリー)組織IDです。常に、「1」に設定します。

ReportRequestString

webサービス関数です。「

XLSX」、または「XLS

INFO」に設定します。

OrgRefString クライアント組織内部参照IDです。(オプション設定)
ReportIdIntegerXLSX/XLS書式で返すレポートを指定するための内部IDです。
 
特定のレポートを検索するために、レポートIDを提供することができます。


リクエストの例

以下のSOAPの例は、こちらの呼び出しに渡すことのできるパラメーターを示しています。

Code Block
languagexml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:remoteReportCall>
        <arg0>
            <loginId>admin@yellowfin.com.au</loginId>
            <password>test</password>
            <orgId>1</orgId>
            <reportRequest>XLSX<<reportRequest>INFO</reportRequest>
            <reportId>56401<<reportId>60712</reportId>       
         </arg0>
      </web:remoteReportCall>
   </soapenv:Body>
</soapenv:Envelope>
 


応答要素

応答には、これらの主要なパラメーターが含まれます。応答には、これらのパラメーターが含まれます。

ReportIdInteger指定したレポートのIDです。ReportName指定したレポートの名前です。指定したレポートがアクセスされた回数です。BinaryDataBase64でエンコードされたXLSX、またはXLSのバイナリーチャンクです。
応答要素データ型説明

StatusCode

String

webサービスのステータスです。選択肢は、以下の通りです。Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。

  • SUCCESS
  • FAILURE
ReportNameString

指定したレポートの名前です。

ReportDescriptionString指定したレポートの説明です。
ReportUUIDInteger指定したレポートの一意のID(または、UUID)です。
HitCountIntegerレポートがアクセスされた回数です。
FormatCodeString

指定されたレポートの書式コードです。

レポートの書式コードです。
AverageRunTimeIntegerレポートの平均実行時間です。
CategoryStringレポートが保存されているカテゴリーです。

ContentType

String

このオブジェクトのMIMEコンテンツタイプです。値は「application/vnd.openxmlformats-officedocument.spreadsheetml.sheet」になります。

 
SubCategoryStringレポートのサブカテゴリーです。
ReportUsageIntegerレポートが使用、またはアクセスされた回数です。
ViewNameStringビューの名前です。
DatasourceStringデータソースの名前です。
AuthorStringレポートを作成したユーザーです。
AuthoringModeStringレポートが作成されたモードです。
ReportTemplateStringレポートのテンプレートです。
DataOutputStringデータ出力です。例:カラム(列)
DashboardEnabledBooleanダッシュボードが有効化されている場合はTrueです。
LastModifiedDateDateレポートが最後に変更された日付です。


応答の例

サービスは、今回のSOAPの例に基づき、以下の応答を返します。

Code Block
languagexml
themeEclipselanguagexml
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:remoteReportCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
         <return>
            <author>System Administrator</author>
            <authoringMode>JAVA</authoringMode>
            <averageRunTime>0</averageRunTime>
            <binaryData>UEsDBBQACAgIAJUKa0wAAAAAAAAAAAAAAAALAAAAX3JlbHMvLnJlb ...</binaryData><canDrill>false</canDrill>
            <canDrill>false<<category>Tutorial</canDrill>category>
            <category>Audit Reports<<dashboardEnabled>true</category>dashboardEnabled>
            <contentType>application/vnd.openxmlformats-officedocument.spreadsheetml.sheet</contentType>
<dataOutput>COLUMN</dataOutput>
            <datasource>Ski <dashboardEnabled>true<Team</dashboardEnabled>datasource>
            <dataOutput>COLUMN<<errorCode>0</dataOutput>errorCode>
            <datasource>Yellowfin Configuration Database</datasource><formatCode>REPORTANDCHART</formatCode>
            <errorCode>0</errorCode>
            <formatCode>REPORTANDCHART</formatCode>
            <hitCount>25</<hitCount>0</hitCount>
            <lastModifiedDate>2016<lastModifiedDate>2017-0306-29<26</lastModifiedDate>
            <lastRunDuration>0</lastRunDuration>
            <lastRunStatus>RUN_NOERROR</lastRunStatus>
            <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
            <messages>Loaded Report: 5640160712 Successfully</messages>
            <messages>Generating<messages>Collating XLSReport Report<Information</messages>
            <messages>Request<messages>Web ContainsService No ReportFilter Records.<Request Complete</messages>
             <messages>Report Run Successfully</messages>
            <messages>Web Service Request Complete</messages>
            <preRunFilterString><![CDATA[<div class="rptFilterLogicText">
<span class="rptFilterLogicIdentifier">Active Session Start</span>
Is Not Null
<span class="rptFilterLogicIdentifier"></span>
<preRunFilterString><![CDATA[<div class="rptFilterLogicText">
<span class="rptFilterLogicIdentifier">Company Name</span>
In List
<span class="rptFilterLogicIdentifier">[User Prompt]</span>
</div>]]></preRunFilterString>
            <private>false</private>
            <reportDescription>Top  <reportDescription/>N Agencies compared to all other Agencies by demographic</reportDescription>
            <reportId>56401<<reportId>60712</reportId>
            <reportName>Active<reportName>Agency Sessions<Benchmark</reportName>
            <reportTemplate>REPORTANDCHART</reportTemplate>
            <reportUUID>594d4da4<reportUUID>c83357db-1b588aef-44d34ec7-bf4fab72-11456a42f68c<fce34de9ee77</reportUUID>
            <reportUsage>26<<reportUsage>0</reportUsage>
            <sessionId>18097e8275689f88876f004a07935a7c<<sessionId>900e9dfabd21bdef75410fa88fe501dd</sessionId>
            <statusCode>SUCCESS</statusCode>
            <subCategory>Admin Reports<<subCategory>Marketing &amp; Booking</subCategory>
            <tags>No tags</tags>
            <viewName>NEW<viewName>New VIEW<View</viewName>
         </return>
      </ns2:remoteReportCallResponse>
   </S:Body>
</S:Envelope>   
 


手順

Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。

Expand
title詳細手順
  • 管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの呼び出しを実行するための基礎的なリクエストです。

    Code Block
    languagejava
    themeEclipselanguagejava
    ReportServiceRequest rsr = new ReportServiceRequest();
      
    rsr.setLoginId("admin@yellowfin.com.au");
    rsr.setPassword("test");
    rsr.setOrgId(new Integer(1));
     
    rsr.setReportRequest("XLSXINFO");


  • レポートの保存されているクライアント組織を指定する必要がある場合は、こちらのコードを追加します。


    Code Block
     code
    language
    java
    themeEclipselanguagejava
    rsr.setOrgRef("org1");      // search for the report in this client org


  • どのレポートのコメントのステータスを変更するか指定することができます。XLSX書式に変換するレポートを指定します。


    Code Block
     code
    language
    java
    themeEclipse
    rsr.setReportId(60712);


  • レポートのクライアント参照ID、またはセッションIDを指定することもできます。

    Code Block
    languagejava
    themeEclipse
    rsr.setReportId(60712setReportClientReferenceId("1");
    rsr.setSessionId("18607a5670842650d512976b5d7ccddd");


  • リクエストを構成したら、呼び出しを実行します。

    Code Block
    languagejava
    ReportServiceResponse rs=rsc.remoteReportCall(rsr);

    レポートwebサービスを初期化します。実行方法の詳細は、こちらを参照してください。

 

返される応答には、StatusCode、ReportID、BinaryDataなどのパラメーターが含まれます。(より詳細な情報は、上記応答パラメーターの表を参照してください)
 


  • 返される応答には、他のレポート固有のパラメーターとともに、StatusCodeパラメーターが含まれます。詳細は、上記応答パラメーターの表を参照してください。


完成例

以下は、こちらの関数の完成例です。こちらを使用するには、以下の手順に従います。

  1. コードをコピーして、「ws_info_xlsxreportreport.jsp」として保存します。
  2. root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
  3. 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
  4. インターネットブラウザから、「http://<host>:<port>/ws_info_xlsxreportreport.jsp」を実行します。

Code Block
languagejava
themeEclipse
languagejava
<%          
/*              ws_info_xlsxreportreport.jsp              */
%>
  
<%@ page language="java" contentType="text/html; charset=UTF-8" %>
<%@ page import="com.hof.util.*, java.util.*, java.text.*" %>
<%@ page import="com.hof.web.form.*" %>
<%@ page import="com.hof.mi.web.service.*" %>
<%@ page import="javax.xml.bind.JAXBContext" %>
<%@ page import="javax.xml.bind.Marshaller" %>
<%@ page import="java.io.StringWriter" %>
<%@ page import="javax.xml.bind.JAXBElement" %>
<%@ page import="javax.xml.namespace.QName" %>
<%
 
ReportService rsc  /*
  Create Group
  Using Java generated stubs rather that using the Yellowfin webservices API..
*/
 
ReportService rsc = = new ReportService();   //("localhost", 8080, "admin@yellowfin.com.au", "test", "/services/ReportService");
    ReportServiceRequest rsr = new ReportServiceRequest();
    rsr.setLoginId("admin@yellowfin.com.au");
    rsr.setPassword("test");
    rsr.setOrgId(new Integer(1));
    rsr.setReportRequest("XLSXINFO");
 
    rsr.setOrgRef("1");
    rsr.setReportId(60712);
    rsr.setReportClientReferenceId("1");
    rsr.setSessionId("18607a5670842650d512976b5d7ccddd");
 
    ReportServiceResponse rs=rsc.remoteReportCall(rsr);
    if ("SUCCESS".equals(rs.getStatusCode())) {
          JAXBContext context = JAXBContext.newInstance(ReportServiceResponse.class);
            Marshaller m = context.createMarshaller();
            m.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE); // To format XML
            JAXBElement<ReportServiceResponse> rootElement = new JAXBElement<ReportServiceResponse>(new QName("ReportServiceResponse"), ReportServiceResponse.class, rs);
            m.marshal(rootElement,out);
        //out.write("Success");
    } else {
        out.write("Failure");
        out.write(" Code: " + rs.getErrorCode());
    }
%>



Expand
titleDOC / DOCXSCHEMA

こちらのwebサービスは、レポートのカラム(列)やフィルターのメタデータを含む、指定したレポートのスキーマ情報を返します。レポートは、そのレポートID、またはwebサービス名を提供することで指定しなくてはいけません。

こちらの関数は、指定したレポートをDOC、またはDOCX書式(Microsoft Word)で返します。

 


リクエスト要素

以下の要素は、こちらのリクエストとともに渡されます。

リクエスト要素データ型説明

LoginId

String

Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。

このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト(プライマリー)組織に所属していなくてはいけません。

Password

String

上記アカウントのパスワードです。

OrgId

Integer

Yellowfin内のデフォルト(プライマリー)組織IDです。常に、「1」に設定します。

ReportRequestStringwebサービス関数です。「DOCX」、または「DOCSCHEMA」に設定します。
OrgRefStringクライアント組織内部参照IDです。(オプション設定)
ReportIdIntegerDOCX/DOC書式で返すレポートを指定するための内部IDです。
 
特定のレポートを検索するための内部レポートIDです。レポートIDは、レポートが編集される度に変更されます。ヒント:関連するレポートIDを取得するために、GETIDFROMUUID関数を使用することができます。
ObjectNameString(オプション設定)レポートのwebサービス名です。レポートIDが提供されている場合、こちらは必要ありません。


リクエストの例

以下のSOAPの例は、こちらの呼び出しに渡すことのできるパラメーターを示しています。

Code Block
languagexml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:remoteReportCall>
         <arg0>
            <loginId>admin@yellowfin.com.au</loginId>
            <password>test</password>
            <orgId>1</orgId>
            <reportRequest>DOCX<<reportRequest>SCHEMA</reportRequest>
            <reportId>56401<<reportId>60712</reportId>
            </arg0>
      </web:remoteReportCall>
   </soapenv:Body>
</soapenv:Envelope>
 


応答要素

応答には、これらの主要なパラメーターが含まれます。

FormatCode指定されたレポートの書式コードです。BinaryDataBase64でエンコードされたDOCX、またはDOCのバイナリーチャンクです。ContentType
応答要素データ型説明

StatusCode

String

webサービスのステータスです。選択肢は、以下の通りです。Webサービスリクエストのステータスです。値の選択肢は、以下の通りです。

  • SUCCESS
  • FAILURE

ReportIdColumns

Integer

指定したレポートのIDです。

ReportSchema[]

レポート結果セット内の各カラム(列)と、レポートにユーザープロンプトフィルターのデータを渡す必要があるかの情報(メタデータ)を含むReportSchemaオブジェクトの配列です。より詳細な情報は、以下のを参照してください。

AuthorReportName

String

指定したレポートの名前です。

レポートを作成したユーザーの名前です。

AuthoringMode

String


AverageRunTime

Integer


CanDrill

Boolean

レポートのドリル可否です。

Category

String

レポートが保存されているフォルダーの名前です。

SubCategory

String

レポートが保存されているサブフォルダーの名前です。

DashboardEnabled

Boolean


DataOutput

String

以下のいずれかになります。

  • COLUMN
  • ROW
  • PIVOT

Datasource

String

レポートが依存するデータソースの名前です。

DrillCode

String

レポートで利用可能な場合のドリルタイプです。以下のいずれかになります。

  • DRILLDOWN
  • DRILLTHROUGH
  • DRILLANYWHERE

FormatCode

String

指定したレポートの書式コードです。以下のいずれかになります。

  • REPORTANDCHART
  • CHART
  • REPORT

HitCount

Integer

指定したレポートがアクセスされた回数です。

LastModifiedDate

String

レポートが最後に変更された日付です。

LastRunDuration

Integer


PreRunFilterString

String


Private

Boolean

レポートが非公開、または公開のどちらであるかを定義します。(レガシーサービスの場合は非公開です)

ReportDescription

String

このオブジェクトのMIMEコンテンツタイプです。値は「application/vnd.openxmlformats-officedocument.wordprocessingml.document」になります。

 

応答の例

サービスは、今回のSOAPの例に基づき、以下の応答を返します。

指定したレポートの説明です。

ReportId

Integer

指定したレポートのIDです。 

ReportName

String

指定したレポートの名前です。

ReportTemplate

String

レポートに適用するテンプレートです。以下のいずれかになります。

  • REPORTANDCHART
  • CHART
  • REPORT

ReportUUID

String

レポートのUUIDです。

ReportUsage

Integer


ViewName

String

レポートが依存するビューの名前です。

Tags

String


ErrorCode

Integer

webサービスが失敗した場合のエラーのコード番号です。

Messages

String[]

レポートがサーバ上で実行されている時のデバッグ情報を示す文字列の配列です。デバッグとエラーのトレーシングに使用されます。

Anchor
以下の表
以下の表
ReportSchemaオブジェクトは、レポートカラム(列)の情報を含む、以下のパラメーターを返します。

パラメーター説明

ColumnName

String

レポートカラム(列)の名前です。

DisplayName

String

カラム(列)の表示名です。

ColumnLength

String

レポートカラム(列)の長さです。

FieldId

Integer

カラム(列)のフィールドIDです。

DataType

String

レポートカラム(列)のデータ型です。

SortOrder

Integer

カラム(列)を並べかえる順序です。

Hidden

Boolean

レポートでのカラム(列)表示有無です。

NumberOfDecimals

Integer


OutputLocation

String


AllowPrompt

Boolean

フィルターのみの設定です。

CachedValues

Boolean

フィルターのみの設定です。フィルターのキャッシュ値使用有無です。

FilterDisplayType

String

フィルターのみの設定です。カラム(列)がフィルタの場合のフィルター表示タイプです。

FilterId

String

フィルターのみの設定です。カラム(列)がフィルターの場合のフィルターIDです。

FilterOmittable

Boolean

フィルターのみの設定です。

FilterType

String

フィルターのみの設定です。フィルタータイプと、プロンプトに投入する必要のあるデータを決定します。

DefaultValue1

String

フィルターのみの設定です。フィルターが設定されている場合の最初のデフォルト値です。

DefaultValue2

String

フィルターのみの設定です。フィルターが設定されている場合の二番目のデフォルト値です。

FilterTypeCode

String

フィルターのみの設定です。

FilterUUID

String

フィルターのみの設定です。フィルターのUUIDです。

MinimumValue

BigDecimal

フィルターのみの設定です。フィルターが設定されている場合の最小値です。

MaximumValue

BigDecimal

フィルターのみの設定です。フィルターが設定されている場合の最大値です。

ParentFilterId

Integer

フィルターのみの設定です。依存フィルターが設定されている場合の親フィルターのフィルターIDです。

Prompt

Boolean

フィルターのみの設定です。カラム(列)がプロンプトフィルターであるかどうかです。

ValueUnitCode

String

フィルターのみの設定です。フィルターが設定されている場合の時間単位です。

応答の例

サービスは、今回のSOAPの例に基づき、以下の応答を返します。

Code Block
languagexml
themeEclipse
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
    <ns2:remoteReportCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
Code Block
themeEclipse
languagexml
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:remoteReportCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
         <return>
            <author>System Administrator</author>
            <authoringMode>JAVA</authoringMode>
            <averageRunTime>0</averageRunTime>
            <binaryData>UEsDBBQACAgIAN0Ma0wAAAAAAAAAAAAAAAATAAAAW0 ...</binaryData>
            <canDrill>false</canDrill><return>
            <category>Audit<author>System Reports<Administrator</category>author>
            <contentType>application/vnd.openxmlformats-officedocument.wordprocessingml.document</contentType><authoringMode>JAVA</authoringMode>
            <dashboardEnabled>true<<averageRunTime>0</dashboardEnabled>averageRunTime>
            <dataOutput>COLUMN<<canDrill>false</dataOutput>canDrill>
           <category>Tutorial</category>
 <datasource>Yellowfin Configuration Database</datasource>
         <columns>
   <errorCode>0</errorCode>
            <formatCode>REPORTANDCHART<<columnName>Region</formatCode>columnName>
               <hitCount>26<<dataType>TEXT</hitCount>dataType>
            <lastModifiedDate>2016-03-29</lastModifiedDate><displayName>Athlete Region</displayName>
            <lastRunDuration>0<<fieldId>1</lastRunDuration>fieldId>
            <lastRunStatus>RUN_NOERROR<<hidden>false</lastRunStatus>hidden>
            <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages> <numberOfDecimals>0</numberOfDecimals>
            <messages>Loaded Report: 56401 Successfully<<outputLocation>COLUMN</messages>outputLocation>
             <messages>Generating DOCX Report<<prompt>false</messages>prompt>
            <messages>Request Contains No ReportFilter Records.<<sortOrder>0</messages>sortOrder>
            <messages>Report Run Successfully</messages></columns>
            <messages>Web Service Request Complete</messages><columns>
            <preRunFilterString><![CDATA[<div class="rptFilterLogicText">
<span class="rptFilterLogicIdentifier">Active Session Start</span>
Is Not Null
<span class="rptFilterLogicIdentifier"></span>
</div>]]></preRunFilterString>
 <allowPrompt>false</allowPrompt>
               <private>false<<cachedValues>true</private>cachedValues>
               <reportDescription<columnName>Region</>columnName>
               <reportId>56401<<dataType>TEXT</reportId>dataType>
            <reportName>Active<displayName>Athlete Sessions<Region</reportName>displayName>
            <reportTemplate>REPORTANDCHART<<filterDisplayType>DROPDOWN</reportTemplate>filterDisplayType>
              <reportUUID>594d4da4-1b58-44d3-bf4f-11456a42f68c</reportUUID>
 <filterId>74908</filterId>
               <reportUsage>27<<filterOmittable>true</reportUsage>filterOmittable>
               <sessionId>9b4a5e7182d359795d176d56378ac0f2<<filterType>INLIST</sessionId>filterType>
               <statusCode>SUCCESS<<filterTypeCode>FILTER</statusCode>filterTypeCode>
            <subCategory>Admin Reports</subCategory>
 <filterUUID>d4ea61ab-247e-403a-b51b-8243aeea63db</filterUUID>
              <tags>No tags<<numberOfDecimals>0</tags>numberOfDecimals>
            <viewName>NEW   VIEW<<prompt>true</viewName>prompt>
         </return>
      <sortOrder>0</sortOrder>
            </ns2:remoteReportCallResponse>columns>
    </S:Body>
</S:Envelope>  

 

手順

Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。

Expand
title詳細手順
インターネットブラウザから、「http://<host>:<port>/ws_docxreport.jsp」を実行します。
ReportServiceRequest
 
rsr
 
=
 
new
 
ReportServiceRequest();
  
rsr.setLoginId("admin@yellowfin.com.au"); rsr.setPassword("test"); rsr.setOrgId(new Integer(1)); rsr.setReportRequest("DOCX");

レポートの保存されているクライアント組織を指定する必要がある場合は、こちらのコードを追加します。

 

rsr.setOrgRef("org1");
<dashboardEnabled>true</dashboardEnabled>
            <dataOutput>COLUMN</dataOutput>
            <datasource>Ski Team !!!</datasource>
            <drillCode>DRILLDOWN</
/
drillCode>
    
search
 
for
 
the
 
report
 
in
 
this
 
client
 
org
  • DOCX書式に変換するレポートを指定します。

     

  • Code Block
    themeEclipse
    languagejava
    管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの呼び出しを実行するための基礎的なリクエストです。
    Code Block
    themeEclipse
    languagejava
    Code Block
    themeEclipse
    languagejava
    Code Block
    themeEclipse
    languagejava
    rsr.setReportId(60712);
    リクエストを構成したら、呼び出しを実行します。
    Code Block
    languagejava
    ReportServiceResponse rs=rsc.remoteReportCall(rsr);

    レポートwebサービスを初期化します。実行方法の詳細は、こちらを参照してください。

     

    返される応答には、StatusCode、ReportID、BinaryDataなどのパラメーターが含まれます。(より詳細な情報は、上記応答パラメーターの表を参照してください)

     

    完成例

    以下は、こちらの関数の完成例です。こちらを使用するには、以下の手順に従います。

  • コードをコピーして、「ws_docxreport.jsp」として保存します。
  • root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
  • 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
  • /* <errorCode>0</errorCode>
                <formatCode>REPORTANDCHART</formatCode>
             ws_docxreport.jsp   *<hitCount>3</hitCount>
      
    <%@  page language="java" contentType="text/html; charset=UTF-8" %>
    <%@ page import="com.hof.util.*, java.util.*, java.text.*" %>
    <%@ page import="com.hof.web.form.*" %>
    <%@ page import="com.hof.mi.web.service.*" %>
    <%@ page import="javax.xml.bind.JAXBContext" %>
    <%@ page import="javax.xml.bind.Marshaller" %>
    <%@ page import="java.io.StringWriter" %>
    <%@ page import="javax.xml.bind.JAXBElement" %>
    <%@ page import="javax.xml.namespace.QName" %>
    <%
     
     
    ReportService rsc = new ReportService();   //("localhost", 8080, "admin@yellowfin.com.au", "test", "/services/ReportService");
        ReportServiceRequest rsr = new ReportServiceRequest();
        rsr.setLoginId("admin@yellowfin.com.au");
        rsr.setPassword("test");
        rsr.setOrgId(new Integer(1));
        rsr.setReportRequest("DOCX");
        rsr.setOrgRef("1");
        rsr.setReportId(60712);
        rsr.setReportClientReferenceId("1");
        ReportServiceResponse rs=rsc.remoteReportCall(rsr);
        if ("SUCCESS".equals(rs.getStatusCode())) { <lastModifiedDate>2018-06-07</lastModifiedDate>
                <lastRunDuration>0</lastRunDuration>
                <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
                <messages>Loaded Report: 74907 Successfully</messages>
                <messages>Collating Schema Information</messages>
                <messages>Web Service Request Complete</messages>
                <preRunFilterString><![CDATA[<div class="rptFilterLogicText">
    <span class="rptFilterLogicIdentifier">Athlete Region</span>
    In List
    <span class="rptFilterLogicIdentifier">[User Prompt]</span>
    </div>]]></preRunFilterString>
                <private>false</private>
              JAXBContext context = JAXBContext.newInstance(ReportServiceResponse.class);
       <reportDescription>Ski Team, 8/6/2018 9:36 AM</reportDescription>
             Marshaller m = context.createMarshaller(); <reportId>74907</reportId>
                m.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE); // To format XML<reportName>cached filters</reportName>
                JAXBElement<ReportServiceResponse><reportTemplate>REPORTANDCHART</reportTemplate>
     rootElement = new JAXBElement<ReportServiceResponse>(new QName("ReportServiceResponse"), ReportServiceResponse.class, rs);
          <reportUUID>982500e8-7b33-476b-be47-6a1aab611349</reportUUID>
                m.marshal(rootElement,out);
    <reportUsage>100</reportUsage>
                <sessionId>7e9971ea99fff609387ac1c504abcc63<//out.write("Success");
    sessionId>
                <statusCode>SUCCESS</statusCode>
         }      else {
    <subCategory>Training</subCategory>
                 out.write("Failure");
    <tags>No tags</tags>
             out.write(" Code: " + rs.getErrorCode());<viewName>Ski Team</viewName>
        }
    %>
    Expand
    titlePDF
         </return>
        </ns2:remoteReportCallResponse>
       </S:Body>
    </S:Envelope>


    手順

    Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。

    Expand
    title詳細手順
    • 管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの呼び出しを実行するための基礎的なリクエストです。

      Code Block
      languagejava
      themeEclipse
      ReportServiceRequest rsr = new ReportServiceRequest();
       
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(new Integer(1));
       
      rsr.setReportRequest("SCHEMA");


    • レポートの保存されているクライアント組織を指定する必要がある場合は、こちらのコードを追加します。


      Code Block
      languagejava
      themeEclipse
      rsr.setOrgRef("org1");      // search for the report in this client org


    • ステータスを変更するレポートのコメントを指定することができます。


      Code Block
      languagejava
      themeEclipse
      rsr.setReportId(70045);


    • リクエストを構成したら、呼び出しを実行します。

      Code Block
      languagejava
      ReportServiceResponse rs=rsc.remoteReportCall(rsr);

      レポートwebサービスを初期化します。実行方法の詳細は、こちらを参照してください。


    • 返される応答には、他のレポート固有のパラメーターとともに、StatusCodeパラメーターが含まれます。詳細は、上記応答パラメーターの表を参照してください。


    完成例

    以下は、こちらの関数の完成例です。こちらを使用するには、以下の手順に従います。

    1. コードをコピーして、「ws_reportschema.jsp」として保存します。
    2. root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
    3. 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
    4. インターネットブラウザから、「http://<host>:<port>/ws_reportschema.jsp」を実行します。

    Code Block
    languagejava
    themeEclipse
    <%          
    /*

    PDFリクエストは、指定されたレポートを実行し、PDF書式で返します。

     

    リクエスト要素

    以下の要素は、こちらのリクエストとともに渡されます。

    リクエスト要素データ型説明

    LoginId

    String

    Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。

    このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト(プライマリー)組織に所属していなくてはいけません。

    Password

    String

    上記アカウントのパスワードです。

    OrgId

    Integer

    Yellowfin内のデフォルト(プライマリー)組織IDです。常に、「1」に設定します。

    ReportRequestStringwebサービス関数です。「PDF」に設定します。
    ReportIdIntegerPDF書式で返すレポートを指定するための内部IDです。

     

    リクエストの例

    以下のSOAPの例は、こちらの呼び出しに渡すことのできるパラメーターを示しています。

    Code Block
    languagexml
    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
       <soapenv:Header/>
       <soapenv:Body>
          <web:remoteReportCall>
             <arg0>
         ws_reportschema.jsp       <loginId>admin@yellowfin.com.au</loginId>
                <password>test</password>
                <orgId>1</orgId>
                <reportRequest>PDF</reportRequest>
                <reportId>56401</reportId>*/
    %>
    <%@ page language="java" contentType="text/html; charset=UTF-8" %>
    <%@ page import="com.hof.util.*, java.util.*, java.text.*" %>
    <%@ page import="com.hof.web.form.*" %>
    <%@ page import="com.hof.mi.web.service.*" %>
    <%
        ReportServiceResponse rs = null;
        ReportServiceRequest rsr = new ReportServiceRequest();
         </arg0>
          </web:remoteReportCall>
       </soapenv:Body>
    </soapenv:Envelope>

     

    応答要素

    応答には、これらの主要なパラメーターが含まれます。

    応答要素データ型説明取得コード
    ReportIdInteger指定したレポートのIDです。getReportId()

    ReportName

    String

    指定したレポートの名前です。

    getReportName()

    HitCount

    Integer

    指定したレポートがアクセスされた回数です。

    getHitCount()

    FormatCode

    String

    指定したレポートの書式コードです。

    getFormatCode()

    BinaryData

    String

    Base64でエンコードされたPDFのバイナリーチャンクです。

    getBinaryData()

    ContentType

    String

    このオブジェクトのMIMEコンテンツタイプです。値は「application/pdf」です。

    getContentType()

     

    応答の例

    サービスは、今回のSOAPの例に基づき、以下の応答を返します。

    Code Block
    themeEclipse
    languagexml
    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
       <S:Body>
          <ns2:remoteReportCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">ReportServiceService ts = new ReportServiceServiceLocator("localhost", 8080, "/services/ReportService", false);
        ReportServiceSoapBindingStub rssbs = (ReportServiceSoapBindingStub) ts.getReportService();
      
        rsr.setLoginId("admin@yellowfin.com.au");
        rsr.setPassword("test");
        rsr.setOrgId(1);
        rsr.setReportRequest("SCHEMA");
         
        rsr.setReportId(70045);
         
        rs = rssbs.remoteReportCall(rsr);
      
        if ("SUCCESS".equals(rs.getStatusCode())) {
             <return>out.write("Success </br>");
                <author>System Administrator</author>
                <authoringMode>JAVA</authoringMode>
                <averageRunTime>0</averageRunTime>ReportSchema[] schema = rs.getColumns();
                <binaryData>JVBERi0xLjQKJeLjz9MKNCAwIG9iago8PC9GaWx0ZXIvRmxhdGVEZWNvZGUvTGVuZ3RoIDI4OT4+
    c3RyZWFtCnic7VNNSwMxEI1 . . .</binaryData>
                <canDrill>false</canDrill>
             for (ReportSchema  <category>Audit Reports</category>
    s: schema)
                  <contentType>application/pdf</contentType>
                <dashboardEnabled>true</dashboardEnabled>
                <dataOutput>COLUMN</dataOutput>
                <datasource>Yellowfin Configuration Database</datasource>//display filters:
                <errorCode>0</errorCode>
                <formatCode>REPORTANDCHART</formatCode>
                <hitCount>25</hitCount>
                <lastModifiedDate>2018-07-02</lastModifiedDate>
        if (s.getFilterType() != null && s.getFilterTypeCode().equals("FILTER")){
       <lastRunDuration>0</lastRunDuration>
                <lastRunStatus>RUN_NOERROR</lastRunStatus>
                <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
                  <messages>Loaded Report: 56401 Successfully</messages>
                <messages>Generating PDF Report</messages>
                <messages>Request Contains No ReportFilter Records.</messages>out.write("<br>Display Name: " + s.getDisplayName());
                <messages>Report Run Successfully</messages>
                <messages>Web Service Request Complete</messages>
                <preRunFilterString><![CDATA[<div class="rptFilterLogicText">
    <span class="rptFilterLogicIdentifier">Active Session Start</span>
    Is Not Null
    <span class="rptFilterLogicIdentifier"></span>
    </div>]]></preRunFilterString>
                <private>false</private>
                <reportDescription/>
      out.write("<br>Filter UUID:" + s.getFilterUUID());
                  <reportId>56401</reportId>
                <reportName>Active Sessions</reportName>
                <reportTemplate>REPORTANDCHART</reportTemplate>
                <reportUUID>594d4da4-1b58-44d3-bf4f-11456a42f68c</reportUUID>
                <reportUsage>100</reportUsage>
             out.write("<br>Filter Id:"  <sessionId>bb2175f6da398640f670ff666c40fcfa</sessionId>+ s.getFilterId());
                <statusCode>SUCCESS</statusCode>
                 <subCategory>Admin Reports</subCategory>
                <tags>No tags</tags>
                <viewName>NEW VIEW</viewName>}
        } else {
       </return>
         out.write(rs.getStatusCode());
            </ns2:remoteReportCallResponse>out.write(rs.toString());
       </S:Body>
    </S:Envelope>

     

    手順

    Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。

    Expand
    title詳細手順
    管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの呼び出しを実行するための基礎的なリクエストです。
    Code Block
    themeEclipse
    languagejava
    ReportServiceRequest rsr = new ReportServiceRequest();
      
    rsr.setLoginId("admin@yellowfin.com.au");
    rsr.setPassword("test");
    rsr.setOrgId(new Integer(1));
     
    rsr.setReportRequest("PDF");
  • レポートの保存されているクライアント組織を指定する必要がある場合は、こちらのコードを追加します。

     

    Code Block
    themeEclipse
    languagejava
    rsr.setOrgRef("org1");      // search for the report in this client org
  • PDF書式で参照するレポートを指定します。

     

    Code Block
    themeEclipse
    languagejava
    rsr.setReportId(60712);
  • リクエストを構成したら、呼び出しを実行します。
    Code Block
    languagejava
    ReportServiceResponse rs=rsc.remoteReportCall(rsr);

    レポートwebサービスを初期化します。実行方法の詳細は、こちらを参照してください。

     

    返される応答には、レポートに関連するパラメーターが含まれます。(より詳細な情報は、上記応答パラメーターの表を参照してください)

     

    完成例

    以下は、こちらの関数の完成例です。こちらを使用するには、以下の手順に従います。

  • コードをコピーして、「ws_pdfreport.jsp」として保存します。
  • root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
  • 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
  • インターネットブラウザから、「http://<host>:<port>/ws_pdfreport.jsp」を実行します。
    Code Block
    themeEclipse
    languagejava
    /*              ws_pdfreport.jsp   */
      
    <%@ page language="java" contentType="text/html; charset=UTF-8" %>
    <%@ page import="com.hof.util.*, java.util.*, java.text.*" %>
    <%@ page import="com.hof.web.form.*" %>
    <%@ page import="com.hof.mi.web.service.*" %>
    <%@ page import="javax.xml.bind.JAXBContext" %>
    <%@ page import="javax.xml.bind.Marshaller" %>
    <%@ page import="java.io.StringWriter" %>
    <%@ page import="javax.xml.bind.JAXBElement" %>
    <%@ page import="javax.xml.namespace.QName" %>
    <%
        ReportService rsc = new ReportService();        //("localhost", 8080, "admin@yellowfin.com.au", "test", "/services/ReportService");
        ReportServiceRequest rsr = new ReportServiceRequest();
     
        rsr.setLoginId("admin@yellowfin.com.au");
        rsr.setPassword("test");
        rsr.setOrgId(new Integer(1));
        rsr.setReportRequest("PDF");
        rsr.setOrgRef("1");
        rsr.setReportId(60712);
        rsr.setReportClientReferenceId("1");
     
        ReportServiceResponse rs=rsc.remoteReportCall(rsr);
     
        if ("SUCCESS".equals(rs.getStatusCode())) {
             
              JAXBContext context = JAXBContext.newInstance(ReportServiceResponse.class);
                Marshaller m = context.createMarshaller();
                m.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE); // To format XML
                JAXBElement<ReportServiceResponse> rootElement = new JAXBElement<ReportServiceResponse>(new QName("ReportServiceResponse"), ReportServiceResponse.class, rs);
                m.marshal(rootElement,out);   
            //out.write("Success");
        } else {
            out.write("Failure");
            out.write(" Code: " + rs.getErrorCode());
        }
    %>
    Expand
    titleCSV
     }
    %>



    Expand
    titleFILTEROPTIONS

    webサービスは、指定したレポートのフィルター値を返します。

    注意:現在、このリクエストにユーザー情報を渡す方法はありません。そのため、特定の値を制限するアクセスフィルターがレポートに適用されている場合、ログインしているユーザー(このwebサービスを呼び出しているユーザー)がアクセスできるフィルター値のみが返されます。


    リクエスト要素

    以下の要素は、こちらのリクエストとともに渡されます。

    リクエスト要素データ型説明

    LoginId

    String

    Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。

    このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト(プライマリー)組織に所属していなくてはいけません。

    Password

    String

    上記アカウントのパスワードです。

    OrgId

    Integer

    Yellowfin内のデフォルト(プライマリー)組織IDです。常に、「1」に設定します。

    ReportRequestStringwebサービス関数です。「FILTEROPTIONS」に設定します。
    OrgRefString(オプション設定)特定のクライアント組織を指定してレポートを検索する場合の、クライアント組織内部参照IDです。こちらが指定されてない場合、デフォルト組織から検索されます。
    ReportClientReferenceIdString(オプション設定)特定のクライアント組織を指定する、別のオプションです。
    ReportIdInteger特定のレポートを検索するための内部レポートIDです。レポートIDは、レポートが編集される度に変更されます。ヒント:関連するレポートIDを取得するために、GETIDFROMUUID関数を使用することができます。
    ObjectNameString内部フィルターIDです。ヒント:レポートが編集される度に変更されるため、SCHEMA関数を使用して有効なフィルターIDを取得します。


    リクエストの例

    以下のSOAPの例は、こちらの呼び出しに渡すことのできるパラメーターを示しています。

    Code Block
    languagexml
    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
       <soapenv:Header/>
       <soapenv:Body>
        <web:remoteReportCall>
            <arg0>
                <loginId>admin@yellowfin.com.au</loginId>
                    <password>test</password>
                    <orgId>1</orgId>
                    <reportRequest>FILTEROPTIONS</reportRequest>
                    <reportId>70066</reportId>
                    <objectName>70081</objectName>
             </arg0>
        </web:remoteReportCall>
       </soapenv:Body>
    </soapenv:Envelope>


    応答要素

    応答には、これらの主要なパラメーターが含まれます。

    応答要素データ型説明

    StatusCode

    String

    Webサービスリクエストのステータスです。値の選択肢は、以下の通りです。

    • SUCCESS
    • FAILURE

    Results

    ReportRow[]

    利用可能なフィルター値の配列です。より詳細な情報は、以下のを参照してください。

    Author

    String

    レポートを作成したユーザーの名前です。

    AuthoringMode

    String


    AverageRunTime

    Integer


    CanDrill

    Boolean

    レポートのドリル可否です。

    Category

    String

    レポートが保存されているフォルダーの名前です。

    SubCategory

    String

    レポートが保存されているサブフォルダーの名前です。

    DashboardEnabled

    Boolean


    DataOutput

    String

    以下のいずれかになります。
    • COLUMN
    • ROW
    • PIVOT

    Datasource

    String

    このレポートに使用されているデータソースの名前です。

    FormatCode

    String

    指定したレポートの書式コードです。以下のいずれかになります。

    • REPORTANDCHART
    • CHART
    • REPORT

    HitCount

    Integer

    指定したレポートがアクセスされた回数です。

    LastModifiedDate

    String

    レポートが最後に変更された日付です。

    LastRunDuration

    Integer


    PreRunFilterString

    String


    Private

    Boolean

    レポートが非公開、または公開のどちらであるかを定義します。(レガシーサービスの場合は非公開です)

    ReportDescription

    String

    指定したレポートの説明です。 

    ReportId

    Integer

    指定したレポートのIDです。 

    ReportName

    String

    指定したレポートの名前です。 

    ReportTemplate

    String

    レポートに適用するテンプレートです。以下のいずれかになります。

    • REPORTANDCHART
    • CHART
    • REPORT

    ReportUUID

    String

    レポートのUUIDです。

    ReportUsage

    Integer


    ViewName

    String

    レポートが依存するビューの名前です。 

    Tags

    String


    ErrorCode

    Integer

    webサービスが失敗した場合のエラーのコード番号です。 

    Messages

    String[]

    レポートがサーバ上で実行されている場合にデバッグ情報を示す文字列の配列です。デバッグとエラーのトレーシングに使用されます。 

    Anchor
    以下の表2
    以下の表2
    ReportRowオブジェクトは、以下のパラメーターを返します。

    パラメーター説明
    DataValueString[]レポート結果セット内の各カラム(列)データの文字列の配列です。


    応答の例

    サービスは、今回のSOAPの例に基づき、以下の応答を返します。

    Code Block
    languagexml
    themeEclipse
    <S:Envelope xmlns:S

    こちらのリクエストは、指定されたレポートを実行し、CSV書式(カンマ区切り値)で返します。

     

    リクエスト要素

    以下の要素は、こちらのリクエストとともに渡されます。

    リクエスト要素データ型説明

    LoginId

    String

    Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。

    このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト(プライマリー)組織に所属していなくてはいけません。

    Password

    String

    上記アカウントのパスワードです。

    OrgId

    Integer

    Yellowfin内のデフォルト(プライマリー)組織IDです。常に、「1」に設定します。

    ReportRequestStringwebサービス関数です。「CSV」に設定します。
    ReportIdIntegerCSV書式で返すレポートを指定するための内部IDです。

     

    リクエストの例

    以下のSOAPの例は、こちらの呼び出しに渡すことのできるパラメーターを示しています。

    Code Block
    languagexml
    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
       <S:Body>
        <ns2:remoteReportCallResponse xmlns:webns2="http://webservices.web.mi.hof.com/">
            <soapenv:Header/><return>
        <soapenv:Body>
             <web:remoteReportCall><author>System Administrator</author>
             <arg0>   <authoringMode>JAVA</authoringMode>
                <loginId>admin@yellowfin.com.au</loginId><averageRunTime>0</averageRunTime>
                <password>test<<canDrill>false</password>canDrill>
                <orgId>1<<category>Tutorial</orgId>category>
                <reportRequest>CSV<<dashboardEnabled>true</reportRequest>dashboardEnabled>
                <reportId>56401<<dataOutput>COLUMN</reportId>dataOutput>
                <datasource>Ski <Team</arg0>
    datasource>
                <<errorCode>0</web:remoteReportCall>
    errorCode>
             </soapenv:Body>
    </soapenv:Envelope>

     

    応答要素

    応答には、これらの主要なパラメーターが含まれます。

    応答要素データ型説明取得コード
    ReportIdInteger指定したレポートのIDです。getReportId()

    ReportName

    String

    指定したレポートの名前です。

    getReportName()

    HitCount

    Integer

    指定したレポートがアクセスされた回数です。

    getHitCount()

    FormatCode

    String

    指定したレポートの書式コードです。

    getFormatCode()

    BinaryData

    String

    Base64でエンコードされたCSVのバイナリーチャンクです。

    getBinaryData()

    ContentType

    String

    このオブジェクトのMIMEコンテンツタイプです。値は「text/comma-separated-values」です。

    getContentType()

     

    応答の例

    サービスは、今回のSOAPの例に基づき、以下の応答を返します。

    Code Block
    themeEclipse
    languagexml
    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
       <S:Body>
       <formatCode>REPORTANDCHART</formatCode>
                <hitCount>2</hitCount>
                <lastModifiedDate>2018-06-18</lastModifiedDate>
                <lastRunDuration>0</lastRunDuration>
                <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
                <messages>Loaded Report: 70080 Successfully</messages>
             <ns2:remoteReportCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
      <messages>Retrieving Options</messages>
          <return>
          <messages>Request Contains No    <author>System Administrator</author>ReportFilter Records.</messages>
                <authoringMode>JAVA</authoringMode>
          <messages>Region (FilterId: 70082 ) Requires User Prompt</messages>
          <averageRunTime>0</averageRunTime>
          <messages>Ignoring Prompt Filter On Field:  <binaryData>Tm8gcmVzdWx0cyByZXR1cm5lZC4K<70082</binaryData>messages>
                <canDrill>false</canDrill>
          <messages>DEMOGRAPHIC (FilterId: 70081 ) Requires User Prompt</messages>
          <category>Audit Reports</category>
         <messages>Web Service Request Complete</messages>
        <contentType>text/comma-separated-values</contentType>
            <preRunFilterString><![CDATA[<div class="rptFilterLogicText">
    <span   <dashboardEnabled>true</dashboardEnabled>
                <dataOutput>COLUMN</dataOutput>
         class="rptFilterLogicIdentifier">Athlete Region</span>
    In List
    <span class="rptFilterLogicIdentifier">[User Prompt]</span>
    </div>
    <div class="rptFilterLogicText">
    AND
    <span class="rptFilterLogicIdentifier">Demographic</span>
    In List
    <span class="rptFilterLogicIdentifier">(Adventure, Relaxation, Family, Culture)</span>
    </div>]]></preRunFilterString>
           <datasource>Yellowfin Configuration Database</datasource>
       <private>false</private>
             <errorCode>0</errorCode>
       <reportDescription>Ski Team, 18/6/2018       <formatCode>REPORTANDCHART</formatCode>2:49 PM</reportDescription>
                <hitCount>26<<reportId>70066</hitCount>reportId>
                <lastModifiedDate>2018-07-02</lastModifiedDate><reportName>qwerty</reportName>
                <lastRunDuration>0<<reportTemplate>REPORTANDCHART</lastRunDuration>reportTemplate>
                <lastRunStatus>RUN_NOERROR</lastRunStatus>
    <reportUUID>c105ab26-9744-434d-9c8c-9fb9e48d80c0</reportUUID>
                <reportUsage>100</reportUsage>
             <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages> <results>
                <messages>Loaded Report: 56401 Successfully<<dataValue>Asia</messages>dataValue>
                 <messages>Generating CSV Report<<dataValue>Asia</messages>dataValue>
                </results>
      <messages>Request  Contains No ReportFilter Records.</messages>
         <sessionId>eb31d9392a25c8c40995237650837cd5</sessionId>
           <messages>Report Run Successfully</messages>
       <statusCode>SUCCESS</statusCode>
             <messages>Web Service Request Complete<<subCategory>Training</messages>subCategory>
                <preRunFilterString><![CDATA[<div class="rptFilterLogicText">
    <span class="rptFilterLogicIdentifier">Active Session Start</span>
    Is Not Null
    <span class="rptFilterLogicIdentifier"></span>
    </div>]]></preRunFilterString>
    <tags>No tags</tags>
                        <private>false</private><viewName>New View</viewName>
                <reportDescription/></return>
                <reportId>56401</reportId></ns2:remoteReportCallResponse>
                <reportName>Active Sessions<</S:Body>
    </S:Envelope>


    手順

    Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。

    Expand
    title詳細手順
    • 管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの呼び出しを実行するための基礎的なリクエストです。

      Code Block
      languagejava
      themeEclipse
      ReportServiceRequest rsr = new ReportServiceRequest();
       
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(new Integer(1));
       
      rsr.setReportRequest("FILTEROPTIONS");


    • フィルターを取得するレポートを指定します。


      Code Block
      languagejava
      themeEclipse
      rsr.setReportId(70066);


    • 特定のフィルターを取得する場合は、ObjectNameパラメーターにフィルターIDを提供します。


      Code Block
      languagejava
      themeEclipse
      rsr.setObjectName("70081");


    • リクエストを構成したら、呼び出しを実行します。

      Code Block
      languagejava
      ReportServiceResponse rs=rsc.remoteReportCall(rsr);

      レポートwebサービスを初期化します。実行方法の詳細は、こちらを参照してください。


    • 返される応答には、他のレポート固有のパラメーターとともに、StatusCodeパラメーターが含まれます。詳細は、上記応答パラメーターの表を参照してください。


    完成例

    以下は、こちらの関数の完成例です。こちらを使用するには、以下の手順に従います。

    1. コードをコピーして、「ws_filteroptions.jsp」として保存します。
    2. root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
    3. 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
    4. インターネットブラウザから、「http://<host>:<port>/ws_filteroptions.jsp」を実行します。

    Code Block
    languagejava
    themeEclipse
    <%/reportName>
                <reportTemplate>REPORTANDCHART</reportTemplate>
                <reportUUID>594d4da4-1b58-44d3-bf4f-11456a42f68c</reportUUID>
                <reportUsage>100</reportUsage>
                <sessionId>6f95db60d17d24138a5faf23190f5a6e</sessionId>
                <statusCode>SUCCESS</statusCode>
                <subCategory>Admin Reports</subCategory>
               
    /* <tags>No tags</tags>
                <viewName>NEW VIEW</viewName>
    ws_filteroptions.jsp          </return>
                      */
    %>
    <%
        ReportServiceResponse rs  </ns2:remoteReportCallResponse>
       </S:Body>
    </S:Envelope>

     

    手順

    Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。

    Expand
    title詳細手順
    インターネットブラウザから、「http://<host>:<port>/ws_csvreport.jsp」を実行します。
    = null;
        ReportServiceRequest rsr = new ReportServiceRequest();
        ReportServiceService 
    rsr.setLoginId("admin@yellowfin.com.au"); rsr.setPassword("test"); rsr.setOrgId(new Integer(1)); rsr.setReportRequest("CSV");
  • レポートの保存されているクライアント組織を指定する必要がある場合は、こちらのコードを追加します。

     

  • Code Block
    themeEclipse
    languagejava
    管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの呼び出しを実行するための基礎的なリクエストです。
    Code Block
    themeEclipse
    languagejava
    Code Block
    themeEclipse
    languagejava
    rsr.setOrgRef("org1");      // search for the report in this client org
  • CSV書式で参照するレポートを指定します。

     

    Code Block
    themeEclipse
    languagejava
    rsr.setReportId(60712);
  • リクエストを構成したら、呼び出しを実行します。
    Code Block
    languagejava
    ReportServiceResponse rs=rsc.remoteReportCall(rsr);

    レポートwebサービスを初期化します。実行方法の詳細は、こちらを参照してください。

     

    返される応答には、レポートに関連するパラメーターが含まれます。(より詳細な情報は、上記応答パラメーターの表を参照してください)

     

    完成例

    以下は、こちらの関数の完成例です。こちらを使用するには、以下の手順に従います。

  • コードをコピーして、「ws_csvreport.jsp」として保存します。
  • root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
  • 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
  • /*ts = new ReportServiceServiceLocator("localhost", 8080, "/services/ReportService", false);
        ReportServiceSoapBindingStub rssbs = (ReportServiceSoapBindingStub) ts.getReportService();
      
        rsr.setLoginId("admin@yellowfin.com.au");
        rsr.setPassword("test");
        rsr.setOrgId(1);
        rsr.setReportRequest("FILTEROPTIONS");
         
        rsr.setReportId(70066);
        rsr.setObjectName("70081");
                  ws_csvreport.jsp   */
         
    <%@    pagers language="java" contentType="text/html; charset=UTF-8" %>
    <%@ page import="com.hof.util.*, java.util.*, java.text.*" %>
    <%@ page import="com.hof.web.form.*" %>
    <%@ page import="com.hof.mi.web.service.*" %>
    <%@ page import="javax.xml.bind.JAXBContext" %>
    <%@ page import="javax.xml.bind.Marshaller" %>
    <%@ page import="java.io.StringWriter" %>
    <%@ page import="javax.xml.bind.JAXBElement" %>
    <%@ page import="javax.xml.namespace.QName" %>
    <%
        ReportService rsc = new ReportService(); rssbs.remoteReportCall(rsr);
      
        if ("SUCCESS".equals(rs.getStatusCode())) {
            out.write("Success </br>");
                                       //("localhost", 8080, "admin@yellowfin.com.au", "test", "/services/ReportService");
     ReportRow[] rows = rs.getResults();
          ReportServiceRequest rsr = new ReportServiceRequest();
        rsr.setLoginId("admin@yellowfin.com.au");
        rsr.setPassword("test");
        rsr.setOrgId(new Integer(1));
        rsr.setReportRequest("CSV");
        rsr.setOrgRef("1");
         for rsr.setReportId(60712);
    (ReportRow r: rows) {
         rsr.setReportClientReferenceId("1");
        ReportServiceResponse rs=rsc.remoteReportCall(rsr);
        if ("SUCCESS".equals(rs.getStatusCode())) {
             
              JAXBContext context = JAXBContext.newInstance(ReportServiceResponse.class);
                Marshaller m = context.createMarshaller();
     //display filter values:           m.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE); // To format XML
                JAXBElement<ReportServiceResponse> rootElement = new JAXBElement<ReportServiceResponse>(new QName("ReportServiceResponse"), ReportServiceResponse.class, rs);
           
                              m.marshal(rootElement,out);                
            //out.write("Success");
        } else {
            out.write("Failure");
            out.write(" Code: <br>" + rsr.getErrorCodegetDataValue()[0]);
                         }
    %>
    Expand
    titleTEXT

    リクエストは、指定されたレポートを実行し、テキスト書式で返します。

     

    リクエスト要素

    以下の要素は、こちらのリクエストとともに渡されます。

    リクエスト要素データ型説明

    LoginId

    String

    Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。

    このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト(プライマリー)組織に所属していなくてはいけません。

    Password

    String

    上記アカウントのパスワードです。

    OrgId

    Integer

    Yellowfin内のデフォルト(プライマリー)組織IDです。常に、「1」に設定します。

    ReportRequestStringwebサービス関数です。「TEXT」に設定します。
    ReportIdIntegerTEXT書式で返すレポートを指定するための内部IDです。

     

    リクエストの例

    以下のSOAPの例は、こちらの呼び出しに渡すことのできるパラメーターを示しています。

    Code Block
    languagexml
    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
       <soapenv:Header/>
       <soapenv:Body>
          <web:remoteReportCall>
             <arg0>
            }
        <loginId>admin@yellowfin.com.au</loginId>
                <password>test</password>} else {
                <orgId>1</orgId>out.write(rs.getStatusCode());
                <reportRequest>TEXT</reportRequest>out.write(rs.toString());
                <reportId>60712</reportId>
                </arg0>
          </web:remoteReportCall>
       </soapenv:Body>
    </soapenv:Envelope>}
    %>





    レポート結果セット関数

    これらのwebサービスは、レポートにより生成される結果に固有のものです。

    Expand
    titleRESULTSET

    こちらのwebサービスは、指定したレポートの結果データと、レポートのメタデータを取得します。レポートの結果は、書式設定されていないそのままの形式になります。この結果は、ReportRowオブジェクトの配列に保存され、このオブジェクトは、各結果ロウ(行)を表します。そのため、各ロウ(行)に対して、結果データの各カラム(列)のデータを含む文字列の配列が存在します。

    注意:このデータを、文字列表現から各特定のカラム(列)のデータ型に変換するのは、webサービスクライアント次第です。各カラム(列)のデータ型は、SCHEMA関数で取得することができます。

    例えば、以下は2つのカラム(列)を含み、各ユーザーロールに割り当てられたユーザー数を特定するロール集計レポートを示しています。

    ユーザーロール人数
    System Administrator1
    Consumer & Collaborator5
    Report Content Writer4

    こちらのwebサービスは、各ユーザーロールのReportRowオブジェクトを返します。各オブジェクトは、2つのデータ文字列を含みます。ひとつはロール名であり、もうひとつはユーザー数を表示します。



    リクエスト要素

    以下の要素は、こちらのリクエストとともに渡されます。

    リクエスト要素データ型説明

    LoginId

    String

    Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。

    このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト(プライマリー)組織に所属していなくてはいけません。

    Password

    String

    上記アカウントのパスワードです。

    OrgId

    Integer

    Yellowfin内のデフォルト(プライマリー)組織IDです。常に、「1」に設定します。

    ReportRequestStringwebサービス関数です。「RESULTSET」に設定します。
    OrgRefStringクライアント組織内部参照IDです。(オプション設定)
    ReportIdInteger結果データを参照するレポートのIDです。


    リクエストの例

    以下のSOAPの例は、こちらの呼び出しに渡すことのできるパラメーターを示しています。

    Code Block
    languagexml
    <soapenv:Envelope xmlns:soapenv

     

    応答要素

    応答には、これらの主要なパラメーターが含まれます。

    応答要素データ型説明取得コード
    ReportIdInteger指定したレポートのIDです。getReportId()

    ReportName

    String

    指定したレポートの名前です。

    getReportName()

    HitCount

    Integer

    指定したレポートがアクセスされた回数です。

    getHitCount()

    FormatCode

    String

    指定したレポートの書式コードです。

    getFormatCode()

    BinaryData

    String

    Base64でエンコードされたTEXTのバイナリーチャンクです。

    getBinaryData()

    ContentType

    String

    このオブジェクトのMIMEコンテンツタイプです。値は「text/tab-separated-values」です。

    getContentType()

     

    応答の例

    サービスは、今回のSOAPの例に基づき、以下の応答を返します。

    Code Block
    themeEclipse
    languagexml
    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
       <S:Body>
          <ns2:remoteReportCallResponse xmlns:ns2="httpxmlns:web="http://webservices.web.mi.hof.com/">
             <return><soapenv:Header/>
                <author>System Administrator</author><soapenv:Body>
                <authoringMode>JAVA</authoringMode><web:remoteReportCall>
                <averageRunTime>0</averageRunTime><arg0>
                <binaryData>Tm90IGZvciBSZS1TYWxlIExpY2VuY2UsLCwKVG9wIE4sQ29tcGFueSBOYW1lLERlbW9ncmFwaGlj
    LFN1bSBJbnZvaWNlZCAoUHJlZiBDdXJyZW5jeSkKIlRvcCBOIEFnZW5jaWVzICIsQmFyZ2FpbiBU
    cmlwcyxBZHZlbnR1cmUsIiQxMCw4NTYiCiJUb3AgTiBBZ2VuY2llcyAiLEJhcmdhaW4gVHJpcHMs
    RmFtaWx5LCIkMjk1LDgyNyIKIlRvcCBOIEFnZW5jaWVzICIsQmFyZ2FpbiBUcmlwcyxMdXh1cnks
    IiQxLDAzMiwwNTYiCiJUb3AgTiBBZ2VuY2llcyAiLEJhcmdhaW4gVHJpcHMsUmVsYXhhdGlvbiwi
    JDgwLDY2MCIKIlRvcCBOIEFnZW5jaWV . . .</binaryData><loginId>admin@yellowfin.com.au</loginId>
                <canDrill>false<<password>test</canDrill>password>
                <category>Tutorial<<orgId>1</category>orgId>
                <contentType>text/tab-separeted-values</contentType><reportRequest>RESULTSET</reportRequest>
                <dashboardEnabled>true<<reportId>58511</dashboardEnabled>reportId>
                <dataOutput>COLUMN<</dataOutput>arg0>
                <datasource>Ski Team</datasource></web:remoteReportCall>
       </soapenv:Body>
    </soapenv:Envelope>


    応答要素

    応答には、これらの主要なパラメーターが含まれます。(より詳細な応答パラメーターの一覧は、ReportServiceResponseオブジェクトを参照してください)

    応答要素データ型説明

    StatusCode

    String

    Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。

    • SUCCESS
    • FAILURE
    ResultsReportRow[]レポートのデータセットの結果を含むオブジェクトの配列です。


    応答の例

    サービスは、今回のSOAPの例に基づき、以下の応答を返します。

    Code Block
    languagexml
    themeEclipse
    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
       <S:Body>
          <errorCode>0</errorCode><ns2:remoteReportCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
             <return>
       <formatCode>REPORTANDCHART</formatCode>
             <author>System   <hitCount>5<Administrator</hitCount>author>
                <lastModifiedDate>2017-06-26</lastModifiedDate><authoringMode>JAVA</authoringMode>
                <lastRunDuration>0<<averageRunTime>0</lastRunDuration>averageRunTime>
                <lastRunStatus>RUN_NOERROR<<canDrill>false</lastRunStatus>
    canDrill>
                <category>Audit Reports</category>
          <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
       <dashboardEnabled>true</dashboardEnabled>
             <messages>Loaded Report: 60712 Successfully<<dataOutput>COLUMN</messages>dataOutput>
                <messages>Generating<datasource>Yellowfin TEXTConfiguration Report<Database</messages>datasource>
                <messages>Request<errorCode>0</errorCode>
     Contains No ReportFilter Records.</messages>
            <formatCode>REPORTANDCHART</formatCode>
        <messages>AGENCYNAME   (FilterId: 60723 ) Requires User Prompt<<hitCount>4</messages>hitCount>
                <messages>Report Run Successfully</messages>
    <lastModifiedDate>2016-04-13</lastModifiedDate>
                <lastRunDuration>0</lastRunDuration>
     <messages>Web Service Request Complete</messages>
            <lastRunStatus>RUN_NOERROR</lastRunStatus>
        <preRunFilterString><![CDATA[<div class="rptFilterLogicText">
    <span class="rptFilterLogicIdentifier">Company Name</span>
    In List
    <span class="rptFilterLogicIdentifier">[User Prompt]</span>
    </div>]]></preRunFilterString>
            <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
                <private>false</private>
       <messages>Loaded Report: 58511 Successfully</messages>
             <reportDescription>Top N Agencies compared<messages>Returning to all other Agencies by demographic</reportDescription>
    RAW Resultset</messages>
                <messages>Request Contains No ReportFilter <reportId>60712<Records.</reportId>messages>
                <messages>Report <reportName>AgencyRun Benchmark<Successfully</reportName>messages>
                <reportTemplate>REPORTANDCHART</reportTemplate><messages>Web Service Request Complete</messages>
                <reportUUID>c83357db-8aef-4ec7-ab72-fce34de9ee77</reportUUID><private>false</private>
                <reportDescription/>
                <reportUsage>0<<reportId>58511</reportUsage>reportId>
                <reportName>Role <sessionId>0b549fb1c8361edb2b83dee81227e460<Population</sessionId>reportName>
                <statusCode>SUCCESS<<reportTemplate>REPORTANDCHART</statusCode>reportTemplate>
                <subCategory>Marketing &amp; Booking</subCategory>
    <reportUUID>00c65743-15f8-4f93-ace1-e3d4d2b956eb</reportUUID>
                <reportUsage>7</reportUsage>
                <results>
                   <tags>No<dataValue>System tags<Administrator</tags>dataValue>
                 <viewName>New  View<<dataValue>1</viewName>dataValue>
                </return>
    results>
                </ns2:remoteReportCallResponse><results>
        </S:Body>
    </S:Envelope>

     

    手順

    Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。

    Expand
    title詳細手順
    インターネットブラウザから、「http://<host>:<port>/ws_textreport.jsp」を実行します。
    rsr.setOrgRef("org1");
               <dataValue>Consumer &amp; Collaborator</dataValue>
           
    //
     
    search
     
    for
     
    the
     
    report
     
    in
     
    this
     
    client org
  • TEXT書式で参照するレポートを指定します。

     

  • Code Block
    themeEclipse
    languagejava
    管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの呼び出しを実行するための基礎的なリクエストです。
    Code Block
    themeEclipse
    languagejava
    ReportServiceRequest rsr = new ReportServiceRequest();
      
    rsr.setLoginId("admin@yellowfin.com.au");
    rsr.setPassword("test");
    rsr.setOrgId(new Integer(1));
     
    rsr.setReportRequest("TEXT");

    レポートの保存されているクライアント組織を指定する必要がある場合は、こちらのコードを追加します。

     

    Code Block
    themeEclipse
    languagejava
    Code Block
    themeEclipse
    languagejava
    rsr.setReportId(60712);
    リクエストを構成したら、呼び出しを実行します。
    Code Block
    languagejava
    ReportServiceResponse rs=rsc.remoteReportCall(rsr);

    レポートwebサービスを初期化します。実行方法の詳細は、こちらを参照してください。

     

    返される応答には、レポートに関連するパラメーターが含まれます。(より詳細な情報は、上記応答パラメーターの表を参照してください)

     

    完成例

    以下は、こちらの関数の完成例です。こちらを使用するには、以下の手順に従います。

  • コードをコピーして、「ws_textreport.jsp」として保存します。
  • root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
  • 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
  • /* <dataValue>5</dataValue>
                </results>
      ws_textreport.jsp   */
      
    <%@ page language="java" contentType="text/html; charset=UTF-8" %>
    <%@ page import="com.hof.util.*, java.util.*, java.text.*" %>
    <%@ page import="com.hof.web.form.*" %>
    <%@ page import="com.hof.mi.web.service.*" %>
    <%@ page import="javax.xml.bind.JAXBContext" %>
    <%@ page import="javax.xml.bind.Marshaller" %>
    <%@ page import="java.io.StringWriter" %>
    <%@ page import="javax.xml.bind.JAXBElement" %>
    <%@ page import="javax.xml.namespace.QName" %>
    <%
        ReportService rsc = new ReportService(); <sessionId>c958af74f677c4b1f575bd728d3b25d0</sessionId>
                <statusCode>SUCCESS</statusCode>
                <subCategory>User Access</subCategory>
                <tags>No tags</tags>
             //("localhost", 8080, "admin@yellowfin.com.au", "test", "/services/ReportService");
     <viewName>NEW VIEW</viewName>
         ReportServiceRequest rsr = new ReportServiceRequest();
     </return>
          rsr.setLoginId("admin@yellowfin.com.au");</ns2:remoteReportCallResponse>
       </S:Body>
    </S:Envelope>


    手順

    Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。

    Expand
    title詳細手順
    • 管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの呼び出しを実行するための基礎的なリクエストです。

      Code Block
      languagejava
      themeEclipse
      ReportServiceRequest rsr = new ReportServiceRequest();
       
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(new Integer(1));
       
      rsr.setReportRequest("RESULTSET");


    • 結果セットを取得するレポートを指定します。


      Code Block
      languagejava
      themeEclipse
      rsr.setReportId(60712);


    • レポートクライアント参照IDを指定することもできます。


      Code Block
      languagejava
      themeEclipse
      rsr.setReportClientReferenceId("1");


    • リクエストを構成したら、呼び出しを実行します。

      Code Block
      languagejava
      ReportServiceResponse rs=rsc.remoteReportCall(rsr);

      レポートwebサービスを初期化します。実行方法の詳細は、こちらを参照してください。


    • 返される応答には、他のレポート固有のパラメーターとともに、StatusCodeと結果パラメーターが含まれます。詳細は、上記応答パラメーターの表を参照してください。


    完成例

    以下は、こちらの関数の完成例です。こちらを使用するには、以下の手順に従います。

    1. コードをコピーして、「ws_resultset.jsp」として保存します。
    2. root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
    3. 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
    4. インターネットブラウザから、「http://<host>:<port>/ws_resultset.jsp」を実行します。

    Code Block
    languagejava
    themeEclipse
    <%  rsr.setPassword("test");
        rsr.setOrgId(new Integer(1));
        rsr.setReportRequest("TEXT");
        rsr.setOrgRef("1");
        rsr.setReportId(60712);
        rsr.setReportClientReferenceId("1");
        ReportServiceResponse rs=rsc.remoteReportCall(rsr);
        if ("SUCCESS".equals(rs.getStatusCode())) {
             
    /*           JAXBContext context = JAXBContext.newInstance(ReportServiceResponse.class);
    ws_resultset.jsp            Marshaller m = context.createMarshaller();
                m.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE); // To format XML
                JAXBElement<ReportServiceResponse> rootElement = new JAXBElement<ReportServiceResponse>(new QName("ReportServiceResponse"), ReportServiceResponse.class, rs */
    %>
    <%@ page language="java" contentType="text/html; charset=UTF-8" %>
    <%@ page import="com.hof.util.*, java.util.*, java.text.*" %>
    <%@ page import="com.hof.web.form.*" %>
    <%@ page import="com.hof.mi.web.service.*" %>
    <%@ page import="javax.xml.bind.JAXBContext" %>
    <%@ page import="javax.xml.bind.Marshaller" %>
    <%@ page import="java.io.StringWriter" %>
    <%@ page import="javax.xml.bind.JAXBElement" %>
    <%@ page import="javax.xml.namespace.QName" %>
    <%
         
    ReportService rsc = new ReportService();   //("localhost", 8080, "admin@yellowfin.com.au", "test", "/services/ReportService");
        ReportServiceRequest rsr =      m.marshal(rootElement,out);   new ReportServiceRequest();
        rsr.setLoginId("admin@yellowfin.com.au");
        //outrsr.writesetPassword("Successtest");
         } else {rsr.setOrgId(new Integer(1));
        rsr.setReportRequest("RESULTSET");
        rsr.setReportId(60712);
        outrsr.writesetReportClientReferenceId("Failure1");
        ReportServiceResponse rs=rsc.remoteReportCall(rsr);
        if out.write(" Code: " + SUCCESS".equals(rs.getErrorCodegetStatusCode()));
     {
              }
    %>
    Expand
    titlePRINT

    webサービスは、デフォルトではなく、印刷可能な書式でレポートを返します。

     

    リクエスト要素

    以下の要素は、こちらのリクエストとともに渡されます。

    リクエスト要素データ型説明

    LoginId

    String

    Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。

    このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト(プライマリー)組織に所属していなくてはいけません。

    Password

    String

    上記アカウントのパスワードです。

    OrgId

    Integer

    Yellowfin内のデフォルト(プライマリー)組織IDです。常に、「1」に設定します。

    ReportRequestStringwebサービス関数です。「PRINT」に設定します。
    ReportIdInteger印刷可能な書式で返すレポートを指定するための内部IDです。

     

    リクエストの例

    以下のSOAPの例は、こちらの呼び出しに渡すことのできるパラメーターを示しています。

    Code Block
    languagexml
    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
       <soapenv:Header/>
       <soapenv:Body>
    
              JAXBContext context = JAXBContext.newInstance(ReportServiceResponse.class);
                <web:remoteReportCall>
    Marshaller m        <arg0>= context.createMarshaller();
                <loginId>admin@yellowfinm.com.au</loginId>
         setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE); // To format XML
           <password>test</password>
         JAXBElement<ReportServiceResponse> rootElement = new JAXBElement<ReportServiceResponse>(new QName("ReportServiceResponse"),  <orgId>1</orgId>ReportServiceResponse.class, rs);
                <reportRequest>PRINT</reportRequest>
    m.marshal(rootElement,out);   
             <reportId>56401</reportId>
        //out.write("Success");
        } else {
            </arg0>out.write("Failure");
          </web:remoteReportCall>
       </soapenv:Body>
    </soapenv:Envelope>out.write(" Code: " + rs.getErrorCode());
        }
     
         
    %>



    Expand
    titleFORMATTEDRESULTSET

    こちらのwebサービスは、RESULTSET関数の呼び出しに類似していますが、結果セットをレポートのフォーマッターを使用して返します。


    リクエスト要素

    以下の要素は、こちらのリクエストとともに渡されます。

    リクエスト要素

     

    応答要素

    応答には、これらの主要なパラメーターが含まれます。

    応答要素データ型説明取得コード

    Chart

    ReportChart[]

    HTMLレポート応答に付加される、複数のグラフビットマップを含むReportChartオブジェクトの配列です。

    getCharts()

    ReportBinaryObject

    ReportBinaryObject[]

    BLOB、およびCLOBを含む、ReportBinaryObjectオブジェクトの配列です。

    getBinaryObjects()

    ReportStyles

    String

    CSSスタイルです。

    getReportStyles()

    Breadcrumbs

    Breadcrumb[]

    Breadcrumbオブジェクトの配列です。

    getBreadcrumbs()

    SeriesSelection

    SeriesSelection[]

    SeriesSelectionオブジェクトの配列です。

    getSeriesSelections()

    TimeAggregationSelection

    TimeAggregationSelection[]

    TimeAggregationSelectionオブジェクトの配列です。

    getTimeAggregationSelection()

    ReportTabSelection

    ReportTabSelection[]

    ReportTabSelectionオブジェクトの配列です。

    getReportTabSelection()

    ReportPageSelection

    ReportPageSelection[]

    ReportPageSelectionオブジェクトの配列です。

    getReportPageSelection()

    TimeSliderSelection

    TimeSliderSelection[]

    TimeSliderSelectionオブジェクトの配列です。

    getTimeSliderSelection()

    SortableColumns

    SortableTableColumn[]

    SortableTableColumnオブジェクトの配列です。

    getSortableColumns()

    SelectedSortColumn

    Integer

    並べかえに使用するカラム(列)です。このインデックスは、レポート内のカラム(列)インデックスに適用されます。

    getSelectedSortColumn()

    SelectedSortOrder

    Integer

    並べかえに使用するカラム(列)の並べかえ順序です(0が昇順、1が降順です)。

    getSelectedSortOrder()

    DrillCode

    String

    レポートで使用可能な場合の、ドリルタイプです。

    getDrillCode()

    RelatedReports

    RelatedReport[]

    RelatedReportオブジェクトの配列です。これは、メインレポートにタブ化、またはマルチ表示されるレポートです。

    getRelatedReports()

    BinaryData

    String

    Base64でエンコードされた、HTMLドキュメントのバイナリーチャンクです。

    getBinaryData()

    Private

     

    レポートが非公開、または公開のどちらであるかを定義します。

    getPrivate()

    ContentType

    String

    返されるオブジェクトのMIME ContentTypeです。値は「text / html」です。

    getContentType()

    CanDrill

    Boolean

    レポートのドリル可否です。

    getCanDrill()

    GoogleMaps

    GMap

    GMapオブジェクトの配列です。

    getGoogleMaps()

    LoginId

    String

    Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。

    このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト(プライマリー)組織に所属していなくてはいけません。

    Password

    String

    上記アカウントのパスワードです。

    OrgId

    Integer

    Yellowfin内のデフォルト(プライマリー)組織IDです。常に、「1」に設定します。

    ReportRequestStringwebサービス関数です。「FORMATTEDRESULTSET」に設定します。
    OrgRef

    String

    クライアント組織内部参照IDです。(オプション設定)
    ReportIdInteger結果データを参照するレポートのIDです。


    リクエストの例

    以下のSOAPの例は、こちらの呼び出しに渡すことのできるパラメーターを示しています。

    Code Block
    languagexml
    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
       <soapenv:Header/>
       <soapenv:Body>
          <web:remoteReportCall>
             <arg0>
                <loginId>admin@yellowfin.com.au</loginId>
                <password>test</password>
                <orgId>1</orgId>
                <reportRequest>FORMATTEDRESULTSET</reportRequest>
                <reportId>58511</reportId>
                </arg0>
          </web:remoteReportCall>
       </soapenv:Body>
    </soapenv:Envelope>


    応答要素

    応答には、これらの主要なパラメーターが含まれます。(より詳細な応答パラメーターの一覧は、ReportServiceResponseオブジェクトを参照してください)

    応答要素データ型説明

    StatusCode

    String

    Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。

    • SUCCESS
    • FAILURE
    ResultsReportRow[]レポートのデータセットの結果を含むオブジェクトの配列です。

    応答の例

    サービスは、今回のSOAPの例に基づき、以下の応答を返します。

    Code Block
    languagexml
    themeEclipse
    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
       <S:Body>
          <ns2:remoteReportCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
             <return>
                <author>System Administrator</author>
                <authoringMode>JAVA</authoringMode>
                <averageRunTime>0</averageRunTime>
                <canDrill>false</canDrill>
                <category>Audit Reports</category>
                <dashboardEnabled>true</dashboardEnabled>
                <dataOutput>COLUMN</dataOutput>
                <datasource>Yellowfin Configuration Database</datasource>
                <errorCode>0</errorCode>
                <formatCode>REPORTANDCHART</formatCode>
                <hitCount>5</hitCount>
                <lastModifiedDate>2016-04-13</lastModifiedDate>
                <lastRunDuration>0</lastRunDuration>
                <lastRunStatus>RUN_NOERROR</lastRunStatus>
                <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
                <messages>Loaded Report: 58511 Successfully</messages>
                <messages>Returning RAW Resultset</messages>
                <messages>Request Contains No ReportFilter Records.</messages>
                <messages>Report Run Successfully</messages>
                <messages>Web Service Request Complete</messages>
                <private>false</private>
                <reportDescription/>
                <reportId>58511</reportId>
                <reportName>Role Population</reportName>
                <reportTemplate>REPORTANDCHART</reportTemplate>
                <reportUUID>00c65743-15f8-4f93-ace1-e3d4d2b956eb</reportUUID>
                <reportUsage>9</reportUsage>
                <results>
                   <dataValue>System Administrator</dataValue>
                   <dataValue>1</dataValue>
                </results>
                <results>
                   <dataValue>Consumer &amp; Collaborator</dataValue>
                   <dataValue>5</dataValue>
                </results>
                <sessionId>1e4f0c8ee07d24a5500f952a459b1652</sessionId>
                <statusCode>SUCCESS</statusCode>
                <subCategory>User Access</subCategory>
                <tags>No tags</tags>
                <viewName>NEW VIEW</viewName>
             </return>
          </ns2:remoteReportCallResponse>
       </S:Body>
    </S:Envelope>


    手順

    Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。

    Expand
    title詳細手順
    • 管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの呼び出しを実行するための基礎的なリクエストです。

      Code Block
      languagejava
      themeEclipse
      ReportServiceRequest rsr = new ReportServiceRequest();
       
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(new Integer(1));
       
      rsr.setReportRequest("FORMATTEDRESULTSET");


    • 書式設定された結果セットを取得するレポートを指定します。


      Code Block
      languagejava
      themeEclipse
      rsr.setReportId(60712);


    • レポートクライアント参照IDを指定することができます。


      Code Block
      languagejava
      themeEclipse
      rsr.setReportClientReferenceId("1");


    • リクエストを構成したら、呼び出しを実行します。

      Code Block
      languagejava
      ReportServiceResponse rs=rsc.remoteReportCall(rsr);

      レポートwebサービスを初期化します。実行方法の詳細は、こちらを参照してください。


    • 返される応答には、他のレポート固有のパラメーターとともに、StatusCodeと結果パラメーターが含まれます。詳細は、上記応答パラメーターの表を参照してください。


    完成例

    以下は、こちらの関数の完成例です。こちらを使用するには、以下の手順に従います。

    1. コードをコピーして、「ws_resultset.jsp」として保存します。
    2. root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
    3. 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
    4. インターネットブラウザから、「http://<host>:<port>/ws_resultset.jsp」を実行します。

    Code Block
    languagejava
    themeEclipse
    <%          
    /*              ws_resultset.jsp              */
    %>
    <%@ page language="java" contentType="text/html; charset=UTF-8" %>
    <%@ page import="com.hof.util.*, java.util.*, java.text.*" %>
    <%@ page import="com.hof.web.form.*" %>
    <%@ page import="com.hof.mi.web.service.*" %>
    <%@ page import="javax.xml.bind.JAXBContext" %>
    <%@ page import="javax.xml.bind.Marshaller" %>
    <%@ page import="java.io.StringWriter" %>
    <%@ page import="javax.xml.bind.JAXBElement" %>
    <%@ page import="javax.xml.namespace.QName" %>
    <%
         
    ReportService rsc = new ReportService();   //("localhost", 8080, "admin@yellowfin.com.au", "test", "/services/ReportService");
        ReportServiceRequest rsr = new ReportServiceRequest();
        rsr.setLoginId("admin@yellowfin.com.au");
        rsr.setPassword("test");
        rsr.setOrgId(new Integer(1));
        rsr.setReportRequest("FORMATTEDRESULTSET");
        rsr.setOrgRef("1");
        rsr.setReportId(60712);
        rsr.setReportClientReferenceId("1");
        ReportServiceResponse rs=rsc.remoteReportCall(rsr);
        if ("SUCCESS".equals(rs.getStatusCode())) {
             
              JAXBContext context = JAXBContext.newInstance(ReportServiceResponse.class);
                Marshaller m = context.createMarshaller();
                m.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE); // To format XML
                JAXBElement<ReportServiceResponse> rootElement = new JAXBElement<ReportServiceResponse>(new QName("ReportServiceResponse"), ReportServiceResponse.class, rs);
                m.marshal(rootElement,out);   
            //out.write("Success");
        } else {
            out.write("Failure");
            out.write(" Code: " + rs.getErrorCode());
        }
         
    %>





    その他

    Expand
    titleSENDTOEMAIL

    こちらの関数は、受信者の電子メールアドレスにレポートを送信します。


    リクエスト要素

    以下の要素は、こちらのリクエストとともに渡されます。

    リクエスト要素データ型説明

    LoginId

    String

    Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。

    このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト(プライマリー)組織に所属していなくてはいけません。

    Password

    String

    上記アカウントのパスワードです。

    OrgId

    Integer

    Yellowfin内のデフォルト(プライマリー)組織IDです。常に、「1」に設定します。

    ReportRequestStringwebサービス関数です。「SENDTOEMAIL」に設定します。
    OrgRefStringクライアント組織の内部参照IDを指定するためのオプションパラメーターです。
    ReportIdInteger電子メール送信されるレポートの内部IDです。
    ReportsOptionString[]レポート送信先となる電子メールアドレスの一覧です。
    AlterationCommand

    SessionIdInteger(オプション設定)IDを使用して以前のセッションを指定します。
    LanguageCode
    (オプション設定)言語を指定します。


    リクエストの例

    以下のSOAPの例は、こちらの呼び出しに渡すことのできるパラメーターを示しています。

    Code Block
    languagexml
    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
       <soapenv:Header/>
       <soapenv:Body>
          <web:remoteReportCall>
             <arg0>
                <loginId>admin@yellowfin.com.au</loginId>
                <password>test</password>
                <orgId>1</orgId>
                <reportRequest>SENDTOEMAIL</reportRequest>
                <reportId>70012</reportId>
                <alterationCommand>drill-down|70012</alterationCommand>
                <reportOptions>
                    <string>binish.sheikh@yellowfin.com.au</string>
                </reportOptions>
                </arg0>
          </web:remoteReportCall>
       </soapenv:Body>
    </soapenv:Envelope>


    応答要素

    応答には、これらのパラメーターが含まれます。

    応答要素データ型説明

    StatusCode

    String

    Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。

    • SUCCESS
    • FAILURE

    応答の例

    サービスは、今回のSOAPの例に基づき、以下の応答を返します。

    Code Block
    languagexml
    themeEclipse
    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
       <S:Body>
          <ns2:remoteReportCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
             <return>
                <author>System Administrator</author>
                <authoringMode>JAVA</authoringMode>
                <averageRunTime>0</averageRunTime>
                <canDrill>false</canDrill>
                <category>Tutorial</category>
                <dashboardEnabled>true</dashboardEnabled>
                <dataOutput>COLUMN</dataOutput>
                <datasource>Ski Team</datasource>
                <errorCode>0</errorCode>
       

    応答の例

    サービスは、今回のSOAPの例に基づき、以下の応答を返します。

    Code Block
    themeEclipse
    languagexml
    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
       <S:Body>
          <ns2:remoteReportCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
             <return><formatCode>CHART</formatCode>
                <author>System Administrator<<hitCount>3</author>hitCount>
                <authoringMode>JAVA</authoringMode><lastModifiedDate>2018-03-07</lastModifiedDate>
                <averageRunTime>0<<lastRunDuration>0</averageRunTime>lastRunDuration>
                <binaryData>PHN0eWxlIHR5cGU9InRleHQvY3NzIj4KLm11bHRpV2lkZ2V0Q2FudmFzRWRpdG9yIHsKCXBvc2l0
    aW9uOiByZWxhdGl2ZTsKfQoKLm11bHRp . . .</binaryData><messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
                <canDrill>false</canDrill>
    <messages>Loaded Report: 70012 Successfully</messages>
                <messages>Web <category>AuditService Request Reports<Complete</category>messages>
                 <contentType>text/html</contentType>
                <dashboardEnabled>true</dashboardEnabled><preRunFilterString><![CDATA[<div class="rptFilterLogicText">
    <span class="rptFilterLogicIdentifier">Invoiced Date</span>
    Between
    <span class="rptFilterLogicIdentifier">Current Date - 6 Years And Current Date</span>
    </div>
    .
    .
    .
    ]]></preRunFilterString>
                <dataOutput>COLUMN<<private>false</dataOutput>private>
                <datasource>Yellowfin<reportDescription>This Configuration Database</datasource>
                <drillCode>NODRILL</drillCode>report provides a high level summary of campaigns</reportDescription>
                <errorCode>0<<reportId>70012</errorCode>reportId>
                <reportName>Campaign <formatCode>REPORTANDCHART<Summary</formatCode>reportName>
                <hitCount>30<<reportTemplate>CHART</hitCount>reportTemplate>
                <lastModifiedDate>2018-07-02</lastModifiedDate><reportUUID>3e842fae-02f7-4ad3-a632-ca267e0078da</reportUUID>
                <lastRunDuration>0<<reportUsage>100</lastRunDuration>reportUsage>
                <lastRunStatus>RUN_NOERROR<<sessionId>fa0cc79a9ea229bd5df85b4a7f50c878</lastRunStatus>sessionId>
                <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages><statusCode>SUCCESS</statusCode>
                <messages>Loaded Report: 56401 Successfully</messages><subCategory>Marketing &amp; Booking</subCategory>
                <messages>Generating<tags>No HTML Report<tags</messages>tags>
                <messages>Request Contains No ReportFilter Records.</messages>
    <viewName>New View</viewName>
             </return>
          </ns2:remoteReportCallResponse>
     <messages>Report Run Successfully<</messages>
           S:Body>
    </S:Envelope>


    手順

    Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。

    Expand
    title詳細手順
    • 管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの呼び出しを実行するための基礎的なリクエストです。

      Code Block
      languagejava
      themeEclipse
      ReportServiceRequest rsr = new ReportServiceRequest();
        
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(new Integer(1));
       
      rsr.setReportRequest("SENDTOEMAIL");


    • レポートの保存されているクライアント組織を指定する必要がある場合は、こちらのコードを追加します。


      Code Block
      languagejava
      themeEclipse
      rsr.setOrgRef("org1");     
    <messages>Web
    •  // search for the report in this client org


    • 電子メール送信するレポートと、その変更コマンドを指定します。


      Code Block
      languagejava
      themeEclipse
      rsr.setReportId(60712);
      rsr.setAlterationCommand("drill-down|60712");


    • レポートの送信先となる電子メールアドレスを提供します。


      Code Block
      languagejava
      themeEclipse
      rsr.setReportOptions(new String[]{ "dummy@dummy.com"});


    • リクエストを構成したら、呼び出しを実行します。

      Code Block
      languagejava
      ReportServiceResponse rs=rsc.remoteReportCall(rsr);

      レポートwebサービスを初期化します。実行方法の詳細は、こちらを参照してください。


    • 返される応答には、次のパラメーターが含まれます:StatusCode、Dashboard、Subtabs。(より詳細な情報は、上記応答パラメーターの表を参照してください)


    完成例

    以下は、こちらの関数の完成例です。こちらを使用するには、以下の手順に従います。

    1. コードをコピーして、「ws_sendtoemail.jsp」として保存します。
    2. root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
    3. 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
    4. インターネットブラウザから、「http://<host>:<port>/ws_sendtoemail.jsp」を実行します。

    Code Block
    languagejava
    themeEclipse
    /*Service Request Complete</messages>
                <preRunFilterString><![CDATA[<div class="rptFilterLogicText">
    <span class="rptFilterLogicIdentifier">Active Session Start</span>
    Is Not Null
    <span class="rptFilterLogicIdentifier"></span>
    </div>]]></preRunFilterString>
                <private>false</private>
      ws_sendtoemail.jsp          <relatedReports/>
                <reportDescription/>*/
      
    <%@ page language="java"        <reportId>56401</reportId>
                <reportName>Active Sessions</reportName>
                <reportStyle>td.rpthdrcol {
       position: relative;
    }
    img.rptcolmenu {
       position: absolute;
       right: 5px;
       top: 0;
       bottom: 0;
       margin: auto 0;
       cursor: pointer;
    }
    td.rpthdrcol div.rptdata {
       padding-right: 20px;
    }
    td.reportChartCell {
       vertical-align: top;
    }
    div.reportChart {
       position: relative;
       display: inline-block;
    }
    img.reportChart {
       position: absolute;
       left: 0;
       top: 0;
    }
    .
    .
    .
    table.rpt56401sectionsummary {
       margin-bottom: 20px;
    }
    .printpagebreak {
       PAGE-BREAK-BEFORE: always;
    }</reportStyle>
                <reportTemplate>REPORTANDCHART</reportTemplate>
                <reportUUID>594d4da4-1b58-44d3-bf4f-11456a42f68c</reportUUID>contentType="text/html; charset=UTF-8" %>
    <%@ page import="com.hof.util.*, java.util.*, java.text.*" %>
    <%@ page import="com.hof.web.form.*" %>
    <%@ page import="com.hof.mi.web.service.*" %>
    <%@ page import="javax.xml.bind.JAXBContext" %>
    <%@ page import="javax.xml.bind.Marshaller" %>
    <%@ page import="java.io.StringWriter" %>
    <%@ page import="javax.xml.bind.JAXBElement" %>
    <%@ page import="javax.xml.namespace.QName" %>
    <%
         
     
        ReportService rsc = new ReportService();   //("localhost", 8080, "admin@yellowfin.com.au", "test", "/services/ReportService");
        ReportServiceRequest rsr = new ReportServiceRequest();
        rsr.setLoginId("admin@yellowfin.com.au");
        rsr.setPassword("test");
        rsr.setOrgId(new Integer(1));
        rsr.setReportRequest("SENDTOEMAIL");
        rsr.setOrgRef("1");
        rsr.setReportId(60712);
        rsr.setAlterationCommand("drill-down|60712");
        rsr.setReportOptions(new String[]{ "dummy@dummy.com"});
        rsr.setReportClientReferenceId("1");
        rsr.setDashboardTabId(70080);
         
        ReportServiceResponse rs=rsc.remoteReportCall(rsr);
        if ("SUCCESS".equals(rs.getStatusCode())) {
             
       <reportUsage>100</reportUsage>
           
         <selectedSortColumn>-1</selectedSortColumn>
         JAXBContext context = JAXBContext.newInstance(ReportServiceResponse.class);
        <selectedSortOrder>0</selectedSortOrder>
            Marshaller m   <sessionId>7fc9ad31786cfd1ca10605c301551534</sessionId>= context.createMarshaller();
                <sortableColumns/>
         m.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE); // To format XML
           <sortableColumns/>
         JAXBElement<ReportServiceResponse> rootElement = new JAXBElement<ReportServiceResponse>(new QName("ReportServiceResponse"),  <sortableColumns/>ReportServiceResponse.class, rs);
                <statusCode>SUCCESS</statusCode>
    m.marshal(rootElement,out);   
             <subCategory>Admin Reports</subCategory>
      
              <tags>No tags</tags>//out.write("Success");
        } else {
           <viewName>NEW VIEW</viewName>
     out.write("Failure");
            out.write("  </return>
      Code: " + rs.getErrorCode());
        </ns2:remoteReportCallResponse>
       </S:Body>
    </S:Envelope>}
    %>



    Expand
    titleCOMMAND

    webサービスレポートのレポートからのインタラクションを処理します。こちらの関数は、レポートページの変更、ドリルスルー、ドリルダウン、ドリルエニウェアの実行、シリーズ選択の変更など、レポートでのインタラクションに使用します。

    AlterationCommandパラメーターは、レポートに組み込まれたテキストコードであり、レポートを変更するためにwebサービスに戻すことができます。


    リクエスト要素

    以下の要素は、こちらのリクエストとともに渡されます。

    リクエスト要素データ型説明

    LoginId

    String

    Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。

    このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト(プライマリー)組織に所属していなくてはいけません。

    Password

    String

    上記アカウントのパスワードです。

    OrgId

    Integer

    Yellowfin内のデフォルト(プライマリー)組織IDです。常に、「1」に設定します。

    ReportRequestStringwebサービス関数です。「COMMAND」に設定します。
    OrgRefStringクライアント組織の内部参照IDです。(オプション設定)
    ReportIdInteger処理をするレポートのIDです。
    AlterationCommandStringレポートに適用するコマンドです。これは、レポートの変更方法を指定します。このパラメーターは、レポートに組み込まれたテキストコードです。レポート詳細取得時に、この値をwebサービスに渡すことでレポートを変更することができます。 
    CommandHistoryString(オプション設定)パイプされたコマンドの一覧です。(レポートがセッションから消去されている場合、コマンドを順番に適用します)
    SessionIDString(オプション設定)以前のセッションのIDです。
    LanguageCodeString(オプション設定)言語を指定します。


    応答要素

    応答には、これらのパラメーターが含まれます。

    応答要素データ型説明

    StatusCode

    String

    Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。

    • SUCCESS
    • FAILURE
     


    手順

    Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。

    Expand
    title詳細手順
    • 管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの呼び出しを実行するための基礎的なリクエストです。

      Code Block
      languagejava
      themeEclipselanguagejava
      ReportServiceRequest rsr = new ReportServiceRequest();
        
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(new Integer(1));
       
      rsr.setReportRequest("PRINTCOMMAND");


    • レポートの保存されているクライアント組織を指定する必要がある場合は、こちらのコードを追加します。


      Code Block
       code
      language
      java
      themeEclipse
      rsr.setReportClientReferenceId("1");


    • レポートに適用するコマンドを追加します。


      Code Block
      languagejava
      themeEclipse
      rsr.setOrgRefsetAlterationCommand("org1DRILLDOWN|60712|53655|RXVyb3Bl");      // search for the report in this client org


    • 必要に応じて、以前のリクエストからセッションIDを渡します。


      Code Block
      languagejava

      印刷可能な書式に変換するレポートを指定します。

       

      code
      language
      themeEclipsejava
      rsr.setReportIdsetSessionId(60712"ce509806176f6a0563767bfb0b2bb36f");


    • リクエストを構成したら、呼び出しを実行します。

      Code Block
      languagejava
      ReportServiceResponse rs=rsc.remoteReportCall(rsr);

      レポートwebサービスを初期化します。実行方法の詳細は、こちらを参照してください。

     


    • 返される応答には、他の固有なパラメーターとともに、StatusCodeパラメーターが含まれます。詳細は、上記応答パラメーターの表を参照してください。返される応答には、レポートに関連するパラメーターが含まれます。(より詳細な情報は、上記応答パラメーターの表を参照してください)

     



    完成例

    以下は、こちらの関数の完成例です。こちらを使用するには、以下の手順に従います。

    1. コードをコピーして、「ws_command_printreportreport.jsp」として保存します。
    2. root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
    3. 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
    4. インターネットブラウザから、「http://<host>:<port>/ws_command_printreportreport.jsp」を実行します。

    Code Block
    languagejava
    themeEclipse
    languagejava
    /*              ws_printreport.jsp   */
      
    <%@page import="com.thoughtworks.xstream.io.xml.StaxDriver"%>
    <%@ page language="java" contentType="text/html; charset=UTF-8" %>
    <%@ page import="com.hof.util.*, java.util.*, java.text.*" %>
    <%@ page import="com.hof.web.form.*" %>
    <%@ page import="com.hof.mi.web.service.*" %>
    <%@ page import="javax.xml.bind.JAXBContext" %>
    <%@ page import="javax.xml.bind.Marshaller" %>
    <%@ page import="java.io.StringWriter" %>
    <%@ page import="javax.xml.bind.JAXBElement" %>
    <%@ page import="javax.xml.namespace.QName" %>
     
     
    <%
        
    ReportService rsc = new ReportService();   //("localhost", 8080, "admin@yellowfin.com.au", "test", "/services/ReportService");
        ReportServiceRequest rsr = new ReportServiceRequest();
        rsr.setLoginId("admin@yellowfin.com.au");
        rsr.setPassword("test");
        rsr.setOrgId(new Integer(1));
        rsr.setReportRequest("PRINTCOMMAND");
        rsr.setReportId(60712);
     
     
        rsr.setAlterationCommand("DRILLDOWN|60712|53655|RXVyb3Bl");
     
        rsr.setReportClientReferenceId("1");
        rsr.setSessionId("ce509806176f6a0563767bfb0b2bb36f");
        ReportServiceResponse rs=rsc.remoteReportCall(rsr);
         
        if ("SUCCESS".equals(rs.getStatusCode())) {
             
            %> <xmp> <%
              JAXBContext context = JAXBContext.newInstance(ReportServiceResponse.class);
                Marshaller m = context.createMarshaller();
                m.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE); // To format XML
                JAXBElement<ReportServiceResponse> rootElement = new JAXBElement<ReportServiceResponse>(new QName("ReportServiceResponse"), ReportServiceResponse.class, rs);
                m.marshal(rootElement,out);   
                %></xmp><%
            //out.write("Success");
        } else {
            out.write("Failure");
            out.write(" Code: " + rs.getErrorCode());
        }
    %>

     



    horizontalrule

    Styleclass
    ClasstopLink

    ページトップ

    ...