P. 1
Sbo41sp2 Webi UI Extension_Points User Guide

Sbo41sp2 Webi UI Extension_Points User Guide

|Views: 74|Likes:
Published by Rajiv Kumar
Webi UI Extension_Points User Guide
Webi UI Extension_Points User Guide

More info:

Published by: Rajiv Kumar on Feb 28, 2014
Copyright:Attribution Non-commercial

Availability:

Read on Scribd mobile: iPhone, iPad and Android.
download as PDF, TXT or read online from Scribd
See more
See less

07/30/2014

pdf

text

original

Using extension points to customize the Web Intelligence interface ■ SAP BusinessObjects Business Intelligence Suite 4.

1 Support Package 2

2013-11-07

Copyright

© 2013 SAP AG or an SAP affiliate company. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice. Some software products marketed by SAP AG and its distributors contain proprietary software components of other software vendors. National product specifications may vary. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty. SAP and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and other countries. Please see http://www.sap.com/corporate-en/legal/copyright/index.epx#trademark for additional trademark information and notices. 2013-11-07

Contents

Chapter 1

About this guide......................................................................................................................5

Chapter 2

Document history....................................................................................................................7

Chapter 3

About Web Intelligence extension points................................................................................9

Chapter 4

About the extension bundle...................................................................................................11 About the IExtension interface................................................................................................11 About the extension bundle....................................................................................................11 To create an extension bundle................................................................................................12 Extension bundle recommendations.......................................................................................12 To declare the extension bundle contribution..........................................................................13 To implement the IExtension interface....................................................................................14 About the getExtension method properties............................................................................15 To build the extension bundle.................................................................................................15 For 64 bit Windows: To deploy the extension point bundles on the Tomcat application server.16 To test the extension bundle..................................................................................................16 About the extension bundle sample........................................................................................17 The user interface JavaScript APIs.......................................................................................19 About the user interface JavaScript APIs...............................................................................19 addEventListener...................................................................................................................19 setWaitCursorDisplayed........................................................................................................20 displayErrorMessage..............................................................................................................20 navigateTo.............................................................................................................................21 getContext.............................................................................................................................21 loadReport.............................................................................................................................21 reloadPane.............................................................................................................................22 attachDefaultButton...............................................................................................................22 setTitle...................................................................................................................................22 resize.....................................................................................................................................23

4.1 4.2 4.2.1 4.3 4.4 4.5 4.5.1 4.6 4.7 4.8 4.9
Chapter 5

5.1 5.1.1 5.1.2 5.1.3 5.1.4 5.1.5 5.1.6 5.1.7 5.1.8 5.1.9 5.1.10

3

2013-11-07

..................................................................................23 setButtonDisabled........................1...............................1...............................................18 6..........................................30 updateDPQuerySpec...............................................16 6.................................21 6.................................32 getVariableDefinition.............................14 6..............................................................................................................................12 6................................24 buttonEvents..........................................................................................................................33 deleteVariable...................................7 6......1........................................................2 6....................1....23 setButtonText...............26 createReport........................16 Chapter 6 close................................................................................................................................1.....28 getDataProviders.................................................1......................................................29 updateDataProvider......................27 getReportOutput......................3 6................11 5..25 4 2013-11-07 ..................................................................11 6................................25 getParameters....1................32 updateVariable.................4 6...............................................................................................................1....................25 About the Web Intelligence services JavaScript APIs..................1..........................................13 5......24 setButtonDisplayed......................................................................1...........................................................................................................1...............27 getReportMap........24 Using the Web Intelligence services JavaScript APIs.................................................................1...........26 getReportSpecification.....................................8 6.......................................................................................1.....17 6.............................30 getDPFlowDetails......28 getReportElement...................1.............................................................................................27 updateReportSpecification.........29 getDPQuerySpec...............................................................10 6............30 updateDPNbFlows......31 getVariables..........................................25 refreshDocument.....20 6.............1............................................................................................................................15 6..........33 6..................14 5.1......1..................................................................1...............................9 6....23 setButtonTitle...................................22 6..............1...........24 6........................................1......12 5..............13 6........................................................................1.......................................................................................................................................................................................15 5....1.............................................................................................................................................................26 updateReport..........................32 addVariable....................1...........................................................................1.................................29 addDataProvider......................................................6 6...................................31 exportReportListingMode.........................................................................................................19 6........23 6................................1...1 6.........28 getDPDetails...31 exportReportElement..............................................................25 getReports......................5 6....................1..............1........1....................................................................................1........................................Contents 5.........................................................................................................1 6.....1................................1........................................................

About this guide About this guide This document provides a description of how to use the Extension Points SDK to interact with the Web Intelligence (DHTML and Java interfaces) and Web Intelligence documents via the JavaScript APIs. This guide is intended for SAP BusinessObjects administrators and report creators who wish to customize the interface and use the JavaScript API calls to create and interact with reports. This document describes how to create your extension and use the calls to interact with documents. 5 2013-11-07 .

About this guide 6 2013-11-07 .

1 release.Document history Document history The following table provides an overview of the most important document changes. Version Date Description SAP Web Intelligence User Interface Extension Points API 4. 7 2013-11-07 .1 SP02 November 2013 New product for the 4.

Document history 8 2013-11-07 .

Related Topics • About the IExtension interface • About the user interface JavaScript APIs How to create extension points and use the RESTful services API to interact with Web Intelligence documents. 1. In the CMC. • About the Web Intelligence services JavaScript APIs An overview of how you can use the Web Intelligence RESTful web service JavaScript APIs to interact with reports. 3. Use the provided models to define and call the Javascript user interface APIs. 9 2013-11-07 . Declare and deploy the extension bundles. 2. use the customization panel in order to select the extensions that you want to make available to users. You use the CMC to define which extensions are available to a selected user group. refer to the JavaScript APIs to call the RESTful services in order to interact with Web Intelligence Documents.About Web Intelligence extension points About Web Intelligence extension points Develop and deploy extension bundles in order to create functions that can be used by specific groups of Web Intelligence users.

About Web Intelligence extension points 10 2013-11-07 .

extension package. web webiApplet webiDHTML viewer … extension <Provider> <Extension name> 11 2013-11-07 . The parameter lang takes the current UI language as value. Its folders must be organized following some recommendations.2 About the extension bundle The extension bundle is a webpath bundle. Here is an example of merged folder structure. Please see paragraph 2. It behaves like language pack fragment.AnalyticalReporting. 4.2.webi.AnalyticalReporting host. The interface IExtension has to methods: ExtensionProperties getExtensionProperties (String lang): The implementation of this method must return the Extension Properties. The bundle must be a fragment linked to the bundle host webpath. List<IUIElement> getContribution (String lang): The implement of this method must return 1 or N UIElements. which must be exported to make the interface available for the extensions. The content of the extension is merged to webpath.toolkit.About the extension bundle About the extension bundle 4.1 About the IExtension interface All bundle extension contributors will implement the IExtension interface. This class is created in the com.sap.2 for more details.

Provider: SAP e.businessobjects.x. To create an Extension bundle. Execution Environment: JavaSE-1. You can now create the extension bundle 7. Name: Extension Name d.businessobjects. Select Use default location b. In the "Import" dialog box.6 or higher. Select Create a Java project"(Source folder": src. Open Eclipse and select Plug-in Development perspective as your work perspective 2.0 c.About the extension bundle 4. Edit the Eclipse preferences and set the Java/Installed runtimes to JDK 1." 4.6. 4.1 To create an extension bundle You must have SAP Business Objects Enterprise Server installed in your development machine.webpath. The directory must be C:\Program Files (x86)\SAP BusinessObjects\SAP BusinessObjects Enterprise XI 4. Select the Directory option in Import From.2. Fill in the "New Fragment Project" dialog box as below and click Next. select Plug-in development/import plug-ins and Fragments and click Next. Select Fragment project and click Next. 5.webpath. Right-click on "Package Explorer" and select "Import. Select "com." Output folder": bin) • Select an OSGi framework: Equinox 9. 1. a. Version: 1. 3.6 10.0. Right-click on Package Explorer and select New/Plug-in Development. Fill in the "Fragment Content" as below: a. Create the extension bundle in order to use the extension points.AnalyticalReporting_SAP_ExtensionName b. it is highly recommended to build a development environment based on Eclipse 3.0\warfiles\we bapps\BOE\WEB-INF\eclipse\plugins. ID: com. Click Finish.3 Extension bundle recommendations Following recommendations 12 2013-11-07 . 6.AnalyticalReporting" bundle and click Finish.0. 8.

webpath. Bundle folders organization In the BOE OSGI framework. jsp. extension: means the sub-folders belong to an extension bundle. the webpath. respect the following constraints to the extension bundle folders organization. Root path The root path of the extension bundle is the folder from where the resource files are deployed.AnalyticalReporting bundle host and its fragment bundles (language packs and extensions) are merged.businessobjects. The bundle resources can be html. We will use the manifest editor to do it.About the extension bundle Extension bundle naming convention The name of the extension bundle must follow the template below in order to fit the BOE deployment. 4. The root path is web/extension/<Provider>/<Extension name>. Open the MANIFEST.MF file and select the Overview tab. Click on Extensions link in “Extension/Extension Point Content” area. The extension declaration is done in the MANIFEST. Extension bundle contribution The extension bundle is created to contribute to the webpath.4 To declare the extension bundle contribution 13 2013-11-07 . com. The space character is not recommended. The extension bundle is a webpath and it must organize its folders as following way: web extension <Provider> <Extension name> … WEB-INF lib • • • • • web: is the top folder of all webpath bundles. In order to avoid some files overriding others. Provider: the name of bundle provider.MF file. If a space is required it can be replaced by the underscore character and they must be the same as those provided by the extension attributes. Important: all URL to resources must be relative to root path.AnalyticalReporting bundle host. images files. This is non-exhaustive list of file types. The provider can be a vendor or a company name Extension name: the name should reflect the functionality provided by the extension WEB-INF/lib: the folder where you can deploy libraries. Add folders and jars to the classpath in order to be found and loaded by the class loader. Mainly jar files. JavaScript.AnalyticalReporting_<Provider>_<ExtensionName> Note: Provider and Extension name must contain only alphanumeric characters.

The extension declaration is done in the MANIFEST.AnalyticalReporting.webiApplication extension point and click Finish.custombutton.MF file and select the Overview tab. Both methods must be implemented by the created java class. The method getExtensionProperties (String lang) returns Extension Properties in required language.AnalyticalReporting_SAP_CustomButton in order to define attributes.5 To implement the IExtension interface The extension bundle must implement the IExtension interface to contribute to webpath. 14 2013-11-07 . 5. 4.businessobjects.Analytical Reporting bundle host.businessobjects. 2. Table 4-1: Attribute Property id class name provider varsion com.AnalyticalReporting bundle host.About the extension bundle The extension bundle is created to contribute to the webpath. The interface has two methods. you click on Add button to display the list of available extension points. Select the created package and right-click on it to create a java class. Select the com. Open the MANIFEST.<Extension name>.0. 3.Extension Custom Button SAP 1.webpath.custombutton com. create a package with the template: com. The package must contain alphanumeric characters and a dot character as separator.The java class must implement the IExtension interface. 1. Select the created extension com.MF file. 4. 2.0 The id attribute can take the bundle name and class attribute refers a java class that implements the interface IExtension.<Provider>.sap.sap. Click on Extensions link in “Extension/Extension Point Content” area In Extensions tab.webpath. 1.

4. Select the new folder webpath. In our use case we only create a build binary. Right-click on the jar file and select “Extract files”.About the extension bundle 4.AnalyticalRe porting_SAP_CustomButton to extract the content of the jar. build the bundle to create a deployable jar file.zip and put the folder webpath. The warpath bundles are not deployed as jar files but as sub-folders under <Tomcat DIR>\webapps\BOE\WEB-INF\eclipse\plugins folder.AnalyticalReporting_SAP_CustomButton_1. Binary build files to select META-INF bin web 3. 5. 1. Select the Extension bundle project in plug-ins list and specify in Destination tab the folder where the jar is generated. 7. 6. 2. Click the“Export deployable plug-ins and fragments” icon (top right) 4. Note: In the out-of-the-box installation. 15 2013-11-07 .0.1 About the getExtension method properties This method returns an instance of ExtensionProperties class. double-click on the build. Convert the Extension bundle jar file to a zip file. Create a zip file webpath. In the Project Explorer (or Package explorer).6 To build the extension bundle To use the Extension bundle in your deployment.properties file to open it. Select folders according to the table below and click on “Export deployable plug-ins and fragments” button (surrounded in red). The instance is provided by the Extension and it must contain the following properties: • • Title: The extension Title that is displayed in Extension Management UI in CMC application. Description: it provides a short description of the feature provided by the Extension. The Export dialog is displayed to set some options on how to export the bundle.0.5. 8.AnalyticalReporting_SAP_CustomButton in the same folder as the built jar file. Create a new folder webpath.AnalyticalReporting_SAP_CustomButton into the zip file. Tomcat 6 is used as an application server. If you select the project folder then a new folder with name “plugins” and the plugin jar is copied in this folder.

jar file for using Web Intelligence user interface extension points with the Java Applet.About the extension bundle 4. For a Windows 32-bit machine. For a Windows 64-bit machine. copy the file C:\Program Files (x86)\Java\jre7\lib\jfxrt. Right-click on a group name you want to customize and click on Customization item. b.jar file.0. When deploying the extension points for a desktop computer for use wiith the Java Applet.zip to test the Extension Points. 8. there is no specific action required. Select the "Extensions" tab to display all installed Extensions. 1. Stop Tomcat 2. Click on the" Group List" item on the left pane to display all available groups. 7. Check the Extensions you want to validate and make them available for users of the selected group. 4. copy the file C:\Program Files\Java\jre7\lib\jfxrt. Do the following: • Copy the jfxrt.jar file to the extension file.0.jar to the folder: C:\Program Files (x86)\Java\jre7\lib\ext. You must have Java 7 installed on the computer where you deploy the extension points. 6. How you do this depends on whether you are using a 32-bit or 64-bit machine: a. 16 2013-11-07 . 3. Start Tomcat. Log on to the CMC and in the home page click on the User Groups link. 5. 9. Extract all the contents of the zip file in <Tomcat DIR>\webapps\BOE\WEBINF\eclipse\plugins and also in Tomcat cache: <Tomcat DIR>\work\Catalina\local host\BOE\eclipse\plugins.AnalyticalReporting. Note: When deploying the extension points for Web Intelligence Rich Client. 4. you must create a copy of the jfxrt.jar to the folder: C:\Program Files\Java\jre7\lib\ext.7 For 64 bit Windows: To deploy the extension point bundles on the Tomcat application server How to deploy the jfxrt.8 To test the extension bundle Use the zip file webpath.webpath_SAP_ExtensionSample_1. A customization dialog page is displayed. Click on Save and close button to save your selection.

In order to see the Extension in action. Show and update Report Specification in a custom dialog box.About the extension bundle 10. To use the sample. We call this folder <Tomcat DIR>. you just deploy the provided zip on your installed BOE server build. The sample shows how to use the provided JavaScript APIs to interact with WebI DHTML application and also with WebI services.9 About the extension bundle sample You can start using the provided Extension bundle sample as a starter kit for your Extension bundle development. 4. This sample has two functionalities. • • Start and stop a periodic refresh of the document in the side panel. You must have installed an out-of-the-box build and the Tomcat installation folder is C:\Program Files (x86)\SAP BusinessObjects\Tomcat6. 17 2013-11-07 . your test User must be a member of the customized "User Group".

About the extension bundle 18 2013-11-07 .

The second parameter is optional and its value depends on the eventType. The callback function will receive 2 parameters: eventType and data. This chapter provides a description of how to use the extension points SDK to modify and setup the Web Intelligence interface to interact with Web Intelligence documents via the RESTful services API.1 addEventListener You can add an event listener to your code /** * Add event listenerbr* * @parambr* Object eventType: WebiApplication. 5. REPORT_PAGE_LOADED.1.1 About the user interface JavaScript APIs How to create extension points and use the RESTful services API to interact with Web Intelligence documents. 19 2013-11-07 .Events = { UNDO_REDO. REPORT_SELECTED REPORT_ELEMENT_SELECTED } The callback function is called when the event manager caches an event.The user interface JavaScript APIs The user interface JavaScript APIs 5.addEventListener( { eventType. DATA_REFRESHED. callback }) WebiApplication.Events * callback: Function */ WebiApplication.

You can get the list of selected report elements from the WebiApplicaMENT_SELECTED tion. /** * Display/Hide wait cursor * * @param * display Boolean. The text to display on dialog title bar */ WebiApplication.selectedReportElementsInfo attribute. code.2 setWaitCursorDisplayed Use this to display or hide a wait cursor.The user interface JavaScript APIs eventType Data UNDO_REDO No value RENo value PORT_PAGE_LOADED DATA_REFRESHED No value REPORT_SELECT.displayErrorMessage( { message. It displays a wait cursor.Report ID ED REPORT_ELENo value.3 displayErrorMessage /** * Display error message * * @param * Object message: String * code (optional): String * title (optional): String.getContext().1. Default value: true. */ WebiApplication. 5. title }) 20 2013-11-07 .1.setWaitCursorDisplayed(display) 5.

4 navigateTo /** * Navigate to a page in a target frame * * @param * Object url (relative URL): String * targetFrame: WebiApplication. DESKTOP } 5.5 getContext /** * Get application context * * @returns * Object applicationType: WebiApplication.TargetFrames */ WebiApplication. The account name of the current user.getContext() WebiApplication.1.navigateTo( { url. targetFrame }) WebiApplication.6 loadReport /** * Load report * * @param 21 2013-11-07 .1. APPLET. * selectedReportId: int * pageNumber: int * selectedReportElements: Array of selected Report Elements * pvl (Preferred Viewing Locale): String * lang (UI language): String */ applicationContext = WebiApplication.ApplicationTypes * documentName: String * currentUser: String. DIALOG_BOX } 5.TargetFrames = { SAME_FRAME.ApplicationTypes = { DHTML.1.The user interface JavaScript APIs 5.

If not specified the current report will reloaded * reportId: int.loadReport( { reportId. HELP_BUTTON } 5. APPLY_BUTTON.9 setTitle /** * Set dialog title * * @param * title String */ WebiApplication.dialogbox.1.dialogbox.sidepane.8 attachDefaultButton /** * Set default button * * @param * button WebiApplication. Default to current page */ WebiApplication. pageNumber }) 5.1.dialogbox.setTitle(title) 22 2013-11-07 . Default to current report * pageNumber: int.attachDefaultButton(button) WebiApplication. CANCEL_BUTTON.reloadPane() 5.1.dialogbox.Buttons */ WebiApplication.7 reloadPane /** * Reload pane */ WebiApplication.Buttons = { OK_BUTTON.The user interface JavaScript APIs * Object (Optional).

1.The user interface JavaScript APIs 5.Buttons * title: String. text }) 5.dialogbox.close() 5.setButtonText( { button.10 resize /** * Resize dialog box * * @param * Object width: int * height: int */ WebiApplication.Buttons * text: String */ WebiApplication. height }) 5.11 close /** * Close current dialog box */ WebiApplication.12 setButtonText /** * Set button text * * @param * Object button: WebiApplication.13 setButtonTitle /** * Set button title * * @param * Object button: WebiApplication.1.dialogbox. It is a tooltip of the button 23 2013-11-07 .1.dialogbox.dialogbox.1.dialogbox.resize( { width.

dialogbox.setButtonDisabled( { button.16 buttonEvents /** * Button Events */ WebiApplication.14 setButtonDisabled /** * Disable/Enable button * * @param * Object button: WebiApplication.dialogbox. title }) 5.1. CANCEL_CLICK } 24 2013-11-07 .Events = { OK_CLICK.15 setButtonDisplayed /** * Display/Hide button * * @param * Object button: WebiApplication.1. APPLY_CLICK.Buttons * display true (disable button).setButtonTitle( { button.dialogbox.dialogbox. If true then button is disabled else (false) the button is enabled */ WebiApplication.The user interface JavaScript APIs */ WebiApplication.dialogbox. display }) 5.setButtonDisplayed( { button. false (enable button) */ WebiApplication.Buttons * disable: Boolean. disable }) 5.1.dialogbox.

1 getParameters /** * Get document parameters * * @returns * Object containing the list of parameters */ WebiServices.refreshDocument( { 25 2013-11-07 .Using the Web Intelligence services JavaScript APIs Using the Web Intelligence services JavaScript APIs 6.document.document.getParameters() 6. You can do the folIowing: • • • • Manipulate Web Intelligence documents and reports Retrieve data from a dataprovider Retrieve a list of available universes and details of an universes Schedule documents You can also create an empty SAP Web Intelligence document and fill the document by using a Report Spercification.2 refreshDocument /** * Refresh Document * * @param * Object (optional): it contains a list of parameters with answer */ WebiServices.1.1. The Web Intelligence RESTful web service SDK relies on the BI platform RESTful web services. Use the Web Intelligence RESTful web service JavaScript APIs to interact with reports. you must do this by updating the report specification.1 About the Web Intelligence services JavaScript APIs An overview of how you can use the Web Intelligence RESTful web service JavaScript APIs to interact with reports. To edit a document. 6.

4 createReport /** * Create a report * * @param * Object (optional): it contains the report namebr * * @returns * Object containing the success message and the report ID created */ WebiServices.3 getReports /** * Get all document reportsbr * * @returns * Object containing the document reports */ WebiServices..5 updateReport /** * Update the specified report with the specified values * * @param * Object reportId: int.Using the Web Intelligence services JavaScript APIs "parameters": [{parameter:{.getReports() 6. A valid report identifier * requestBody (optional): Object * * @returns * Object containing the success message and the report ID updated */ WebiServices.updateReport( { "reportId": <REPORT_ID>.}] }) 6. "requestBody": {"report": {"name": "<REPORT_NAME>".createReport( { "report": {"name": "<REPORT_NAME>"} }) 6.document.document.1..1.1. "showDataChanges":< true|false>} } }) 26 2013-11-07 .document.

7 updateReportSpecification /** * Update the report specification * * @param * Object reportId: int.getReportMap( { "reportId": <REPORT_ID>.document.document.1.getReportSpecification( { "reportId": <REPORT_ID>.updateReportSpecification( { "reportId": <REPORT_ID> "requestBody": "<XML>" }) 6.Using the Web Intelligence services JavaScript APIs 6.1. "reference": “<REFRENCE_NODE>” }) 27 2013-11-07 .document. New report specification XML * * @returns * Object containing the success message and the report ID updated */ WebiServices.1. }) 6. A valid report identifier * requestBody: string.6 getReportSpecification /** * Get the report specification * * @param * Object that specifies the report identifier * * @returns * Report specification in XML format */WebiServices.8 getReportMap /** * Get the report map * * @param * Object reportId: a valid identifier of a report * reference: (optional) a valid reference of a map node * * @returns * Object containing the report map */ WebiServices.

document. default=96 * chartOutputFormat (optional): String. Min=75. * elementId: int. * * @returns * Object containing report element details */ WebiServices. max=9600.Using the Web Intelligence services JavaScript APIs 6. "chartOutputFormat":”<bmp|gif|jpeg|png>" }) //defaut: png 6.getReportElement( { "reportId": <REPORT_ID>. A valid identifier of an element inside the report.11 getReportElement /** * Get the report element detailsww * * @param * Object: reportId: int. Chart format.1.9 getReportOutput /** * Get report output in XML format * * @param * Object reportId: int. "dpi":<DPI_VALUE>.document.1. * * @returns * Report output in XML format */ WebiServices. " elementId ": “<ELEMENT_ID>” }) 28 2013-11-07 .1. A valid report identifier * dpi (optional): int.document.getDataProviders() 6. A valid identifier of a report inside the WebI document.getReportOutput( { "reportId": <REPORT_ID>.10 getDataProviders /** * Get document data providersbr * * @returns * Object containing the data provider list */ WebiServices.

1.getDPDetails( { "dpId": "<DP_ID>" }) 6. Data provider info * * @returns * Object containing the success message and the data provider ID updatedbr */ WebiServices. "purge": true|false". "dataSourceId": “<DATASOURCE_ID>”} } } ) 6. the datasource ID is equal to “<DATASOURCE_ID>.Using the Web Intelligence services JavaScript APIs 6.document. //purge data "purgeOptions": "prompts" //purge prompts values (optional) } }) 29 2013-11-07 . A valid data provider identifier * requestBody: Object. "requestBody": {"dataprovider": {"name": "<DP_NAME>"}}.<QUERY_NAME>” * * @returns * Object containing the success message and the data provider ID created */ WebiServices.1.document.14 updateDataProvider /** * Update a document data provider * * @param * Object dpId: int.updateDataProvider( { {"dpId": "<DP_ID>".addDataProvider( { {"dataprovider": {"name": "<DATAPROVIDER_NAME>".1.13 addDataProvider /** * Add a data provider * * @param * Object: it contains data provider name and the data source ID * In case of BEx queries.12 getDPDetails /** * Get document data provider details * * @param * Object: a valid data provider identifier * * @returns * Object containing data provider details */ WebiServices.document.

document.Using the Web Intelligence services JavaScript APIs 6.getDPNbFlows( { "dpId": "<DP_ID>" }) 30 2013-11-07 . A valid data provider identifier * requestBody: String.1.15 getDPQuerySpec /** * Get the query specification attached to a given data provider * * @param * Object: it contains a valid data provider identifier * * @returns * XML String containing the query specification attached to a data provider */ WebiServices.updateDPQuerySpec( { "dpId": "<DP_ID>".document. */ WebiServices. "requestBody": “<XML>” }) 6.document.1.1.getDPQuerySpec( { "dpId": "<DP_ID>" }) 6.16 updateDPQuerySpec /** * Update the query specification attached to a given data providerbr * * @param * Object dpId: String.17 updateDPNbFlows /** * Get number of available flows. for a given data provider * * @param * Object: it contains a valid data provider identifier * * @returns * The number of flows for the data provider specified (String value). New query specification XML * * @returns * Object containing the success message and the data provider ID updated */ WebiServices.

18 getDPFlowDetails /** * Get detail of a given flow for a given data provider * * @param * Object dpId: int. Flow index * * @returns * Details of the given flow (CSV format) */ WebiServices. A valid data provider identifier * flowId: int.document.exportReportListingMode( { "reportId":<REPORT_ID>.20 exportReportElement /** * Export an element of a report * * @param * Object reportId: int. "dpi":<DPI_VALUE>. A valid identifier of an element inside the report * datapath (optional): String. Chart format.DOa6:Austin) * dpi (optional): int.1. max=9600.1.document. * * @returns * Report output in HTML format */ WebiServices. Min=75.DObc:2004. Chart format. default=96 * chartOutputFormat (optional): String.DP1. default=96 * chartOutputFormat (optional): String. "chartOutputFormat":”<bmp|gif|jpeg|png>" //defaut: png }) 6. A valid report identifier * dpi (optional): int. It allows specifying a datapath * (ex: DP1.19 exportReportListingMode /** * Export a report in listing mode * * @param * Object reportId: int.Using the Web Intelligence services JavaScript APIs 6. * * @returns * String in HTML format */ 31 2013-11-07 . max=9600. "flowId": <FLOW_ID> }) 6.1. Min=75.getDPFlowDetails( { "dpId": "<DP_ID>". A valid report identifier * elementId: int.

22 addVariable /** * Add a variable to dictionary * * @param * Object: it contains the variable definition * * @returns * Object containing the success message and the variable ID updated */ WebiServices. "dpi":<DPI_VALUE>.addVariable( { "variable":{ "@dataType":”<Numeric|String|Date|DateTime>”.updateVariable( { "variableId":”<VARIABLE_ID>”.1. "name":”<VARIABLE_NAME>”.document. 32 2013-11-07 .exportReportElement( { "reportId":<REPORT_ID>.Using the Web Intelligence services JavaScript APIs WebiServices.1.23 updateVariable /** * Modify the definition of an existing variable from the document's expressions dictionarybr * * @param * Object variableId: String. "@qualification":”<Measure|Dimension|Attribute>”. "datapath":<DATA_PATH>.1. "elementId":<ELEMENT_ID>. "definition":”<VARIABLE_EXPRESSION>” } }) 6. A valid variable identifier * requestBody: String. "chartOutputFormat":”<bmp|gif|jpeg|png>" }) //defaut: png 6.21 getVariables /** * Get the content of a document variables dictionary * * @returns * Object containing the list of variables */ WebiServices. "@qualification":”<QUALIFICATION_VALUE>”.document.document. "requestBody": {"variable": {"@dataType":”< DATA_TYPE_VALUE>”.document.getVariables() 6. It defines the update of the variablebr * * @returns * Object containing the success message and the variable ID updatedbr */ WebiServices.

document.document. obtained from the expressions dictionary * * @returns * String contains variable definition in XML format */ WebiServices.getVariableDefinition( { "variableId":”<VARIABLE_ID> ” }) }) 6.25 deleteVariable /** * Delete a variable from the document's expressions dictionary * * @param * Object: it contains a valid variable identifier. “definition”: ”<VARIABLE_EXPRESSION>” }) 6. obtained from the expressions dictionary * * @returns * Object containing the success message and the variable ID deleted */ WebiServices.Using the Web Intelligence services JavaScript APIs "name":”<VARIABLE_NAME>”.1.deleteVariable( { "variableId":”<VARIABLE_ID>” }) 33 2013-11-07 .1.24 getVariableDefinition /** * Get the definition of a variable from the document's expressions dictionary * * @param * Object: it contains a valid variable identifier.

Using the Web Intelligence services JavaScript APIs 34 2013-11-07 .

You're Reading a Free Preview

Download
scribd
/*********** DO NOT ALTER ANYTHING BELOW THIS LINE ! ************/ var s_code=s.t();if(s_code)document.write(s_code)//-->