Skip to main content

Walkthrough App

The Walkthrough app guides users through step-by-step procedures combining instructional content and action confirmation. It is designed for processes that must be followed in a specific way β€” equipment commissioning, system allocation, image-guided procedures, and any task where the user needs to both reference guidance and record what they did.

πŸ“Œ Intended audience: The Walkthrough app is designed for sales teams and inspection app technical personnel who need to deliver guided, documented procedures in the field or during customer engagements.


πŸ†š How Walkthroughs Differ from Other Task Apps​

WalkthroughAuditInspectionSurvey
PurposeQuick observationDocument installed assetsAssess equipment conditionEvaluate compliance
StructureInformalStructured asset captureChecklist-drivenFormal engineering
Depth / DurationLow Β· 15–45 minMedium Β· 2–6 hrsMedium–High Β· 1–4 hrsHigh Β· 1–3 days
Data capturedPhotos, notesSerial numbers, configCondition measurementsEngineering analysis
OutputsVisit notes, leadsAsset registryInspection reportEngineering audit report
Typical triggerSales visit or service stopOnboarding new plantMaintenance schedulePerformance project

πŸ“Š Dashboard β€” Status Tiles​

Three summary charts at the top give you an immediate view of all walkthrough activity.

Walkthrough Status Summary​

StatusColorMeaning
DueπŸ”΄ PinkWalkthrough is assigned and waiting to be started
In-Progress🟠 OrangeStarted but not yet submitted
Complete🟒 GreenSubmitted and report generated

Walkthrough Report Status Summary​

StatusColorMeaning
Pass🟒 GreenAll mandatory steps completed and validation rules met
FailπŸ”΄ PinkOne or more mandatory steps failed or were not completed

Walkthrough Template Status Summary​

StatusColorMeaning
Active🟒 GreenTemplate is available for new walkthroughs
InActive🟠 OrangeTemplate has been deactivated

πŸ“‹ The Walkthrough List​

Organized into three tabs β€” each showing a different stage of the walkthrough lifecycle.

START NEW Tab​

Lists all available walkthrough templates.

ColumnDescription
Walkthrough ID#The template reference identifier
Walkthrough TitleName of the walkthrough or procedure
TagsCategory labels (e.g., Test, Allocation, Level 5, Efficiency, Mobile)
Allocated ToWhether this template applies to assets, systems, or model families
Create DateWhen the template was created
Report StatusN/A until a walkthrough is started from this template
ActionStart a new walkthrough from this template

IN-PROGRESS Tab​

Lists all walkthroughs that have been started but not yet submitted.

ColumnDescription
Walkthrough ID#Template reference
Walkthrough TitleName of the walkthrough
LabelUnique instance identifier, prefixed WLK-
TagsCategory labels
StatusIn-Progress badge
Assigned ToThe user responsible for completing this walkthrough
Allocated ToThe specific asset, system, or model family this instance is linked to
Start DateWhen this instance was started
Report StatusN/A until complete
ActionResume (β–Ά) or Delete

COMPLETED Tab​

Lists all finished walkthroughs with their final outcomes.

ColumnDescription
Walkthrough ID#Template reference
Walkthrough TitleName of the walkthrough
LabelUnique instance identifier
TagsCategory labels
StatusComplete badge
Assigned ToUser who completed the walkthrough
Allocated ToThe asset, system, or model family walked through
Completed OnDate and time of submission
Report Statusβœ… Pass or πŸ”΄ Fail
ActionView report (πŸ‘), Repeat (πŸ”), or Delete

Available tools on all tabs: Search Β· Filter Β· Toggle between grid and list views Β· Request Data to export


▢️ Starting a Walkthrough​

Click the Start action icon on any template row in the START NEW tab. A confirmation dialog appears:

ElementDescription
Confirms the start dateToday's date is shown
Walkthrough titleThe name of the procedure being started
LabelAuto-generated WLK- reference β€” editable if needed
AllocationAsks whether this walkthrough is for an Asset, System, or Model Family
START buttonConfirms and opens the walkthrough immediately

The walkthrough opens immediately and appears in the IN-PROGRESS tab.


βœ… Completing a Walkthrough​

Once inside a walkthrough, the interface is split into two panels.

Left panel β€” the full walkthrough structure showing all groups and steps. Expand a group to see its individual steps. Your current step is highlighted.

Right panel β€” the active step's input area. The step title is shown at the top, along with a Show Instructions link for detailed guidance if configured.

Step Navigation​

  • Click any group or step in the left panel to jump to it directly.
  • Use Back and Save & Add Another / Save & Next buttons to move through steps sequentially.
  • The step counter (e.g., 1 / 3) shows progress through the current group.

Action Buttons Per Step​

IconFunction
🚩 FlagMark this step for follow-up or attention
πŸ“· CameraCapture a photo directly from this step
πŸ–Ό ImageAttach an existing image
⏭️ SkipSkip this step (if not mandatory)

Input Types​

Walkthroughs support a full range of input types. The most common in walkthrough templates are:

InputTypical Use in Walkthroughs
Upload DocumentCapture photo evidence of a completed step (e.g., equipment photo, installation confirmation)
Show InstructionsDisplay guidance text, diagrams, or reference images inline as part of a step
Show VideoEmbed a how-to video before a confirmation step
Show ImageReference photo showing correct configuration or component location
Text / NumberRecord a value, serial number, reading, or identifier
Yes / NoConfirm whether a condition or action applies
Pass / Fail / NARecord the result of a specific test or check

Saving Progress​

Progress is saved each time you complete a step. If you exit and return, the walkthrough resumes at your last position. Use Save & Add Another when a step requires multiple entries for the same input type (e.g., uploading multiple photos for the same step).


πŸ“„ PDF Form Walkthroughs​

Some walkthrough templates are built on fillable PDF forms rather than step-by-step inputs. These open in a built-in document viewer β€” a full work order, field service report, or structured form that is filled in directly on screen.

How it works:

  1. The PDF opens in the built-in viewer with any pre-configured default values already filled in (customer name, equipment model, site details, etc.).
  2. Complete the form fields directly in the browser.
  3. Save Changes preserves progress and keeps the walkthrough In-Progress for later.
  4. Save & Finish locks the form, generates a non-editable PDF, and marks the walkthrough Complete.
  5. The completed PDF is stored permanently and can be viewed or downloaded at any time from the report.

πŸ’‘ PDF walkthroughs are ideal for field service reports, work orders, and manufacturer start-up forms β€” any situation where the final deliverable must be a specific document format rather than a data record.


πŸ“Š Walkthrough Reports​

When a walkthrough is completed, a full report is generated. Click the πŸ‘ View icon on any completed row to open it.

Report Header Panels​

Model Families / Asset Information β€” depending on whether the walkthrough was allocated to an asset or a model family, this panel shows the relevant context: asset name, description, make, and model year β€” or asset name, serial number, owner, and model.

Summary

FieldDescription
TitleThe walkthrough template name
TypeWalkthrough
TagsLabels applied to this instance
DescriptionTemplate description
StatusComplete

Report Status

FieldDescription
Start DateWhen the walkthrough was started
End DateThe template's configured end date
Completed OnWhen the technician submitted the final step
Report Statusβœ… Pass or πŸ”΄ Fail

For standard step-based walkthroughs, all step responses are displayed below the header. For PDF walkthroughs, the completed PDF is rendered directly in the report viewer.

Report Actions​

ActionFunction
Download PDFDownload the full report β€” or the completed form PDF for PDF-based walkthroughs

πŸ” Repeating a Walkthrough​

Click the πŸ” Repeat icon on any completed walkthrough row to create a fresh instance from the same template. The original completed record is preserved and the new instance starts immediately.

πŸ“Œ Each completed instance can only generate one repeat. Repeat is particularly useful for walkthroughs that are run on multiple assets using the same procedure β€” start a new repeat for each additional asset rather than re-enrolling from the START NEW tab each time.


πŸ”„ Common Workflows​

Workflow 1 β€” Guided Equipment Commissioning​

  1. Open the Walkthrough app β†’ START NEW tab.
  2. Find the commissioning template by title or tag.
  3. Click Start β†’ confirm the label and select the target asset or system.
  4. Work through each step: review embedded instructions or reference images, upload photos confirming each phase of installation, and enter readings or identifiers where required.
  5. Click Save & Next after each step.
  6. Submit when all steps are complete.

βœ… Result: A fully documented commissioning record β€” timestamped, linked to the asset, and downloadable as a PDF β€” created in the field without any paper forms.


Workflow 2 β€” Completing a PDF Work Order​

  1. Open the Walkthrough app β†’ START NEW tab.
  2. Find the PDF-based work order or field service report template.
  3. Click Start β†’ confirm the label and allocate to the relevant asset or model family.
  4. The PDF form opens in the built-in viewer with pre-filled default values.
  5. Complete all form fields directly on screen.
  6. Click Save Changes to save progress if needed, or Save & Finish to submit.
  7. The completed PDF is stored and the walkthrough moves to Completed.

βœ… Result: The completed work order is stored in the platform and downloadable as a PDF β€” no paper forms, no separate document management required.


Workflow 3 β€” Running the Same Walkthrough Across Multiple Assets​

  1. Complete the walkthrough on the first asset β†’ it moves to Completed.
  2. Click πŸ” Repeat to create a new instance.
  3. In the start dialog, select the next asset from the dropdown.
  4. Complete the walkthrough for that asset.
  5. Repeat for each additional asset.

βœ… Result: Each asset has its own distinct, fully documented walkthrough record β€” all generated from the same template, with no risk of records being mixed up.


Workflow 4 β€” Reviewing Failed Walkthroughs​

  1. Open the COMPLETED tab.
  2. Look for rows with a πŸ”΄ Fail report status badge.
  3. Click πŸ‘ View on any failed walkthrough.
  4. Review which specific steps failed or were not completed.
  5. Identify whether the failure was procedural (step skipped), technical (condition not met), or data-entry (incorrect value).
  6. Coordinate with the assigned technician on corrective action and use Repeat to run a fresh walkthrough once issues are resolved.

βœ… Result: You have a clear, documented record of what failed and where, enabling targeted corrective action.


βœ… Best Practices​

  • Use image guidance steps liberally. Show Image and Show Video steps make walkthroughs self-contained β€” technicians do not need to reference a separate manual. A well-built template reduces errors by showing exactly what to do before asking for confirmation.
  • Require photo uploads at critical phases. Upload Document steps create an unambiguous visual record of conditions at each stage β€” essential for commissioning, warranty, and compliance documentation.
  • Use tags to organize templates by procedure type. Tags like Allocation, Level 5, Mobile, and Commissioning help users find the right walkthrough quickly from a long template list.
  • Repeat rather than re-enroll for recurring procedures. When running the same walkthrough on multiple assets, use Repeat from the previous completed instance rather than re-enrolling from START NEW each time. This keeps records cleaner and avoids confusion between instances.
  • Download PDFs for customer handover. For PDF-based walkthroughs (work orders, field service reports, start-up forms), download the completed PDF immediately after submission and attach it to the service record or share it with the customer.

πŸ’‘ Tips & Shortcuts​

TipHow
Jump to any stepClick the step name in the left panel
Save multiple photos for one stepUse Save & Add Another to submit multiple uploads within the same step
Resume a walkthroughGo to IN-PROGRESS tab β†’ click β–Ά Resume
Repeat a completed walkthroughClick πŸ” on any Completed row
View the completed reportClick πŸ‘ on any Completed row
Download the report or form PDFOpen the report and click Download PDF
Export the full walkthrough listClick Request Data on any tab