Error rendering macro 'rw-search'

null

Page History

Versions Compared

Old Version 7

changes.mady.by.user user-3484a

Saved on 22 Feb, 2018

compared with

New Version 8

changes.mady.by.user user-3484a

Saved on 22 Feb, 2018

Key

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

...

Expand

title	GETUSERTABS

This web service call will return the metadata of all the published dashboards for of a specified user. It also treats each sub tab within a dashboard as separate tabs so that . So if there is a dashboard with 2 sub tabs, GETUSERTABS call retrieves 2 has two tabs, this service will retrieve two separate AdministrationReportGroup objects for the dashboard. To get If only the parent dashboard metadata, do 's details are required, use the GETUSERPARENTTABS call. You can provide even retrieve details of a specfic dashboard tab /subtab Id to retrieve a specific dashboard tab/subtab data via request.setDashboardTabId(<Integer>).

Requires user Id. User Id should be passed via AdministrationPerson object.

or sub tab by passing its ID.

Note however, that this service does not retrieve the metadate of the dashboard's reports. To get that, use the The dashboard reports metadata will not be retrieved. If you need reports metadata, do GETUSERTABSWITHREPORTS call.

Request Parameters

The following parameters should be passed with this request:

Request Element	Data Type	Description
LoginId	String	An admin account to connect to Yellowfin web services. This can be the user ID or the email address, depending on the Logon ID method. This account must have the “web services” role enabled, and must belong to the default (i.e. primary) org.
Password	String	Password of the above account.
OrgId	Integer	Default (i.e. primary) organization ID within Yellowfin. Always set this to 1.
Function	String	Web service function. Set this to "GETUSERREPORTGETUSERTABS".
Person	AdministrationPerson	Object containing details of the user. See table below.
OrgRef	String	Client organization reference ID to search for the tab within a specific client org instead of the default org. This parameter is not mandatory.
ReportIdDashboardTabId	Integer	The Use this optional parameter to provide the unique ID of the report which you want details of. This report should already exist in Yellowfin.a dashboard tab whose details are to be retrieved.

Anchor

	getuserapgetusertabapgetuserap
	getusertabap

These are the main parameters that you must set in the AdministrationPerson object for this web service call:

AdministrationPerson Element	Data Type	Description
UserId	String	To identify the user for whom to retrieve the reportwho the dashboard tab belongs to. This could be the user ID or email address, depending on the Logon ID method.

Request Example

Below is a SOAP XML example for this request:

Code Block

language	xml

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:remoteAdministrationCall>
         <arg0>
 		  <loginId>admin@yellowfin.com.au</loginId>
            <password>test</password>
            <orgId>1</orgId>
            <function>GETUSERREPORT<<function>GETUSERTABS</function>
            <reportId>56401</reportId>       
            <person>
                <userId>admin@yellowfin.com.au</userId>              
            </person>       
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

Response Parameters

The returned response will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

Person

AdministrationPerson

Full details of the user.

ReportGroups

AdministrationReportGroup

Reports

AdministrationReport[]

An array that contains details of the specified reportcontaining the dashboards’ metadata.

Response Example

The service will return the below response, according to our SOAP example:

Code Block

language	javaxml

<S <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
         <return>
            <errorCode>0</errorCode>
            <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
            <messages>Getting user information...</messages>
            <messages>Getting user information...</messages>
            <messages>Web Service Request Complete</messages>
            <person>
               <emailAddress>admin@yellowfin.com.au</emailAddress>
               <firstName>System</firstName>
               <initial/>
               <ipId>5</ipId>
               <languageCode>EN</languageCode>
               <lastName>Administrator</lastName>
               <roleCode>YFADMIN</roleCode>
               <salutationCode/>
               <status>ACTIVE</status>
               <timeZoneCode>AUSTRALIA/SYDNEY</timeZoneCode>
               <userId>admin@yellowfin.com.au</userId>
            </person>
            <reports><reportGroups>
               <authoringMode>JAVA</authoringMode><publishUUID>02fec2d8-6b09-48a1-8c6a-54adbb2eb9b6</publishUUID>
               <averageRunTime>0<<reportGroupId>61251</averageRunTime>reportGroupId>
               <birtData<reportGroupName>Sales Performance</>reportGroupName>
               <chartTypeCode<reportGroupStatus>OPEN</>reportGroupStatus>
               <dashboardEnabled>true<<reportGroupType>ANALYTIC</dashboardEnabled>reportGroupType>
               <dataOutput>COLUMN</dataOutput></reportGroups>
               <deliveryMode/><reportGroups>
               <executionObject/><publishUUID>2e2fb9f6-d43e-4de2-977e-a646b01abc4b</publishUUID>
               <lastModifiedDate>2016-03-29T00:00:00+11:00</lastModifiedDate>
<reportGroupId>61210</reportGroupId>
                <lastModifierId>5</lastModifierId><reportGroupName>Campaign Analysis (Campaigns)</reportGroupName>
               <lastModifierName>System Administrator<<reportGroupStatus>OPEN</lastModifierName>reportGroupStatus>
               <publishDate>2016-03-23T00:00:00+11:00</publishDate><reportGroupType>ANALYTIC</reportGroupType>
               <reportCategory>Audit Reports</reportCategory></reportGroups>
               <reportDescription/><reportGroups>
               <reportId>56401</reportId><publishUUID>1a387957-564b-40ad-9fc1-4167ddd61f33</publishUUID>
               <reportName>Active Sessions<<reportGroupId>61243</reportName>reportGroupId>
               <reportSubCategory>Admin Reports</reportSubCategory><reportGroupName>Campaign Analysis (Marketing)</reportGroupName>
               <reportTemplate>REPORTANDCHART<<reportGroupStatus>OPEN</reportTemplate>reportGroupStatus>
               <reportUUID>594d4da4-1b58-44d3-bf4f-11456a42f68c</reportUUID><reportGroupType>ANALYTIC</reportGroupType>
               <roleCode>OPERATIONAL</roleCode></reportGroups>
               <sourceName/><sessionId>0ad8c1b60e3fb4b013055ee6da9ff867</sessionId>
               <usage>4</usage><statusCode>SUCCESS</statusCode>
               <viewDescription>Yellowfin Usage Audit</viewDescription>
               <viewId>56169</viewId>
               <viewName>NEW VIEW</viewName>
            </reports>
            <sessionId>3a4f9969aa278c03fa4cb891a87d6f36</sessionId>
            <statusCode>SUCCESS</statusCode>
         </return>
      </ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>

Instructions

See below for step-by-step instructions on how to perform this call, using a Java example:

AdministrationReport[] rpts = rs.getReports(); AdministrationReport report = rpts[0]; // getting the metadata of the first report

Expand

title	Step-by-step instructions

Start with a basic request for this function, which includes logging in as the admin user and specifying the web service call to perform:

Code Block

language	java

AdministrationServiceRequest rsr = new AdministrationServiceRequest();

rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);

rsr.setFunction("GETUSERREPORTGETUSERTABS");

Specify the user for whom to retrieve the reportYou may even identify a specific client organization:
Code Block
language java
rsr.setOrgRef("org1");

Specify the user who dashboard tab belongs to:

Code Block

language	java

AdministrationPerson ap =AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("admin@yellowfin.com.au");

rsr.setPerson(ap);

You may even identify a specific client organization:

code

language	java

rsr.setOrgRef("org1");

Provide the report ID. Ensure this ID belongs to an existing report.
Code Block
language java
rsr.setReportId(70292);

Once the request is configured, perform the call:
Code Block
language java
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
Initialize the Administration web service. Click here to learn how to do this.

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

Person

AdministrationPerson

Full details of the user.

ReportGroups

AdministrationReportGroup

Reports

AdministrationReport[]

An array that contains details of the specified report.

You can then retrieve the report:

Code Block

language	java

containing the dashboards’ metadata.

Complete Example

Below is a full example of this web service call. To use it for yourself, carry out the following the steps:

Copy the code and save it as ws_ getuserreportgetusertabs.jsp.
Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
Adjust the host, port, and admin user according to your environment.
Run http://<host>:<port>/ws_ getuserreportgetusertabs.jsp from your Internet browser.

Code Block

language	xml
theme	Eclipse

<%            
/*              ws_getuserreport.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.*" %>
<%
AdministrationServiceService s_adm = new AdministrationServiceServiceLocator("localhost",8080, "/services/AdministrationService", false);        // adjust host and port number
AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();
AdministrationServiceRequest rsr = new AdministrationServiceRequest();

rsr.setLoginId("admin@yellowfin.com.au");          // provide your Yellowfin web services admin account
rsr.setPassword("test");                           // set to the password of the above account
rsr.setOrgId(1);

rsr.setFunction("GETUSERREPORTGETUSERTABS");
rsr.setOrgRef("org1");
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("admin@yellowfin.com.au");  			
rsr.setPerson(ap);
 
rsr.setReportId(70297);								//existing report id. ReportId field of ReportHeader table (Yellowifn database)


AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

if ("SUCCESS".equals(rs.getStatusCode()) ) {
	out.write("Success<br>" + rs.getReportGroups().length + " tabs retrieved");

	// get the reporttabs details:
	AdministrationReportAdministrationReportGroup[] rptstabs = rs.getReportsgetReportGroups();

	for (AdministrationReportAdministrationReportGroup rtab: rptstabs){
		out.write("<br>Report<br><br>Dashboard Name: " + tab.getReportGroupName());
		out.write("<br>UUID: " + rtab.getReportNamegetPublishUUID());
		out.write("<br>Description<br>Id: " + rtab.getReportDescriptiongetReportGroupId());
		out.write("<br>Category<br>Group Type: " + rtab.getReportCategorygetReportGroupType());
		out.write("<br>Subcategory<br>InternalReference: " + rtab.getReportSubCategorygetReportGroupInternalReference());
	}
} else {
	out.write("Failure");
	out.write(" Code: " + rs.getErrorCode());
}
%>

Content

Space Tools

Versions Compared

Old Version 7

New Version 8

Key

Request Parameters

Request Example

Response Parameters

Response Example

Instructions

Complete Example