Information-code tables
The information code (IC) is the field of a Data Module Code (DMC) that says what kind of information a data module holds. It does not say what part of the product the module is about. The Standard Numbering System (SNS) does that. The IC answers a different question: is this a description, a removal procedure, a test, a repair, and so on.
The IC is three characters: a primary code, a secondary code, and a tertiary code. The primary code (the first digit) sorts every data module into one of a small number of families. The secondary and tertiary codes refine the meaning inside that family.
Read an information code from left to right, most general to most specific. In
520, the leading 5 marks the "disconnect, remove, disassemble" family. The
20 narrows it to a specific remove procedure. A trailing letter (the
information code variant, for example the A in 520A) separates near-identical
data modules, such as two alternative remove methods for the same item.
Primary information-code families
These eleven primary categories are defined by the S1000D specification. The
first ten are the numeric 000-900 families. The eleventh, C00, covers
software and computer data.
| Primary code | Family | Covers |
|---|---|---|
000 | Function, plans and description | Descriptive information: what an item is, how it is built, how it works, and data for plans |
100 | Operation | How to operate the product or a system |
200 | Servicing | Routine servicing: replenish, lubricate, clean |
300 | Examinations, tests and checks | Inspections, functional tests, and operational checks |
400 | Fault reports and isolation | Fault reporting and fault-isolation (troubleshooting) procedures |
500 | Disconnect, remove and disassemble | Procedures to disconnect, remove, and disassemble |
600 | Repairs and locally make | Repair procedures and procedures to make an item locally |
700 | Assemble, install and connect | Procedures to assemble, install, and connect |
800 | Package, handling, storage, transport | Packaging, handling, storage, and transportation |
900 | Miscellaneous | Information that does not fit the other families |
C00 | Computer systems, software and data | Software and computer-system information |
The 500 and 700 families are mirror images. The 500 family takes things
apart (disconnect, remove, disassemble). The 700 family puts them back together
(assemble, install, connect). A "remove the pump" data module sits in 500. The
matching "install the pump" data module sits in 700.
Common specific codes (examples)
The secondary and tertiary digits refine the primary family. The codes below are illustrative examples drawn from the specification's standard set. A project may also add its own codes using letters in the tertiary position. Always check the IC against your project's BREX before you rely on it.
| Information code | Meaning | Family |
|---|---|---|
040 | Description (general) | 000 Description |
041 | Description of how a component is made | 000 Description |
042 | Description of the function of a component | 000 Description |
200 | Servicing (general) | 200 Servicing |
258 | Other procedure to clean | 200 Servicing |
520 | Remove procedure | 500 Remove |
720 | Install procedure | 700 Install |
A short way to read a full information code: 041 is "description (0) of how
a component is made." 520 is "remove (5) procedure." 720 is "install
(7) procedure." Once the primary digit is familiar, the rest reads quickly.
How the IC sits inside a DMC
The information code is one field among several in a Data Module Code. The
following DMCs are examples from the s1kd-tools bike-data set. They show the
information code field in context, between the disassembly code and the
information code variant.
BIKE-DA0-00-00-00A-040A-D # 040 = description data module
BIKE-DA0-20-00-00A-520A-A # 520 = remove procedure
BIKE-A-DA1-10-00-00B-720A-D # 720 = install procedure
In each code, the segment immediately before the final block is the information
code plus its variant letter, for example 040A, 520A, 720A. Change that
field and you change the kind of data module while keeping the same product
location.
These DMCs are illustrative examples for teaching the field layout. Real project codes use that project's Model Identification Code and SNS, governed by the project's business rules.
Sources
- S1000D — Wikipedia — overview of the specification, data modules, and the Data Module Code.
- s1kd-tools tutorial — Information codes — worked examples of information codes (040, 520, 720) and full DMCs from the bike-data set.
- Information Control Numbers for S1000D Issue 4.0 or higher — RWS docs — reference list of standard information codes.