Complete information about IETM Level -4

IETM has 5 levels

• Level 1: Scanned PDF

• Level 2: Indexed PDF ( Having internal hyperlinks)

• Level 3: HTML-based interface having hyperlinks for cross-reference. A separate TAB /section for drawings is available. The user interface is protected by login. Content is organised in a structural table of contents format.

• Level 4: Advanced Form of Level 3. This level uses a database; hence powerful search feature enables users to access any keyword easily. This level has features like bookmarks, annotations, user activity tracking, search, user management, hot spots, hyperlinks, related content, glossary etc

• Level 5: When IETM uses actual user data and does analysis of data its called level 5
  This level does not exist as of now. Because no user gives actual data to 3rd part software to analyse. i.e. you can not pull data from radar information and store it in IETM database. No Radar vendor or ship vendor or missile vendor transfers the data to IETM software in real-time. Hence, this level as of now does not exist.
  Some people argue that using 3d virtual reality and augmented reality is Level 5, but it's not true.
  There is no relation between AR, VR, 3d, CBT, Videos, etc. These are separate works to explain the system effectively.
  These all can be plugged into IETM, which makes IETM a centralised repository of multimedia

IETM has 2 standards

• INDIAN STANDARD, which is developed as per JSG 0852

• European standard developed as per S1000D

Indian standard uses a database, and European standard uses XML

Softcopies of User Manuals

Submit all manuals in fully editable formats, such as:

Microsoft Word (.doc, .docx)

Editable PDF (not password-protected, not copy-protected, not scanned/raster images)

Note: Manuals that are locked, password-protected, or in image-only form (scanned) will incur additional charges due to retyping or OCR processing.

Images, Videos, and Drawings

Provide all multimedia files needed for integration into the IETM.

Formats accepted:

Images: .jpg, .png,

Videos: .mp4,

Drawings: .dwg, .dxf, converted to image/PDF

Table of Contents/Content Tree

Subject Matter Expert (SME)

Assign an SME who can address technical clarifications and support accurate content transformation.

Manuals Must Be Editable

Ensure all files are not restricted by passwords, security locks, or copy-protection.

Avoid scanned PDFs or image-based softcopies.

If files are found to be non-editable (e.g., scanned, locked, or rasterized), additional costs will apply for manual text extraction or retyping.

Important Notes & Past Experience

“Softcopy” is frequently misunderstood:

Editable softcopies mean files where text can be copied and edited (like Word or true PDFs).

Scanned documents or images are not considered usable softcopies for direct conversion, even though they are digital files.

OCR (Optical Character Recognition) can sometimes be applied to images or scanned PDFs, but text accuracy is not guaranteed and often requires manual verification and correction (additional charges will apply).

Such file restrictions and misunderstandings are especially common with manuals from OEMs in Russia, France, China, or Germany.

• No high-end hardware or specialised servers are required to run IETM. However, for installations with a high number of concurrent users, it is important to ensure a server with good configuration and reliable LAN connectivity.

• Minimum system requirements: An Intel i3 processor with 8 GB RAM is the baseline for either the server or node.

• Lightweight web application: The IETM software is designed to be resource-efficient and is developed using advanced web technologies to ensure high performance.

• Operating system compatibility: IETM runs seamlessly on any system using Windows 7 or newer, as well as the latest versions of Linux.

• No client-side installation needed: Users can access IETM directly through any web browser; no additional software needs to be installed on client machines.

• No proprietary software required: The system operates independently and does not rely on any proprietary platforms or applications.

• The software is licensed exclusively for OEM who purchased: it is intended solely for your internal use and for the projects you undertake. While you are free to distribute your IETM projects, you are not permitted to resell the standalone IETM software or framework itself. To enforce this policy, your company’s logo is hardcoded into the software.

• Unlimited usage: You are allowed to use the software across multiple projects, clients, and databases. There are no restrictions on the number of uses or installations within your organization.

• Redistribution rights: You may develop new IETM projects and distribute as many copies as needed, each branded with your logo.

• Resale restrictions: Reselling refers to purchasing the IETM software from us and then selling the same framework to other OEMs. To prevent this, the software you receive is embedded with your organization’s logo upon purchase.

IETM is web-based software. IETM has 2 variants.

• IETM viewer: To view IETMs

• IETM authoring tool: TO create IETMs

How do you open PDF files ? Using Acrobat viewer. And using acrobat writer we edit PDF.

Similarly, IETM viewer is used to View IETM and IETM authoring tool is needed to Edit the IETM.

Understanding the Authoring Tool

An IETM (Interactive Electronic Technical Manual) is developed using a dedicated IETM framework or authoring tool.

To illustrate this, let’s consider a familiar scenario:

• If you need to share an electrical wiring diagram with a client, you would typically design it using a program like AutoCAD and save it as a .dwg file. However, instead of sharing the editable source file (which could be modified by the recipient or may not be accessible if they don’t have AutoCAD), you convert the drawing to a PDF. This allows the recipient to view the diagram but not edit it.

• In another situation, if you want the recipient to be able to edit the diagram, you must provide the .dwg file, but they would still need AutoCAD (the authoring tool) installed on their computer to make changes.

• In this way, AutoCAD is an example of an “authoring tool” for CAD drawings.
  Similarly, when it comes to IETMs:

• An authoring tool is specialized software used to create and develop IETMs. It provides the necessary environment, features, and functionality to build interactive technical manuals efficiently.

• Just as you need design software to create editable engineering drawings, you need an IETM authoring tool to develop, organize, and publish IETMs.
  

  In summary:
  The authoring tool is essential for building IETMs, allowing you to develop, structure, and manage all content before it is distributed in its final, user-friendly format.

Developing an Interactive Electronic Technical Manual (IETM)

Contrary to popular belief, creating an IETM is not as simple as importing a user manual PDF into software and instantly converting it into a database. Instead, the process requires building everything from the ground up. Here’s a comprehensive guide to developing and delivering IETM projects:

Step 1: Prepare the Table of Contents (TOC)

Collect and Review Documentation: Gather all approved PDF manuals associated with the project. Each client or project usually involves several manuals, which may vary in type and content.

Categorization: Sort the manuals into broad modules. For large systems, the TOC might look like this:

• Electrical

  • Navigation Equipment

    • Radar (Instructions, User Handbook, Technical Manual, Illustrated Parts List, Manufacturer’s Recommended Spares)

    • GPS

    • Gyro

    • EMLOG

  • Communication Equipment

  • Main Switchboard

  • Alarm Systems

  • Battery Chargers

• Hull

  • HVAC

  • Anchors

  • Towing Hook

  • Magnetic Compass

  • Life Rafts

  • Insulation

  • Windlass

• Engineering

  • Fire Fighting

  • Main Engines

  • DA Sets

  • Pumps and Compressors

  • Propulsion

• For smaller systems, the classification may be limited to:

  • User Handbook

  • Technical Manuals Parts 1 and 2

  • Illustrated Parts List

  • Manufacturer’s Recommended Spares

Step 2: Build the TOC in the IETM Authoring Tool

Digitize the Structure: Using your authoring tool, recreate the paper-based TOC as a digital, hierarchical (tree) structure—parent, child, sub-child, etc.—precisely matching the structure of the original manuals.

Verification: Review the digital TOC against source PDFs to ensure accuracy and completeness.

Step 3: Convert PDF Content into the IETM Database

Populate Content: Utilize the IETM Authoring Tool’s default templates to copy content from each PDF into the corresponding sections.

Automatic Conversion: As content is input, the tool converts and stores it in a structured database for fast searching and retrieval.

Step 4: Add Interactivity—Hyperlinks, Hotspots, Glossary, and Related Topics

Enhance Navigation: Use the authoring tool to insert hyperlinks, hot spots, and cross-references, making it easy for users to navigate between related topics and glossary entries.

Clarifying ‘Interactive’: In IETMs, ‘interactive’ does not mean 3D graphics. Rather, it refers to the ability for users to quickly browse, search, and cross-reference thousands of pages, view related topics, and access supplementary media with hover or clicks.

Advanced Features: Users can bookmark, annotate, review search and document history, all of which make the manual truly interactive and user-friendly.

Step 5: Integrate Drawings & Original Manuals

Drawings: Export high-resolution images from original PDFs. Classify and insert them into the IETM under dedicated tabs based on category.

Original Manuals: Store all original manuals/PDFs within the IETM under a separate “Manuals” tab for future reference.

Step 6: Branding

Customization: Place the OEM’s logo in the designated area (typically the upper left corner). Customize the login background in accordance with the OEM’s branding preferences.

Step 7: Internal Quality Check

Verification: Cross-check the IETM against all source PDFs to confirm the presence of every paragraph, topic, and function (hyperlinks, hot spots, search, user permissions, bookmarks, annotations, activity tracking, etc.)

Step 8: OEM Quality Review

Hosting: Upload the IETM to a private cloud for the OEM to review.

Feedback and Finalization: Address any observations or corrections suggested before the final release.

Step 9: Delivery

Deliverables include:

• IETM Viewer Software

• Database and Assets (drawings, images, PDFs, videos)

• An installation manual is provided to enable independent installations.

• All content is delivered via DVD, USB, or ZIP file; OEMs can duplicate and distribute as needed.

• IETM can be installed on standalone PCs/laptops, or on a server for networked (LAN) access via browsers.

• IETM is a browser-based application compatible with both Windows and Linux.

Development Stack:

The IETM framework uses Angular, Node.js, and MariaDB.

Summary:

Developing an IETM involves careful planning, structure, content curation, and technical expertise. It goes beyond simple PDF conversion, adding layers of interactivity, quality control, and end-user convenience, all tailored to the needs of each project and OEM.

• The IETM software and its database will be delivered to the OEM or client

• The client is free to make unlimited copies and distribute them to end users via DVDs.

• There are no licensing fees per installation, and no hardware binding, serial numbers, or similar restrictions are required.

• OEMs may produce and distribute as many DVDs as necessary.

• The software license is perpetual, so there are no annual renewal charges or recurring licensing fees.
  We will provide you with one complete set of files, and you are authorized to create and distribute as many copies or DVDs to your end users as needed.

There is often a misconception that Interactive Electronic Technical Manuals (IETM) are the same as 3D blowup software. While the term "interactive" leads some to expect advanced 3D features, the primary purpose of an IETM is to allow users to efficiently browse, search, and cross-reference technical information.

For example, if you have 3,000 pages spread across 10 different manuals, reviewing each one manually is impractical. With an IETM, all content is converted into a searchable database, enabling users to locate specific topics instantly. Interactive features include cross-referencing related topics, viewing images or videos when hovering over text, saving bookmarks, making annotations, and accessing search or document history. These are the elements that define an "interactive" manual.

It’s important to note that IETMs are not designed to provide 3D models that "blow up" into sub-parts with voice-over explanations. Those advanced visualizations are known as 3D blowups, virtual reality models, or Computer-Based Tutors (CBTs).

However, if the OEM provides videos or 3D animations, these can be integrated into the IETM. The scope of IETM development—typically Level 4—focuses on compiling and digitizing the information supplied by the client. It's crucial to understand that:

• The IETM vendor uses only client-provided materials (videos, images, CAD drawings/PDFs).

• Any existing graphics, diagrams, or 3D files from the client can be incorporated into the IETM.

• The IETM vendor does not create new 3D or 2D animations, models, draw CAD designs, or conduct photography/videography.

• If additional 3D animations or custom blowup models are needed, these are handled as separate projects.

Always check which IETM Level is being requested in your SCOPE or RFP—recent requirements usually specify Level 4. If your specifications are older (2016-17), Level 2 might be indicated.

In summary:

IETMs are powerful, searchable, electronic manuals focused on information accessibility and interactivity—not 3D visualization. Additional 3D content can be included if provided, but its creation falls outside the standard IETM assignment and budgeting.

Hotspots function much like tooltips. When a user hovers the mouse over hotspot-enabled text, a popup box appears, displaying additional content such as text, images, or videos.

• Training – Text Hotspot: Hovering displays relevant text in a popup.

• Operations – Image Hotspot: Hovering shows related images in a popup box.

• Published – Video Hotspot: Hovering reveals a related video in the popup box.