Error rendering macro 'rw-search'

null

Page History

Versions Compared

Old Version 9

changes.mady.by.user user-3484a

Saved on 09 Mar, 2018

compared with

New Version 10

changes.mady.by.user user-3484a

Saved on 09 Mar, 2018

Key

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

...

Expand

title	GETIMPORTCONTENT

This function reads a provided YFX or XML file and places specific content from it into ContentResource object that can be imported.

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 "GETIMPORTCONTENT".
OrgRef	String	This optional parameter can be used to specify a client org. ID.
Parameter	String[]	This array contains strings with details of content that is to be imported from a file. The first string is a byte array of UTF-8 string. The second is the file type, that is "YFX" or "XML".

Request Example

Below is a SOAP XML example for this request:

Code Block

language	xml

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

ContentResources

ContentResource[]

Object array containing details of Yellowfin's content to be imported.

Response Example

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

Code Block

language	xml

Instructions

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

Expand

title	Step-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
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.)

Complete Example

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

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

Code Block

language	java
theme	Eclipse

<%   	
/*    	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());
}
%>

Anchor

	TestImportContent
	TestImportContent

Expand

title	TESTIMPORTCONTENT

This function imports content from a YFX or XML file and then tests or validates it.

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 "TESTIMPORTCONTENT".
OrgRef	String	This optional parameter can be used to specify a client org. ID.
Parameter	String[]	This array contains strings with details of the content to be imported and validated. The first string is a byte array of UTF-8 string. The second is the file type, that is "YFX" or "XML".
ImportOptions	ImportOption[]	This optional parameter can be used to define how content should be imported.

Request Example

Below is a SOAP XML example for this request:

Code Block

language	xml

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:remoteAdministrationCall>
         <!--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>

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

ImportIssues

ImportIssue[]

Object array containing issues faced while importing the file.

ContentResources

ContentResource[]

Object array containing details of Yellowfin's content to be imported.

Response Example

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

Code Block

language	xml

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

Instructions

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

Expand

title	Step-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
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.)

Complete Example

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

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

Code Block

language	java
theme	Eclipse

<%   	
/*    	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());
}
%>

Expand

title	TESTIMPORTCONTENTNOVALIDATION

This web service is the same as the TESTIMPORTCONTENT, with the only difference being that it does not validate the data source.

Anchor

	importContent
	importContent

Expand

title	IMPORTCONTENT

This function imports content from an XML or YFX file into 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 "IMPORTCONTENT".
OrgRef	String	This optional parameter can be used to specify a client org. ID.
Parameters	String[]	This array contains strings with details of the content to be imported and validated. The first string is a byte array of UTF-8 string. The second is the file type, that is "YFX" or "XML".
ImportOptions	ImportOption[]	This optional parameter can be used to define how content should be imported. If not specified, Yellowfin will import all the content as new, exactly how it is contained in the file.

Request Example

Below is a SOAP XML example for this request:

Code Block

language	xml

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:remoteAdministrationCall>
         <!--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>

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

Note: The status corresponds to whether or not the call was performed, not if the actual import was carried out.

Response Example

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

Code Block

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

Instructions

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

Expand

title	Step-by-step instructions

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

Complete Example

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

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

Code Block

language	java
theme	Eclipse

<%   	
/*    	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());
        	}       	
 
%>

Expand

title	IMPORTCONTENTNOVALIDATION

This web service is the same as the IMPORTCONTENT, with the only difference being that it does not validate the data source.

Tips & Tricks

The basic function for exporting is GETCONTENT that returns content details in the ContentResource object, which can further be used with other web service calls to import, export or validate content.
Instead of searching for dependencies manually, use the GETEXPORTDEPENDENCIES to get a list of dependencies, and then pass them to another call.
To retrieve a Yellowfin XML file, create an array of ContentResource objects and call the EXPORTCONTENT. You can proceed to import this file in another Yellowfin environment as well.

...

Content

Space Tools

Page History

Versions Compared

Old Version 9

New Version 10

Key

Request Parameters

Request Example

Response Parameters

Response Example

Instructions

Complete Example

Request Parameters

Request Example

Response Parameters

Response Example

Instructions

Complete Example

Request Parameters

Request Example

Response Parameters

Response Example

Instructions

Complete Example

Tips & Tricks