IETM Level IV | Interactive Electronic Technical Manual | Hyderabad

Interactive Electronic Technical Manuals


Code and Pixels is Pioneer in designing and developing of IETMs. Code and pixels is the only company in Hyderabad having strong R&D team exclusively for IETM.

Code and pixels has executed IETM assignments for Indian Navy, Indian Army and we are approved vendor for DRDO, ASL.

Code and pixels has delivered number of Level 2/3 or Class 2/3 and Level 4/Class 4 or Level 5/Class 5 IETMS for many defense labs and OEM i.e. Bharat Dynamics Limited (BDL), MAG 4, Electronics Corporation of India Limited (ECIL), TATA, L&T, Tractors India Limited to name few.

Outline of IETM

(This Article on IETM has been written by (G.Gopi krishna from Code and Pixels, 7 years into IETM Service, and 20 years of overall IT experience)


IETM or Interactive electronic Technical Manual, as the name indicates, it is a Manual which is interactive and in the form of electronic/digital.

Then PDF file is also electronic/digital, will that be called IETM?

Yes, undoubtedly PDF is also IETM. It's Level 2 IETM.

I need to give an example so that u can understand better about Levels. . Every one of us must have played digital games. In that, we need to cross various levels. The first level would be simple, the second little difficult, and 3rd level more challenging and 4th Level tough.

Question is, why this documentation is required?

Along with phone or vehicle or any household gadgets, we get a user manual because, in case we have any trouble while using, we can refer to the manual and resolve the issue, without connecting to OEM or service center as might not be available 24 X7.

Hence, these documents should be in simple language and easy to navigate, and easy to reach any point in few clicks.

The bigger the system/device the more pages are required and more variety of manuals are required. i.e. User manual, Operator manual, Maintainer manual, Spare list, and so on.

If some fault has occurred in the system, then the operator may need to refer to more than one manual and it is very difficult to refer to multiple hard copies. Even it is not easy to refer to multiple PDFs and refer to the issue as there is no linkage between all PDFs.

The purpose of the Manual is to guide the operator. If the manual is more dynamic that will be easy for the operator to refer and resolve the issue.

Level 4 and to some extent Level 3 will be very handy and very fast. All the documents are converted to a database, hence searching and inter-document referring will become easier.

I.e. a user can search for a problem and easily reach that particular page in seconds and also can see all the related topics to that topic which is being displayed.

Simple is Level 1 and advanced is Level -4

LEVEL -1 Normally scanned document Normal PDF file
LEVEL -2 Basic PDF file with indexing, internal links between pages
LEVEL -3 Intermediate HTML/XML based Software
LEVEL -4 Advanced HTML/XML based software with advanced navigation features

Indian Defense wants all the equipment to be delivered along with IETMs since 2014.

Based on the complexity, Level 3 or Level 4 is asked in the RFQ document. Since 2018, mostly Level 4 is asked to deliver.

What is IETM is it a document similar to PDF?

IETM Level 1 and 2 are PDF files.

IETM Levels 3 and 4 are not any document like MS Word or PDF file.

IETM is a combination of Software and database. All the manuals are converted to SQL database. Using IETM Viewer, the user can access the data i.e. manuals, drawings, images, etc.

IETM has 3 modes. User mode where users can access the documents. Admin mode where Admin can create users and track the activities of users.

Super admin or Authoring tool, where all the manuals are converted to database using this authoring tool.

Standards:

IETMs are available in 2 standards

  • INDIAN Defense Standard (JSG 0852:2001)
  • European Aviation standard (S1000D)

INDIAN STANDARD

Government of India, Ministry of defense has framed few standards, Joint service Guide 0852:2001 and reframed in 2007.

European Aviation standard

It is called S1000D, mainly used in the Aviation industry

If the RFQ or tender documents say it is IETM means, it's Indian standard only. If the end-user wants S1000D, then specifically “S1000D IETM LEVEL -4” is mentioned.

What is the difference in both the standard?

Ultimately the purpose of both the standard is the same, easy accessibility to all the documents and key points in few clicks.

Indian Standard uses SQL Database and IETM Viewer to see the database. IETM Viewer has tools to navigate faster and most effectively.

IETM does not need any third-party software to run. OEM can edit using the authoring tool which is available in IETM software.

S1000d is very costly than the Indian standard.

Indian Standard is SQL based and HTML based and s1000d is XML based

Few companies convert Documents to XML and call them S1000D.

Simple XML is not an S1000D IETM. If the end-user /navy/shipowner does not have a CSDB studio then all these IETMs cannot be imported and made a single master IETM.

CSDB studio is very costly software and is mainly supplied by western counties. Indian version CSDBs is not compatible with original S1000d importing.

Call 9849527706 or mail gopikrishna@codeandpixels for more details.

Our IETM Client Base

L&T - BRAHMOS NAVY IETM

TATA - NAVY IETM

RCI - Medium Range Surface to Air Missile (MRSAM) IETM

ASTRA (DRDO) - IETM

Hindustan Shipyard Limited - IETM

Ananth Technologies Limited - IETM

Nova Integrated Systems Ltd - IETM

BDL - AKASH MISSILE IETM

POONA BEARING - Missile Handling Trolley (MHT) IETM

POONA BEARING - Missile Handling Trolley Vehicle (MHTV) IETM

HITECH HYDRAULICS -Missile Tranportation Vehicle (MTV) IETM

HITECH HYDRAULICS - Akash Tent Vehicle (ATV) IETM

TIL - Transport Cum Loader Vehicle (TLV) IETM

TIL - Akash Auto Crane (AAC) IETM

ECIL - Mobile System for Missile Checkout (MSMC) IETM

ECIL - Combat Command Control Centre (CCC) IETM

TATA - Akash Army Luncher (AAL) IETM

TATA - Mobile Luncher Repair Station (MRLS) IETM

ideaForge - IETM

Man Energy Solutions - IETM

DESMI - IETM

TATA

Larsen and Toubro

NOVA

Hindustan Shipyard Limited

Marine Electricals

ideaForge Technology Pvt.Ltd.

Desmi

Man Energy Solutions

Navcon Advanced Systems

Piramal

TIL

Kirloskar

DRDO

Army Air Defence Colloge

ASL

RCI

Brahmos

Hitech Hydraulics

NTPC

Bharat Electronics

ECIL

Bharat Dynamic LTD.

Ananth Technologies

MIL

Astra

ECA 3G

Ground

Welcome to Code and Pixels IETM knowledge center!!

If you are a Vendor / Supplier / OEM or a PSU/Defense lab looking for Interactive Electronic Technical Manual delivery then you are in right place.

We are the pioneers in the field of IETM worked in association with IETM approval agencies OF india.

WHY YOU ARE HERE, Let us guess!!

  1. If you are OEM then
    • RFQ/ Bid document says IETM as a deliverable along with your System/Subsystem. And you want to know the tentative cost of IETM so that you submit a competitive quote.
    • If you are awarded a contract of supply, you need to start IETM development and search for the right partner who can guide you.
  1. If you are PSU/Defense lab or Production Agency
    • You want to make a specifications/ Scope document for IETM
    • You want to understand the latest standard/ technology of IETM
    • If you are a production agency, you might want to initiate IETM
  1. If you are IETM supplier
    • You want to know what’s new in IETM technology and want to know about date of next webinar on technology.
    • Or you want to outsource your contract to us.

IETM, NEW word in your RFQ/ SCOPE…? Know the story behind.

For the past few years, the Navy/Air force/ Army wants all the OEMs to deliver training Aids along with equipment or the machines. Training Aids include

  • Technical Manuals / Technical Literature
  • Computer-based Training
  • Video film
  • Charts and Blowups
  • Training Work Models
  • Scale down models etc.

It is becoming very difficult to refer thousands of hard copies or PDF files when the issue arises in equipment to fix it.

Now from the past few years as per the guidelines received from Navy/Air force/ Army headquarters, they want OEMs to deliver IETMs along with actual machinery. IETM is one of the deliverables mentioned in the RFQ/Scope document. To submit the quote, you need to know the tentative cost of IETM.

If the system is small (we mean page count of all the manuals put together is not more than 4,000) IETM Level -3 is asked in RFQ or scope document.

If the page count is more IETM Level 4 is proposed.

How code and Pixels Can assist you?

We are very glad to share of experience and knowledge, irrespective you give business to us or not.

Talk to our experts for 5 minutes, who had delivered 30 IETM project life cycle. Get an insight into your need. Understand the process, cost, time, efforts, inputs required.

We are proud to serve the nation and Defense and happy to assist you with all your queries.

Our Basic questions are:

  • How many pages does your document has
  • Does the SCOPE/RFQ mentioned IETM level 3 or LEVEL -4?
  • Does your scope says JSG or S1000d

If you have answers for this questions, call 90000 90702 now, and share your details. Our technical team will call you within a hour.

There are two specifications/standards that exist.

Joint Service Guid
( JSG 0852: 2001 )
Reaffirmed 2007

Designed and Developed by Directorate of Standardization Department of Defense Production. Ministry of Defense, New Delhi

It has been framed by 20 different types of stakeholders and steering committee, from Army, Navy, Air force, Scientist of Defense labs, Capt, Lt. Cdr from various organizations and labs such as BEL, ADG systems, NHQ, ACAS, HAL, BDL, GRSE, Goa Shipyard, MIDHANI, MDL, BEML, DQAL, Dte Standardization, CQA, DS cell Bangalore, etc.

IETM Means, a software made as per Joint Service Guide ( JSG 0852: 2001 )

S1000d

S1000D is jointly produced by Aerospace and Defense Industries Association of Europe (ASD), Aerospace Industries Association of America (AIA), and ATA e-Business Program

This is not called IETM. This is called the IETP.

Following Documents are Integrated in IETM

  • User Handbook (UHB)
  • Design Specification (DS)
  • Technical Manuals (TM)
  • Illustrated Spare Parts List (ISPL)
  • Manufactured Recommended List of Spars (MRLS)
  • Diagnostics and Installation (DIM)
  • Special Maintenance Tool & SPL Test EQPT (SMT & STE)
  • Initial Stocking Guide (ISG)
  • Maintenance Scale (MS)
  • Permissive Repair Schedule (PRS)
  • Inventory
  • OEM Manuals
  • Operating Manuals
  • Combat Manuals
  • Deployment manuals
  • Air Transportation Manuals

Introduction to IETM |History of IETM | what is IETM?

  • Technical manuals (e.g. maintenance, user, training, operations, etc) published in electronic format are becoming more and more popular than paper based manuals for their interactivity, convenience and ease of use.
  • For example, the maintenance and operation manuals of a warship, which used to occupy 300 -350 sq. feet of prime area with thousands of pages of technical literature.
  • It was very difficult to refer some operating process or trouble shooting from thousands of hardcopies. Each time, maintainers had to refer multiple books to get information related to issues.
  • To address these issues, IETMs were introduced in ships initially. IETM is the replacement of paperwork / hard copies
  • IETMs are now replaced by their electronic versions occupying very little space and can be viewed on tablets from any part of the ship. These electronic technical manuals are termed as Interactive Electronic Technical Manuals (IETM) or Interactive Electronic Technical Publications (IETP).
  • Interactive Electronic Technical Manuals (IETMs) or Interactive Electronic Technical Publications (IETPs) are technical manuals (such as maintenance, training, user or operations manuals) usually authored in XML or HTML -5.
  • IETMs are a portable, electronic "library" which contain thousands of pages of documentation and images and allows end users to trace technical documentation in a more efficient manner, and the digital nature provides a more agile and accurate method of updating technical documentation.

The Classes of Electronic Technical Manuals

Level 0/Class 0 Non-Electronically-Indexed Page Images

As we all know that Level 0/Class 0 gives us the full description of the spectrum by providing the digital page with images that can be mean to plan for electronic archival filing. These pages allow the users to view only on an electronic device but it does not have the detailed index for navigation with this document for the online purpose.

Level 1/Class 1: Electronically Indexed Page Images

In this level systems with a digital page with images are provided with full page display and it allows the navigation by means of user-friendly which can be an automated index page. For e.g: Navy Advanced Technical Information System – ATIS). This type of systems which can be used in libraries and as well as used for reference setting for research and reading purpose.

Level 2/Class 2: Electronic Scrolling Documents

Systems for Interactive Display of ASCII-Encoded Documents using an intelligent index and Hypertext tags inserted into an attached document file. In general, the document is the result of a simple conversion from a page-oriented document but with little or no alternative by a subject matter expert with the exception of adding hypertext tags. These allow a user to navigate through the document, but have very limited, if any, author inserted navigation aids or a content-driven "NEXT" function.

Level 3//Class 3: Linear Structured IETMs

Interactive Display of Technical Information which is SGML tagged using MIL-D-87269 tags to the maximum extent possible and using a Hypertext presentation system for display in accordance with MIL-M-87268. It is based on a sequential SGML document file and not a hierarchically based on Database. Navigation is based on author developed make employing features such as to bring dialog boxes and content-driven logical "NEXT" function.

IETM Class-III is a linearly structured electronic document where the content is stored in smaller logical blocks of text with hyperlinked content to different logical pages and less use of scrolling compared to IETM Class-II. Class-III IETM is structured in freely flowing linear format following the logic of the content.

Key Feature of our Class-III IETM are:

  • Content derived from Logically Hyperlinked Static Pages and not related to database
  • Linear Structured Table of Contents with Hyperlinked data
  • Interaction through dialog boxes
  • Logical display of data in blocks related to content
  • Logical NEXT and BACK functions for User navigation through content
  • Page Search and Keyword search capabilities of content
  • Text and Graphics support for the content display
  • Useful as interactive training, operation and maintenance aid
  • Content specific help available
  • Module wise deployment for Content, Manuals, Illustrations, Spares, Glossary, Help and E-Book View for manuals

Code and Pixels, IETM Level IV and Level V expertise

  • We are proud to be in association with Indian Defense
  • CODE AND PIXELS IETM Frame work has been successfully used by Army, Navy and Air force since 2013. We are empaneled vendors to supply software to DRDO, ASL, BDL, ECIL and many other OEMs who supplies systems and sub systems to various Indian Defense agencies.
  • We have an exclusive R&D wing and it has been efficient since 2013 and we have studied various IETMS available across the globe and we have done enough R&D before releasing our IETM frame work in 2015
  • Code and Pixels has developed Robust Frame work and authoring tools and we have successfully executed 25 + IETMs design and Development projects

Skill Set
  • MIL-M-87268, MIL-D-87269, and MIL-Q-87270
  • JSG-0852:2001 Joint Service Guide Document

Graphic User Interface
  • Graphic User Interface as suggested in JSG-0852:2001 Joint Service Guide Document
  • Standard Navigation Tools
  • Easy to navigate, Tree structured based content tree and user friendly Graphic user interface
  • Frame oriented instead of being page oriented

Security
  • Role based Login Control and Dynamic User access control (User, Admin)
  • 256 Bit Encryption for data safety
  • Database configured as per MIL -PRF 28001 Standards document
  • Dynamic User Access control to reduce the risk of unauthorized access to content data
  • Backup and Restore Module for protecting the loss of data

Cross Plat form Compatibility and Deployment
  • Our IETM Frame work is cross platform compatible
  • Code and Pixels Frame works is compatible for multiple devices i.e. Lap tops, PCs, Tablets etc.
  • IETM can be operated in Windows Operating systems and also LINUX OS
  • IETM can be browser based or EXE based as per the clients requirements
  • No 3rd party tools are required to install IETM in Clients Machine
  • It can be played as EXE (Executable file) Or can be played in Browser
  • It can be installed in Client server Environment and also in single System

Performance
  • In Class-IV IETM the data to be stored in a relational database, obtaining benefits of data integrity and removal of data redundancy.
  • As the content (Images, Text, tables, Hyperlinks, Hot spots) is saved in database, hence content will be loaded in fraction of seconds from server.
  • Content completely hyperlinked are mapped directly to relations in the database schema.
  • Content will be driven dynamically from Database based.
  • Dynamic data access from Relational database and reduced use of static pages.
  • Content data derived in textual, graphical, audio or video formats in a relational database which is composed of logically connected but randomly accessible IETM data elements.
  • High-end Server with good bandwidth LAN would make IETM more efficient.
  • Our IETM frame work supports 1 lakhs plus pages and 500 concurrent users.

Modern and Latest Technologies
  • HTML 5 (responsive) based content integration and module based deployment
  • Applications : Angular JS Frame work, Electron
  • Database : My SQL
  • Frontend : HTML5, Bootstrap
  • Encryption : AES 256 bit

EED-P-23: NAVAL SPECIFICATIONS FOR IETMS
  • JSG 0852:2001 JOINT SERVICE GUIDE
  • MIL-M-87268: MIL STANDARDS: REQUIREMENTS FOR MANUALS, INTERACTIVE ELECTRONIC TECHNICAL MANUAL
  • MIL-D-87269: MIL STANDARD FOR SUPPORT OF DATABASE

Features of IETM

IETM is equipped with User management tools, content management tool, Authoring tools

User Dashboard
  • User Dashboard consist of features like Manage Bookmarks, Manage Annotations , View Activity, Change Password, Enter IETM, Logout

Admin
  • Admin can control the documents access based on user profile. I.e. For Operator user , only manuals related to operator can be given access and for maintainer user only Maintenance related documents can be give access.
  • Admin can see user login history and user Annotations and feedback etc.

View Activity
  • View Activity Feature consist of Last login, Created Date and a Table with all the previous login and logout’s gets displayed.

Change Password
  • This Feature enables User to change his own password and to update his own security questions.

Enter IETM
  • This Feature enables User to enter into IETM Core and access the IETM Data by selecting the desired module.

IETM Core
  • IETM core consist of IETM Content section on the Right and Tree Menu on the Left for navigation of content, IETM Core consist of Global Search, Local Search, Print, Annotation, Bookmark, Help and Select Module, History Navigation and Home options.

Annotations
  • Annotations are displayed by an icon at the Top Right beside the Global Search with Annotations Count of particular page. User can select the text with mouse and Add Annotation option appears to users to add new annotation in the content page.

Print IETM Core
  • Print feature is provided in IETM Core to print the current page content

Bookmark
  • A Bookmark Icon is provided at the top of content section to bookmark a particular page and can be added by clicking the Bookmark icon, A popup with Name Bookmark name field gets appeared.

Word Explainer
  • Word explainer feature helps in providing a Description/Explanation to a word by clicking on the word and is highlighted with a color in IETM Content

Image Explainer
  • Image Explainer feature helps in linking a related image to a word in the IETM content, the word with the image explainer is highlighted with a color in IETM content.

Video Explainer
  • Video Explainer feature helps in linking a related Video to a word in the IETM content, the word with the video explainer is highlighted with a color in IETM content.

Hotspotting
  • Hotspotting functionality is used to link a word to respective image/Drawing of the same page, works with mouse hovering or selecting text or part of a image by which respective drawing or image will highlighted.

Hyperlinking
  • Hyperlinking feature enables user to navigate from one page to the other related hyperlinked page by mouse click, the hyperlinked data is highlighted with a color and underlined.

Image Viewer
  • By clicking on image or enlarge icon of the image at the right bottom of image respective image is displayed in a popup of image viewer.

Page Navigation
  • Page navigation feature enable the user to navigate to next and previous pages , by clicking on Prev Button at the left bottom of content area user gets navigate to the previous page of the content.

History Navigation
  • This feature enables the user to navigate to his previous steps based on his navigation history of the current session, by clicking on the right arrow in the top header user gets navigated to the forward.

Global Search
  • Global Search provides a functionality to search a keyword with matching page name and also content text form entire IETM Core and the results are displayed in tabular format with Page Title and Module Name. by clicking page title user gets navigated to that page.

Local Search
  • Local Search provides a functionality to search a keyword in the same page and the matching text is highlighted with a color in that single page.

Related Content
  • Related Content features is located at the right bottom of IETM content section. We can link the Related Pages of IETM Core, Document and Drawings which are related to this page content in this feature.

Page Expand View
  • IETM Page can be expanded upon clicking the arrow button provided at the bottom of the tree menu section

Manuals Tab
  • Manuals tab is provided in the header above the tree menu. All the manuals related to can be placed in this tab and can be viewed with the help of pdf viewer provided in the IETM application.

Logs Tab
  • Logs tab is provided in the header above the tree menu. This section enables User to add and store the logs of required data for the user

Glossary Tab
  • Glossary tab consist of Add, Sort , Find options with a tabular display of the glossary Related to content in IETM Core

Select Modules
  • User can be navigated to desired module form this Select Module Button, A list of all available modules will be displayed in dropdown.

Help for IETM
  • This consist of two pages About IETM and How to use IETM with the information related to IETM and a video how to use IETM.

Logout
  • Logout enables the User to close his session and logout form the IETM dashboard and redirects out of application from his access to login page of IETM.

EED-P-23: NAVAL SPECIFICATIONS FOR IETMS

1) JSG 0852:2001 JOINT SERVICE GUIDE
2) MIL-M-87268: MIL STANDARDS: REQUIREMENTS FOR MANUALS, INTERACTIVE ELECTRONIC TECHNICAL MANUAL
3) MIL-D-87269: MIL STANDARD FOR SUPPORT OF DATABASE
4) MIL SPECIFICATION: REQUIREMENTS FOR QA PROGRAM
5) MIL-PRF 28001: MIL STANDARD FOR DATA FORMAT: BIT MAP INDEXING AND HEADERS FILES
6) ISO 8879:1986 SPECIFICATION FOR STANDARD GENERALIZED MARKUP! LANGUAGE(sgml) FOR TEXT AND OFFICE SYSTEMS
7) S1000D: IETM DOCUMENTATION STANDARDS ADOPTED BY THE CONSORTIUM OF EUROPEAN AEROSPACE INDUSTRY.

What is S1000D

  • The S1000D specification requires a document to be broken down into individual data items (called Data Modules) which can be marked with individual XML labels and metadata, and be part of a hierarchical XML structure.
  • This permits the updating of single data items without necessarily changing the path down the XML tree which points to them.
  • Knowledge thus classified can then be shared among many publications, and updating of items in the underlying S1000D (XML) document will automatically affect updating of the dependent publications.
  • S1000D is maintained by the S1000D Steering Committee, which includes board members from Aerospace and Defense Industries of Europe (ASD), the United States' Aerospace Industries Association (AIA), and the Air Transport Association (ATA), along with national industry and defense representatives

A new buzzword in the technical publishing world. New word? Not exactly new, but surely it’s a new word in the Indian Defense Technical Publishing segment.

S1000D is an Interactive Electronic Technical Publishing IETP. It’s also called IETM too.

S1000d is not new but very few Indian companies, which support documentation of foreign Airline documentation are similar to S1000d word. But almost 90 % of the people who do S1000D conversation do not know what s1000d is.

Few tools available in the market which are used to make XML files But they are not an IETM creating tool, Just XML conversion tools. After converting to XML, they send to foreign airlines company, where they foreign airline companies plug-in theses XML into their S1000d suits.

What is S1000D

S1000D is the European standard of technical publications or technical documentation being followed in Aerospace since 1980, which uses CSDB, a Common source database which is used for preparing, managing, and publishing technical information for a warship, or Aerospace, or even Civil airlines too.

The first release of the S1000D Specification was in 1989 and in August 2019 the latest 5 Issue was release

An airplane or ship is built with thousands of components, subcomponents and navigation equipment, and many more. Hence, these components are supplied by many OEMs (Original equipment manufacturers). OEMs make the documents to their own standards. Each document and format is entirely different because all OEMs don’t maintain similar standards. At that point, the Technical Publications Specification Maintenance Group (TPSMG) was formed. They proposed a DM-based (Data Module) Based structure. TO manage these Data modules CSDB was maintained. (Database). Data Module is the standalone section of the document. For example, let’s assume that one data module is prepared on Operation of GPS and stored in CSDB, then whenever GPS operations are to be reproduced for different aircraft or different systems, simply that Data module can be copied and plugged.

In short, reusability and the format used is XML, and tags are defined by the S1000D steering committee

S1000D History in brief

A few years back S1000d is mainly used in the Aerospace segment, because S1000d is basically governed by Steering Committee formed by ASD, Aerospace Industries Association of America (AIA) ATA e-Business Program These organizations form the S1000D Council

Hence, it’s more apt for the Aerospace industry.

Currently, Defense systems – including land, sea, and air products, civil aviation, Ship industry of the US have adopted these standards while making documentation.

Now Indian Defense system is also trying to adopt S1000D for their documentation activities.

When Navy/IAF/Army wants s1000d IETM, it is implied that the navy has CSDB Suit /Local CSDB Server

20- 50 OEMs or Service providers will give S1000d data Modules of various systems and the Navy CSDB Local server will host them and monitor them and does the user management

If the navy does not have a CSDB suit then, still they can run IETM, but a standalone version where no user management will be done by IETM Viewer.

(User management will be done by Navy CSDB Local server which hosts all the data modules of various OEMs)

S1000D is not suitable for smaller systems. It’s very apt for the systems which have around 1 lakh pages of documentation and the project has just initiated the documentation.

S1000D and its basic principle

  • Content or data produced following the standard is in Data Module
  • This data module is the smallest and self-contained content or data unit within a technical publication
  • A data module must have sense and meaning when viewed without any supporting data other than images and diagrams
  • These data modules will be stored and managed in CSDB, Common Source DataBase
  • Using this CSDB we can publish output in a page-oriented or Interactive Electronic Technical Manual
  • These Individual data modules are re-usable components and can be used repeatedly in an output.

Benefits of S1000d?

  • Reusability of data hence reduces production cost
  • Standardization of data and naming conventions
  • Standardization of data and naming conventions
  • Good for legacy data conversion
  • Proper documentation and version control management
  • Zero printing cost and zero occupancies of space as no Hard copies are to be maintained. Achieved by reusing instead of recreating information each time it is required
  • Easily to maintain and distribute: Facilitates transfer of information and electronic output between systems very easily and conveniently
  • Multiple Vendor support
  • Fastest reference to operator or maintainer than traditional paper-based documents
  • Many different output forms can be generated from a single data source i.e. from CSDB we can generate IETM and also PDF format which can be used for printing if need be
  • Customized Output creation: Allows sub-sets of information to be generated to meet specific user needs and user levels.

S1000D USERS

  • Military
    • Air
    • Land
    • Maritime
    • International
  • Civil/commercial
    • Aviation
    • Aviation
    • Space
    • Urban
    • General technology
  • Others:
    • Manufacturer
    • Integrator
    • Supplier
    • Suppliers of documentation
    • Technical service providers
    • Software vendors/

Common information sets provide the following data: -

  • Crew/Operator information
  • Description and operation
  • Maintenance information
  • Wiring data
  • Illustrated Part Data (IPD)
  • Maintenance planning information
  • Mass and balance information
  • Recovery information
  • Equipment information
  • Weapon loading information –
  • Cargo loading information
  • Stores loading information
  • Role change information
  • Battle damage assessment and repair information
  • Illustrated tool and support equipment data
  • Service bulletins
  • Material data
  • Common information and data
  • Training
  • List of applicable publications
  • Maintenance checklists and inspections

One of the greatest advantages of S1000D is

In JSS 0852 IETM, first, documentation has to be done in JSS 251 format, in MS word then IETM activity starts.

In S1000D, Separate documentation need not be done. Whatever we do in MS word will be done using s1000d Author software.

Once all the documentation is done, We can simply export them either as PDF or as IETM or XML files with Project manifest file so that these can be deployed in any other S1000d distribution servers/ CSDB studios of navy

IETP S1000D

  • “IETM” and “Documentation” both are NOTseparate activities. In S1000D the activity is documentation.
  • Once documentation is done, then we can publish as IETM or As PDF also

Common Source Data Base

In S1000D Documentation, 2 software's are used

Authoring Tool :

  • Its is like in simple words, MS word, where we write the content and put images etc.
  • IN MS word its .doc file, in S1000D, its XML Data Module.
  • In this authoring tools we need to write content in S1000d defined XML Tags, so that all the documents designed by all the OEMs will be in same lines across the globe.

CSDB Server

  • This is server software that stores all the databases and also tracks versions, and manages Data modules
  • S1000D needs some codes so that every Data Module has unique code.
  • CSDB server creates these unique codes automatically.
  • Helps in publishing IETMs, PDFs and Source XML files

Major advantage of s1000d

  • lets say each ship is built by has 50 OEMs and all 50 OEMs supply IETMS in different formats, then it will be difficult maintain uniformity.
  • If all 50 vendors gives the end user s1000d IETMs then all the IETMs will almost in similar format.
  • To achieve this, the end user must have S1000d CSDB server with them to host all the files received by various vendors.
  • If Navy/IAF/Army do not have CSDB suit then, still they can run IETM, but a standalone version where no user management will be done by IETM Viewer.
  • (User management will be done by end users CSDB Local server which hosts all the data modules of various OEMs)

S1000D and its basic principle

  • Content or data produced following the standard is in Data Module
  • This data module is the smallest and self-contained content or data unit within a technical publication
  • A data module must have sense and meaning when viewed without any supporting data other than images and diagrams
  • These data modules will be stored and managed in CSDB, Common Source DataBase
  • Using this CSDB we can publish output in a page-oriented or Interactive Electronic Technical Manual
  • These Individual data modules are re-usable components and can be used repeatedly in an output.

Benefits of S1000d?

  • Reusability of data hence reduces production cost
  • Standardization of data and naming conventions
  • Open source and non-proprietary
  • Good for legacy data conversion
  • Proper documentation and version control management
  • Zero printing cost and zero occupancies of space as no Hard copies are to be maintained. Achieved by reusing instead of recreating information each time it is required
  • Easily to maintain and distribute: Facilitates transfer of information and electronic output between systems very easily and conveniently
  • Multiple Vendor support
  • Fastest reference to operator or maintainer than traditional paper-based documents
  • Many different output forms can be generated from a single data source i.e. from CSDB we can generate IETM and also PDF format which can be used for printing if need be
  • Customized Output creation: Allows sub-sets of information to be generated to meet specific user needs and user levels.

CODE AND PIXELS AND S1000D:

  • For the past 8 years, we have been executing IETM projects for Army, Navy, and Airforce in JSG 0852 format.
  • In 2016, the first time we received an inquiry from a Dubai-based oil and gas firm. We have also come across the s1000d term in various Navy documentation meetings. we have then initiated R&D activities on S1000D Implementation and hired S1000d experts who have worked on various defense Aerospace projects.
  • we have interviewed 50 members who mentioned s1000d in their profiles. We picked them from LinkedIn. They don’t even know what s1000d is. They were told that the project was s1000d, and they blindly did data entry work on the conversion of word to XML.
  • We initially tried to develop software for S1000d. We later realized that S1000d is not just making Doc files into XML files. It has thousands of standards of XML tags as mentioned by S1000d documentation.
  • We have searched for an organization that is already an expert in delivering S1000d solutions. After almost 6 months of evolution, we have done a technical tie-up with one of the best s1000d service provider companies. (US-based firm)
  • We have executed projects in S1000d successfully.

S1000D IETM IETP 1


S1000D IETM IETP 2


S1000D IETM IETP 3


S1000D IETM IETP 4


S1000D IETM IETP 5


S1000D IETM IETP 6

IETM VS IETP? What is this new confusion?

It’s not confusion, it’s clarity. You are on the very right track. Understand the difference between IETM and IETM.

Let’s not get confused any anymore again with the technical Jargons. Let us come straight to the point.

  • If it is JSG 0852 :2007 then it’s IETM
  • If it is s1000d then it’s IETP.

IETM - JSG 0852:2007 Architecture

IETM - S1000D Architecture

Frequently Asked Questions about IETM

Interactive Electronic Technical Manual

No, IETM is a combination of Database and Software. The database will be viewed using IETM Viewer.

IETM Viewer is software that is used to see the manuals that are converted into a database.

IETMs are asked to deliver along with systems, equipment, devices of defense supplies i.e. ships, missiles, radars, etc.

As per the new guidelines of defense, all the OEMs must supply IETM along with the physical component.

Login-based access, Next, Previous, History, Search, Annotations, Bookmark, Activity tracker, Fullscreen, Hotspot/hyperlinks, Image-based hotspot, Text-based hotspots, Video-based Hotspots, Change password, Content tree, expandable and collapsible, homepage main menu items, etc.

Yes, if it is IETM Level 3, you can run from DVD, because it does not have any database. Its standalone HTML 5 based pages with IETM Viewer. IETM Level 3 does not update your navigation history or user credentials etc hence can be run from DVD. Whereas Level 4 is database based, hence requires database installation. LEVEL 4 tracks all user activity and user-wise reports hence, every activity is tracked and the database keeps updating always. That is the reason IETM level 4 does not work from DVD or CD

Level 1 is obsolete, Level 2 is PDF file Level 3 is used for smaller systems and Level 4 is mainly in use

JSG 0852: 2001, reframed 2007 is acceptable Indian Standard of IETM

In earlier days, OEMs used to deliver hard copies of manuals due course of time it has become scanned image so that space is reduced. As technology advanced, PDF and Interactive PDFs were delivered. For more fats and better reference, IETMs were evolved which are database based hence takes very little space and fast in terms of searching for key ford and excellent for cross-referring between multiple manuals.

INDIAN Defense Standard JSG 0852 and International aviation standard S1000D.

IETM is not freeware or open-source its proprietary software

If you have procured the correct authoring tool, then knowledge of programming is not required.

YES, IETM can be viewed from different devices and different sizes of monitors.

Yes, IETM can be viewed in Linux OS.

All the browsers support IETM viewing.

A few years ago IETM was EXE based. Due course of time, browsers have become more powerful and easy to use, and they are compatible with multiple devices and OS independent hence, browsers have taken over EXE-based IETMs.

EXE-based IETMs are obsolete now. A few years back, in 2015 Exe based IETMs were delivered to clients. A separate EXE has to be delivered for 64 bits system and also for 128 bits system. IETMs cannot be seen in Mobiles or Tabs. Hence all the EXE based IETMs are converted to browser-based IETMs

Contact sales@codeandpixels.net from your official mail ID and schedule a demo

IF IETM is mentioned in RFQ then it is Indian JSG 0852 standard only. Only very few end users are asking for S1000D. The use specifically mentions S1000D if they are looking for that standard.

It depends on the number of pages and Basic software cost. If OEM wants an authoring tool, the additional amount is paid. Price also depends on standard. In general, s1000d cost 4 times more than the INDIAN standard.

Deliverables are, IETM DB ( Database), IETM Viewer to see the DB and a server file, and Installation manual and User manual ( User manual and Admin manual) If you are also delivering Authoring tool then Authoring modules user manual.

For S1000D, IETM is generated using CSDB studio which is authoring and distribution software. Once the document is authored then, it is exported as S1000D IETM. CSDB exports as XML package and also as IETM. This XML package has a Manifesto file wrapped with XML files. These XML packages can be imported into any Standard CSDB application.

Definitely not. S1000D IETM output is XML which used thousands of S1000D tags and DMs. Hence IETM developed using XML is not S1000D IETM. CSDB studio is needed to export IETM. CSDB studio maintains all version changes and Data Modules (DM) etc. Normal XML based IETMs can be called S1000d based IETMs.

Common Source DataBase is a software used to generate S1000D IETMS. S1000d is an international specification for developing technical publications.

S1000D is a recent concept introduced in India. S1000D IETMs are being developed by big aerospace companies but they use foreign-based CSDB i.e. Boeing spectrum etc. They cost crores. Indian companies use CSDB of western countries as of now.

Any XML-based application cannot be called CSDB studio.

CSDB Studio can create S1000d specified pages/DMs using specific Tags. CSDB can import original S1000D DMs and export any project into 2 3 outputs. IETM Viewer, XML package and PDF file.

CSDB studio can produce different DMs for different types of content.

A file or XML produced using CSDB studio is called Data Module. Its self-contained unit of data. It means it can be imported into any other CSDB studio

As the name indicates, it’s a complete list of data modules that are required to make a project or export a project.

It’s a unique code given for each data module. A 17 to 41 character alphanumeric code. No DMs will have the same name. Every DM is identified by its DMC.

From 2018, all Defense/Navy/Air force clients are asking for IETM along with other training Aids such as CBT, Video Film, Charts and Boards, and Technical literature Hardcopies.

Based on the complexity of your Machinery/System/Vehicle/Equipment, you will need to provide different types of manuals as deliverables. (User handbook, Design specifications, Technical manuals, and Illustrated spares parts list)

Manufacture recommended list of spares, DIM, SMT & STE, ISG, MS, PRS, Inventory, Deployment manuals, Combat manuals, Operating manuals, Maintenance manuals and many more as per your system. The count of all together may range from 5000 to 25,000 for big systems.

If the user has to refer for a topic, then she/he has to refer to all 10-15 manuals hard copies or soft copies (PDFs) separately. It’s a time taking and troublesome process and also not completely resourceful.

For example, if a user wants to search for some particular LRU (line replaceable unit) then he has to open each and every PDF and search for the LRU. He will get many results and it will be hard to refer to all the 16 PDFs at a time. Sometimes, he may have to refer to 2-4 manuals together for a solution. In this case, traditional PDF file or Hard copy will have many limitations.

To overcome the limitations, IETMs are designed.

IETM basically combines all these manuals and creates interactivity between all the manuals and drawings etc. That’s the reason it’s called Interactive Electronic Training Manual.

In IETM, all the manuals and drawings, images, and videos will interact with each other through hyperlinks, hot spots and cross references etc. Thus, searching for topics is made possible in a single click with 100% efficient result.

Ask your client whether they want IETM Level 3/Class 3 or Level 4/Class 4. And count how many pages of text they have.

Price varies based on the number of pages and the Level of IETM. Level 3/Class 3 is less expensive than Level 4/Class 4

Though the name reads Electronic Training Manual, it is not a single file or Manual. IETM is a software package.

A software where all the pages of manuals are converted and embedded in IETM framework or IETM software.

IETM is a software where all your manuals sit.

May it be IETM level -3/Class 3 or LEVEL -4/Class 4, we need all the manuals which are to be converted (either into PDF or Word format), all the images (JPEG, PNG, TIF) and all the CAD drawings converted in PDFs and Videos that are to be embedded into IETM.

We need table of content/content classification done by your subject matter experts.

We also need your subject matter expert’s help in connecting documents and also giving hyperlinks, related topics, glossary etc.

If you have any Videos or Images already made, then we will put exploded views in IETM. The IETM vendor’s responsibility is to embed all inputs provided by OEM into IETM frame work.

The IETM scope does not cover the designing of Charts, Blowups, Exploded Views, and Animations etc.

If you want exploded views, then that will be taken as content development activity.

It depends on the number of pages to be converted. We have done almost 35 IETMs of various levels. As per our experience to make Level 3/Class 3 IETM having 5000 pages, it takes around 30 days.

For documents 10,000 to 20,000 it takes around 60 days.

Major hindrance that we face is availability of final documents from OEM.

We had this experience several times that OEMs have to collect documents from many sources and number of versions are available for each document. OEMs usually focus on actual equipment but not on documentation of equipment. Collecting final approved files from OEM is the biggest challenge in IETM development. If all the final approved documents are in place, it takes standard time as mentioned above.

You need to nominate a person as a Point of Contact from your end. Our technical team will be in constant touch with the POC to take approval on UI and UX (User interface and user experience), i.e. the logos to be used, color formats, table of content finalizing and cross checking of IETM etc.

    Probably, your client must be looking for IETM level 3/Class 3. IETM level 3/Class 4 only can be played from CD/DVD player. IETM -4 requires installation as it used Database.

It depends on your client’s requirement. General practice is, IETM level 3/Class 3 is used when documents are less, i.e. below 5000. When documents are more, IETM -4 is required.

Having said that, we have also done 5000 Pages IETM Level 4/Class 4 or Level 5/Class 5 and 6000 pages Level 3/Class 3.

It completely depends on the Client. If your system is small, you can convince them to go for IETM level 3/Class 3

We are the only company having experience of delivering 30 + IETMs in past 5 years and one of the few companies having experience in developing the IETMs for Indian defense

We worked closely In associated with all the Defense Labs and we are fully aware of their requirements as almost 30 IETMs are being used by various Army or Naval, Air Force headquarters and training centers and Army Air Defense Colleges etc.

You can verify our Purchase Orders and approval letters.

IETM is the combination of software and data conversion. We have the strength of 50 + software and content development professionals and we guarantee delivery date as we have experienced resources having dealt with 30 project life cycles.

We have a strong R&D team, which exclusively works on improving software as per the latest technologies.

Difference Between IETM level 3 and Level 4

10.What is the difference between IETM level 3/Class 3 and Level 4/Class 4 or Level 5/Class 5?

    The below tables demonstrates the differences:

S.NO Feature Description -IETM -3/ Description -IETM -4/5
1.        Password Protection YES YES
2.        Login Password Yes.
But common for all.
Yes.
Different for all. Maintainer, Operator, Admin, Super Admin (Developer mode)
3.        User access All the contents will be visible to all the users. No control over access rights to specific users. Based on login credentials, we can restrict users. I.e. Operator will be able to see only contents and PDFs and Drawings related to operator only.
4.  Admin NO. Only single log in for all users. Yes. Admin can create and manage users and content access rights.
5.  Super admin/Authoring tool No Yes. Client can update the content.
Using Super admin or Authoring tool, IETM can be edited. Text, images, Content tree, hyperlinks can be done using Authoring tool.
6.        Database No data base. Documents will be stored as HTML SQL – Complete text and user information, Content structure will be stored in SQL database
7.        Dash board No User Dash Board to manage user activities.
Admin Dash Board to manage admin activities.
8.  Nature of content Static Dynamic. Complete data is stored in the database.
9.        Interactivity Less More
10.    Bookmark, Annotations NO Yes.
User wise bookmarks and annotations.
11.    Glossary Yes Yes
12.    Search Local Search Local and global search (Full IETM search).
13.    Delivery & Execution CD and DVD or USB Installation. Can’t be played from DVD/USB.
Need client server environment.
14.    Dependent software's to play NO NO. IETM has inbuilt image and video players, PDF viewers, hence no 3rd part installations are required at client side.
15.    Operating systems Linux Windows and Linux.
IETM can be browser based or EXE based.
16.    User activity monitoring NO Yes. User log in history will be tracked.
17.    Hyperlinks Yes, Hardcoded Dynamic. Each frame, Images or topic will be given a unique code.
18.    Hotspots (A pop up window having image, Video and Text plainer) Yes , Hardcoded Dynamic
19.    Contents Tree Structure YES YES
20.    When to use When page count is up to 5000 Anywhere from 5000 to 2 lakhs.
21.    Specifications JSG 0852:2001 Joint service Guide JSG 0852:2001 Joint service Guide
MIL Standards - 87268, 87269 (DATABASE)
22.    Print No Admin can print the required files.
23.    Content Page based approach. HTML pages are developed and integrated Frame based approach. No pages exist. All data will be stored in database. Based on request from user, content will be fletched from server and displayed.

References

https://en.wikipedia.org/wiki/IETM

https://en.wikipedia.org/wiki/S1000D

https://s1000d.org/

https://www.aerospaceonline.com/doc/what-is-s1000d-0001

http://www.aia-aerospace.org/wp-content/uploads/2018/12/S1000D-User-Forum-2018-Tutorial-Part-1-FINAL-R2.pdf

Still, we have provided you our version of content and an easy to understand a quick 2 minutes Video for more clarity on IETM. At this point we are assuming that you have knowledge on IETM. If you don’t have knowledge, then scroll down and read “introduction to IETM” section then come back to this place.

A brief about us: We are the only company that has delivered around 30 IETM projects of all types of IETMS (Leve-2, Level3, and Level 4/5) to the Indian Navy, Army, and Air force. We are the only company having 50 plus professional IETM documentation engineers working for 8 years.

Download Pdf

1-CODE AND PIXELS _KNOW ABOUT IETM 2021

2-CODE AND PIXELS PROFILE_IETM_2021

3-IETM AND IETP_COMPLETE GUIDE (JSG 0852 VS S1000D)

Interactive Electronic Technical Manuals - Videos


IETM JSG 0852


IETM JSG 0852 Architecture

IETM JSG 0852 Working Process


S1000D Architecture

S1000D Software Working Process