Report Details: TEMPLATE
Report Name: Unique Report Name 1
Description / Note: Description of what the report will contain, how it will differ depending on the mode, and what it will look like (e.g. a formatted doc, a list, etc.). This description should be end-user readable.
Modes - choose one or more of the below, and describe the expected behavior in each mode
- SINGLE: Single CSID selected by user
- LIST: List of one or more CSIDs
- GROUP: Single CSID of group record, run on group and its related records
- NOCONTEXT: No CSID given, run on all records or subset decided with no input from user
Parameters: If the report accepts any parameters, e.g. a date range, what those parameters are, and if they are specific to a mode.
Output / MIME type: Default to any, note here if the report should default instead to a specific output type, e.g. CSV
Example: Include an example of the report that shows it properly formatted with field names, and properly formatted with sample data.
Wherever possible, try to use the CSpace Sample Data Set to populate your sample reports. If the Sample Data Set needs to updated with specific fields or relationships, let us know at talk@lists.collectionspace.org.
Fields: List in a table below all fields shown by the report.
Field Name (UI) | Field Name (Schema) | Procedure |
---|---|---|
Field Name 1 | fieldNameOne | Procedure 1 |
Field Name 2 | fieldNameTwo | Procedure 2 |
Etc. |