Reports (Admin)
- Matthew Tate
- Conk Buckley
Reporting is a framework to specify the precise data you want to get out of the model. Using filters you can generate the reports by order, area, level, cost code, or any property you want. Reports can be created for different user roles. A report can be generated based on any model property or a Stratus filter. Field expressions work with parameter names that include () or “ in them.
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
- Name (Required) - Enter a report name. When selecting the report to be run, this is the name that will display. It is recommended that this name be descriptive yet short.
Note: BIM 360 does not allow special characters to be used when generating files. - Format - A report can utilize one of the following formats.
- CSV - Use this format when you only need tabular data.
- PDF - Use this format when you want to bring together multiple data types (data fields, images, isometric views, QR codes, etc.) and other formatting options
- ZPL - Use this format if you are 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.
- Item Type - A report can utilize one of the following Item Types.
- Assembly (Assemblies Dashboard) - Use this item type when the report will display data about assemblies.
- Report Examples include - Estimated Hours, Spool Label (when combined with the ZPL format).
- BOM - Use this item type when your 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.
- 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.
- When a Container Item Type is combined with a ZPL Format, the resulting report can be used as a Label Template.
- Container Details - Use this item type for a container's contents. By creating a Template, you can choose a specific report format for each type of container. 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.
- Invoice - Only use this type if your company has been configured to use the Purchasing and Supplier options.
- Master Report - A Master Report can be used to combine multiple sub-reports into a single report.
- Report Examples: Master = Pipe BOM; Sub-Reports = Pipe Length, Fittings, Valves
- See below for a Fab Packet example.
- 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.
- Package (Packages Dashboard) - Use this item type when your 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.
- 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.
- Report Examples: System Package
- Package Details - Use this item type when your 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.
- Report Examples: Package Sheet
- 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.
- When a Part Item Type is combined with a PDF Format, the resulting report can be used on a Template.
- 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.
- When a Part Item Type is combined with a ZPL Format, the resulting report can be used as a Label Template.
- Report Examples include BOM, Cut List, Pipe, Duct, Conduit, Length, Fittings, Hangers (Rod, Strut), Galvanized Supports, Weld Diameter, Equipment.
- Purchasing - Only use this type if your company has been configured to use the Purchasing and Supplier options.
- 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.
- Assembly (Assemblies Dashboard) - Use this item type when the report will display data about assemblies.
- Assembly Filter
- 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 you select a different report for an assembly, the system will select that same report the next time you view that particular assembly.
- Default Assembly Report in Package Categories Alternative - Default Assembly Report option was added to Package Categories With the release of v6.3.1, a Default Assembly Report option was added to Package Categories which works well when working with Assemblies that are in Packages. Both of these options are described in the Default Assembly Report article.
- Part Filter - If your report needs to filter part data, select the filter. See Filters (Admin) for more information.
- Assembly Viewer - Check this option if the report needs to display in the Assemblies > Viewer.
- Model Viewer - Check this option if the report needs to display in the Models > Viewer.
- 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
- Assemblies Dashboard - Check this option when your report is targeted to display in the report drop-down on the Assemblies > Dashboard tab.
- Containers Dashboard - Check this option when your report is targeted to display in the report drop-down on the Containers > Dashboard tab.
- Packages Dashboard - Check this option when your report is targeted to display in the report drop-down on the Packages > Dashboard tab. See the Package Dashboard article for more information.
- Cut List Import - Check this option when you want to use the report 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.
- 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.
- Template - If you plan to embed the report inside a template, then select a template. See the Templates (Admin) article for more information.
- Notes - Add notes to describe the purpose of the report.
- Save, Cancel, or Delete
- Clone Row - Clone a report by clicking the Clone Row button.
- Name (Required) - Enter a report name. When selecting the report to be run, this is the name that will display. It is recommended that this name be descriptive yet short.
- 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 you want to a total quantity for like values such as 6" Diameter pipe.
For a Report where:
Item Type = Part
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.
The following business rules will be applied:
If the quantity counts of a report (the Quantity checkbox) are enabled
- Only show the “(n)” count on merged data in cells when n does not equal the quantity column value in the report.
When n = 1, show “(1)”
As a result:
Assemblies > Viewer where all merged parts in the Quantity are the same.
Assemblies > Viewer where merged parts in the Quantity are different, the (n) value will display.
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 - Aggregate replaced Total Values on 3/3/21.
- None - The None option is selected by default and will not apply a sum or average.
- The Sum option will add a total for numeric values at the bottom of the report. If you are using Merge Like Values, Total Values will provide sub-totals for each merged row.
- 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.
- Average - The Average option will average the numeric values.
- Format - Select the display Format type for the report field.
- String - A String data format is a sequence of characters, either as a literal constant or as some kind of variable.
- Integer - An Integer data format stores whole numbers, positive or negative.
- Decimal - A Decimal data format stores decimal numbers, which include a fractional part. The precision column controls the number of decimal places.
- FeetInch - A FeetInch data format displays the value as feet and decimal inches (Ex. 7'-4"). The precision column controls the decimal.
- FeetInchFraction - A FeetInchFraction data format displays the value as feet and fractional inches (Ex. 7'-3-5/8"). The precision column controls the fraction.
- Inch - An Inch data format displays the value as inches and decimal inches (Ex. 88"). The precision column controls the decimal.
- InchFraction - An InchFraction data format displays the value as inches and fractional inches (Ex. 87-5/8"). The precision column controls the fraction.
- Date - The Date data format stores the value as a date.
- Boolean - A Boolean data format can store one of two values: true or false.
- 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).
- Decimal - If your Format is set to Decimal, you can 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.
- 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 you want to find the total circumference of the pipe, take the outside diameter of the pipe x Pi which gives you a result in linear weld inches. When dealing with Revit, because their units are in feet, you have to do 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, you might want to 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 of your 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. This means that you can use something like a nested rod family in conjunction with control points, a filter, and a report to generate your own point files in whatever configuration you need. 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. You could either:
- Search a report for the tracking status, or,
- 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. Clone (Copy) a Report.
- 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 4th 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:
Get the part’s origin point by evaluating the following in order and using the first value that is found:
first connector point
first tap connector point
first dimension reference point
then, if not considered a hanger support, will try:
centroid
centerline intersection point
anchor or positioning point
Find a Z elevation to calculate the relative offset value of the point’s Z value, by:
Selecting the property value (which refers to the part’s assigned level name)
Finding a level with a section name and get its Z elevation for reference
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
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, Purchasing, or Shop to display Start Date Lead Days for packages.
- Stratus.Package.XStartDT - Replace the X with Office, Purchasing, or Shop 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 appear. Note: Refreshing the report page will not show your changes, rather, regenerate the report.
Clone a Report
To clone a report:
- On the Admin > Reports button, click the clone button associated with the report you want to clone.
- 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.
- 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.
- Omit Title - When checked, if the sub-report has no data, the report Title will not display.
- 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 you click the Admin > Reports tab you see a warning message like the following, take note and then review the report to correct the issue.
Assembly Filter Impact on a Part Report
The assembly filter is used to set which report will be the initial report displayed on the Assembly viewer Parts tab. When an assembly is created 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 you have a filter to identify ductwork and another to identify pipework you will want to assign the ductwork filter as the assembly filter on your ductwork BOM and assign the piping filter on your pipework BOM (above). The first time you open a newly created ductwork assembly you will get the ductwork BOM report because the Assembly Filter found more duct parts than pipe parts. Similarly, the first time you open the pipework assembly you will get 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.
Report Setup Videos
Stratus 10-10-19 Implementation Webinar - Trade Specific Reporting (32:31)
Stratus 05-16-19 Implementation Webinar - Pipe Reports (19:54)
This webinar covers how to create a pipe report.
Using the Properties tool to review and select properties to include in the report. 1:23
Create a new report (Test – Linear Pipe Length Report) – 2:20
Report Format options – 2:40
Part Filter - 4:26
Report Fields – 5:23
Extract out quantities for pipe fittings – 11:04
Create a new report (Test – Pipe Fitting Report) – 12:19
Create a Master Report (Test - Pipe Master Report) – 15:02
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 you are reporting on a Part, Assembly, or Order.
- 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, you want to know the Material and the outside diameter of the pipe.
- Format – The Diameters will be in FeetInches; the Description will be a String value.
- Precision = 2
- Multiplier – If you want to find the total circumference of the pipe, take the outside diameter of the pipe x Pi which gives you a result in linear weld inches. When dealing with Revit, because their units are in feet, you have to do 12 x Pi.
- Suffix – You might want to include the word inches in the output…or for a total weight field you might enter lbs.
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 you are reporting on a Part, Assembly, or Order.
- 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, you want to know the total length … so the Total Values = Yes. AND Merge Like Values is set 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 would 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 does provide a default report, but you will want to customize reports for this tab. 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 you want to display 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. You can create a new report or clone and modify an existing report.
- Configure the Spool Sheet Report which will contain the spool's part list:
- Name - Name of the report (Ex. Pipe Spool Sheet).
- Format
- 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.
- Item Type
- Part - The Item Type, in this example, is Part since the report data will include assembly parts.
- Filter - Your 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.
- 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.
- 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 your company database. For fields like Diameter, Material, or Length which can reference many different fields in your database, you will probably need to take an extra step and 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.
- Number
- Name
- Description
- Stratus.Alias.Pipe Diameter
- Stratus.Alias.Pipe Material
- Stratus.Alias.Pipe Length
Example: Package Dashboard Reports
Reports can be targeted to the Packages > Dashboard. The Dashboard does provide a default report, but you can create one or more reports to customize how the list of packages is displayed.
To create a report that can be displayed on the Packages Dashboard:
- Create a new report under Admin > Company > Reports.
- For the report, select:
- Format = CSV
- Item Type = Package
- Save the report so that the Packages Dashboard checkbox is activated and can be checked.
- Check the Packages Dashboard checkbox and Save.
- Expand the report.
- Click the New Report Field button.
- Add any of the Stratus.Package fields under Property Name and Save.
- To Total numeric fields (Integer, Decimal, and all the Feet Inch variations), set Total Values setting to Yes. If the field is a Feet Inch variation, set the Format and the Precision as well.
- To Total numeric fields (Integer, Decimal, and all the Feet Inch variations), set Total Values setting to Yes. If the field is a Feet Inch variation, set the Format and the Precision as well.
To view the report on the Packages Dashboard:
- Go to the Packages > Dashboard page.
- Click the Report drop-down and select the report. Only reports where the Packages Dashboard checkbox is checked for the report will display here.
- Once selected your report will display. You can filter the list of packages by selecting the Package Category.
To view the column totals:
- Run the report. The totals will display. When Show Entries is not All, then a subset of packages can display. In this case a subtotal (150.29’) followed by the total (24226.2’) will display.
- Other column types like Decimal and String can also be totaled.
Example: Package Stratus Sheet
Reports can be targeted to the Packages > Stratus Sheet tab. A default report does not display under Admin > Company > Reports, so you'll need to create a new report if you want a custom report option for this tab.
To create a report that can be displayed on the Package's Stratus Sheet tab:
- Create a Template - See the Templates (Admin) article.
- Create a new report under Admin > Company > Reports or clone an existing report that may have some of the report fields you want in the new report.
- For the report, select:
- Format = PDF. In this example, the Reports will pull in various data fields like Package Name, Project Name, Assembly Name, QR Code, and more.
- Item Type = Package. Note: This is the only Item Type that targets the report for the Package Reports page drop-down.
- Filter = None. The Selected package will filter the report so a separate filter is not needed.
- Template = a template you have created to display the data fields. In this case, I have created a Package Details template that includes the Report field, Package Name, Project Name, Assembly Name, QR Code, and Isometric image.
- Save the report.
- Expand the report to add report fields. These fields will display in a table in the templates' Report field.
- Click the New Report Field button. Add any applicable fields under Property Name and Save. Below are some examples.
- To use the Package Details Report, see the Package Report article. This article includes information about how to enhance the Isometric view of the report by adding features like assembly names, spool names, item numbers, and Display Grid.
Example: Import Cut List Reports
An Import Cut List report can be used to generate a cut list for items like Single Rod Hanger, Trapeze Hanger, Strut, Skids, etc. When a report is configured with the Import Cut List checkbox checked, the report can be imported as a Cut List on the Packages > Cut Lists tab. This report must also be configured to be used with a mapping under Admin > Import Mappings.
This example will demonstrate how to create a cut list report for single rod hangers.
Create a report filter
- The Single Rod Hanger report will require a Filter be configured to isolate the hangers in the model viewer.
- Select a single rod hangers in the model and determine which field(s) can best isolate the hangers.
- Under Admin > Company > Filters, create a new filter and set the rule using the property that will isolate the hangers (Ex. ServiceType = Hanger).
Create a cut list report
- Under Admin > Company > Reports, create a report for a cut list, select the Filter, check the Cut List Import checkbox, and save.
- Add the report fields for the cut list and labels. For example:
- ServiceAbbreviation
- Size
- Drop Rod Diameter; Sort = 1; Format = inchFraction
- Length A; Sort = 2; Format = inchFraction
- Go to the Models > Viewer and run the report on the whole model or an isolated view under Actions > Reports > Select the report. Check that the report contains the information you want and that it sorts and formats it the way you want.
- Once done, click the Download the report. You'll use this file later when you set up the Import Mapping.
Create an import mapping
- See the Import Mapping article for information on how to configure an import mapping.
- If you haven't already, download the report created above.
- Under Admin > Company > Import Mapping, click the New Import Mapping button, name it, and then save.
- Browse and upload the downloaded file (.csv). This is a sample file that includes your cut list header rows (Ex. Size, Drop Rod Diameter, Material, Length A) and at least one row of data.
- Once a sample file has been uploaded, expand the row to tell Stratus which fields to use for the Header row. Once selected, Stratus will automatically fill-in and save the mapping fields with your Header rows.
- The Import Mapping is ready to use with other reports that use the same Import Mapping and the same report.
Import Cut Lists
- In the Models > Viewer, run the cut list report (above) on the whole model or an isolated view under Actions > Reports > Select the report.
- Download the report.
- Under Packages > Dashboard, click the New Package button, add the package details, and then save. For this example, this step assumes that a package containing the cut list parts for the Single Rod Hanger cut list has not been created. If you have a package where you have added the isolated Single Rod Hangers, then go ahead and open that package.
- Open the package and make sure it set to a tracking status where the "Can Assemble" checkbox is unchecked which indicates that the package can no longer be edited. See the Tracking Statuses (Admin) article for more information.
- Under Packages > Cut List, click the Import Cut List button.
- Click Import. The Cut List will display.
- You can either
- Print the labels to a ZPL printer, or,
- if you have a TigerStop, select a Station, check one or more cut list rows, and then click the Send Cut List to Station.
Example: Label Report
If you want to print fitting labels to your Zebra printer, you would create a report similar to the following:
- Create a filter that either filters out your straights or filters in the fittings. Get this running in the Models Viewer until you are happy with it.
- Create a report where:
- Format = ZPL
- Item Type = Part
- Filter = the above filter
- Edit the Label as needed. Note: You can copy/paste the label code from a label you currently use.
- Add Fields to the report. Example Label Fields, depending on your database, might include:
- Assembly Name: Stratus.Part.AssemblyName
- Package Name: Stratus.Part.PackageName
- Item Number: Number
- Material: Material
- Diameter: Overall Size
- Description: Description
- QR Code: Stratus.Part.QRCode
- To run the report, go to the Package Details > Attachments tab. Select the report and click the Create button.
- The resulting report will have a print option.
- To print the labels, you’ll need to open and configure the GTP Stratus Workstation Printer to point to your label printer.
- Download the GTP Stratus Print.
- Download the GTP Stratus Print.
- Send the Zebra printer identified on the GTP Stratus Workstation Printer.
- Affixing the label to the right part may be a challenge so you may need a couple of filters so that you only print labels for certain parts.
Example: Container Label Report
To configure a Container report to be used on labels:
Go to Admin > Company > Reports
Click New Report.
Name (required) – The name for your Container Label report.
Format – ZPL
Item Type – Container
Click Save.
Expand the report to add Report Fields. The following fields are available:
Stratus.Container.Name – The Name entered in the Define Container section. No additional field columns need to be edited.
Stratus.Container.QRCode – A QR code will be included. No additional field columns need to be edited.
Stratus.Container.Description - The Description entered in the Define Container section.
Stratus.Container.Id - Displays the container's unique Container ID
Stratus.Container.QRCode - Displays the container's QR Code.
Stratus.Container.Type - The Container Type entered in the Define Container section.
Stratus.Container.CompanyName - Displays the Company name.
Edit Label Template
By default, the Label Template includes the report fields Stratus.Container.Name and Stratus.Container.QRCode. On the label, this will print the container name and QR code.
If you want to add report fields like Company Name or Container ID, then you’ll need to add them to the Label Template and to the Report Fields. See the Label Printing for Zebra (ZPL) Compatible Printers article for more information.
Example: Container Details Report
Use this report item type for a container's bill of contents. By creating a Template, you can choose a specific report format for each type of container. The Container Details Item Type is only available on the Containers page in the Report drop-down. Note: When a Container Details report is run, the order of output is sorted as follows:
Loose parts
Assemblies (don't list child parts)
Packages (do list child assemblies and loose parts)
Containers (repeats the list above)
To configure a Container Details report:
Under Admin > Company > Reports, create a new report where Item Type is Container Details, Format is PDF, and Template can either be empty, in which case the Stratus default Containers template will be used, or, you can configure your own template.
Under the report's Report Fields, add all the available Report Fields to the report. You can remove fields later.
To run the report, go to the Containers page and open a container that includes one or more parts, assemblies, or packages. The report will be available in the Report drop-down.
Once the report is selected, click the Print button and the report will generate at the bottom of the page. Below is an example of an out-of-the-box report.
By default, the above report used the default Stratus Container Details Template. You can configure your own template as needed.
Example: Container Part, Assembly, or Package Report
A Container Part, Assembly, or Package report is targeted to Shop or Field workers to provide them with container information to help locate items.
To configure a Container Part, Assembly, or Package Report:
Create a separate Report (as needed) to include Parts, Assemblies, and Packages.
To include Assemblies in a container report
Report Field - Stratus.Assembly.Container
Format = CSV
Item Type = Assembly
To includes Parts in a container report:
Report Field - Stratus.Part.Container
Format = CSV
Item Type = Part
To includes Packages in a container report:
Report Field - Stratus.Package.Container
Format = CSV
Item Type = Package
Create a Container under Admin > Company > Containers. See the Containers (Admin) article for more information.
Run the report from either the Models or Packages Viewer. Below is an example of a report that includes Assemblies in a Container.
Example: Package Assemblies Batch Report PDF
The report gives you the ability to batch generate spool sheet reports (PDF) for all assemblies in a package. Creating the report is a 2-step process: 1) Create a Template and 2) Create the Report. If you already have a spool report defined for use on the Assemblies > Viewer page, you can skip the setup below and running the report batch from the Package's Attachments tab.
- Create the Template. See the Templates (Admin) article for more information.
- Identify or create a report where:
- Fomat = PDF
- Item Type = Part
- Assembly Viewer = Checked
- Template = Includes one of your templates (created on the Templates tab)
- Add report fields to the report.
- To run the report, open a package, click the Attachments tab, and select the report. See the Package Assemblies Batch Report PDF section of the Package Attachments article for more information.
Example: Configure an Alias for use inside a report field
To configure an Alias for use inside a report field:
- Create an Alias (Duct Width and Duct Depth in the example below):
- Create a Field under Admin > Company > Fields that uses the Alias in the Expression.
- Create a Report that includes the Field:
- Results if the report was an Assembly Viewer report:
Example: Fab Packet
A Master Report (Item Type) can be used to combine reports into a single report. A "Fab Packet" PDF is an example of a Package level report that combines reports (sub-reports) that may also be targeted for the Assembly Viewer and Package Details pages; the result is a report that could include a traveler and all spool sheets in one PDF.
To create a Fab Packet:
- Create one or more sub-reports (CSV or PDF) or identify existing reports.
- Format = CSV or PDF
- Item Type = Part, Assembly (PDF), Package Details (PDF)
- Filter – Optional
- Assembly Viewer – Checked for reports targeted to display on the Assemblies Viewer page.
- Template – An Assembly Viewer report and a Package Details report are associated with a Template.
- Create a Master report
- Item Type = Master (PDF)
- Add any of the above report Item Types to the Master report. Reports will display in the order they were entered as sub-reports.
Note: If an Assembly report is included, the Master report will create an assembly report for each assembly in the package.
- Run the Master Report from the Packages Details > Attachments page.
Example: Stratus.Assembly.Connected Property
The Stratus.Assembly.Connected property can be used to print labels or generate reports that identify the connecting assemblies. Using this property to generate a label, one or more labels can be printed and placed on parts to identify the connecting assembly.
To use the Stratus.Assembly.Connected property, you’ll add either a .Single or .Multiple depending on what you want to accomplish.
- Stratus.Assembly.ConnectedAssembly.Single – This property will only print one label per connected assembly, which may be a better option for a rack.
- Stratus.Assembly.ConnectedAssembly.Multiple – This property will print a label for each connection.
To configure a Report:
- Under Admin > Company > Reports, locate or create a report where:
- Format = ZPL (for a label) or CSV (for a tabular report)
- Item Type = Assembly
For a ZPL Label Format
- Click the Edit Label Template button and add one of the properties to the Label Template:
- Stratus.Assembly.ConnectedAssembly.Single
- Stratus.Assembly.ConnectedAssembly.Multiple
- Examples based on this assembly:
- .Single - 2 labels should print:
- One for assembly Duct01-01-0001 with attached assembly Duct02-02-0002.
- One for assembly Duct02-02-0002 with attached assembly Duct01-01-0001.
- One for assembly Duct01-01-0001 with attached assembly Duct02-02-0002.
- .Multiple – 6 labels should print (not shown)
- 3 for assembly Duct01-01-0001 with attached assembly Duct02-02-0002
- 3 for assembly Duct02-02-002with attached assembly Duct01-01-0001
- .Single - 2 labels should print:
For CSV Report Format
- .Single Example - When a report with the same assembly connected (as above) is run for the CSV format, the report will display the following:
- .Multiple Example
- .Multiple Example when the assembly is connected to 2 other different assemblies.
Example: Extract the X, Y, and Z Coordinates of a Part’s Bounding Box Center
The X, Y, and Z coordinates of a part’s bounding box center can now be extracted. This means that you can use something like a nested rod family in conjunction with control points, a filter, and a report to generate your own point files in whatever configuration you need. Stack this with the ability to renumber parts based on properties, schemes, and iterative numbering routines and you may very well be enabled to manage points right inside of Stratus.
The following properties can now be found in reports and used in fields:
Stratus.Part.Point.X
Stratus.Part.Point.Y
Stratus.Part.Point.Z
Below are some examples that demonstrate the X and Y for a rod will always be exactly what you expect them to be, which is the center of the rod. On the other hand, the Z will be halfway down the length of your rod. In most cases, this won’t matter, but if it does you can use a Stratus field to give you the top Z by adding half of the rod length to the Stratus.Part.Point.Z value. [NewZField = {Stratus.Part.Point.Z} + ((Rod Length)/2)].
Below is an example of the new properties on a rod:
Below is an example of what that bounding box and point look like from a front view:
Below is an example of what that bounding box and point look like from a top view:
For reports, users can specify which parts are used through filtering on the report. In the example above, a Shared Nested threaded rod family in the hangers was found and their XY data was extracted. Since the rod was symmetric you know that the XY data is going to be the middle of the rod.
This feature also enables users to use the Stratus sPoint or even create your own families to embed for point export utilities.
Example: Report Average and Sum Hours
Tracking Status hours can be displayed in a report using the new Aggregate Report Field options (Average or Sum). See the Added Aggregate Report Column to Include Average section for more information. The Aggregate column replaced the previous Total Values column. Report Fields that had Total Values set to Yes have been converted to use the new Sum option.
This example averages leverage the fields:
- Stratus.Assembly.TrackingStatusLogDT
- Stratus.Package.TrackingStatusLogDT
This example also leverages the HoursInTrackingStatus() field expression function.
Example - Assembly Report to Track Times
Example - Package Report to Track Times
Example: Filter and Report on Parent Families that Consist of Only Shared Nested Families
Below are examples:
- Family report
- Shared Nested Parent Family
Example: BIM Area Elevation Report Properties XYZ for Part Connectors C1, C2, C3, C4
BIM Area Elevation report properties XYZ for Part Connectors C1, C2, C3, C4. A workcase example is installing a waste stack where there is a sanitee looking out to a sink and the elevation of the sanitee is needed. Depending on how the object is configured, the elevation can now be from one of the connectors' Z value which would inform the user that the sanitee is 18” above the floor. This eliminates the need to look at an install drawing because the spool drawing can include the install elevation. This value can:
Add positioning to sloped pipe labels
Eliminate the need to look at an install drawing because the spool drawing can include the install elevation
Provide QA/QC information
Generate a CSV report to send to a Total Station
Example: Hanger Point Report
Create two (2) sub-reports, one for point 1 and one for point 2, and then a Master report to combine them. In this solution, the report headers in the second report (Ex. Sub Points C2) are ignored so the end result of the master report is correct. In addition, a suffix (Ex. -1 or -2) can be used to distinguish points. In the example below, the Item Number is used as the name but another part identifier can be easily be configured. Below is an example report configuration. Note: A part filter may need to be applied to the second hanger point sub-report to only include points for trapeze hangers, filtering out single rod parts like clevis.
Master Report
Sub-report for C2
Sub-report for C3
Example Report to Download
© Copyright 2022 GTP Services, LLC All rights reserved. | About | Contact