Show TOC

Background documentationBPM API for Reporting Data Source-Based Search Locate this document in the navigation structure

 

You can use the BPM API for reporting data source-based search to retrieve information about the reporting data sources deployed in the system. You can then query the information and enable the search for process instances based on the process context data reported in the reporting data sources.

For a detailed description of the BPM public APIs, see http://help.sap.com/javadocs/ (under   SAP NetWeaver 7.3 including Enhancement Package 1   Composition Environment   Process and Task Management Facade (BPM)  ).

Prerequisites

You have added the necessary dependencies to development component tc/bpem/facade/ear (public part api) in software component BPEM-FACADE. The user has the necessary UME actions assigned to his role (depending on the functionality accessed using API.)

Procedure

  1. Get reporting data source

    Returns the reporting data source identified by the unique identifier.

    Syntax Syntax

    1. ReportingDataSource getReportingDataSource(URI reportingDataSourceId) throws BPMException
    End of the code.

  2. Get reporting data source versions

    Returns all the reporting data source versions deployed in the system and identified by the given identifier.

    Syntax Syntax

    1. List<ReportingDataSource> getReportingDataSources(URI reportingDataSourceId) throws BPMException
    End of the code.

  3. Get all reporting data sources

    Returns all reporting data sources deployed in the system.

    Syntax Syntax

    1. Collection<ReportingDataSource> getReportingDataSources() throws BPMException
    End of the code.

  4. Query the reporting data source result set based on a search term

    Queries the reporting data source for all records containing at least the searched term in one of the searchable reporting fields.

    Syntax Syntax

    1. ReportingResultSet query(URI reportingDataSourceId, String term) throws BPMException
    End of the code.

  5. Query the reporting data source result set based on a search term to a specified limit

    Queries the given reporting data source for all records containing at least the searched term in one of the searchable reporting fields. The query stops as soon as the maximum number of records to return is reached.

    Syntax Syntax

    1. ReportingResultSet query(URI reportingDataSourceId, String term, int maxRecords) throws BPMException
    End of the code.

  6. Query the reporting data source result set based on a search term in the reporting field

    Queries the given reporting data source for all records that the value of the designated reporting field matches the term to search for.

    Syntax Syntax

    1. ReportingResultSet query(URI reportingDataSourceId, String reportingFieldName, String term) throws BPMException
    End of the code.

  7. Query the reporting data source result set based on a search term in the reporting field to a specified limit

    Queries the given reporting data source for all records that the value of the designated reporting field matches the term to search for.

    Syntax Syntax

    1. ReportingResultSet query(URI reportingDataSourceId, String reportingFieldName, String term, int maxRecords) throws BPMException
    End of the code.

  8. Query the reporting data source result set based on a set of process instances

    Returns all records created in the given reporting data source by the given process instances.

    Syntax Syntax

    1. ReportingResultSet query(URI reportingDataSourceId, Set<URI> processInstanceIds) throws BPMException
    End of the code.

  9. Query the reporting data source result set based on the process instances

    Returns all records created in the given reporting data source by the given process instances.

    Syntax Syntax

    1. ReportingResultSet query(URI reportingDataSourceId, URI... processInstanceIds) throws BPMException
    End of the code.

  10. Search process instances based on a search term

    Searches for process instances matching the searched term in at least one reporting field of the given reporting data source.

    Syntax Syntax

    1. Set<URI> search(URI reportingDataSourceId, String term) throws BPMException
    End of the code.

  11. Search process instances based on a search term to a specified limit

    Searches for process instances matching the searched term in at least one reporting field of the given reporting data source. The search stops as soon as the maximum number of process instances to return is reached.

    Syntax Syntax

    1. Set<URI> search(URI reportingDataSourceId, String term, int maxHits) throws BPMException
    End of the code.

  12. Search process instances based on a search term in the reporting field

    Searches for process instances matching the searched term in the given reporting field.

    Syntax Syntax

    1. Set<URI> search(URI reportingDataSourceId, String reportingFieldName, String term) throws BPMException
    End of the code.

  13. Search process instances based on a search term in the reporting field to a specified limit

    Searches for process instances matching the searched term in the given reporting field. The search stops as soon as the maximum number of process instances to return is reached.

    Syntax Syntax

    1. Set<URI> search(URI reportingDataSourceId, String reportingFieldName, String term, int maxHits) throws BPMException
    End of the code.