Reports define what data is extracted from the model and how it's presented. Each report is built around three decisions: a Format (CSV, PDF, or ZPL), an Item Type (Part, Assembly, Package, etc.), and optionally a Filter. Once saved, a report is made available to specific viewers, dashboards, or project roles. Select a Template for a report when the output requires additional elements such as images, isometric views, and QR codes formatted into a printable PDF.

1 Stratus Academy Course Video
2 Report
- 2.1 Report Options
- 2.2 Report Fields
- 2.3 Project Role Permission Settings for Reports
- 2.4 Reportable Stratus Fields (Properties)
- 2.5 Hiding Report Columns
- 2.6 Clone a Report
- 2.7 Create Master / Sub Reports
- 2.8 Report Validation
- 2.9 Assembly Filter Impact on a Part Report
3 Configuration Examples
4 Other Report Videos
- 4.1 10-10-19 Implementation Webinar - Trade Specific Reporting (32:31)
- 4.2 05-16-19 Implementation Webinar - Pipe Reports (19:54)

Stratus Academy Course Video

To take the Reports course, log in to Stratus Academy and locate the course ADM-507: Admin 2 - Reports.

Report

Report Options

To create a new report, click the New Report button. A new row will display in the list of reports.
Report Options
1. Name (Required) - Enter a report name. When selecting the report to be run, this is the name that will display. Use a name that is descriptive yet short.
  Note: BIM 360 does not allow special characters to be used when generating files.
2. Format - A report can use one of the following formats.
  1. CSV - Use this format when tabular data is needed.
  2. PDF - Use this format when multiple data types (data fields, images, isometric views, QR codes, etc.) and other formatting options need to be brought together.
  3. ZPL - Use this format if for creating a report that will be printed on a ZPL compatible printer. See the Label Printing for Zebra (ZPL) Compatible Printers article for more information. ZPL format reports will display on any checked Viewer (Assembly, Model, Package). For example, the Package ZPL report will be available in the Models > Viewer under Actions > Reports.
3. Item Type - A report can utilize one of the following Item Types.
  1. Assembly (Assemblies Dashboard) - Use this item type when the report will display data about assemblies.
    1. Report Examples include - Estimated Hours, Spool Label (when combined with the ZPL format).
  2. BOM - Use this item type when the report is targeted to display in the report drop-down on the Package's BOM tab. The Report Fields will be restricted to those available for the BOM Template Type. Once saved, the report will display on the Packages Dashboard under Report. See the Package BOM article for more information.
  3. Container (Containers Dashboard) - Use this item type when the report will be used for a Container Label Report which will display information about the container on a label.
    1. When a Container Item Type is combined with a ZPL Format, the resulting report can be used as a Label Template.
  4. Container Details - Use this item type for a container's contents. By creating a Template, a specific report format for each type of container can be chosen. The Container Details Item Type is only available on the Containers page in the Report drop-down. See the Containers Assign article for more information.
  5. Invoice - Only use this type if the company has been configured to use the Purchasing and Supplier options.
  6. Master Report - A Master Report can be used to combine multiple sub-reports into a single report.
    1. Report Examples: Master = Pipe BOM; Sub-Reports = Pipe Length, Fittings, Valves
    2. See below for a Fab Packet example.
    3. If a Sub-report of a Master Report often contains no data, the sub-report can be omitted from the report results when Sub-Reports are configured.
  7. Package (Packages Dashboard) - Use this item type when the report is targeted to display in the report drop-down on the Package's Report tab. Use this item type when the report will display data about packages. This report time is most often used in conjunction with the Packages Dashboard checkbox to display the report as a custom report on the Packages Dashboard.
    1. When a Package Item Type is combined with a CSV Format and the Package Dashboard is checked, the resulting report can be used as a custom Packages Dashboard report.
    2. Report Examples: System Package
  8. Package Details - Use this item type when the report is targeted to display in the report drop-down on the Package's Report tab. See the Package's Stratus Sheet article for more information.
    1. Report Examples: Package Sheet
  9. Part (Assembly Details) - The Part Item Type is the most frequently used Report Item Type. It is used when the report will display data about parts. It is often combined with a Part Filter.
    1. When a Part Item Type is combined with a PDF Format, the resulting report can be used on a Template.
    2. When a Part Item Type is combined with a CSV Format, the resulting report can be used on the Assembly Viewer or as a Cut List Import. Additionally, if the report is targeted to be displayed on the Assemblies > Viewer, an Assembly Filter can further refine the list of parts.
    3. When a Part Item Type is combined with a ZPL Format, the resulting report can be used as a Label Template.
    4. Report Examples include BOM, Cut List, Pipe, Duct, Conduit, Length, Fittings, Hangers (Rod, Strut), Galvanized Supports, Weld Diameter, Equipment.
  10. Purchasing - Only use this type if the company has been configured to use the Purchasing and Supplier options.
  11. Report and Template Configuration Grid - Below, the Reports column lists the path of where a report can display. The Report Settings section (blue) shows the settings (Admin > Company > Reports) needed to display the report. The Template Types section (green) shows the areas a template can be used and setting requirements for the template to display. For a larger display, click the image.
4. Assembly Filter
  1. Assemblies Filter (Default Parts Report) - Under Assemblies > Viewer > Parts, the default Report selected on the assembly's first page load, will compare the parts in the assembly with all relevant Assembly Filters. The Assembly Filter that matches the most parts will be selected as the default Report. Note: If a different report for an assembly is selected, the system will select that same report the next time it is viewed on that particular assembly. Both of these options are described in the Default Assembly Report article.
  2. Default Assembly Report in Package Categories Alternative - Under Admin > Company > Package Categories, the Default Assembly Report can be used to set the default assembly report based for the Package Category. Both of these options are described in the Default Assembly Report article.
5. Part Filter - If the report needs to filter part data, select the filter. See Filters (Admin) for more information.
6. Assembly Viewer - Check this option if the report needs to display in the Assemblies > Viewer.
7. Model Viewer - Check this option if the report needs to display in the Models > Viewer.
8. Package Viewer - Check this option if the report needs to display in the Packages > Viewer. The Package Viewer checkbox column is only available to the following Report Item Types:
  - Part
  - Assembly
  - Package
  - Package Details (New - Default Checked)
  - Master
9. Assemblies Dashboard - Check this option when the report is targeted to display in the report drop-down on the Assemblies > Dashboard tab.
10. Containers Dashboard - Check this option when the report is targeted to display in the report drop-down on the Containers > Dashboard tab.
11. Packages Dashboard - Check this option when the report is targeted to display in the report drop-down on the Packages > Dashboard tab. See the Package Dashboard article for more information.
12. Cut List Import - Check this option when the report needs to display cut lists. When checked, the report will display on the Import Cut Lists dialog. See the Import Cut List - Select the report that contains the cut lists section of the Package Cut Lists article.
13. Label Template - If the report format is ZPL, then the Label Template will be active. The Label Template can be edited. See the Label Printing for Zebra (ZPL) Compatible Printers article for more information.
14. Template - If reports will be embedded inside a template, select a template. See the Templates (Admin) article for more information.
15. Notes - Add notes to describe the purpose of the report.
16. Save, Cancel, or Delete
17. Clone Row - Clone a report by clicking the Clone Row button.
After the Save button is clicked the following message will inform you that only the Project Admin project role can access the report by default. Give permission to the report to other project roles under Admin > Company > Project Roles.
Note: In order to enforce property rules where specific properties can only be used with specific Item Types, editing the Item Type after a Report is created is prevented. Hover over an Item Type that cannot be edited and the following message will display.

Report Fields

Once a report is defined, add the Fields (properties) that will display on the report. Report Fields (properties) can include:

Revit and/or AutoCAD database fields from all models published to the company.
Stratus default fields for parts, assemblies, and packages (Ex. Stratus.Part.CutLength or Stratus Package).
Stratus Fields created under Admin > Company > Fields (Ex. Stratus.Field.Pipe Length).
Ancillary content (Ex. Stratus.Ancillary.Type).

To configure a Report Field (property) the following options are available:

"#" - The number column indicates the order in which the report field columns display from left to right.
The Move Up and Move Down arrows change the order of the report fields in the grid.
Property Name - A drop-down selection box which displays all available report fields. Enter characters to alphabetically jump in the list. Click to select a field.
Header - By default when Empty, the Property Name will display as the column header for the report field. Enter a different value as needed.
Sort Index - Set the display sort order by report field.
Merge Like Values - Set Merge Like Values to Yes when a total quantity for like values such as 6" Diameter pipe is needed.
For a Report where:
1. Item Type = Part
2. Report Field has Merge Like Values set to Yes. Note: If any Report Field Property is set to Yes for Merge Like Values, then all other properties will get a count (n) added as well.
3. The following business rules will be applied:
  1. If the quantity counts of a report (the Quantity checkbox) are enabled
    1. Only show the “(n)” count on merged data in cells when n does not equal the quantity column value in the report.
    2. When n = 1, show “(1)”
4. As a result:
  1. Assemblies > Viewer where all merged parts in the Quantity are the same.
5. Assemblies > Viewer where merged parts in the Quantity are different, the (n) value will display.
6. Packages > Viewer > Items where (n) value displays.
Show Quantity - Show Quantity is enabled when Merge Like Values is set to Yes. When set to Yes, the values will display in the report.
Aggregate
1. None - The None option is selected by default and will not apply a sum or average.
2. The Sum option will add a total for numeric values at the bottom of the report. If Merge Like Values is being used, Total Values will provide sub-totals for each merged row.
3. For reports where the Packages Dashboard is checked, Numeric columns (Integer, Decimal, and all the Feet Inch variations) can be totaled when Sum option is selected. The Format and Precision can also be controlled.
4. Average - The Average option will average the numeric values.
Format - Select the display Format type for the report field.
1. String - A String data format is a sequence of characters, either as a literal constant or as some kind of variable.
2. Integer - An Integer data format stores whole numbers, positive or negative.
3. Decimal - A Decimal data format stores decimal numbers, which include a fractional part. The precision column controls the number of decimal places.
4. FeetInch - A FeetInch data format displays the value as feet and decimal inches (Ex. 7'-4"). The precision column controls the decimal.
5. FeetInchFraction - A FeetInchFraction data format displays the value as feet and fractional inches (Ex. 7'-3-5/8"). The precision column controls the fraction.
6. Inch - An Inch data format displays the value as inches and decimal inches (Ex. 88"). The precision column controls the decimal.
7. InchFraction - An InchFraction data format displays the value as inches and fractional inches (Ex. 87-5/8"). The precision column controls the fraction.
8. Date - The Date data format stores the value as a date.
9. Boolean - A Boolean data format can store one of two values: true or false.
10. QRCode - The QRCode format is used to render the value of the property as a QR code in the Stratus UI (Ex. Packages > Items > Parts table) and in generated PDFs (Ex. Stratus Sheet, Attachment). Note: When the report type is CSV, the value of the property will still be rendered as a string.
Precision - Precision is used in relation to the selected Report Field Format (FeetInchFraction, InchFraction, Inch, FeetInch, and Decimal).
1. Decimal - If the Format is set to Decimal, specify the Decimal Precision and the number of decimals after the point (Ex. 1,2,3,4 decimals). Note: If the Report Field is a custom Stratus Field and it includes Possible Values for a drop-down list, the precision must be set to include decimals in the Possible Value list.
2. Below are display examples of 2 different pipe lengths and common precision values for each format type. For a larger display, click the image.
AutoCAD Multiplier - The AutoCAD Multiplier equals Pi when finding the total circumference of the pipe using the outside diameter.
Revit Multiplier - If the total circumference of the pipe is needed, take the outside diameter of the pipe x Pi which gives the result in linear weld inches. When dealing with Revit, because their units are in feet, multiply 12 x Pi.
Prefix - Add text to the beginning of the data in this column.
Suffix - Add text at the end of the data in this column. For example, include the word inches in the output, or lbs for total weight.
Possible Values - A read-only display of possible values for the field.
Hidden - When checked, the report can use the data of the report field for things like grouping and sorting, but the column will not display in generated reports.
Delete - Delete the Report Fields from the report.

Project Role Permission Settings for Reports

Each Report is independently permissioned for a project role. See the Project Roles article for more information. When configuring project roles for a report, each report can be selectively visible or hidden per role.

In the following example, those assigned the project role of Administrator or Project Manager can run the highlighted reports. The other reports do not appear as choices for them. NOTE: The Project Admin role always has all reports available and this cannot be overridden.
When a user whose project role is Administrator or Project Manager attempts to run a report, their options are limited to those reports that have been checked.

Reportable Stratus Fields (Properties)

Below are explanations of selected reportable fields or property names. The list of property names includes all of the fields from all the company’s published models and Stratus-specific fields.

To access the report fields, click the Expand button associated with the report.

Stratus.Assembly.ConnectedAssembly.Single – This property will only print one label per connected assembly, which may be a better option for a rack. See Example: Stratus.Assembly.Connected Property (below).
Stratus.Assembly.ConnectedAssembly.Multiple – This property will print a label for each connection. See Example: Stratus.Assembly.Connected Property (below).
Stratus.Part.AssemblyQRCode - Add QR code for the parts in an assembly to the report.
Stratus.Part.CutLengthDecimal - When attempting to build a report using Part Template Cut List Property Mapping and referenced properties (Ex. Stratus.Part.CutLengthDecimal) are included, also included the referenced properties in the report as hidden columns. See the Cut List Mappings article for more information.
Stratus.Part.PackageQRCode - Add QR code for the parts in a package to the report.
Stratus.Part.Point.X, Stratus.Part.Point.Y, Stratus.Part.Point.Z - The X, Y, and Z coordinates of a part’s bounding box center can now be extracted. As a result, a nested rod family, combined with control points, a filter, and a report, can be used to extract point files in any required configuration. See the Extract the X, Y, and Z Coordinates of a Part’s Bounding Box Center section below for an example.
Stratus.Part.QRCode - Add QR code for the parts to the report.
Stratus.Part.TrackingStatusLog - When used in a report, the history of part’s tracking statuses will be separated by a semi-colon. One use case for including this field in a report is to check if the material was ordered for a part, knowing that “Ordered” tracking status may not be the current status. Do one of the following:
1. Search a report for the tracking status, or,
2. Configure a Filter that “Contains” the value “Ordered” and assign the filter to a report. Then when the report is run on parts in the model only those that match the filter will be included.
Stratus.Part.TrackingStatus - Will display the current Stratus tracking status for the part.
Stratus.Part.Point.AFF (Above Finished Floor) - The parameter Stratus.Part.Point.AFF is reportable and displays in the part’s Properties. In this example on the 4^th Level (Floor), the Stratus.Part.Point.Z = 1,358.88 while the Stratus.Part.Point.AFF = 0.63. If there are no levels in the model, Stratus.Part.Point.Z will equal Stratus.Part.Point.AFF. The AFF point is measured from the part's centroid. The complex process to derive the Stratus.Part.Point.AFF value includes:
1. Get the part’s origin point by evaluating the following in order and using the first value that is found:
  1. first connector point
  2. first tap connector point
  3. first dimension reference point
  4. then, if not considered a hanger support, will try:
    1. centroid
    2. centerline intersection point
    3. anchor or positioning point
2. Find a Z elevation to calculate the relative offset value of the point’s Z value, by:
  1. Selecting the property value (which refers to the part’s assigned level name)
  2. Finding a level with a section name and get its Z elevation for reference
  3. if not found, process all model levels in order from highest to lowest and use the first level with an elevation value at or below the part’s origin point
3. Finally, return the difference between the part’s origin point and the Z elevation reference level.
Stratus.Part.HoleInfo - This Report Field will display holes in pipe.
When added to a Stratus Sheet report, the report column will include a list of all holes separated by semi-colons in the following format per hole:
<hole size> <clocking angle from start>d <distance from start> E-C <mating angle from start>d out
Note: Clockwise is a positive angle looking downpipe from start to end.
Stratus.Package.XLeadDays - Replace the X with Office (e.g.,Stratus.Package.OfficeLeadDays), Purchasing, or Shop to display Start Date Lead Days for packages.
Stratus.Package.XStartDT - Replace the X with Office, Purchasing, or Shop (e.g., Stratus.Package.ShopStartDT) to display the Start Date for packages.

Hiding Report Columns

To hide report columns so that they do not display on the report:

Select Admin > Company > Reports.
Expand the definition of the report to be configured.
Click the Hidden checkbox for the column(s) that will be hidden.
Run the report. The columns will not display. Note: Regenerate the report to show the changes.

Clone a Report

To clone a report:

On the Admin > Reports button, click the clone button associated with the report to be cloned.
The cloned report will display and will include an incremented number after the name.

Create Master / Sub Reports

Multiple reports can be combined into a single report by creating a Master Report.

Identify or create a new report that will be the Master Report.
Under Admin > Company > Reports for a new or existing report click Item Type drop-down and select the Master Report option.
Once the report is saved, check which viewer the Master Report will be visible in (Ex. Model Viewer or Package Viewer).
To add sub-reports, click the Expand button associated with the report. The Sub-Reports section displays.
In the Sub-Reports section, click the +Add Report button. A new row will display.
Click the Empty link in the Report field to select one of the sub-reports.
1. Omit If Empty - When the sub-report is checked and the report is run, if the checked sub-report contains no data, it will be omitted from the report. This is especially useful when a Part Filter sub-report filters out all parts in the model.
2. Omit Title - When checked, if the sub-report has no data, the report Title will not display.
3. Omit Column Headings - When checked, if the sub-report has no data, the report Column Headings will not display.
Repeat to select another sub-report.
Once saved, the report is ready to run. In the example below, the report was run from Models > Viewer > Actions > Reports > Master (CSV) where Sub-report A and Sub-report B display.

Report Fields

Once a report is defined, add the fields that will display on the report. Report fields can include:

Database fields from all models published to the company.
Stratus default fields for parts, assemblies, and packages (Ex. Stratus.

Report Validation

Reports are validated to ensure, for example, that templates cannot be assigned to CSV reports and that a template has a "matching" template type to the report item type. If, when the Admin > Reports tab is clicked a warning message like the following displays, take note and then review the report to correct the issue.

Assembly Filter Impact on a Part Report

If a Default Assembly Report has not been configured under Package Categories, or if the assembly is not associated with a package, the assembly filter determines which report is initially displayed on the Assembly Viewer Parts tab.

When the Assembly Filter is used to set the initial report displayed on the Assembly viewer Parts tab, Stratus will look at all of the part reports set to display on the assembly viewer, find the report that has an assembly filter that contains the most amount of parts for that new assembly and set that report to display the first time the assembly is opened.

For example, if there is one filter to identify ductwork and another to identify pipework, assign the ductwork filter as the assembly filter on the ductwork BOM and assign the piping filter on the pipework BOM (above). The first time a newly created ductwork assembly is opened, the ductwork BOM report will display since the Assembly Filter found more duct parts than pipe parts. Similarly, the first time the pipework assembly is opened, the pipework BOM report because the Assembly Filter found more pipe parts than duct parts.
Note: Once a report is manually changed, when the page is refreshed, the newly selected report will display rather than the report based on the Assembly Filter.

Configuration Examples

Example: Pipe Weld Diameter Inches

Below is one way to configure a report on Pipe Weld Diameter Inches.

Item Type - This report is run on Parts, not Orders or Assemblies. The list of properties (Property Names) will be different depending on whether a Part, Assembly, or Order is being reported.
Filter - For this report, the Filter Pipe Welds is applied. This means that only parts defined by the Pipe Welds filter will be included in the output.
Other columns are used for formatting, grouping, and ordering data within the report.
Property Names - This report will have 2 columns (Property Names):
Product Material Description and Main Primary Diameter of the Pipe Welds.
In this case, the Material and the outside diameter of the pipe needs to be known.
Format – The Diameters will be in FeetInches; the Description will be a String value.
Precision = 2
Multiplier – If the total circumference of the pipe is needed, take the outside diameter of the pipe x Pi which gives the result in linear weld inches. When dealing with Revit, because their units are in feet, multiply 12 x Pi.
Suffix – Optionally, include the word inches in the output or lbs for total weight.

Example: Flex Duct

Below is one way to configure a report on Flex Duct

Item Type – A flex duct report is run on Parts, not Orders or Assemblies. The list of properties (Property Names) will be different depending on whether a Part, Assembly, or Order is being reported.
Filter - For this report, the Filter Flex Duct is applied. This means that only Flex Duct parts, as defined by the Flex Duct filter will be included in the output.
Other columns are used for formatting, grouping, and ordering data within the report.
Property Names - This report will have 2 columns (Property Names):
Diameter and Length
For ordering purposes, the total length needs to be reported. Set Total Values = Yes AND set Merge Like Values to Yes on the diameter so that everything that is set to the same diameter will get merged into a single row on the report, AND the Length will get totaled.
Format – The data is formatted in FeetInch

Example: Create a Spool Sheet Report

Reports can be targeted to the Assemblies > Viewer tab. The Assemblies Viewer includes a default report, though most companies customize it. A spool sheet report combines a template with a report.

To create a printable Spool Sheet report that can be used on the Assemblies > Viewer tab:

Create a Template - See the Templates (Admin) article. Define the information need on the report like logo, QR code, 3D views, and space for the parts list.
Create a Spool Sheet Report report under Admin > Company > Reports that will be associated with the report template. A new report can be created or a report clone can be modified.
Configure the Spool Sheet Report which will contain the spool's part list:
1. Name - Name of the report (Ex. Pipe Spool Sheet).
2. Format
  1. PDF – PDF format means that data, like spool sheet data, might include a logo header, project name, assembly name, list of spool or assembly parts, and assembly views with dimensions can be formatted on a page.
3. Item Type
  1. Part - The Item Type, in this example, is Part since the report data will include assembly parts.
4. Filter - This report could utilize a filter, however, with regard to a spool sheet report which is opened from the Assembly Viewer, the spool itself will filter the data.
5. Assembly Viewer - Check the Assembly Viewer option so that this report will be available on the report drop-down list on the Assemblies > Viewer page.
6. Template - The Template column is used to pair a report with a report template. In this example, I selected the report template Demo A created above.
Configure the Report Fields for Pipe Spool Sheet report. All reports fields should match fields in the company database. For fields like Diameter, Material, or Length which can reference many different fields in the database, it is recommended to create an alias so that many fields can be funneled into one report field. See the Aliases (Admin) article for more information. Below are report fields used in this example.
1. Number

Reports (Admin)