Page History
...
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Returns the metadata of user's dashboard tabs with their sub tab's IDs. You may provide the ID of a particular tab or sub tab to retrieve its details. Specify the user by using the AdministrationPerson object.
Request ParametersThe following parameters should be passed with this request:
These are the main parameters that you must set in the AdministrationPerson object for this web service call:
Request ExampleBelow is a SOAP XML example for this request:
Response ParametersThe returned response will contain these parameters:
Each element of the ParentDashboard will contain the following elements:
Response ExampleThe service will return the below response, according to our SOAP example:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete ExampleBelow is a full example of this web service call. To use it for yourself, carry out the following the steps:
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Use this web service to delete a user dashboard tab or sub tab. The dashboard tab/sub tab must be specified by providing either the ID number or UUID. Use the AdministrationPerson object to specify the user. This call is used to load metadata of dashboard tab reports for a specific user. The user is to be specified through the AdministrationPerson object. You can provide a dashboard tab ID via the AdministrationReportGroup object to get report details of a specific tab.
Request Parameters The following parameters should be passed with this request:
These are the main parameters that you must set in the AdministrationPerson object for this web service call:
| loadtabreprg | loadtabreprg |
AdministrationReportGroup Element | Data Type | Description |
---|---|---|
ReportGroupId | Integer | The ID of the dashboard tab. |
Request Example
Below is a SOAP XML example for this request:
Code Block | ||
---|---|---|
| ||
|
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:
|
parentReportGroups | An array of the dashboard tabs with subtabs. See below table. | |
Person | Full details of the user. |
Each element of the ParentReportGroup will contain the following elements:
Element | Data Type | Description |
---|---|---|
reportGroupId | Integer | Dashboard tab ID |
reportGroupUUID | String | Dashboard tab published UUID |
displayOrder | Integer | Display order of a dashboard tab in a user dashboard. |
reportGroup | Dashboard tab | |
reportGroupSubTabs | Sub tabs with a dashboard. |
Response Example
The service will return the below response, according to our SOAP example:
Code Block | ||
---|---|---|
| ||
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:remoteAdministrationCallResponse xmlns:ns2<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/"> <soapenv:Header/> <return><soapenv:Body> <errorCode>0</errorCode><web:remoteAdministrationCall> <arg0> <messages>Successfully Authenticated User: admin@yellowfin<loginId>admin@yellowfin.com.au</messages>loginId> <messages>Getting user information...</messages><password>test</password> <messages>Getting user information...</messages><orgId>1</orgId> <messages>Web Service Request Complete</messages><function>DELETETAB</function> <parentReportGroups><person> <reportGroup> <userId>admin@yellowfin.com.au</userId> <publishUUID>e7409ff2-f846-44e1-a603-b78ec51b20b9</publishUUID> </person> <reportGroupId>61250</reportGroupId> <dashboardTabId>61243</dashboardTabId> </arg0> <reportGroupName>Sales Performance</reportGroupName></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:
|
Response Example
The service will return the below response, according to our SOAP example:
Code Block | ||
---|---|---|
| ||
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/" <reportGroupStatus>OPEN</reportGroupStatus> <reportGroupType>ANALYTIC</reportGroupType> </reportGroup> <reportGroupId>61250</reportGroupId> <reportGroupSubTabs> <publishUUID>02fec2d8-6b09-48a1-8c6a-54adbb2eb9b6</publishUUID> <reportGroupId>61251</reportGroupId> <reportGroupName>New Tab</reportGroupName> <reportGroupStatus>OPEN</reportGroupStatus> <reportGroupType>SUBTAB</reportGroupType> </reportGroupSubTabs> </parentReportGroups> <parentReportGroups> <reportGroup> <publishUUID>1e68d9cc-fa5a-44e2-816d-782aa40ceeae</publishUUID> <reportGroupId>61209</reportGroupId> <reportGroupName>Campaign Analysis</reportGroupName> <reportGroupStatus>OPEN</reportGroupStatus> <reportGroupType>ANALYTIC</reportGroupType> </reportGroup> <reportGroupId>61209</reportGroupId> <reportGroupSubTabs> <publishUUID>2e2fb9f6-d43e-4de2-977e-a646b01abc4b</publishUUID> <reportGroupId>61210</reportGroupId> <reportGroupName>Campaigns</reportGroupName> <reportGroupStatus>OPEN</reportGroupStatus> <reportGroupType>SUBTAB</reportGroupType> </reportGroupSubTabs> <reportGroupSubTabs> <publishUUID>1a387957-564b-40ad-9fc1-4167ddd61f33</publishUUID> <reportGroupId>61243</reportGroupId> <reportGroupName>Marketing</reportGroupName> <reportGroupStatus>OPEN</reportGroupStatus> <reportGroupType>SUBTAB</reportGroupType> </reportGroupSubTabs> </parentReportGroups> <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><return> <timeZoneCode>AUSTRALIA/SYDNEY</timeZoneCode><errorCode>0</errorCode> <messages>Successfully Authenticated User: <userId>admin@yellowfinadmin@yellowfin.com.au</userId>messages> </person><messages>Web Service Request Complete</messages> <sessionId>59ff828c9f26cbe0fdfd281a951d3ec9<<sessionId>df716bf8bf6d71bd586da445e02b348e</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:
Expand | |||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||
|
|
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_ getuserparentreportgroupsdeletedashboard.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_ getuserparentreportgroups deletedashboard.jsp from your Internet browser.
Code Block | ||||
---|---|---|---|---|
| ||||
<% /* ws_getuserparentreportgroupsdeletedashboard.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("GETUSERPARENTREPORTGROUPSDELETETAB"); rsr.setOrgRef("org1"); AdministrationPerson ap = new AdministrationPerson(); ap.setUserId("admin@yellowfin.com.au"); rsr.setPerson(ap); rsr.setDashboardTabId(61210); // providepass thisthe dashboard sub tab id to get its parent /subtab Id: //rsr.setDashboardTabtId(71081); // or dashboard tab details (optional)/subtab UUID: rsr.setParameters(new String[] {"0ac13905-aa14-4887-9718-44c29b11311b"}); AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode()) ) { ParentReportGroups[] tabs = rs.getParentReportGroups(); if (tabs != null) for (AdministrationReportGroup tab: tabs){ out.write("<br><br>Tab Name: " + tab.getReportGroupName()); out.write("<br>Number of subtabs: " + tab.getReportGroup().length)); AdministrationReportGroup[] groups = tab.getReportGroup(); for (AdministrationReportGroup gr: groups){ out.write("<br>Subtab Name: " + gr.getReportGroupName()); } } }<br>Dashboard tab has been deleted."); } else { out.write("Failure"); out.write(" Code: " + rs.getErrorCode()); } %> |