BPM API for Reporting Data Source-Based Search

Definition

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.

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

Get reporting data source

Returns the reporting data source identified by the unique identifier.

ReportingDataSource getReportingDataSource(URI reportingDataSourceId) throws BPMException

Get reporting data source versions

Returns all the reporting data source versions deployed in the system and identified by the given identifier.
```
List<ReportingDataSource> getReportingDataSources(URI reportingDataSourceId) throws BPMException
               
```

Get all reporting data sources

Returns all reporting data sources deployed in the system.

Collection<ReportingDataSource> getReportingDataSources() throws BPMException

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.
```
ReportingResultSet query(URI reportingDataSourceId, String term) throws BPMException
               
```
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.
```
ReportingResultSet query(URI reportingDataSourceId, String term, int maxRecords) throws BPMException
               
```
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.
```
ReportingResultSet query(URI reportingDataSourceId, String reportingFieldName, String term) throws BPMException
               
```
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.
```
ReportingResultSet query(URI reportingDataSourceId, String reportingFieldName, String term, int maxRecords) throws BPMException
               
```
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.
```
ReportingResultSet query(URI reportingDataSourceId, Set<URI> processInstanceIds) throws BPMException
               
```
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.
```
ReportingResultSet query(URI reportingDataSourceId, URI... processInstanceIds) throws BPMException
               
```
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.
```
Set<URI> search(URI reportingDataSourceId, String term) throws BPMException
               
```
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.
```
Set<URI> search(URI reportingDataSourceId, String term, int maxHits) throws BPMException
               
```
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.
```
Set<URI> search(URI reportingDataSourceId, String reportingFieldName, String term) throws BPMException
               
```
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.
```
Set<URI> search(URI reportingDataSourceId, String reportingFieldName, String term, int maxHits) throws BPMException
               
```