Error rendering macro 'rw-search'

null

Page History

Versions Compared

Old Version 1

changes.mady.by.user user-3484a

Saved on 08 Mar, 2018

compared with

New Version 2

changes.mady.by.user user-3484a

Saved on 08 Mar, 2018

Key

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

The web service calls categorized in this section are related to exporting and importing content. The web service API is restricted currently limited to exporting or importing the following types of content:

...

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

title	GETCONTENT

This function returns all Yellowfin content available for export or importthat can be exported or 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 "GETCONTENT".
OrgRef	String	This optional parameter can be used to specify a client org. ID

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

SchedulesContentResources

AdministrationSchedule ContentResource[]This

will contain an array of AdministrationSchedule objects describing all the available schedulesObject array containing details of Yellowfin's content that can be exported.

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><contentResources>
            <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
 <resourceCode>AUDITREPORTS</resourceCode>
             <messages>Web Service Request<resourceDescription>Audit Complete<Reports</messages>resourceDescription>
             <schedules xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/> <resourceId>56339</resourceId>
            <schedules xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>   <resourceName>Audit Reports</resourceName>
            <schedules xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
   <resourceOrgId>1</resourceOrgId>
             <schedules xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/> <resourceType>RPTCATEGORY</resourceType>
            <schedules xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
   <resourceUUID>a6bdc6b5-a832-42a2-98c7-18273900d0aa</resourceUUID>
            </contentResources>
  <schedules xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
          <contentResources>
             <schedules xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/> <resourceCode>ADMINREPORTS</resourceCode>
            <schedules xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>   <resourceDescription>Admin Reports</resourceDescription>
            <schedules>
   <resourceId>56340</resourceId>
            <frequency>
   <resourceName>Admin Reports</resourceName>
               <frequencyCode>MONDAY<<resourceOrgId>1</frequencyCode>resourceOrgId>
                  <frequencyUnit>1</frequencyUnit><resourceType>RPTSUBCATEGORY</resourceType>
                  <localRunTime>0</localRunTime><resourceUUID>f7fb32b7-1573-4899-916f-c34afb9a865d</resourceUUID>
             </contentResources>
         <localTimezoneCode>AUSTRALIA/SYDNEY</localTimezoneCode>   <contentResources>
               <<resourceCode>CONTENTUSAGE</frequency>resourceCode>
               <lastRunDateTimeGMT>2018-02-25T00:00:00+11:00</lastRunDateTimeGMT><resourceDescription>Content Usage</resourceDescription>
               <lastRunStatus>SUCCESS<<resourceId>56341</lastRunStatus>resourceId>
               <nextRunDateTimeGMT>2018-03-12T00:00:00+11:00</nextRunDateTimeGMT><resourceName>Content Usage</resourceName>
               <scheduleActive>true<<resourceOrgId>1</scheduleActive>resourceOrgId>
               <scheduleDescription>Athlete<<resourceType>RPTSUBCATEGORY</scheduleDescription>resourceType>
               <scheduleUUID>75a2f5b5<resourceUUID>6bae5230-162bc1f9-49b54491-b1978a8b-53643f7dc0de<f14b1ae660d7</scheduleUUID>resourceUUID>
            </schedules>contentResources>
            <contentResources>
            <schedules xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
   <resourceCode>USERACCESS</resourceCode>
             <schedules xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>  <resourceDescription>User Access</resourceDescription>
            <schedules xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
   <resourceId>56342</resourceId>
              <schedules xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/> <resourceName>User Access</resourceName>
            <schedules xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>   <resourceOrgId>1</resourceOrgId>
            <schedules xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
   <resourceType>RPTSUBCATEGORY</resourceType>
                <schedules xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/><resourceUUID>0c7ddde4-fa03-4e88-b37b-7b5e4aad5e1d</resourceUUID>
            <schedules></contentResources>
               <frequency><contentResources>
                  <frequencyCode>SATURDAY</frequencyCode><resourceCode>TUTORIAL</resourceCode>
                  <frequencyUnit>6</frequencyUnit>
<resourceDescription>Tutorial</resourceDescription>
               <resourceId>60706</resourceId>
            <localRunTime>0</localRunTime>
   <resourceName>Tutorial</resourceName>
               <localTimezoneCode>AUSTRALIA<resourceOrgId>1</SYDNEY</localTimezoneCode>resourceOrgId>
               <<resourceType>RPTCATEGORY</frequency>resourceType>
               <nextRunDateTimeGMT>2018-03-10T00:00:00+11:00</nextRunDateTimeGMT><resourceUUID>a23c2ec6-a2fa-45c7-b5da-dcf3f02e6633</resourceUUID>
               <scheduleActive>false</scheduleActive></contentResources>
            <contentResources>
   <scheduleDescription>Common Filters</scheduleDescription>
           <resourceCode>ATHLETES</resourceCode>
    <scheduleUUID>fa757330-b4a8-4047-9b96-745a48b1d1b7</scheduleUUID>           <resourceDescription>Athletes</resourceDescription>
            </schedules>   <resourceId>60707</resourceId>
            <schedules xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
   <resourceName>Athletes</resourceName>
             <schedules xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/> <resourceOrgId>1</resourceOrgId>
            <schedules xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>   <resourceType>RPTSUBCATEGORY</resourceType>
            <schedules>
   <resourceUUID>72e4b4bd-a482-4a01-a031-c6ab76dbb3a5</resourceUUID>
            <frequency></contentResources>
                  <frequencyCode>SATURDAY</frequencyCode><contentResources>
                  <frequencyUnit>6</frequencyUnit><resourceCode>CAMP</resourceCode>
                  <localRunTime>0</localRunTime><resourceDescription>Camp</resourceDescription>
                  <localTimezoneCode>AUSTRALIA/SYDNEY</localTimezoneCode><resourceId>60708</resourceId>
               <<resourceName>Camp</frequency>resourceName>
               <lastRunDateTimeGMT>2018-02-19T00:00:00+11:00</lastRunDateTimeGMT><resourceOrgId>1</resourceOrgId>
               <lastRunError>com.hof.util.ActionErrorsException: java.lang.NullPointerException</lastRunError><resourceType>RPTSUBCATEGORY</resourceType>
               <lastRunStatus>FAILURE</lastRunStatus><resourceUUID>465411e5-594b-478e-af64-c0f59fc4546f</resourceUUID>
               <nextRunDateTimeGMT>2018-03-10T00:00:00+11:00</nextRunDateTimeGMT></contentResources>
               <scheduleActive>false</scheduleActive><contentResources>
               <scheduleDescription>Common Filters<<resourceCode>KPIS</scheduleDescription>resourceCode>
               <scheduleUUID>f732c7a4-b81a-4788-8038-6771229596c1</scheduleUUID>
<resourceDescription>KPIs</resourceDescription>
              < <resourceId>60709</schedules>resourceId>
            <sessionId>ba906c4149a72b2f3c750467a31adf72</sessionId>
   <resourceName>KPIs</resourceName>
         <statusCode>SUCCESS</statusCode>
      <resourceOrgId>1</resourceOrgId>
     </return>
          <resourceType>RPTSUBCATEGORY</resourceType>
               </ns2:remoteAdministrationCallResponse>
<resourceUUID>d514c643-dc01-4781-8905-d34e761ccd19</resourceUUID>
            </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

Code Block

language	java
theme	Confluence

AdministrationServiceRequest rsr = new AdministrationServiceRequest(); 

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organization
rsr.setOrgId(new Integer(1));

rsr.setFunction("LISTSCHEDULES");

You may even identify a specific client organization:

Code Block

language	java

rsr.setOrgRef("org1");

Once the request is configured, perform the call:

Code Block

language	java

AdministrationServiceResponse rs = AdministrationService.remoteAdministrationCall(rsr);

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

The response will contain the following parameters: StatusCode and Schedules. (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_ listschedules.jsp.
Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
Adjust the host, port, and admin user according to your environment.
Run http://<host>:<port>/ws_ listschedules.jsp from your Internet browser.

Code Block

language	java
theme	Eclipse

/* 
 * LISTSCHEDULES Example. ws_listschedules.jsp
 * A more complete example can be found in ws_admin_schedule_management.jsp
 */

<%@ page language="java" contentType="text/html; charset=UTF-8" %>
<%@ page import="java.text.*" %> 
<%@ page import="java.util.*" %>
<%@ page import="com.hof.mi.web.service.*" %>
<%@ page import="com.hof.mi.web.service.schedule.*" %>
<%@ page import="com.hof.web.form.*" %>

AdministrationServiceService s_adm = new AdministrationServiceServiceLocator("localhost",8080, "/services/AdministrationService", false);contentResources>
            <contentResources>
               <resourceCode>MARKETINGBOOKING</resourceCode>
               <resourceDescription>Marketing &amp; Booking</resourceDescription>
               <resourceId>60710</resourceId>
               <resourceName>Marketing &amp; Booking</resourceName>
               <resourceOrgId>1</resourceOrgId>
               <resourceType>RPTSUBCATEGORY</resourceType>
               <resourceUUID>dbe6d0a3-c088-4d71-b65a-f383aaa54be9</resourceUUID>
            </contentResources>
            <contentResources>
               <resourceCode>TRAINING</resourceCode>
               <resourceDescription>Training</resourceDescription>
               <resourceId>60711</resourceId>
               <resourceName>Training</resourceName>
               <resourceOrgId>1</resourceOrgId>
               <resourceType>RPTSUBCATEGORY</resourceType>
               <resourceUUID>c503ea57-cc69-43a9-98bc-a90ebbe1c864</resourceUUID>
            <//contentResources>
   adjust host and port number
 
AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au"); <contentResources>
               <resourceDescription/>
               <resourceId>70101</resourceId>
               <resourceName>Oracle database</resourceName>
               <resourceOrgId>1</resourceOrgId>
 provide your Yellowfin web services admin account
rsr.setPassword("test");                           // change to the password of the above account              <resourceType>DATASOURCE</resourceType>
            </contentResources>
            <contentResources>
               <resourceDescription/>
               <resourceId>70109</resourceId>
               <resourceName>Oracle</resourceName>
               <resourceOrgId>1</resourceOrgId>
               <resourceType>DATASOURCE</resourceType>
            </contentResources>
            <contentResources>
               <resourceDescription>Ski Team is the demonstration and tutorial database.</resourceDescription>
               <resourceId>54700</resourceId>
               <resourceName>Ski Team</resourceName>
               <resourceOrgId>1</resourceOrgId>
               <resourceType>DATASOURCE</resourceType>
            </contentResources>
            <contentResources>
               <resourceDescription/>
               <resourceId>54701</resourceId>
               <resourceName>Yellowfin Configuration Database</resourceName>
               <resourceOrgId>1</resourceOrgId>
               <resourceType>DATASOURCE</resourceType>
            </contentResources>
            <contentResources>
               <resourceDescription/>
               <resourceId>70108</resourceId>
               <resourceName>c</resourceName>
               <resourceOrgId>1</resourceOrgId>
               <resourceType>DATASOURCE</resourceType>
            </contentResources>
            <contentResources>
               <resourceDescription/>
               <resourceId>70110</resourceId>
               <resourceName>f</resourceName>
               <resourceOrgId>1</resourceOrgId>
               <resourceType>DATASOURCE</resourceType>
            </contentResources>
            <contentResources>
               <resourceDescription>This is a tutorial view for training and demo purposes.</resourceDescription>
               <resourceId>60543</resourceId>
               <resourceName>Ski Team</resourceName>
               <resourceType>VIEW</resourceType>
               <resourceUUID>e3632adb-5194-460c-a172-c085416f493f</resourceUUID>
            </contentResources>
            <contentResources>
               <resourceDescription>This view should be used to monitor usage of Yellowfin by User and Content Type.</resourceDescription>
               <resourceId>56169</resourceId>
               <resourceName>Yellowfin Usage Audit</resourceName>
               <resourceType>VIEW</resourceType>
               <resourceUUID>fb6416c4-441e-42b3-a442-e7426f25f6b4</resourceUUID>
            </contentResources>
            <contentResources>
               <resourceDescription>This dashboard contains a set of reports covering general system and admin information, including performance, sessions, data source &amp; view usage.</resourceDescription>
               <resourceId>57438</resourceId>
               <resourceName>Admin</resourceName>
               <resourceOrgId>1</resourceOrgId>
               <resourceType>GROUP</resourceType>
               <resourceUUID>33827292-cda6-4071-965f-730ccbc53519</resourceUUID>
            </contentResources>
            <contentResources>
               <resourceDescription>This is an analytic tab that is used to understand examine metrics split by various demographics and filters.</resourceDescription>
               <resourceId>61195</resourceId>
               <resourceName>Analysis</resourceName>
               <resourceOrgId>1</resourceOrgId>
               <resourceType>GROUP</resourceType>
               <resourceUUID>f19e63f5-7175-4c57-897d-ed865aba8972</resourceUUID>
            </contentResources>
            </contentResources> 
            <errorCode>0</errorCode>
            <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
            <messages>Web Service Request Complete</messages>
            <sessionId>92029c8ae4f1db0f33bf0b7370c1088a</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("GETCONTENT");
You may even identify a specific client organization:
Code Block
language java
rsr.setOrgRef("org1");

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

Code Block

language	java
theme	Eclipse

<%   	
/*    	ws_getcontent.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("GETCONTENT");
 
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
        	if ("SUCCESS".equals(rs.getStatusCode()) ) {
                    	out.write("<br>Success");
                    	ContentResource[] crs = rs.getContentResources();
                    	out.write("<table>");
                    	out.write("<tr><td> id </td><td> type </td><td> UUID </td></tr>");
                    	for (ContentResource c: crs) {
                                	out.write("<tr>");
                                	out.write("<td>" + c.getResourceId() + "</td><td>" + c.getResourceType() + "</td><td>" + c.getResourceUUID() + "</td>");
                                	out.write("</tr>");
                    	}
        	}
        	else {
        	out.write("<br>Failure");
        	out.write(" Code: " + rs.getErrorCode());
        	}       	
%>

Expand

title	GETEXPORTDEPENDENCIES

This function returns all Yellowfin content that can be exported or 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 "GETCONTENT".
OrgRef	String	This optional parameter can be used to specify a client org. ID

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 that can be exported.

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("GETCONTENT");
You may even identify a specific client organization:
Code Block
language java
rsr.setOrgRef("org1");

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

Code Block

language	java
theme	Eclipse

Expand

title	GETCONTENT

This function returns all Yellowfin content that can be exported or 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 "GETCONTENT".
OrgRef	String	This optional parameter can be used to specify a client org. ID

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 that can be exported.

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("GETCONTENT");
You may even identify a specific client organization:
Code Block
language java
rsr.setOrgRef("org1");

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

Code Block

language	java
theme	Eclipse

Expand

title	GETIMPORTCONTENT

This function returns all Yellowfin content that can be exported or 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 "GETCONTENT".
OrgRef	String	This optional parameter can be used to specify a client org. ID

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 that can be exported.

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(

"LISTSCHEDULES

"GETCONTENT");
You may even identify a specific client organization:
Code Block
language java
rsr.setOrgRef("org1");

Once the request is configured, perform the call:

Code Block

language	java

AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

if ("SUCCESS".equals(rs.getStatusCode()) ) { AdministrationSchedule[] schedules = rs.getSchedules(); out.write("Loaded " + schedules.length + " schedules: <br>"); for (AdministrationSchedule as: schedules) { out.write("Schedule " + as.getScheduleUUID() + "<br>"); } } else { out.write("Failure"); out.write(" Code: " + rs.getErrorCode() ); }

...

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

Code Block

language	java
theme	Eclipse

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 1

New Version 2

Key

Request Parameters

Request Example

Response Parameters

Response Example

Instructions

Complete 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

Request Parameters

Request Example

Response Parameters

Response Example

Instructions

Complete Example

Tips & Tricks