Page History

• 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 theme Confluence
  rsr.setLoginId("admin@yellowfin.com.au"); rsr.setPassword("test"); rsr.setOrgId(1); rsr.setFunction("GETIMPORTCONTENT");

  
  

• Specify the file containing data that is to be imported:

  Code Block
  language java
  Path path = Paths.get("/Applications/Yellowfin 7.4/qwerty.yfx"); byte[] data = Files.readAllBytes(path); byte[] encodeBase64 = java.util.Base64.getEncoder().encode(data); String f = new String(encodeBase64, "UTF-8");

  
  

• Provide the extension of this file, i.e. either YFX or XML:

  Code Block
  language java
  rsr.setParameters(new String[]{f,"YFX"});

  
  

• Once the request is configured, perform the call:
  
  

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

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

• The response will contain the following elements: StatusCode and ContentResource. (See details in the Response Parameters table above.)

   

<%   	
/*    	ws_getimportcontent.jsp                    	*/
%>
<%@ page language="java" contentType="text/html; charset=UTF-8" %>
<%@ page import="com.hof.util.*, java.util.*, java.text.*" %>
<%@ page import="com.hof.web.form.*" %>
<%@ page import="com.hof.mi.web.service.*" %>
<%@ page import="java.nio.file.Files" %>
<%@ page import="java.nio.file.Paths" %>
<%@ page import="java.nio.file.Path" %>
 
<%
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("GETIMPORTCONTENT");
 
Path path = Paths.get("/Applications/Yellowfin 7.4/qwerty.yfx"); 		// existing file
 
byte[] data = Files.readAllBytes(path);
byte[] encodeBase64 = java.util.Base64.getEncoder().encode(data);
String f = new String(encodeBase64, "UTF-8");
 
rsr.setParameters(new String[]{f,"YFX"});
 
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
 
if ("SUCCESS".equals(rs.getStatusCode()) ) {
        	ContentResource[] cr = rs.getContentResources();
        	out.write("<br>Success");
        	for (ContentResource o : cr){
                    	out.write("<br><br>resourceType: " + o.getResourceType());
                    	out.write("<br>resourceCode: " + o.getResourceCode());
                    	out.write("<br>resourceName: " + o.getResourceName());
                    	out.write("<br>resourceDescription: " + o.getResourceDescription());
                    	out.write("<br>resourceOrgId: " + o.getResourceOrgId());
                    	out.write("<br>resourceId: " + o.getResourceId());
                    	out.write("<br>resourceUUID: " + o.getResourceUUID());
        	}
} else {
        	out.write("Failure");
        	out.write(" Code: " + rs.getErrorCode());
}
%>

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:remoteAdministrationCall>
         <!--Optional:-->
         <arg0>
            <loginId>admin@yellowfin.com.au</loginId>
        	<password>test</password>
            <orgId>1</orgId>
            <function>IMPORTCONTENT</function>
            <parameters>PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0i ... </parameters>
            <parameters>XML</parameters>
            <importOption>
          	      	<optionIndex>0</optionIndex>
                    	<optionKey>OPTION</optionKey>
                    	<optionValue>REPLACE</optionValue>
          	      	<optionIndex>1</optionIndex>
                    	<optionKey>EXISTING</optionKey>
                    	<optionValue>70279</optionValue>
             </importOption>
          </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

<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>3c25c8a81c971e26bd23d4ed60194fba</sessionId>
            <statusCode>SUCCESS</statusCode>
         </return>
      </ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>

• 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 theme Confluence
  rsr.setLoginId("admin@yellowfin.com.au"); rsr.setPassword("test"); rsr.setOrgId(1); rsr.setFunction("IMPORTCONTENT");

  
  

• Specify the file containing data that is to be imported:

  Code Block
  language java
  Path path = Paths.get("/Applications/Yellowfin 7.4/YFexport.xml"); byte[] data = Files.readAllBytes(path); byte[] encodeBase64 = java.util.Base64.getEncoder().encode(data); String f = new String(encodeBase64, "UTF-8");

  
  

• Provide the extension of this file, i.e. either YFX or XML:

  Code Block
  language java
  rsr.setParameters(new String[]{f,"XML"});

  
  

• Specify how the file content should be imported:

  Code Block
  language java
  ImportOption[] options = new ImportOption[2]; options[0] = new ImportOption(); options[0].setItemIndex(0); options[0].setOptionKey("OPTION"); options[0].setOptionValue("REPLACE"); options[1] = new ImportOption(); options[1].setItemIndex(0); options[1].setOptionKey("EXISTING"); options[1].setOptionValue("70279");

  
  

• Set the import options object into the request:

  Code Block
  language java
  rsr.setImportOptions(options);

  
  

• Once the request is configured, perform the call:

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

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

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

   

<%   	
/*    	ws_importcontent.jsp              	*/
%>
<%@ page language="java" contentType="text/html; charset=UTF-8" %>
<%@ page import="com.hof.util.*, java.util.*, java.text.*" %>
<%@ page import="com.hof.web.form.*" %>
<%@ page import="com.hof.mi.web.service.*" %>
<%@ page import="java.nio.file.Files" %>
<%@ page import="java.nio.file.Paths" %>
<%@ page import="java.nio.file.Path" %>
<%
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("IMPORTCONTENT");
 
/*    	Yfexport.xml contains just one report with no dependencies
        	which can be retrieved using an EXPORTCONTENT web service call and passing a single report id.
        	FYI. Latest Yellowfin builds do not allow export Yellowfin content WITHOUT dependencies,
        	so ImportOption in this example will not suit any YFX file.
        	You need to define proper ImportOption anyway
*/
Path path = Paths.get("/Applications/Yellowfin 7.4/YFexport.xml");
 
byte[] data = Files.readAllBytes(path);
byte[] encodeBase64 = java.util.Base64.getEncoder().encode(data);
String f = new String(encodeBase64, "UTF-8");
 
rsr.setParameters(new String[]{f,"XML"});
 
        	ImportOption[] options = new ImportOption[2];
        	options[0] = new ImportOption();
        	options[0].setItemIndex(0);
        	options[0].setOptionKey("OPTION");
        	options[0].setOptionValue("REPLACE");
        	
        	options[1] = new ImportOption();
        	options[1].setItemIndex(0);
        	options[1].setOptionKey("EXISTING");
        	
        	/*    	existing report Id. Can be retrieved from ReportHeader table of Yellowfin database, ReportId column.
                    	keep in mind that the reportId changes each time when a user modifies the report.
                    	You can use the GETIDFORUUID call to get the valid reportId value for the report.
        	*/
        	options[1].setOptionValue("70279");
        	
rsr.setImportOptions(options);
 
AdministrationServiceResponse rs1 = adminService.remoteAdministrationCall(rsr);
        	
        	if ("SUCCESS".equals(rs1.getStatusCode()) ) {
                    	out.write("<br>Test Import Success");
        	}
        	else {
        	out.write("Failure");
        	out.write(" Code: " + rs1.getErrorCode());
        	}       	
 
%>

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:remoteAdministrationCall>
         <!--Optional:-->
         <arg0>
            <loginId>admin@yellowfin.com.au</loginId>
        	<password>test</password>
            <orgId>1</orgId>
            <function>TESTIMPORTCONTENT</function>
            <parameters>PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0i ... </parameters>
            <parameters>XML</parameters>
            <importOption>
          	      	<optionIndex>0</optionIndex>
                    	<optionKey>OPTION</optionKey>
                    	<optionValue>REPLACE</optionValue>
          	      	<optionIndex>1</optionIndex>
                    	<optionKey>EXISTING</optionKey>
                    	<optionValue>70279</optionValue>
             </importOption>
          </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
         <return>
            <contentResources>
               <resourceDescription>months, 6/3/2018 8:53 AM</resourceDescription>
               <resourceId>70279</resourceId>
           	<resourceName>My Report 1000</resourceName>
           	<resourceType>REPORT</resourceType>
               <resourceUUID>fd3794b3-62c0-4cf8-bac0-755e68d9c41e</resourceUUID>
            </contentResources>
            <errorCode>0</errorCode>
        	<importIssues>
           	<issueElements>
              	<messageKey>error.reports.import.view</messageKey>
              	<renderedMessage>View has not been selected.</renderedMessage>
           	</issueElements>
           	<issueElements>
                  <messageKey>error.reports.import.category</messageKey>
              	<renderedMessage>Folder has not been selected.</renderedMessage>
           	</issueElements>
           	<resource>
                  <resourceDescription>months, 6/3/2018 8:53 AM</resourceDescription>
             	 <resourceId>70279</resourceId>
              	<resourceName>My Report 1000</resourceName>
                  <resourceType>REPORT</resourceType>
                  <resourceUUID>fd3794b3-62c0-4cf8-bac0-755e68d9c41e</resourceUUID>
           	</resource>
            </importIssues>
            <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
            <messages>Web Service Request Complete</messages>
            <sessionId>ab398569ce36672e9d776c3dae3804d6</sessionId>
  	      <statusCode>SUCCESS</statusCode>
         </return>
      </ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>

• 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 theme Confluence
  rsr.setLoginId("admin@yellowfin.com.au"); rsr.setPassword("test"); rsr.setOrgId(1); rsr.setFunction("TESTIMPORTCONTENT");

  
  

• Specify the file containing data that is to be imported:

  Code Block
  language java
  Path path = Paths.get("/Applications/Yellowfin 7.4/qwerty.yfx"); byte[] data = Files.readAllBytes(path); byte[] encodeBase64 = java.util.Base64.getEncoder().encode(data); String f = new String(encodeBase64, "UTF-8");

  
  

• Provide the extension of this file, i.e. either YFX or XML:

  Code Block
  language java
  rsr.setParameters(new String[]{f,"YFX"});

  
  

• Once the request is configured, perform the call:
  
  

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

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

• Then test the imported content:

  Code Block
  language java
  if ("SUCCESS".equals(rs.getStatusCode()) ) { out.write("<br>Success"); ContentResource[] crs = rs.getContentResources(); ImportIssue[] ImportIssues = rs.getImportIssues(); out.write("<br>Import Issues: " + (ImportIssues!=null?ImportIssues.length:"no issues")); out.write("<table>"); out.write("<tr><td> ResourceId </td><td> ResourceType </td><td> ResourceName </td><td> ResourceUUID </td></tr>"); for (ContentResource c: crs) { out.write("<tr>"); out.write("<td>" + c.getResourceId() + "</td><td>" + c.getResourceType() + "</td><td>" + c.getResourceName() + "</td><td>" + c.getResourceUUID() + "</td>"); out.write("</tr>"); } } else { out.write("Failure"); out.write(" Code: " + rs.getErrorCode()); }

  
  
  

• The response will contain the following elements: StatusCode, ImportIssues and ContentResources. (See details in the Response Parameters table above.)

   

<%   	
/*    	ws_testimportcontent.jsp                  	*/
%>
<%@ page language="java" contentType="text/html; charset=UTF-8" %>
<%@ page import="com.hof.util.*, java.util.*, java.text.*" %>
<%@ page import="com.hof.web.form.*" %>
<%@ page import="com.hof.mi.web.service.*" %>
<%@ page import="java.nio.file.Files" %>
<%@ page import="java.nio.file.Paths" %>
<%@ page import="java.nio.file.Path" %>
<%
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("TESTIMPORTCONTENT");
 
Path path = Paths.get("/Applications/Yellowfin 7.4/www.yfx"); 			// existing file
 
byte[] data = Files.readAllBytes(path);
byte[] encodeBase64 = java.util.Base64.getEncoder().encode(data);
String f = new String(encodeBase64, "UTF-8");
 
rsr.setParameters(new String[]{f,"YFX"});
 
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
 
if ("SUCCESS".equals(rs.getStatusCode()) ) {
        	out.write("<br>Success");
        	
        	ContentResource[] crs = rs.getContentResources();
        	
        	ImportIssue[] ImportIssues = rs.getImportIssues();
        	out.write("<br>Import Issues: " + (ImportIssues!=null?ImportIssues.length:"no issues"));
        	
        	out.write("<table>");
        	out.write("<tr><td> ResourceId </td><td> ResourceType </td><td> ResourceName </td><td> ResourceUUID </td></tr>");
        	for (ContentResource c: crs) {
                    	out.write("<tr>");
                    	out.write("<td>" + c.getResourceId() + "</td><td>" + c.getResourceType() + "</td><td>" + c.getResourceName() + "</td><td>" + c.getResourceUUID() + "</td>");
                    	out.write("</tr>");
   }
} else {
        	out.write("Failure");
        	out.write(" Code: " + rs.getErrorCode());
}
%>

<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>EXPORTTRANSLATIONALL</function>
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
         <return>
            <binaryData>77u/VVVJRCxUZXh0IFR5cGUsS2V5LE9yaWdpbmFsIFRleHQs ... </binaryData>
            <contentType>text/comma-separated-values</contentType>
            <errorCode>0</errorCode>
            <fileName>Translations - 10 Mar 2018.csv</fileName>
            <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
            <messages>Web Service Request Complete</messages>
            <sessionId>4a19aa468b23ab18d3aee5c7121bcacd</sessionId>
            <statusCode>SUCCESS</statusCode>
         </return>
      </ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>

• 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 theme Confluence
  rsr.setLoginId("admin@yellowfin.com.au"); rsr.setPassword("test"); rsr.setOrgId(1); rsr.setFunction("EXPORTTRANSLATIONALL");

  
  

• Once the request is configured, perform the call:
  
  

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

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

• The response will contain the following elements: StatusCode, BinaryData, FileName and ContentType. (See details in the Response Parameters table above.)

   

<%   	
/*    	ws_exporttranslationall.jsp             	*/
%>
<%@ page language="java" contentType="text/html; charset=UTF-8" %>
<%@ page import="com.hof.util.*, java.util.*, java.text.*" %>
<%@ page import="com.hof.web.form.*" %>
<%@ page import="com.hof.mi.web.service.*" %>
<%@ page import="java.nio.file.Files" %>
<%@ page import="java.io.PrintWriter" %>
<%
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("EXPORTTRANSLATIONALL");
 
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
        	
        	if ("SUCCESS".equals(rs.getStatusCode()) ) {
                    	out.write("<br>Success");
                    	
                    	//response.setBinaryData(Base64.encodeBytes(pdf.getData()));
                    	
                    	String Base64encoded = rs.getBinaryData();
                    	Base64encoded = Base64encoded.replace("\n", "").replace("\r", "");
                    	
                    	byte[] bytes = Base64encoded.getBytes();
                    	byte[] decoded = java.util.Base64.getDecoder().decode(bytes);
                    	
                    	String text = new String(decoded, "UTF-8");
                    	PrintWriter writer = new PrintWriter("/Applications/Yellowfin 7.4/" + rs.getFileName(), "UTF-8");
                    	writer.println(text);
                    	writer.close();
        	}
        	else {
        	out.write("<br>Failure");
        	out.write(" Code: " + rs.getErrorCode());
        	}       	
%>

<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>IMPORTTRANSLATION</function>
			<binaryData>-17</binaryData>
			<binaryData>-69</binaryData>
			<binaryData>-65</binaryData>
			<binaryData>85</binaryData>
			<binaryData>85</binaryData>
				...
		</arg0>
  	</web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

<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>11c466874bfbcdb80f5d250c97ffbd03</sessionId>
            <statusCode>SUCCESS</statusCode>
         </return>
      </ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>

• 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 theme Confluence
  rsr.setLoginId("admin@yellowfin.com.au"); rsr.setPassword("test"); rsr.setOrgId(1); rsr.setFunction("IMPORTTRANSLATION");

  
  

• Specify the translation CSV file to be imported:

  Code Block
  language java
  Path path = Paths.get("/Applications/Yellowfin 7.4/Translations - 8 Mar 2018.csv"); // existing file byte[] data = Files.readAllBytes(path); rsr.setBinaryData(data);

  
  

• Once the request is configured, perform the call:
  
  

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

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

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

   

<%   	
/*    	ws_importtranslation.jsp                   	*/
%>
<%@ page language="java" contentType="text/html; charset=UTF-8" %>
<%@ page import="com.hof.util.*, java.util.*, java.text.*" %>
<%@ page import="com.hof.web.form.*" %>
<%@ page import="com.hof.mi.web.service.*" %>
<%@ page import="java.nio.file.Files" %>
<%@ page import="java.nio.file.Paths" %>
<%@ page import="java.nio.file.Path" %>
<%
 
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 the password of the account above
rsr.setOrgId(1);
rsr.setFunction("IMPORTTRANSLATION");
 
Path path = Paths.get("/Applications/Yellowfin 7.4/Translations - 8 Mar 2018.csv"); 		// existing file
 
byte[] data = Files.readAllBytes(path);
 
rsr.setBinaryData(data);
 
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
        	if ("SUCCESS".equals(rs.getStatusCode()) ) {
                    	out.write("<br>Success");
        	}
        	else {
        	out.write("<br>Failure");
        	out.write(" Code: " + rs.getErrorCode());
        	}       	
%>