Page History
...
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This function exports selected Yellowfin content into an XML file.
Request ParametersThe following parameters should be passed with this request:
The following parameters are specified in the ContentResource object to call this function:
Request ExampleBelow is a SOAP XML example for this request:
Response ParametersThe returned response will contain these parameters:
The ReportBinaryObject array will return the following parameters with this call:
Response ExampleThe service will return the below response, according to our SOAP example:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete ExampleBelow is a full example of this web service call. To use it for yourself, carry out the following the steps:
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This function reads a provided YFX or XML file and places specific content from it into ContentResource object that can be importedreturns all the dependencies of a specific content. The ContentResource object is used to specify the content with the help of the resource ID (which can be retrieved using the GETCONTENT call). For instance if a report is the defined content type, then the response will display its dependencies, such as the report category, sub category, data source, view, etc.
Request ParametersThe following parameters should be passed with this request:
Request ExampleBelow is a SOAP XML example for this request:
Response ParametersThe returned response will contain these parameters:
Response ExampleThe service will return the below response, according to our SOAP example:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example: Expand | | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ContentResource | Object containing metadata of the content whose dependencies are to be retrieved. See table below. |
The following parameters are specified in the ContentResource object to call this function:
ContentResource Element | Data Type | Description |
---|---|---|
ResourceID | Integer | Mandatory parameter to provide internal ID of the content. |
ResourceType | String | Mandatory parameter to specify the content type. Could be one of:
|
ResourceUUID | String | This optional parameter can be used to provide the UUID of the content. |
Request Example
Below is a SOAP XML example for this request:
Code Block | ||
---|---|---|
| ||
<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>
|
Code Block | ||||
---|---|---|---|---|
| ||||
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 | ||
---|---|---|
| ||
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 | ||
---|---|---|
| ||
rsr.setParameters(new String[]{f,"YFX"}); |
Code Block | ||
---|---|---|
| ||
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 | ||||
---|---|---|---|---|
| ||||
<% /* ws_getimportcontent.jsp <function>GETEXPORTDEPENDENCIES</function> <contentResources> <resourceId>56169</resourceId> <resourceType>VIEW</resourceType> </contentResources> </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:
|
ContentResources | ContentResource[] | Object array containing metadata of the specified artifact's dependencies. |
Response Example
The service will return the below response, according to our SOAP example:
Code Block | ||
---|---|---|
| ||
<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/> */ %> <%@ 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){ <resourceId>54701</resourceId> <resourceName>Yellowfin Configuration Database</resourceName> out.write("<br><br>resourceType: " + o.getResourceType()); <resourceOrgId>1</resourceOrgId> out.write("<br>resourceCode: " + o.getResourceCode()); <resourceType>DATASOURCE</resourceType> </contentResources> out.write("<br>resourceName: " + o.getResourceName()); <errorCode>0</errorCode> <messages>Successfully Authenticated out.write("<br>resourceDescription: " + o.getResourceDescription());User: admin@yellowfin.com.au</messages> <messages>Web Service Request Complete</messages> out.write("<br>resourceOrgId: " + o.getResourceOrgId()); <sessionId>97d7f893d787daf2806a13cdfa6f09d3</sessionId> out.write("<br>resourceId: " + o.getResourceId());<statusCode>SUCCESS</statusCode> </return> out.write("<br>resourceUUID: " + o.getResourceUUID()); } } else { out.write("Failure"); out.write(" Code: " + rs.getErrorCode()); } %> |
title | GETEXPORTDEPENDENCIES |
---|
</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 | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||
|
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_ getexportdependencies.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_ getexportdependencies.jsp from your Internet browser.
Code Block | ||||
---|---|---|---|---|
| ||||
<%
/* ws_getexportdependecies.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 webservices admin account
rsr.setPassword("test"); |
This function returns all the dependencies of a specific content. The ContentResource object is used to specify the content with the help of the resource ID (which can be retrieved using the GETCONTENT call). For instance if a report is the defined content type, then the response will display its dependencies, such as the report category, sub category, data source, view, etc.
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 "GETEXPORTDEPENDENCIES". |
OrgRef | String | This optional parameter can be used to specify a client org. ID. |
ContentResources | ContentResource | Object containing metadata of the content whose dependencies are to be retrieved. See table below. |
The following parameters are specified in the ContentResource object to call this function:
ContentResource Element | Data Type | Description |
---|---|---|
ResourceID | Integer | Mandatory parameter to provide internal ID of the content. |
ResourceType | String | Mandatory parameter to specify the content type. Could be one of:
|
ResourceUUID | String | This optional parameter can be used to provide the UUID of the content. |
Request Example
Below is a SOAP XML example for this request:
Code Block | ||
---|---|---|
| ||
<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>GETEXPORTDEPENDENCIES</function> <contentResources> <resourceId>56169</resourceId> <resourceType>VIEW</resourceType> </contentResources> set to the password of the account </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:
|
ContentResources | ContentResource[] | Object array containing metadata of the specified artifact's dependencies. |
Response Example
The service will return the below response, according to our SOAP example:
Code Block | ||
---|---|---|
| ||
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">above rsr.setOrgId(1); rsr.setFunction("GETEXPORTDEPENDENCIES"); ContentResource[] cr = new ContentResource[1]; cr[0] = new ContentResource(); cr[0].setResourceId(70307); cr[0].setResourceType("GROUP"); cr[0].setResourceOrgId(1); rsr.setContentResources(cr); AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode()) ) { <return> out.write("<br>Success"); ContentResource[] crs <contentResources>= rs.getContentResources(); out.write("<table>"); <resourceDescription/> out.write("<tr><td> id </td><td> type </td><td> UUID </td></tr>"); <resourceId>54701</resourceId> for (ContentResource c: crs) { <resourceName>Yellowfin Configuration Database</resourceName> out.write("<tr>"); <resourceOrgId>1</resourceOrgId> out.write("<td>" + c.getResourceId() + <resourceType>DATASOURCE</resourceType> </contentResources>"</td><td>" + c.getResourceType() + "</td><td>" + c.getResourceUUID() + "</td>"); <errorCode>0</errorCode> <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages> out.write("</tr>"); } } else { <messages>Web Service Request Complete</messages> out.write("Failure"); out.write(" Code: " <sessionId>97d7f893d787daf2806a13cdfa6f09d3</sessionId> <statusCode>SUCCESS</statusCode> </return> </ns2:remoteAdministrationCallResponse> </S:Body> </S:Envelope>+ rs.getErrorCode()); } %> |
Instructions
...
Main Import Functions
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This function reads a provided YFX or XML file and places specific content from it into ContentResource object that can be imported.
Request ParametersThe following parameters should be passed with this request:
Request ExampleBelow is a SOAP XML example for this request:
Response ParametersThe returned response will contain these parameters:
Response ExampleThe service will return the below response, according to our SOAP example:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete ExampleBelow is a full example of this web service call. To use it for yourself, carry out the following the steps:
| 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 | ||||
---|---|---|---|---|
| ||||
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
rsr.setFunction("GETEXPORTDEPENDENCIES"); |
You may even identify a specific client organization:
Code Block | ||
---|---|---|
| ||
rsr.setOrgRef("org1");
|
Using a ContentResource object, specify details of the content whose dependencies are to be retrieved:
Code Block | ||
---|---|---|
| ||
ContentResource[] cr = new ContentResource[1];
cr[0] = new ContentResource();
cr[0].setResourceId(70307);
cr[0].setResourceType("GROUP");
cr[0].setResourceOrgId(1); |
Then set this object in the request:
Code Block | ||
---|---|---|
| ||
rsr.setContentResources(cr); |
Code Block | ||
---|---|---|
| ||
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_ getexportdependencies.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_ getexportdependencies.jsp from your Internet browser.
Code Block | ||||
---|---|---|---|---|
| ||||
<% /* ws_getexportdependecies.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 webservices admin account rsr.setPassword("test"); // set to the password of the account above rsr.setOrgId(1); rsr.setFunction("GETEXPORTDEPENDENCIES"); ContentResource[] cr = new ContentResource[1]; cr[0] = new ContentResource(); cr[0].setResourceId(70307); cr[0].setResourceType("GROUP"); cr[0].setResourceOrgId(1); rsr.setContentResources(cr); 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><br>Success"); for (ContentResource o : cr){ out.write("<td><br><br>resourceType: " + co.getResourceIdgetResourceType() + "</td><td>); out.write("<br>resourceCode: " + co.getResourceTypegetResourceCode() + "</td><td>); out.write("<br>resourceName: " + co.getResourceUUIDgetResourceName() + "</td>"); out.write("</tr>"); } } else { <br>resourceDescription: " + o.getResourceDescription()); out.write("Failure"); <br>resourceOrgId: " + o.getResourceOrgId()); out.write(" Code<br>resourceId: " + rso.getErrorCodegetResourceId()); } %> |
out.write("<br>resourceUUID: " + o.getResourceUUID());
}
} else {
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
}
%>
|
Main Import Functions
Anchor | ||||
---|---|---|---|---|
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This function imports content from a an XML or YFX or XML file and then tests or validates itfile into Yellowfin.
Request ParametersThe following parameters should be passed with this request:
Request ExampleBelow is a SOAP XML example for this request:
Response ParametersThe returned response will contain these parameters:
Response ExampleThe service will return the below response, according to our SOAP example:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete ExampleBelow is a full example of this web service call. To use it for yourself, carry out the following the steps:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Initialize the Administration web service. Click here to learn how to do this.
Then test the imported content: Code Block |
ImportOption[] options = new ImportOption[2]; options[0] = new ImportOption();out.write("<br>Success" options[0].setItemIndex(0); options[0].setOptionKey("OPTION");ContentResource options[0]crs = rs.getContentResources( .setOptionValue("REPLACE");ImportIssue options[1]ImportIssues = rs.getImportIssuesnew ImportOption();out.write("<br>Import Issues: " + (ImportIssues!=null?ImportIssues.length:"no issues") options[1].setItemIndex(0); options[1].setOptionKey("EXISTING");out.write("<table>"); /* existing report Id. Canout.write("<tr><td> ResourceId </td><td> ResourceType </td><td> ResourceName </td><td> ResourceUUID </td></tr>"); be retrieved from ReportHeader table of Yellowfin database, ReportId column.for (ContentResource c: crs) {
keep in mind that the reportId changes each time when a user modifies theout.write("<tr>"); report.out.write("<td>" + c.getResourceId() + "</td><td>" + c.getResourceType() + "</td><td>" + c.getResourceName() + "</td><td>" + c.getResourceUUID() + "</td>"); You can use the GETIDFORUUID call to get the valid reportId value for the report. */ options[1].setOptionValue("70279");out rsr.write("</tr>" setImportOptions(options); AdministrationServiceResponse rs1} } else { = adminService.remoteAdministrationCall(rsr);out.write("Failure");
out.writeif ("Code: " + rs.getErrorCode()); } The response will contain the following elements: StatusCode, ImportIssues and ContentResources. (See details in the Response Parameters table above.)
Complete ExampleBelow is a full example of this web service call. To use it for yourself, carry out the following the steps:
|
Expand | ||
---|---|---|
| ||
This web service is the same as the IMPORTCONTENT, with the only difference being that it does not validate the data source.
|
Anchor | ||||
---|---|---|---|---|
|
Expand | |||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||
This function imports content from a YFX or XML file and then tests or validates it.
Request ParametersThe following parameters should be passed with this request:
Request ExampleBelow is a SOAP XML example for this request:
|
Expand | ||
---|---|---|
| ||
This web service is the same as the TESTIMPORTCONTENT, with the only difference being that it does not validate the data source.
|
...
Response ParametersThe returned response will contain these parameters:
Response ExampleThe service will return the below response, according to our SOAP example:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete ExampleBelow is a full example of this web service call. To use it for yourself, carry out the following the steps:
|
Expand | ||
---|---|---|
| ||
This web service is the same as the TESTIMPORTCONTENT, with the only difference being that it does not validate the data source.
|
Content Translation Functions
Yellowfin's Content Translation functionality allows users to translate content, such as reports, views, dashboards, etc. from a previously configured language. Click here to learn more about this feature and the translation process involved. The following web services relate to this functionality.
Note: You must have this funtionality enabled in your instance, to call these web services.
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This web service exports translatable content across all active views, reports, and dashboards.
Request ParametersThe following parameters should be passed with this request:
Request ExampleBelow is a SOAP XML example for this request:
Response ParametersThe returned response will contain these parameters:
Response ExampleThe service will return the below response, according to our SOAP example:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete ExampleBelow is a full example of this web service call. To use it for yourself, carry out the following the steps:
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||
This function imports content from a YFX or XML file and then tests or validates it.
Request ParametersThe following parameters should be passed with this request:
Request ExampleBelow is a SOAP XML example for this request:
Response ParametersThe returned response will contain these parameters:
Response ExampleThe service will return the below response, according to our SOAP example:
|
...
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This function imports content from an XML or YFX file into Yellowfin.
Request ParametersThe following parameters should be passed with this request:
Request ExampleBelow is a SOAP XML example for this request:
Response ParametersThe returned response will contain these parameters:
Response ExampleThe service will return the below response, according to our SOAP example:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete ExampleBelow is a full example of this web service call. To use it for yourself, carry out the following the steps:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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.
...