MILITARY SPECIFICATION DATA BASE, REVISABLE: INTERACTIVE ELECTRONIC TECHNICAL MANUALS, FOR THE SUPPORT OF This specification is approved for use by all Departments and Agencies of the Department of Defense. 1. SCOPE. 1.1 Scope. This specification prescribes the requirements for an Interactive Electronic Technical Manual Data Base (IETMDB) to be constructed by a weapon-system contractor for the purpose of creating Interactive Electronic Technical Manuals (IETM). The requirements herein cover the specification for the IETMDB and are intended to apply to one or both of two modes as specified in a contract: (1) the interchange format for the data base to be delivered to the Government; or (2) the structure and the naming of the elements of the data base created and maintained by the contractor for purposes of creating IETMs which are in turn delivered to the Government. 1.2 Paragraphs with limited applicability. This specification contains paragraphs and specific requirements which are applicable to all Services. Such paragraphs or requirements are prefixed to indicate the Services to which they pertain: (A) for Army; (N) for Navy; (M) for Marines; and (F) for Air Force. AMSC AREA TMSS Distribution Statement A. Approved for public release; distribution is unlimited. 1.3 Introduction. The following introductory material is included in this specification in order to fully acquaint offering contractors with the new requirements and characteristics of a data base developed specifically for IETMs. 1.3.1 Nature and purpose of a revisable source data base. For complex weapon systems and other types of military equipment, adequate logistic support in all its forms requires an enormous amount of current, readily accessible, accurate, and highly detailed data, consisting of Technical information (TI). This information has been traditionally prepared and distributed to the end user in paper form; but with new technology it can be better and more effectively displayed or presented electronically and interactively to an end user. The material presented is derived from material stored in textual, graphical, audio, or video form in a revisable data base which is composed of logically connected but randomly accessible IETM data elements. It is this starting point of the IETM electronic data chain that is specified in this document. The concept that the Services can either acquire and maintain large scale data bases of this type, or acquire access to such data bases, maintained continuously by a contractor, is an integral part of the IETM concept and in the larger arena of the Department of Defense (DoD) Computer-aided Acquisition and Logistic Support (CALS) program. 1.3.1.1 IETMDB capabilities. An IETMDB is a complete collection of data base elements relating to a weapon system or other equipment acquired by the Government and constructed in a standardized manner in order to provide the following capabilities: a. The IETMDB can serve as the basis for construction and update of the entire suite of weapon system electronically displayed (IETMs) through the use of automated authoring systems. b. Government activities or DoD contractors concerned with logistic support for the weapon system involved can access the data base directly to obtain needed logistic support information for specific purposes. c. The IETMDB, or portions of it, can be interchanged by means of standardized formats and procedures throughout the DoD and its supporting contractors when needed for any purpose. 1.3.2 Technical information procurement options. Acquisition of IETMs may be carried out by one of several optional approaches. This specification provides requirements for a standardized IETMDB which will permit the Government to acquire TI by applying any of the following contractual options: a. Acquisition of only the final-form IETMs which are required. Although the author (equipment prime contractor) will need to establish an automated equipment or weapon- system (source) data base, this data base will not be acquired by the Government, but will be maintained, used, and controlled by the contractor, both for the preparation of IETMs and for other purposes. The Government under this specification requires that the data base be structured and the individual data elements named and attributed in a standard manner. However, an explicitly tagged data file need not be prepared for delivery as no data base delivery is required. b. Acquisition of the IETMDB. Acquisition of the IETMDB may involve either of the following options: (1) Delivery to the Government in standardized form and subsequently maintained by the Government (with or without update information supplied on a continuing basis by the contractor). (2) Title acquired to the IETMDB by the Government, but with the data base retained and maintained in standardized form in the contractor's plant. The Government could be provided with on-line access to the data base. c. Acquisition of fully constructed IETMs (fully prepared and validated by the contractor), as well as the IETMDB upon which they are based. Acquisition under this option may involve either option (1) or (2) as given in 1.3.2b above. 1.4 Format free technical information. The IETMDB will consist of an assemblage of data elements, including a listing of the specific attributes possessed by the data elements; and a list of explicit relationships providing logical links among the data elements. The relationships incorporated into the data base by the IETMDB author provide the basis of the technical structure of the IETMs and other logistic support TI which will be extracted from it. The IETMDB will not, however, contain format directions in the sense of arrangement of text and graphics on a display screen for presentation to the end user. The IETMDB itself will, of course, require a "format" (data base structure) but this specification does not impose structural requirements on the actual Data Base Management System (DBMS) methodology to be employed (e.g., the data base may be either relational or object oriented). The exterior view of the data base to be used for updating, adding cross references, producing tagged output files, etc. must conform to requirements of this specification. 1.4.1 Data portability. Elimination of formatting requirements for the IETMDB reduces the overall magnitude of data base and data interchange standardization effort, and permits use of a less complex DBMS by the contractor which is, in turn, less expensive and easier to modify. The "format-free" nature of the IETMDB is intended to provide the Government the capability to: a. Acquire or access the data in a variety of ways (IETMs, other types of logistics reports; training TI, etc.); b. Subsequently format and style the data in a variety of ways for electronic display options. 1.4.2 Integration support. Since one of the functions of the IETMDB is to provide direct on-line data access to a variety of users and to a number of automated logistic support and management information systems throughout the Services, establishment of standard identifiers, data entity relationships, and multiple path access routes to individual data elements is an important part of IETMDB design and construction. 2. APPLICABLE DOCUMENTS. 2.1 Government documents. 2.1.1 Specifications, standards and handbooks. The following specifications, standards and handbooks form a part of this document to the extent specified herein. Unless otherwise specified, the issues of these documents are those listed in the issue of the Department of Defense Index of Specifications and Standards (DODISS) and supplement thereto, cited in the solicitation (see 6.2). SPECIFICATIONS Military MIL-M-87268 - Manual, Technical: General Content, Style, Format, and User Requirements for Interactive Electronic Technical Manuals MIL-Q-87270 - Quality Assurance Program: Interactive Electronic Technical Manuals and Associated Technical Information; Requirements for STANDARDS Military MIL-STD-1388-1 - Logistics Support Analysis MIL-STD-1388-2 - Logistics Support Analysis Record, DoD Requirements for a MIL-STD-1840 - Automated Interchange of Technical Information (Unless otherwise indicated, copies of federal and military specifications, standards and handbooks are available from the Standardization Documents Order Desk, Building 4D, 700 Robbins Avenue, Philadelphia, PA 19111-5094.) 2.1.2 Other Government documents, drawings and publications. The following other Government documents, drawings and publications form a part of this specification to the extent specified herein. Unless otherwise specified, the issues are those cited in the solicitation. PUBLICATIONS Department of Defense DOD 5200.1-R - Information Security Program Regulations DOD 5220.22-M - Industrial Security Manual for Safeguarding Classified Information (Application for copies should be addressed to the Superintendent of Documents, US Government Printing Office, Washington, DC 20402.) 2.2 Non-Government publications. The following documents form a part of this document to the extent specified herein. The issues of the documents which are DoD adopted are those listed in the issue of the DODISS cited in the solicitation. Unless otherwise specified, the issues of documents not listed in the DODISS are the issues of the documents cited in the solicitation. ISO 8879 - Information Processing - Text and Office Systems - Standard Generalized Markup Language (SGML) ISO/IEC IS10744:1992- Information technology - Hypermedia/Time-based Structuring Language (HyTime) (Application for copies should be addressed to the American National Standards Institute, 1430 Broadway, New York, NY 10018.) 2.3 Order of precedence. In the event of a conflict between the text of this document and the references cited herein, the text of this document shall take precedence. Nothing in this document, however, supersedes applicable laws and regulations unless a specific exemption has been obtained. 3. REQUIREMENTS. 3.1 General requirements. An IETMDB developed in accordance with this specification shall conform to the Content Data Model (CDM) specified herein. The CDM employs a two layered approach to define technical information. The top layer, called the "Generic Layer", defines the semantic rules for the data characteristics. The generic layer is defined in Appendices A and C of this specification. The bottom layer, called the "Content Specific Layer", employs the generic layer when defining elements for weapon system specific TI. Appendices B and D contain a content specific layer model developed for organizational level maintenance. Many content specific layers can be developed in accordance with the generic layer. The CDM generic layer defined in Appendices A and C of this specification will be the (DoD) standard for any data base of IETM technical information procured using this specification. In addition, unless otherwise specified by the procuring activity, the content specific layer defined in Appendices B and D of this specification shall also be part of this specification (see 6.2). If Appendices B B and D of this specification are not specified by the procuring activity, some other content specific layer Document Type Definition (DTD) must be specified and approved by the government. The IETMDB can be invoked by a procuring activity in either one of two modes as follows, depending on whether a data base is (1) specified for interchange and delivery to the Government, or (2) being developed and maintained for the subsequent preparation of IETMs, but not actually delivered to the Government. 3.1.1 Data Base interchange requirements. When specified, IETMDBs which are to be delivered to the Government under this specification shall be structured and tagged in accordance with the DTDs and the tag set descriptions included as Appendices A through D of this specification (see 6.2). 3.1.2 Data base structuring and data element naming requirements. Unless otherwise specified, a deliverable instance created under this specification shall be structured in accordance with the hierarchical relationships defined in the CDM DTDs contained in Appendices A and B, and created and named in accordance with the tag set descriptions contained in Appendices C and D (see 6.2). When a tagged instance is not specified for delivery, the contractor shall maintain the ability to map the internal element names to the specified content specific DTD names. 3.1.3 Data maintainability. The IETMDB shall be constructed with provisions to allow the incorporation of any change to automatically update all aspects of the data base affected by that change. This data-maintainability requirement shall involve changes to the IETMDB of the following two kinds: a. Additions to, eliminations of, or changes to individual data elements and attributes; b. Changes to relationships including establishment of new relationships or elimination of old relationships. 3.1.4 Additional content specific DTDs. When specified, additional content specific DTDs shall be used in addition to or instead of the content specific DTD defined in Appendices B and D of this specification (see 6.2). These DTDs shall be incorporated into the overall CDM in accordance with the requirements of 3.2. 3.2 Generic layer. The generic layer of the CDM is defined in the DTD listed in Appendix A. This DTD provides templates, which shall be used to define content specific elements. The generic layer includes a definition for each template and the attribute lists associated with the template. The DTD provides a definition of three other data types: primitive data elements that shall remain standard across all content specific applications; user interaction elements, called dialogs; and the context filtering elements, which shall be used to provide the most appropriate information to a user. The following paragraphs provide a description of the components of the generic layer. 3.2.1 Templates. Templates shall be used as described in Appendix A to define elements declared in content specific DTDs. The generic layer contains five templates: Node, Node Alternatives, Node Sequence, If Node, and Loop Node. Each template has two components: (1) a set of semantic rules that govern the template's activities, and (2) a list of attributes. 3.2.1.1 Node template. All elements conforming to the node template provide the capability for creating composite structures within the content specific layer. Composite structures contain primitives, links, and preconditions. When a composite structure contains other composite structures within its content model, this implies hierarchy. Elements employing the node template shall have a set of required attributes as follows. 3.2.1.1.1 Name. The "name" attribute of the element shall consist of the standard nomenclature for an instance of the element. 3.2.1.1.2 Item-Id. The "Item-Id" attribute shall specify the reference designator(s) and other identifiable designator(s) of the system(s), subassemblies, or part(s) referred to by the element. 3.2.1.1.3 Type. The "type" attribute shall specify the type of information contained in the element. 3.2.1.1.4 CDM. The "cdm" attribute shall identify the type of template being employed by the content specific element. 3.2.1.1.5 Ref. The "ref" attribute shall facilitate the reduction of data redundancy by allowing data elements to be referenced. 3.2.1.2 Node Alternatives (Alts) template. All elements conforming to the Node Alts template shall contain a list of mutually exclusive nodes, only one of which will be used at the time of presentation. 3.2.1.3 Node Sequence (Seq) template. All elements conforming to the Node Seq template group elements together as well as providing an order or presentation sequence to the elements. The elements conforming to the Node Seq shall also allow an author to define branching logic within the TI. 3.2.1.4 If Node template. Elements conforming to the If Node template provide a method for conditional branching. These elements shall use the same logic as the IF-THEN-ELSE statement in a programming language. The "IF" part is the expression in the content model. The "THEN" part is the first Node Seq, and is selected when the expression evaluates to true. The "ELSE" part is the second Node Seq, which is optional in the CDM, and is selected when the expression evaluates to not true. 3.2.1.5 Loop Node template. The Loop Node template provides the equivalent of a loop in a programming language. This element shall provide the capability to create either a "FOR" loop or a "WHILE" loop within the data. The expressions and assertions developed in accordance with this template provide the testing criteria for the loop. The node sequence shall contain the actual elements to be repeated within the loop. 3.2.2 Relational links. Elements shall have relationships to other elements in TI, when applicable. These relationships shall be represented through two or more link ends. The link element shall provide the capability to show the relationship between several elements. The contractor shall include the specific cross references to elements within the IETMDB as well as information sources outside the IETMDB. 3.2.2.1 Links to reduce redundancy. Links shall be used to reduce the number of redundant elements by referencing common elements. The templates defined within the generic layer CDM DTD define attributes to reduce redundant elements. These elements shall utilize the SGML #CONREF reference capability in accordance with ISO 8879. A #CONREF attribute, used only in instances where an elements content model is EMPTY, shall contain the unique identifier of an element using a template or a location element. 3.2.2.2 Location elements. The location elements are defined by ISO/IEC IS10744:1992. Elements shall be referenced by other elements in accordance with ISO/IEC IS10744:1992. 3.2.2.3 Logistics support and task-analysis link. The contractor shall establish linkages (information- access capabilities) with the IETMDB when external logistics support and task analysis systems developed in accordance with MIL-STD-1388-1 and MIL-STD-1388-2 exist. 3.2.3 Primitive elements. An IETMDB shall be composed of the primitive elements defined in the generic layer DTD as follows. Content and style for these elements shall be in conformance with the requirements of MIL-M-87268. 3.2.3.1 Textual information. Textual information shall consist of alphanumeric (i.e., character) data. Textual information shall also contain embedded references to some higher level elements such as those describing parts or consumables. 3.2.3.2 Tables. Tables shall be represented as a series of separate entries, each entry being associated with a specific row and column intersection (cell) of a table. Each entry in the table may be associated with other primitive types of information presentation and attributes. Each entry may refer (through a relationship) to any other template element or primitive element in the IETMDB. 3.2.3.3 Graphics. Graphics (drawings, illustrations) information shall be structured in a hierarchical manner and consist of logically related groups. Graphics shall be composed of a series of illustrations which can be overlaid on each other to build a complete graphic. These graphic "building blocks" are called graphic primitives. Graphic primitives may be combined to produce composite information which can be referenced and selected. Graphics shall be composed of information represented in accordance with the graphic standards included in MIL-STD-1840. 3.2.3.4 Audio, video, and process. The elements audio, video, and process provide the capability for the author to define an audio sequence, a video sequence, or a call to a software process. 3.2.3.5 Dialogs. Dialog elements are the basic element which provides the capability for user interaction with the TI. During a presentation these elements shall be used to prompt the user to input a response ("fillin"), select a choice from a set of alternatives ("menu"), or to select items from within a text, table or graphic ("selection"). 3.2.4 Context dependent filtering. Context dependent filtering shall be accomplished through author- defined preconditions. A precondition shall contain an expression which will contain all the information necessary to identify what conditions must be present to display the TI. 3.2.4.1 Preconditions. A precondition shall contain an expression which identifies the conditions which must be present to display the TI. Precondition elements may be referenced by node elements. This implies that the element's information is relevant only if the precondition is true in the presentation situation. 3.2.4.2 Postconditions. Postconditions assert the value of an expression to a property. Once these property values are asserted, they shall be accessible to the presentation software for later testing and processing to determine the user's situation. 3.2.4.3 Expressions. Any expressions developed for an IETMDB shall conform to one of four types of expressions defined in the CDM. The first is a binary operation between two expressions; the second is a unary operation which is applied to an expression; the third and fourth are operations that identify an unique property (variable) or a value to be used in an expression. 3.3 Content specific layer. All TI shall be structured in accordance with a content specific DTD. One content specific DTD shall apply for an entire set of information regardless of the desired access to the information. The CDM will define the content and structure of the TI but will not describe format information. 3.3.1 Control of content specific DTDs. The contractor shall not exchange TI with the DoD unless it has been developed in accordance with the generic layer DTD and one or more of the latest versions of DoD approved content specific DTDs. If a content specific DTD does not exist which meets the contract's requirements, the contractor shall submit a content specific DTD to the Government for approval. 3.3.2 Development of content specific DTDs. If a new content specific DTD is developed, the contractor shall assure the content specific DTD meets the requirements of ISO 8879, and the requirements imposed by the generic layer DTD. 3.3.2.1 Use of generic DTD primitive elements. The generic layer of the CDM shall define a set of primitive elements. Those elements shall be available to any content specific layer DTD that includes the generic layer in an entity declaration. Any element defined within a content specific DTD which requires the use of any of the primitive elements need only include text, table, graphic, or dialog within its content model. The contractor shall not redefine the primitive elements within the content specific DTD. The elements using the primitive elements shall be restricted to the structure of the primitive elements as defined within the generic layer. 3.3.2.2 Use of generic DTD template elements. Elements within a content specific DTD shall conform to one of the templates defined within the generic layer. Elements shall include the attributes listed under the generic layer's definition of the templates. The two common attributes among the five templates are identification (id) and content data model (cdm). Each element employing a template includes an identification attribute for referencing. The cdm attribute identifies which template an element is employing. 3.3.3 Content specific DTD for Organizational Level (O-Level) maintenance. The following describes requirements for the content specific DTD included in this specification. 3.3.3.1 Item/System hierarchy. The vehicle, weapon system, or other equipment that is being maintained and operated is composed of several layers of subsystems, components, and parts. This hierarchical representation of the equipment being maintained and operated shall be accomplished by use of a system element that is used recursively, and which decomposes the equipment into only those components that are being maintained or operated. Each component of this hierarchy has associated with it one or more of the following four categories of information: a. Descriptive information b. Procedural information c. Troubleshooting information d. Parts information 3.3.3.2 Descriptive information. Descriptive information may provide information on system (subsystem, component, part) physical arrangement, functional behavior, theory of operation, and other aspects. Descriptive information shall contain a hierarchy of narrative paragraphs. Paragraphs, in turn, may refer to primitive elements. 3.3.3.3 Procedural information. Procedural information shall be composed primarily of task statements. Each task element shall be associated with attributes which provide related information such as: estimated completion time; maintenance level(s) where the task is to be performed; required conditions which must be met before performing the task; and the number of people required to perform the task. A procedural element may be linked to other elements which define the support equipment and consumables that task requires, through the establishment of appropriate relationships. 3.3.3.4 Troubleshooting information. Troubleshooting information shall contain data necessary to isolate faults found in a system. Troubleshooting information shall contain fault elements, fault state elements, test elements, outcome elements, and rectification elements. 3.3.3.4.1 Fault elements. Fault elements shall identify potential faults which might occur in the system. 3.3.3.4.2 Fault state elements. Fault state elements shall present a list of faults implicated as the result of a test that has been performed. Each suspected fault in the list shall be weighted, based on the probability that it is the cause of the observed malfunction. The fault state element may also present a list of possible faults that have been eliminated from consideration as the result of tests performed. 3.3.3.4.3 Test elements. Test elements shall contain a link to the procedural instructions a technician must follow to carry out a required task at a particular juncture in the troubleshooting procedure. Test elements shall also provide all possible test outcomes. 3.3.3.4.4 Outcome elements. Outcome elements shall contain definitions of new fault states associated with the results of a particular test. Outcome elements shall also contain a description of the state of the item being maintained. An outcome is based on one or more expressions (i.e., system states which must be established for the specific outcome to apply). The final outcome element of a fault isolation procedure shall have a relationship which associates it with an identified fault. The identified fault has, in turn, associated with it the initial element of the appropriate corrective maintenance action. 3.3.3.4.5 Rectification elements. Rectification (i.e., corrective maintenance actions) elements shall contain references to procedural rectification tasks, checkout tests used to report the success of completed rectification tasks, and a list of all faults that the rectification shall repair. 3.3.3.5 Parts information. Two types of parts information shall be included: (1) maintainer/operator information, and (2) supply information. Elements containing either type shall refer explicitly to corresponding elements of the other type. 3.3.3.5.1 Parts information for the maintainer or operator. Parts information provided for a system maintainer and/or operator shall include such items as units per assembly, usable-on code, Mean Time Between Failures (MTBF), and reference designator, if applicable. 3.3.3.5.2 Parts information provided for parts supply. Parts information provided for the parts supply process shall constitute unambiguous identification of a part so that it can be reordered, and may consist of such items as: the part number; Commercial And Government Entity (CAGE) code; Source, Maintenance, and Recoverability (SMR) code; Hardness Critical Item (HCI) identification; and National Stock Number (NSN), if applicable. 4. QUALITY ASSURANCE PROVISIONS. 4.1 Responsibility for inspection. The contractor is responsible for the performance of all inspection requirements (examinations and tests) as specified herein. Quality Assurance (QA) for the IETMDB preparation shall be in accordance with the requirements of MIL-Q-IETMQA. Except as otherwise specified in the contract or purchase order, the contractor may use his own or any other facilities suitable for the performance of the inspection requirements specified herein, unless disapproved by the Government. The Government reserves the right to perform any of the inspections set forth in this specification where such inspections are deemed necessary to ensure supplies and services conform to prescribed requirements. 4.1.1 Responsibility for compliance. All items shall meet all requirements of sections 3 and 5 of this specification. The inspection set forth in this specification shall become a part of the contractor's overall inspection system or quality program. The absence of any inspection requirements in this specification shall not relieve the contractor of the responsibility of ensuring that all products or supplies submitted to the Government for acceptance comply with all requirements of the contract. Use of sampling for inspections shall be in accordance with MIL-Q-IETMQA; however, Government approval for use of sampling in QA procedures does not authorize submission of known defective material, either indicated or actual, nor does it commit the Government to accept defective material. 5. PACKAGING. 5.1 Preparation for delivery. Items shall be packaged in the most economical manner that will provide adequate protection during shipment in accordance with accepted industrial packaging procedures. 5.1.1 Digital product packaging. Packaging of encoded computer products, in preparation for delivery, shall be in accordance with the requirements of MIL-STD-1840. 5.1.2 Classified material. Classified material shall be packaged and identified in accordance with DOD 5200.1-R, DOD 5220.22-M, and the implementing Service regulations. 6. NOTES. (This section contains information of a general or explanatory nature that may be helpful, but is not mandatory.) 6.1 Intended use. An IETMDB is the source data for the preparation of IETMs. IETMs prepared in accordance with this specification are intended for use in the installation, operation, maintenance, repair, and logistics support of equipment/systems or for the accomplishment of the assigned mission of users. 6.2 Acquisition requirements. Acquisition documents must specify the following: a. Title, number and date of the specification. b. Issue of the DODISS to be cited in the solicitation, and if required, the specific issue of individual documents referenced (see 2.1.1, 2.1.2). c. If IETM program elements shall be other than as specified herein (3.1). d. If the specification applies to the delivery and tagging of an IETMDB (3.1.1). e. If the specification applies to the structuring of the IETMDB and naming of the IETMDB elements which are created and maintained by the contractor (3.1.2). f. Content specific DTDs other than the one included herein and whether these are to be used in addition to or instead of the content specific DTD included herein, if additional DTDs apply (3.1.4). 6.3 Data requirements. Any applicable Data Item Descriptions (DIDs) must be listed on the Contract Data Requirements List (CDRL) when this specification is applied on a contract, in order to obtain the data, except where DOD FAR Supplement 27.475-1 exempts the requirement for a DD Form 1423. DID citations shall be as follows: Reference Suggested Paragraph DID Number DID Title Tailoring (None Required) 6.4 Definitions of acronyms and terms. Acronyms and IETM terms not listed in MIL-STD-12 are included in the definitions contained in 6.4.1 through 6.4.3. 6.4.1 Acronyms. a. ALHRG - Armstrong Laboratory Human Resource Division b. AFLC - Air Force Logistics Command c. AMSC - Acquisition Management Systems Control (number) d. ANSI - American National Standards Institute e. CAGE - Commercial And Government Entity f. CALS - Computer-aided Acquisition and Logistic Support g. CDM - Content Data Model h. CDRL - Contract Data Requirements List i. DBMS - Data Base Management System j. DD - Department of Defense (document-number prefix) k. DID - Data Item Description l. DLA - Defense Logistics Agency m. DoD - Department of Defense n. DODISS - Department of Defense Index of Specifications and Standards o. DTD - Document Type Definition p. DTRC - David Taylor Research Center q. EDS - Electronic Display System r. HCI - Hardness Critical Item s. IETM - Interactive Electronic Technical Manual t. IETMDB - IETM Data Base u. IETMQA - IETM Quality Assurance (program) v. ISO - International Standards Organization w. MTBF - Mean Time Between Failures x. NSN - National Stock Number y. QA- Quality Assurance z. QAP - Quality Assurance Program aa. SGML - Standard Generalized Markup Language bb. SMR - Source, Maintenance, and Recoverability (Code) cc. STD - Standard dd. TI - Technical Information ee. TMSS - Technical Manual Specifications and Standards (standardization program) 6.4.2 Interactive Electronic Technical Manual (IETM). A technical manual, prepared (authored) by a contractor and delivered to the Government, or prepared by a Government activity, in digital form on a suitable medium, by means of an automated authoring system; designed for electronic screen display to an end user, and possessing the following three characteristics: a. The format and style of the presented information are optimized for screen presentation to assure maximum comprehension; that is, the presentation format is "information oriented", not "page oriented". b. The elements of technical data constituting the IETM are so interrelated that a user's access to the information required is facilitated to the greatest extent possible, and is achievable by a variety of paths. c. The computer controlled IETM display device can function interactively (as a result of user requests and information input) in providing procedural guidance, navigational directions, and supplemental information; and also in providing assistance in carrying out logistic support functions supplemental to maintenance. 6.4.3 Quality assurance. A planned and systematic series of procedures carried out by the contractor as monitored by the Government, necessary to ensure a high degree of confidence that deliverable technical data conforms to contract requirements. The culminating action in a Quality Assurance Program (QAP) is contractor support of the Government verification procedure. 6.5 Subject terms (key word) list. Database Interactive Electronic Technical Manual (IETM) Content Data Model (CDM) Technical Manuals Custodian: Preparing Activity: Air Force - 16 Air Force - 16 Army - TM Navy - AS Review Activities: (Project TMSS-0296) Air Force - 11, 13, 14, 18, 19, 30, 70, 71, 80, 82, 84, 99 Army - AL, AR, AT, AV, CR, EA, MI, PT, SC, TR Navy - AS, EC, MC, SA, SN, TD, YD User Activities: Air Force - 11, 13, 14, 18, 19, 30, 70, 71, 80, 82, 84, 99 Army - AL, AR, AT, AV, CR, EA, MI, PT, SC, TR Navy - AS, EC, MC, SA, SN, TD, YD GENERIC LAYER DOCUMENT TYPE DEFINITION (DTD) 10. SCOPE. 10.1 Scope. The Document Type Definition (DTD) within this appendix provides the structure and content of documents prepared in accordance with this specification. This Appendix is a mandatory part of this specification. The information contained herein is intended for compliance. 20. APPLICABLE DOCUMENTS. 20.1 Government documents. 20.2 Non-Government publications. The following documents form a part of this document to the extent specified herein. Unless otherwise specified, the issues of the documents which are DoD adopted are those listed in the issue of the DODISS cited in the solicitation. Unless otherwise specified, the issues of documents not listed in the DODISS are the issues of the documents cited in the solicitation. ISO 8879 Information Processing - Text and Office Systems - Standard Generalized Markup Language (SGML) ISO/IEC IS10744:1992 Information Technology - Hypermedia/Time-based Document Structuring Language (HyTime) (Application for copies should be addressed to the American National Standards Institute, 1430 Broadway, New York, NY 10018.) 30. GENERIC LAYER DOCUMENT TYPE DEFINITION. 30.1 Use of SGML. The markup tags described herein are based on rules outlined in ISO 8879. All data to be delivered digitally in accordance with this specification shall be tagged using the DTD in this section and associated content specific DTD(s). 30.2 Template document type. The DTD for this specification is as follows: %hytime; %mathpac; A CONTENT SPECIFIC DOCUMENT TYPE DEFINITION (DTD) 10. SCOPE. 10.1 Scope. The DTD within this appendix provides the structure and content of documents prepared in accordance with this specification. This Appendix is a mandatory part of this specification unless otherwise specified by the procuring activity. The information contained herein is intended for compliance. 20. APPLICABLE DOCUMENTS. 20.1 Government documents. 20.2 Non-Government publications. The following documents form a part of this document to the extent specified herein. Unless otherwise specified, the issues of the documents which are DoD adopted are those listed in the issue of the DODISS cited in the solicitation. Unless otherwise specified, the issues of documents not listed in the DODISS are the issues of the documents cited in the solicitation. ISO 8879 Information Processing - Text and Office Systems - Standard Generalized Markup Language (SGML) ISO/IEC IS10744:1992 Information Technology - Hypermedia/Time-based Document Structuring Language (Hytime) (Application for copies should be addressed to the American National Standards Institute, 1430 Broadway, New York, NY 10018. ) 30. A CONTENT SPECIFIC DOCUMENT TYPE DEFINITION. 30.1 Use of SGML. The markup tags described herein are based on the rules outlined in ISO 8879. All data to be delivered digitally in accordance with this specification shall be tagged using the DTD in this section and the generic DTD found in Appendix A. 30.2 Template document type. The DTD for this specification is as follows: %ietmdb-a; ] GENERIC LAYER TAG SET DESCRIPTIONS 10. SCOPE. 10.1 Scope. This appendix provides the detailed description of the elements and attributes to be included in an IETM Data Base. It is formulated as a description of possible tags or names for components in an IETM Data Base whose structure is defined by the Generic Layer DTD specified within Appendix A of this specification. This Appendix is a mandatory part of this specification. The information contained herein is intended for compliance. 20. APPLICABLE DOCUMENTS. 20.1 Government documents. 20.2 Non-Government publications. The following documents form a part of this document to the extent specified herein. Unless otherwise specified, the issues of the documents which are DoD adopted are those listed in the issue of the DODISS cited in the solicitation. Unless otherwise specified, the issues of documents not listed in the DODISS are the issues of the documents cited in the solicitation. ISO 8879 Information Processing - Text and Office Systems - Standard Generalized Markup Language (SGML) ISO/IEC IS10744:1992 Information Technology - Hypermedia/Time-based Document Structuring Language (HyTime) (Application for copies should be addressed to the American National Standards Institute, 1430 Broadway, New York, NY 10018.) 30. GENERIC LAYER TAG SET DESCRIPTIONS. 30.1 Use of SGML. The markup tags described herein conform to rules defined in ISO 8879. 30.2 Tag Set Descriptions. Data elements shall be defined in accordance with the Tag-Set Descriptions included below (see 3.1.2). AGENT Dialog Agent Descriptor: Attribute Format: Character Data Template Used: N/A Description: Used in the dialog element, this attribute defines to whom the question is asked. The value of this attribute contains character data which identifies the person or computer to whom the dialog should be presented. The default value is 'human'. ASSERTION Assertion Descriptor: Element Format: N/A Template Used: N/A Description: This element is used to make an assertion from within the content model of an application specific element. Whenever an assertion appears in an element's content model, there shall be set of semantic rules describing when the assertion is to be evaluated. For example, under required conditions the assertion is only evaluated when the user decides to skip a task reference. AUDIO Audio Sequence Descriptor: Element Format: N/A Template Used: Node, Node-alts Description: This element is used to hold an audio sequence. BINOP Binary Operation Descriptor: Entity Format: N/A Template Used: N/A Description: This entity enumerates all of the possible binary operators which may be used within an expression. This element must contain one of the following elements: eq, ne, lt, gt, le, ge, and, or, xor, concat, substring, append, plus, minus, times, divide, idivide, exponent, mod, remove, union, intersect, set- diff, member, subset, disjoint, add, subsequence. CDM CDM Template Type Descriptor: Attribute Format: NAME Template Used: N/A Description: Used in all element declarations, to identify the generic template which the element follows. The attribute's value is a fixed default value (ie. cannot be changed by entry of another value ). It is set to 'node' if the element follows the 'node' template. It is set to 'node-alts' if the element follows the 'node-alts' template. It is set to 'node-seq' if the element follows the 'node-seq' template. It is set to 'if-node' if the element follows the 'if-node' template. It is set to 'loop-node' if the element follows the 'loop-node' template. CHOICE Choice Descriptor: Element Format: N/A Template Used: N/A Description: This element defines a choice in a menu. Choices consist of a piece of text or a graphic to be displayed. Once the user selects a choice from a menu, the presentation system will either assert some postcondition or will branch to another dialog ( which could contain another menu, fillin or selection ). CODING Coding Descriptor: Attribute Format: Character Data Template Used: N/A Description: Used by the grphprim element, this attribute identifies the particular storage type of the current graphic file (e.g. IGES, CGM ). The default value is 'cgmbin'. COLHDDEF Column Header Definition Descriptor: Element Format: N/A Template Used: N/A Description: This element defines a column header for a specific column of tabular information. COLNUM Column Number Descriptor: Attribute Format: NUTOKEN Template Used: N/A Description: Used by the colhddef and entry elements, the value of this attribute consists of the column number of a table. DEFAULT Default Indicator Descriptor: Attribute Format: Character Data Template Used: N/A Description: Used by the choice element, this attribute contains an enumerated list with values of either a 'Yes' or 'No'. The default attribute provides a method of indicating whether a choice is designated as a default for the menu. The default value for this attribute is 'No'. DIALOG User-Interactive Dialogs Descriptor: Element Format: N/A Template Used: Node, Node-alts Description: This element provides the capability for user interaction. A dialog could contain a subdialog, fillin, menu, selection, or any combination of the four. It may also contain an optional text string which would be the title of the composite dialog. DIALOG-REF Dialog Reference Descriptor: Attribute Format: IDREF Template Used: N/A Description: Used in the property element, this attribute contains the ID of either a dialog element or a process element which will acquire a value for the property, if property is undefined (ie., equal to 'nil' ) at presentation time. ENTRY Column Entry Definition Descriptor: Element Format: N/A Template Used: N/A Description: This element defines an entry for a cell in a table. An entry is a piece of text and a column number. EXPRESSION Expression Descriptor: Element Format: N/A Template Used: N/A Description: The expression element provides the capability to create mathematical expressions to be used for preconditions and postconditions. There can be one of four types of expressions: a binary operation between two expressions, a unary operation with an expression, a property, or a value. EXTERNAL-PTR External Process Pointer Descriptor: Attribute Format: IDREF Template Used: N/A Description: Used in the audio, video and process elements, this attribute is a pointer which points to an external file. The external file shall contain the appropriate audio, video or software process that will present to the user a multimedia event. FILLIN Fill-In-The-Blank Question Descriptor: Element Format: N/A Template Used: N/A Description: This element defines a fill-in-the-blank question. It will contain a prompt, a property, and an optional default value. The prompt contains the question to be presented to the user. The property element identifies the variable which will receive a value from the user's response. The property element also identifies the legal value type of the user's response. The fillin will be presented to the user according to the value type. GENERIC-RANGE Generic Range Descriptor: Element Format: N/A Template Used: N/A Description: This element provides a mechanism for defining valid range checking for fill-in elements. The element may identify a maximum and minimum for numeric entries or a set of valid values that may be entered for an alpha numeric entry. GRAPHIC Graphic Descriptor: Element Format: N/A Template Used: Node, Node-alts Description: This element represents a composite graphic which is made up of graphic primitives ( grphprim ) or other graphic components ( graphic ). GRPHPRIM Graphic Primitives Descriptor: Element Format: N/A Template Used: Node, Node-alts Description: This element defines a graphic primitive to be a single graphic component which, when combined with other primitives, can become a composite graphic. A graphic primitive references a file that contains the detailed graphic information in some standard ( e.g., CGM, IGES, FAX, or DXF graphic codes ). HIGH-BOUND High Bound Descriptor: Element Format: N/A Template Used: N/A Description: This element identifies the maximum allowable number for a numeric entry of a fill-in. HYTIMEHytime Descriptor: Attribute Format: NAME Template Used: N/A Description: Used by the link element, this attribute is a fixed default value (ie. cannot be changed by entry of another value ). It is set to 'ilink'. ID Identifier Descriptor: Attribute Format: ID Template Used: N/A Description: Used by elements to hold a unique identifier of a specific element. IF-NODE If-Node Template Descriptor: Entity Format: Template Template Used: N/A. Description: The if-node template provides a method of conditional branching within an interactive sequence. This template uses the same logic as the IF-THEN-ELSE statement in a programming language. INDEX Index Descriptor: Element Format: N/A Template Used: N/A Description: A signed integer value. Its meaning is dependent upon its sign. A positive value means an index position from the beginning of a string or sequence. A negative number means an index position counted back from the end of the string or sequence. A zero means the end of the string. ITEMID Item Identification Descriptor: Attribute Format: Character Data Template Used: N/A Description: Used in all node elements to identify the components of the system being repaired, as they relate to information elements. The item identification attribute specifies the reference designator(s) or other identifiable designator(s) of the system(s), subassemblies, or parts referred to by the element. The permissible values of this attribute are dependant upon the content-specific application using this primitive. LINK Link Descriptor: Element Format: N/A Template Used: N/A Description: This element provides the capability for creating relational links with the data. It employs the HyTime "ilink" architectural form (template) and may contain "anchors" called (location elements) to identify two or more linkends. The link element may contain the name of the relation (e.g., linkterm). LINKEND Link End Descriptor: Attribute Format: IDREFS Template Used: N/A Description: Used by the link element, this attribute contains one or more unique identifiers (IDREFs). The identifiers shall point to a CDM element or a location element which resolves at the desired data. LINKTERM Link Term Descriptor: Attribute Format: IDREF Template Used: N/A Description: Used by the link element, this attribute contains the ID of a specific element. This attribute points to a data item which will be used to identify a link during presentation. LOOP-NODE Loop-Node Template Descriptor: Entity Format: Template Template Used: N/A. Description: The loop-node template allows for the creation of iterative loops within an interactive sequence ( node-seq ) of elements. LOW-BOUND Low Bound Descriptor: Element Format: N/A Template Used: N/A. Description: This element is used to identify the minimum allowable entry for a numeric fill-in. MENU Menu Descriptor: Element Format: N/A Template Used: Node Description: This element defines a menu for user interaction. It consists of a prompt followed by one or more choice elements. MINSIZE Minimum Size Descriptor: Attribute Format: NUTOKENS Template Used: N/A Description: Used in the graphic and grphprim elements, the minsize attribute specifies the minimum viewing size at which the graphic should be displayed. The minimum is expressed as the width ( in inches ) at which the graphic should be displayed, assuming a 36 inch viewing distance. MODE Mode Descriptor: Attribute Format: Character Data Template Used: N/A Description: Used in the parameter element, this attribute is composed of character data containing permissible values of either 'in','out', or 'in-out'. The default value is 'in'. It will indicate the method of parameter passing between the technical information and the software process. NAME Name Descriptor: Attribute Format: Character Data Template Used: N/A Description: Used in all node elements, this attribute holds the standard nomenclature for the element expressed as character data. The permissible values of this attribute depend on the specific element type. NIL An Empty Element Descriptor: Element Format: N/A Template Used: N/A Description: This element represents an undefined value. Any property can take on the nil value. NODE Node Template Descriptor: Entity Format: Template Template Used: N/A. Description: The node is a template by which technical information is defined. The node template contains the "content" of the technical information. The node template creates hierarchy within the CDM. The node template also contains context filtering preconditions and postconditions. The link element within the node template provides the capability to cross reference to other technical information. The use of link, from the Hytime model, provides additional functionality by allowing a link to be made to a document outside the CDM specification boundary. The node template provides the capability to create composite structures within the content specific layer. Composite structures may contain subcomponents that employ the node, node- alts, or node-seq templates. The node subcomponents may be composite structures themselves or they may be primitive nodes (text, tables, graphics, audio, video, process). Composite structures create hierarchy within the CDM. When composite nodes contain other composite nodes there is an implied hierarchy. The composite node in the content-model is at a lower level in the hierarchy (e.g. a task-node contains step-nodes in its content model). NODE-ALTS Node Alternatives Template Descriptor: Entity Format: Template Template Used: N/A. Description: This template shows you how to create context sensitive filtering. This element contains one or many elements using the node template. Node-alts (node alternatives) will contain a list of mutually exclusive nodes. Their grouping is due to the fact that they apply in different contextual situations. In this manner, the node-alts element is a logical reference that contains a set of nodes which might apply to different situations. An important fact in the node-alts structure is that no hierarchy is implied between the generic identifier and the content model nodes (e.g. a task-alts element will contain task nodes in its content model). NODE-SEQ Node Sequence Template Descriptor: Entity Format: Template Template Used: N/A. Description: The node-seq template provides the structure for creating interactive sequences with the user. The node-seq template provides the capability to not only group elements together, but also to preserve any inherent order/sequence which may apply to the technical information. The node-seq template also allows an author to define conditional branching and iteration within the technical information. NUM-RANGE Number Range Descriptor: Element Format: N/A Template Used: N/A Description: This element contains the maximum and minimum allowable values for a fill-in. PARAMETER Parameter Descriptor: Element Format: N/A Template Used: N/A Description: This element will be used to pass parameters to or from an external software process. For example, the 1553 bus on an aircraft might require parameters concerning a given channel which requires look up. The parameter element will contain the channel required by the process. PENPATT Pen Pattern Descriptor: Attribute Format: Character Date Template Used: N/A Description: Used in graphic and grphprim elements, this attribute represents the bit-map pattern to be used as the pen for drawing lines, points, etc. for a particular graphic. PENSHAPE Pen Shape Descriptor: Attribute Format: Character Data Template Used: N/A Description: Used in graphic and grphprim elements, this attribute indicates the boundary shape for the pen for drawing lines, points, etc. for a particular graphic. POSTCOND Post Condition Descriptor: Element Format: N/A Template Used: N/A Description: The postcond element asserts the value of an expression to a property when the display system software presents a dialog node to the user, or when a user completes some action which needs to be recorded for later context filtering. PRECOND Precondition Descriptor: Element Format: N/A Template Used: N/A Description: A precond element must contain an expression which identifies the conditions which must be present to display the Technical Information. PROCESS External Software Process Descriptor: Element Format: N/A Template Used: Node, Node-alts Description: This element will be used to represent an external software process. PROMPT Prompt Descriptor: Element Format: N/A Template Used: N/A Description: This element defines the prompt to be displayed to the user for the presentation of a fillin or a menu. It allows the prompt to be either a text string (in the form of a question) or a graphic ( a picture which requires an answer). PROPERTY Property Descriptor: Element Format: Parsable Character Data Template Used: N/A Description: This element contains parsable character data which represents the property (variable) name. The value of a property may be obtained by finding the current value associated with the property name in the state table. REF Reference Descriptor: Attribute Format: IDREF Template Used: N/A Description: Used in many elements, this attribute contains the ID of a specific element. The ref attribute utilizes the SGML #CONREF capability. A #CONREF attribute is only filled in when the element's content model is empty. In this case, the #CONREF attribute contains a reference which is a unique identifier to either an element employing the appropriate template or a location element that resolves to an element employing the appropriate template (see ISO/IEC IS10744:1992). REMOVE Remove Descriptor: Element Format: N/A Template Used: N/A Description: For a set element the remove element returns a set with value removed. For a sequence using the binary operand form it returns a sequence which has the first instance of value removed. For a sequence or string as a unary operator remove must contain an index-value which refers to the position from which the character in the string is to be removed or the value in the sequence is to be removed. The new string or sequence will be the old one up to but not including the index position concatenating with the old one after the index position. ROW Row Number Descriptor: Attribute Format: NUTOKEN Template Used: N/A Description: Used in the entry element, the value of this attribute consists of the row number for that entry's tabular information. ROWHDDEF Row Header Definition Descriptor: Element Format: N/A Template Used: N/A Description: This element defines a row header for a specific row of tabular information. SELECT Select Descriptor: AttributeFormat: Character Data Template Used: N/A Description: Used in the menu element, this attribute allows the author to designate the number of choices that may be selected by the user. The choices are either 'single' or 'multiple', with the default selection choice being 'single'. SELECTION Selection Descriptor: Element Format: N/A Template Used: N/A Description: This element provides the capability of creating a special menu that allows selection within a given picture, text string or table. SEQUENCE Sequence Descriptor: Element Format: N/A Template Used: N/A Description: This element is defined as being an ordered sequence of data. SET Set Descriptor: Element Format: N/A Template Used: N/A Description: This element is defined as being an unordered sequence of data. TABLE Table Descriptor: Element Format: N/A Template Used: Node, Node-alts Description: This element defines how a table is constructed. A table will contain a column header followed by one or more entries. The combination of column header and entries may be repeated for as many columns as the table requires. TEXT Text Descriptor: Element Format: Parsable Character Data Template Used: Node, Node-alts Description: This element defines how text is constructed. Within a text string, there may be embedded text elements which allow the referencing of other elements or parts of elements through the link/location mechanism of HyTime. TRANSFRM Transformation Matrix Descriptor: Attribute Format: NUTOKEN Template Used: N/A Description: Used in the graphic and grphprim elements, this attribute signifies a transformation matrix which specifies coordinate translations, scaling, or reflection and rotations in terms of homogenous coordinates. For further information see the book Mathematical Elements For Computer Graphics by David F. Rogers and J. Alan Adams., McGraw-Hill Book Company 1976. TYPE Type Descriptor: Attribute Format: Character Data Template Used: N/A Description: Used in all node elements, the information type attribute provides a more precise mechanism for classifying an element. The permissible values of this attribute are dependant upon the content specific application using this primitive. UNOP Unary Operator Descriptor: Entity Format: N/A Template Used: N/A Description: This entity enumerates all of the possible unary operators which may be used within an expression. This element could contain the following: not, empty, size, head, tail, neg, remove, trunc, float, index, undef, max, and min. VALUE Value Descriptor: Entity Format: N/A Template Used: N/A Description: This entity defines an expression value. A value may be a boolean, string, sequence, set, real, integer, or nil. VALUE-TYPE Value Type Descriptor: Attribute Format: Character Data Template Used: N/A Description: Used in the property element, this attribute is used to denote the allowable data types which may be assigned to the property. The current legal values are any combination of the following: 'boolean', 'integer', 'real', 'set', 'sequence', 'string', and 'general'. The default value is 'general'. VIDEO Video Sequence Descriptor: Element Format: N/A Template Used: Node, Node-alts Description: This element will be used to include a video sequence into technical information. WINDOW Window Descriptor: Attribute Format: NUTOKENS Template Used: N/A Description: Used in the graphic and grphprim elements, this attribute indicates the subrectangle within a graphic which should be displayed in those cases where the author wishes to display only a portion of a large graphic to the user. A CONTENT-SPECIFIC LAYER TAG SET DESCRIPTIONS 10. SCOPE. 10.1 Scope. This appendix provides the detailed description of the IETM content-specific elements and attributes to be included in an IETM Data Base. It is formulated as a description of possible tags or names for components in an IETM Data Base whose structure is defined by a DTD specified or developed in accordance with this specification. Unless otherwise specified by the procuring activity, this Appendix is a mandatory part of this specification. The information contained herein is intended for compliance. 20. APPLICABLE DOCUMENTS. 20.1 Government documents. 20.2 Non-Government publications. The following documents form a part of this document to the extent specified herein. Unless otherwise specified, the issues of the documents which are DoD adopted are those listed in the issue of the DODISS cited in the solicitation. Unless otherwise specified, the issues of documents not listed in the DODISS are the issues of the documents cited in the solicitation. ISO 8879 Information Processing - Text and Office Systems - Standard Generalized Markup Language (SGML) ISO/IEC IS10744:1992 Information Technology - Hypermedia/Time-based Document Structuring Language (HyTime) (Application for copies should be addressed to the American National Standards Institute, 1430 Broadway, New York, NY 10018.) 30. CONTENT SPECIFIC LAYER TAG SET DESCRIPTIONS. 30.1 Use of SGML. The markup tags described herein conform to rules defined in ISO 8879. 30.2 Tag Set Descriptions. Data elements shall be defined in accordance with the Tag-Set Descriptions included below (see 3.1.2). ACTIONAction Descriptor: Attribute Format: Character Data Template Used: N/A Description: Used in the rect element, this attribute contains character data describing the type of maintenance action required to rectify, or fix, a fault. The action can be a 'swap', which means it is a removal/replacement action, or it can be a 'maint' action, which means it is an adjustment, alignment, or similar action. The default value is 'swap'. AGENT Agent Descriptor: Attribute Format: Character Data Template Used: N/A Description: Used in the rect and test element, this attribute contains character data describing who performs a maintenance action. It can be either a 'human' agent, or some valid computer system (e.g., 1553 bus ) called 'machine'. The default value is 'human'. ALERT Alert Descriptor: Element Format: N/A Template Used: Node, Node-alts Description: This element identifies an alert that may accompany a task or a step. The type attribute may designate an alert to be a warning, caution or note which may be displayed to the technician. A warning notifies the technician that a task or step may be harmful to himself or another human if not properly performed. A caution is used in technical information to emphasize a procedure that, if not strictly followed, or a condition that, if not strictly maintained, may result in damage to the equipment. A note signifies additional information which aids the technician in completing the step or task. A note is used in technical information to emphasize an especially important procedure or condition. ATTACH-PARTAttaching Part Descriptor: Element Format: N/A Template Used: Node, Node-alts Description: This element identifies all the attaching parts required for a given part information element. CAGE Commercial and Government Entity Descriptor: Attribute Format: NUTOKENS Template Used: N/A Description: Used in the consum, equip and partbase elements, this attribute is a five-character code assigned by the Defense Logistics Services Center (DLSC) to the design control activity or actual manufacturer of an item contained in the Cataloguing Handbook H4/H8 series. CONNECTION Connecting Part Descriptor: Element Format: N/A Template Used: Node, Node-alts Description: This element is used to identify a connection between two part information elements (e.g., a connection between pin 123 and wire ABC). CONSUMConsumables Descriptor: Element Format: N/A Template Used: Node, Node-alts Description: This element identifies all the consumable required for the completion of the task. DESCINFO Descriptive Information Descriptor: Element Format: N/A Template Used: Node, Node-alts Description: The element descinfo is used to define general purpose, non-procedural, narrative information such as theory of operation, schematics, etc which are associated with a system component. The descinfo element is very flexible. It can be used to describe any arbitrary, hierarchical hypertext-like node. ESTTIME Estimated Time Descriptor: Attribute Format: NUTOKEN Template Used: N/A Description: Used in the task and step elements, the value of this attribute indicates the amount of time, in minutes, required for the corresponding task/step to be completed. EQUIP Equipment Descriptor: Element Format: N/A Template Used: Node, Node-alts Description: An equip element identifies the equipment needed to perform a particular task. Equip usually refers to a piece of test equipment, support equipment, or a tool. FAULT Fault Descriptor: Element Format: N/A Template Used: Node, Node-alts Description: The element fault is used to identify a potential failure which may occur on a weapon system. FAULTINF Fault Information Descriptor: Element Format: N/A Template Used: Node, Node-alts Description: The faultinf element is used to define all the tests and faults associated with the system that references it. FLTSTATE Fault State Descriptor: Element Format: N/A Template Used: Node, Node-alts Description: The fltstate element identifies a set of implicated or exculpated faults. Implicated faults are faults suspected of being bad; exculpated faults are faults known to be good. Each implicated fault will have a weight associated base on its likelihood of causing the discrepancy. The 'type' attribute will designate whether the list of faults are 'implicated' or 'exculpated'. FOLLOW-ON Follow On Conditions Descriptor: Element Format: N/A Template Used: Node Node-alts Description: A follow-on condition is a maintenance condition which must be accomplished sometime following the completion of a task to clean-up or undo actions performed during the task. For example, in order to fix a component a task might require that an access panel be removed. The panel would then need to be replaced as a follow-on action. This task might be performed sometime after the repair task is completed, but not immediately after the repair task. Other maintenance tasks might be performed in the same area before the follow-on task is accomplished. A follow-on element contains a set of preconditions which define the follow-on maintenance condition which must be satisfied, relational links, a text element which verbally describes the follow-on condition, a list of task(s)/step(s) which provide instructions for accomplishing the follow-on condition, and a set of postconditions which define the state changes to be made once the follow-on condition is accomplished. FSC Federal Stock Classification Descriptor: Attribute Format: Character Data Template Used: N/A Description: Used in the partbase element, the value of this attribute contains applicable Federal Stock Classification (FSC) codes. GOVSTDGovernment Standard Descriptor: Attribute Format: Character Data Template Used: N/A Description: Used in the consum element, the value of this attribute signifies a document that establishes engineering and technical requirements for processes, procedures, practices, and methods that have been adopted as standards. It also establishes requirements for selection, application, and design criteria for materials. HCI Hardness Critical Item Descriptor: Attribute Format: Character Data Template Used: N/A Description: Used in the partbase element, the value of this attribute represents a code which indicates that an item could degrade system survivability in a nuclear, biological, or chemically hostile environment if hardness were not considered. ICC Item Category Code Descriptor: Attribute Format: Character Data Template Used: N/A Description: Used in the equip and consum elements, the value of this attribute signifies a code which identifies a type of item, and indicates categories into which support and test equipment, spares, repair parts, etc. may be divided. Note: ICCs of "A," "B," and "C" should not be assigned to hardware items: these codes are reserved for grouping and selecting similar ICCs during automated data processing. Peculiar Support Equipment and Tools not Currently in the DOD Inventory (ICC Group A): Peculiar Support Equipment (Other) 7 Peculiar Tools 8 Peculiar Test Equipment M Peculiar Handling Equipment D Peculiar Automatic Test Equipment (ATE) 1 Common Support Equipment and Tools Currently in the DOD Inventory (ICC Group B): Common Support Equipment (Other) H Common Tools 4 Common Test Equipment 5 Common Handling Equipment 6 Common Automatic Test Equipment (ATE) 2 Common Support Equipment and Tools Currently in the DOD Inventory but not Assigned to a Unit/Ship (ICC Group C): Common Support Equipment (Other) G Common Tools N Common Test Equipment P Common Handling Equipment R Common Automatic Test Equipment (ATE) 3 Bulk Items Q Training material not currently in the DOD inventory S Training material currently in the DOD inventory T End Item W Spare (repairable support item) X Repair part (a nonrepairable consumable support item, component, assembly) Y Repair Parts Kit Z A repair part, component or assembly that is contained in a kit/set 9 Tool Kit/Set V Program (Embedded software) E Tech Manuals F Forms or records J Electrostatic Discharge-Sensitive Item K Electromagnetic-Sensitive Item L Facilities U System-Peculiar Spare Part AA Maintenance Significant Consumable AB Modified Hand Tool AC Maintenance Assist Module AD INDEXNUM Index Number Descriptor: Attribute Format: NUTOKENS Template Used: N/A Description: Used in the partinfo element, the value of this attribute contains the index number for the part which represents a callout in a graphic output onto paper. INPUT Input Conditions Descriptor: Element Format: N/A Template Used: Node, Node-alts Description: The input element contains the personnel required, the consumable used, the equipment used and the required conditions for accomplishing a given task. LOCATION Part Location Descriptor: Element Format: N/A Template Used: Node, Node-alts Description: The location element provides information for physical assessment. It will contain x, y, z location(s) for a system with respect to the x, Fuselage Station (FS), y, Buttock Line (BL), and z, Water Line (WL) reference system. Where appropriate BL may be replaced by Wing Station (WS). LOCATION-X Location X Descriptor: Attribute Format: NUTOKENS Template Used: N/A Description: Used in the location element, the value of this attribute contains a number representing a position on the Fuselage Station (FS), which is used as the x-axis of the weapon system. LOCATION-Y Location Y Descriptor: Attribute Format: NUTOKENS Template Used: N/A Description: Used in the location element, the value of this attribute represents a position on the Buttock Line (BL), which is used as the y-axis of the weapon system. LOCATION-Z Location Z Descriptor: Attribute Format: NUTOKENS Template Used: N/A Description: Used in the location element, the value of this attribute contains a number representing a position on the Water Line (WL), which is used as the z-axis of the weapon system. LRU Line Replaceable Units Descriptor: Attribute Format: Character Data Template Used: N/A Description: Used in the partinfo element, this attribute signifies an essential support item that is removed and replaced at field level to restore the end item to its operationally ready condition. Allowable values are: Item is a LRUY Item is not a LRU N MFGCODE Manufacturers Codes Descriptor: Attribute Format: Character Data Template Used: N/A Description: Used in the consum element, the value of this attribute indicates the in-house code a manufacturer uses to represent parts. MILSPEC Military Specification Descriptor: Attribute Format: Character Data Template Used: N/A Description: Used in the consum element, the value of this attribute represents the exact specification for each item bought by the government. MTBF Mean Time Between Failure Descriptor: Attribute Format: Character Data Template Used: N/A Description: Used in the fault and partinfo elements, the value of this attribute signifies, for a particular interval, the total functional life of a population of an item divided by the total number of failures within the population during the measurement interval. The definition holds for time, rounds, miles, events, or other measure-of-life units. NOUNIDNoun Identifier Descriptor: Attribute Format: NUTOKEN Template Used: N/A Description: Used in the partinfo element, the value of this attribute indicates a general name of a part. NOUNTYPE Noun Type Descriptor: Attribute Format: NUTOKEN Template Used: N/A Description: Used in the partinfo element, the value of this attribute signifies more specific descriptors which differentiate part names. NSN National Stock Number Descriptor: Attribute Format: Character Data Template Used: N/A Description: Used in the equip, consum and partbase elements, the value of this attribute is a number, assigned under the Federal Cataloguing Program and/or North Atlantic Treaty Organization (NATO) codification of equipment system to each approved item, which provides a unique identification of an item of supply within a specified Federal Supply Classification (FSC). The field consists of a three-character prefix, a thirteen- character National Stock Number (NSN), and a four-character suffix code. For applicable codes, see DOD 4100.38-M. OPERABILITYOperability Descriptor: Attribute Format: Character Data Template Used: N/A Description: Used in the task element, the value of this attribute is a code used to indicate the operational status and mission readiness of the system during the maintenance task. Allowable values are: Full Mission-Capable: performance of the maintenance C task does not degrade any mission capability. Partial Mission-Capable: performance of the D maintenance task degrades the mission capability of the system, but can perform at least one mission. System Inoperable During Equipment Maintenance: A system is not available to perform all normal operations. System Operable During Equipment Maintenance: system B is available to perform normal operations. Not Mission-Capable: system cannot perform any E missions. Off-Equipment Maintenance: task is performed after G the item under analysis has been removed from the system. Turnaround: task occurs during normal turnaround F operations, and does not affect the operability of the system. OUTCOME Outcome Descriptor: Element Format: N/A Template Used: Node, Node-alts Description: This element represents a possible outcome from a test. It identifies a fault state ( fltstate ) for use in a dynamic fault model, and a test or fault for the static tree model. PARA Para Descriptor: Element Format: N/A Template Used: Node, Node-alts, Node-seq, If-node, Loop-node Description: Identifies a piece of text to be displayed under the descinfo element. The text may be "Theory of Operation", "General Information", etc. PARTBASE Part Base Descriptor: Element Format: N/A Template Used: Node Node-alts Description: This element describes the supply system's view of the part information. It describes the item in terms of its part number. PARTINFO Part Information Descriptor: Element Format: N/A Template Used: Node, Node-alts Description: This element describes the maintainer's view of the part information. It identifies parts information within its relative position in the weapon system. PARTNUM Part Number Descriptor: Attribute Format: Character Data Template Used: N/A Description: Used in the partbase element, this attribute signifies any number, other than a government activity stock number, used to identify an item of production or supply. PERSON Person Descriptor: Element Format: N/A Template Used: Node Node-alts Description: This element is used to identify the personnel requirements for a given task. QUANTITY Quantity Descriptor: Attribute Format: NUTOKEN Template Used: N/A Description: Used in the person, equip, expend and consum elements, the value of this attribute signifies the amount of the appropriate consumable, equipment, or people required for the associated task/step. RANGE Range Descriptor: Attribute Format: Character Data Template Used: N/A Description: Used in the test element, this attribute represents the boundaries for valid choices or outcomes, according to the element containing the range. RECT Rectification Descriptor: Element Format: N/A Template Used: Node, Node-alts Description: The rectification element identifies the prescribed task that will repair the fault causing the discrepancy and all other faults that could be fixed by the rectification. Upon completion of the task, a test is performed to verify the effect of the rectification. REFDESReference Designation Descriptor: Attribute Format: NUTOKEN Template Used: N/A Description: Used in the partinfo element, this attribute is an identifier assigned according to a numbering scheme for parts of a system which reflects the hierarchical assembly of the system. REPLVL Replenishment Level Descriptor: Attribute Format: Character Data Template Used: N/A Description: Used in the partinfo element, this attribute represents the minimum quantity of a part in stock that will trigger a reorder or stock action. REQCOND Required Conditions Descriptor: Element Format: N/A Template Used: Node, Node-alts Description: A reqcond element contains a list of preliminary conditions which must be met prior to beginning a task. If any condition is not met, it contains the task or step which will satisfy the condition. It also contains postconditions which will record the state changes made in satisfying the conditions. SERVICEDES Service Designator Descriptor: Attribute Format: Character Data Template Used: N/A Description: Used in the task element, this attribute is a single-position code identifying the military service or nonmilitary major governmental agency having jurisdiction over, or executive management responsibility for, the acquisition. Allowable values are: Army A Air Force F Marine Corps M Navy N Coast Guard Y All Military X Federal Aviation Administration T FAA/All Military J National Security Agency S Other O SMR Source, Maintenance, Recoverability Codes Descriptor: Attribute Format: Character Data Template Used: N/A Description: Used in the partbase element, SMR codes are alphabetic or alphanumeric symbols used at the time of provisioning to indicate the source of supply of an item, its maintenance implications, and its recoverability characteristics. The provisioning activity may require the contractor to recommend these codes. Approved codes are defined in: AR 700-82, OPNAVINST 4410.2, AFR 66-45, MCO 4400.120, and DSAR 4100.6. STEP Step Descriptor: Element Format: N/A Template Used: Node, Node-alts, Node-seq, If-node, Loop-node Description: The step element is the primary component of a maintenance procedure. It describes the actions to be performed in order to successfully complete a task. SYSTEM System Descriptor: Element Format: N/A Template Used: Node, Node-alts Description: The system element defines the vehicle/system/subsystem/subassembly hierarchy for the weapon system. A system element must be created for any component (ie., vehicle, system, subsystem, subassembly) which has associated technical information (ie., descriptive, procedural, fault, or part information). TASK Task Descriptor: Element Format: N/A Template Used: Node, Node-alts Description: The task element is a set of directive steps which make up a specific maintenance procedure. A maintenance procedure could be a preventive or corrective maintenance task. Preventive tasks are preformed at regular intervals to ensure that the item or system will continue to operate correctly and safely (such as inspect, clean, lubricate, etc). Corrective (or unscheduled) maintenance procedures are performed when required to repair faulty items or systems that have been identified by troubleshooting procedures. A procedural task is made up of steps, and ties all text, graphics, messages, prompts, and references required to convey the step together. A task element contains linking information necessary to link one task to other tasks. TECHINFO Technical Information Descriptor: Element Format: N/A Template Used: N/A Description: This element represents the top layer of the information contained in this content specific DTD. The content model contains the top level system such as "F-15", "M-1" or "F/A-18". TEST Test Descriptor: Element Format: N/A Template Used: Node, Node-alts Description: This element indicates a diagnostic test that will lead to outcomes and guide the technician toward a rectification during troubleshooting. UNIT-OF-MEASURE Unit of Measure Descriptor: Attribute Format: Character Data Template Used: N/A Description: Used in the consum element, this attribute identifies the type of unit measurement used to quantify the number of consumables needed for the current application. (e.g., "inches", "meters", "pounds", etc.). UNITSPER Units per Assembly, System, etc. Descriptor: Attribute Format: NUTOKEN Template Used: N/A Description: Used in the partinfo element, this attribute represents the number of units required per assembly of a system or component. USABLEON Usable On Code Descriptor: Attribute Format: NUTOKEN Template Used: N/A Description: Used in the partinfo element, this attribute identifies the different configurations in which a part or assembly may appear within a system or vehicle. VERSION Version Descriptor: Element Format: N/A Template Used: Node Description: This element identifies the currency of the data by providing the last revision information and change information necessary for taking delivery of partial databases. WEIGHT Fault Probability Descriptor: Attribute Format: NUTOKENS Template Used: N/A Description: Used in the fltstate element, this attribute represents a probability associated with a given fault within a list of faults in a fault state ( fltstate ). A Content Specific Document Type Definition .. B-1 A Content Specific Layer Tag Set Description . D-1 Acquisition of Final Form IETMs .............. 1.3.2 2 Acquisition of Fully Constructed IETMs ....... 1.3.2 3 Acquisition of IETMDB ........................ 1.3.2 3 Acquisition Requirements ..................... 6.2 12 Acronyms ..................................... 6.4.1 13 Additional Content Specific DTDs ............. 3.1.4 6 Appendix A ................................... A-1 Appendix B ................................... B-1 Appendix C ................................... C-1 Appendix D ................................... D-1 Applicable Documents ......................... 2. 4 Attributes ................................... 3.2.1.1 7 Audio, Video and Process ..................... 3.2.3.4 9 Capabilities (IETMDB) ........................ 1.3.1.1 2 CDM Attribute ................................ 3.2.1.1.4 7 Classified Material .......................... 5.1.2 12 Commercial and Government Entity (CAGE) ...... 3.3.3.5.2 11 CONREF Attribute ............................. 3.2.2.1 8 Content Data Model (CDM) ..................... 3.1 5 Content Specific - Document Type Definition (DTD) ................................... 3.3.1 9 B-1 Content Specific DTD for Organizational Level (O-Level) Maintenance ................... 3.3.3 10 Content Specific Layer ....................... 3.3 9 Context Dependent Filtering................... 3.2.4 9 Control of Content Specific DTDs ............. 3.3.1 9 Data Base Interchange Requirements ........... 3.1.1 6 Data Base Structuring and Data Element Naming Requirements ............................ 3.1.2 6 Data Maintainability ......................... 3.1.3 6 Data Portability ............................. 1.4.1 3 Data Requirements ............................ 6.3 13 Definitions of Acronyms and Terms ............ 6.4 13 Delivery, Preparation for .....................5.1 12 Descriptive Information ...................... 3.3.3.2 10 Development of Content Specific DTDs ......... 3.3.2 9 Dialog Elements .............................. 3.2.3.5 9 Dialogs ...................................... 3.2.3.5 9 Digital Product Packaging .................... 5.1.1 12 Document Type Definition (DTD) ............... 3.1 6 Expressions .................................. 3.2.4.3 9 Fault Element ................................ 3.3.3.4.1 11 Fault State Elements ......................... 3.3.3.4.2 11 Fillin ....................................... 3.2.3.5 9 Filtering .................................... 3.2.4 9 Final Form IETMs, Acquisition of ............. 1.3.2 2 Format Free Technical Information ............ 1.4 3 Fully Constructed IETMs, Acquisition of ...... 1.3.2 3 General Requirements ......................... 3.1 5 Generic Layer ................................ 3.2 6 Generic Layer Tag Set Descriptions ........... C-1 Generic Layer Document Type Definition ....... A-1 Government Documents ......................... 2.1 4 Government Documents, Drawings and Publications ............................ 2.1.2 5 Graphics ..................................... 3.2.3.3 8 Handbooks .................................... 2.1.1 4 Hardness Critical Item (HCI) ................. 3.3.3.5.2 11 Hierarchy, Item/System........................ 3.3.3.1 10 IETMDB, Acquisition of ....................... 1.3.2 3 IETMDB Capabilities .......................... 1.3.1.1 2 If Node Template ............................. 3.2.1.4 7 Inspection ................................... 4.1 11 Integration Support .......................... 1.4.2 4 Intended Use ................................. 6.1 12 Interactive Electronic Technical Manual (IETM) 6.4.2 14 Interchange, Data Base Requirements .......... 3.1.1 6 Introduction ................................. 1.3 2 Item-Id Attribute ............................ 3.2.1.1.2 7 Item/System Hierarchy ........................ 3.3.3.1 10 Key Word List ................................ 6.5 14 Limited Applicability, Paragraphs ............ 1.2 1 Links to Reduce Redundancy ................... 3.2.2.1 8 Location Elements ............................ 3.2.2.2 8 Logistics Support and Task Analysis Link ..... 3.2.2.3 8 Loop Node Template ........................... 3.2.1.5 8 Maintainability, data ........................ 3.1.3 6 Maintainer or Operator, Parts Information .... 3.3.3.5.1 11 Maintenance, Organizational Level ............ 3.3.3 10 Mean Time Between Failures (MTBF) ............ 3.3.3.5.1 11 Menu ......................................... 3.2.3.5 9 Naming, data element ......................... 3.1.2 6 National Stock Number (NSN) .................. 3.3.3.5.2 11 Nature and Purpose of a Revisable Source Data Base .....................................1.3.1 2 Node Alternatives Template ................... 3.2.1.2 7 Node Sequence Template ....................... 3.2.1.3 7 Node Template ................................ 3.2.1.1 7 CDM Attribute ........................... 3.2.1.1.4 7 Item-Id Attribute ....................... 3.2.1.1.2 7 Name Attribute .......................... 3.2.1.1.1 7 Ref Attribute ........................... 3.2.1.1.5 7 Type Attribute .......................... 3.2.1.1.3 7 Non-Government Publications .................. 2.2 5 Notes ........................................ 6. 12 Operator or Maintainer Parts Information ..... 3.3.3.5.1 11 Options, Technical Information Procurement ... 1.3.2 2 Order of Precedence .......................... 2.3 5 Organization Level Maintenance ............... 3.3.3 10 Other Government Documents, Drawings and Publications ........................ 2.1.2 5 Outcome Elements ............................. 3.3.3.4.4 11 Packaging .................................... 5. 12 Paragraphs With Limited Applicability ........ 1.2 1 Parts Information ............................ 3.3.3.5 11 Maintainer/Operator Information ......... 3.3.3.5.1 11 Supply Information ...................... 3.3.3.5.2 11 Parts Information Provided for Parts Supply .. 3.3.3.5.2 11 Postconditions ............................... 3.2.4.2 9 Precedence, Order of ......................... 2.3 5 Preconditions ................................ 3.2.4.1 9 Preparation for Delivery ..................... 5.1 12 Primitive Elements ........................... 3.2.3 8 Audio ................................... 3.2.3.4 9 Graphics ................................ 3.2.3.3 8 Process ................................. 3.2.3.4 9 Tables .................................. 3.2.3.2 8 Textual Information ..................... 3.2.3.1 8 Video ................................... 3.2.3.4 9 Procedural Information ....................... 3.3.3.3 10 Process, Audio, Video ........................ 3.2.3.4 9 Procurement Options, Technical Information.... 1.3.2 2 Quality Assurance ............................ 6.4.3 14 Quality Assurance Provisions ................. 4. 11 Rectification Elements ....................... 3.3.3.4.5 11 Reduce Redundancy ............................ 3.2.2.1 8 Ref Attribute ................................ 3.2.1.1.5 7 Relational Links ............................. 3.2.2 8 Requirements ................................. 3. 5 Additional Content Specific DTDs ........ 3.1.4 6 Data Base Interchange Requirements ...... 3.1.1 6 Database Structuring and Data Element Naming Requirements .................. 3.1.2 6 Data Maintainability .................... 3.1.3 6 General Requirements .................... 3.1 5 Responsibility for Compliance ................ 4.1.1 12 Responsibility for Inspection ................ 4.1 11 Revisable Source Data Base ................... 1.3.1 2 Scope ........................................ 1.1 1 Selection .................................... 3.2.3.5 9 Source Maintenance and Recoverability (SMR) Code .................................... 3.3.3.5.2 11 Specifications, Standards & Handbooks ........ 2.1.1 4 Structuring, Data Base ....................... 3.1.2 6 Subject Term (Key Word) List ................. 6.5 14 Supply Process................................ 3.3.3.5.2 11 System/Item Hierarchy......................... 3.3.3.1 10 Tables ....................................... 3.2.3.2 8 Tag Set Descriptions, A Content Specific Layer ................................... D-1 Tag Set Descriptions, Generic Layer .......... C-1 Task Analysis Link ........................... 3.2.2.3 8 Technical Information, Format Free ........... 1.4 3 Technical Information Procurement Options..... 1.3.2 2 Templates .................................... 3.2.1 7 If Node Template ........................ 3.2.1.4 7 Loop Node Template ...................... 3.2.1.5 8 Node Alternatives Template .............. 3.2.1.2 7 Node Sequence Template .................. 3.2.1.3 7 Node Template ........................... 3.2.1.1 7 Terms and Acronyms, Definitions of ........... 6.4 13 Test Element ................................. 3.3.3.4.3 11 Textual Information .......................... 3.2.3.1 8 Troubleshooting Information .................. 3.3.3.4 10 Type Attribute ............................... 3.2.1.1.3 7 Usable-on code ............................... 3.3.3.5.1 11 Use of Generic DTD Primitive Elements ........ 3.3.2.1 9 Use of Generic DTD Template elements ......... 3.3.2.2 10 Video ........................................ 3.2.3.4 9