Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The forDocType element is repeatable, so the above report could easily be generalized to a “Related Objects” report runnable from any procedure record type listed in forDocTypes.

Each forDocType value should be the objectName property assigned to the given record type in the UI layer, which corresponds to the NUXEO_DOCTYPE constant value assigned in the Services layer.

UI objectName values can be found in the cspace-ui.js repository (or relevant profile or extension repositories) under:

src/plugins/recordTypes/{rectype}/serviceConfig.js

NUXEO_DOCTYPE can be found in the services repository under:

...

Where to find the correct docType values

Registered docType values will be categorized into service groups, available via the /servicegroups REST-ful API service for the given CollectionSpace instance.

Examples for the Anthro sandbox site:

The docType value for Objects is CollectionObject (Check /servicegroups/object for your instance to verify.)

supportsSingleDoc element

...

supportsOutputMIMEList allows you to constrain the output formats available to selection to the ones you specify. Multiple outputMime elements can be nested inside this element.

The top-level, non-nested outputMIME element sets CSV as the default output format.

The list of currently-supported report output MIME types can be found in the default reportMimeTypes option list configuration.

The above config looks redundant: why specify a preferred output format when there is only one output format? Indeed, the report can be nested inside this element.

The same-level outputMIME element selects CSV as the preferred output format.

TODO: Test whether it is necessary to specify the selected outputMIME if only one format is supported.run without specifying the default output format. However, the non-nested/top-level outputMIME value is used to populate the Default output format in the Tools > Reports screen, so it is best to provide this information.

...

Preparing reports for running from within CollectionSpace

...