Page History
...
You can use pre-built Java functions to call Yellowfin API. This makes development a little bit easier as you are using pre-built functions, rather than configuring each request manually.
| Tip |
|---|
The code samples regarding this method can be found in the development/examples/webservices folder. See the jsp files with ‘api’ in their names. A good starting point is copying files with ‘mobile’ in their names, into the Yellowfin ROOT folder and explore. |
Performing SOAP Calls
Performing direct SOAP calls using Java generated stubs off Yellowfin WSDL.
All the code samples under Administration Service and Report Service sections are explained using SOAP calls in Java. In this Wiki, all the examples of using Yellowfin web services are explained assuming that you call Yellowfin API from Yellowfin Tomcat (that means you use JSP and all your files go to Yellowfin/appserver/webapps/ROOT folder). Using languages other than Java will not bring much complexity to the code.
Use this command to initialize the Administration web services:
| Code Block | ||
|---|---|---|
| ||
AdministrationServiceService s_adm = new AdministrationServiceServiceLocator(<host>,<port>,<ServicePath>, <ssl>); AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService(); |
Use this command to initialize the Report web services:
| Code Block | ||
|---|---|---|
| ||
ReportServiceService s_rpt = new ReportServiceServiceLocator(<host>, <port>, <ServicePath>, <ssl>); ReportServiceSoapBindingStub reportService = (ReportServiceSoapBindingStub) s_rpt.getReportService(); |
See below for an explanation of these parameters:
| Parameter | Type | Description |
|---|---|---|
host | String | Yellowfin server (can be server DNS name, IP address, URL or “localhost”) |
port | Integer | http port number to access Yellowfin server |
ServicePath | String | Path to the service Administration service path: "/services/AdministartionService" Report service path: "/services/ReportService" |
ssl | Boolean | If SSL enabled: true |
The primary objects include:
| Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
An object that defines the type of call being made to the web service.
Object parameters:
All parameters have corresponding “get” and “set” methods. For instance:
It is not necessary to define all the parameters; each web service call has a list of the required parameters. If you do not specify parameters of the call, they will have null value by default. There are mandatory parameters for any request: loginId - Yellowfin account with web services role switched on and must be Yellowfin default (primary) org user; password - password of the above account orgId - should be always 1 which is default org ID. function - type of the call. Other parameters will be required depending on the function value. Each request must contain the web service user details: who can call Yellowfin webservices. This must be existing user with “Webservices” role being ticked, and these details should be specified as loginId, password, orgId.
|
- AdministrationServiceRequest
- AdministrationServiceResponse