Cover pages

Cover pages contain meta data for the document in question, such as case number, document title, contacts. Cover pages can be generated with the report. They can also be included in the output file when the report document is converted and the report data contains information about documents.

You can set up a report to include a cover page for every document in the report and you can create a report that only consists of cover pages from each document by not including any underlying documents in the report, effectively creating an overview document of the underlying reports.

The option to include cover pages and/or document contents in the report must be specified as the following parameters:

  • IncludeDocumentCoverPage: Generate a cover page for the report (True/False)
  • IncludeDocumentContents: Generate report contents (True/False)

To only generate the cover page

  • IncludeDocumentCoverPage: True
  • IncludeDocumentContents: False

To generate the report without a cover page

  • IncludeDocumentCoverPage: False
  • IncludeDocumentContents: True

To generate the report with a cover page

  • IncludeDocumentCoverPage: True
  • IncludeDocumentContents: True

Note: The JSON file for each specific report must be edited in order to generate a cover page for the report.

Example: IncludeDocumentCoverPage and IncludeDocumentContents in the Report JSON:

            Header 
		Content-type: application/json
		OData: http://db01/OData
		Accept: application/pdf
Body
	{
		Parameters: { FileKey: ‘141’, RecordKeys: [‘20’, ‘18’] },
		IncludeDocumentCoverPage: true,
		IncludeDocumentContents: true
	}

If the JSON report contains a specific $Select clause for the underlying table, you must specifically include the RecordKey and State_Value fields in the underlying table in the $Select statement of the report Odata queries section in order to create cover pages and /or include underlying document contents in the report.

In the report JSON example, Agenda report (See Also section below), the $Select statement in the Odata query is specified directly and the query must specifically contain the RecordKey and State_Value fields.

"#Query": "?$expand=Text&$select=Title,Text/Text",
"Records": [
	{
		"#Query": "?$expand=Record&$select=Record/RecordKey,Record/Title,
		Record/RecordType_Summary,Record/Extension,Record/State_Value"
	}

If the JSON report does not contain a specific $Select clause for the underlying table, all fields are by default selected, including the RecordKey and State_Value fields and you do not need to specifically include the RecordKey and State_Value fields.

In the Report JSON example, Case report (See Also section below), the $Select statement in the Odata query is not needed and not specified. Therefore, the query does not specify the RecordKey and State_Value fields and all fields, including the RecordKey and State_Value fields, are selected by default. 

                    ...
   "FileRecords": [
	{
	   "#Query": "('@RecordKeys')?$expand=Parties/Name&$filter=Pax ne 'A'",
	   "SupplementaryDocuments": [
		{
		"#Query": "?$expand=Parties/Name"
		}...