Further Info

This page provides additional explanations for selected fields and concepts in the SME Adapter.
It focuses on the semantic meaning in the context of Asset Administration Shells (AAS) and related standards.

---

Product Root / Family / Type

These fields define the hierarchical classification of a product in the AAS Product Submodel.

Level	Meaning	Example
Root	The top-level category of the product.	Pumps
Family	A subgroup within the root category, usually defined by function or design.	Centrifugal Pump
Type	The exact technical type or model identifier — often corresponds to a code or model series.	PUMP3000

---

Why is it important?

This classification is not just for UI display, but also:

• Provides semantic structure for the AAS product submodel
• Enables standardized catalog navigation and variant management
• Facilitates interoperability with external systems (ERP, PLM)
• Supports mapping to standards (e.g., ECLASS, IEC 61360)

---

Example Hierarchy

• Root: Drives

  • Family: Electric Motors
    • Type: MOTOR-55kW-400V

• Root: Valves

  • Family: Check Valves
    • Type: VALVE-CV-100

---

Documents / Handover Documentation

The SME Adapter allows you to attach documents to a product entry.
This follows the concept of Handover Documentation (based on VDI 2770 and IDTA guidelines), which ensures that important technical documents can be stored and transferred in a structured way.

---

What is Handover Documentation?

Handover Documentation means that each product can be accompanied by a defined set of documents – such as manuals, certificates, or safety instructions – together with key metadata.
The metadata describes the content, version, and status of the document so that it can be clearly identified and managed over time.

---

Document Version Form

When you click View Documents in the Product List, you will see the Document Version form.
Here you can add metadata to describe a document linked to the selected product.

Fields Explained

Field	Description	Example
Language	The language of the document.	EN, DE
Version	Internal or external version identifier.	v1.0, RevA
Title	The official title of the document.	*Installation Manual PUMP3000 *
Summary	Short description of the document content.	Describes installation and maintenance steps for PUMP3000.
Keywords	Search terms to make the document easier to find.	Pump, Maintenance, Safety
State	The release status of the document.	Draft, Released, Deprecated
State Date	The date when the state was set (e.g., release date).	–
Organisation Name	Short name of the company or institution that issued the document.	HKA GmbH
Organisation Official Name	Full legal name of the organisation.	Hochschule Karlsruhe

---

Best Practices

• Always provide a clear title and version number so documents can be distinguished.
• Use keywords consistently to make searching easier.
• Keep the summary short and precise.
• Make sure the state reflects the actual lifecycle of the document (e.g., Released for customer handover).

---

Usage in SME Adapter

• Open the Product List and click View Documents next to a product.
• Fill in the metadata form as described above.
• Upload the related document file.
• You can create multiple versions of the same document (e.g., new revisions).

This ensures that every product has its relevant documentation stored in a structured and reusable way.