Configuring Report Types


Report types define what an individual ”record” is in a report, for example, a document, a product, or a specific instance of a workflow. The report type also affects what fields are available as report columns, filters, etc. When a user creates a new report, the first step is selecting a report type for it.

Vault includes standard, default report types, which are not editable, but also allows you to create custom report types. Custom report types are the only way to create certain kinds of reports, including a report that displays only object data records without including documents, or a report that displays details for custom objects.

Accessing Report Type Administration

From Admin > Configuration > Report Types, you can create and manage customized report types. Note that standard report types are not editable and do not appear in this page.

How to Add Report Types

To create a new report type:

  1. From the Report Types page, click Create.
  2. Optional: Enter a Label. Users see this label when creating new reports. If you leave this blank, Vault will automatically generate a label based on the selected reporting objects.
  3. Optional: Enter a Name. This is the value that developers can use to access the report type through the API. If you leave this blank, Vault automatically generates it based on the selected reporting objects.
  4. Set the Status. To keep the report type hidden from users, set it to “Disabled.” To make the report type available to users, set it to “Active.”
  5. Optional: Enter a Description. This value is only visible in the Report Types page in Admin > Configuration.
  6. In the Report Configuration area, select a Primary Reporting Object.
  7. Optional: To add additional reporting objects, click Add Related Object and select a related reporting object. 
  8. Optional: Click the Add Related Object button again to add more objects to your report type. The Up and Down arrows in the picklist indicate whether an object is an up or down object to the primary reporting object.
  9. Click Save. If the status is “Active,” the report type is available immediately to users.

How to Edit Report Types

Note that only custom report types are editable. Standard report types are system-managed and not editable. Custom report types that are in use by at least one report are not editable.

To edit an existing report type:

  1. From the Report Types page, click on the type.
  2. Click Edit.
  3. Make any necessary changes.
  4. Click Save.

How to Disable and Delete Report Types

Deleting a report type permanently removes it from the vault. This option is only available for custom report types that are not selected for a report. If a report type is in use, you cannot delete it.

To prevent users from creating new reports using the report type, you can set the Status field to “Disabled.” Setting the disabled report type back to “Active” makes it available again.

Many-to-Many Relationship Reporting

Complex and simple relationships appear differently to users in reports. If the relationship is complex, the relational object and its fields appear. If the relationship is simple, the relational object does not appear in reports. 

Reports with Multiple Up or Down Objects

You can configure report types that include multiple up or down objects, such as a Query with Subject and Query Binding and Query Message type report. In that report type, Query is the primary reporting object, with Subject as an up object, and Query Binding and Query Message as down objects. 

An “up” object is an object related through a reference or parent relationship to the primary reporting object. A “down” object is a child object, simple join object, an object related through a reference relationship, or related documents. See About Object Relationships for details.

By default, you can select up to five (5) additional reporting objects. Contact Veeva Support to change this limit.


Last Updated: