Reporting

Use Reporting when a private procedure needs confirmation, comments, or photo evidence during execution.

Reporting only applies to Private published procedures.

Turn Reporting On

Step by step

Enable Reporting from Publish Settings

Reporting is a private-viewer feature.

Product HomePublish SettingsPrivate

Steps

1. Open the product in Product Home.
2. Click Publish Settings.
3. Open the Private tab.
4. Turn on Reporting.
5. Turn on Photo Reporting if the viewer must also upload images.
6. Click Save.

Example

For a maintenance procedure that must be signed off by a technician, enable Reporting. If the technician must upload a photo of the finished work, enable Photo Reporting too.

Screenshot

Private reporting settings

The Private tab includes Reporting, Photo Reporting, and Save.

What The Viewer Can Do

When reporting is enabled, the current viewer can capture:

• step confirmation
• step success or failure
• step comments
• procedure-level comments
• uploaded photos when Photo Reporting is enabled

Step by step

Understand the private viewer reporting flow

The viewer records evidence as the user moves through the procedure.

Private viewerProcedure execution

Steps

1. Open the private published procedure.
2. Execute the procedure step by step.
3. Confirm each step when required.
4. Add comments when needed.
5. Upload photos if the step requires image evidence.
6. Finish the procedure so the execution record is stored.

Example

A field technician can mark a step as completed, write Seal replaced, and upload a photo of the final assembly before moving to the next step.

Screenshot

Private viewer with reporting

The reporting panel is open on a step that requires a comment or photo.

Review Report History

The private viewer also includes a Report History panel for reviewing earlier private executions directly in the viewing experience.

This is useful when the same device or user needs to compare previous runs of the same procedure.

Review Reporting In Analytics

Step by step

Open reporting results in analytics

Private analytics is where reporting becomes measurable and exportable.

Left sidebarDashboardProcedure AnalyticsPrivate

Steps

1. Open Dashboard.
2. Open the relevant product.
3. Open the relevant procedure.
4. Switch to the Private view in Procedure Analytics.
5. Review execution duration, comments, success/failure state, images, and step-level reporting.
6. Export the data to Excel if needed.

Example

If a maintenance team reports repeated failures on the same step, open the private analytics view and compare the comments and images from those runs.

Screenshot

Procedure Analytics private view

The Private view includes the Public/Private selector, the execution table, and the Export .xlsx action.

Serial-Number Workflows

Use serial-specific QR codes when many identical units share the same published procedure but each physical unit needs its own maintenance trace.

When you export serial-specific QR codes from Product Settings, each QR opens the viewer with that serial number already embedded in the URL. During execution, StepWorks stores that serial number with the report record.

This means:

• the operator scans the QR code attached to the exact unit they are working on
• the private viewer can show Report History for that serial number
• analytics and exports keep the execution linked to that specific serial number instead of mixing reports from every unit