Creating a Data Set Using a Web Service

BI Publisher supports data sets that use simple and complex Web service data sources to return valid XML data.

To include parameters for Web service methods, it is recommended that you define the parameters first, so that the methods are available for selection when setting up the data source. See Adding Parameters and Lists of Values.

Multiple parameters are supported. Ensure the method name is correct and the order of the parameters matches the order in the method. To call a method in the Web service that accepts two parameters, you must map two parameters defined in the report to the two parameters in the method. Note that only parameters of simple type are supported, for example, string and integer.

Note:

Only document/literal Web services are supported.

To specify a parameter, click Add Parameter and select the parameter from the drop-down list.

Note:

The parameters must be set up in the Parameters section of the report definition. For more information, see Adding Parameters and Lists of Values.

Web Service Data Source Options

Web service data sources can be set up on the Administration page or as a data source.

  • On the Administration page

    Connections to Web service data sources can be set up on the Administration page and then used in multiple data models. For more information, see Setting Up a Connection to a Web Service in Administrator's Guide for Oracle Business Intelligence Publisher.

  • As a private data source

    You can also set up a private connection accessible only to you. See Managing Private Data Sources for information about private data source connections.

You must set up the connection before you create the data model.

BI Publisher supports data sets that use simple and complex Web service data sources to return valid XML data:

Creating a Data Set Using a Simple Web Service

If you are not familiar with the available methods and parameters in the Web service to call, you can open the URL in a browser to view them.

  1. Click the New Data Set toolbar button, and then select Web Service.
  2. Enter the data set name.
  3. Select the Data Source.

    The WSDL URL, Web Service, and Method fields are automatically populated from the Web service data source.

  4. Enter the Method.
  5. Click OK.
  6. Define the parameters to make them available to the Web service data set as follows:

    • Select Parameters on the Data Model pane, click Create New Parameter, and then enter the following attributes:

      • Name - Enter an internal identifier for the parameter, for example, Symbol.

      • Data Type - Select String.

      • Default Value - Enter a default for the parameter, for example, ORCL.

      • Parameter Type - Select Text.

      • Row Placement - Select a row placement value. The default is 1.

    • In the New_Parameter_1:Type: Text region, enter the following attributes:

    • (Optional) Select the following parameter options:

      • Text field contains comma-separated values - Enables the user to enter multiple comma-delimited values for this parameter.

      • Refresh other parameters on change - Performs a partial page refresh to refresh any other parameters whose values are dependent on the value of this one.

  7. Return to the Web service data set and add the parameter as follows:
  8. Click Save.

Creating a Data Set Using a Complex Web Service

BI Publisher supports data sets that use complex Web service data sources to return valid XML data. A complex Web service type internally uses soapRequest / soapEnvelope to pass the parameter values to the destination host.

When a data set uses a complex Web service as a data source, the data model editor displays the WSDL URL, available Web service, and operations associated with the complex Web service. For each selected operation, the data model editor displays the structure of the required input parameters. If you choose Show optional parameters, all optional parameters as displayed as well.

If you are not familiar with the available methods and parameters in the Web service, open the WSDL URL in a browser to view them.

  1. Enter the data set information as follows:

    • Enter the data set name.

    • Select the data source. The WSDL URL and Web service fields are automatically populated from the complex Web service data source.

    • Select the Method.

      The Methods available for selection are based on the complex Web service data source. When you select a method, the Parameters are displayed. To view optional parameters, select Show optional parameters.

    • Response Data XPath - If the start of the XML data for the report is deeply embedded in the response XML generated by the Web service request, use this field to specify the path to the data to use in the BI PublisherOracle BI Publisher report.

  2. Define the parameter to make it available to the Web service data set as follows:

    • Select Parameters on the Report definition pane, and then click New to create a parameter.

    • Define the following parameter attributes:

      • Name - Enter an internal identifier for the parameter.

      • Data Type - Select the appropriate data type for the parameter.

      • Default Value - Enter a default value for the parameter.

      • Parameter Type - Select the appropriate parameter type.

      • Display label - Enter the label you want displayed for your parameter.

      • Text Field Size - Enter the size for the text entry field in characters.

  3. Return to the Web Service data set and add the parameter.
  4. To test the Web service, see Testing Data Models and Generating Sample Data.

Additional Information on Web Service Data Sets

There is no metadata available from Web service data sets, therefore grouping and linking are not supported.