Wiki · iiRDS core concepts · Exchange and conformance
iiRDS Consumer: the software role that reads and processes iiRDS packages
The iiRDS Consumer is the receiving side of every iiRDS exchange: the application that reads a package and does something useful with it, such as a content delivery portal, a service app or a server that feeds a retrieval index. The specification defines the consumer as a role for software, not as a class of the vocabulary, and it does not prescribe features or user interfaces. It does set a few rules for processing: every processing application must support the iiRDS ZIP archive, and consumers must ignore unreferenced files in the root directory. This guide explains what a consumer reads, which requirements and recommendations of iiRDS 1.3 apply, what metadata enables, and how the role differs from the iiRDS Generator.
Valid for iiRDS 1.3Last reviewed Level: Introductory
- Technical documentation
- Machinery
- MedTech
- AI retrieval
Definition
In iiRDS (intelligent information Request and Delivery Standard), an iiRDS Consumer is an application that reads and processes iiRDS-compliant information on the receiving end, for example on a server, in a content delivery portal or in a web application. It is a role defined in the specification, not an RDF class.
The consumer is the reason iiRDS metadata exists. A generator describes content with product variants, lifecycle phases, qualifications and information types; the consumer uses exactly these statements to show a service technician the right maintenance task for the right machine. The specification describes such scenarios but leaves the implementation open: it does not say how a consumer stores, searches or displays content.
Processing starts with the iiRDS ZIP archive, which all processing applications must support. The consumer recognizes the package by its mimetype entry, reads META-INF/metadata.rdf and resolves each rendition's relative source path inside the container.
Like the generator, the consumer is not an RDF class. A consumer that imports a package without errors has processed a valid format; it has not verified that the documentation is complete or compliant.
In one sentence
An iiRDS Consumer is whatever software receives a package, reads its metadata and uses it to find, filter, assemble or display the content.
Example
A food producer operates packaging lines from three suppliers. Its content delivery portal is the iiRDS Consumer: it imports each supplier's .iirds file, reads META-INF/metadata.rdf and indexes every topic by product variant, lifecycle phase and qualification. A service technician scans the machine's type plate, selects "maintenance" and sees only the tasks for that variant, together with the tools and spare parts each task needs. An index.html that one supplier added to the root for VDI 2770 is not referenced in the metadata, so the portal ignores it.
How it applies
Technical documentation
For documentation teams, the consumer is where metadata quality becomes visible. Filtering, directory rendering and supply lists all depend on the relations the generator wrote. Consumers find proprietary classes through their iiRDS superclasses, which is why proprietary extensions must comply with the standard.
Migration
A consumer that already supports earlier iiRDS versions should adopt the 1.3 recommendation to ignore iirds:has-rendition on nested packages. The specification also notes that RDF/XML metadata may become deprecated in future versions; reading metadata.jsonld as well, mandatory for iiRDS/H, prepares for that.
MedTech
A MedTech consumer might be a document management system that files handover packages to the right device. In self-contained packages such as iiRDS/A, consumers may omit the few exempt cross-references, for example without internet access, and the content must still be consumable.
AI and retrieval
A retrieval pipeline that ingests iiRDS packages is a consumer too. It can chunk along information units, keep their IRIs as stable identifiers and store product and lifecycle metadata as filters, so an assistant answers for the right machine instead of the closest match.
Consumer vs. Generator
| iiRDS Consumer | iiRDS Generator | |
|---|---|---|
| Side | Receiving | Sending |
| Task | Reads and processes packages | Creates packages from source formats |
| Must support | iiRDS ZIP archive | Writing a valid container and ZIP archive |
| Must ignore | Unreferenced root files | — |
The iiRDS Generator and the consumer never need to know each other; the package format is their only contract.
In RDF
These are the kind of statements a consumer queries to select content for a variant, phase and role. Shown in Turtle for readability — inside a package, metadata.rdf is written in RDF/XML.
@prefix iirds: <http://iirds.tekom.de/iirds#> .
<https://example.com/iirds/topics/replace-sealing-jaw> a iirds:Topic ;
iirds:relates-to-product-variant <https://example.com/iirds/products/packer-p40> ;
iirds:relates-to-product-lifecycle-phase iirds:Maintenance ;
iirds:relates-to-qualification <https://example.com/iirds/roles/service-technician> .
<https://example.com/iirds/products/packer-p40> a iirds:ProductVariant .
<https://example.com/iirds/roles/service-technician> a iirds:Role .
In topic-based authoring and modular architectures
Topic-based authoring pays off at the consumer. Because content arrives as individual topics with their own metadata, the consumer can assemble task-specific views instead of showing whole manuals, and it can combine topics from several suppliers in one interface. In modular delivery architectures the consumer is replaceable: a portal, a mobile service app and an AI retrieval index can all read the same package without changes on the authoring side. The consumer should treat the iiRDS XHTML5 class attribute as styling only; the specification requires that an iiRDS XHTML5 consumer can ignore or modify class values without loss of meaning.
Concept cluster
How this concept connects to the other iiRDS core concepts.
- iiRDS GeneratorThe sending counterpart that creates the packages a consumer reads.
- iiRDS container and ZIP archiveThe layout and archive format every consumer must be able to open.
- iiRDS metadataThe statements a consumer uses to filter and assemble content.
- iiRDS RenditionThe files a consumer locates through relative source paths.
- Audience in iiRDSQualification metadata that lets consumers select content per target group.
- iiRDS ProductLifeCyclePhaseLifecycle metadata that lets consumers deliver content for a specific phase.
Also searched as
- iiRDS Consumer
- iiRDS import
- iiRDS content delivery portal
- process iiRDS package
- iiRDS consuming application
- iiRDS conformance
- iiRDS-consuming application
Questions this article answers:
- what is an iiRDS consumer
- how to import an iiRDS package
- iiRDS content delivery portal
- iiRDS consumer requirements
Explore further
In the glossary
Frequently asked questions
- What is an iiRDS Consumer?
- It is an application that reads and processes iiRDS-compliant information on the receiving end, for example a content delivery portal, a server or a web application.
- Is there an iirds:Consumer class?
- No. Consumer is a term from the specification's terms and definitions, not a class of the iiRDS vocabulary.
- Which archive format must an iiRDS Consumer support?
- The iiRDS ZIP archive with the extension .iirds. The specification requires all processing applications to support it.
- What should a consumer do with extra files in an iiRDS package?
- It must ignore files in the root directory that iiRDS metadata does not reference, such as files added for VDI 2770. The specification also recommends ignoring any other files in the META-INF directory.
- Does the iiRDS standard define portal features?
- No. It describes scenarios such as filtering by product or building spare-part lists, but it does not specify how a consumer is implemented or which features it offers.
- How does a consumer handle nested packages in iiRDS 1.3?
- It is recommended to ignore the iirds:has-rendition relation of a nested package and to read the nested content from the nested package's own metadata.
Conclusion
The iiRDS Consumer turns a package from a file into a service. The specification keeps its obligations small — open the ZIP archive, ignore what is not referenced, stay robust — and leaves everything else to the product. How useful a consumer is depends mostly on the metadata the generator provided, and a successful import says nothing about whether the documentation itself is correct.