Like what you see? Have a play with our trial version.

Versions Compared

Key

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

These web services are used in a cluster environment, where Yellowfin is set up amongst multiple nodes connected to a local database. Most of these are used to transmit messages between the cluster nodes, and to clear the cache of a specific node, when data is updated or deleted locally, ensuring consistency in content throughout the cluster. Each of these services remove a specific type of content/data.

 

 

Anchor
binaryCacheFlush
binaryCacheFlush

Expand
titleBINARYCACHEFLUSH

This web service is used to remove classes that are in the binary class loader. For example, this could be classes that were loaded as plug-ins such as connectors or data transformation steps that are stored in the database rather than on the file system.

 

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

 

 

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

This web service is used to retrieve users' avatar images. If an avatar image is not set up for a user in Yellowfin, then no image will be retrieved for that user. This service requires the users' internal IDs (that is, their IP ID).

 

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 "GETAVATARSBINARYCACHEFLUSH".

ParametersString[]An array containing the internal IDs (or IpId) of Yellowfin users’ whose avatars you want to retrieve. Each ID must be passed as a String, even though it's an Integer.

 

 

  

Request Example

Below is a SOAP XML example for this request:

Code Block
languagexml
 <soapenv<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>GETAVATARS<<function>BINARYCACHEFLUSH</function>
   
         <parameters></arg0>
            	<string>13000</string>
            </parameters>
         </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

binaryAttachments

ReportBinaryObject[]

Contains avatar images for the specified users.

 

 

Response Example

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

Code Block
languagexml
 

 

 

Instructions

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

Expand
titleStep-by-step instructions
Code Block
languagejava
AdministrationServiceRequest rsr = new AdministrationServiceRequest();

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

rsr.setFunction("GETAVATARS");

You can specify the users' IP IDs:

Code Block
languagejava
rsr.setParameters(new String[] {"5","13073"});
  • Once the request is configured, perform the call:

    Code Block
    languagejava
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
    

    Initialize the Administration web service. Click here to learn how to do this. 

 

  • The response will contain a StatusCode element, along with a BinaryAttachment array.

  • To get the first image, use the following:

    Code Block
    languagejava
    byte[] data = response.getBinaryAttachments[0].getData();
    

     

     

    Complete Example

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

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

     

    Code Block
    languagejava
    themeEclipse
    <%<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>071e8a40b17160cbc3e55df360cdab11</sessionId>
      ws_getavatars.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.*" %>
    <html>
    <body>
    <%
    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("GETAVATARS");
    rsr.setParameters(new String[] {"5","13073"});
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
    
    if ("SUCCESS".equals(rs.getStatusCode()) ) {
    	ReportBinaryObject[] objects = rs.getBinaryAttachments();
    	if (objects != null) {
    		byte[] data,encodeBase64;
    		String base64Encoded;
    
    
    		for(ReportBinaryObject o: objects){
    			data = o.getData();
    			if (data != null){
    
    
    				encodeBase64 = java.util.Base64.getEncoder().encode(data);
    				base64Encoded = new String(encodeBase64, "UTF-8");
    				if (base64Encoded != null)  
    					out.write("<br>");
    				%>
    				<img src="data:image/jpg;base64,<%=base64Encoded%>" alt="No image">
    				<%
    			}
    		}
    	}
    } else {
    	out.write("Failure");
    	out.write(" Code: " + rs.getErrorCode());
    }
    %>
    </body>
    </html>
    

     

     

     </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
    titleStep-by-step instructions
    • Define the request for this function, which includes logging in as the admin user and specifying the web service call to perform:

      Code Block
      languagejava
      themeConfluence
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(new Integer(1));
      
      rsr.setFunction("BINARYCACHEFLUSH");


    • Once the request is configured, perform the call:

      Code Block
      languagejava
      AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

      Initialize the Administration web service. Click here to learn how to do this. 

     

    • The response will contain the StatusCode. (See details in the Response Parameters table above.)

       

     

     

    Complete Example

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

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

     

    Code Block
    languagejava
    themeEclipse
    <%   	
    /*    	ws_binarycacheflush.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.*" %>
     
    AdministrationServiceResponse rs = null;
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
    AdministrationServiceService ts = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false);
    AdministrationServiceSoapBindingStub rssbs = (AdministrationServiceSoapBindingStub) ts.getAdministrationService();
    
    rsr.setLoginId("admin@yellowfin.com.au");
    rsr.setPassword("test");
    rsr.setOrgId(new Integer(1));
    rsr.setFunction("BINARYCACHEFLUSH");    
    rs = rssbs.remoteAdministrationCall(rsr);
    
    if ("SUCCESS".equals(rs.getStatusCode())) {
        out.write("Success");
    } else {
        out.write("Failure");
        out.write(rs.toString());
    }
    

     


     

    Anchor
    uploadLicence
    uploadLicence

    Expand
    titleUPLOADLICENCE

    This web service is used to upload a new licence for the Yellowfin instance

    Expand
    titleSETAVATARIMAGE

    This web service is used to upload an avatar image for a specified user. The image should be an array of bytes in UTF-8 which you could convert to a String value.

     

    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 "SETAVATARIMAGEUPLOADLICENCE".

    PersonAdministrationPersonThis object contains details of the user whose avatar is to be changed. See table below.
    BinaryDatabyteParametersString[]An A byte array containing a single element representing the avatar image to be uploaded. The image should be an array of bytes in UTF-8 format, which could be converted to a String.
    Anchor
    setavatarap
    the new licence.

     

      

    Response Parameters

    The returned response will contain these parameters:

    Response

    setavatarap

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

    IpId
    AdministrationPerson

    Element

    Data Type

    Description

    StatusCode

    Integer

    Provide the internal Yellowfin IP ID of the user. This value is stored in the Person parameter's IpId field in Yellowfin's database.

     

     

    Request Example

    Below is a SOAP XML example for this request

    String

    Status of the web service call. Possible values include:

    • SUCCESS
    • FAILURE

     

    Instructions

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

    xml
    Expand
    titleStep-by-step instructions
    • Define the request for this function, which includes logging in as the admin user and specifying the web service call to perform:

      Code Block
      language
    • java
      themeConfluence
     

     

     

    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
    languagexml
    themeConfluence
     

     

     

    Instructions

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

    Expand
    titleStep-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
      languagejava
      AdministrationServiceRequest AdministrationServiceRequest rsr = new AdministrationServiceRequest();
      
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(new Integer(1));
      
      rsr.setFunction("SETAVATARIMAGEUPLOADLICENCE");


    • You can specify the user by providing their IP ID:Provide the new licence for your instance. The licence will be a byte array; you can encode it to Base64 and use the util method to convert it.

      Code Block
      languagejava
      AdministrationPersonbyte[] aplic = new AdministrationPerson();
      ap.setIpId(5);
      
      rsr.setPerson(ap); com.hof.util.Base64.decode("Base64 Encoded String of licence file");
      rsr.setBinaryData(lic);


    • Once the request is configured, perform the callSelect the image file, by using the java.nio.file library:

      Code Block
      languagejava
      PathAdministrationServiceResponse pathrs = PathsadminService.get("D:/TMP/fish.jpg"); // existing image file
      byte[] data = Files.readAllBytes(path);
      byte[] encodeBase64 = java.util.Base64.getEncoder().encode(data);
      String img = new String(encodeBase64, "UTF-8");
      
      rsr.setParameters(new String[] {img});

      Once the request is configured, perform the call:

      Code Block
      languagejava
      AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
      
      remoteAdministrationCall(rsr);

      Initialize the Administration web service. Click here to Initialize the Administration web service. Click here to learn how to do this. 

     

    • The response will contain a StatusCode element.the StatusCode. (See details in the Response Parameters table above.)

       

     

     

    Complete Example

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

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

     

    Code Block
    languagejava
    themeEclipse
    <%        	
    /*          	ws_setavatarimageuploadlicence.jsp              	*/
    %>
    <%@ page               	*/
    %>
    <%@ page language="java" contentTypelanguage="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="java.nio.file.Files" %>
    <%@ page import="java.nio.file.Paths" %>
    <%@ page import="java.nio.file.Path" %>
    <%
    AdministrationServiceService s_adm
    AdministrationServiceResponse rs = null;
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
    AdministrationServiceService ts = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false);    	// adjust host and port number
    AdministrationServiceSoapBindingStub adminServicerssbs = (AdministrationServiceSoapBindingStub) s_admts.getAdministrationService();
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
     
    rsr.setLoginId("admin@yellowfin.com.au");      	// provide your Yellowfin webservices admin account
    rsr.setPassword("test");
    rsr.setOrgId(new Integer(1));
    rsr.setFunction("UPLOADLICENCE");
        
    // Licence needs to be a byte array. An easy way to do this is to encode it to Base64 and use the util method to convert it
    byte[] lic = com.hof.util.Base64.decode("Base64                 	// change to be the password of the account above
    rsr.setOrgId(1Encoded String of licence file");
    rsr.setFunctionsetBinaryData("SETAVATARIMAGE"lic);
     
    AdministrationPerson ap   
    rs = new AdministrationPerson(rssbs.remoteAdministrationCall(rsr);
    ap.setIpId(5);
     
    rsr.setPerson(ap);
     
    Path path = Paths.get("D:/TMP/fish.jpg"); // existing image file
    byte[] data = Files.readAllBytes(path);
    byte[] encodeBase64 = java.util.Base64.getEncoder().encode(data);
    String img = new String(encodeBase64, "UTF-8");
     
    rsr.setParameters(new String[] {img});
     
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
     
    if ("SUCCESS".equals(rs.getStatusCode()) ) {
                  	out.write("<br>Success");
    } else {
                  	out.write("Failure");
                  	out.write(" Code: " + rs.getErrorCode());
    }
    %>
    
    

     

     

     

     

    Favourting Items

    
    if ("SUCCESS".equals(rs.getStatusCode())) {
    	out.write("Success");
    } else {
    	out.write(rs.getStatusCode());
    	out.write(rs.toString());
    }
    
    

     


     

    Anchor
    delGeoPack
    delGeoPack

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

    Expand
    titleDELGEOPACK

    This web service removes a specified Geopack from the Geopack cache. Note, however, that it does not delete the Geopack from the server.

    Expand
    titleGETFAVOURITES

    This web service call returns all reports marked as favourite by a specific 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 "GETFAVOURITESDELGEOPACK".

    PersonOrgRefAdministrationPersonThis object contains details of the user. See table below.
    Anchor
    getfaveapgetfaveap
    AdministrationPerson Element

    Data Type

    Description

    UserId

    String

    ID of the user whose favourite reports are to be fetched. This value could be the user ID or user's email address, depending on the Logon ID method.

     

    StringThis optional parameter can be used to specify a client org. ID
    ParametersStringUse this to specify the UUID of the geopack to be deleted from the cache.

       

    Request Example

    Below is a SOAP XML example for this request:

    Code Block
    languagexml
    themeConfluence
     

     

     

    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

    Person

    AdministrationPerson

    Full details of the user.

    Reports

    AdministrationReports[]

    An array of the user's favourite reports.

     

     

    Response Example

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

    Code Block
    languagexml
    themeConfluence
     

     

     

    Instructions

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

    Expand
    titleStep-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:
    <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>DELGEOPACK</function>
                <parameters>
                	<string>db1cf6f7-3561-45a0-b6bc-ff7b94117741</string>
                </parameters>
             </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

     

    Response Example

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

    Code Block
    languagexml
    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
       <S:Body>
          <ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
             <return>
    
    Code Block
    languagejava
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
    
    rsr.setLoginId("admin@yellowfin.com.au");
    rsr.setPassword("test");
    rsr.setOrgId(1);
    
    rsr.setFunction("GETFAVOURITES");
  • You can specify the user to fetch their favourite reports:

    Code Block
    languagejava
    AdministrationPerson ap = new AdministrationPerson();
    ap.setUserId("test.user@yellowfin.com.au");
    rsr.setPerson(ap);
    • Once the request is configured, perform the call:

      Code Block
      languagejava
      AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
      

      Initialize the Administration web service. Click here to learn how to do this. 

     

    • The response will contain the StatusCode, Person and Reports parameters. See the Response Parameter table above for details on these.

       

     

     

    Complete Example

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

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

     

    Code Block
    languagejava
    themeEclipse
    <%        	
    /*          	ws_getfavourites.jsp                	*<errorCode>0</
    %>
    <%@ 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");errorCode>
                <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
                <messages>Web Service Request Complete</messages>
                		// provide your Yellowfin web services admin account
    rsr.setPassword("test");<sessionId>9a3871407a758998334a2d780c44f9ae</sessionId>
                <statusCode>SUCCESS</statusCode>
             </return>
           // set to the password of the account above
    rsr.setOrgId(1);
    rsr.setFunction("GETFAVOURITES");
     
    AdministrationPerson ap = new AdministrationPerson();
    ap.setUserId("test.user@yellowfin.</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
    titleStep-by-step instructions
    • Define the request for this function, which includes logging in as the admin user and specifying the web service call to perform:

      Code Block
      languagejava
      themeConfluence
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();
      rsr.setLoginId("admin@yellowfin.com.au");
      
    • rsr.
    setPerson
    • setPassword(
    ap
    • "test");
      
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr
    • rsr.setOrgId(new Integer(1));
      
    • 
      
    if
    • rsr.setFunction("DELGEOPACK");


    • Specify which geopack to remove from the cache, by providing its UUID through a Parameters element:

      Code Block
      languagejava
      rsr.setParameters(new String[] { "db1cf6f7-3561-45a0-b6bc-ff7b94117741" } );


    • Once the request is configured, perform the call:

      Code Block
      languagejava
      AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

      Initialize the Administration web service. Click here to learn how to do this. 

     

    • The response will contain the StatusCode. (See details in the Response Parameters table above.)

       

     

     

    Complete Example

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

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

     

    Code Block
    languagejava
    themeEclipse
    <%   	
    /*    	ws_delgeopack.jspSUCCESS".equals(rs.getStatusCode()) ) {
                  	out.write("<br>Success");
                                    	AdministrationReport[] reports = rs.getReports();
                                    	if (reports != null)
                                                                        	for(AdministrationReport r: reports){
                                                                                          	out.write("<br>Report Name: " + r.getReportName());
                                                                        	}
    } else {
                  	out.write("Failure");
                  	out.write(" Code: " + rs.getErrorCode());
    }
    %>
    
    
    

     

     

    Expand
    titleGETINBOX
    */
    %>
    <%@ 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.*" %>
     
    AdministrationServiceResponse rs = null;
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
    AdministrationServiceService ts = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false);
    AdministrationServiceSoapBindingStub rssbs = (AdministrationServiceSoapBindingStub) ts.getAdministrationService();
    
    rsr.setLoginId("admin@yellowfin.com.au");
    rsr.setPassword("test");
    rsr.setOrgId(new Integer(1));
    rsr.setFunction("DELGEOPACK");
    rsr.setParameters(new String[] { "db1cf6f7-3561-45a0-b6bc-ff7b94117741" } );
        
    rs = rssbs.remoteAdministrationCall(rsr);
    
    if ("SUCCESS".equals(rs.getStatusCode())) {
        out.write("Success");
    } else {
        out.write("Failure");
        out.write(rs.toString());
    }
    

     


     

    Anchor
    dashboardCache
    dashboardCache

    Expand
    titleREFRESH_DASHBOARD_CACHED_FILTERS

    This web service is used to refresh cached filters associated with a particular dashboard. The dashboard is specified by providing its ID or UUID.

     

    Request Parameters

    The following parameters should be passed with this request:

    Request Element

    Data

    This returns a specified user's inbox reports. These are reports which have been distributed to the 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 "GETINBOXREFRESH_DASHBOARD_CACHED_FILTERS".

    PersonParametersAdministrationPersonThis object contains details of the user. See table below.
    Anchor
    getinboxap
    String[]Array string containing the ID or UUID of the dashboard whose cached filters are to be removed. Note that only the first parameter in the array is used.

     

     

    Response Parameters

    The returned response will contain these parameters:

    Response

    getinboxap

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

    UserIdID user whose inbox reports are to be fetched. This value could be the user ID or user's email address, depending on the Logon ID method.
    AdministrationPerson

    Element

    Data Type

    Description

    StatusCode

    String

    Status of the

     

     

    Request Example

    Below is a SOAP XML example for this request:

    Code Block
    languagexml
    themeConfluence
     

     

     

    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

    Person

    AdministrationPerson

    Full details of the user.

    Reports

    AdministrationReports[]

    An array of the user's inbox reports.

     

     

    Response Example

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

    Code Block
    languagexml
    themeConfluence
     

     

     

    web service call. Possible values include:

    • SUCCESS
    • FAILURE

     

    Instructions

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

    Expand
    titleStep-by-step instructions
    • Start with a basic Define the request for this function, which includes logging in as the admin user and specifying the web service call to perform:

      Code Block
      languagejava
      themeConfluence
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();
      
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(new Integer(1));
      
      rsr.setFunction("GETINBOXREFRESH_DASHBOARD_CACHED_FILTERS");


    • You can specify the user to fetch their favourite reports:Specify the dashboard UUID by using the parameters element.

      Code Block
      languagejava
      AdministrationPerson ap = new AdministrationPerson();
      ap.setUserId("test.user@yellowfin.com.au");
      rsr.setPerson(aprsr.setParameters(new String[] { "61209" });


    • Once the request is configured, perform the call:

      Code Block
      languagejava
      AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
      

      Initialize the Administration web service. Click here to learn how to do this. 

     

    • The The response will contain the StatusCode, Person and Reports parameters. (See details in the Response Parameter Parameters table above for details on these.)

       

     

     

    Complete Example

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

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

     

    Code Block
    languagejava
    themeEclipse
    <%        	
    /*          	ws_getinboxrefreshdashboardfilters.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
     
    AdministrationServiceResponse rs = null;
    AdministrationServiceRequest rsr = new AdministrationServiceServiceLocator(AdministrationServiceRequest();
    AdministrationServiceService ts = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false);    	// adjust host and port number
    AdministrationServiceSoapBindingStub adminServicerssbs = (AdministrationServiceSoapBindingStub) s_admts.getAdministrationService();
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
     
    rsr.setLoginId("admin@yellowfin.com.au");      	// provide your Yellowfin webservices admin account
    rsr.setPassword("test");
    rsr.setOrgId(new Integer(1));
    rsr.setFunction("REFRESH_DASHBOARD_CACHED_FILTERS");
        
    // Provide the Dashboard UUID
    rsr.setParameters(new String[] { "61209" });
        
    rs = rssbs.remoteAdministrationCall(rsr);
    
    if ("SUCCESS".equals(rs.getStatusCode())) {
                                   	// change to be the password of the account above
    rsr.setOrgId(1);
    rsr.setFunction("GETINBOXout.write("Success");
    } 
    AdministrationPerson ap = new AdministrationPerson();
    ap.setUserId("test.user@yellowfin.com.au");
     
    rsr.setPerson(ap);
     
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
     
    if ("SUCCESS".equals(else {
        out.write(rs.getStatusCode()) ) {
              ;
        	out.write("<br>Success");
      rs.toString());
    }
    

     


     

    Anchor
    viewCache
    viewCache

    Expand
    titleREFRESH_VIEW_CACHED_FILTERS

    This web service is used to refresh cached filters associated with a particular view. The view is specified by providing its ID or UUID.

     

    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 "REFRESH_VIEW_CACHED_FILTERS".

    ParametersString[]Array string containing the ID or UUID of the view whose cached filters are to be removed. Note that only the first parameter in the array is used.

     

     

    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

     

    Instructions

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

    Expand
    titleStep-by-step instructions
    • Define the request for this function, which includes logging in as the admin user and specifying the web service call to perform:

      Code Block
      languagejava
      themeConfluence
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(new Integer(1));
      
      rsr.setFunction("REFRESH_VIEW_CACHED_FILTERS");


    • Specify the view UUID by using the Parameters element.

      Code Block
      languagejava
      rsr.setParameters(new String[] { "61209" });


    • Once the request is configured, perform the call:

      Code Block
      languagejava
      AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

      Initialize the Administration web service. Click here to learn how to do this. 

     

    • The response will contain the StatusCode. (See details in the Response Parameters table above.)

       

     

     

    Complete Example

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

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

     

    Code Block
    languagejava
    themeEclipse
    <%   	
    /*    	ws_refreshviewfilters.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.*" %>
     
    AdministrationServiceResponse rs = null;
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
    AdministrationServiceService ts = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false);
    AdministrationServiceSoapBindingStub rssbs = (AdministrationServiceSoapBindingStub) ts.getAdministrationService();
    
    rsr.setLoginId("admin@yellowfin.com.au");
    rsr.setPassword("test");
    rsr.setOrgId(new Integer(1));
    rsr.setFunction("REFRESH_VIEW_CACHED_FILTERS");
        
    // Provide the View UUID
    rsr.setParameters(new String[] { "61209" });
        
    rs = rssbs.remoteAdministrationCall(rsr);
    
    if ("SUCCESS".equals(rs.getStatusCode())) {
        out.write("Success");
    } else {
        out.write(rs.getStatusCode());
        out.write(rs.toString());
    }

     


     

    Anchor
    refreshsourcefilters
    refreshsourcefilters

    Expand
    titleREFRESH_SOURCE_FILTERS

    This service refreshes all access source filters for the specified data source connection.

     

    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 "REFRESH_SOURCE_FILTERS".

    ParametersString[]

    The function requires only one string as a parameter, which is the target source ID. You can find this value in the reportviewsource table of the SourceId column.

     

    Request Example

    Below is a SOAP XML example for this request:

    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:remoteAdministrationCall>
         	<arg0>
                <loginId>admin@yellowfin.com.au</loginId>
                <password>test</password>
            	<orgId>1</orgId>
                <function>REFRESH_SOURCE_FILTERS</function>
                <parameters>54700</parameters>
           	</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

     

    Response Example

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

    Code Block
    languagexml
    <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>13143fc20f2d7eeb52ec27f588a9942f</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
    titleStep-by-step instructions
    • Define the request for this function, which includes logging in as the admin user and specifying the web service call to perform:

      Code Block
      languagejava
      themeConfluence
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(new Integer(1));
      
      rsr.setFunction("REFRESH_SOURCE_FILTERS");


    • Specify the data source by its source ID number to remove its definition from the cache:

      Code Block
      languagejava
      rsr.setParameters(new String[] {"54700"});


    • Once the request is configured, perform the call:

      Code Block
      languagejava
      AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

      Initialize the Administration web service. Click here to learn how to do this. 

     

    • Add the following check to retrieve the response, containing the StatusCode.

      Code Block
      languagejava
      if ("SUCCESS".equals(rs.getStatusCode()) ) {
                    	out.write("<br>Success");
                    	
      }
      else {
                    	out.write("<br>Failure");
                    	out.write(" Code: " + rs.getErrorCode());
      }   

       

     

     

    Complete Example

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

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

     

    Code Block
    languagejava
    themeEclipse
    <%        	
    /*          	ws_refresh_source_filters.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("REFRESH_SOURCE_FILTERS");
     
    rsr.setParameters(new String[] {"54700"});
     
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
     
    if ("SUCCESS".equals(rs.getStatusCode()) ) {
                  	out.write("<br>Success");
                  	
    }
    else {
                  	out.write("<br>Failure");
                  	out.write(" Code: " + rs.getErrorCode());
    }             	
    %>

     


     

    Anchor
    reloadcodes
    reloadcodes

    Expand
    titleRELOADCODES

    This web service will reload the specified Org Reference Codes within Yellowfin.

     

    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 "RELOADCODES".

    ParametersString[]

    Array of Org reference codes to refresh. Following are some of the options and their descriptions:

    • NAME: Use this option to reload the organization names.
    • PARAMETER: This option reloads prganization Parameters, including system configurations, custom parameters, and date periods.
    • REFCODE: Reloads Org Ref Codes.
    • ROLEFN: Reloads functions and role definitions.
    • ORGRELATIONSHIPS: Reloads organization relationships, including 'Client Reference ID to Org ID' mappings.

     

     

    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

     

    Instructions

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

    Expand
    titleStep-by-step instructions
    • Define the request for this function, which includes logging in as the admin user and specifying the web service call to perform:

      Code Block
      languagejava
      themeConfluence
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(new Integer(1));
      
      rsr.setFunction("RELOADCODES");


    • Specify the Org reference codes that you need to reload into Yellowfin:

      Code Block
      languagejava
      rsr.setParameters(new String[] {
          "ADDRESS", "HIERARCHY", "NAME", "PARAMETER", "REFCODE", "ROLEFN", "ORGRELATIONSHIPS"
      });


    • Once the request is configured, perform the call:

      Code Block
      languagejava
      AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

      Initialize the Administration web service. Click here to learn how to do this. 

     

    • The response will contain the StatusCode. (See details in the Response Parameters table above.)

       

     

     

    Complete Example

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

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

     

    Code Block
    languagejava
    themeEclipse
    <%   	
    /*    	ws_reloadcodes.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.*" %>
     
    	AdministrationServiceResponse rs = null;
        AdministrationServiceRequest rsr = new AdministrationServiceRequest();
        AdministrationServiceService ts = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false);
        AdministrationServiceSoapBindingStub rssbs = (AdministrationServiceSoapBindingStub) ts.getAdministrationService();
    
        rsr.setLoginId("admin@yellowfin.com.au");
        rsr.setPassword("test");
        rsr.setOrgId(new Integer(1));
        rsr.setFunction("RELOADCODES");
        
        rsr.setParameters(new String[] {
                "ADDRESS", "HIERARCHY", "NAME", "PARAMETER", "REFCODE", "ROLEFN", "ORGRELATIONSHIPS"
        });
        
        rs = rssbs.remoteAdministrationCall(rsr);
    
        if ("SUCCESS".equals(rs.getStatusCode())) {
            out.write("Success </br>");
        } else {
            out.write(rs.getStatusCode());
            out.write(rs.toString());
        }
    
    
    

     


     

    Anchor
    geometryFlush
    geometryFlush

    Expand
    titleGEOMETRYFLUSH

    This web service will clear the geometry cache in Yellowfin.

     

    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 "GEOMETRYFLUSH".

    ParametersString[]

    IDs of Views from which the geometry objects are cached with.

     

     

    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

     

    Instructions

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

    Expand
    titleStep-by-step instructions
    • Define the request for this function, which includes logging in as the admin user and specifying the web service call to perform:

      Code Block
      languagejava
      themeConfluence
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(new Integer(1));
      
      rsr.setFunction("GEOMETRYFLUSH");


    • Specify the Views from which to flush geometery objects:

      Code Block
      languagejava
      rsr.setParameters(new String[] {
           "70103", "70104"
      });


    • Once the request is configured, perform the call:

      Code Block
      languagejava
      AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

      Initialize the Administration web service. Click here to learn how to do this. 

     

    • The response will contain the StatusCode. (See details in the Response Parameters table above.)

       

     

     

    Complete Example

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

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

     

    Code Block
    languagejava
    themeEclipse
    <%   	
    /*    	ws_geometryflush.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.*" %>
     
    	AdministrationServiceResponse rs = null;
        AdministrationServiceRequest rsr = new AdministrationServiceRequest();
        AdministrationServiceService ts = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false);
        AdministrationServiceSoapBindingStub rssbs = (AdministrationServiceSoapBindingStub) ts.getAdministrationService();
    
        rsr.setLoginId("admin@yellowfin.com.au");
        rsr.setPassword("test");
        rsr.setOrgId(new Integer(1));
        rsr.setFunction("GEOMETRYFLUSH");
        
    	//View IDs from which geometry objects are to be removed
        rsr.setParameters(new String[] {
                "70103", "70104"
        });
        
        rs = rssbs.remoteAdministrationCall(rsr);
    
        if ("SUCCESS".equals(rs.getStatusCode())) {
            out.write("Success </br>");
        } else {
            out.write(rs.getStatusCode());
            out.write(rs.toString());
        }
    
    
    

     


     

    Anchor
    removeView
    removeView

    Expand
    titleREMOVEVIEW

    This web service will remove a view's cache in Yellowfin.

     

    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 "REMOVEVIEW".

    ParametersString[]

    IDs of views whose caches are to be removed.

     

     

    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

     

    Instructions

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

    Expand
    titleStep-by-step instructions
    • Define the request for this function, which includes logging in as the admin user and specifying the web service call to perform:

      Code Block
      languagejava
      themeConfluence
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(new Integer(1));
      
      rsr.setFunction("REMOVEVIEW");


    • Specify the Views whose caches are to be removed:

      Code Block
      languagejava
      rsr.setParameters(new String[] {
           "70103", "70104"
      });


    • Once the request is configured, perform the call:

      Code Block
      languagejava
      AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

      Initialize the Administration web service. Click here to learn how to do this. 

     

    • The response will contain the StatusCode. (See details in the Response Parameters table above.)

       

     

     

    Complete Example

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

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

     

    Code Block
    languagejava
    themeEclipse
    <%   	
    /*    	ws_removeview.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.*" %>
     
    	AdministrationServiceResponse rs = null;
        AdministrationServiceRequest rsr = new AdministrationServiceRequest();
        AdministrationServiceService ts = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false);
        AdministrationServiceSoapBindingStub rssbs = (AdministrationServiceSoapBindingStub) ts.getAdministrationService();
    
        rsr.setLoginId("admin@yellowfin.com.au");
        rsr.setPassword("test");
        rsr.setOrgId(new Integer(1));
        rsr.setFunction("REMOVEVIEW");
        
    	//View IDs whose caches are to be removed
        rsr.setParameters(new String[] {
                "70103", "70104"
        });
        
        rs = rssbs.remoteAdministrationCall(rsr);
    
        if ("SUCCESS".equals(rs.getStatusCode())) {
            out.write("Success </br>");
        } else {
            out.write(rs.getStatusCode());
            out.write(rs.toString());
        }
    
    
    

     


     

    Anchor
    flushReport
    flushReport

    Expand
    titleFLUSHREPORT

    This web service will remove a report's cached definitions.

     

    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 "FLUSHREPORT".

    ParametersString[]

    ID of report to remove its cached definition or metadata. Only the first string will be read, so ensure that it is the report ID.

     

    Request Example

    Below is a SOAP XML example for this request:

    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:remoteAdministrationCall>
         	<arg0>
                <loginId>admin@yellowfin.com.au</loginId>
                <password>test</password>
            	<orgId>1</orgId>
            	<function>FLUSHREPORT</function>
            	<parameters>65254</parameters>
           	</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

     

    Response Example

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

    Code Block
    languagexml
    <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>5a29f6eaf3ee084b00c76da124f31fe0</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
    titleStep-by-step instructions
    • Define the request for this function, which includes logging in as the admin user and specifying the web service call to perform:

      Code Block
      languagejava
      themeConfluence
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(new Integer(1));
      
      rsr.setFunction("FLUSHREPORT");


    • Specify the report by its ID to remove its definition from the cache:

      Code Block
      languagejava
      rsr.setParameters(new String[] {
           "56401"
      });


    • Once the request is configured, perform the call:

      Code Block
      languagejava
      AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

      Initialize the Administration web service. Click here to learn how to do this. 

     

    • Add the following check to retrieve the response, containing the StatusCode.

      Code Block
      languagejava
       if ("SUCCESS".equals(rs.getStatusCode()) ) {
                    	out.write("<br>Success");
                    	
      }
      else {
                    	out.write("<br>Failure");
                    	out.write(" Code: " + rs.getErrorCode());
      } 

       

     

     

    Complete Example

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

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

     

    Code Block
    languagejava
    themeEclipse
    <%        	
    /*          	ws_FLUSHREPORT.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");                        // set to the password of the account above
    rsr.setOrgId(1);
    rsr.setFunction("FLUSHREPORT");
    rsr.setParameters(new String[] {"65254"});
     
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
     
    if ("SUCCESS".equals(rs.getStatusCode()) ) {
                  	out.write("<br>Success");
                  	
    }
    else {
                  	out.write("<br>Failure");
                  	out.write(" Code: " + rs.getErrorCode());
    }             	
    %>

     


     

    Anchor
    flushTab
    flushTab

    Expand
    titleFLUSHTAB

    This web service will remove a dashboard tab's cached definitions in Yellowfin.

     

    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 "FLUSHTAB".

    ParametersString[]

    ID of dashboard tab to remove its cached definition or metadata. Only the first string is read, which should contain this ID.

     

    Request Example

    Below is a SOAP XML example for this request:

    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:remoteAdministrationCall>
         	<arg0>
                <loginId>admin@yellowfin.com.au</loginId>
                <password>test</password>
            	<orgId>1</orgId>
            	<function>FLUSHTAB</function>
            	<parameters>65254</parameters>
           	</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


    Response Example

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

    Code Block
    languagexml
    <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>5a29f6eaf3ee084b00c76da124f31fe0</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
    titleStep-by-step instructions
    • Define the request for this function, which includes logging in as the admin user and specifying the web service call to perform:

      Code Block
      languagejava
      themeConfluence
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(new Integer(1));
      
      rsr.setFunction("FLUSHTAB");


    • Specify the ID of the dashboard tab to remove its cached definition:

      Code Block
      languagejava
      rsr.setParameters(new String[] {"65254"});


    • Once the request is configured, perform the call:

      Code Block
      languagejava
      AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

      Initialize the Administration web service. Click here to learn how to do this. 

     

    • Add the following code to retrieve the response, which is the StatusCode.

      Code Block
      languagejava
      if ("SUCCESS".equals(rs.getStatusCode()) ) {
                    	out.write("<br>Success");
                    	
      }
      else {
                    	out.write("<br>Failure");
                    	out.write(" Code: " + rs.getErrorCode());
      } 

       

     

     

    Complete Example

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

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

     

    Code Block
    languagejava
    themeEclipse
    <%        	
    /*          	ws_flushtab.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("FLUSHTAB");
    rsr.setParameters(new String[] {"65254"});
     
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
     
    if ("SUCCESS".equals(rs.getStatusCode()) ) {
                  	out.write("<br>Success");
                  	
    }
    else {
                  	out.write("<br>Failure");
                  	out.write(" Code: " + rs.getErrorCode());
    }             	
    %>

     


     

    Anchor
    flushperson
    flushperson

    Expand
    titleFLUSHPERSON

    This web service will remove a person's cached details.


    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 "FLUSHPERSON".

    ParametersString[]

    ID of person record to remove its cached definition or metadata. Only the first string is read, which should contain this ID.

     

    Request Example

    Below is a SOAP XML example for this request:

    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:remoteAdministrationCall>
         	<arg0>
            	<loginId>admin@yellowfin.com.au</loginId>
                <password>test</password>
            	<orgId>1</orgId>
            	<function>FLUSHPERSON</function>
            	<parameters>65254</parameters>
           	</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


    Response Example

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

    Code Block
    languagexml
    <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>5a29f6eaf3ee084b00c76da124f31fe0</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
    titleStep-by-step instructions
    • Define the request for this function, which includes logging in as the admin user and specifying the web service call to perform:

      Code Block
      languagejava
      themeConfluence
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(new Integer(1));
      
      rsr.setFunction("FLUSHTAB");


    • Specify the ID of the dashboard tab to remove its cached definition:

      Code Block
      languagejava
      rsr.setParameters(new String[] {"65254"});


    • Once the request is configured, perform the call:

      Code Block
      languagejava
      AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

      Initialize the Administration web service. Click here to learn how to do this. 

     

    • Add the following code to retrieve the response, which is the StatusCode.

      Code Block
      languagejava
      if ("SUCCESS".equals(rs.getStatusCode()) ) {
                    	out.write("<br>Success");
                    	
      }
      else {
                    	out.write("<br>Failure");
                    	out.write(" Code: " + rs.getErrorCode());
      } 

       

     

     

    Complete Example

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

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

     

    Code Block
    languagejava
    themeEclipse
    <%        	
    /*          	ws_flushperson.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");                        // set to the password of the account above
    rsr.setOrgId(1);
    rsr.setFunction("FLUSHPERSON");
    rsr.setParameters(new String[] {"65254"});
     
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
     
    if ("SUCCESS".equals(rs.getStatusCode()) ) {
                  	out.write("<br>Success");
                  	
    }
    else {
                  	out.write("<br>Failure");
                  	out.write(" Code: " + rs.getErrorCode());
    }             	
    %>  

     


     

    Anchor
    reloadLicence
    reloadLicence

    expand
    Expand
    titleRELOADLICENCE

    This web service will reload a licence in Yellowfin.

     

    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 "RELOADLICENCE".

     

     

    Request Example

    The following SOAP XML example shows how perform this request with the mandatory parameters:

    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:remoteAdministrationCall>
             <arg0>
              <loginId>admin@yellowfin.com.au</loginId>
                <password>test</password>
                <orgId>1</orgId>
                <function>RELOADLICENCE</function>     
             </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

     

     

    Response Example

    The following SOAP XML response will be returned based on our example:

    Code Block
    languagexml
     <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>
                	AdministrationReport[] reports = rs.getReports();<messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
                <messages>Web Service Request Complete</messages>
                <sessionId>c4d0b6dec61e890a417132f05c3f0fbc</sessionId>
         	if (reports != null)
            <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
    titleStep-by-step instructions
    • Define the request for this function, which includes logging in as the admin user and specifying the web service call to perform:

      Code Block
      languagejava
      themeConfluence
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(new Integer(1));
      
      rsr.setFunction("RELOADLICENCE");


    • Once the request is configured, perform the call:

      Code Block
      languagejava
      AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

      Initialize the Administration web service. Click here to learn how to do this. 

     

    • The response will contain the StatusCode. (See details in the Response Parameters table above.)

       

     

     

    Complete Example

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

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

     

    Code Block
    languagejava
    themeEclipse
    <%   	
    /*    		ws_reloadlicence.jsp                                                   	for(AdministrationReport r: reports){
                                                                                          	out.write("<br>Report Name: " + r.getReportName())	*/
    %>
    <%@ 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.*" %>
     
    	AdministrationServiceResponse rs = null;
        AdministrationServiceRequest rsr = new AdministrationServiceRequest();
        AdministrationServiceService ts = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false);
        AdministrationServiceSoapBindingStub rssbs = (AdministrationServiceSoapBindingStub) ts.getAdministrationService();
    
        rsr.setLoginId("admin@yellowfin.com.au");
        rsr.setPassword("test");
        rsr.setOrgId(new Integer(1));
        rsr.setFunction("RELOADLICENCE");
        
        rs = rssbs.remoteAdministrationCall(rsr);
    
        if ("SUCCESS".equals(rs.getStatusCode())) {
            out.write("Success </br>");
           	}
    } else {
                  	out.write("Failure"(rs.getStatusCode());
                  	out.write(" Code: " + rs.getErrorCodetoString());
        }
    %>
    
    
    

     


     

    Anchor

    ...

    closeConnectionPool
    closeConnectionPool

    Expand
    titleCLOSECONNECTIONPOOL

    This web service will close the connection pool of a specified data source

    ISREPORTFAVOURITE

    This web service checks whether or not a particular report is marked as a specific user's favourite. Both the user and the report would need to be specified here, the latter by providing the Report ID. This ID can be retrieved from Yellowfin database's Report Header table. You can even use the GETIDFORUUID web service call to retrieve the Report ID.

     

    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 "ISREPORTFAVOURITECLOSECONNECTIONPOOL".

    PersonAdministrationPersonThis object contains details of the user. See table below.
    ReportIdIntegerThe report ID to check whether the report is the user's favourite.
    Anchor
    isrepfaveap
    ParametersString[]
    isrepfaveap

    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

    ID of the user whose inbox reports data source whose connection pools are to be fetched. This value could be the user ID or user's email address, depending on the Logon ID methodclosed.

     

     

    Request Example

    Below is a The following SOAP XML example for shows how perform this request with the mandatory parameters:

    Code Block
    languagexml
    themeConfluence
     <soapenv<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>ISREPORTFAVOURITE<	<function>CLOSECONNECTIONPOOL</function>
                <reportId>61131</reportId>
                <person>
     	<parameters>74909</parameters>
               	<userId>admin@yellowfin.com.au</userId>
                </person>
             </arg0>
          	</web:remoteAdministrationCall>
       </soapenv:Body>
    </soapenv:Envelope>

     

     

    Response Parameters

    The returned response will contain the following parameterthese parameters:

    Response Element

    Data Type

    Description

    StatusCode

    String

    Status of the web service call. Possible values include:

    • SUCCESS - If the specified report is the user's favourite.
    • FAILURE - If the report is not a favourite report of the user.
     

     

    Response Example

    The service will return the below response, according to our SOAP following SOAP XML response will be returned based on our example:

    Code Block
    languagexmlthemeConfluence
    <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>fa69d19c0f6a6ffa9b3d1a19ec92abd9<<sessionId>5a29f6eaf3ee084b00c76da124f31fe0</sessionId>
                <statusCode>FAILURE<<statusCode>SUCCESS</statusCode>
             	</return>
          </ns2:remoteAdministrationCallResponse>
       </S:Body>
    </S:Envelope> Envelope>

     

     

    Instructions

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

    Expand
    titleStep-by-step instructions
    • Start with a basic Define the request for this function, which includes logging in as the admin user and specifying the web service call to perform:

      Code Block
      languagejava
      themeConfluence
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();
      
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(1);
      
      rsr.setFunction("ISREPORTFAVOURITE");new Integer(1));
      
      rsr.setFunction("CLOSECONNECTIONPOOL");


    • Specify the ID of the data source to close its connection pools:

      Code Block
      languagejava
      rsr.setParameters(new String[] {"74909"});


    • Once the request is configured, perform the call:

      Code Block
      languagejava
      AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

      Initialize the Administration web service. Click here to learn how to do this. 

     

    • Add the following code to retrieve the response, containing the StatusCode.You can identify the user for whom to check the report's favourite status:

      Code Block
      languagejava
      AdministrationPerson ap = new AdministrationPerson();
      ap.setUserId("test.user@yellowfin.com.au");
      rsr.setPerson(ap);

      Specify which report to check the favourite status for:

      Code Block
      languagejava
      rsr.setReportId(61131);
    • Once the request is configured, perform the call:

      Code Block
      languagejava
      AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
      

      Initialize the Administration web service. Click here to learn how to do this. 

     

    • The response will contain the StatusCode. See the Response Parameter table above for details on this.
      if ("SUCCESS".equals(rs.getStatusCode()) ) {
                    	out.write("<br>Success");
                    	
      }
      else {
                    	out.write("<br>Failure");
                    	out.write(" Code: " + rs.getErrorCode());
      }  

       

     

     

    Complete Example

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

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

     

    Code Block
    languagejava
    themeEclipse
    <%        	
    /*          	ws_isreportfavouritecloseconnectionpool.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("ISREPORTFAVOURITE");
     
    AdministrationPerson ap = new AdministrationPerson();
    ap.setUserId("test.user@yellowfin.com.au");
     
    rsr.setPerson(apCLOSECONNECTIONPOOL");
     
    rsr.setReportId(61131setParameters(new String[] {"74909"});
     
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
     
    if ("SUCCESS".equals(rs.getStatusCode()) ) {
                  	out.write("<br>Success");
                  	
    }
    else {
                  	out.write("<br>Failure");
       	
    } else {
               	out.write(" Code: " + rs.getErrorCode());
    }              	out.write("Failure");
                  	out.write(" Code: " + rs.getErrorCode());
    }
    %>
    
    

     

     

    Expand
    titleADDTOFAVOURITES
    	
    %>

     


     

    Anchor
    flushtextentity
    flushtextentity

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

    Expand
    titleFLUSHTEXTENTITY

    This web service removes a cached text entity.

     

    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 "FLUSHTEXTENTITY".

    ParametersString[]

    ID of the text entity that is to be flushed from a cache. (Only the first parameter is read, so ensure it is the text ID.)

     

     

    Request Example

    The following SOAP XML example shows how perform this request with the mandatory parameters:

    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:remoteAdministrationCall>
         	<arg0>
                <loginId>admin@yellowfin.com.au</loginId>
                <password>test</password>
            	<orgId>1</orgId>
            	<function>FLUSHTEXTENTITY</function>
            	<parameters>65254</parameters>
           	</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


    Response Example

    The following SOAP XML response will be returned based on our example:

    Code Block
    languagexml
    <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>5a29f6eaf3ee084b00c76da124f31fe0</sessionId>
                <statusCode>SUCCESS</statusCode>
         	</return>
          </ns2:remoteAdministrationCallResponse>
       </S:Body>
    </S:Envelope>

    Also, ADDTOFAVORITES. This web service call marks a particular report as the specified user's favourite. Both the user and the report would need to be specified here, the latter by providing the report ID. Use the GETIDFORUUID web service call to retrieve the report ID, or fetch it from the database (this value is stored in the Report Header table).

     

    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 "ADDTOFAVOURITES" or "ADDTOFAVORITES".

    PersonAdministrationPersonThis object contains details of the user. See table below.
    ReportIdIntegerThe ID of the report that is to be added as a favourite of the user's.
    Anchor
    addtofavapaddtofavap
    AdministrationPerson Element

    Data Type

    Description

    UserId

    String

    ID of the user to add the report as their favourite. This value could be the user ID or user's email address, depending on the Logon ID method.

     

     

    Request Example

    Below is a SOAP XML example for this request:

    Code Block
    languagexml
    themeConfluence
     

     

     

    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 - if the report is added as the user's favourite.
    • FAILURE - if the report is not added as the user's favourite.

     

     

    Response Example

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

    Code Block
    languagexml
    themeConfluence
     

     

     

    Instructions

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

    Expand
    titleStep-by-step instructions
    • Start with a basic Define the request for this function, which includes logging in as the admin user and specifying the web service call to perform:

      Code Block
      languagejava
      themeConfluence
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();
      
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(new Integer(1));
      
      rsr.setFunction("ADDTOFAVOURITESFLUSHTEXTENTITY");


    • You can identify the user for whom to check the report's favourite statusSpecify ID of the text to flush it from the cache:

      Code Block
      languagejava
      AdministrationPerson ap = new AdministrationPerson();
      ap.setUserId("test.user@yellowfin.com.au");
      rsr.setPerson(ap);

      Specify which report to check the favourite status for:

      Code Block
      languagejava
      rsr.setReportId(61131rsr.setParameters(new String[] {
           "12323"
      });


    • Once the request is configured, perform the call:

      Code Block
      languagejava
      AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
      

      Initialize the Administration web service. Click here to learn how to do this. 

     

    • The response will contain the StatusCode. (See details in the Response Parameter Parameters 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:

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

     

    Code Block
    languagejava
    themeEclipse
    <%        	
    /*          	ws_addtofavouritesflushtextentity.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("ADDTOFAVORITESFLUSHTEXTENTITY");
     
    AdministrationPerson ap = new AdministrationPerson();
    ap.setUserId("test.user@yellowfin.com.au"rsr.setParameters(new String[] {"65254"});
     
    rsr.setPerson(ap);
     
    rsr.setReportId(56361);
     
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
     
    if ("SUCCESS".equals(rs.getStatusCode()) ) {
                  	out.write("<br>Success");
                                    	
    } 
    else {
                  	out.write("Failure<br>Failure");
                  	out.write(" Code: " + rs.getErrorCode());
    }             	
    %>
    
    

     


     

    Anchor
    flushCachedFilterCache

    ...

    flushCachedFilterCache

    Expand
    titleREMOVEFAVOURITEFLUSHCACHEDFILTERCACHE

    Also, REMOVEFAVORITE. This web service call removes a particular report from the specified user's favourite list. Both the user and the report would need to be specified here, the latter by providing the report ID. Use the GETIDFORUUID web service call to retrieve the report ID, or fetch it from the database (this value is stored in the Report Header table).removes cached filter definitions.

     

    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 "REMOVEFAVOURITE" or "REMOVEFAVORITE".

    PersonAdministrationPersonThis object contains details of the user. See table below.
    ReportIdIntegerThe ID of the report that is to be removed from the user's favourite list.
    Anchor
    removefavap

    this to 1.

    Function

    String

    Web service function. Set this to "FLUSHCACHEDFILTERCACHE".

    ParametersString[]

    ID of the filter that is to be flushed from the cache. (Only the first parameter is read, so ensure it is the filter ID.)

     

     

    Request Example

    The following SOAP XML example shows how perform this request with the mandatory parameters:

    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:remoteAdministrationCall>
         	<arg0>
                <loginId>admin@yellowfin.com.au</loginId>
                <password>test</password>
            	<orgId>1</orgId>
            	<function>FLUSHCACHEDFILTERCACHE</function>
            	<parameters>74909</parameters>
           	</arg0>
      	</web:remoteAdministrationCall>
       </soapenv:Body>
    </soapenv:Envelope>


    removefavap

    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

    ID of the user to remove the report from their favourite list. This value could be the user ID or user's email address, depending on the Logon ID method.

     

     

    Request Example

    Below is a SOAP XML example for this request:

    Code Block
    languagexml
    themeConfluence
     

     

     

    Response Parameters

    The returned response will contain the following parameterthese parameters:

    Response Element

    Data Type

    Description

    StatusCode

    String

    Status of the web service call. Possible values include:

    • SUCCESS - If the report is removed from the user's favourite list.
    • FAILURE - If the report is not removed from the user's favourite list.

     

     

    Response Example

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

    Code Block
    languagexml
    themeConfluence
     

     

     

    Instructions

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

    Expand
    titleStep-by-step instructions

    Status of the web service call. Possible values include:

    • SUCCESS
    • FAILURE


    Response Example

    The following SOAP XML response will be returned based on our example

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

    :

  • You can identify the user for whom to check the report's favourite status:

  • Code Block
    language
    java
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
    
    rsr.setLoginId("admin@yellowfin.com.au");
    rsr.setPassword("test");
    rsr.setOrgId(1);
    
    rsr.setFunction("REMOVEFAVOURITE");
    Code Block
    languagejava
    AdministrationPerson ap = new AdministrationPerson();
    ap.setUserId("test.user@yellowfin.com.au");
    rsr.setPerson(ap);

    Specify which report to check the favourite status for:

    Code Block
    languagejava
    rsr.setReportId(61131);
    • Once the request is configured, perform the call:

      Code Block
      languagejava
      AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
      

      Initialize the Administration web service. Click here to learn how to do this. 

     

    • The response will contain the StatusCode. 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:

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

     

    xml
    <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>5a29f6eaf3ee084b00c76da124f31fe0</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:

    Eclipse
    Expand
    titleStep-by-step instructions
    • Define the request for this function, which includes logging in as the admin user and specifying the web service call to perform:

      Code Block
      languagejava
      theme
    • Confluence
    /*
    • AdministrationServiceRequest rsr = new AdministrationServiceRequest();
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(new Integer(1));
      
      rsr.setFunction("FLUSHCACHEDFILTERCACHE");


    • Specify ID of the filter to flush it from the cache:

      Code Block
      languagejava
      rsr.setParameters(new String[] {
           "12323"
      });


    • Once the request is configured, perform the call:

      Code Block
      languagejava
      AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

      Initialize the Administration web service. Click here to learn how to do this. 

     

    • The response will contain the StatusCode. (See details in the Response Parameters table above.)

       

     

     

    Complete Example

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

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

     

    Code Block
    languagejava
    themeEclipse
    <%   	
    /*    		ws_flushcachedfilter.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.*" %>
     
    	AdministrationServiceResponse rs = null;
        AdministrationServiceRequest rsr = new AdministrationServiceRequest();
        AdministrationServiceService ts = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false);
        AdministrationServiceSoapBindingStub rssbs = (AdministrationServiceSoapBindingStub) ts.getAdministrationService();
    
        rsr.setLoginId("admin@yellowfin.com.au");
        rsr.setPassword("test");
        rsr.setOrgId(new Integer(1));
        rsr.setFunction("FLUSHCACHEDFILTERCACHE");
        
    	//Specify filter ID to flush its cache
        rsr.setParameters(new String[] {
          	ws_removefavourite.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("REMOVEFAVOURITE");
     
    AdministrationPerson ap = new AdministrationPerson();
    ap.setUserId("test.user@yellowfin.com.au");
     
    rsr.setPerson(ap);
     
    rsr.setReportId(56361);
     
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
     
    if ("SUCCESS".equals(rs.getStatusCode()) ) {
                  	out.write("<br>Success");
                      "12323"
        });
        
        rs  	
    } else {= rssbs.remoteAdministrationCall(rsr);
    
        if ("SUCCESS".equals(rs.getStatusCode())) {
            	out.write("FailureSuccess </br>");
        } else {
            	out.write(" Code: " + rs.getErrorCode(rs.getStatusCode());
            out.write(rs.toString());
        }
    %>
    
    
    

     


     

    expand

    Anchor
    removedocument

    ...

    removedocument

    Expand
    titleREMOVEDOCUMENT

    This web service removes a specified document from the cache

    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".

    FavouritePersonFavouriteThis 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.
    RetrospectiveDaysIntegerThis is an optional parameter.
    Anchor
    listfavperson

    REMOVEDOCUMENT".

    ParametersString[]

    ID of the document that is to be flushed from the cache. (Only the first parameter is read, so ensure it is the document ID.)

    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

    ID of the user to remove the report from their favourite list. This value could be the user ID or user's email address, depending on the Logon ID method.

    ContentTypeString

    This optional parameter can be set to filter the result by a specific content type. Values could include:

    • REPORT
    • REPORTGROUP
    • DISCUSSIONGROUP
    • REPORTVIEW
    • STORYBOARD
    • IMAGE
    ContentIdIntegerThis optional parameter can be used to restrict the result to a specific content by providing its internal ID.

     

     

    Request Example

    Below is a The following SOAP XML example for shows how perform this request with the mandatory parameters:

    Code Block
    languagexml
    themeConfluence
     <soapenv<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>REMOVEDOCUMENT</function>
                <favourite>
                	<personId>5</personId>
                </favourite>     
      <parameters>74909</parameters>
           	</arg0>
          	</web:remoteAdministrationCall>
       </soapenv:Body>
    </soapenv:Envelope>

     

     


    Response Parameters

    The returned response will contain the following parameterthese parameters:

    PersonFavourite[]

    Response Element

    Data Type

    Description

    StatusCode

    String

    Status of the web service call. Possible values include:

    • SUCCESS
    • FAILURE

    Personfavourites

    An array containing the user's favourite objects.

     

     


    Response Example

    The service will return the below response, according to our SOAP following SOAP XML response will be returned based on our example:

    Code Block
    languagexml
    themeConfluence
     <S<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
       <S:Body>
          <ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">.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>
             <return>   <sessionId>fe029927cc6aae20446f1a8caf25e83a</sessionId>
                <errorCode>0<<statusCode>SUCCESS</errorCode>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
    titleStep-by-step instructions
    • Define the request for this function, which includes logging in as the admin user and specifying the web service call to perform:

      Code Block
      languagejava
      themeConfluence
      AdministrationServiceRequest rsr 
    <messages>Successfully
    • = 
    Authenticated User:
    • new AdministrationServiceRequest();
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(new Integer(1));
      
      rsr.setFunction("REMOVEDOCUMENT");


    • Specify ID of the document to remove it from the cache:

      Code Block
      languagejava
      rsr.setParameters(new String[] {
           "12323"
      });


    • Once the request is configured, perform the call:

      Code Block
      languagejava
      AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

      Initialize the Administration web service. Click here to learn how to do this. 

     

    • The response will contain the StatusCode. (See details in the Response Parameters table above.)

       

     

     

    Complete Example

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

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

     

    Code Block
    languagejava
    themeEclipse
    <%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>
    	
    /*          	ws_removedocument.jsp     <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>	*/
    %>
     
    <%@ 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.*" %>
    <% 
    	AdministrationServiceResponse rs = null;
    	AdministrationServiceRequest rsr = new AdministrationServiceRequest();
    	AdministrationServiceService ts = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false);
    	AdministrationServiceSoapBindingStub rssbs = (AdministrationServiceSoapBindingStub) ts.getAdministrationService();
     
        rsr.setLoginId("admin@yellowfin.com.au");
    	rsr.setPassword("test");
    	rsr.setOrgId(new Integer(1));
    	rsr.setFunction("REMOVEDOCUMENT");
     	
    	rsr.setParameters(new String[] {
          </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
    titleStep-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:
    	"70103" });
     	
    	rs = rssbs.remoteAdministrationCall(rsr);
     
    	if ("SUCCESS".equals(rs.getStatusCode())) {
        	out.write("Success </br>");
    	} else {
        	out.write(rs.getStatusCode());
        	out.write(rs.toString());
    	}
    %>

     


     

    Anchor
    refreshacll
    refreshacll

    Expand
    titleREFRESHACLL

    This web service refreshes the access levels for a specific content. The content is specified by providing its ID via a parameter element. This could be a Report ID, Dashboard Tab ID, or ETL Process (data transformation flow) UUID.


    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 "REFRESHACLL".

    ParametersString[]

    ID of the content whose access levels are to be reset. (Only the first parameter is read, so ensure it is the content ID.)

    • Report ID
    • Dashboard Tab ID
    • ETL Process(data transformation flow) UUID

     

     

    Request Example

    The following SOAP XML example shows how perform this request with the mandatory parameters:

    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:remoteAdministrationCall>
         	<arg0>
            	<loginId>admin@yellowfin.com.au</loginId>
                <password>test</password>
            	<orgId>1</orgId>
            	<function>REFRESHACLL</function>
                <parameters>74909</parameters>
           	</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


    Response Example

    The following SOAP XML response will be returned based on our example:

    Code Block
    languagexml
    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
       <S:Body>
      	<ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
         	<return>
    
    Code Block
    languagejava
    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
    languagejava
    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
    languagejava
    pf.setContentType("REPORT");    	
    pf.setFavouriteType("FAVOURITE");

    To retrieve all of the user's dashboard:

    Code Block
    languagejava
    pf.setContentType("REPORTGROUP");
    pf.setFavouriteType("REPORTDASHBOARD");

    To retrieve reports and dashboards distributed to the user:

    Code Block
    languagejava
    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
    languagejava
    pf.setContentType("DISCUSSIONGROUP");
    pf.setFavouriteType("DISCUSSIONMEMBER");

    To retrieve user's favourite views:

    Code Block
    languagejava
    pf.setContentType("REPORTVIEW");

    To retrieve user's favourite storyboards:

    Code Block
    languagejava
    pf.setContentType("STORYBOARD");
    pf.setFavouriteType("FAVOURITE");

    To get user's profile image:

    Code Block
    languagejava
    pf.setContentType("IMAGE");
    pf.setFavouriteType("PROFILE");

    To retrieve report comments flagged by the user:

    Code Block
    languagejava
    pf.setContentType("COMMENT");
    pf.setFavouriteType("FLAGGED");

    Add this object to the request:

    Code Block
    languagejava
    rsr.setFavourite(pf);
    • Once the request is configured, perform the call:

      Code Block
      languagejava
      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:

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

     

    Code Block
    languagejava
    themeEclipse
    <%        	
    /*          	ws_listpersonfavourites.jsp  <errorCode>0</errorCode>
            	<messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
            	<messages>Web Service Request Complete</messages>
             	*/
    %>
    <%@ 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); <sessionId>fe029927cc6aae20446f1a8caf25e83a</sessionId>
                <statusCode>SUCCESS</statusCode>
         	<//return>
     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()) ) {
     	</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
    titleStep-by-step instructions
    • Define the request for this function, which includes logging in as the admin user and specifying the web service call to perform:

      Code Block
      languagejava
      themeConfluence
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(new Integer(1));
      
      rsr.setFunction("REFRESHACLL");


    • Specify ID of the content to reset its access level:

      Code Block
      languagejava
      rsr.setParameters(new String[] {
           "12323"
      });


    • Once the request is configured, perform the call:

      Code Block
      languagejava
      AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

      Initialize the Administration web service. Click here to learn how to do this. 

     

    • The response will contain the StatusCode. (See details in the Response Parameters table above.)

       

     

     

    Complete Example

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

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

     

    Code Block
    languagejava
    themeEclipse
    <%        	
    /*           out.write("<br>Success");
    	ws_refreshacll.jsp           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()	*/
    %>
     
    <%@ 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.*" %>
    <% 
    	AdministrationServiceResponse rs = null;
    	AdministrationServiceRequest rsr = new AdministrationServiceRequest();
    	AdministrationServiceService ts = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false);
    	AdministrationServiceSoapBindingStub rssbs = (AdministrationServiceSoapBindingStub) ts.getAdministrationService();
     
        rsr.setLoginId("admin@yellowfin.com.au");
    	rsr.setPassword("test");
               		out.write("<br>CreatorId: " + f.getCreatorId());
        rsr.setOrgId(new Integer(1));
    	rsr.setFunction("REFRESHACLL");
     	
    	rsr.setParameters(new String[] {
            	out.write("<br>FavouriteType: " + f.getFavouriteType());
        "70103" });
     	
    	rs = rssbs.remoteAdministrationCall(rsr);
     
    	if ("SUCCESS".equals(rs.getStatusCode())) {
        		out.write("<br>Message:Success </br>" + f.getMessage);
    	} else {
        	out.write(rs.getStatusCode());
         	    	out.write("<br>PersonId: " + f.getPersonId());
                	out.write("<br>textEntityId: " + f.getTextEntityId());
               }
    } else {
                out.write("Failure");
                out.write(" Code: " + rs.getErrorCode());
    }
    %>
    
    
    

     

     

    rs.toString());
    	}
    %>

     


     

    Anchor
    deleteview
    deleteview

    Expand
    titleDELETEVIEW

    This web service is used to delete a view in Yellowfin. You can specify the view by providing either its ID or UUID.

     

    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 "DELETEVIEW".

    ParametersString[]

    The ID or UUID of the view that is to be deleted.

     

     

    Response Parameters

    The returned response will contain these parameters:

    Response

    Expand
    titleSAVEPERSONFAVOURITE

    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

    LoginIdStatusCode

    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".

    FavouritePersonFavouriteThis 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

    Status of the web service call. Possible values include:

    • SUCCESS
    • FAILURE

     

    Instructions

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

    Expand
    titleStep-by-step instructions
    • Define the request for this function, which includes logging in as the admin user and specifying the web service call to perform:

      Code Block
      languagejava
      themeConfluence
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(new Integer(1));
      
      rsr.setFunction("DELETEVIEW");


    • Specify the view to be deleted by providing its ID or UUID:

       

      Code Block
      languagejava
      rsr.setParameters(new String[] {
           "70103"
      });

       

       

    • Once the request is configured, perform the call:

      Code Block
      languagejava
      AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

      Initialize the Administration web service. Click here to learn how to do this. 

     

    • The response will contain the StatusCode. (See details in the Response Parameters table above.)

       

     

     

    Complete Example

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

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

     

    Code Block
    languagejava
    themeEclipse
    <%   	
    /*    		ws_deleteview.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.*" %>
     
    	AdministrationServiceResponse rs = null;
        AdministrationServiceRequest rsr = new AdministrationServiceRequest();
        AdministrationServiceService ts = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false);
        AdministrationServiceSoapBindingStub rssbs = (AdministrationServiceSoapBindingStub) ts.getAdministrationService();
    
        rsr.setLoginId("admin@yellowfin.com.au");
        rsr.setPassword("test");
        rsr.setOrgId(new Integer(1));
        rsr.setFunction("DELETEVIEW");
        
    	//Specify the view to be deleted by providing its ID or UUID
        rsr.setParameters(new String[] {
    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). The items selected will be added as this user's favourite.

    ContentTypeString

    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
    ContentIdIntegerThis mandatory parameter is used to define the item that is to be marked as the user's favourite by providing its internal ID.
    FavouriteTypeString 
    CreationCodeString 
    TextEntityIdInteger

    This parameter is required if a comment is to be flagged.

     

     

    Request Example

    Below is a SOAP XML example for this request:

    Code Block
    languagexml
    themeConfluence
    <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>"70103"
        });
            	<personId>13000</personId>
        rs = rssbs.remoteAdministrationCall(rsr);
    
        if  	<contentType>REPORTGROUP</contentType>("SUCCESS".equals(rs.getStatusCode())) {
                	<contentId>61209</contentId>out.write("Success </br>");
        } else {
          </favourite>       out.write(rs.getStatusCode());
             </arg0>out.write(rs.toString());
          </web:remoteAdministrationCall>
       </soapenv:Body>
    </soapenv:Envelope>}
    
    
    

     


     

    Anchor
    deletesource
    deletesource

    Expand
    titleDELETESOURCE

    This web service is used to delete a specified data source Yellowfin. You can identify the data source by providing its ID.

     

    Request

    Response

    Parameters

    The returned response will contain the following parameter:following parameters should be passed with this request:

    Request Response Element

    Data Type

    Description

    StatusCodeLoginId

    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
    languagexml
    themeConfluence
    <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>
     

    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 "DELETESOURCE".

    ParametersString[]

    The ID of the data source to be deleted.

     

     

    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

     

    Instructions

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

    Expand
    titleStep-by-step instructions
    • Start with a basic Define the request for this function, which includes logging in as the admin user and specifying the web service call to perform:

      Code Block
      languagejava
      themeConfluence
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();
      
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(new Integer(1));
      
      rsr.setFunction("SAVEPERSONFAVOURITEDELETESOURCE");
    • Identify a user throught the PersonFavourite object:

      Code Block
      languagejava
      PersonFavourite pf = new PersonFavourite();
      pf.setPersonId(13073);

    • Specify the contents that are to be marked as favourite in this objectSpecify the view to be deleted by providing its ID or UUID:

      Code Block
      languagejava
      pfrsr.setContentId(61252);
      pf.setContentType("REPORTVIEW");

      Add this object to the request:

      Code Block
      languagejava
      rsr.setFavourite(pf);
      setParameters(new String[] {
           "40563"
      });


    • Once the request is configured, perform the call:

      Code Block
      languagejava
      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 details in the Response Parameter Parameters 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:

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

     

    Code Block
    languagejava
    themeEclipse
    <%        	
    /*          		ws_savepersonfavouritedeletesource.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	AdministrationServiceResponse rs = new AdministrationServiceServiceLocator("localhost",8080, "/services/AdministrationService", false);    	// adjust host and port number
    AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();
    null;
        AdministrationServiceRequest rsr = new AdministrationServiceRequest();
     
    rsr.setLoginId("admin@yellowfin.com.au");    AdministrationServiceService ts 			// 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= new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false);
        AdministrationServiceSoapBindingStub rssbs = (AdministrationServiceSoapBindingStub) ts.getAdministrationService();
    
        rsr.setLoginId("admin@yellowfin.com.au");
        rsr.setPassword("test");
        rsr.setOrgId(new Integer(1));
        rsr.setFunction("DELETESOURCE");
        
    	//Specify the data source to be deleted by providing its 	
    } elseID
        rsr.setParameters(new String[] {
                  	out.write("Failure");"40567"
        });
        
        rs = 	outrssbs.write(" Code: " + rs.getErrorCode());
    }
    %>
    
    

     

     

    remoteAdministrationCall(rsr);
    
        if ("SUCCESS".equals(rs.getStatusCode())) {
            out.write("Success </br>");
        } else {
            out.write(rs.getStatusCode());
            out.write(rs.toString());
        }
    
    
    

     


     

    Anchor
    removecontentmanagement
    removecontentmanagement

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

    Expand
    titleREMOVECONTENTMANAGEMENT

    This function is used for cluster messaging. It removes content management records from remote caches when such a record is altered or deleted locally.

     

    Request Parameters

    The following parameters should be passed with this request:

    Request

    Expand
    titleREMOVEPERSONFAVOURITE

    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".

    FavouritePersonFavouriteThis 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
    listfavpersonlistfavperson
    PersonId
    PersonFavourite

    Element

    Data Type

    Description

    LoginId

    Integer

    A mandatory parameter to identify the user with their internal ID (that is, the IP ID). The items selected will be removed as this user's favourite.

    ContentTypeString

    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
    ContentIdIntegerThis mandatory parameter is used to define the item that is to be marked as the user's favourite by providing its internal ID.
    FavouriteTypeStringThis is required to remove reports or dashboards as the user's favourite.
    CreationCodeString 
    TextEntityIdInteger

    This parameter is required if a comment is to be unflagged.

     

     

    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 "REMOVECONTENTMANAGEMENT".

    parameters

    String[]

    This is used to pass the content management ID as the first string. (Only the first string will be read.)

      

    Request Example

    Below is a SOAP XML example for this request:

    Code Block
    languagexml
    themeConfluence
    <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>REMOVECONTENTMANAGEMENT</function>
                <favourite>
                	<personId>13000</personId>
                	<contentType>REPORTGROUP</contentType>
       <parameters>73118</parameters>
             	<contentId>61209</contentId>
                </favourite>     
             </arg0>
          	</web:remoteAdministrationCall>
       </soapenv:Body>
    </soapenv:Envelope>

     

     


    Response Parameters

    The returned response will contain the following parameterthese parameters:

    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
    theme
    languagexmlConfluence
    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
       <S:Body>
          	<ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
             <return>
        	<return>
    	        <errorCode>0</errorCode>
                	<messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
                	<messages>Web Service Request Complete</messages>
                <sessionId>0cc3673ed857e1e28fb0e326b8f3b24e<<sessionId>5a29f6eaf3ee084b00c76da124f31fe0</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
    titleStep-by-step instructions
    • Start with a basic Define the request for this function, which includes logging in as the admin user and specifying the web service call to perform:

      Code Block
      languagejava
      themeConfluence
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();
      
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(new Integer(1));
      
      rsr.setFunction("REMOVECONTENTMANAGEMENT");


    • Next, set the content management ID that is to be removed from the cache in the Parameters element:

      Code Block
      languagejava
      rsr.setParameters("REMOVEPERSONFAVOURITE"new String[] {"73118"});



    • Identify a user throught the PersonFavourite objectOnce the request is configured, perform the call:

      Code Block
      languagejava
      PersonFavouriteAdministrationServiceResponse pfrs = new PersonFavourite();
      pf.setPersonId(13073adminService.remoteAdministrationCall(rsr);

      Initialize the Administration web service. Click here to learn how to do this. 

     

    • Add a check that returns the response containing the StatusCode. (See details in the Response Parameters table above.)Specify the objects that are to be removed as favourites in this object:

      Code Block
      languagejava
      pf.setContentId(61252);
      pf.setContentType("REPORTVIEW");

      Add this object to the request:

      Code Block
      languagejava
      rsr.setFavourite(pf);
    • Once the request is configured, perform the call:

      Code Block
      languagejava
      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.

       

     

     

    • if ("SUCCESS".equals(rs.getStatusCode()) ) {
                    	out.write("<br>Success");
                    	
      }
      else {
                    	out.write("<br>Failure");
                    	out.write(" Code: " + rs.getErrorCode());
      }

       

     

     

    Complete Example

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

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

     

    Code Block
    languagejava
    themeEclipse
    <%        	
    /*          	ws_removepersonfavouriteremovecontentmanagement.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("REMOVEPERSONFAVOURITEREMOVECONTENTMANAGEMENT");
     
    PersonFavourite pf = new PersonFavourite();
    pf.setPersonId(13073);
    pf.setContentId(70270);
    pf.setContentType("REPORTVIEW"rsr.setParameters(new String[] {"73118"});
     
    rsr.setFavourite(pf);
     
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
     
    if ("SUCCESS".equals(rs.getStatusCode()) ) {
                  	out.write("<br>Success");
                  	
    } 
    else {
                  	out.write("Failure<br>Failure");
                  	out.write(" Code: " + rs.getErrorCode());
    }             	
    %>