The management of S1000D Data Modules (DM’s) in a CSDB (Common Source Database) has always been straightforward. The ID & Status section provides a great mechanism for entering metadata pertaining to the Data Module. The same cannot be said of graphics, the Information Control Number (ICN) the actual file name, is the only standard way of obtaining additional information about the graphic. The graphics can be stored in the CSDB, and potentially supplementary data can be entered about the graphic, however, this ability will be dependent on the CSDB’s functionality. However, this method is potentially proprietary, and not acceptable as an S1000D compliant deliverable.
If you wish to manage the project graphics comprehensively issue 4.2 of the specification provides the solution. A new Chapter has been added 3.9.2.7. The chapter details a new strategy for creating metadata for graphics files. The ICN Metadata File (IMF) has the capability to hold specific metadata for an ICN graphic in a separate file. The IMF file is XML encoded, the connection/relationship with the graphic is derived from the ICN code.
Perhaps the best starting point for this post is an overview of the Information Control Number (ICN), Chapter 4.4. The ICN code is similar to the Data Module Code (DMC), it is unique and contains important details about the graphic. They include the Standard Numbering System (SNS), identifying the graphic location relating to the equipment. Also included, the CAGE code of the originating company, Issue Number, and Security Classification. As mentioned before this is a file name only, it does not have the same data management capabilities as the DMC.
The IMF allows the entry of more detailed information about the graphic, similar to the information contained in the DMC ID & Status section.
In Part 2, I will describe the technical aspects of the IMF and its capabilities.
