Error rendering macro 'rw-search'

null

Page History

Versions Compared

Old Version 35

changes.mady.by.user user-3484a

Saved on 24 Jun, 2018

compared with

New Version 36

changes.mady.by.user user-3484a

Saved on 24 Jun, 2018

Key

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

...

Expand

title	LISTPERSONFAVOURITES

This web service call returns a specific user's favourite items, including reports, storyboards, views, dashboards, distributed content, discussions or comments flagged by them.

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 "LISTPERSONFAVOURITES".
Favourite	PersonFavourite	This object is used to specify the favourite items are to be fetched. The user must be specified here, however other parameters are optional. See table below for more details.
RetrospectiveDays	Integer	This is an optional parameter.

Anchor

	listfavperson
	listfavperson

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

PersonFavourite Element	Data Type	Description
PersonId	Integer	Mandatory parameter. The Yellowfin internal ID (or IP ID) of a user whose favourite items you want to manipulate. This value should correspond with the Person.IpId field of Yellowfin's database, or retrieved by using AdministrationPerson.getIpId().
ContentType	String	This optional parameter can be set to filter the result by a specific content type. Values could include: REPORT REPORTGROUP DISCUSSIONGROUP REPORTVIEW STORYBOARD IMAGE
ContentId	Integer	This optional parameter can be used to restrict the result to a specific content by providing its internal ID, such as a report, dashboard, storyboard, etc.
FavouriteType	String	Optional. Use this to specify the favourite type.

Request Example

Below is a SOAP XML example for this request:

Code Block

language	xml
theme	Confluence

 <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>LISTPERSONFAVOURITES</function>
            <favourite>
            	<personId>5</personId>
            </favourite>     
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

Response Parameters

The returned response will contain the following parameter:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

Personfavourites

PersonFavourite[]

An array containing the user's favourite objects.

Response Example

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

Code Block

language	xml
theme	Confluence

 <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>Web Service Request Complete</messages>
            <personfavourites>
               <contentId>61209</contentId>
               <contentType>REPORTGROUP</contentType>
               <creationCode/>
               <creationDate>2017-06-26</creationDate>
               <creatorId>0</creatorId>
               <favouriteType>REPORTDASHBOARD</favouriteType>
               <message/>
               <personId>5</personId>
               <textEntityId>0</textEntityId>
            </personfavourites>
            <personfavourites>
               <contentId>61250</contentId>
               <contentType>REPORTGROUP</contentType>
               <creationCode/>
               <creationDate>2017-06-26</creationDate>
               <creatorId>0</creatorId>
               <favouriteType>REPORTDASHBOARD</favouriteType>
               <message/>
               <personId>5</personId>
               <textEntityId>0</textEntityId>
            </personfavourites>
            <sessionId>09123071f17afb11be74ca07a6d25aef</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

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("LISTPERSONFAVOURITES");

Identify a user by using a PersonFavourite object:
Code Block
language java
PersonFavourite pf = new PersonFavourite(); pf.setPersonId(13073);
The following steps are optional, and can be included to filter the response of this call.
- To retrieve the user's favourite reports:
  Code Block
  language java
  pf.setContentType("REPORT"); pf.setFavouriteType("FAVOURITE");
- To retrieve all of the user's dashboard:
  Code Block
  language java
  pf.setContentType("REPORTGROUP"); pf.setFavouriteType("REPORTDASHBOARD");
- To retrieve reports and dashboards distributed to the user:
  Code Block
  language java
  pf.setContentType("REPORTGROUP"); // use this for dashboards, or pf.setContentType("REPORT") to get distributed reports pf.setFavouriteType("INBOX");
- To retrieve discussions that the user is a member of:
  Code Block
  language java
  pf.setContentType("DISCUSSIONGROUP"); pf.setFavouriteType("DISCUSSIONMEMBER");
- To retrieve user's favourite views:
  Code Block
  language java
  pf.setContentType("REPORTVIEW");
- To retrieve user's favourite storyboards:
  Code Block
  language java
  pf.setContentType("STORYBOARD"); pf.setFavouriteType("FAVOURITE");
- To get user's profile image:
  Code Block
  language java
  pf.setContentType("IMAGE"); pf.setFavouriteType("PROFILE");
- To retrieve report comments flagged by the user:
  Code Block
  language java
  pf.setContentType("COMMENT"); pf.setFavouriteType("FLAGGED");
Add this object to the request:
Code Block
language java
rsr.setFavourite(pf);

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 will contain the StatusCode and PersonFavourites parameters. See the Response Parameter table above for details on this.

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_ listpersonfavourites.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_ listpersonfavourites.jsp from your Internet browser.

Code Block

language	java
theme	Eclipse

<%        	
/*          	ws_listpersonfavourites.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 webservices admin account
rsr.setPassword("test");                                                    	// change to be the password of the account above
rsr.setOrgId(1);
rsr.setFunction("LISTPERSONFAVOURITES");
 
PersonFavourite pf = new PersonFavourite();
pf.setPersonId(13073);
pf.setContentType("REPORT");
 
rsr.setFavourite(pf);
 
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
 
if ("SUCCESS".equals(rs.getStatusCode()) ) {
           out.write("<br>Success");
           if (rs.getPersonfavourites() != null)
           for (PersonFavourite f: pf){
                out.write("<br><br>contentId: " + f.getContentId());
            	out.write("<br>ContentType: " + f.getContentType());
            	out.write("<br>CreationCode: " + f.getCreationCode());
   	     		out.write("<br>CreationDate: " + f.getCreationDate());
           		out.write("<br>CreatorId: " + f.getCreatorId());
            	out.write("<br>FavouriteType: " + f.getFavouriteType());
        		out.write("<br>Message: " + f.getMessage());
     	    	out.write("<br>PersonId: " + f.getPersonId());
            	out.write("<br>textEntityId: " + f.getTextEntityId());
           }
} else {
            out.write("Failure");
            out.write(" Code: " + rs.getErrorCode());
}
%>

...

Expand

title	SAVEPERSONFAVOURITE

This web service call adds an item to a user's favourite list, such as a report, storyboard, view, etc. It also allows a dashboard tab to be added to a user's dashboard, and even flag a comment for a user.

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 "SAVEPERSONFAVOURITE".
Favourite	PersonFavourite	This object is used to specify the items to be marked as a user's favourite. The user is also specified here. See the table below for more details.

Anchor

	listfavperson
	listfavperson

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

PersonFavourite Element	Data Type	Description
PersonId	Integer	A mandatory parameter to identify the user with their internal ID (that is, the IP ID). This value should correspond with the Person.IpId field of Yellowfin's database, or retrieved by using AdministrationPerson.getIpId(). The items selected will be added as this user's favourite.
ContentType	String	This mandatory parameter is used to specify the content type of the item to be added as favourite. Possible values include: REPORT REPORTGROUP DISCUSSIONGROUP REPORTVIEW STORYBOARD IMAGE
ContentId	Integer	This mandatory parameter is used to define the item (such as a report, dashboard, storyboard, etc.) that is to be marked as the user's favourite by providing its internal ID.
FavouriteType	String	Optional. To specify the favourite type.
CreationCode	String
TextEntityId	Integer	This parameter is required if a comment is to be flagged.

Request Example

Below is a SOAP XML example for this request:

Code Block

language	xml
theme	Confluence

<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>SAVEPERSONFAVOURITE</function>
            <favourite>
            	<personId>13000</personId>
            	<contentType>REPORTGROUP</contentType>
            	<contentId>61209</contentId>
            </favourite>     
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

Response Parameters

The returned response will contain the following parameter:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

Response Example

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

Code Block

language	xml
theme	Confluence

<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>Web Service Request Complete</messages>
            <sessionId>6eb0b81605d3b355cf4a43ae608ab274</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

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("SAVEPERSONFAVOURITE");

Identify a user throught the PersonFavourite object:
Code Block
language java
PersonFavourite pf = new PersonFavourite(); pf.setPersonId(13073);
Specify the contents that are to be marked as favourite in this object:
Code Block
language java
pf.setContentId(61252); pf.setContentType("REPORTVIEW");
Add this object to the request:
Code Block
language java
rsr.setFavourite(pf);

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 will contain the StatusCode parameter. See the Response Parameter table above for details on this.

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_ savepersonfavourite.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_ savepersonfavourite.jsp from your Internet browser.

Code Block

language	java
theme	Eclipse

<%        	
/*          	ws_savepersonfavourite.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 account above
rsr.setOrgId(1);
rsr.setFunction("SAVEPERSONFAVOURITE");
 
PersonFavourite pf = new PersonFavourite();
pf.setPersonId(13073);
pf.setContentId(61252);
pf.setContentType("REPORTVIEW");
 
rsr.setFavourite(pf);
 
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
 
if ("SUCCESS".equals(rs.getStatusCode()) ) {
              	out.write("<br>Success");
              	
} else {
              	out.write("Failure");
              	out.write(" Code: " + rs.getErrorCode());
}
%>

...

Expand

title	REMOVEPERSONFAVOURITE

This web service call removes an item or object from a specific user's favourite list, such as a report, storyboard, view, etc. It also allows a dashboard tab to be removed from a user's dashboard, and even unflag a comment flagged by a user.

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 "REMOVEPERSONFAVOURITE".
Favourite	PersonFavourite	This object is used to specify the items to be removed as a user's favourite. The user is also specified here. See the table below for more details.

Anchor

	listfavperson
	listfavperson

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

PersonFavourite Element	Data Type	Description
PersonId	Integer	A mandatory parameter to identify the user with their internal ID (that is, the IP ID). This value should correspond with the Person.IpId field of Yellowfin's database, or retrieved by using AdministrationPerson.getIpId(). The items selected will be removed as this user's favourite.
ContentType	String	This mandatory parameter is used to specify the content type of the item to be removed as favourite. Possible values include: REPORT REPORTGROUP DISCUSSIONGROUP REPORTVIEW STORYBOARD IMAGE
ContentId	Integer	This mandatory parameter is used to define the item that is to be marked as the user's favourite by providing its internal ID.
FavouriteType	String	This is required to remove reports or dashboards as the user's favourite.
CreationCode	String
TextEntityId	Integer	This parameter is required if a comment is to be unflagged.

Request Example

Below is a SOAP XML example for this request:

Code Block

language	xml
theme	Confluence

<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>REMOVEPERSONFAVOURITE</function>
            <favourite>
            	<personId>13000</personId>
            	<contentType>REPORTGROUP</contentType>
            	<contentId>61209</contentId>
            </favourite>     
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

Response Parameters

The returned response will contain the following parameter:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

Response Example

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

Code Block

language	xml
theme	Confluence

<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>Web Service Request Complete</messages>
            <sessionId>0cc3673ed857e1e28fb0e326b8f3b24e</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

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("REMOVEPERSONFAVOURITE");

Identify a user throught the PersonFavourite object:
Code Block
language java
PersonFavourite pf = new PersonFavourite(); pf.setPersonId(13073);
Specify the objects that are to be removed as favourites in this object:
Code Block
language java
pf.setContentId(61252); pf.setContentType("REPORTVIEW");
Add this object to the request:
Code Block
language java
rsr.setFavourite(pf);

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 will contain the StatusCode parameter. See the Response Parameter table above for details on this.

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_ removepersonfavourite.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_ removepersonfavourite.jsp from your Internet browser.

Code Block

language	java
theme	Eclipse

<%        	
/*          	ws_removepersonfavourite.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 account above
rsr.setOrgId(1);
rsr.setFunction("REMOVEPERSONFAVOURITE");
 
PersonFavourite pf = new PersonFavourite();
pf.setPersonId(13073);
pf.setContentId(70270);
pf.setContentType("REPORTVIEW");
 
rsr.setFavourite(pf);
 
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
 
if ("SUCCESS".equals(rs.getStatusCode()) ) {
	out.write("<br>Success");              	
} else {
	out.write("Failure");
	out.write(" Code: " + rs.getErrorCode());
}
%>

...

Content

Space Tools

Page History

Versions Compared

Old Version 35

New Version 36

Key

Request Parameters

Request Example

Response Parameters

Response Example

Instructions

Complete Example

Request Parameters

Request Example

Response Parameters

Response Example

Instructions

Complete Example

Request Parameters

Request Example

Response Parameters

Response Example

Instructions

Complete Example