Gp Digitally signed

by Gp Capt PC
JSG 0852 : 2019
(Second Revision)
Capt PC Pandey
Date: 2021.09.13
Pandey 12:26:31 +05'30'

Hkkjr ljdkj
GOVERNMENT OF INDIA

j{kk ea=ky;
MINISTRY OF DEFENCE

la;qDr lsok ekxZnf’kZdk

JOINT SERVICES GUIDE

ON

INTERACTIVE ELECTRONIC TECHNICAL MANUAL

(IETM)

Ekkudhdj.k funs'kky;
j{kk mRiknu foÒkx]j{kk ea=ky;
^,p*&CykWd] fuekZ.k Òou MkdÄj
ubZ fnYyh&110011
DIRECTORATE OF STANDARDISATION
DEPARTMENT OF DEFENCE PRODUCTION
MINISTRY OF DEFENCE
„H‟ BLOCK, NIRMAN BHAWAN PO
NEW DELHI-110011
 JSG 0852 : 2019
(Second Revision)

LIST OF MEMBERS ASSOCIATED WITH REVISION OF THIS JSG

1. This „Joint Services Guide‟ (JSG) has been approved by Shri Mahesh V, Director
(R&D), BEL, Bangalore and Chairman, Information Technology Standardisation Sub
Committee (ITSSC).

2. The following members have revised or have been associated with the revision of this
document:
S. Name and Designation Email id/Organisation
No.
1. Shri L Ramakrishnan, lramakrishnan@bel.co.in
AGM (D&E) Military Radar BEL, Bengaluru
2. Shri M Shivakumar, shivakumarm@bel.co.in
Member (Senior Research Staff), CRL BEL, Bengaluru
3. Gp Capt PS Rao, oicbnglore.defstand@gov.in
OIC & Member Secretary ITSSC Defence Standardisation Cell, Bengaluru
4. Lt Col Dinesh Pattabhi K, TSO & dscbnglore.defstand@gov.in
Associate Member Secretary ITSSC Defence Standardisation Cell, Bengaluru

ii
 JSG 0852 : 2019
(Second Revision)

RECORD OF AMENDMENTS

Amendment Amendment Authority Amended by Signature

No. Date pertains to: Name & Appointment &
S. No./Para (In block letters) Date
No./Column No.
1 09-09-2011 Contents Sl. No. CRL-BEL, Shri L
11 Bangalore RAMAKRISHNAN,
M (SRS), CRL, BEL, BG
Shri M SHIVAKUMAR
M (SRS), CRL, BEL, BG

2 09-09-2011 ANNEX F CRL-BEL, Shri L

Bangalore RAMAKRISHNAN,
M(SRS), CRL, BEL, BG
Shri M SHIVAKUMAR
M(SRS), CRL, BEL, BG

3 20-02-2019 ANNEX G Minutes of Shri L

51st ITSSC RAMAKRISHNAN,
Meeting AGM (MR), BEL, BG
Shri M SHIVAKUMAR
M (SRS), CRL, BEL, BG

iii
 JSG 0852 : 2019
(Second Revision)

TABLE OF CONTENTS

S. Topic Page
No. No.

1. FOREWORD 1
2. SCOPE 3
3. RELATED SPECIFICATIONS/DOCUMENTS 3
4. ACRONYMS 4
5. PRESENT DOCUMENTATION SYSTEM 4
6. GENERAL FEATURES OF IETM 4
7. CLASSES OF IETM 6
8. IETM CLASS FOR DEFENCE SERVICES 7
9. GUIDELINES FOR FORMULATION OF SPECIFICATIONS FOR 9
IETM
10. GUIDELINES FOR FORMULATION OF SPECIFICATIONS FOR 19
IETM DATABASE (IETMDB)
11. GUIDELINES FOR FORMULATION OF SPECIFICATIONS ON 20
QUALITY ASSURANCE OF ITEM
12. GUIDELINES FOR FORMULATION OF INTERACTIVE 29
BROWSER BASED WYSIWYG FOR IETM
13. VERSION MANAGEMENT OF IETM 42
14. REFERENCES 43
15. SUGGESTIONS FOR IMPROVEMENT 43
16. ANNEXURES
ANNEX „A‟ - DEFINITION FOR CLASSES OF IETM 44
ANNEX „B‟ - GENERIC LAYER 47
ANNEX „C‟ - GENERIC LAYER TAG SET-DESCRIPTIONS 51
ANNEX „D‟ - CONTENT SPECIFIC LAYER 55
ANNEX „E‟ - CONTENT SPECIFIC LAYER TAG SET-DESCRIPTIONS 57
ANNEX „F‟ - JSIA, CS & IA, MULTIMEDIA AND RFID 61
ANNEX „G‟ - NEW DEVELOPMENTS IN IETM 65-71

iv
 JSG 0852 : 2019
(Second Revision)

0. FOREWORD

0.1 This Joint Services Guide has been prepared by the Information Technology
Standardisation Sub Committee on the authority of the Standardisation Committee, Ministry
of Defence.

0.2 This document JSG 0852 : 2019 (Second Revision):

a) was prepared in the year 2001.

b) was reaffirmed in the year 2007.

c) was revised in the year 2012.

d) is revision of JSG 0852 : 2012 (First Revision) and supersedes the same.

0.3 This Guide has been approved by the Ministry of Defence for use by the Defence
Services, Defence PSUs, various Defence Support Organisations and R & D Organisations.

0.4 This Guide may be useful to the Defence services and supporting organisations like
DRDO, Defence PSU‟s, Defence Accounts and apex body of Ministry of Defence who may
use this document to bring awareness about what is an Interactive Electronics Technical
Manual (IETM).

0.5 Information given in this JSG will enable the user in choosing the class of IETM,
formulation of specification for IETM, formulation of specification for IETM database,
formulations of specification for Quality Assurance besides guidelines for Version Control.

0.6 An attempt has also been made to provide various technical inputs like the:

a) Meaning of IETM
b) Advantages
c) Relevance to Maintenance Management
d) The approach on using Standard Generalised Markup Language (SGML),
Hyper Text Markup Language (HTML) and Extensive Markup Language (XML)
e) Main Characteristics of IETM - Display, Functionality & Data Format
f) Classification of IETM and Levels of Information in an IETM

0.7 All technical enquiries regarding this document may be addressed to :

The Director,
Directorate of Standardisation,
Ministry of Defence,
„H‟ Block, Nirman Bhawan PO,
New Delhi-110011.
Email id-director.defstand@gov.in

1
JSG 0852 : 2019
(Second Revision)

0.8 Non registered users can obtain the following on payment:

a) Copies of IS from:

Bureau of Indian Standards,

Manak Bhavan,
9, Bahadur Shah Zafar Marg,
New Delhi-110002.
or
their regional offices.

b) Copies of JSSs/JSGs:

The Director,
Directorate of Standardisation,
Standardisation Documents Centre,
Ministry of Defence,
Room No. 05, „J‟ Block,
Nirman Bhawan PO,
New Delhi-110011.
jdstd.defstand@gov.in

0.9 Indian Standard (IS) specifications are available free of cost for registered users on:

Directorate of Standardisation Website:

www.ddpdos.gov.in
For registration visit our website.

0.10 Directorate of Standardisation Website - All the approved JSSs/JSGs are available on
the Directorate of Standardisation Website www.ddpdos.gov.in. Defence organisations
desirous of procuring a copy of this document are requested to visit the Directorate of
Standardisation website for registration and obtaining User id/password to access the
JSS/JSG.

2
 JSG 0852 : 2019
(Second Revision)

1. SCOPE

1.1 This document contains information on the features of IETM, their advantages and
classifications. The Standard Generalised Markup Language (SGML) or the Extensible
Markup Language (XML) used in creation of IETM is explained. This guideline is prepared
on the basis of the specifications on IETM of Indian Navy and updated with the current data
available on SGML, HTML and XML. The referred Naval document was based on MIL-M-
87268, MIL-D-87269 and MIL-Q-87270. This document also includes the following:

a) Guidelines to evolve Specification for generation of IETM.

b) Guidelines to evolve Specification for generation of IETM Database.

c) Guidelines for formulation of Specification for Quality Assurance of IETM.

1.2 These guidelines for IETM, though essentially cover maintenance roles, are equally
applicable to other roles such as operations and planning.

2. RELATED SPECIFICATIONS/DOCUMENTS

References are made in this specification to:

Table 1

S. Specification Title of Specification

No. Number
1 EED-P-23 Indian Naval Specification on IETM
2 ISO 8879: 1986 Specification for Standard Generalised Markup Language
(SGML) for text and office systems
3 MIL-D-87269 Database Revisable: IETM, for support of
4 MIL-M-87268 Manuals, Interactive Electronics Technical: General Contents,
Style, Format and User Interaction, Requirements for
5 MIL-Q-87270 Military Specification QA Programme : IETM & associated
Technical Information, Requirements for
6 MIL-R-28001 Data Format: BitMap (raster); Indexing and Header Files (Navy
MIL-STD-29532)

2.2 Related Websites

a) http://www.oasis-open.org/cover/topics.html - SGML/XML Special Topics

By: Robin Cover (Last modified: February 23, 2001).

b) http://www.google.com - Search for Study Material on SGML and XML.

3
JSG 0852 : 2019
(Second Revision)

3. ACRONYMS
Table 2
Acronyms Full Form
ASCII American Standard Code for Information Interchange
BMP Bitmap formats (for WINDOWS)
CALS Computer Aided Acquisition and Logistic Support
CDM Content Data Model
COTS Commercial off the Shelf (solutions/hardware/software)
DBMS Database Management System
DOD Department of Defence (of United States of America)
DTD Document Type Definition
EDD Electronic Display Device
GUI Graphic User Interface
HTML Hypertext Markup Language
HyTime Time based structuring Language
IETM Interactive Electronic Technical Manual
IETMDB Interactive Electronic Technical Manual Database
MMS Maintenance Management System
PEDD Portable Electronic Display Device
QA Quality Assurance
QAP Quality Assurance Programme
QAPI Quality Assurance Process Inspections
QAPP Quality Assurance Programme Plan
SGML Standard Generalised Markup Language
TI Technical Information
XML Extensible Markup Language

4. PRESENT DOCUMENTATION SYSTEM

4.1 The present documentation methodology is predominantly based on paper

documentation. With the increased complexity of systems, this method consumes enormous
amount of paper, which is cumbersome to handle, relatively non-portable, difficult to refer
and comprehend and tends to deteriorate easily with frequent use, especially, when used by
multiple users.

4.2 This limitation can be overcome by the adoption of electronically generated technical
manuals, commonly known as “Interactive Electronic Technical Manuals” or, in short,
IETM.

5. GENERAL FEATURES OF IETM

5.1 Meaning of IETM - An electronic technical manual is not merely a document typed
on a word processor and presented on a floppy disk. IETM have been defined by the US
DOD as a technical manual prepared in a digital form on a suitable medium, designed for
electronic window display to the user and possessing the following characteristics:

4
 JSG 0852 : 2019
(Second Revision)

a) The format and style of the presented information are optimised for window
presentation to assure maximum comprehension, i.e. the presentation format is
“Frame- Oriented” and not “Page-Oriented”. An IETM can be presented either on a
“Desk Top Work Station” or a “Portable Electronic Display Device” (PEDD).

b) The elements of technical data constituting the IETM are so interrelated that
user‟s access to the information he requires 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‟s request and information input) in providing procedural guidance,
navigational direction and supplemental information and also in providing assistance
in carrying out logistic support functions supplemental to maintenance.

5.2 Advantages of IETM

IETM allows the user to locate required information faster and more easily than is possible
with a paper manual.

5.2.1 IETM, when designed to clearly defined standard, are easier to comprehend and more
specifically matched to the system configuration under diagnosis. Powerful interactive
troubleshooting procedures, not possible with paper technical manuals, can be made available
using the intelligent features of IETM display device.

5.2.2 It becomes feasible, using IETM, to expand the electronic classroom technology and
introduce the concept of the virtual classroom using remote Video Tele training. These virtual
classrooms would use IETM, which would be linked together with a single large database
augmented with modules of video, sound, animation and interactive courseware.

5.3 Standard Generalised Markup Language (SGML) and Hyper Text Markup
Language (HTML)

5.3.1 An SGML document is an information container and not a screen or hard copy output.
A document may be thought to consist of three layers, the Structure, Content and Style.
SGML separates these three layers and provides ways to directly define the relationship
between structure and content. Firstly, there must be declaration - a text file that contains
system specific information such as character sets. Secondly, there must be a declaration of
the document type and incorporation of the “Document Type Definition” (DTD) that are to
be used. The DTD is a set of rules stated in SGML to define the structure of a document and
a list of all the permissible elements and entities that can be included in the document.
Elements and entities are the units of digital information that are to be included in the
document. Thirdly, the document instance consists of the actual text with markups called
“SGML Tags” that are defined in the DTD. The document instance is, therefore, directly
related to the DTD. There are no text objects in the instance file. All graphics, for example,
are extended to the instance and referred to as external entities.

5.3.2 The SGML tags, defined in the DTD and incorporated in the document instance to
define the relationship between the structure and content, are the equivalent of pencilled
markups that are often used on the printed pages when we want to identify the characteristics

5
JSG 0852 : 2019
(Second Revision)

of the document such as bolding, position on the page, heading and paragraph types.
However, the SGML markups do much more. When a tag is used to identify a document
element such as a unit of text information, it can also have attributes that add intelligence to
the document, improve navigation and trigger actions to be taken automatically. This
increases the user productivity by decreasing time to access information and providing a
smart interface between the user and the document.

5.3.3 SGML fulfils a goal to produce a single set of rules for describing the structure and
managing the contents of a digital document. It is an open standard and a shared technology;
so it is not owned by anybody and is available to all. It is also free from hardware and
software technology.

5.3.4 The SGML rules, in the form of a meta-language, provide a way to extend SGML
features and we can expect it to evolve with experience. The Hypertext Markup Language
(HTML), used to define material on the World Wide Web, is an example of how experience
will change SGML. HTML has gone through several versions, some of which bend current
SGML rules that have been enhanced, to meet project needs. Eventually SGML may be
extended to officially meet WWW type documents.

5.4 Extensive Markup Language (XML)

XML has emerged as a draft standard for web application of SGML. XML aims to bridge the
gap between SGML and HTML. It is a modernized remake of SGML that removes some of
the complex and less-used features of SGML. XML is a simpler form of SGML without the
restrictions of DTD. XML also makes it easier to produce documents for many different
media such as paper, online and WWW from a single source. The goal of XML is to enable
generic SGML to be served, received and processed on the web by construction of XML
documents for SGML documents.

6. CLASSES OF IETM

6.1 Available IETM Classes, Worldwide

a) Class I - Electronically indexed pages

b) Class II - Electronically scrolling Documents
c) Class III - Linearly structured IETM
d) Class IV - Hierarchically structured IETM
e) Class V - Integrated database

NOTE - Broad features of the above classes of IETM are shown at Annex „A‟.

6.2 Characteristics of IETM

There are three categories of characteristics used to define IETM - Display, Functionality and
Data Format described as under:

6.2.1 Display

The display characteristics cover the presentation of the information to the user, the type of
display used and the features provided on the display. The display may be a normal 14”

6
 JSG 0852 : 2019
(Second Revision)

monitor or a lap top LCD display. The information needs to be displayed in the user-
friendliest way. The display may be customized for full page viewing, scrolling window and
page-turner. The hot spot access (Hyper links) to other text or graphics should be provided on
the display. The user interaction with dialogue boxes is imperative. The text and graphics
should be displayed simultaneously and also through separate windows.

6.2.2 Functionality

Functionality is how the end user will access, navigate and interact with the IETM online. For
example, we can see increasingly greater use of hypertext and hypermedia from Class 1
through to Class 3 (see ANNEX - A), and the addition of dialog driven interactions beginning
in Class 3 IETM. Another aspect of functionality is how much intelligence and expertise the
system will have that aids the performance of the user. For example, Classes 3-5 IETM
provide logical “Next” and “Back” functions for navigation and Class 5 is partly defined by
an expert system that can aid in implementing next navigation by taking into account the
session data such as troubleshooting results. These functionality characteristics potentially
have profound impacts on job definition and training requirements because they may very
well have major impacts on what the technician has to know and be able to do.

6.2.3 Data Format

The data format category of IETM characteristics is of interest not only for defining classes
but also for its training development implications. A review across the 5 Classes along this
dimension reveals that the databases change in various ways, becoming increasingly more
useful and integrated for functionality. By virtue of starting out as a legacy hardcopy manual,
Class 1 IETM is a raster scanned, page turning, electronic technical manual with only an
intelligent index for additional user access. It has only a bitmap database with indexing and
header file data. Beginning with Class 2 IETM, the text data is all digital with increasingly
more useful and effective data structures, use of SGML/XML tagging to hierarchically
structure the text data and associate it to other media and integration with other application
data, both at the database and the user level.

6.3 Use of IETM in Maintenance Management System

The IETM concept can include a Maintenance Management System (MMS) model for
continuous improvement of maintenance and spare parts stock, which can facilitate the
continuous improvement process by introducing decision support feature. The MMS can
generate spares demands continuously, monitor the actual maintenance history and spare
parts consumption, indicate pattern and flag deviations from a plan. The MMS itself will
direct the user‟s focus towards the non-conformities and guide them through the decision
process.

7. IETM CLASS FOR DEFENCE SERVICES

7.1 The “Linearly Structured” IETM Class 3 (refer ANNEX - A), is to be followed for
use in the Defence Services. The salient features of this class are as under:
a) Display
1) Primary view is scrolling text window interaction through dialogue
boxes with user prompts.

7
JSG 0852 : 2019
(Second Revision)

2) User selection and navigational aids (Key-word search, on-line

indices).

3) Text and graphics displayed simultaneously in separate window when

keyed together.

b) Data Format - Linear ASCII with SGML/XML (or higher version) tags,
SGML/XML with content wise format tags.

c) Outlines - Authored directly to database for interactive electronic output.

d) Functionality

1) Dialogue Driven Interaction - Logical display of data in accordance

with content.

2) Logical NEXT & BACK Functions - Useful as interactive maintenance

& user selectable cross-references and indices content specific help available.

7.2 Levels of Information in an IETM

The IETM will comprise of information at various levels as follows:

a) Level 1 - Title, Content, etc.

b) Level 2 - Text - The text would be broad outline information on the contents,
e.g., if the item in the contents is “Receiver”, the text in this level could give
information like the names of the submits/modules of the receiver and their broad
functions.

c) Level 3 - Text - This would be detailed information based on hot spots created
in Level 2.

d) Level 4 - Text - This could be information about a component/part or could be

a “Parts List”, and could contain ordering information in respect of a spare part.

e) Level 5 - Drawing.

f) Level 6 - Drawing/Photograph - This would be a more detailed drawing than

available in the previous level.

g) Level 7 - Spares Order Form.

NOTE - Additional levels could be created depending upon the application.

7.3 Access to each level would be through links created by “Hot Spots” in any level. The
user would have the flexibility to go to the next level or directly to a lower level.

8
 JSG 0852 : 2019
(Second Revision)

7.4 Security Features/Access Control

a) Only authorized persons should be able to access IETM. Suitable password

protection/access control should be incorporated.

b) While the above provisions should permit only authorized persons to access
the IETM, additional protection may be necessary to authorize only select few to
access or add notes to certain portions of the IETM. Suitable provision has to be made
for this feature.

7.5 Annotations

7.5.1 IETM, essentially being a technical manual will be accessed by the

technicians/engineers for trouble shooting in the concerned equipment. Systems linkage
facilities should be provided, to the IETM, so that authorized persons can add
notes/annotations to facilitate subsequent reference by concerned personnel.

7.6 Search Feature

7.6.1 Suitable search features should be available for quick reference of the relevant
portions by clicking on key words that would be specified by the organization requiring the
development of the IETM.

7.7 Common User Computer Aided Tools

7.7.1 Common user tools like calculator, spell check, drawing tool bar, etc., should be
included in the IETM as per requirements of the buyer.

8. GUIDE LINES FOR FORMULATION OF SPECIFICATIONS FOR IETM

8.1 Introduction

While drafting specifications for IETM, the guidelines in the succeeding sub clauses should
be followed.

8.2 Scope

A specification should define common requirements for the general content, style, format and
user interaction features which are required for interactive electronic technical manuals
(IETM). The specification should provide requirements governing the creation of IETM.

8.3 Basic Requirements

The following sub clauses present general content requirements, both for technical
information, which shall be incorporated as the basic content of the IETM, and for technical
information, which shall be incorporated to support use of a particular IETM.

9
JSG 0852 : 2019
(Second Revision)

8.3.1 Help Related to Technical Content

The user shall have access to additional information relating to the technical content of the
IETM, such as information on a weapon system itself, or assistance in using one of the
special features of the authored procedures for that particular weapon system. The help
function shall also permit the user to access context-sensitive help, which applies to the user‟s
current activity and situation. It shall also permit the user to access descriptive information to
further explain some technical point, to define a specific term or to provide further
explanation where necessary.

8.3.2 Administrative Information

All IETM shall contain the following administrative information for subsequent user
selectable display:

a) Identification of the “Title of The Technical Manual”, assigned “Technical

Manual Number”, as applicable.

b) Classification Level of the IETM (shall also be presented upon initial entry to
the IETM by the user).

c) Date, baseline date and dates of the latest/all previous changes.

d) Verification, change or revision status as applicable.

e) Method of obtaining additional copies and the format of such electronic copies.

f) Distribution statement.

g) Summary of documents and/or technical manuals that are referred in the IETM
but not included in the automatically accessible data (hyperlink) available to the IETM.

8.3.3 Introductory Information

All IETM shall contain information, which explains the purpose and scope (e.g.,
organizational level troubleshooting and corrective maintenance for a particular system),
content, and organization of the IETM. This section shall present the range of tasks covered
by the IETM and relate the purpose and scope of the manual.

10
 JSG 0852 : 2019
(Second Revision)

8.3.4 List of Contents

The IETM shall contain a “List of Contents” of the IETM and shall provide instructions for
direct user access to each item at the lowest level sited. If the IETM is a “Proceduralised
Corrective Maintenance IETM”, for instance, the list of contents shall provide a list of
maintenance tasks included. The list of contents, while being analogous to the table of
contents of a paper manual, shall base sequencing on the logic of the logistics support
function covered and shall contain branching as necessary. The user shall be given the
capability to access the listed entries directly from the list of contents menu.

8.3.5 How to Use “Help” Function

In addition to the technical information related “help” function described later in Clause----,
the user shall be provided with help information involving the use of IETM or the use of the
electronic display system (EDS). This help information shall describe how to use the IETM;
e.g., how to reach (access) specific information and how to employ user interaction functions.
“How to use this IETM” information shall be incorporated as part of the content information
of the IETM.

8.3.6 Instructions for Interactions with IETM Utility Functions

Information shall be provided to describe procedures for all utility functions included as
supplements to the primary functions of the IETM; e.g., preparation and submission of
associated maintenance action reports, accumulation and submission of IETM deficiency
reports citing IETM errors/problems in using the IETM, ordering of needed parts, work
centre maintenance management, use for on-site training, acquisition of additional IETM
discs, etc.).

8.3.7 Definition of Acronyms, Terms and Abbreviations

A glossary of terms used in the IETM including all acronyms, abbreviations and special
terms shall be incorporated in the IETM and shall be directly accessible in all IETM
presentations.

8.3.8 Warnings, Cautions and Notes

Technical information shall be supplemented with warnings, cautions and notes in such a way
as to:

a) Attract the user‟s attention to correct practices, procedures and conditions

which, if not adhered to, could lead to injury or equipment damage.

b) Warn the user against performance of certain hazardous actions; and/or

c) Follow specific steps leading to safe performance of the procedures.

11
JSG 0852 : 2019
(Second Revision)

8.4 General Style/Presentation

IETM shall be prepared in accordance with the general style requirements contained in this
clause. These requirements shall apply both for the language to be used in textual technical
information and for the graphics supplementing the textual portions.

8.4.1 Level of Detail

The technical content shall be adequate for a user to perform the task for which the IETM has
been intended. Unnecessary information above or below this level shall not be included.
When a general purpose task, which can be easily performed by an experienced
person/technician, is required to be carried out (e.g., “Open Access Panel”), the main
equipment need not be specifically listed.

8.4.2 Multiple Skill Level Tracks

When required, technical information shall be available in multiple skill level tracks. For
example, in the case of novice level and expert level skills, technical information shall be
available in each of the two separate and complete tracks representing the two skill levels.
The novice level track shall contain all information necessary to carry out a task step by step,
while the expert level track may provide only a checklist or a description in broader terms.
The expert would have the option of referring to the novice level information also.

8.4.3 Comprehensibility

The following guiding principles shall be followed to ensure comprehensibility of data in an

IETM:

a) Information should be in a descriptive text manner. This text must be

consistent in style, terminology and format.

b) The functions of the system/component, the inputs, outputs, interfaces and

principles of operation are to be described.

c) Any special features are to be listed and explained.

d) Location of the component/part in the system is to be indicated.

e) Each paragraph of the text should be limited to a single idea. Each sentence
should be limited to a single thought. Short and familiar words are to be used. Rules
of Service writing shall be adhered to:

f) Length of a sentence shall not exceed 20 words. The average paragraph shall
not exceed 6 sentences.

g) Steps and explanations shall be constructed as fully integrated text and

graphics modules.

12
 JSG 0852 : 2019
(Second Revision)

h) Text shall be presented in a logical order; e.g., as in an operational sequence or

in signal flow sequence.

j) The IETM shall contain only the information required. Any additional
information which could be useful, but not essentially required, shall be provided as
HELP.

8.4.4 Quality of Graphics

Graphics shall be prepared to a scale that ensures that all essential details are legible. Line
widths should be chosen so as to be seen clearly on any display. However, it should be kept
in mind that intensive use of graphics would slow down a system.

8.4.5 Angle of view

The graphics should represent the views that are generally used. If necessary, more than one
view should be provided.

8.4.6 Schematic and Wiring Diagrams

Cable schedules, schematics and wiring diagrams displayed along with an accompanying text
should be displayed so as to contain only the information referenced by the text with which
they are displayed. However, the user should be able to see the complete diagram or list if it
can be displayed on the screen.

8.4.7 Flow Charts

These are to be drawn from left to right or from top to bottom. The diagrams should indicate
the details referenced by the accompanying text.

8.5 General Requirements of GUI

The presentation software of the IETM should provide the display formatting and user
interaction functions described in the succeeding sub clauses. Free form positioning devices
such as, a mouse/joystick/track ball/light pen/touch panel or arrows with a selection key may
be used to implement cursor movements and selection of functions. Dedicated keys may also
be used if required.

8.5.1 Cursor

On screen selection, if required and available, shall be by means of a cursor, which must be
easily distinguishable from other items on the screen. When the cursor is positioned on an
item to be selected, that item should be highlighted. The highlighting should be clearly
visible. Selecting an item already selected should deselect it. The user should have the facility
to select a single item or a range of items, including those that are non-contiguous. Once an
item/items is/are selected, the OK function will mark the end of selection.

13
JSG 0852 : 2019
(Second Revision)

8.5.2 Cursor Movement

The cursor should be capable of being positioned either through a free form positioning
device or by UP, DOWN, LEFT and RIGHT keys.

8.5.3 Tab Groups

Should several sets of objects be displayed, these sets are to be formed into fields called “Tab
Groups”. The cursor movement is to be constrained with in a tab group. The TAB function
shall allow a forward sequential movement of the cursor between tab groups. “BACK TAB”
shall allow for reverse movement of the cursor between tab groups.

8.5.4 Pointer

If the system provides a free form positioning device, a pointer shall also be provided, which
will be used in conjunction with the cursor. The pointer shall be used for rapid relocation of
the cursor on the display. The pointer should also be capable of selecting items.

8.6 Presentation of Windows

Presentation system should be able to display any number of windows on the screen, but only
one should be active at any time. Windows should be capable of the following -

a) Open/Close.

b) Overlapping displays.

c) Adjacent displays.

d) Positioning anywhere on the screen.

e) Orderly placement, if overlapped, with only the title bars visible.

8.6.1 Window Features

The windows shall comprise of the following features:

a) Minimum Client Area - The IETM information shall be displayed with in this
area, which will be contained within the window frame.

b) Title and Menu Bars - The top area of every window shall display the TITLE
BAR and the MENU BAR. The menu bar will be below the title bar. Title shall be
displayed in upper case. Title bar shall be highlighted when the window is active.

c) Window Controls - When the information to be displayed requires more space

than is available in the client area, the user should have the facility of repositioning
the window and stretching/including it.

14
 JSG 0852 : 2019
(Second Revision)

8.6.2 Scroll Bar

Vertical and horizontal scroll bars shall be used to enable the user to scroll UP, DOWN,
LEFT and RIGHT to manipulate the displayed information. Scroll bars shall be displayed on
the right hand edge, vertically, and on the bottom edge, horizontally, of the data and have
arrow marks. A slider box shall be provided to enable the user to scroll incrementally
through/across the display. When the scroll bar is used to view information, the information
should appear to move in the direction opposite to the movement of the slider box.

8.6.3 Window Resizing

Windows that can be resized should have distinctive borders. When a window is resized,
information displayed should be reduced/enlarged and not scaled down/up.

8.7 Menu System

The menu system shall consist of a menu bar, which shall control a hierarchy of „pull down‟
menus and a set of „pop up‟ menus. „Cascading menus‟ or „sub menus‟ shall be used to add
details to pull-down and pop-up menus. These shall provide a tree-top structure for
organizing information; thus, simplifying the presentation of complex lists. To maintain ease
of use, the menu selection tree shall not be more than four levels deep. Menu items shall be
displayed using upper and lower case letters.

8.7.1 Menu Dimensions

The minimum menu column width shall be no less than 5 text characters and shall be wide
enough to enclose all menu item tables or options so that none are truncated. When an
individual item is too wide for display in the client area, it shall be wrapped out to the next
line. If the entire menu cannot be presented with in the client area, the existence of the menu
data, which is hidden and not displayed, shall be indicated to the user. The minimum height
shall be the height of two menu items.

8.7.2 Highlighting of Menu

Highlighting shall be used whenever the cursor lands on a selectable item. Reverse sides shall
be used to highlight the menu item after the item is selected.

8.7.3 De-Emphasis

Those functions that are unavailable shall be de-emphasized by using a grey out or dimming
method.

8.7.4 Cursor Default Location

In all menus, the cursor shall be positioned at the same default location in a menu every time
that menu is accessed.

15
JSG 0852 : 2019
(Second Revision)

8.7.5 Dialogue and Dialogue-Controls

A dialogue box shall be the primary means by which the user converses with the underlying
IETM software. It shall be displayed in a separate window, which may overlay the primary
window and shall contain a heading and one or more graphical controls (buttons). Dialogues
shall be of one of the following kinds:

a) Alerts

b) Fill the blanks

c) Single/Multiple Choice

d) Selection in list

e) Composite

8.7.5.1 All the dialogues shall contain the OK function and with the exception of
information only, alerts the CANCEL function. Both terminate the user‟s interaction with the
dialogue box.

8.7.6 Dialogue Cursor Movement

During dialogues the cursor shall move only within the dialogue box.

8.7.7 Dialogue Presentation

The dialogue boxes shall be distinctive in appearance so that they are not confused with other
windows.

8.7.8 Dialogue Push Buttons

Dialogue boxes shall contain graphical controls called push buttons. A push button shall be a
selectable work or a graphic icon on the screen, which enables the user to make a selection or
initiate an action. The push button shall be large enough to enable the user to position the
cursor on the same for selection. These will be single action entities. The shape of the push
button is to be consistent; e.g., box or circle. Moving the cursor on to the push button and
activating SELECT function will activate the push button. After selecting the push button, the
user shall have at least two push buttons located in the bottom of the box. These two push
buttons shall have the functions “OK” and “CANCEL”, which will be in the last selections
made by the user before leaving the dialogue box. “HELP” push button shall also be at the
bottom of the box.

8.7.9 Alert Dialogues

Alert dialogues shall include warnings, cautions, notes, messages, etc., which require
acknowledgement by the user. These would also include messages generated as a result of
erroneous user inputs or sequence control actions. They shall also provide information on the

16
 JSG 0852 : 2019
(Second Revision)

status of systems‟ internal components. Alerts are to be brief, consistent and strictly factual.
Alerts regarding calls to erroneous or potentially destructive external systems shall be
displayed to the user.

8.8 Graphics

The IETM shall have the capability to display static and interactive type of graphics.

8.8.1 Static Graphics

These shall be displayed in full detail in the graphic area provided with no ability for
manipulation, unlike the interactive graphics.

8.8.2 Interactive Graphics

These shall be displayed in an assigned data pane of the displayed window. If a graphic
cannot be displayed in its entirety and in full detail, it shall be displayed using interactive
graphic display techniques like scrolling, zooming, etc.

8.8.3 Selection of Graphics

The user should have the facility to select a point, an area or the entire graphic by positioning
the cursor on or near that point and activating SELECT function. The selectable region shall
be graphically distinct, but shall not affect the overall appearance of the graphic. Graphical
information shall be selected by selecting the following:

a) A part displayed in a graphic.

b) A point or a rectangular area in a graphic.

8.8.4 Manipulation of Graphics

If the graphic is designed as scrollable, the user shall have the capability to activate
SCROLL, ZOOM or FULL SCREEN functions to manipulate a graphic. These options shall
be available whenever the graphic exceeds the size of the data pane.

8.8.5 Zoom Functions

The system shall provide the capability to enlarge or reduce the displayed graphical
information. The enlargement capability shall be provided to the user by activating a ZOOM
IN function. The user shall have the capability to reduce the size of the information being
displayed by activating a ZOOM OUT function. The size of the data pane shall not change as
a result of using the zoom functions.

8.8.6 Centre Function

The user shall have the capability to activate a CENTRE function, which would relocate the
centre of a graphic to the point that the position cursor indicates without scrolling.

17
JSG 0852 : 2019
(Second Revision)

8.8.7 Full Screen

The user shall have the capability to enlarge a graphic to the full size of a client area by
activating the FULL SCREEN function.

8.8.8 Tables

Tabular information shall be displayed as cells of textual information or as a graphic. When

tables contain textual elements, those elements shall conform to the requirements as set in
this specification for textual information. Graphical elements within a table shall conform to
the requirements in this specification for graphic material.

8.8.9 Scrolling to Tables

The user shall have the capability to manipulate displayed tables by activating a SCROLL
function if the table exceeds the size of the data pane. When a table is made scrollable, the
table headers shall not scroll within the pane.

8.9 Formatting & User Interaction Features For Display

The IETM shall be displayed by an EDS which shall have the capability to form displayed
windows of information formed by combining primitive information components, each
individually displayed using general display format described above. The general formatting
and user interaction requirements of the succeeding sub clauses shall apply to all IETM.

8.9.1 Initial Set Up

The initial set up or input conditions, where required, shall be provided at the beginning of
every task. The initial set up lists information that the technician must know before starting a
task.

8.9.2 Test Equipment Required

A listing of the government approved test equipment applicable to the required task shall be
provided. The description shall include equipment capacity, range, etc. If alternate equipment
can be used, the notation “or equivalent” shall follow the nomenclature. If no test equipment
is needed, the entry shall state “None”. If an equivalent alternate piece of test equipment
cannot be used, the notation “No Substitution” shall follow the item name and description.

8.9.3 Tools Required

A list of tools by name, part number and manufacturer‟s name shall be provided.

8.9.4 System Preparation Check List

A checklist of all procedures which should be performed by the technician, to assure that all
preparations have been completed prior to the start of the procedure, particularly those
involving personnel safety and prevention of equipment damage, shall be provided.

18
 JSG 0852 : 2019
(Second Revision)

8.9.5 General Safety Instructions

A safety summary of any general safety information that applies throughout the task shall be
provided.

9. GUIDE LINES FOR FORMULATION OF SPECIFICATIONS FOR IETM

DATABASE (IETMDB)

9.1 The creation of Interactive Electronics Technical Manual (IETM) for a weapon
system or other equipment requires Interactive Electronic Technical Manual Data Base
(IETMDB) to be constructed. The guidelines for formulation of the specifications for the
construction of IETMDB are given in the succeeding sub clauses.

9.2 IETMDB Capabilities

An IETM is a complete collection of database elements relating to a weapon system or other

equipment 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
electronically displayed IETM through the use of automated authoring systems, for
the entire suite of weapon system, or other equipment.

b) The user concerned with the logistic support for the weapon system or other
equipment involved can access the database directly to obtain need based 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 Defence Services, R & D Organisations and
Defence PSUs, whenever necessary for any purpose.

9.3 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
database by the IETMDB author provide the basis of the technical structure of the IETM and
other logistic support TI, which will be extracted from it. The IETMDB itself will, of course,
require a format (database structure); but these guidelines do not impose structural
requirements on the actual Database Management System (DBMS) methodology to be
employed (e.g., the database may be either relational or object oriented).

9.4 Data Portability

Elimination of formatting requirements for the IETMDB reduces the overall magnitude of
database and data interchange Standardisation effort and permits the use of a less complex
DBMS, which is, in turn, less expensive and easier to modify. The “Format-Free” nature of
the IETMDB is intended to provide the following capabilities:

19
JSG 0852 : 2019
(Second Revision)

a) Acquire or access the data in a variety of ways (IETM, other types of logistics
reports, training TI, etc.).

b) Subsequently, format and style the data in a variety of ways for electronic
display options. Since one of the functions of the IETMDB is to provide direct online
data access to a variety of users and to a number of automated logistics support and
Management information systems throughout the Defence Services, establishment of
standard identifiers, data entry relationships and multiple path access routes to
individual data elements is an important part of IETMDB design and construction.

9.5 Content Data Model

The IETM Content Data Model (CDM) provides a representation of technical information
documents and their relationships. 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 provides structure and content of documents and is
defined in ANNEX “B” of this JSG. The generic layer tag set description is shown at
ANNEX “C”. The bottom layer called the “Content Specific Layer” employs the generic
layer when defining elements for system specific TI. A Content Specific Layer Model
developed for organizational level maintenance is placed at ANNEX “D” and the Content
Specific Layer tag description is placed at ANNEX “E”. The CDM linking elements are
taken from the HyTime model. These elements provide the capability to link between CDM
elements and other SGML/XML files.

9.6 Data Maintainability

The IETMDB shall be constructed with provisions to allow the incorporation of any change to
automatically update all aspects of the database affected by that change. This data
maintainability requirement shall involve changes to the IETMDB of the following two kinds:

a) Additions to, elimination of or changes to individual data elements and

attributes.

b) Changes to relationships, including establishment of new relationships or

elimination of old relationships.

10. GUIDE LINES FOR FORMULATION OF SPECIFICATIONS ON QUALITY

ASSURANCE OF IETM

NOTE - The succeeding sub clauses describe the general guidelines and the basic requirements,
beginning with “Scope” for formulation of specifications on QA of IETM.

10.1 Scope

This specification prescribes the requirements of Quality Assurances (QA) Programme for
Interactive Electronic Technical Manuals (IETM) and the associated IETM Data Base
(IETMDB).

20
 JSG 0852 : 2019
(Second Revision)

10.2 Summary of Requirements

This specification provides detailed requirements for the following:

a) Preparation of a Quality Assurance Program Plan (QAPP).

b) Validation of the IETM and Technical Information (TI).

c) When specified, preparation of verification supports plan.

d) Preparation, retention and analysis of QA records.

10.3 Requirements

The Quality Assurance Program (QAP) shall encompass the accountability for and
development of QA functions related to the following IETM program elements :

a) Source data management

b) Evaluation of draft material

c) Database integrity maintenance

d) Authoring system capability

e) Validation

f) Record keeping

g) Verification support

h) Final procedures preparation

j) Sampling procedures where authorized

10.4 Components of the QAPP

The QAPP shall contain the following:

a) Scope and applicability of the QAPP including the list of deliverable IETM
items to which the QAPP applies.

b) A description of the function and structure of the vendor's QA organization.

c) A description of the authoring system.

d) A listing of the vendor's written operating procedures involved in IETM

generation.

21
JSG 0852 : 2019
(Second Revision)

e) A listing of the vendor‟s procedures for quality reviews.

f) Sampling procedures and criteria.

g) A validation approach summary.

h) A validation support approach summary

j) A classification of defects table

10.4.1 Scope and Applicability of QAPP

The QAPP shall identify the scope and applicability of the QA effort. The QAPP shall
identify all the contractually deliverable IETM items, the contract specifications with which
they must comply and the schedule for their inspection and delivery.

10.4.2 QA Organization

a) Function - The vendors QA organization shall have the responsibility for

implementation, administration and conduct of the QA program, and shall function as
the point of contact between the vendor and the purchasing authority in all the matters
related to QA.

b) Structure - The QAPP shall describe the vendor's QA organization. This

description shall indicate how the vendor's QA personnel are organized to retain their
independence from personnel responsible for IETM generation, so as to be able to
carry out their QA responsibilities in an objective manner.

10.4.3 Description of the Authoring System

The authoring system must possess the following capabilities, in order to effectively produce
an IETM:

a) Support technical manual planning and control.

b) Capture data from a wide variety of computerized databases, including text,

graphics and tables.

c) Create and change TI, including text, graphics and tabular data; and the ability
to merge these information elements into a single composite element.

d) Provide the author with access to files in the system database {the interactive
electronic technical manual database (IETMDB)} so that the author can prepare the
IETM.

e) Provide prompts to the author so as to propose proper sequences of writing, to

identify omissions in pre-established plans, and to identify faulty authoring logic.

22
 JSG 0852 : 2019
(Second Revision)

f) Provide author with a view of his finished product in a form identical to that in
which it will be viewed by the end user.

10.4.4 Vendor Quality Reviews

The QAPP shall describe the proposed quality review producers for each individual type of
IETM deliverable where a given process applies to several deliverable, the producer need to
be presented only once, but may be referred to as often as necessary. The QAPP shall also
explain producers for maintaining records of defects found and corrective actions taken. The
QAPP shall include measures proposed by the vendors to assure the effective use of design
and manufacturing drawings of the IETM generation without the necessity to completely redo
the drawings. The QAPP shall describe the approach by which the vendor shall ensure that
IETM products prepared by sub vendors and vendors satisfy all contractual requirements.

10.4.5 Sampling Inspection Plan

The QAPP shall describe the overall sampling inspection plan.

10.4.6 Validation Approach Summary

The QAPP shall contain a validation approach summary covering the approach the vendor
intends to the use of validation. This summary shall outline the intended methodology upon
which the vendor intends to base the validation plan.

10.4.7 Classifications of Defects Table

The QAPP shall contain classification of defects table in which a complete listing of the
possible types of defects discovered in the IETM will be classified into major or minor
categories, depending upon their portable impact.

10.5 Inspections by Purchasing Authority

The Purchasing Authority and other Defence production agencies shall reserve the right to
make any inspection it deems necessary to assure that IETM and its related elements meet
contract requirements. The vendor shall support these inspections by providing access to all
QA records and IETM documentation.

10.5.1 QA Process Inspections (QAPI)

Each Service, including other Defence production agencies, shall conduct a series of
schedules for QAPI to establish that the QAPP is being properly followed, product quality
reviews are being correctly implemented, defects are being identified and appropriate
corrective actions are being taken. During the initial QAPI, in addition to other demonstration
or presentations, the concerned Service, may require, the vendor shall provide specific
demonstrations of the following:

23
JSG 0852 : 2019
(Second Revision)

a) The use of the authoring system to be employed in generating the IETM,

including a demonstration that the authoring system functions outlined in the QAPP
are in working order and are being used in the IETM generation process.

b) Use of the relevant EDD for QA reviews, validation and post validation
review.

10.5.2 Vendor Quality Assurance Inspection and Records - The vendor shall maintain and
provide to the concerned Service, upon request, records documenting all vendor process and
product inspections. These records shall include -

a) Name of the operation or product inspected

b) Date

c) Names of inspectors

d) Defects found

e) Procedure or inspection leading to identification of defect

f) Method of defect correction or explanation for no correction of defect

g) Name of persons making correction

h) Name of the person certifying that the products have been corrected or where
applicable, that the operations have been modified and written procedures corrected,
as necessary.

10.6 Review of Maintenance and Operation Procedure

Quality review procedures shall assure, as a minimum, the following requirements:

a) All input conditions for maintenance and operating procedures contained in

the IETM are explicitly identified.

b) Steps contained in the maintenance and operating procedures use concise text
and simple graphics to instruct the user.

c) Each task is cross-referenced with appropriate descriptive, troubleshooting,

parts and operational information.

d) Steps within a maintenance/operating procedure are presented sequentially and

in their entirety.

e) Information that is not applicable is not displayed.

24
 JSG 0852 : 2019
(Second Revision)

f) All warnings, cautions, and notes associated with a maintenance or operation

actions are presented so that the user is aware of all potentially dangerous or
damaging situations prior to initiation of the action.

g) Maintenance and operating procedures are suitable for presentation on an

EDD.

10.7 Validation

The objective of validation is to ensure that the vendor has provided for support of the
equipment involved, accurate & adequate IETM and an IETMDB in accordance with an
approved validation plan. The vendor shall deliver a validation plan, which covers each
IETM item required by contract and details the anticipated schedule requirements &
producers for performing validation. The validation plan shall contain as much as a minimum
in the following items:

a) Titles and identification numbers of all deliverables shall be validated.

b) Site locations, support, equipment, contractual end items and tools required
during validation.

c) General characteristics relating to skill level of target audience type personnel

to be used in validation of procedural TI.

d) Identification of next higher assemblies/system required to support the effort.

e) Special safety precautions.

f) Any special environmental requirements.

g) Recording keeping system to be used in validation.

h) How validation of producers is to be accomplished.

j) A proposed fault stimulation list for use in validation of trouble shooting

producers.

k) Approach to evaluation of usability of the ITEM as generated by the vendor;

specifically, establishment of the adequacy and accuracy of information access
producers and identifications of any potential man machine interface problems
involving effective use of the IETM on the specified EDD.

m) Applications of results of test during the validation process of the correction of

deficiencies performed.

25
JSG 0852 : 2019
(Second Revision)

10.8 Validation of IETMDB

Validation of the IETMDB shall be carried out procedurally in the same fashion as the
validation of the several types of TI included in the IETM. Validation of the IETMDB shall
establish the following:

a) The IETMDB meets all specific requirements of specification as per clause 9.

b) All information contained in the IETMDB is technically accurate, based on

comparison of the data entries with actual hardware.

c) All relationships as defined in the data element dictionary of the IETMDB are
in place, valid and operable.

d) There are no open loops in the fault isolation tasks.

e) There are no un-referenced or inaccessible data entities in the system.

f) The IETMDB is capable of being used to construct individual IETM to

support the weapon system.

10.9 IETM System Validation

The IETM system validation shall consist of two parts; a demonstration of the system and
system software tests:

a) IETM System Demonstration - The IETM system demonstration shall:

1) Be performed entirely on an EDD provided/specified by the

purchasing authority.

2) Demonstrate the system‟s compliance with applicable specifications.

3) Demonstrate maintenance tasks, displayed for a selected sampling of

the various systems, in various levels of complexity.

4) Introduce a selected sampling of fault codes to exercise the retrieval

capabilities of the system.

5) Demonstrate all system utilities and special functions including ad hoc

user access to data.

6) Demonstrate the general visibility and readability of the IETM as

displayed on the EDD.

26
 JSG 0852 : 2019
(Second Revision)

b) System Software Tests - The vendor shall develop a software routine capable
of exhaustively testing the IETM system. This program shall:

1) Check that all data access links and branches are valid and operable.

2) Ensure that there are no “open loops‟ in the fault isolation tasks.

3) Ensure that there are no un-referenced or inaccessible data in the

system.

4) Check that all special functions are fully operable.

10.10 Quality Assurance Provisions

10.10.1 Responsibility for Inspection

Unless otherwise specified in the contract or purchase order, the vendor is responsible for the
performance of all inspection requirements. Except as otherwise specified in the contract or
purchase order, the vendor may use his own or any other facilities suitable for the
performance of the inspection requirements specified herein, unless disapproved by the Navy.

10.10.2 IETM Acceptance Tests

Acceptance tests shall be performed entirely on a standard EDD for IETM as specified by the
Purchasing Authority. Such a device will be provided/specified by the purchaser, for use by
the vendor, in validating the IETM and in performing QA inspections. It may be borne in
mind that compatibility with a specified EDD type is a primary contract requirement for the
IETM. Hence, the entire interactive display concept of digitized technical manual information
requires establishment of information calling sequences and the exercise of special functions,
with both processes dependent on software, which is functionally common to the automated
authoring system and to the display device. The proof that an IETM is satisfactory, therefore,
is that it may be scrutinized in a way, which demonstrates conformance with all specification
requirements on the device, which the end user handles.

10.10.3 Test Sequence

Tests will be conducted in two phases as under:

a) Tests to assure that the IETM functions satisfactorily when viewed with a test
display device; specifically, that all special functions are available, calling sequences
are correct and in general that all capabilities requested have in fact been provided.

b) A thorough review of the content of each screen to assure the following:

1) That no procedure has been left out.

2) That the material is written comprehensively.

27
JSG 0852 : 2019
(Second Revision)

3) That the TI is error free.

4) That troubleshooting information in fact leads to fault isolation in all

branches and that the technician is informed as to the calling sequences for
required information and can obtain it quickly and directly. These tests are
outlined in greater detail in the succeeding clauses.

10.10.4 Tests of IETM Functions

Following four functions shall apply:

a) Screen Sequencing - Using the required calling algorithm based on screen

references, every screen in the IETM will be viewed from the first to the last and the
logical sequences applicable to the maintenance procedure and to troubleshooting will
be evaluated.

b) Special Functions - Each of the special functions provided in the EDD would
be checked to see that it performs properly with the IETM being evaluated. The
ability of a technician to exercise these functions using the function keys and touch
screen capability of the display device will be evaluated

c) Display Characteristics - Tests outlined in this section are not tests of the
display device but of the IETM. The individual screens shall be displayed so that they
can be seen and understood properly by the technician, within the limitations of the
screen size, resolution, etc. The visibility of each screen provided will accordingly be
checked in this context.

d) Capability to Access Information - One of the primary reasons for preparation

of IETM is to provide a technician with the ability to reach needed information
immediately, without searching through hundreds of paper pages. For this reason, the
IETM is designed to provide multi path calling methods to access the information
required directly (i.e., without proceeding via numerous successive menus). The
ability of the technician to retrieve the information he needs for specific problems will
be accordingly evaluated based on a number of input requests. A software routine is
developed capable of being used to test exhaustively this aspect of the automated TI
when used with the EDD, to assure that.

1) All calling sequences (data access links) established by the author are
valid and operable.

2) Calling sequences implied by special function keys are fully operable.

3) User established calling sequences perform as indicated.

4) There are no „lost‟ (unreachable) data in the entire body of TI.

28
 JSG 0852 : 2019
(Second Revision)

10.10.5 Evaluation of IETM Content, Format and Style

a) Selected Screens - Selected screens will be used to perform a detailed

evaluation of TM content, format, style and user-interaction characteristics.
For example, a number of maintenance tasks will be followed through each
sub-task and step to evaluate completeness, accuracy, competence of the
graphics, arrangement, conformance to style requirements, inclusion of
warnings, cautions, notes, completeness of the setup information and the like.

b) Evaluation of Troubleshooting TI - Beginning with operationally

realistic defective performance reports, a series of troubleshooting paths will
be followed in detail to establish the effectiveness of these tests sequences in
isolating the fault. Experienced technicians will evaluate not only the
mechanical effectiveness but also the technical competence of the
troubleshooting procedure designed by the author for fleet system
troubleshooting under operational conditions

10.11 Packaging

10.11.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.

11. GUIDELINES FOR FORMULATION OF INTERACTIVE BROWSER-BASED

WYSIWYG FOR IETM

11.1 Browser Components and the Web Architecture-Overview

The Web browser is an integral component of the Joint Services IETM Architecture that
resides on the client side of the architecture. It should support the features needed by the
server side that provide the functionality to the IETM. Because IETMs in the JSIA may
provide a range of capabilities to the user, the browser should be capable of supporting a
range of features as well. Currently, there are two major browsers featuring competing
technologies that may support IETM capabilities. Microsoft's Internet Explorer and
Netscape's Navigator both support basic Web surfing capabilities. However, when higher
level scripting is introduced, there is the chance that incompatibilities may be encountered. It
is important to design the IETM to detect the type of browser in use by the client and provide
the appropriate code to support that particular browser. The following section explains the
minimum acceptable features of an intranet/stand-alone Web browser suitable for viewing
technical manual data. Due to the expense and time involved in developing custom browsers,
commercial browsers currently available on the market should be utilized. External
referencing may not work in this mode.

29
JSG 0852 : 2019
(Second Revision)

11.1.1 Salient characteristics of the Browser

The World Wide Web (WWW) browser should support the following minimum features:

a) Thin client/server model

b) Commercially defined object model
c) Browser should identify itself to the server
d) Commonly used internet transport and addressing protocols
e) Frames
f) MoD standardized controls, applets or software components
g) User interface
h) Offline browsing
j) Hypertext markup language (HTML)
k) Security
m) Java
n) Supported data types
p) Multimedia

30
 JSG 0852 : 2019
(Second Revision)

11.1.1.1 Thin client/server model

The browser should be a thin client, which necessitates Transmission Control Protocol
(TCP)/Internet Protocol (IP) connectivity. This model assures that IETM data need not be
permanently stored on the client machine.

11.1.1.2 Commercially defined object model

The browser should support at least one commercially defined object model [i.e., Component
Object Model (COM)/Distributed COM (DCOM), Common Object Request Broker
Architecture (CORBA)].

11.1.1.3 Commonly used internet transport and addressing protocols

a) File Transfer Protocol (FTP)

b) HyperText Transport Protocol (HTTP)

c) Uniform Resource Locator (URL)

11.1.1.4 Frames

The browser should support the display of multiple frames, so that multiple presentations of
information may be displayed simultaneously on a single screen.

11.1.1.5 Extensible components

The browser should support extensible controls and add-on components to process data types
not natively supported.

11.1.1.6 User interface

The browser should support the following user interface capabilities:

a) Context Menus should be available to permit the user to utilize all features and
options of the browser.

b) Tool tips should be made available to the user.

c) Configurable toolbars.

11.1.1.7 Offline browsing

The browser should provide the ability to browse information on the client system without a
permanent connection to a network.

31
JSG 0852 : 2019
(Second Revision)

11.1.1.8 HTML support

a) HTML 3.2/4.0 Strict (with support for Cascading Style Sheets).

b) Dynamic HTML should be made available using JavaScript as a minimum.

c) Full-screen mode.

d) Layers should be made possible using style sheets.

11.1.1.9 Security

The Web browser should provide security support for certificates, encrypted e-mail and
digital signatures, in accordance with the official MoD Public Key Infrastructure (PKI)
policy:

a) Personal Certificates - The Web browser should protect against fraud by

providing support for certificates.

b) Encryption - The Web browser should support FIPS 140 data encryption to
protect the data during transmission.

c) Digital Signatures - The Web browser should support the authentication of

senders by supporting digital signatures.

11.1.1.10 Java

a) Java Virtual Machine (JVM) - The Web browser should support a Java
Virtual Machine.

b) Just In Time (JIT) compiler - The Web browser may optionally support a JIT
compiler to improve the speed of execution for Java applets.

11.1.1.11 Supported data types

The Web browser should support the following simple data types, either natively or with the
use of add-on components:

a) Hypertext Markup Language (HTML)

b) Standard Generalized Markup Language (SGML)

c) eXtensible Markup Language (XML)

d) Portable Document Format (PDF)

e) Computer Graphics Metafile (CGM)

32
 JSG 0852 : 2019
(Second Revision)

f) Joint Photographic Experts Group (JPEG)

g) Tagged Image File Format (TIFF)

11.1.1.12 Multimedia

Components and plug-ins needed to support multimedia (e.g., video, animation, sound)
should be provided by the IETM and not assumed to be supplied by the browser.

11.2 Look and Feel Requirement

The following user-interaction categories were identified as those for which establishment of
common look-and-feel requirements are desirable:

a) Display Format

b) Browse Capability

c) Link Behavior/Navigation

d) Control Bars

e) Icon Standardization

f) Selectable Elements (Hot Spots)

g) Warnings, Cautions, Notes, Search & Lookup

h) Session Control (Suspend, Resume, Nested sessions)

j) Context Filtering

k) Screen Resolution & Color Graphics

m) Information Access (Indices, Electronic TOCs, etc.)

n) Dialogues

p) Sound

q) Voice I/O

r) Graphics

s) Hardware User Interface

t) Performance (Response Time by Context)

33
JSG 0852 : 2019
(Second Revision)

u) Printer Output

w) User Annotations (e.g., comments, user notes, redlines, bookmarks)

y) Feedback to Originator (e.g., TMDRs, Form-2028, AFTO 22)

z) Administrative Information (e.g., effectiveness, authorization, distribution,

Validation/Verification)

aa) Interface to External systems

ab Rapid Action Changes (RAC)/Critical Safety Interim Messages

ac) Specific treatment for Major Information Types (e.g., troubleshooting,

procedural data, parts, descriptive, etc.)

11.2.1 Explanation of above categories are briefly explained below

a) Display Format (Text/font, graphic, table, lists, Object Embedding)

1) Use Best Commercial Practices

2) Use of multiple frames (formerly “panes”) is not a requirement

b) Browse Capability

1) Browse capability should be available

2) User controlled access mode

3) No tracking of activities

4) Not rigidly tied to IETM controls

c) Link Behavior/Navigation

1) Persistent visual indication of link(s) to additional information should

be available.

2) There should be a visual indication of how the link behaves (e.g., goto,
gosub, relational).

3) If you are executing a link that is not a goto or exit link, you should be
able to return at any time to where the link began.

d) Control Bars

1) The User Navigation Panel (Tool Bar) should provide the necessary
choices/options available at the current time.

34
 JSG 0852 : 2019
(Second Revision)

2) The User Navigation Panel is required with an optional toggle

capability to turn it off.

3) The User Navigation Panel should remain accessible by persistent

visible indication.

4) Use the standard icons when applicable in the User Navigation Panel.

e) Search & Lookup

1) Use the standard icon to get the user into a search mode.

2) The user should be presented with the search options available.

3) At a minimum, a Keyword search against valid entry points (TOC/List

of Content) should be available.

4) The system should provide a search capability against Metadata (e.g.,

Keywords, tagged data, indexable data, searchable data, etc.) when it exists.

f) Session Control (Suspend, Resume, Nested Sessions)

1) The user should be able to suspend a session at any time. (e.g., Break,
Emergency, No Parts).

2) A subsequent resume should be capable of re-starting the session at the

same point it was suspended.

3) At the time of resume, the user should be advised that some key
parameters/condition settings may be out-of-date (e.g., aircraft safe for
maintenance, temperature change or other people worked on the end-
item/platform during the suspension). The system should support the three
Exit Modes:

i) Complete (Save and update history)

ii) Abort (Don‟t save or update history)

iii) Suspend (See above)

g) Ontext Filtering

1) The system should have the ability to perform context filtering on

effectively as a minimum.

2) The system should provide the user a mechanism for entering/

modifying configuration parameters.

35
JSG 0852 : 2019
(Second Revision)

h) Screen Resolution and Color Guidelines

1) Presentation system and graphics developers should consider the use of

standard “safe” colors visible across multiple presentation systems.

2) Presentation systems should not presume any fixed display resolution

or size.

j) Information Access (Indices, Electronic TOC‟s, etc.)

1) A Table/List of all key entry points should be made available for user
access.

2) Access should be provided via a Hierarchical Breakdown such as:

i) SSSN (MIL-STD-1808)

ii) LCN

iii) AECMA 1000D

iv) Functional and Physical Hierarchy

v) Graphical Interfaces are acceptable

k) Dialogues

1) Support should be provided for both pop-up dialog box and in-line
dialogs in the display frame itself.

2) Developers should use Best Commercial Practices for entering data in

dialog boxes (e.g., radio buttons, check-boxes, fill-ins, combo boxes, scrolling
selection lists, etc.).

m) Sound

1) Developers should use Best Commercial Practices when implementing

sound.

2) The user must take action to hear the sound. (No automatic playing of
sound).

3) User controls muting and volume via system controls (versus

embedded controls within the application). Optional: Application can provide
convenient access to the system controls.

36
 JSG 0852 : 2019
(Second Revision)

n) Voice I/O

Voice I/O should be used only as supplemental input/output and navigation.

Keyboard and pointing devices should be the primary input and visual display
should be the primary output.

p) Graphics

1) Developers should use Best Commercial Practices for graphics format

and display.

2) Preferred Vector Graphics Std: CGM - WebCGM Type 4 Profile

(moving towards ISO Std).

q) Hardware User Interface

1) Point and Click, Voice, Selection Keys, A/N Keyboard, Touch Pad, etc.

2) Point and click capability on target display should be assumed.

3) Developers should accommodate the limitations of the target display

device.

4) Alphanumeric Input Capability must be provided, if not in hardware,

then in software.

r) Printer Output

1) Printer Output is strongly discouraged.

2) Print capability should be used primarily for graphics.

3) All printer output should have version number and/or printed date/time
stamp.

4) When customer requires printed output Printer output should not have
to conform to normal Paper TM Specifications.

5) Satisfactory Options

i) “pre-composed” files (such as Adobe PDF) can be attached.

ii) “on-the-fly” composition for printing (of logical element) built

into the viewing application.

6) Screen Print. Preferred method: print data content of Active Window

only.

37
JSG 0852 : 2019
(Second Revision)

s) User Annotations (e.g., comments, user notes, redlines, bookmarks)

1) There should be a persistent visual indication that an annotation exists.

2) The default initial presentation of annotations is to appear minimized.

3) If there are levels of annotations (e.g., Public, Private, etc.), they

should be visually differentiated.

t) Feedback to Originator

1) A single user interaction should be available to select the function

(e.g., a Button, double mouse click).

2) The preferred user interface is a form.

3) The system should provide an output compatible with the user

environment.

4) There should be a “Form fill-in completed” function before

returning to the IETM (e.g., “submit”, “done”, “okay”, “close-out”).

5) The system should automatically generate an Electronic locator

(e.g., Address, Version) and to the greatest extent possible, relevant fields
on the form should be automatically filled-in (e.g., User Id, System State,
etc.).

u) Administrative Information (e.g., Effectivity, Authorization, Distribution,

Val/Ver) Administrative information should be displayable.

w) Interface to External Systems - A single user interaction should electronically

link to external references (e.g., another IETM) or external systems (e.g., Supply
Support/Parts Ordering, etc.).

y) Rapid Action Changes /Critical Safety Interim Messages

1) A visual indication of the existence of a critical change must be

displayed in context.

2) A single user interaction should be available to access the change.

3) The user should be provided with a visual indication for critical

messages at the start of the IETM.

z) Major Data Types (e.g., Troubleshooting, Procedural, Parts, Descriptive, etc.)

Because of differences in user cultures and requirements, this area cannot be
addressed by providing guidance. Lessons learned may be a better way to address this
category.

38
 JSG 0852 : 2019
(Second Revision)

11.3 Icon Standardization

An icon should show its name or function when the cursor is stalled over the icon.

a) Next

b) Previous [Chronological]

c) Return [Chronological]

d) Back [Logical]

e) TOC

f) Exit

g) Find/Search

h) Undo

j) User Navigation Panel Minimized

k) Processing Indication

m) Parts (IPB/RPSTL)

n) Suggested Changes/Feedback

p) Training

11.4 Multimedia Icon

a) Sound/Voice Icon

b) Full Motion Video Icon

c) Animation Icon

d) Graphic

e) Diagnostics

f) Warning

g) Caution

h) Note

j) Hazards per AIA PUB 119/Icons included in MIL-STD-38784

39
JSG 0852 : 2019
(Second Revision)

k) Print

m) One-way link (Goto)

n) Two-way link (Gosub)

11.5 Relational link

Browse

Fig 2 Example of an IETM Screen

11.6 Dangers, Warnings, Cautions and Notes

11.6.1 Handbook 511 - 9.2.7 Warnings, Cautions, Notes.

11.6.2 Standard colors for alerts: Red - Warning, Yellow - Caution, Cyan - Note.

11.6.3 In the past, warning has been used to denote what is now considered danger and
warning. Dangers, warning, cautions, and notes are defined in ANSI Z535.3. Here, a red
border is used for both danger and warning. Also, if the requirement is to be ANSI Z535.3
compliant, there is no guarantee that a printout will be readable, due to the choice of
background colors.

40
 JSG 0852 : 2019
(Second Revision)

11.6.4 Here are the 8-bit safe colors to be used for Dangers, Warnings, Cautions, and Notes :

41
JSG 0852 : 2019
(Second Revision)

11.7 Pop-up Dangers, Warnings, Cautions and Notes (If Used)

11.7.1 Handbook 511 - 9.2.7 Warnings, Cautions, Notes.

a) User should acknowledge pop up warnings and cautions before proceeding.

b) Pop up alerts should be centered on the screen.

c) A persistent icon should appear on the screen when alert is applicable.

11.7.2 Pop-up Dangers, Warnings, Cautions and Notes appear similar to a pop-up menu with
an OK button in the center of the user viewing area to alert the user of a specific condition.
(These are thus out-line rather than in-line). Some systems display all applicable pop-ups as
stacked window frames where the user acknowledges each one individually. In either case,
the user should be able to again see the pop-up(s) after they are acknowledged by clicking on
the applicable icon in the status footer.

11.7.3 For systems which allow minimized appearance of a pop-up Dangers, Warnings,
Cautions and Notes (as opposed to those that are in-line), the status footer bar at the bottom
of the screen will appear and display the appropriate icon as shown below:

12. VERSION MANAGEMENT OF IETM

12.1 Factor Based Allotment Version No. of IETM

a) All modifications made to an IETM since its inception (in case the IETM is
developed new).

42
 JSG 0852 : 2019
(Second Revision)

b) All modifications to an IETM from its previous release (in case these
modifications are undertaken after its previous release).

12.2 Naming Convention for Version Control

Every IETM shall clearly be identified by a “Title” followed by a “Version Number”,

indicated by 2 integers, starting from “00”. Every change from the release of the IETM will
be clearly identified as an incremental integer from “00”. For example:

a) “IETM for Radio Station RRF Ver. 00” - Initial release version.

b) “IETM for Radio Station RRF Ver. 01” - First revised version.

13. REFERENCES

[1] Federico Manuri and Andrea Sanna, A Survey on Applications of Augmented

Reality, Advances in Computer Science: An International Journal, Vol. 5, Issue 1,
No.19, January 2016, ISSN: 2322-5157.

[2] Norman I. Badler, Patrick J. Vincent, Extending Interactive Electronic

Technical Manuals (IETMs) with Real and Virtual Animated Content for
Maintenance Task Training, December 2008.

[3] Larry McMaster, George Cooper, David McLin, Donna Field, Robin
Baumgart, Geoffrey Frank, Combining 2D and 3D Virtual Reality for Improved
Learning, RTI International, Research Triangle Park, North Carolina.

[4] Next-Gen IETMS, White Paper, Excerpted from InfoTrends, Inc.

[5] Interactive 3D Technical Publication, Aftermarket Intelligence - IETM, June

2016 WP2/AMI/0616, June 2016.

[6] Eric L. Jorgensen and Joseph J. Fuller, A Web-Based Architecture for

Interactive Electronic Technical Manuals (IETMs).

[7] Eric L. Jorgensen, The Interactive Electronic Technical Manual Overview,

"Setting the Stage", Carderock Division, Naval Surface Warfare Center.

14. SUGGESTIONS FOR IMPROVEMENT

Any suggestion for improvement in this document may be forwarded to:

The Director,
Directorate of Standardisation,
Ministry of Defence, 'H' Block, DHQ PO,
New Delhi-110011.
Email id : director.defstand@gov.in

43
 JSG 0852 : 2019
(Second Revision)

ANNEX „A‟
(Clause 6)
A-15. DEFINITIONS FOR CLASSES OF IETMs

Table 3

S Class I Class 2 Class 3 Class 4 Class 5

No. Electronically Electronically Linearly Hierarchically Integrated Data
Indexed Scrolling Structured Structured Base
Pages Documents IETM IETM
a) Display a) Full page a) Primary a) View smaller a) View smaller a) Same as Class
viewing view is logical block of logical block of 4 for IETM
scrolling text with less text with very function.
window. use of limited use of
scrolling. scrolling.
b) Page b) Hot-spot b) Interaction b) Interaction b) Interactive
turner/next access (Hyper- through dialog through dialog electronic display
function links) to other boxes. boxes with user per MIL-M-
text or prompts. 87268.
graphics.
c) Intelligent c) User c) Interaction c) Interaction c) Expert system
index for user selection and per MIL-M- per MIL-M- allows same
access to page navigation 87268 to extent 87268 to extent display session
images aids (key work possible. possible. and view system
search, on-line to provide
indices). simultaneous
access to many
differing
functions
(e.g., supply,
training,
troubleshooting).
d) Page d) Minimal d) Text and d) Text and
integrity text- graphic graphic
preserved formatting for simultaneously simultaneously
display. displayed in displayed in
separate separate widow
window when when keyed
keyed together. together.

44
 JSG 0852 : 2019
(Second Revision)

Table 3 (Continued)

S. Class I Class 2 Class 3 Class 4 Class 5

No. Electronically Electronically Linearly Hierarchically Integrated
Indexed Pages Scrolling Structured Structured Data Base
Documents IETM IETM
b) Data a) Bitmap a) Text-ASCII a) Linear a) Fully a) IETM
Format (raster) ASCII with attributed datainformation
SGML/XML base elements integrated at
tags. per MIL-D- the data level
87269. with other
application
information.
b) Indexing and b) Graphics, b) SGML/ b) MIL-D- b) Does not
header files whatever XML with 87269 content use separate
(Navy MIL- viewer content wise tags with full databases for
STD-29532) supports, e.g. format tags. conformance to other
BMP or CALS. Generic Level application
Object Outlines data.
(architectural
forms).
c) MIL-R- c) Can be c) Maximum c) Authored c) Identical
28001 or SGML tagged- use of MIL- directly to to Class 4
postscript no page breaks D-87269. database for Standards for
pages. (browser). interactive IETM
electronic applications
output. data per
MIL-D-
87269.
d) Generic d) Generic d) Data d) Coding for
COTS imaging SGML/XML managed by a expert
formats. tags DBMS. systems and
equivalent to AI modules
MIL-D- when used.
87269.

e) Interactive e) Generic:
features COTS equal
authored to MIL-D-
invoice added 87269 data
on definition
and tags.
f) Generic:
COTS equal to
MIL-D-87269
data definition
and tags.

45
 JSG 0852 : 2019
(Second Revision)

Table 3 (Concluded)

S. Class I Class 2 Class 3 Class 4 Class 5

No. Electronically Electronically Linearly Hierarchically Integrated
Indexed Pages Scrolling Structured Structured Data Base
Documents IETM IETM
c) Functio a) Access a) Browse a) Dialogue a) Dialogue a) Single
nality pages by through driven driven viewing
intelligent scrolling info. interaction. interaction. system for
index/ header simultaneous
info. access to
multiple
information
sources.

b) View page b) User b) Logical b) Logical b) Same as

with pan, selection display of display of data Class 4 for
zoom, etc. graphics or data in in accordance IETM
tools. hotspot accordance with content. functions.
reference to with content.
more text.
c) Logical
c) Limited use c) Hot spot and NEXT and c) Logical c) Expert
of hot spots. cross- BACK NEXT and system to
reference functions. BACK assist in
usually added functions. NEXT
after original functions
authoring. based on info
gathered in
session.
d) Useful for d) User- d) Useful as
library or selectable interactive
reference use cross- maintenance
reference and aid.
indices.
e) Content e) User-
specific help selectable
available. cross-reference
and indices.
f) Content
specific help
available.

46
 JSG 0852 : 2019
(Second Revision)

ANNEX „B‟
(Clause 9.5)

B-16. GENERIC LAYER

B-16.1 Generic Layer

The generic layer defines general characteristics, which are common across all applications.
The generic layer defines the templates, linking elements, and context filtering elements
which are used to create content specific Document Type Definitions (DTD). The generic
layer includes a definition of each template and attributes lists associated with the template.
The following paragraphs provide a description of the components of the generic layer.

B-16.2 Templates

The following section defines the generic layer templates. These templates define semantic
rules for creating content specific elements. These semantic rules make up the minimum set
of constraints on content specific elements. The templates provide the structure for creating
composite nodes, context dependent filtering, interaction and branching. Each template has
two components: (a) a set of semantic rules that govern the template activities, and (b) a list
of attributes. The generic layer contains five templates: node, node alternatives, node
sequence, if node and loop node.

B-16.2.1 Node Template

The NODE template provides the capability to create composite structures within the content
specific layer. Composite structures may contain sub components that employ the NODE,
NODE ALTS or NODE SEQ. templates. The NODE sub components may be composite
structures themselves or they may be primitives NODES (text, tables, graphics, audio, video,
process and dialog). Composite structures create hierarchy within the CDM. When composite
nodes contain other composite nodes there is an implied hierarchy elements employing the
node template shall have a set of required attributes as follows:

a) Name - The “name” attribute of the element shall consist of the standard
nomenclature for an instance of the element.

b) Item-ID - The “Item-ID” attribute shall specify the reference designator(s) and
other indefinable designator(s), subassemblies, or part (s) referred to by the element.

c) Type - The “type” attribute shall specify the type of information contained in
the element.

d) CDM - The “cdm” attribute shall identify the type of template being employed
by the content specific element.

e) Ref - The “ref” attribute shall facilitate the reduction of data redundancy by
allowing data elements to be referenced.

47
JSG 0852 : 2019
(Second Revision)

B-16.2.2 Node Alternatives (Alts) Template

All elements conforming to the node shall contain a list of mutually exclusive nodes, only
one of which will be used at the time of presentation. The following semantic rules apply to
any content specific element employing the NODE ALTS template :

a) The element must contain components that employ the NODE template.

b) The components must be the same element type and at the same level in the
hierarchy.

c) At presentation time, the precondition for each NODE alternative will be

evaluated. The NODE whose pre-condition evaluates to “true” elected for resentation.

d) These components must contain mutually exclusive preconditions. In any

specific situation, at most one node would have a precondition which to true.

e) There need not be an applicable component for every possible situation.

B-16.2.3 Node Sequence (Seq.) Template

The NODE SEQ. template is the mechanism for creating interactive sequences with the user.
The following semantic rules apply to the NODE SEQ. template.

a) Any content specific element employing NODE - SEQ. must contain

components that employ the NODE, NODE ALTS, IF NODE or LOOP NODE
templates.

b) The components of NODE SEQ. are always traversed in the order they appear.
This traversal includes the branching and iteration implicit in any IF NODES or
LOOP NODES in the sequence logic.

c) If Node Template - Elements conforming to if node template provides 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.

d) 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.

B-16.3 Relational Links

Elements shall have relationship 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. Links shall be used to reduce
the number of redundant elements by referencing common elements. The “link” element
provides the capability for creating relational links within the CDM “link” is included within

48
 JSG 0852 : 2019
(Second Revision)

the content model of the NODE template, therefore, any content specific element employing
the NODE template may include relational links. The „HyTime‟ attribute indicates that “link”
employs the “link” architectural from (template) from the HyTime model. The end types
define the allowable anchors to which a node may point. The initial end types defined are
links to descriptive information, parts information or any primitive.

B-16.4 Primitive Elements

An IETMDB shall be composed of the primitive elements defined in the generic layer DTD
as follows:

a) 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.

b) Tables - Tables shall be represented as a series of separate entities, 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 primitives of information presentation
and attributes. Each entry may refer 9through a relationship) to any other template
element or primitive element in the IETMDB

c) Graphics - Graphics drawings, illustration information shall be structured in a

hierarchical manner and consist of logically related groups. Graphics shall be
composed of series of illustrious, which can be overlaid on each 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 are integral part of technical information.
Therefore, all possible standard representations should be included

d) Audio, Video and Process - The element audio, video, and process provide the
\capability for author to define an audio sequence, a video sequence or a call to a
software process

e) Dialogs - Dialog elements are the basic element, which provides the capability
for user intersection with the TI. During the presentation these elements shall be used
to prompt the user to input the response select a choice from the set from a set to
alternatives, or to select items from within a text, table or graphic (selection)

B-16.5 Context Dependent Filtering

Provides the capability to present the user with only the information that applies to a specific
situation. The pre-condition and post-conditions elements provide the mechanism for context
depending filtering. The pre-condition element enables the selection of the appropriate
information for presentation. The post-condition element enables the recording of
presentation events for later filtering. Context dependent filtering shall be accomplished
through author-defined preconditions. A pre-condition shall contain an expression, which
contain all the information necessary to identify what condition must be present to display
the TI.

49
JSG 0852 : 2019
(Second Revision)

B-16.5.1 Pre-conditions

The precondition element enables the selection of the appropriate information for
presentation. A precondition shall contain an expression, which contains all the information
necessary to identify what condition must be present to display the TI. Precondition elements
may be referenced by node elements. This implies that the element information is relevant
only if the preconditions are true in the presentation situation.

B-16.5.2 Post-conditions

The post-condition element enables the recording of presentation events for later filtering.
Post-condition asserts 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 situation.

B-16.6 Expressions

Any expression developed for an IETMDB shall conform to four types of expression defined
in the CDM as under:

a) The first is a binary operation between two expressions.

b) The second is the unary operation, which is applied to an expression.

c) The third and fourth are to identify a unique property or a value to be used in
an expression.

50
 JSG 0852 : 2019
(Second Revision)

ANNEX „C‟
(Clause 9.5)

C-17. GENERIC LAYER TAG SET DESCRIPTIONS

C-17.1 Scope

This ANNEX provides the detailed description of the elements and attributes to be included
in an IETMDB. It is formulated as a description of possible tags or name for components in
an IETMDB whose structure is defined by the generic layer DTD specified within ANNEX
„A‟ of this specification. The information contained is intended for compliance.

C-17.2 Agent

Used in the dialogue 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 the dialog
should be presented. The default value is „human‟.

C-17.3 Assertion

This element is used to make an assertion from within the content model of an application of
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 task
reference.

C-17.4 Audio

This element is used to hold an audio sequence.

C-17.5 Choice

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 from a menu, the presentation system will either assert some
Post-condition or will branch to another dialogue.

C-17.6 Default

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 default for the menu. The default value of the attribute is „no‟.

C-17.7 Dialogue

This element provides the capability of the user interaction. A dialogue could contain a sub
dialogue, menu, selection or any combination of the four. It may also contain an optional text
string, which would be the title of the composite dialogue.

51
JSG 0852 : 2019
(Second Revision)

C-17.8 Expression

The expression element provides the capability to create mathematical expressions to be used
for preconditions and post-conditions. 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.

C-17.9 Graphic

This element represents a composite graphic, which is made up of graphic primitives or other
graphic components.

C-17.10 HyTime

Used by the link element, this attribute is fixed default value (i.e., cannot be changed by the
entry of another value).

C-17.11 If-Node

The node template provides a method of conditional branching within an interactive

sequence. The template uses the same logic as the IF-THEN-ELSE statement in a
programming language.

C-17.12 Itemid

Used in all node elements, which identify the components of the system being repaired, as
they relate to formation elements. The item identification attributes specifies the reference
designator or other identifiable designator of the system, subassemblies, or parts referred to
by the element. The permissible values of this attribute are dependent upon the content
specific application using this primitive.

C-17.13 Link

This element provides the capability for creating relational links with the data. It the employs
the HyTime link architectural from template and may contain „anchors‟ called to identify to
or more link ends. The link element may contain the name of the relation.

C-17.14 Menu

This element defines a menu for user interaction. It consists of prompts followed by one or
more choice elements.

C-17.15 Name

Used in all node elements, this attribute holds the standard nomenclature for the element
expressed in character data. The permissible values of this attribute depend on the specific
element type.

52
 JSG 0852 : 2019
(Second Revision)

C-17.16 Node

This template by which technical information is defined. The node template contains the
content of technical information. The node template creates hierarchy within the CDM. The
node template also contains context filtering preconditions and Post-conditions. The link
element within the node template provides the capability to cross- reference 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 sub components that employ the node, node alts or
node seq. templates. The node sub components may be composite structures themselves or
they may be primitive nodes composite structure creates hierarchy within the CDM. When
composite nodes contain other composite nodes there is an implied hierarchy. The composite
node is the content model is a lower level in the hierarchy.

C-17.17 Prompt

This element defines the prompt to be displayed to the user for the presentation of a fill in or
a menu. It allows the prompt to be either a text string or a graphic.

C-17.18 Row

Used in the entry element, the value of this attribute consists of the row number of that entry
tabular information.

C-17.19 Select

Used in the menu element, the value of 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 default selection choice being single.

C-17.20 Selection

The element provides the capability of creating a special menu that allows selection within
even a picture, text string or a table.

C-17.21 Sequence

The element is defined as being an ordered sequence of data.

C-17.22 Table

This element defines how a table is constructed. A table will contain a column header
followed by one or more entities. The combination of the column headers and entries may be
repeated for as many columns as the table requires.

53
JSG 0852 : 2019
(Second Revision)

C-17.23 Text

This element defines how text is constructed. Within a text string, there may be embedded
text elements which allow the referencing of other elements through the link /location
mechanism of Hy Time.

C-17.24 Video

This element will be used to include a video sequence into technical information.

C-17.25 Window

Used in the graphic and graphprim elements, this attribute indicates the sub-rectangle within
a graphic, which should be displayed in those cases where the author wishes to display only a
portion of a large graphic of the user.

54
 JSG 0852 : 2019
(Second Revision)

ANNEX „D‟
(Clause 9.5)
D-18. CONTENT SPECIFIC LAYER
D-18.1 The creation of a content specific Document Type Definition (DTD) represents the
second layer of the Content Data Model (CDM). It identifies all the content specific elements
and their relationships for a given application. In this instance, the application happens to be
the display of organizational level data to the technician. This document breaks down data
into a hierarchy based upon the system/subsystem structure of the weapon system. It
identifies four different types of information, which may be referenced within the document.
They are procedural, descriptive, parts and fault data. Each type of information is
appropriately referenced and structured in accordance with a content specific DTD. One
content specific DTD shall apply for an entire range of information regardless of the desired
access to the information.

D-18.2 The general layer of the CDM shall define a set of primitive elements. These elements
shall cover any content specific layer DTD that includes the generic layer in an entity
declaration. Elements defined within content specific DTD that require the use of any of the
primitive elements need only include text, table, graphic or dialog within its content model.
The elements using the primitive elements shall be restricted to the structure of the primitive
elements as defined within the generic layer. 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” definition of the templates. The following describes
the requirements for the content specific DTD that are included in this specification :

a) Item/System Hierarchy - The 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:
1) Descriptive information
2) Procedural information
3) Troubleshooting information
4) Parts information
b) Descriptive Information - Descriptive information may provide information on
system (subsystem, component and 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.

c) 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

55
JSG 0852 : 2019
(Second Revision)

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 the task requires, through the establishment of
appropriate relationships.

d) 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. These are briefly explained below:

1) Fault Elements - Fault elements shall identify potential faults, which

might occur in the system.

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) 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.

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. 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.

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.

e) Parts Information - Two types of parts information shall be included:

1) Maintainer/Operator Information and Supply Information - Elements

containing either type shall refer explicitly to corresponding elements of the
other type. 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.

2) Parts information provided for the parts supply process shall constitute
unambiguous identification on a part so that it can be reordered and may
consist of such items as: the part number, description, source, system,
maintenance, etc.

56
 JSG 0852 : 2019
(Second Revision)

ANNEX „E‟
(Clause 9.5)
E-19. CONTENT SPECIFIC LAYER TAG SET - DESCRIPTIONS

E-19.1 Scope

This ANNEX provides the detailed description of the IETM content specific elements and
attributes to be included in an IETMDB. It is formulated as a description of possible tags or
names for components in an IETMDB whose structure is defined by a DTD specified or
developed in accordance with this JSG. The information contained herein is intended for
compliance.

E-19.2 Action

Used in the rectification (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‟.

E-19.3 Alert

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 user. A
warning notifies the user that a task or step may be harmful to him 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.

E-19.4 Attach

This element identifies all the attaching parts required for a given part information element.

E-19.5 Connection

This element is used to identify a connection between two “part information” elements (e.g.,
a connection between pin 123 and wire ABC).

E-19.6 Consum

This element identifies all the consumables required for the completion of the task.

E-19.7 Desc info

The element “Desc info” 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 “Desc info” element is very flexible. It can be used to describe any arbitrary,
hierarchical, hypertext like node.

57
JSG 0852 : 2019
(Second Revision)

E-19.8 Equip

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.

E-19.9 Fault

The element “Fault” is used to identify a potential failure, which may occur on a weapon
system.

E-19.10 Faultinf

The “Faultinf” element is used to define all the tests and faults associated with the system that
references it.

E-19.11 Fltstate

The “Fltstate” element identifies a set of implicated or exculpated faults. Implicated faults are
faults suspected of being bad; exculpated faults are fault 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‟.

E-19.12 Follow-On

A “Follow-on” condition is a maintenance condition, which must be accomplished sometime

allowing the completion of a task to clean up or undo actions performed during the task. For
example, in order to fix 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 pre-conditions, 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 post-conditions, which define the state
changes to be made once the follow on condition is accomplished.

E-19.13 Input

The input element contains the personnel required, the consumable used, the equipment used
and the required conditions for accomplishing a given task.

E-19.14 MTBF

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 (cycles), miles, events or other measure-of-life units.

58
 JSG 0852 : 2019
(Second Revision)

E-19.15 Outcome

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.

E-19.16 Partbase

This element describes the view of the “part information” of the supply system. It describes
the item in terms of its part number.

E-19.17 Partinfo

This element describes the view of the “part information” of the maintainer. It identifies “part
information” within its relative position in the weapon system.

E-19.18 Partnum

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.

E-19.19 Rect

The “Rectification” (rect) 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.

E-19.20 REPLVL

Used in the “Partinfo” element, this “Replenish level” (REPLVL) attribute represents the
minimum quantity of a part in stock that will trigger a recorder or stock action.

E-19.21 REQCOND

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 post-conditions, which will record the state changes made in
satisfying the conditions.

E-19.22 SMR

Used in the “Partbase” element, SMR (Supply, maintenance and recoverability) 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.

E-19.23 Step

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.

59
JSG 0852 : 2019
(Second Revision)

E-19.24 System

The “System” element defines the system/sub-system/sub-assembly hierarchy for the weapon
system. A “System” element must be created for any component (system, sub-system, and
sub-assembly) which has associated technical information (descriptive, procedural, fault or
part data).

E-19.25 Task

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 performed at regular intervals to ensure that the 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 links the required text, graphics, messages, prompts and references. A task
element contains linking information necessary to link one task to other tasks.

E-19.26 Test

This element indicates a diagnostic test that will lead to outcomes and guides the user
towards rectification.

E-19.27 Usableon

Used in the “Partinfo” element, this attribute identifies the different configurations in which a
part or assembly may appear within a system or vehicle.

E-19.28 Version

This element identifies the currency of the data by providing the last revision information and
change information necessary for taking delivery of partial database.

E-19.29 Weight

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).

60
 JSG 0852 : 2019
(Second Revision)

ANNEX „F‟
(Clause 11.1)

F-20. JSIA, CS & IA, MULTIMEDIA AND RFID

F-20.1 Joint Services IETM Architecture (JSIA)

F-20.1.1 Basic Architecture Independent of Operating System

The basic architecture of IETM is not intended for, nor constrained to, any specific operating
system or combinations of operating systems. Individual services or programs may restrict
their IETM applications to a single operating environment, but the basic architecture does not
require a specific operating system. In some cases, a weapon-specific feature or functionality
may need advanced functionality (e.g., downloadable diagnostic components containing
active agents for collection of on-board data) that operate only with a specific operating
environment and thus not be fully interoperable. However, some limited universal availability
can exist in that such an application can still be hosted and made available on a general-
purpose JSIA-compliant intranet. The Web-based network concept, upon which the JSIA is
based, can easily host multiple operating systems for the various Client and Server
computers.

F-20.1.2 Developing a Solution for IETM Inter-operability

The approach to developing a solution for the problem of inter-operability among IETMs
from various sources has been to adapt commercial and industry applications involving
electronic documentation for which there is widespread vendor-product support and these are
essentially all Web- based products to some degree. Taking into account the rapid changes
that have been occurring in Internet technology, the JSIA has to be designed to be extensible,
flexible and able to accommodate the predictable rapid growth in technology for all aspects
of the Internet, the Web and the emerging electronic-documentation applications being
developed to operate on the Web. Updates to any guidance document for the acquisition of
JSIA-compliant IETMs should be based on a continuing study of emerging military
requirements and compared with the current state of commercial technology and available
COTS products to assure that they still met the MoD requirements in the future.

F-20.1.3 The primary areas relating to the JSIA in which the needs of the military and
commercial communities may differ are those involving communication security (COMSEC)
and information assurance and the overall administratively imposed requirements for
operational presence on the Ministry of Defence Information Infrastructure MoDII (e.g.,
operating system limitations, restrictions on use of downloadable components, etc.).

F-20.2 Communications Security and Information Assurance

F-20.2.1 All IETMs developed to be JSIA compliant should be designed to be usable

within the Ministry of Defence Information Infrastructure (MoDII) as it matures and becomes
more available for logistics support operations. The functional area of using and deploying
IETMs in the field is one of these logistics support areas and forms a part of the Military
Support and Logistics System. As such, the IETM applications will inherit the requirements

61
JSG 0852 : 2019
(Second Revision)

for applications on the Support and Logistics System especially in the communications
security and information assurance area. These apply to unclassified IETMs as well as
classified IETMs. IETMs should conform to the prescribed rules on communication security;
however, it is likely that most of the specific IETM requirements and those of the associated
infrastructure implementation apply to the network elements (i.e., browser implementation
and settings and Web servers) and not to the specific IETM view package itself. The
communication and information-assurance security should involve user and server
authentication and be layered around the IETM accessing and viewing processes and should
not be part of the IETM-specific view packages or the actual implementation. The principal
exception to this statement is that the downloadable software components involved in an
IETM (including diagnostic routines and software agents) should be digitally signed and
issued a certificate by one of the official IETM management activities. In accordance with
MoD security policy (COMSEC references), any security mechanism implemented in any
MoD IETM should be limited to those that employ only the certificates issued by the official
MoD certified Public Key Infrastructure (PKI). In other words, proprietary or any other
security methodologies, which are not certified by MoD should not be used.

F-20.3 Multimedia and Other Items/Functions

F-20.3.1 The use of multimedia in IETMs marks the great distinction between a
traditional hard copy manual and a modern IETM. The information conveyed through
multimedia greatly enhances the presentation of the subject matter and increases the retention
of the material by the user. Multimedia includes audio, graphics, video and animation.

F-20.3.2 The textual information for procedures, instructions, or steps should not be
replaced by multimedia. Audio, video clips and animations will not be played automatically.
Audio, video clips and animations will be manually started by pressing "play" on a standard
Windows Media Player or QuickTime Movie and Audio Viewer control panel. Developers
need to ensure that the user can use the multimedia format being delivered.

F-20.4 RFID and IETM

F-20.4.1 RFID is the Radio Frequency based Identification Sensor used for verification
of data present in the item/unit or machines; RFID tags are increasingly used for the logging
of maintenance data wirelessly. RFID sensors can be integrated with IETM for the effective
maintenance and support of Military Logistics.

F-20.4.2 The IETM can be linked to diagnostic, prognostic and RFID/UID sensors
embedded in a vehicle or system, either through a data bus or by RF. Information collected
from the sensors directs the operator or maintainer to the appropriate operating,
troubleshooting or repair procedure and related illustrations and parts manuals for a unique
serial numbered system.

F-20.4.3 Web-based Interactive Electronic Technical Manual (IETM) can be used in

association with RFID technology for the System Maintenance and Health Management
functions.

62
 JSG 0852 : 2019
(Second Revision)

F-20.4.4 Diagnostic & Prognostic (D&P) sensors embedded in a system can be

Integrated with its IETM technology which provides data tracking and logging of faults,
maintenance requirements and changes in system condition, etc. This integrated system
provides the military logistics personnel direct access by linking the D&P data with the
appropriate maintenance and troubleshooting procedures as well as parts information for a
specific serial numbered system.

F-20.5 IETM Potential in Training

Interactive Electronic Technical Manuals, broadly defined as the Interactive Electronic

presentation of suitably prepared and formatted Technical Information, have a high potential
for streamlining the technical training process for the armed forces, for reducing training
costs and time, for simplifying training-associated logistics and for reducing operational risk.
This potential will be most effectively realized when the IETM is integrated with other
automated systems, including course-material preparation, display, course management,
telecommunications, management information systems and integrated database systems.

F-20.6 Type of changes and impact to Paper and Electronic Medium

Table 4

63
JSG 0852 : 2019
(Second Revision)

64
 JSG 0852 : 2019
(Second Revision)

ANNEX „G‟

G-21. NEW DEVELOPMENTS IN IETM

G-21.1 Augmented Reality

G-21.1.1 The term Augmented Reality (AR) refers to a set of technologies and devices
able to enhance and improve human perception, thus bridging the gap between real and
virtual space. Users of AR applications can keep a contact with the real world and this is an
advantage both from the technical point of view (a part of the space to be presented already
exists and it is not necessary a computer generated model of it) and the physical point of view
(a detachment form the real world can lead to physical and mind discomforts).

G-21.1.2 The main blocks characterizing an AR system are - a tracking system, an

asset/scene generator and a combiner. A lot of AR systems rely on optical trackers; in this
case, a camera is necessary to frame the real environment and then the video stream is
received by a head tracking module. This module computes position and orientation of the
head with respect to the framed objects; position and orientation are necessary to correctly
align assets. The output of the head tracking module is sent to the scene generator block.
Head location and orientation information allow the scene generator to generate assets and
accurately align them. The combiner overlaps assets to the user view.

G-21.1.3 Different methods are used by the combiner. The first is based on see-through
devices which allow the user to see the real environment with his/her own eyes and assets
generated by the scene generator are overlapped by an optical effect. The second paradigm is
based on hand-held (mobile) devices which a camera to gather a video of the real world, a
display to show the augmented environment and the computational power to: compute the
camera position-orientation (by optical tracking), generate assets and combine virtual objects
with the video. The third method is called monitor-based AR, in which camera,
computational power and display (a monitor) are not encompassed in a single device. This
method is used when either large displays are needed or the camera must be independent
(e.g., in augmented endoscopy).

G-21.1.4 Technicians involved in complex maintenance and repair tasks often need to
refer to instruction manuals to correctly complete assigned procedures. This might entail a
high cognitive load deriving from a continuous switch of the attention between the device
under maintenance and the manual. In other words, mistakes are more likely and repair times
(and hence the costs) can grow up. A first attempt to mitigate these issues was the
introduction of Interactive Electronic Technical Manuals (IETMs) able to replace paper
instructions. On the other hand, also IETMs cannot be completely part of the interaction
between technician and equipment to be maintained.

G-21.1.5 AR can efficiently tackle this issue and manufacturing repair has been
immediately identified as one of the most promising application field of AR. Assets are
overlaid and correctly aligned with respect to the device to be maintained and can be
conveyed to technicians while they are performing the procedure. Moreover, AR applications
for maintenance and repair are often completed by telepresence systems; in this way, a
remote expert can interactively support maintainers when AR aid is not sufficient.

65
JSG 0852 : 2019
(Second Revision)

G-21.1.6 First attempts of supporting technicians by AR tools can be dated back to

1990s and they were all based on special purpose hardware (e.g., HMDs). On the other hand,
recent advances of mobile technologies have opened new challenging and intriguing
scenarios for this type of applications. Tablets and smart-phones allow users to perform easier
some tasks such as routine maintenance of a car, furniture assembly, installation of electrical
appliances and so on. If we consider the huge amount of money related to these activities, it
is immediately clear the tremendous impact the AR might have on our everyday life.

G-21.1.7 At the present time, the spread of AR in maintenance and repair tasks is very
limited; this is mainly due to the time needed to create, change and improve the procedures.
A Method was developed to mitigate this issue where in a procedure is managed as a set of
sequential states: each state is related both to a tracking configuration and to a set of assets to
be played when the tracking system recognizes the configuration in the real world. Existing
states can be deleted and new states can be easily added; an asset library allows content
makers to quickly associate an object configuration with a set of aids to be conveyed.

Fig. 1 AR Application for Maintenance Procedures. The Application Supports the

Technician Through the Repair Task of an Industrial Device

Courtesy - A Survey on Applications of Augmented Reality, Advances in Computer Science:

an International Journal, Vol. 5, Issue 1, No.19, January 2016

G-21.1.8 AR proved to be an effective and efficient tool to improve traditional learning

and training paths. AR changes the way users and machines interact and this can stimulate
students to approach the study of course material in a different and more pro-active way. Fig.
2 provides an example of Magic book application - a 3D model of planet Earth is visualized
on top of a 2D image of Earth itself depicted on the physical book; the application allows to
rotate the model and to change its size to provide further interaction.

66
 JSG 0852 : 2019
(Second Revision)

Fig. 1 A Magic Book that Provides Multimedia Content Related to the Current Page
Framed by the Camera

Courtesy : A Survey on Applications of Augmented Reality, Advances in Computer Science:

an International Journal, Vol. 5, Issue 1, No.19, January 2016
G-21.2 Virtual Reality

G-21.2.1 Maintenance training for modern systems requires learning procedures, which
integrate diagnostic skills with remove and replace skills. Computer-based virtual
maintenance training is used nowadays as an alternative to expensive constructive and live
hands-on training. It makes use of 2D and 3D virtual environments for training.

G-21.2.2 VR can be used to provide a safe, self-paced learning environment. Various

training scenarios can be incorporated. It also provides safety since mistakes made by the
user will not lead to equipment damage and does not affect the health of the user. VR based
training helps to gain knowledge on the functioning of the equipment/machine,
troubleshooting and diagnostics skills, basic operational skills, etc.

67
JSG 0852 : 2019
(Second Revision)

Fig. 2 Screenshot of a Simulation That uses Virtual Reality to bring Alive and Provide
Context for the Technical Manual Fig.s
Courtesy - Combining 2D and 3D Virtual Reality for Improved Learning, RTI International,
Research Triangle Park, North Carolina

G-21.3 3D Technologies

G-21.3.1 Digitization is increasingly taking over all the traditional approaches in

product development to bring better customer experience, time-to-market and operational
efficiency. This is particularly true for technologically-sophisticated products. Interactive
Electronic 3D Technical Manual (IETM) is one of the enablers of digital product
development for the manufacturing organizations.

G-21.3.2 3D technologies provide a secondary method of understanding technical

content. Animations and videos of complex installation or removal procedures reduce part
breakage and provide “just-in-time” training for junior technicians. 3D simulations can allow
a technician to watch a procedure and then enact it inside the digital simulation. Simulations
can help supply perspective for complex and large products. Audio clips can help technicians
identify critical clues to isolate equipment faults. Richer multimedia such as video and
simulation enables the visualization of technical processes as well. This multimedia can also
be useful for navigating the array of parts and specifications in a complex product. A multi-
frame viewing client and intelligent graphics with embedded hyperlinks (or “hot spots”)
provide multilateral navigation between text and graphics.

68
 JSG 0852 : 2019
(Second Revision)

G-21.3.3 Interactive BOM, exploded views, annotations are the available in 3D

technical manual. It is possible to rotate, zoom and pan while seeing the work instruction. 3D
animation is usually synchronized with instruction steps.

G-21.3.4 3D IETM document will have creative representations of product 3D models.

Documentation skills and knowledge on assembly process and service process is required to
build a 3D IETM manual.

Fig. 3 An Example of 3D Illustration

Courtesy: Interactive 3D Technical Publication, Aftermarket Intelligence - IETM, June 2016

G-21.3.5 Conventional CBT modules often consist of two-dimensional (2D) imagery,

although the images may be of 3D objects. The content of these modules may appear
realistic. Fig. 4 shows an interface that is used to provide virtual training of a particular
procedure. The design of the interface is oriented around the concept of giving a trainee
various tools to complete a given procedure in the interactivity panel. At any time, the user
can use the task list panel to monitor progress through the procedure. The user can click a
step to view its details in the step detail panel but, by default, that panel displays the details
for the next step to be executed.

69
JSG 0852 : 2019
(Second Revision)

Fig. 4 User Interface used for Virtual Training of a Procedure

Courtesy : AFRL-RH-WP-TR-2009-0027, Extending Interactive Electronic Technical

Manuals (IETMs) with Real and Virtual Animated Content for Maintenance Task Training,
December 2008

G-21.4 Applications

G-21.4.1 With digital interactive, 3-Dimensional, illustrative and enterprise integration

capabilities, IETM can be used in product development, manufacturing and service process in
various applications like:

a) Product maintenance manuals

b) Product and component repair manuals

c) Interactive service bulletins

d) Trouble shooting manuals

e) Routing and harness manuals

f) Assembly work Instructions

g) Product marketing manuals

h) Equipment handling manuals

70
 JSG 0852 : 2019
(Second Revision)

j) Process operating manuals

k) Product and component catalogues

m) Training and E-learning - product and process

G-21.4.2 Advantages

The usage of digital documents, technologies like 3D, AR and VR adds great value to IETM
documents. It provides many advantages as listed below:

a) Increase customer adoption and capture greater market share

b) Increase operational efficiency

c) Time reduction in process planning & documentation

d) Standardized procedures & work instructions

e) New level of clarity effectiveness in technical manual

f) Near elimination of trainings & reduce training investments

g) Increase first-time fix rate and reduce resolution cycles

h) Grow aftermarket service and parts revenues

j) Increase productivity and lower manual labor costs

k) Minimize production costs related to printing and translation

71