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

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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指定したレポートの名前です。FormatCode指定されたレポートの書式コードです。BinaryDataBase64でエンコードされたXLSX、またはXLSのバイナリーチャンクです。ContentTypeこのオブジェクトのMIMEコンテンツタイプです。値は「application/vnd.openxmlformats-officedocument.spreadsheetml.sheet」になります。
応答要素データ型説明

StatusCode

String

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

  • SUCCESS
  • FAILURE
ReportNameString

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

ReportDescriptionString指定したレポートの説明です。
ReportUUIDInteger指定したレポートの一意のID(または、UUID)です。
HitCountInteger

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

レポートがアクセスされた回数です。
FormatCodeStringレポートの書式コードです。
AverageRunTimeIntegerレポートの平均実行時間です。
CategoryStringレポートが表示されるカテゴリーです。
SubCategoryStringレポートのサブカテゴリーです。
ReportUsageIntegerレポートが使用、またはアクセスされた回数です。
ViewNameStringビューの名前です。
DatasourceStringデータソースの名前です。
AuthorStringレポートを作成したユーザーです。
AuthoringModeStringレポートが作成されたモードです。
ReportTemplateStringレポートのテンプレートです。
DataOutputStringデータ出力です。例:カラム(列)
DashboardEnabledBooleanダッシュボードが有効化されている場合はTrueになります。
LastModifiedDateDateレポートの最終編集日です。

 

応答の例

サービスは、今回の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>
            <author>System Administrator</author>
            <authoringMode>JAVA</authoringMode>
            <averageRunTime>0</averageRunTime>
            <binaryData>UEsDBBQACAgIAJUKa0wAAAAAAAAAAAAAAAALAAAAX3JlbHMvLnJlb ...</binaryData>
            <canDrill>false</<canDrill>false</canDrill>
            <category>Audit Reports</category>
            <contentType>application/vnd.openxmlformats-officedocument.spreadsheetml.sheet</contentType><category>Tutorial</category>
            <dashboardEnabled>true</dashboardEnabled>
            <dataOutput>COLUMN</dataOutput>
            <datasource>Yellowfin<datasource>Ski Configuration Database<Team</datasource>
            <errorCode>0</errorCode>
            <formatCode>REPORTANDCHART</formatCode>
            <hitCount>25<<hitCount>0</hitCount>
            <lastModifiedDate>2016<lastModifiedDate>2017-0306-29</lastModifiedDate>
            <lastRunDuration>0</lastRunDuration>
            <lastRunStatus>RUN_NOERROR</lastRunStatus>26</lastModifiedDate>
            <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<preRunFilterString><![CDATA[<div class="rptFilterLogicText">
<span class="rptFilterLogicIdentifier">Active>Company Session Start<Name</span>
IsIn Not NullList
<span class="rptFilterLogicIdentifier"><>[User Prompt]</span>
</div>]]></preRunFilterString>
            <private>false</private>
            <reportDescription>Top N Agencies compared to all other Agencies by <reportDescriptiondemographic</>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>Marketing <subCategory>Admin&amp; Reports<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
    themeEclipse
    languagejava
    ReportServiceRequest rsr = new ReportServiceRequest();
      
    rsr.setLoginId("admin@yellowfin.com.au");
    rsr.setPassword("test");
    rsr.setOrgId(new Integer(1));
     
    rsr.setReportRequest("XLSXINFO");
  • レポートの保存されているクライアント組織を指定する必要がある場合は、こちらのコードを追加します。

     

    Code Block
    themeEclipse
    languagejava
    rsr.setOrgRef("org1");      // search for the report in this client org
  • XLSX書式に変換するレポートを指定します。どのレポートのコメントのステータスを変更するか指定することができます。

     

    Code Block
    themeEclipse
    languagejava
    rsr.setReportId(60712);
  • レポートクライアント参照ID、またはセッションIDを指定することもできます。

    Code Block
    themeEclipse
    languagejava
    rsr.setReportClientReferenceId("1");
    rsr.setSessionId("18607a5670842650d512976b5d7ccddd");
  • リクエストを構成したら、呼び出しを実行します。

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

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

 

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

 

完成例

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

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

Code Block
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" %>
<%
    /*
  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");
    ReportServiceResponse rs=rsc.remoteReportCall(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サービスは、れオートカラム(列)やフィルターのメタデータを含む、指定したレポートの概略情報を返します。こちらの関数は、指定したレポートをDOC、またはDOCX書式(Microsoft Word)で返します。

 

リクエスト要素

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

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

LoginId

String

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

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

Password

String

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

OrgId

Integer

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

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

 

応答要素

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

応答要素データ型説明

StatusCode

String

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

  • SUCCESS
  • FAILURE

ReportId

Integer

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

Columns

ReportSchema[]

レポート結果セット内の各カラム(列)と、レポートにユーザープロンプトフィルターデータを渡す必要があるかどうかの情報(メタデータ)を含むReportSchemaの配列です。

Author

String

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

AuthoringModeReportName

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

 

HitCountAverageRunTime

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

 

FormatCodeCanDrill

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

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

BinaryDataCategory

StringBase64でエンコードされたDOCX、またはDOCのバイナリーチャンクです。

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

ContentTypeSubCategory

String

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

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

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

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

ReportId

Integer

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

ReportName

String

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

ReportTemplate

String

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

  • REPORTANDCHART
  • CHART
  • REPORT

ReportUUID

String

レポートのUUIDです。

ReportUsage

Integer

 

ViewName

String

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

Tags

String

 

ErrorCode

Integer

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

Messages

String[]

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

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
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>
            <canDrill>false</canDrill>
           <category>Tutorial</category>
            <columns>
               <columnName>Region</columnName>
               <dataType>TEXT</dataType>
            <displayName>Athlete Region</displayName>
            <fieldId>1</fieldId>
            <hidden>false</hidden>
               <numberOfDecimals>0</numberOfDecimals>
               <outputLocation>COLUMN</outputLocation>
               <prompt>false</prompt>
               <sortOrder>0</sortOrder>
            </columns>
            <columns>
               <allowPrompt>false</allowPrompt>
               <cachedValues>true</cachedValues>
               <columnName>Region</columnName>
               <dataType>TEXT</dataType>
            <displayName>Athlete Region</displayName>
            <filterDisplayType>DROPDOWN</filterDisplayType>
               <filterId>74908</filterId>
               <filterOmittable>true</filterOmittable>
               <filterType>INLIST</filterType>
               <filterTypeCode>FILTER</filterTypeCode>
             <filterUUID>d4ea61ab-247e-403a-b51b-8243aeea63db</filterUUID>
               <numberOfDecimals>0</numberOfDecimals>
               <prompt>true</prompt>
               <sortOrder>0</sortOrder>
            </columns>
            <dashboardEnabled>true</dashboardEnabled>
            <dataOutput>COLUMN</dataOutput>
            <datasource>Ski Team !!!</datasource>
            <drillCode>DRILLDOWN</drillCode>
            <errorCode>0</errorCode>
            <formatCode>REPORTANDCHART</formatCode>
            <hitCount>3</hitCount>
            <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>
            <reportDescription>Ski Team, 8/6/2018 9:36 AM</reportDescription>
            <reportId>74907</reportId>
            <reportName>cached filters</reportName>
            <reportTemplate>REPORTANDCHART</reportTemplate>
            <reportUUID>982500e8-7b33-476b-be47-6a1aab611349</reportUUID>
            <reportUsage>100</reportUsage>
            <sessionId>7e9971ea99fff609387ac1c504abcc63</sessionId>
            <statusCode>SUCCESS</statusCode>
            <subCategory>Training</subCategory>
            <tags>No tags</tags>
            <viewName>Ski Team</viewName>
         </return>
    </ns2:remoteReportCallResponse>
   </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("SCHEMA");
  • レポートの保存されているクライアント組織を指定する必要がある場合は、こちらのコードを追加します。

     

    Code Block
    themeEclipse
    languagejava
    rsr.setOrgRef("org1");      // search for the report in this client org
  • ステータスを変更するレポートのコメントを指定することができます。

     

    Code Block
    themeEclipse
    languagejava
    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
themeEclipse
languagejava
<%          
/*              ws_reportschema.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.*" %>
<%
    ReportServiceResponse rs = null;
    ReportServiceRequest rsr = new ReportServiceRequest();
    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())) {
        out.write("Success </br>");
                                    ReportSchema[] schema = rs.getColumns();
                                    for (ReportSchema s: schema)
                                                    //display filters:
                                                    if (s.getFilterType() != null && s.getFilterTypeCode().equals("FILTER")){
                                                                        out.write("<br>Display Name: " + s.getDisplayName());
                                                                        out.write("<br>Filter UUID:" + s.getFilterUUID());
                                                                        out.write("<br>Filter Id:" + s.getFilterId());
                                                    }
    } else {
        out.write(rs.getStatusCode());
        out.write(rs.toString());
    }
%>
管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの呼び出しを実行するための基礎的なリクエストです。
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[]

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

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

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


応答の例

サービスは、今回の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>
            <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>
            <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>
            <messages>Retrieving Options</messages>
            <messages>Request Contains No ReportFilter Records.</messages>
            <messages>Region (FilterId: 70082 ) Requires User Prompt</messages>
            <messages>Ignoring Prompt Filter On Field: 70082</messages>
            <messages>DEMOGRAPHIC (FilterId: 70081 ) Requires User Prompt</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>
<div class="rptFilterLogicText">
AND
<span class="rptFilterLogicIdentifier">Demographic</span>
In List
<span class="rptFilterLogicIdentifier">(Adventure, Relaxation, Family, Culture)</span>
</div>]]></preRunFilterString>

 

応答の例

サービスは、今回の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>
            <author>System Administrator</author>
            <authoringMode>JAVA<<private>false</authoringMode>private>
            <averageRunTime>0</averageRunTime>
            <binaryData>UEsDBBQACAgIAN0Ma0wAAAAAAAAAAAAAAAATAAAAW0 ...</binaryData><reportDescription>Ski Team, 18/6/2018 2:49 PM</reportDescription>
            <canDrill>false<<reportId>70066</canDrill>reportId>
            <category>Audit Reports<<reportName>qwerty</category>reportName>
            <contentType>application/vnd.openxmlformats-officedocument.wordprocessingml.document</contentType><reportTemplate>REPORTANDCHART</reportTemplate>
            <dashboardEnabled>true</dashboardEnabled><reportUUID>c105ab26-9744-434d-9c8c-9fb9e48d80c0</reportUUID>
            <dataOutput>COLUMN<<reportUsage>100</dataOutput>
            <datasource>Yellowfin Configuration Database</datasource>
reportUsage>
            <results>
   <errorCode>0</errorCode>
            <formatCode>REPORTANDCHART<<dataValue>Asia</formatCode>dataValue>
               <hitCount>26<<dataValue>Asia</hitCount>dataValue>
            <lastModifiedDate>2016-03-29</lastModifiedDate></results>
            <lastRunDuration>0<<sessionId>eb31d9392a25c8c40995237650837cd5</lastRunDuration>sessionId>
            <lastRunStatus>RUN_NOERROR<<statusCode>SUCCESS</lastRunStatus>statusCode>
            <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages><subCategory>Training</subCategory>
            <messages>Loaded Report: 56401 Successfully</messages><tags>No tags</tags>
            <messages>Generating<viewName>New DOCX Report<View</messages>viewName>
        </return>
    <messages>Request Contains No ReportFilter Records.</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>
</div>]]></preRunFilterString>
            <private>false</private>
  </ns2:remoteReportCallResponse>
   </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("FILTEROPTIONS");
  • フィルターを取得するレポートを指定します。

     

    Code Block
    themeEclipse
    languagejava
    rsr.setReportId(70066);
  • 特定のフィルターを取得する場合は、ObjectNameパラメーターにフィルターIDを提供します。

     

    Code Block
    themeEclipse
    languagejava
    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
themeEclipse
languagejava
<%          <reportDescription/>
            <reportId>56401</reportId>
  /*          <reportName>Active Sessions</reportName>
   ws_filteroptions.jsp         <reportTemplate>REPORTANDCHART</reportTemplate>
            <reportUUID>594d4da4-1b58-44d3-bf4f-11456a42f68c</reportUUID>
            <reportUsage>27</reportUsage>
            <sessionId>9b4a5e7182d359795d176d56378ac0f2</sessionId>
            <statusCode>SUCCESS</statusCode>*/
%>
<%
    ReportServiceResponse rs       <subCategory>Admin Reports</subCategory>= null;
            <tags>No tags</tags>
   ReportServiceRequest rsr = new ReportServiceRequest();
    ReportServiceService ts = new  <viewName>NEW VIEW</viewName>ReportServiceServiceLocator("localhost", 8080, "/services/ReportService", false);
    ReportServiceSoapBindingStub rssbs =   </return>(ReportServiceSoapBindingStub) ts.getReportService();
  
    </ns2:remoteReportCallResponse>
   </S:Body>
</S:Envelope>  

 

手順

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

Expand
title詳細手順
Code Block
themeEclipse
languagejava
ReportServiceRequest rsr = new ReportServiceRequest();
  
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(new Integer(1));
 
rsr.setReportRequest("DOCX");
  • レポートの保存されているクライアント組織を指定する必要がある場合は、こちらのコードを追加します。

     

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

     

    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)フォルダーにファイルを配置します。
  • 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
  • インターネットブラウザから、「http://<host>:<port>/ws_docxreport.jsp」を実行します。
    Code Block
    themeEclipse
    languagejava
    /*rsr.setLoginId("admin@yellowfin.com.au");
        rsr.setPassword("test");
        rsr.setOrgId(1);
        rsr.setReportRequest("FILTEROPTIONS");
         
        rsr.setReportId(70066);
        rsr.setObjectName("70081");
                     
         
        rs = rssbs.remoteReportCall(rsr);
      
        if ("SUCCESS".equals(rs.getStatusCode())) {
            out.write("Success </br>");
                                        ReportRow[] rows = rs.getResults();
                                         ws_docxreport.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("DOCX");
        rsr.setOrgRef("1");
        rsr.setReportId(60712);
        rsr.setReportClientReferenceId("1");
        ReportServiceResponse rs=rsc.remoteReportCall(rsr);
        if ("SUCCESS".equals(rs.getStatusCode())) {
    for (ReportRow r: rows) {
                                                        //display filter values:                                       
                                              JAXBContext context = JAXBContext.newInstance(ReportServiceResponse.class);
                Marshaller m = context.createMarshaller();
                mout.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE); // To format XML
    write("<br>" + r.getDataValue()[0]);
                         JAXBElement<ReportServiceResponse> rootElement = new JAXBElement<ReportServiceResponse>(new QName("ReportServiceResponse"), ReportServiceResponse.class, rs);
                m.marshal(rootElement,out);
            //out.write("Success");    }
        } else {
            out.write("Failure"(rs.getStatusCode());
            out.write(" Code: " + rs.getErrorCodetoString());
        }
    %>

     

     

     

    レポート結果セット関数

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

    Expand
    titlePDFRESULTSET

    こちらのwebサービスは、指定したレポートの結果データと、レポートのメタデータを取得します。

    レポートの結果は、

    この結果は、ReportRowオブジェクトの配列に保存されます。このオブジェクトは、各結果ロウ(行)を表します。そのため、各ロウ(行)に対して、結果データの各カラム(列)のデータを含む文字列の配列が存在します。

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

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

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

    こちらのwebサービスは、各ユーザーロールのReportRowオブジェクトを返します。各オブジェクトは、2つのデータ文字列を含みます。ひとつはロール名であり、もうひとつはユーザー数を表示します。PDFリクエストは、指定されたレポートを実行し、PDF書式で返します。

     


    リクエスト要素

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

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

    LoginId

    String

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

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

    Password

    String

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

    OrgId

    Integer

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

    ReportRequestStringwebサービス関数です。「PDF」に設定します。RESULTSET」に設定します。
    OrgRefStringクライアント組織内部参照IDです。(オプション設定)
    ReportIdIntegerPDF書式で返すレポートを指定するための内部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>PDF<<reportRequest>RESULTSET</reportRequest>
                <reportId>56401<<reportId>58511</reportId>
                </arg0>
          </web:remoteReportCall>
       </soapenv:Body>
    </soapenv:Envelope>

     

    応答要素

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

    Envelope>

     

    応答要素

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

    getContentType()
    応答要素データ型説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE
    ResultsReportRow[]レポートのデータセットの結果を含むオブジェクトの配列です。
    応答要素データ型説明取得コード
    ReportIdInteger指定したレポートのIDです。getReportId()

    ReportName

    String

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

    getReportName()

    HitCount

    Integer

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

    getHitCount()

    FormatCode

    String

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

    getFormatCode()

    BinaryData

    String

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

    getBinaryData()

    ContentType

    String

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

     

    応答の例

    サービスは、今回の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>
                <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 <averageRunTime>0<Database</averageRunTime>datasource>
                <binaryData>JVBERi0xLjQKJeLjz9MKNCAwIG9iago8PC9GaWx0ZXIvRmxhdGVEZWNvZGUvTGVuZ3RoIDI4OT4+
    c3RyZWFtCnic7VNNSwMxEI1 . . .</binaryData><errorCode>0</errorCode>
                <canDrill>false<<formatCode>REPORTANDCHART</canDrill>formatCode>
                <category>Audit Reports<<hitCount>4</category>hitCount>
                <contentType>application/pdf</contentType><lastModifiedDate>2016-04-13</lastModifiedDate>
                <dashboardEnabled>true<<lastRunDuration>0</dashboardEnabled>lastRunDuration>
                <dataOutput>COLUMN<<lastRunStatus>RUN_NOERROR</dataOutput>lastRunStatus>
                <messages>Successfully <datasource>YellowfinAuthenticated Configuration Database</datasource>
    User: admin@yellowfin.com.au</messages>
                <messages>Loaded Report: 58511 <errorCode>0<Successfully</errorCode>messages>
                <messages>Returning RAW <formatCode>REPORTANDCHART<Resultset</formatCode>messages>
                <messages>Request Contains No ReportFilter <hitCount>25<Records.</hitCount>messages>
                <messages>Report Run <lastModifiedDate>2018-07-02</lastModifiedDate>
    Successfully</messages>
                <messages>Web Service Request <lastRunDuration>0<Complete</lastRunDuration>messages>
                <lastRunStatus>RUN_NOERROR<<private>false</lastRunStatus>private>
                <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages> <reportDescription/>
                <messages>Loaded Report: 56401 Successfully</messages><reportId>58511</reportId>
                <messages>Generating<reportName>Role PDF Report<Population</messages>reportName>
                <messages>Request Contains No ReportFilter Records.</messages><reportTemplate>REPORTANDCHART</reportTemplate>
                <messages>Report Run Successfully</messages><reportUUID>00c65743-15f8-4f93-ace1-e3d4d2b956eb</reportUUID>
                <messages>Web Service Request Complete</messages><reportUsage>7</reportUsage>
                <preRunFilterString><![CDATA[<div class="rptFilterLogicText">
    <span class="rptFilterLogicIdentifier">Active Session Start</span>
    Is Not Null
    <span class="rptFilterLogicIdentifier"></span>
    </div>]]></preRunFilterString>
    <results>
                   <dataValue>System Administrator</dataValue>
      <private>false</private>
                 <reportDescription<dataValue>1</>dataValue>
                <reportId>56401<</reportId>results>
                <results>
        <reportName>Active Sessions</reportName>
              <dataValue>Consumer &amp; <reportTemplate>REPORTANDCHART<Collaborator</reportTemplate>dataValue>
                   <reportUUID>594d4da4-1b58-44d3-bf4f-11456a42f68c</reportUUID><dataValue>5</dataValue>
                <reportUsage>100<</reportUsage>results>
                <sessionId>bb2175f6da398640f670ff666c40fcfa<<sessionId>c958af74f677c4b1f575bd728d3b25d0</sessionId>
                <statusCode>SUCCESS</statusCode>
                <subCategory>Admin<subCategory>User Reports<Access</subCategory>
                <tags>No tags</tags>
                <viewName>NEW VIEW</viewName>
             </return>
          </ns2:remoteReportCallResponse>
       </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("PDFRESULTSET");
    • レポートの保存されているクライアント組織を指定する必要がある場合は、こちらのコードを追加します。結果を取得するレポートを指定します。

       

      Code Block
      themeEclipse
      languagejava
      rsr.setOrgRefsetReportId("org1");      // search for the report in this client org60712);
    • レポートクライアント参照IDを指定することもできます。PDF書式で参照するレポートを指定します。

       

      Code Block
      themeEclipse
      languagejava
      rsr.setReportIdsetReportClientReferenceId(60712"1");
    • リクエストを構成したら、呼び出しを実行します。

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

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

     

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

     

    完成例

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

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

    Code Block
    themeEclipse
    languagejava
    <%          
    /*              ws_pdfreport.jspresultset.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("1RESULTSET");
        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
    titleCSVFORMATTEDRESULTSET

    こちらのリクエストは、指定されたレポートを実行し、CSV書式(カンマ区切り値)で返します。こちらのwebサービスは、RESULTSET関数の呼び出しに類似していますが、レポートからのフォーマッターを使用してロウ結果セットを返します。

     

    リクエスト要素

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

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

    LoginId

    String

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

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

    Password

    String

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

    OrgId

    Integer

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

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

    String

     クライアント組織内部参照IDです。(オプション設定)
    ReportIdIntegerCSV書式で返すレポートを指定するための内部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>CSV<<reportRequest>FORMATTEDRESULTSET</reportRequest>
                <reportId>56401<<reportId>58511</reportId>
                </arg0>
          </web:remoteReportCall>
       </soapenv:Body>
    </soapenv:Envelope>

     

    応答要素

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

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

    ReportNameStatusCode

    String

    指定したレポートの名前です。Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。getReportName()

    • SUCCESS
    HitCount
    • FAILURE

    Integer

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

    getHitCount()

    FormatCode

    String

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

    getFormatCode()

    BinaryData

    String

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

    getBinaryData()

    ContentType

    String

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

    getContentType()

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

    応答の例

    サービスは、今回の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>
                <author>System Administrator</author>
                <authoringMode>JAVA</authoringMode>
                <averageRunTime>0</averageRunTime>
                <binaryData>Tm8gcmVzdWx0cyByZXR1cm5lZC4K</binaryData>
                <canDrill>false</canDrill>
                <category>Audit Reports</category>
                <contentType>text/comma-separated-values</contentType>
                <dashboardEnabled>true</dashboardEnabled>
                <dataOutput>COLUMN</dataOutput>
                <datasource>Yellowfin Configuration Database</datasource>
                <errorCode>0</errorCode>
                <formatCode>REPORTANDCHART</formatCode>
                <hitCount>26</hitCount>
                <lastModifiedDate>2018-07-02</lastModifiedDate>
    <dataOutput>COLUMN</dataOutput>
                <datasource>Yellowfin Configuration <lastRunDuration>0<Database</lastRunDuration>datasource>
                <lastRunStatus>RUN_NOERROR<<errorCode>0</lastRunStatus>errorCode>
                <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages><formatCode>REPORTANDCHART</formatCode>
                <messages>Loaded Report: 56401 Successfully</messages><hitCount>5</hitCount>
                <messages>Generating CSV Report</messages><lastModifiedDate>2016-04-13</lastModifiedDate>
                <messages>Request Contains No ReportFilter Records.</messages><lastRunDuration>0</lastRunDuration>
                <messages>Report Run Successfully</messages><lastRunStatus>RUN_NOERROR</lastRunStatus>
                <messages>Web<messages>Successfully ServiceAuthenticated Request Complete<User: admin@yellowfin.com.au</messages>
                <preRunFilterString><![CDATA[<div class="rptFilterLogicText">
    <span class="rptFilterLogicIdentifier">Active Session Start</span>
    Is Not Null
    <span class="rptFilterLogicIdentifier"></span>
    </div>]]></preRunFilterString>
    <messages>Loaded Report: 58511 Successfully</messages>
                <messages>Returning RAW <private>false<Resultset</private>messages>
                <messages>Request Contains No ReportFilter <reportDescriptionRecords.</>messages>
                <messages>Report Run <reportId>56401<Successfully</reportId>messages>
                <messages>Web Service <reportName>ActiveRequest Sessions<Complete</reportName>messages>
                <reportTemplate>REPORTANDCHART<<private>false</reportTemplate>private>
                <reportUUID>594d4da4-1b58-44d3-bf4f-11456a42f68c</reportUUID><reportDescription/>
                <reportUsage>100<<reportId>58511</reportUsage>reportId>
                <reportName>Role <sessionId>6f95db60d17d24138a5faf23190f5a6e<Population</sessionId>reportName>
                <statusCode>SUCCESS<<reportTemplate>REPORTANDCHART</statusCode>reportTemplate>
                <subCategory>Admin Reports</subCategory><reportUUID>00c65743-15f8-4f93-ace1-e3d4d2b956eb</reportUUID>
                <tags>No tags<<reportUsage>9</tags>
    reportUsage>
                <results>
          <viewName>NEW VIEW</viewName>
            <dataValue>System <Administrator</return>dataValue>
          </ns2:remoteReportCallResponse>
       </S:Body>
    </S:Envelope>

     

    手順

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

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

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

     

    rsr.setOrgRef("org1");
    <dataValue>1</dataValue>
                
    // search for the report in this client org
  • CSV書式で参照するレポートを指定します。

     

  • 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サービスを初期化します。実行方法の詳細は、こちらを参照してください。

     

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

     

    完成例

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

  • コードをコピーして、「ws_csvreport.jsp」として保存します。
  • root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
  • 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
  • /*     </results>
                <results>
                   <dataValue>Consumer &amp; Collaborator</dataValue>
                   <dataValue>5</dataValue>
             ws_csvreport.jsp   *</results>
                
    <%@ 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>1e4f0c8ee07d24a5500f952a459b1652</sessionId>
                <statusCode>SUCCESS</statusCode>
                <subCategory>User Access</subCategory>
                <tags>No tags</tags>
                <viewName>NEW VIEW</viewName>
             //("localhost", 8080, "admin@yellowfin.com.au", "test", "/services/ReportService");
        </return>
          </ns2:remoteReportCallResponse>
       </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("
    CSV
    • FORMATTEDRESULTSET");
    rsr.setOrgRef("1");
    • 書式設定された結果セットを取得するレポートを指定します。

       

      Code Block
      themeEclipse
      languagejava
      rsr.setReportId(60712)
    ;
    • ;
    • レポートクライアント参照IDを指定することができます。

       

      Code Block
      themeEclipse
      languagejava
      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
    themeEclipse
    languagejava
    <% 
        if ("SUCCESS".equals(rs.getStatusCode())) {
             
    /*           JAXBContext context = JAXBContext.newInstance(ReportServiceResponse.class);
        ws_resultset.jsp        Marshaller m = context.createMarshaller();
       */
    %>
    <%@ page language="java" contentType="text/html; charset=UTF-8" %>
    <%@ page   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("Failureimport="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");
            out.write(" Code: " + rs.getErrorCode(rsr.setPassword("test");
        rsr.setOrgId(new Integer(1));
        }
    %>
    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>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);
          <web:remoteReportCall>
          Marshaller m  <arg0>= context.createMarshaller();
                <loginId>admin@yellowfin.com.au</loginId>
    m.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE); // To format XML
                JAXBElement<ReportServiceResponse> rootElement = new JAXBElement<ReportServiceResponse>(new QName("ReportServiceResponse"),  <password>test</password>ReportServiceResponse.class, rs);
                <orgId>1</orgId>
    m.marshal(rootElement,out);   
             <reportRequest>TEXT</reportRequest>
       //out.write("Success");
        } else {
             <reportId>60712</reportId>out.write("Failure");
            out.write(" Code: "  </arg0>+ rs.getErrorCode());
        }
      </web:remoteReportCall>
       </soapenv:Body>
    </soapenv:Envelope>
    %>

     

     

     

    その他

    Expand
    titleSENDTOEMAIL

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

     

    応答要素

    リクエスト要素

    応答には、これらの主要なパラメーターが含まれます。以下の要素は、こちらのリクエストとともに渡されます。

    ReportId
    応答要素リクエスト要素データ型説明取得コード

    LoginId

    String

    Integer指定したレポートの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の例に基づき、以下の応答を返します。

    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の例は、こちらの呼び出しに渡すことのできるパラメーターを示しています。

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

     

    応答要素

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

    応答要素データ型説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE

     

     

    応答の例

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

    Code Block
    themeEclipse
    languagexml
    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">   <errorCode>0</errorCode>
       <S:Body>
             <formatCode>REPORTANDCHART</formatCode><ns2:remoteReportCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
                <hitCount>5</hitCount>
    <return>
                <author>System <lastModifiedDate>2017-06-26</lastModifiedDate>Administrator</author>
                <lastRunDuration>0<<authoringMode>JAVA</lastRunDuration>authoringMode>
                <lastRunStatus>RUN_NOERROR<<averageRunTime>0</lastRunStatus>averageRunTime>
                <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages><canDrill>false</canDrill>
                <messages>Loaded Report: 60712 Successfully</messages><category>Tutorial</category>
                <messages>Generating TEXT Report</messages><dashboardEnabled>true</dashboardEnabled>
                <messages>Request Contains No ReportFilter Records.</messages><dataOutput>COLUMN</dataOutput>
                <messages>AGENCYNAME (FilterId: 60723 ) Requires User Prompt</messages>
     <datasource>Ski Team</datasource>
               <messages>Report Run Successfully<<errorCode>0</messages>errorCode>
                <messages>Web Service Request Complete</messages><formatCode>CHART</formatCode>
                <preRunFilterString><![CDATA[<div class="rptFilterLogicText">
    <span class="rptFilterLogicIdentifier">Company Name</span>
    In List
    <span class="rptFilterLogicIdentifier">[User Prompt]</span>
    </div>]]></preRunFilterString><hitCount>3</hitCount>
                <private>false</private><lastModifiedDate>2018-03-07</lastModifiedDate>
                <reportDescription>Top N Agencies compared to all other Agencies by demographic</reportDescription>
    <lastRunDuration>0</lastRunDuration>
                <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
         <reportId>60712</reportId>
           <messages>Loaded Report: 70012 Successfully</messages>
      <reportName>Agency Benchmark</reportName>
             <messages>Web Service Request <reportTemplate>REPORTANDCHART<Complete</reportTemplate>messages>
                 <reportUUID>c83357db-8aef-4ec7-ab72-fce34de9ee77</reportUUID>
                <reportUsage>0</reportUsage><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>
                <sessionId>0b549fb1c8361edb2b83dee81227e460<<private>false</sessionId>private>
                <statusCode>SUCCESS</statusCode>
    <reportDescription>This report provides a high level summary      <subCategory>Marketing &amp; Booking</subCategory>of campaigns</reportDescription>
                <tags>No tags<<reportId>70012</tags>reportId>
                <viewName>New<reportName>Campaign View<Summary</viewName>reportName>
             </return>
           <<reportTemplate>CHART</ns2:remoteReportCallResponse>reportTemplate>
        </S:Body>
    </S:Envelope>

     

    手順

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

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

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

     

    rsr.setOrgRef("org1");
     <reportUUID>3e842fae-02f7-4ad3-a632-ca267e0078da</reportUUID>
             
    //
     
    search
     
    for
     
    the
    <reportUsage>100</reportUsage>
     
    report
     
    in
     
    this
     
    client
     
    org
  • TEXT書式で参照するレポートを指定します。

     

  • 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サービスを初期化します。実行方法の詳細は、こちらを参照してください。

     

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

     

    完成例

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

  • コードをコピーして、「ws_textreport.jsp」として保存します。
  • root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
  • 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
  • /*       <sessionId>fa0cc79a9ea229bd5df85b4a7f50c878</sessionId>
             ws_textreport.jsp   *<statusCode>SUCCESS</statusCode>
               
    <%@ 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, <subCategory>Marketing &amp; Booking</subCategory>
                <tags>No tags</tags>
                <viewName>New View</viewName>
             </return>
          </ns2:remoteReportCallResponse>
       </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"
    , "/services/ReportService");
    • );
      rsr.setOrgId(new Integer(1));
       
      rsr.setReportRequest("SENDTOEMAIL");
    • レポートの保存されているクライアント組織を指定する必要がある場合は、こちらのコードを追加します。

       

      Code Block
      themeEclipse
      languagejava
      rsr.setOrgRef("org1");      
    ReportServiceRequest
    • // 
    rsr
    • search 
    =
    • for the report in this client org
    • メール送信するレポートと、その変更コマンドを指定します。

       

      Code Block
      themeEclipse
      languagejava
      rsr.setReportId(60712);
      rsr.setAlterationCommand("drill-down|60712");
    • レポートの送信先となるメールアドレスを提供します。

       

      Code Block
      themeEclipse
      languagejava
      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
    themeEclipse
    languagejava
    /*              ws_sendtoemail.jsp    new ReportServiceRequest();
        rsr.setLoginId("admin@yellowfin.com.au");
        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())) {
             */
      
    <%@ page language="java" contentType="text/html; charset=UTF-8" %>
    <%@ page  JAXBContext context = JAXBContext.newInstance(ReportServiceResponse.class);
                Marshaller m = context.createMarshaller();
                m.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE); // To format XMLimport="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  JAXBElement<ReportServiceResponse> rootElementrsc = new JAXBElement<ReportServiceResponse>(new QNameReportService();   //("ReportServiceResponselocalhost"), 8080, ReportServiceResponse.class, rs"admin@yellowfin.com.au", "test", "/services/ReportService");
        ReportServiceRequest rsr = new ReportServiceRequest();
        mrsr.marshal(rootElement,outsetLoginId("admin@yellowfin.com.au");
        rsr.setPassword("test");
        rsr.setOrgId(new Integer(1));
        //outrsr.writesetReportRequest("SuccessSENDTOEMAIL");
        } else {rsr.setOrgRef("1");
        rsr.setReportId(60712);
        outrsr.writesetAlterationCommand("Failuredrill-down|60712");
        rsr.setReportOptions(new    out.write(" Code: " + rs.getErrorCode()String[]{ "dummy@dummy.com"});
        rsr.setReportClientReferenceId("1");
        }
    %>
    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>rsr.setDashboardTabId(70080);
         
        ReportServiceResponse rs=rsc.remoteReportCall(rsr);
        if ("SUCCESS".equals(rs.getStatusCode())) {
             
              
              JAXBContext context = JAXBContext.newInstance(ReportServiceResponse.class);
          <web:remoteReportCall>
          Marshaller m  <arg0>= context.createMarshaller();
                <loginId>admin@yellowfin.com.au</loginId>
    m.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE); // To format XML
                JAXBElement<ReportServiceResponse> rootElement = new JAXBElement<ReportServiceResponse>(new QName("ReportServiceResponse"),  <password>test</password>ReportServiceResponse.class, rs);
                <orgId>1</orgId>
    m.marshal(rootElement,out);    
            <reportRequest>PRINT</reportRequest>
        
            <reportId>56401</reportId>
    //out.write("Success");
        } else {
            </arg0>
    out.write("Failure");
             </web:remoteReportCall>
       </soapenv:Body>
    </soapenv:Envelope>out.write(" Code: " + rs.getErrorCode());
        }
    %>
    Expand
    titleCOMMAND

     

     

    リクエスト要素

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

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

    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

     

    応答要素

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

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

    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()

    応答の例

    サービスは、今回の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>
                <author>System Administrator</author>
                <authoringMode>JAVA</authoringMode>
                <averageRunTime>0</averageRunTime>
                <binaryData>PHN0eWxlIHR5cGU9InRleHQvY3NzIj4KLm11bHRpV2lkZ2V0Q2FudmFzRWRpdG9yIHsKCXBvc2l0
    aW9uOiByZWxhdGl2ZTsKfQoKLm11bHRp . . .</binaryData>
           xmlns:web="http://webservices.web.mi.hof.com/">
       <soapenv:Header/>
       <soapenv:Body>
          <canDrill>false</canDrill><web:remoteReportCall>
                <category>Audit Reports</category><arg0>
                <contentType>text/html</contentType><loginId>admin@yellowfin.com.au</loginId>
                <dashboardEnabled>true<<password>test</dashboardEnabled>password>
                <dataOutput>COLUMN<<orgId>1</dataOutput>orgId>
                <datasource>Yellowfin Configuration Database</datasource><reportRequest>SENDTOEMAIL</reportRequest>
                <drillCode>NODRILL<<reportId>70012</drillCode>reportId>
                <errorCode>0</errorCode><alterationCommand>drill-down|70012</alterationCommand>
                <formatCode>REPORTANDCHART</formatCode><reportOptions>
                <hitCount>30</hitCount>
                <lastModifiedDate>2018-07-02</lastModifiedDate><string>binish.sheikh@yellowfin.com.au</string>
                <lastRunDuration>0<</lastRunDuration>reportOptions>
                <lastRunStatus>RUN_NOERROR<</lastRunStatus>arg0>
          </web:remoteReportCall>
       </soapenv:Body>
    </soapenv:Envelope>

     

    応答要素

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

    応答要素データ型説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE

     

     

    応答の例

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

    Code Block
    themeEclipse
    languagexml
    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
       <S:Body>
        <messages>Successfully Authenticated User<ns2: admin@yellowfin.com.au</messages>
    remoteReportCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
             <return>
        <messages>Loaded Report: 56401 Successfully</messages>
         <author>System Administrator</author>
          <messages>Generating HTML Report</messages>
        <authoringMode>JAVA</authoringMode>
            <messages>Request Contains No ReportFilter Records.<<averageRunTime>0</messages>averageRunTime>
                <messages>Report<canDrill>false</canDrill>
     Run Successfully</messages>
              <category>Tutorial</category>
      <messages>Web Service Request Complete</messages>
           <dashboardEnabled>true</dashboardEnabled>
         <preRunFilterString><![CDATA[<div class="rptFilterLogicText">
    <span class="rptFilterLogicIdentifier">Active Session Start</span>
    Is Not Null
    <span class="rptFilterLogicIdentifier"></span>
    </div>]]></preRunFilterString>
     <dataOutput>COLUMN</dataOutput>
                <datasource>Ski <private>false<Team</private>datasource>
                <relatedReports<errorCode>0</>errorCode>
                <reportDescription<formatCode>CHART</>formatCode>
                <reportId>56401<<hitCount>3</reportId>hitCount>
                <reportName>Active Sessions</reportName><lastModifiedDate>2018-03-07</lastModifiedDate>
                <reportStyle>td.rpthdrcol {
       position: relative;
    }
    img.rptcolmenu {
    <lastRunDuration>0</lastRunDuration>
          position: absolute;
       right: 5px;
     <messages>Successfully Authenticated topUser: 0;
    admin@yellowfin.com.au</messages>
        bottom: 0;
       margin: auto 0;
      <messages>Loaded cursorReport: 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>
        70012 Successfully</messages>
                <messages>Web Service Request Complete</messages>
                <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>
            <reportTemplate>REPORTANDCHART</reportTemplate>
        <private>false</private>
            <reportUUID>594d4da4-1b58-44d3-bf4f-11456a42f68c</reportUUID>
        <reportDescription>This report provides a high level summary of <reportUsage>100<campaigns</reportUsage>reportDescription>
                <selectedSortColumn>-1<<reportId>70012</selectedSortColumn>reportId>
                <reportName>Campaign <selectedSortOrder>0<Summary</selectedSortOrder>reportName>
                <sessionId>7fc9ad31786cfd1ca10605c301551534<<reportTemplate>CHART</sessionId>reportTemplate>
                <sortableColumns/><reportUUID>3e842fae-02f7-4ad3-a632-ca267e0078da</reportUUID>
                <sortableColumns<reportUsage>100</>reportUsage>
                <sortableColumns<sessionId>fa0cc79a9ea229bd5df85b4a7f50c878</>sessionId>
                <statusCode>SUCCESS</statusCode>
                <subCategory>Marketing <subCategory>Admin&amp; Reports<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
      themeEclipse
      languagejava
      ReportServiceRequest rsr = new ReportServiceRequest();
        
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(new Integer(1));
       
      rsr.setReportRequest("PRINTSENDTOEMAIL");
    • レポートの保存されているクライアント組織を指定する必要がある場合は、こちらのコードを追加します。

       

      Code Block
      themeEclipse
      languagejava
      rsr.setOrgRef("org1");      // search for the report in this client org
    • 印刷可能な書式に変換するレポートを指定します。メール送信するレポートと、その変更コマンドを指定します。

       

      Code Block
      themeEclipse
      languagejava
      rsr.setReportId(60712(60712);
      rsr.setAlterationCommand("drill-down|60712");
    • レポートの送信先となるメールアドレスを提供します。

       

      Code Block
      themeEclipse
      languagejava
      rsr.setReportOptions(new String[]{ "dummy@dummy.com"});
    • リクエストを構成したら、呼び出しを実行します。

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

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

     

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

     

    完成例

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

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

    Code Block
    themeEclipse
    languagejava
    /*              ws_printreportsendtoemail.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("SENDTOEMAIL");
        rsr.setOrgRef("PRINT1");
        rsr.setReportId(60712);
        rsr.setAlterationCommand("drill-down|60712");
        rsr.setReportOptions(new String[]{ "dummy@dummy.com"});
       ReportServiceResponse rs=rscrsr.remoteReportCall(rsr);setReportClientReferenceId("1");
        rsr.setDashboardTabId(70080);
         
        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());
        }
    %>

    ...