Products

A Product is the main container for:

• product metadata
• an optional 3D model
• optional PDF instructions
• procedures
• publish settings
• product-level QR and serial settings

Use this page when you need to create a product, understand Product Home, or prepare the Product Twin before procedure authoring.

Create A Product

Step by step

Create the product container

You can create a product with or without a 3D model. If there is no model, the workflow stays document-first.

ProductsNew Product

Steps

1. Open Products.
2. Click New Product.
3. Enter Product Name.
4. Turn on 3D model if the product needs a Product Twin.
5. Upload the model file if you enabled 3D model.
6. Turn on Instructions if you want AI-assisted procedure generation.
7. Upload the instruction documents in PDF format.
8. Click Create.

Example

Create Hydraulic Pump A3, upload pump.step, and attach pump-manual.pdf. This gives you both the Product Twin workflow and manual-driven procedure generation.

Result

The new product appears in Products and becomes editable after processing finishes.

Screenshot

Products page and New Product modal

The product list stays visible behind the New Product modal so authors can create and reopen products from the same workspace.

Use Product Home

Step by step

Choose the right product-level action

Product Home is the control center for product setup.

ProductsOpen a productProduct Home

Steps

1. Open the product from Products.
2. Use Product Twin for model preparation.
3. Use Product Document for instruction PDFs.
4. Use Publish Settings for public/private procedure access, languages, reporting, and branding.
5. Use Product Settings for viewer links, QR codes, and serial numbers.
6. Use the procedures table for authoring and editing procedures.

Example

If you need to rename parts, go to Product Twin. If you need to generate procedures from the manual, stay on Product Home and use the procedures table.

Screenshot

Product Home

Product Home is the control center for 3D preparation, documents, publishing, QR workflows, and procedures.

Prepare The Product Twin

Step by step

Make the 3D model ready for procedures

Reference names are optional, but realistic states and motion have a strong impact on authoring and generation quality.

Product HomeProduct Twin

Steps

1. In Product Home, click Product Twin.
2. Select a part in the hierarchy.
3. Add a Reference Name only when a part needs a clearer label.
4. Add a Store Link if viewers may need to replace or reorder that part.
5. Create or edit the part states you need so the Product Twin behaves like the real object.
6. Adjust materials or groups only when they help the procedure workflow.
7. Save your changes.

Example

Rename Part_08 to Access Panel, add a store link to the spare part page, and create an Open state if the panel must be opened during maintenance.

Result

Procedures can now refer to clearer parts, and a realistic Product Twin will help generation a lot.

Screenshot

Product Twin in Product Home

The top action bar includes Product Twin.

Screenshot

Product Twin editor

Select a part to edit its optional Reference Name, Store Link, and reusable kinematic states.

Manage Product Documents

Step by step

Keep the product manuals up to date

Instruction documents are used for single-procedure generation and Batch create.

Product HomeProduct Document

Steps

1. In Product Home, click Product Document.
2. Add, replace, or remove the product PDFs.
3. Return to the procedures table.
4. If you use generated content, refresh suggested procedures before generating again.

Example

If you replace an outdated maintenance manual with a new revision, update the document first and then rerun Batch create for the relevant procedures.

Screenshot

Product Document dialog

Product Document keeps the instruction PDFs attached to the product so procedures can be generated and refreshed from the latest manuals.

Use Product Settings

Step by step

Prepare QR and serial workflows

Product Settings is separate from publishing. It is for product-level access, serial registration, and traceability.

Product HomeProduct Settings

Steps

1. In Product Home, click Product Settings.
2. Choose Public or Private.
3. Copy the product link if you need a direct URL.
4. Download the product QR code if you need a scannable access point.
5. Import serial numbers from text, CSV, or TXT, or generate them directly in StepWorks.
6. Export the ZIP of serial-specific QR codes if each unit needs its own tracking path.
7. Attach the matching QR code to each physical product so the viewer opens with the correct serial number already embedded.

Example

For a fleet of machines, import the serial numbers first and then export the QR ZIP so each machine opens the correct traceable workflow.

Result

Each physical unit can open the same published viewer while keeping its own serial number, report history, and execution trace.

Screenshot

Product Settings in Product Home

The top action bar includes Product Settings.

Screenshot

Product Settings page

Use Product Settings to register serial numbers, export the QR ZIP, and keep reporting attached to the correct unit.

Delete A Product

Delete a product only when you are sure you no longer need:

• its procedures
• its publish settings
• its QR and serial setup

Step by step

Delete a product from Products

Only delete a product when you are sure its content is no longer needed.

ProductsProduct cardDelete

Steps

1. Open Products.
2. Find the product you want to remove.
3. Use the delete action on that product.
4. Confirm the deletion when StepWorks asks.

Example

Delete a demo product after internal testing if you no longer need its procedures, publish settings, or QR setup.

Screenshot

Delete action on a product

The product card includes the Delete action.