Options to define a report

In order to add a report for distribution, you need to define reports. There are three options to define a report:
  • Using a named query that has been defined by the OnDemand Client
  • Using SQL statements
  • Using the Load option
The following table contains definition, requirements, benefits, and disadvantages of each option.
Option Definition Requirements Benefits Disadvantages

Defining a report using a named query

If you select this option, you are executing a public named query that was already defined by the OnDemand Client to search for reports whose application group fields are mapped to the folder fields that the public named query is defined for.

You must have defined a public named query in the OnDemand Client.

  • The search criteria can be validated immediately from the OnDemand Client to ensure that the values are valid, and the search produces documents that match the search criteria.
  • You do not need to know SQL syntax and the database fields in order to construct an SQL statement
  • A named query can retrieve documents from multiple application groups at once, depending on the named query that you use.
  • A named query can only be used with a folder, because the folder field information is saved in the named query, and not the application group fields.
  • You cannot define a public named query in the OnDemand Administrator client; instead, you must define it in the OnDemand Client.
  • If you use a named query, the complexity of the query is limited, because the OnDemand Client limits the available operators for each folder field, and operators in the search criteria can only be all AND clauses or all OR clauses.

Defining a report using SQL

If you select this option, you are constructing an SQL query to search across the entire Content Manager OnDemand database directly.

You must know SQL syntax and the database fields in order to construct an SQL statement

  • The SQL query that you construct is not limited to folder fields, and access all application group fields.
  • The SQL query can be as complex as necessary. It can include both AND clauses and OR clauses. It can also contain any other available SQL keywords that are not available through a named query.
  • The SQL query is saved with the report definition, and is always available to the report.
  • The benefit of using the SQL query over the named query is that you can search all application group fields while the named query is limited to the defined folder fields.
  • The search does not work if the SQL query is not correctly entered.

Defining a report using the Load option

If you select this option, you are creating a report with all of the documents that have been loaded for the specified application group in a specified time frame based on a load-based schedule.

If you want to construct an SQL query, you must know SQL syntax and the database fields.
Note: An SQL query is optional if you use this option. If you do not specify an SQL query, the entire load is extracted.
  • While the plain SQL query searches against the entire Content Manager OnDemand database, search by Load searches against a particular input file. Therefore, it offers the finest granularity of all the report types among all options.
  • This option allows a search against a subset of Content Manager OnDemand data that might not be isolated otherwise.