Skip to content

Product Catalog

Raghu edited this page Jul 21, 2026 · 4 revisions

Product Catalog

The Product Catalog is your home screen for products. It lists everything you have created, grouped so it stays tidy even with hundreds of entries. It is also where you add a new product or open an existing one.


Where to find it

Left menu → Product Catalog.

The first time you open it you see No Products Yet and a single Add Product button. Everything described below appears once you have created your first product.

Set up your Manufacturer Details first. A product must be linked to a manufacturer, so the form cannot be completed without one.


Product or unit? Get this right first

Example What it is
Product PUMP3000 The model you sell. You describe it once, including its specifications, documents and certifications.
Unit (instance) PUMP3000, serial 00417 One physical thing you built and shipped. It carries a serial number and a build date.

You describe the product once. Then you register as many units under it as you manufacture. The catalog counts both.

➡️ Product Instances


How products are organised

There are two levels of grouping, so you can drill down instead of scrolling.

Root (category)FamilyProduct

  • Root is the broad group, for example Pumps
  • Family is a sub group inside it, for example Centrifugal Pumps
  • Product is the actual item, for example PUMP3000

Both are required when you create a product, so everything lands somewhere. Products created before this rule existed, or generated by parsing a type code, may appear under Ungrouped or General.

Click a root header to expand or collapse it. Then click a family card to see the products inside. The breadcrumbs at the top take you back.

Not sure how to group your products? Use the way a customer would look for them, not the way your factory is organised. Pumps → Centrifugal Pumps → PUMP3000 is much easier to navigate than Assembly Line 2 → Batch 7.


The product card

Open a family and each product inside it appears as a card. The card is a summary, so you can judge a product without opening it.

On the card What it tells you
Status badge Whether the product can be published, and whether what you already published is still current. Hover it for the full explanation. See below.
Product name The product designation.
Order code Shown underneath in a fixed width font.
Contents line What a published file would actually contain, for example Nameplate · Technical Data · no properties · 3 documents.
Instances How many serial numbered units you have registered under this product.

At the bottom of each card are four buttons.

Button What it does
Open Opens the product's own page. Clicking anywhere else on the card does the same.
Edit Reopens the product form so you can change the manufacturer, hierarchy, codes and versions.
Register Goes straight to the product's instances so you can add a serial numbered unit.
Delete Removes the product. See Deleting a product below.

The top of the page

Under the title you see a counts line: N roots · N products · N instances.

Then four tiles:

Tile Shows
Products How many products are in the catalog.
Instances Total registered units across all products.
Roots How many top level categories you use.
Families How many families exist. This turns orange and reads "! N unassigned" if any product has no family.

There is also a New here? box that explains the idea in a sentence. Close it with the × once you know your way around.

Add product sits at the top right. The same button also appears on each root header and inside each family. Adding from inside a root or family fills in that grouping for you, which saves retyping it.


Product status

Each product card carries a badge. It answers one question: can I publish this, and is what I published still current? Hover over the badge for the full explanation.

Badge Meaning What to do
🟠 Not ready A required field is missing, so the file would not be valid. Open the product and fill in whatever the tooltip names.
🔵 Exportable The required fields are there, so the file is valid. It has not been published yet. Nothing, unless you want it in BaSyx.
🟢 Published It is in BaSyx and it matches your current data. Nothing.
🔴 Out of sync You changed something after publishing, so the copy customers see is old. Publish it again.

What "Not ready" checks

Exactly three things, all of them identity fields:

  1. A manufacturer is assigned
  2. Product designation is filled in
  3. Order code is filled in

The tooltip names the one that is missing, for example "Missing order code. The AAS would be missing a mandatory field."

What "Exportable" does not mean

It means the file will be valid. It does not mean the file is complete. Technical properties and documents are optional in the standard, so a product with neither still shows Exportable. Use the contents line to judge how useful the result really is.

Out of sync

Publishing sends a copy of your product to BaSyx. That copy does not update itself. If you change anything afterwards, such as adding a document, correcting the order code or uploading a new certificate, your customers still see the old version. The badge turns red to tell you.

Publish the product again and it goes back to green.

Older products that were published before the app started watching for this stay green. They will not all turn red at once.


What the file will contain

The contents line on each card tells you what a published file would hold. For example:

Nameplate · Technical Data · no properties · 3 documents

  • Nameplate and Technical Data are always exported, so they always appear.
  • "no properties" appears when no technical data template is assigned. The file still has a Technical Data section, but it is empty. Assign a template and fill in values to give it content.
  • The document count covers the manuals, datasheets and certificates you attached.

This line gives you an honest answer to the question "is this file worth sending to a customer?" A product can be Exportable and still be almost empty.


Deleting a product

Deleting is deliberately slow, because a product usually has a lot of data attached to it.

If anything is attached, the app first shows you exactly what will be affected. For example:

3 registered instances, deleted 2 owned documents, deleted 1 shared document link, unassigned (the documents stay in the Library) Technical data template assignment, removed (the template itself stays)

You then confirm a second time before anything is removed. Nothing is deleted silently.

Three things are worth knowing:

  • Owned documents are deleted together with the product. Shared documents are only unassigned. They stay in the Documents library for other products to use.
  • Templates and type code rules survive. Only the link to this product is removed.
  • There is no undo and no recycle bin. If you are unsure, export the product first.

Tips

  • Work through the orange badges first. A Not ready product cannot produce a valid file at all, so it is the only status that actually blocks you.
  • Decide your roots and families early. Renaming them later means editing every product.
  • When the Families tile turns orange, treat it as a prompt to tidy up.
  • Use Add product from inside a family rather than the button at the top right. The grouping is then filled in for you.

Next

Clone this wiki locally