How to import a WSDL Data Source and Prepare it for Use in Framework Manager

Transcription

1 Tip or Technique How to import a WSDL Data Source and Prepare it for Use in Framework Manager Product(s): Composite Software Area of Interest: Infrastructure

2 Manager 2 Copyright Copyright 2008 Cognos ULC (formerly Cognos Incorporated). Cognos ULC is an IBM Company. While every attempt has been made to ensure that the information in this document is accurate and complete, some typographical errors or technical inaccuracies may exist. Cognos does not accept responsibility for any kind of loss resulting from the use of information contained in this document. This document shows the publication date. The information contained in this document is subject to change without notice. Any improvements or changes to the information contained in this document will be documented in subsequent editions. This document contains proprietary information of Cognos. All rights are reserved. No part of this document may be copied, photocopied, reproduced, stored in a retrieval system, transmitted in any form or by any means, or translated into another language without the prior written consent of Cognos. Cognos and the Cognos logo are trademarks of Cognos ULC (formerly Cognos Incorporated) in the United States and/or other countries. IBM and the IBM logo are trademarks of International Business Machines Corporation in the United States, or other countries, or both. All other names are trademarks or registered trademarks of their respective companies. Information about Cognos products can be found at This document is maintained by the Best Practices, Product and Technology team. You can send comments, suggestions, and additions to cscogpp@ca.ibm.com.

3 Manager 3 Contents 1 INTRODUCTION PURPOSE APPLICABILITY EXCLUSIONS AND EXCEPTIONS IMPORTING THE DATA SOURCE TRANSFORMING THE WSDL RESPONSE INTO A USABLE FORMAT PREPARING THE SOAP ENVELOPE VIA A PARAMETERIZED QUERY PUBLISHING TO THE COMPOSITE DATA SERVICES PASSING VALUES VIA THE VIRTUAL COLUMN WITHIN FRAMEWORK MANAGER TROUBLESHOOTING PROBLEM 1: PROBLEM 2: PROBLEM 3:... 18

4 Manager 4 1 Introduction 1.1 Purpose This document provides step by step instructions for importing WSDL (Web Services Description Language) as a data source within Composite Studio. The document also provides the steps for preparing the WSDL data for consumption via Framework Manager. 1.2 Applicability The techniques and product behaviours outlined in this document apply to: Composite Software Cognos Framework Manager 1.3 Exclusions and Exceptions This import method and its required settings may change in future releases.

5 Manager 5 2 Importing the Data Source The WSDL data source used in this example converts a numeric Celsius value to Fahrenheit. The service will take one input parameter and return the results in tabular form. The WSDL being used in this example is: 1. Within Composite Studio, create a new data source by right mouse clicking on the Shared folder and select New Data Source. 2. Within the Add Physical Data Source screen. Select the WSDL data source driver and click Next. 3. For this example, fill in the following information and click Next. Name: TemperatureConversion URL: o?wsdl

6 Manager 6 4. Traverse the tree and select CelsiusToFahrenheit. Once completed, press Finish to import the data source. Composite Studio should now display the imported CelsiusToFahrenheit WSDL function.

7 Manager 7 3 Transforming the WSDL Response into a Usable Format If the imported WSDL function is wrapped in a parameterized query prior to performing a transformation. Any output generated by the function will be in the form of a SOAP response. These SOAP responses will be treated by Framework Manager as one long string, which may or may not be useful. For the purpose of this example, a transformation will be used to transform the response into a tabular format. 1. To create a new transformation, right mouse click on the Shared folder and select New Transformation.

8 Manager 8 2. Within the Create Transformation Screen, select the Basic to Tabular Mapping and click on the Next button. 3. Select CelsiusToFahrenheit, and then give the transformation a name. For this example the transformation will be called My_CelsiusToFahrenheit. Once completed click Finish. The My_CelsiusToFahrenheit transformation should now be visible in the resource tree on the left hand side.

9 Manager 9 4 Preparing the SOAP envelope via a Parameterized Query The newly created transformation expects the input parameter wrapped in a SOAP message. Although the Composite Studio does this on the fly when testing the transformation, Framework Manager does not. If the transformation is imported into Framework Manager as is, Framework Manager will map the WSDL function input type to a binary object. This means that in order for the WSDL function to run successfully the user would be expected to enter the entire SOAP request. In order to map convert the input parameter from a SOAP request to a decimal. The transformation will need to be wrapped in a parameterized query. To do this: 1. Right mouse click on the Shared folder and select New Parameterized Query. 2. Give the parameterized query a name and click OK. For the purpose of this example the name will be My_ParamQuery.

10 Manager Select the My_CelsiusToFahrenheit transformation and drag it into the right hand pane. The drag and drop will automatically display the following screen.

11 Manager Map the input parameters to a Query Parameters by: Expanding the folder structure, clicking on the input parameter, switching the Value from Null to Query Parameter, and typing in a name. In this example the parameter name will be Parameter1. 6. Once completed, press the OK to commit the change. The parameterized query should now be visible in the left hand resource tree. The properties of the newly created parameterized query should also be displayed within the right hand pane.

12 Manager Save the parameterized query by clicking the disk icon from the toolbar. 8. Ensure the parameterized query runs by pressing the F9 key. If an error is displayed, check the error reference with those in the Troubleshooting section of this document. 5 Publishing to the Composite Data Services In order for the parameterized query to be visible to the Composite ODBC driver, the query will need to be published under a catalog and schema within the Composite Data Services. 1. Right mouse click on the My_ParamQuery object and select publish. 2. Within the Publish dialog box select or Create the appropriate Composite Data Service Database, Catalog and Schema and click OK.

13 Manager 13 The Parameterized query can now be utilized within Framework Manager via the Composite ODBC driver. 6 Passing Values via the Virtual Column within Framework Manager 1. Import the My_ParamQuery procedure object into Framework manager via the Metadata Wizard. 2. Double click on the My_ParamQuery object to display the query subject definition. 3. Within query subject definition dialog box, select the ellipses for the value column. 4. Within the Edit Argument dialog box type?parameter1? within the value section.

14 Manager Click OK to commit the changes. 6. Once completed, test the query subject. Notice that a prompt value is required to pass a value to the underlying WSDL. 7 Troubleshooting 7.1 Problem 1: Newly published parameterized queries, stored procedures or transformations do not display as importable object within Framework Manager Metadata Wizard.

15 Manager 15 Solution: In order for these object to show up within the Metadata Wizard, at least 1 table or view has to be published to the same Composite Data Service. 7.2 Problem 2: When testing a parameterized query in Composite Studio the following error is displayed after entering the parameter values. Solution: Ensure that the SOAP Envelope embedded in the SQL is correctly ended. To do this: 1. Within the left hand resource tree, double click on the parameterized query to display the properties within the right hand pane.

16 Manager Click on the SQL Script tab on the bottom of the screen.

17 Manager Examine the SOAP envelope. '<soap-env:envelope xmlns:soap-env=" xmlns:xs=" xmlns:xsi=" xmlns:ns1=" parameter1 '</ns1:ncelcius></ns1:celciustofahrenheit></soapenv:body></soap-env:envelope' 4. Notice that the end tag is missing the >. Add the > character and save the parameterized query. Below is the correct SOAP envelope. '<soap-env:envelope xmlns:soap-env=" xmlns:xs=" xmlns:xsi=" xmlns:ns1=" parameter1 '</ns1:ncelcius></ns1:celciustofahrenheit></soapenv:body></soap-env:envelope>'

18 Manager Save the changes to the query and perform another test by pressing F9 within the Composite Studio. 7.3 Problem 3: When testing a parameterized query in Composite Studio the following error is displayed after entering the parameter values. Solution: Ensure that the SOAP Envelope embedded in the SQL is correctly ended. To do this: 1. Within the left hand resource tree, double click on the parameterized query to display the properties within the right hand pane. 2. Click on the SQL Script tab on the bottom of the screen.

19 Manager Examine the SOAP envelope. <soap-env:envelope xmlns:soap-env=" xmlns:xs=" xmlns:xsi=" xmlns:ns1=" CAST(XMLTEXT(parameter1) AS VARCHAR( )) '</ns1:nfahrenheit></ns1:fahrenheittocelcius></soap-env:body></soapenv:envelope>' 4. Replace the text CAST(XMLTEXT(parameter1) AS VARCHAR( )) with (parameter1). Below is the correct SOAP envelope. <soap-env:envelope xmlns:soap-env=" xmlns:xs=" xmlns:xsi=" xmlns:ns1=" (parameter1) '</ns1:nfahrenheit></ns1:fahrenheittocelcius></soapenv:body></soap-env:envelope>'

20 Manager Save the changes to the query and perform another test by pressing F9 within the Composite Studio.