Versions Compared

Key

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

Report Packs

Report packs are special imports which are used to bulk load reports into an Appliance.

...

Unlike other imports which can only create new records, Report Packs are capable of updating existing reports and report slots.

Manifest Details

A report manifest is an Excel file called Manifest.xlsx. The contents of which determine what report and report slot records are created in your Appliance.

Although the manifest file looks similar to other Excel imports, many of the conventions in other imports do not apply to the manifest (as it imports considerably simpler records). In particular, one row = one record (no records span multiple rows in excel), there are no CSVs in cells, and the sheet names must match exactly.

Reports Sheet

This sheet lists each report record you want to create or update.

...

Field
Type of Data
Required
Comments
NameText, max 100YName of the report. Must be unique. Note that this is different to the Crystal Report file name ending in .rpt and any name within Crystal itself.  
IsStandardReportYes / NoNDetermines if the report is listed as a Standard or Custom report. Standard reports cannot be modified from the web interface, only via a report pack. If not specified or the column is not present, defaults to 'N' ie: a Custom report.
ReportFilenameTextYReference to the Crystal Report file in the report pack. You must reference the file name exactly and include the .rpt extension. If the file cannot be found in the report pack, an error will be logged and the report record will not be imported. 

Report Slots Sheet

This sheet lists each report slot record you want to create or update. Generally, this will reference reports in the same report pack. Referencing other custom reports is dangerous as people can change their names in the web interface (if you do this, consider setting the AssignedReportNotExist policy setting to an appropriate value).

...

Field
Type of Data
Required
Comments
TypeNamed, DataType or PageRefYCategory or type of slot. Named slots are system defined; you assign custom reports to them to replace existing Standard reports with your own. DataType references a shortened view model .NET type name. PageRef is the beginning of a web page URL. See Reporting for more information. 
NameOrPageEither a Named Slot, DataType or appropriate Page ReferenceY

Example Named Slot: Test Report or Trust Trial Balance

Example DataType: Audit.SearchViewModel

Example PageRef: /matter/edit

Note that no validation is done on DataType or PageRef values. That is, they do not have to exist or be valid in the system for the import to succeed; and no warning or error is raised if they are set incorrectly. 

You can use this to create new Named Slots, but, as the Appliance program code will not know about them, they will not appear anywhere in your Appliance,

ReportReport NameN

Reference to the Report entity as named in the CrystalReports sheet (or a previously loaded report).

This can be left blank. If it is blank and the UpdateExistingAssignedReport policy setting is Update, it will remove any reports from this slot. If you do not want to remove the report, you should not list a slot in the report pack.

Note that this is not the same as the Crystal Report file name (ending in .rpt) or the report name within the Crystal Report, but is the Name field on the Create / Edit Report page.

Policy Settings Sheet

This sheet lists policy settings for the report pack. It controls whether certain conditions are raised as errors which prevent a record from importing, or are ignored. By default, they are set to prevent accidental data loss to existing reports at the expense of being more likely to raise errors (that is, it is conservative by default).

...