S1000D tutorial

Embed Size (px)

Citation preview

  • 2004 TPSMG

    S1000D TutorialS1000D TutorialS1000D Tutorial

    User Forum Vxj2004-09-22

  • 2004 TPSMG

    Mr Dennis Hoyland BA, MBA

    Chairman Technical Publications Specification Maintenance Group

    Assistant Director Corporate Technical ServicesDefence Logistics Organisation, United Kingdom

  • 2004 TPSMG

    Dennis Hoyland, UK DLO Carl-Johan Wiln, Saab Aerosystems Denny Raitz. The Boeing Company John Lawless, UK DLO Svante Ericsson, Srman Information & media

    Speakers

  • 2004 TPSMG

    Agenda

    Intro Dennis 5 min Overview Carl 15 min Information objects Denny 15 min Information sets - Publications Carl 10 min DM/DMC - SNS IC (Data Module/Data Module Code - Standard Numbering

    System - Information Codes) Dennis 20 min PM/PMC - ICN (Publication Module/Publication Module Code - Illustration

    Control Number) John 20 min Ca 14.30 Coffee break Id and Status section Svante 20 min Front matter - Warning, Caution and Notes

    Carl 10 min The Functionality matrix Denny 10 min Business rules - Project configuration John 15 min The future Carl 10 min

  • 2004 TPSMG

  • 2004 TPSMG

    Introduction to S1000DIntroduction to S1000DIntroduction to S1000D

    The history and a Compressed introduction to the Spec

    S1000D - Tutorial User Forum Vxj

    2004-09-22

  • 2004 TPSMG

    Co-Chair Technical Publications Specification Maintenance Group

    Technical Fellow InformaticsSaab Aerosystems

    Sweden

    Mr Carl Wiln M Sc

  • 2004 TPSMG

    Who are ASD (AECMA) and AIA?Who are ASD (AECMA) and AIA?

  • 2004 TPSMG

    Who is ASD (AECMA)? ASD is an organization

    The AeroSpace and Defence Industries Association of Europe, ASD, represents the European industries in common issues, with the goal of increasing the competitiveness in the sector

    All EU countries are represented Belgium, Denmark, UK, Finland, France, Greece, The

    Netherlands, Ireland, Italy, Luxembourg, Portugal, Spain, Sweden, Germany, Austria, Czech Republic, .

    Produces standards and specifications (among other things), eg Simplified English. Dictionaries and writing rules. AECMA Specification 2000M for materiel administration S1000D for Technical Publications

  • 2004 TPSMG

    Who is AIA? AIA is an organization

    The Aerospace Industries Association, AIA, represents the US aerospace industries in common issues, with the goal of increasing the competitiveness in the sector.

    AIA corresponds to ASD BIGGER with more employees and operations Eg Boeing, Lockheed Martin, General Dynamics

    Participants in development of standards and specifications (among other things), eg iSpec2200 (owned by ATA) Simplified English. Dictionaries and writing rules. S1000D for Technical Publications

  • 2004 TPSMG

    HistoryHistory

  • 2004 TPSMG

    History1984 AECMA countries and MoD customers started the

    development of an international Specification for Technical Publications to harmonise all national and international specs into a "Western" specification based on ATA Spec 100.

    1989 First release signed by Air commodore RAF,

    Generalleutnant GAF, Brigade general SwAF, etc

    2003 Issue 2.0 released

  • 2004 TPSMG

  • 2004 TPSMG

    Some basic definitions Some basic definitions

  • 2004 TPSMG

    Basic concepts Data module

    A stand alone information unit comprising descriptive, procedural, operational data for a Materiel or a component thereof

    The unit is produced in such a form that it could be stored and retrieved from a Common Source DataBase by the data module code as the identifier

    Produced in SGML/XML according to specific DTDs

    CSDB (Common Source DataBase) A virtual store for the data modules and publications

    DMC (Data Module Code) A 17- thru 37-character code to identify a data module and to facilitate storing

    and retrieving them from a CSDB

    ICN (Illustration Control Number) A 27- thru 45-character code to identify an illustration and to facilitate storing

    and retrieving them from a CSDB

    Applicability/Effectivity Defines to which version/mark/serial number of the Materiel the data module is

    written/The published subset of applicability

  • 2004 TPSMG

    Structure of S1000DStructure of S1000D

  • 2004 TPSMG

    Issue 2

    Three becomes one

    Change 9

    S1000D now (from Issue 2.0) includes Land, Sea and Air S1000D now (from Issue 2.0) includes Land, Sea and Air as well as civil and military products and systemsas well as civil and military products and systems

    AirAir LandLand SeaSea

  • 2004 TPSMG

    Chapter 1

    Chapter 2

    Chapter 3

    Restructuring From five to nine chapters

    Issue 2

    Chapter 4

    Chapter 5

    Chapter 6

    Chapter 7

    Chapter 8

    Chapter 9

  • 2004 TPSMG

    Chapter 4

    Information management

    Issue 2

    Chapter 1

    Introduction

    Chapter 2

    Documentation process

    Chapter 3

    Information generation

    Chapter 5

    Information and publication sets

    Chapter 6

    Information presentation/use

  • 2004 TPSMG

    Chapter 7

    Information processing

    Issue 2

    Chapter 8

    Standard Numbering

    System (SNS) and information

    codes

    Chapter 9

    Terms - Data dictionary

  • 2004 TPSMG

    Chapter 1

    Introduction

    1.1 Purpose

    1.2 Scope

    1.3 How to use this specification

    1.4 How to tailor for a specific project

    1.5 Request for change

    Issue 2

    CPFChange Proposal Form

  • 2004 TPSMG

    Chapter 2

    Documentation process

    2.1 Overview

    2.2 Use of standards

    2.3 Relations to other processes and standards

    Process diagram referencing S1000D chapters

    Issue 2

  • 2004 TPSMG

    Chapter 3

    Information generation

    3.1 Introduction

    3.2 Data modules

    3.3 Information sets

    3.4 Zoning and access

    3.5 Updating of data modules

    3.6 Security and data restrictions

    3.7 Quality assurance

    3.8 Disassembly principles

    3.9 Authoring(incl Process modules)

    Issue 2

  • 2004 TPSMG

    Illustration rules- Jointly with AIA/ATA- ATA iSpec2200 rules are accepted- Color- More illustration sizes

    Chapter 3

    Information generation

    Author and illustrator support:In depth information

    Project decisions listed

    Guidance, examples and mark-up examples are added

  • 2004 TPSMG

    Improved configuration control and security coding

    Process data module- a procedural flow script The first step towards full interactivity

    in standardized form Provides for additional functionality

    without impacting existing legacy data

    Chapter 3

    Information generation

  • 2004 TPSMG

    Process data module Chapter 3Information generationProcess

    Data module

    DM-Alts

    If-DM

    DMNode

    DMNode

    DMNode

    DMNod

    DMNode

    Datamodule

    Datamodule

    Datamodule

    Datamodule

    Datamodule

  • 2004 TPSMG

    Wiring DTD- New data module type and wiring DTD- Takes wiring data from engineering

    into DMs and further to IETP

    Chapter 3

    Information generationDescriptive DTD

    Procedural DTDFault isolation DTD

  • 2004 TPSMG

    Chapter 4

    Information management

    4.1 Introduction

    4.2 CSDB

    4.3 Data module code - DMC

    4.4 Illustration control number ICN

    4.5 Data module lists

    4.6 Commenting

    4.7 Version control of data modules

    4.8 Interchange of data modules

    4.9 Publication management

    Issue 2

  • 2004 TPSMG

    Ml

    BATTLETANK1234BATTLETANK1234

    -C-040A

    SNS IC/ICV ILC

    -AYYY

    SDC DC/DCV

    38-21-0301-Y -04BYY

    The data module code DMCUsed for identifying . Together with issuenumber

    Chapter 4

    Information management

  • 2004 TPSMG

    Commenting- an SGML form for commenting

    and reporting- on data modules or publication modules - during the verification process and the

    in-service

    Chapter 4

    Information management

  • 2004 TPSMG

    Chapter 5

    Information sets and Publications

    5.1 General

    5.2 Information sets

    5.2.1 Common information sets

    5.2.2 Air specific information sets

    5.2.3 Land/Sea specific information sets

    5.3 Publications

    5.3.1 Common requirements

    5.3.2 Air specific publications

    5.3.3 Land/Sea specific publications

    Issue 2

  • 2004 TPSMG

    Information setAn information set is the definition of scope and depth of the information required, and is listed in the DMRL. (Authors view).

    PublicationA group of DMs sensibly for the end user defined by a publication module. (Users view).

    Chapter 5

    Information and

    publication sets

  • 2004 TPSMG

    Publications the deliverablesPublication module (PM)and Publication Module Code (PMC)has been added to control configuration of IETP content

    Chapter 4

    Information management

  • 2004 TPSMG

    The Publication Module Code PMCUsed for identifying . Together with issno

    Chapter 4

    Information management

    - NN

    Issuingauthority

    Volume

    YYYYYYYYYYYYYY

    MI No.

    - YYYYY - XXXXX

  • 2004 TPSMG

    Chapter 6

    Information presentation/use

    6.1 Introduction

    6.2 Page-oriented publications

    6.3 Interactive Electronic Technical Publications IETP

    6.4 Functionality

    Issue 2

  • 2004 TPSMG

    Chapter 6

    Information

    presentation/use

    IETPA non-linear presentation of the data module in an user-interactive manner

    Page-oriented publicationA linear presentation of the data modules either on paper or screen

  • 2004 TPSMG

    IntroducedXML-oriented IETP (IETP-X) included

    Removal of - IETP-L (linearly structured SGML publications)- IETP-D (database-oriented SGML/HyTime

    publications)

    - IETP-H (linearly structured HTML publications)- IETP-I (integrated processes)

    Chapter 6.3

    Interactive Electronic Technical

    Publications IETP

    Interactive Electronic Technical Publications IETP

  • 2004 TPSMG

    Chap 6.3.1 IETP Look and feel Chap 6.3.2 IETP Output specificationChap 6.3.3 IETP User interface

    functionality

    Chapter 6.3

    Interactive Electronic Technical

    Publications IETP

    Interactive Electronic Technical Publications IETP

    Not yet

    in the

    Not yet

    in the

    Spec

    Spec

  • 2004 TPSMG

    Purpose- To establish minimum common requirements

    for the look and feel (style) of IETP- To provide basic rules an guidance for styling

    of elements for display- To provide basic rules an guidance for printing

    output of IETP- To provide general rules for implementation of

    standard functionality for the user interface of IETP

    Based on- Based on Mil Hbk 511 and other national

    requirements

    Chapter 6.3.x

    IETP

  • 2004 TPSMG

    Chapter 6.4

    Information

    Presentation/Use

    - Functionality

    Functionality matrix for deliverables

    Chap 6.4.1 Functionality - Background and explanation

    Chap 6.4.2 Functionality - Functionality matrix Chap 6.4.3 Functionality - Acquisition

    management

    Chap 6.

    4.3

    Chap 6.

    4.3

    Not yet

    in the

    Not yet

    in the

    Spec

    Spec

  • 2004 TPSMG

    Chapter 7

    Information processing

    7.1 Introduction

    7.2 Basic concepts

    7.3 CSDB objects

    7.4 Generation of publications

    7.5 Information interchange

    7.6 Software requirements

    7.7 Guidance and examples

    Issue 2

  • 2004 TPSMG

    Attribute values- flexibility- using configuration files

    XML Schema- Now introduced for data

    modules (in parallel with SGML DM DTD)

    Chapter 7

    Information processing

  • 2004 TPSMG

    Chapter 8

    Standard Numbering System (SNS) and information codes

    8.1 Introduction

    8.2 Maintained SNS

    8.3 Example SNS

    8.4 Information codes

    8.5 Summary

    Maintained SNS: 8, eg General surface vehicles General communications Air vehicle, engines and

    equipment

    Example SNS: 18, eg Combat vehicle project Mil Std 1808 based project

    Issue 2

  • 2004 TPSMG

    Chapter 9

    Terms - Data dictionary

    9.1 Introduction

    9.2 Glossary of terms

    9.3 Data dictionary

    Data dictionaryLinks to databases (downloadable) for definitions of all elements and attribute for

    SGML DTD XML Schemata

    Issue 2

  • 2004 TPSMG

    S1000D Issue 2.1

    International Specification for Technical Publications

    utilisinga Common Source DataBase

    ASD AIAAeroSpace and Defence Industries Association of European

    Aerospace Industries of America

    Issue 2.12004-02-29

  • 2004 TPSMG

    Questions!?Questions!?

    Thanks for your attention!

  • 2004 TPSMG

  • 2004 TPSMG

    Information objects in the CSDBInformation objects in the CSDB

    Denny RaitzThe Boeing Company

    S1000D - TutorialVaxjo

    2004-09-22

  • 2004 TPSMG

    Mr Denny Raitz

    Co-Chair Technical Specification Maintenance GroupAssociate Technical FellowThe Boeing Company, USA

  • 2004 TPSMG

    The Common Source DataBase - CSDB

    A CSDB is a virtual store for the digital information objects includes configuration management of these

    objects

    A CSDB can be implemented in any way

    It doesnt have to be a DBMS It can be any proprietary file system Usually it is some sort of document administration tool

  • 2004 TPSMG

    Publi-cation

    Publi-cation

    DataModuleData

    ModuleData

    ModuleData

    Module

    Common Source DataBase - CSDB

    DataModuleData

    ModuleData

    ModuleData

    Module

    DataModuleData

    ModuleData

    ModuleData

    Module

    Publi-cation

    Publi-cation

    Publi-cation

    CommonCommonSourceSource

    DataBaseDataBase

    (CSDB)(CSDB)

  • 2004 TPSMG

    Information objects

    There are three major types of information object in the CSDB

    Data modules Graphical objects

    Publication modules

  • 2004 TPSMG

    Information types

    Data modules - dm Crew/Operator Descriptive Fault isolation Maintenance planning Parts info Procedural info Process data module Wiring data and data description module

    SGML SGML DTDsDTDsavailable for each available for each

    of theseof these

  • 2004 TPSMG

    Information types

    Data modules - dm Crew/Operator Descriptive Fault isolation Maintenance planning Parts info Procedural info Process data module Wiring data and data description module

    Publication module - pm Comment module com Data dispatch note - ddn Data modules lists - dml

    XML XML DTDsDTDsavailable for each available for each

    of theseof these

  • 2004 TPSMG

    Information types

    Data modules - dm Crew/Operator Descriptive Fault isolation Maintenance planning Parts info Procedural info Process data module Wiring data and data description module

    Publication module - pm Comment module com Data dispatch note - ddn Data modules lists - dml

    XML schemas XML schemas available for each available for each

    of theseof these

  • 2004 TPSMG

    To represent electrical installations/systems

    Corresponds to electrical diagrams Wires Connectors Harnesses/bundles Etc

    No graphics!

    Wiring data module

  • 2004 TPSMG

    Wiring data description module

    To represent diagram data dictionary Define which parts/types of objects that are

    concerned/included Define preferred vocabulary

  • 2004 TPSMG

    IETP withInteractive

    WP

    WiringDiagrams

    Wire Data

    En

    gin

    eeri

    ng

    En

    gin

    eeri

    ng

    Ele

    ctri

    c D

    ata

    Ele

    ctri

    c D

    ata Preparation

    of data modules

    for wiring

    information

    HarnessDrawings

    Equipment Data

    Dat

    a T

    ran

    sfer

    Harness Data

    Electrical StandardParts Data

    CSDB

    Standard Descriptive DTD

    Introductory Information DMDescriptive Information DM

    Standard Practices DM Wiring Diagram DM

    Harness Drawing DM Equipm. & Panels Loc. DM

    Preparation oflists and generated info

    WD DTDElectr. Standard Parts Data DMElectr. Equipment Inform. DM

    Wire Data DMHarness Data DM

    Data Description DM WDD DTD

    Wiring information

  • 2004 TPSMG

    Process data module

    To represent interactive information

    Meet the US needs Retain backwards compatibility

  • 2004 TPSMG

    ProcessDM A new type of DM!

    Process data module in context

    ProcedDM

    CrewDM

    DescriptDM

    Etc

    Process Data module

    ProcessDM

    DM-Alts

    If-DM

    DMNode(refdm)

    DMNode(refdm)

    DMNode(refdm)

    DMNode(refdm)

    DMNode(refdm)

  • 2004 TPSMG

    Process data module

    Sequencing of data modules Procedural flow script Provides

    Branching Looping Filtering Dialogs

  • 2004 TPSMG

    ProcessDM A new type of DM!

    Process data module in context

    ProcedDM

    CrewDM

    DescriptDM

    Etc

    Process data module

    ProcessDM

    DM-Alts

    If-DM

    DMNode(refdm)

    DMNode(refdm)

    DMNode(refdm)

    DMNode(refdm)

    DMNode(refdm)

    Logicengine

    (Software)State Table

    Var1 ValueVar2 ValueEtc

  • 2004 TPSMG

    Process data module

    Based on S1000D concept of data modules and CSDB MIL-PRF-87269 concepts for interactivity

    Will be followed up with additional interactivity

  • 2004 TPSMG

    (b) dm-node (refDM: Prep for engine adjustment)

    (a) Begin Process Data Module Adjust engine temperature

    (c) dm-if

    Condition: if Engine installed on system is True

    (d) dm-node (refDM: Start and run engine on system)

    (e) dm-node (refDM: Start and run engine in shop)

    (f) dm-loop

    (g) dm-node (refDM: Adjust engine temp)

    (h) dm-node (Dialog for variable Engine temp)

    Condition: while Engine temp > 500 degrees

    LogicEngine

    truefalse

    loop return

    End process

    true

    false

  • 2004 TPSMG

    Final set of deliverable objects

    One or mode publication module and/or legacy publication reference and/or one or more data module

    Publication module

    Publication module

    One or more legacy

    publication reference

    One or more data module

    reference

  • 2004 TPSMG

    Enables work share in publication building

    May be nested Provides IETP navigation structure

    Replaces LOAP instances at top levels

    Publication module

  • 2004 TPSMG

    Comments module

    Used to submit comments between parties in a project

    To represent review comments, update requests, etc

    As simple as possible Avoid chaining up of comments Max 2 responses (interim / final) possible

    Attachments in various formats allowed (to be agreed project specific)

    Question, preliminary and final answer A marked-up file (SGML/XML)

  • 2004 TPSMG

    Data dispatch note

    Contains a list of the data objects included in the transfer

    Mandatory part of an S1000D information interchange

    A marked-up file (SGML/XML)

  • 2004 TPSMG

    Data module lists

    Used to identify required data modulesin a project (DMRL)

    Used to identify status about data modules in a project (CSL)

    A marked-up file (SGML/XML)

  • 2004 TPSMG

    Graphical objects

    Can be in one of the formats CGM, CALS raster, TIFF, PNG, JPEG, GIF, PDF

    Can contain hotspots (CGM)

    S1000D is developing in pace with ATA iSpec2200

  • 2004 TPSMG

    Questions!?Questions!?

    Thanks for your attention!

  • 2004 TPSMG

  • 2004 TPSMG

    Information sets - PublicationsInformation sets Information sets -- PublicationsPublications

    Carl WilnSaab Aerosystems

    S1000D - TutorialVxj

    2004-09-22

  • 2004 TPSMG

    Information sets - Publications

    Information set

    An information set is the required information in a defined

    scope and depth (authors view)

    Publication

    A publication is the compilation and publishing of information for a customer (users view)

    A publication can be a subset of or equal to an information set,

    but it may also be a superset of

    several information sets or parts of them.

  • 2004 TPSMG

    Chap 4 Chap 5

    Chap 4 Information management Chap 4.1 Information management Introduction Chap 4.2 Information management - Common Source DataBase

    (CSDB) Chap 4.9 Information management - Publication management

    Chap 5 Information sets and publications Chap 5.1 Information sets and publications General Chap 5.2 Information sets and publications Information Chap 5.3 Information sets and publications Publications

  • 2004 TPSMG

    Information sets - Data modules

    DataModuleData

    ModuleData

    Module

    InformationsetInformation

    set

    InformationsetInformation

    set

    DataModule

    DataModuleData

    ModuleData

    Module

    DataModuleData

    Module

    DataModuleData

    Module

    Contracted content

    DataModule

  • 2004 TPSMG

    DataModuleData

    ModuleData

    ModuleData

    Module

    DMs - Information sets - Publications

    DataModuleData

    ModuleData

    ModuleData

    Module

    InformationsetInformation

    set

    InformationsetInformation

    set

    DataModuleData

    ModuleData

    ModuleData

    Module

    Publi-cation

    Publi-cation

    Publi-cation

  • 2004 TPSMG

    Publi-cation

    Publi-cation

    Publi-cation

    DataModuleData

    ModuleData

    ModuleData

    Module

    DMs - Information sets - Publications

    DataModuleData

    ModuleData

    ModuleData

    Module

    DataModuleData

    ModuleData

    ModuleData

    Module CommonCommonSourceSource

    DataBaseDataBase

    (CSDB)(CSDB)

  • 2004 TPSMG

    Information sets/PublicationsTraditional publicationsSuite of booksIndividual topicsIndividual coversChaptersSectionsSubjectPagesParagraphsSentencesWordsGraphics

    S1000D PublicationsCSDBInformation sets

    Data module(s)

    Data

    No direct equivalent

  • 2004 TPSMG

    Information setsInformation setsInformation sets

  • 2004 TPSMG

    Chap 5 - Information sets and publications

    Chap 5 Information sets and publications Chap 5.1 Information sets and publications General Chap 5.2 Information sets and publications -

    Information sets Chap 5.2.1 Information sets - Common information sets Chap 5.2.2 Information sets - Air specific information sets Chap 5.2.3 Information sets - Land/Sea specific information sets

    Chap 5.3 Information sets and publications Publications

  • 2004 TPSMG

    Chap 5.2.1 Information sets - Common information sets

    Crew/Operator information

    Description and operation

    Maintenance Information

    Wiring diagram data Illustrated parts data Maintenance planning Mass and balance Recovery

    Equipment Weapon loading Cargo loading Stores loading Role change Battle damage repair Illustrated tool and

    support equipment Service bulletins Material data Common information

    and data

  • 2004 TPSMG

    Chap 5.2.2 Information sets - Air specific information sets

    Structure repair information Cross servicing information Engine maintenance information Power plant build-up information Engine standard practices Aircrew information

  • 2004 TPSMG

    Chap 5.2.3 Information sets - Land/Sea specific information sets

    Crew/operator descriptive information Crew/ operator operation Crew/ operator sequential operation Crew/ operator fault detection, isolation

    and resolution International, national and regulatory

    scheduled check

  • 2004 TPSMG

    What does an info set look like?

    1 General2 Standards and definitions

    3 Content

    Example: Chap 5.2.3.2 Crew/operator operation information

    2.1 Standards2.2 Writing style2.3 References2.4 Definitions

    3.1 Introduction3.2 Land/sea Materiel operation General3.3 Land/sea Materiel operation

    3.3.1 Operation (physical breakdown orientated) 3.3.2 Operation (functional breakdown

    orientated)3.3.3 Land/sea Materiel operating data3.4 Operating under special conditions3.4.1 Heat conditions3.4.2 Cold conditions

    3.5 Emergency procedures3.6 Transportation3.7 Equipment stowing

  • 2004 TPSMG

    What information is given in an info set?

    The operation data modules shall include all descriptions necessary to perform the operation of the Materiel to put into operation, to operate during use or to turn off the defined Materiel. The operation description shall be created as a step by step structure.

    It shall also include all preliminary requirements as a description or as a reference to the related data modules.

    Safety conditions and instructions must be included inside the data modules or inserted as a reference to the related data modules.

    Data modules shall be coded YY-Y-YY-YY-YY-YXA-XXXA-AorYYYYYYYYYYYYYY-YYYY-YYY-YY-YY-YYXAAA-XXXA-A- XXX shall be 111, 112, 121, 131, 141 or 151.

    Para 3.3.2 Operation (physical breakdown orientated)

  • 2004 TPSMG

    PublicationsPublicationsPublications

  • 2004 TPSMG

    Defines publications content and structure

    Sequences data modules by referencing Can reference other publication modules

    Enables work share in publication building

    Publication module

  • 2004 TPSMG

    Final set of deliverable objects Publication package

    One or mode publication module and/or legacy publication reference and/or one or more data module

    Publication module

    Publication module

    One or more legacy

    publication reference

    One or more data module

    reference

  • 2004 TPSMG

    Provides IETP navigation structure

    Replaces LOAP instances at top level Identified by a Publication Module Code

    (PMC)

    Publication module

  • 2004 TPSMG

    Markup element:

    YY-YYYYY-XXXXX-NN 12 char (min) YYYYYYYYYYYYYY-YYYYY-XXXXX-NN

    24 char (max) Model identifier: 2 to 14 alphanumeric Issuing authority (NCAGE): 5 alphanumeric Publication number: 5 numeric Volume number (default 00): 2 numeric

    Publication module

  • 2004 TPSMG

    PMC examples:

    1B-D9460-00001-00 (LOAP Eurofighter)

    BICYCLEXXXAAA-U8025-00003-00 (Bike test set)

    Publication module

  • 2004 TPSMG

    Publication module

  • 2004 TPSMG

    Publication module

  • 2004 TPSMG

    Chap 5 - Information sets and publications

    Chap 5.2 Information sets and publications -Information sets

    Chap 5.3 Information sets and publications Publications

    Chap 5.3.1 Publications - Common requirements Chap 5.3.2 Publications - Air specific publications Chap 5.3.3 Publications - Land/Sea specific

    publications

  • 2004 TPSMG

    Chap 5.3 Publications

    Chap 5.3.1 Publications - Common requirementsChap 5.3.1.1 Common requirements - List of applicable

    publicationsChap 5.3.1.2 Common requirements - Front matterChap 5.3.1.3 Common requirements - Technical contentChap 5.3.1.4 Common requirements - Illustrated parts data

    Chap 5.3.2 Publications - Air specific publicationsChap 5.3.2.1 Air specific publications - Aircrew publicationChap 5.3.2.2 Air specific publications - Cross servicing guide

    Chap 5.3.3 Publications - Land/Sea specific publications

  • 2004 TPSMG

    Chapter 4 - Information management

    Chap 4 Information management Chap 4.1 Information management Introduction Chap 4.2 Information management - Common Source DataBase

    (CSDB) Chap 4.3 Information management - Data module code Chap 4.4 Information management - Illustration control number Chap 4.5 Information management - Data module lists Chap 4.6 Information management - Comment Chap 4.7 Information management - Version control of data modules Chap 4.8 Information management - Interchange of data modules Chap 4.9 Information management - Publication management

    Chap 4.9.1 Publication management - Publication module Chap 4.9.2 Publication management - Coding of Chap 4.9.3 Publication management - Building of publications Chap 4.9.4 Publication management - Updating of publications

  • 2004 TPSMG

    Chap 5 - Information sets and publications

    Chap 5 Information sets and publications Chap 5.1 Information sets and publications General Chap 5.2 Information sets and publications - Information sets Chap 5.2.1 Information sets - Common information sets Chap 5.2.1.1 Common information sets - Crew/Operator information Chap 5.2.1.2 Common information sets - Description and operation

    Chap 5.2.1.3 Common information sets - Maintenance information Chap 5.2.1.3.1 Maintenance information - Maintenance procedures Chap 5.2.1.3.2 Maintenance information - Fault isolation Chap 5.2.1.3.3 Maintenance information - Non-destructive testing

    Chap 5.2.2 Information sets - Air specific information sets Chap 5.2.3 Information sets - Land/Sea specific information sets Chap 5.3 Information sets and publications Publications Chap 5.3.1 Publications - Common requirements Chap 5.3.2 Publications - Air specific publications Chap 5.3.3 Publications - Land/Sea specific publications

  • 2004 TPSMG

    Questions!?Questions!?

    Thanks for your attention!

  • 2004 TPSMG

  • 2004 TPSMG

    The Data Module Codeand

    Standard Numbering systemand

    Information Codes

    The Data Module CodeThe Data Module Codeandand

    Standard Numbering systemStandard Numbering systemandand

    Information CodesInformation Codes

    Dennis Hoyland BA, MBAMod UK

    S1000D TutorialVaxjo

    2004-09-22

  • 2004 TPSMG

    The Data Module conceptThe Data Module conceptThe Data Module concept

  • 2004 TPSMGOne of

    All of

    IDSTATUS

    CONTENT

    Meta data about the

    data module

    What the user sees

    Issue details

    DM Address

    Security

    Applicability

    QA Status

    Descriptive

    Procedural

    Fault

    Crew

    IPD

    Schedules

    Datamodule

    ProcessWiring

    The data module

    Every data module has this

  • 2004 TPSMG

    Data module code

    Model IdentSystem

    differenceSNS DC DCV IC ICV ILC

    Issue details

    Data module address

    The data module

    Datamodule

    IDSTATUS

  • 2004 TPSMG

    The Data Module Code - DMCThe Data Module Code The Data Module Code -- DMCDMC

  • 2004 TPSMG

    The data module code - DMC

    The data module code is a part of the unique identifier of a data module

    It comprises 17 to 37 characters The 17 character variant is used for most air vehicle

    projects.

    Ml

    BICYCLEXXXAAAABICYCLEXXXAAAA

    -Y-258Y

    SNS IC/ICV ILC

    -AAAA

    SDC DC/DCV

    00-00-0000-D -04YYY

  • 2004 TPSMG

    SystemDiff

    Code

    ModelIdentifi-cation

    Model Identification code - MI- Identifies the project

    Variable length between 2 and 14 (inclusive) alpha-numeric characters

    First 10 can give the project name and can be drawn from the End Item Acronym Code of a 1388 2b or 49506 based LSARLast 4 can give the equivalent of the End Item Usable On Code (3 characters from 1388 2b based LSAR and 4 characters from 49506 based LSAR)

    System Difference Code - SDC- Identifies differences in the function of a system

    Variable length between 1 and 4 (inclusive) alpha-numeric characters

    Eg Can be used as a single character entry in the same way as pre-Issue 2 or 3 characters to capture SLUOC from 1388 2b based LSAR or 4 characters to capture UOC from 49506

    MI and SDC

  • 2004 TPSMG

    Model Identification code - MI

    ModelIdentifi-cation

    -Y-YYYY-AAAA 00-00-0000-D YYYYY BICYCLEXXXAAAA

    LIGHTINGXXAAAA

    -Y-YYYY-AAAA 00-00-0000-D YYYYY LIGHTINGXXAAAA

  • 2004 TPSMG

    SDC

    SystemDiff

    Code

    ModelIdentifi-cation

    -Y-YYYY-AAAA 00-00-0000-D YYYYY BICYCLEXXXAAAA

    SDC = AAAABasic Bike Basic Bike plus light system

    -Y-YYYY-BBBB 00-00-0000-D YYYYY BICYCLEXXXAAAA

    SDC = BBBB

  • 2004 TPSMG

    Unit of assembly

    Subsub-system

    Sub-system

    SystemSystem

    DiffCode

    ModelIdentifi-cation

    Standard Numbering System - SNS

    Standard Numbering Systems SNS - Identifies the breakdown of the Materiel

  • 2004 TPSMG

    Standard Numbering System - SNS

    Unit of assembly

    Subsub-system

    Sub-system

    SystemSystem

    DiffCode

    ModelIdentifi-cation

    -Y-YYYY-AAAA 00-00-0000-D YYYYYBICYCLEXXXAAAA

    Materiel Item Category Code (MICC)OptionalIndicates different SNSs in a single MIeg

    A = SeaB = ElectronicsC = AirD = Land VehiclesE = Ordnance

  • 2004 TPSMG

    Standard Numbering System - SNS

    Unit of assembly

    Subsub-system

    Sub-system

    SystemSystem

    DiffCode

    ModelIdentifi-cation

    -Y-YYYY-AAAA 00-00-0000-D YYYYYBICYCLEXXXAAAA

    The whole bike

  • 2004 TPSMG

    Standard Numbering System - SNS

    Unit of assembly

    Subsub-system

    Sub-system

    SystemSystem

    DiffCode

    ModelIdentifi-cation

    -Y-YYYY-AAAA 00-10-0000-D YYYYYBICYCLEXXXAAAA

    Rear Wheel

    Subsystem

  • 2004 TPSMG

    Standard Numbering System - SNS

    Unit of assembly

    Subsub-system

    Sub-system

    SystemSystem

    DiffCode

    ModelIdentifi-cation

    -Y-YYYY-AAAA 00-11-0000-D YYYYYBICYCLEXXXAAAA

    Rear Gearing

    Subsystem

  • 2004 TPSMG

    Standard Numbering System - SNS

    Unit of assembly

    Subsub-system

    Sub-system

    SystemSystem

    DiffCode

    ModelIdentifi-cation

    -Y-YYYY-AAAA 00-11-0001-D YYYYYBICYCLEXXXAAAA

    Rear Axle

  • 2004 TPSMG

    Maintained and example SNSs

    Maintained SNS 8 maintained SNSs cover the requirements for air, land

    and sea and are subject to Change Proposal Form (CPF) action

    A generic SNS is provided for common system information

    Example SNS 18 example SNSs are provided Projects can decide to reuse these SNS as they are or

    modify them to suit their needs. These SNSs are provided as examples only and will not

    be maintained by the TPSMG

  • 2004 TPSMG

    Maintained SNSs

    Chap 8.2 gives the descriptions and definitions of the SNS that will be maintained by the TPSMG

    Chap 8.2.1 gives a generic numeric SNS that can be used for common and system level information

    Chap 8.2.2 SNS for support and training equipment Chap 8.2.3 SNS for ordnance Chap 8.2.4 SNS for general communications Chap 8.2.5 SNS for air vehicle, engines and equipment Chap 8.2.6 SNS for tactical missiles Chap 8.2.7 SNS for general surface vehicles Chap 8.2.8 SNS for general sea vehicles

  • 2004 TPSMG

    Example SNSs

    Chap 8.3 gives a number of example SNS

    Projects can decide to use these SNS without modification or use part and modify those areas that do not suit their needs

    If these example SNS or the maintained SNS do not suit a projects needs, then projects can decide to design their own complete SNS

  • 2004 TPSMG

    Example SNSsSNS for eg a combat vehicle project a Mil-Std 1808 based project a GAPL based project a climate control project an automated handling project an artillery radar project a software project a training project an electrical project an electronic project a surveillance project a navigation project a deployable airbase project a medical project a technical publications project

  • 2004 TPSMG

    Example of an SNS

  • 2004 TPSMG

    Example of an SNS, cont

  • 2004 TPSMG

    Example of an SNS, cont

  • 2004 TPSMG

    Unit of assembly

    Subsub-system

    Sub-system

    SystemSystem

    DiffCode

    ModelIdentifi-cation

    SNS - Summary

    First part of the Standard Numbering System (SNS)

    Can carry the Material Item Category Code, as defined in Def Stan 00-60

    Variable length at either 2 or 3 alpha-numeric characters

    Third part of the SNS

    Fixed length at 1 alpha-numeric character

    Fourth part of the SNS

    Variable length at either 2 or 4 alpha-numeric characters

    4 characters can be used to cater for large number of LRUs on bigger projects

    Second part of the SNS

    Fixed length at 1 alpha-numeric character

    Standard Numbering Systems SNS - Identifies the breakdown of the Materiel

  • 2004 TPSMG

    Disassembly Code and Variant DC/DCV

    Unit of assembly

    Subsub-system

    Sub-system

    SystemSystem

    DiffCode

    ModelIdentifi-cation

    DisassCode

    Variant

    DisassCode

    -Y-YYYY-AAAA 00-11-0001-D YYYYY BICYCLEXXXAAAA

    -Y-YYYY-AAAA 00-11-0001-D 00000 BICYCLEXXXAAAA

    No maintenance on the nut

    -Y-YYYY-AAAA 00-11-0001-D 01001 BICYCLEXXXAAAA

    Maintenance on the nut (alternative nut)

    -Y-YYYY-AAAA 00-11-0001-D 01000 BICYCLEXXXAAAA

    Maintenance on the nut

  • 2004 TPSMG

    DisassCode

    Variant

    DisassCode

    Unit of assembly

    Subsub-system

    Sub-system

    SystemSystem

    DiffCode

    Modelidenti-fication

    DC/DCV - Summary

    Disassembly Code DC- Identifies the disassembly of the Materiel

    Fixed length at 2 alpha-numeric characters

    Disassembly Code Variant DCV- Identifies the disassembly variants of the Materiel

    Variable length at 1, 2 or 3 alpha-numeric charactersEg:- 1 characters for use as in DMC-17 char- 2 characters to capture the ALC from 1388 2b based

    LSAR - 3 characters to capture the Alternate Indenture Product

    Code from 49506

  • 2004 TPSMG

    Information Code and Variant IC/ICV

    Unit of assembly

    Subsub-system

    Sub-system

    SystemSystem

    DiffCode

    ModelIdentifi-cation

    DisassCode

    Variant

    DisassCode

    InfoCode

    Variant

    InfoCode

    -Y-YYYY-AAAA 00-00-0000-D YYYYYBICYCLEXXXAAAA

    -Y-520A-AAAA 00-10-0000-D 00000 BICYCLEXXXAAAA

    Remove the rear wheel

    -Y-520B-AAAA 00-10-0000-D 00000 BICYCLEXXXAAAA

    Slightly different removal procedure

  • 2004 TPSMG

    Information codes - IC

    There is one common set of information codes for air, land and sea

    The S1000D gives full definitions of all ICs as well as an overview in the form of short definitions

  • 2004 TPSMG

    IC Short definitions

  • 2004 TPSMG

    IC Full definitions

  • 2004 TPSMG

    Information codes - IC

    Codes defined as "NOT GIVEN " are controlled by S1000D

    Codes defined as "Not given" are available for use by projects who must agree their own short and full definitions

  • 2004 TPSMG

    Information codes - IC

    The IC is basically defined as numeric The allocation of alpha characters has to be

    done according to the following rules:

    XXX as defined in Chap 8.4.1 and Chap 8.4.2 XXA Not given XYY NOT GIVEN (Changed by CPF) YYY NOT GIVEN (Changed by CPF)

  • 2004 TPSMG

    InfoCode

    Variant

    InfoCode

    DisassCode

    Variant

    DisassCode

    Unit of assembly

    Subsub-system

    Sub-systemSystem

    SystemDiff

    Code

    Modelidenti-fication

    IC/ICV - Summary

    Information Code Variant - ICV- Identifies the information type

    Fixed length at 1 alpha-numeric character

    Information Code - IC- Identifies the information type variants

    Fixed length at 3 alpha-numeric characters with special rules as below:

    XXX as currently definedXXA Not given (project defined)XYY NOTGIVEN (Projects to apply to TPSMG via CPF for allocations)YYY NOTGIVEN (Projects to apply to TPSMG via CPF for allocations)

  • 2004 TPSMG

    Item Location Code - ILC

    Unit of assembly

    Subsub-system

    Sub-system

    SystemSystem

    DiffCode

    ModelIdentifi-cation

    DisassCode

    Variant

    DisassCode

    InfoCode

    Variant

    InfoCode

    ItemLocation

    Code

    -Y-YYYY-AAAA 00-00-0000-D YYYYY BICYCLEXXXAAA

    Repair on the Bike: Item Location Code = A

    Repair in the Workshop: Item Location Code = B

    Repair at depot: Item Location Code = C

    Repair at any of the above: Item Location Code = D

  • 2004 TPSMG

    ItemLocation

    Code

    InfoCode

    Variant

    InfoCode

    DisassCode

    Variant

    DisassCode

    Unit of assembly

    Subsub-system

    Sub-systemSystem

    SystemDiff

    Code

    Modelidenti-fication

    ILC - Summary

    Item Location Code ILC- Identifies the location of the task

    Fixed length at 1 alpha-numeric character

  • 2004 TPSMG

    DMC partitions

    MI

    Model/Project

    SDC/SNS/DC/DCV../YYY-YY-YYYY//..

    Breakdown

    IC/ICV/ILC

    Information type

    Relations of variation

  • 2004 TPSMG

    Implementation

    Allocate MI (~ project name) and register with NAMSA NATO Maintenance and Supplay Agency i

    Luxembourg

    Allocate SDC or use for example the UOC

    Optionally use of a first character in SNS as MICC to allow multiple SNS types (if required) MICC - Material Item Category Code, as defined

    in Def Stan 00-60

    MI SDC SNS DC DCV IC ICV ILC

  • 2004 TPSMG

    Implementation

    Allocate SNS 8 sets of SNS that are maintained by TPSMG (by

    CPF) 18 examples SNS not maintained If none fit write your own!

    Allocate disassembly under the rules for disassembly

    Model IdentSystem

    DifferenceSNS DC DCV IC ICV ILC

  • 2004 TPSMG

    Implementation

    Allocate Disassembly Code Variant Allocate Information Codes Allocate Information Code Variant Allocate Item Location Code

    Model IdentSystem

    DifferenceSNS DC DCV IC ICV ILC

  • 2004 TPSMG

    Questions!?Questions!?

    Thanks for your attention!

  • 2004 TPSMG

  • 2004 TPSMG

    The Illustration Control Number (ICN)and

    The Publication Module Code (PMC)

    The Illustration Control Number (ICN)The Illustration Control Number (ICN)andand

    The Publication Module Code (PMC)The Publication Module Code (PMC)

    John Lawless

    S1000D TutorialVaxjo

    2004-09-22

  • 2004 TPSMG

    The Illustration Control Number - ICNThe Illustration Control Number The Illustration Control Number -- ICNICN

  • 2004 TPSMG

    ICN-27 characters

    In S1000D up to and including Change 9

    27 character illustration control number - ICN Made up of 10 subelements

    All fixed length All populated by specific data types

  • 2004 TPSMG

    ICN-27 characters

    Prefix ModelicSystem

    DiffCode

    SNSRPCcode

    Originatorcode

    Sequen-tialNo.

    Variantcode

    IssueNo.

    Securityclassifi-cation

    Strict rules

  • 2004 TPSMG

    The Illustration Control Number - ICN

    The illustration control number is the unique identifier of an illustration (graphic)

    It comprises 27 to 45 characters

    ICN-BICYCLEXXXAAAA-AAAA-D00-00-0000-Y-YYYYY-NNNNN-Y-XX-YICN-BICYCLEXXXAAAA-AAAA-D00-00-0000-Y-YYYYY-NNNNN-Y-XX-Y

    Prefix

    SDC

    SNS

    RPC

    Orig

    SeqNo

    VarCode

    IssNo

    Sec

    MI

  • 2004 TPSMG

    The Illustration Control Number - ICN

    ICN-BICYCLEXXXAAAA-AAAA-D00-00-00-0-U8025-00536-A-01-1ICN-BICYCLEXXXAAAA-AAAA-D00-00-00-0-U8025-00536-A-01-1

    ICN-BICYCLEXXXAAAA-AAAA-DA5-10-00-0-U8025-00520-A-01-1ICN-BICYCLEXXXAAAA-AAAA-DA5-10-00-0-U8025-00520-A-01-1

  • 2004 TPSMG

    ICN

    Prefix ModelicSystem

    DiffCode

    SNS

    Identifies the project Variable length between 2 and 14 (inclusive) alpha-numeric characters

    Identifies differences in the function of a system

    Variable length between 1 and 4 (inclusive) alpha-numeric characters

    The Standard Numbering System (SNS)

    The same variable structure as for the DMC (6, 8 or 9 alpha-numeric characters)

    Written without dashes

    ICN

    3 A characters

  • 2004 TPSMG

    Issue 2.0 ICN

    Prefix ModelicSystem

    DiffCode

    SNSRPCcode

    Originatorcode

    Sequen-tialNo.

    Variantcode

    IssueNo.

    Securityclassifi-cation

    The code is the originators NCAGE code.

    For each MI, the number shall start from 00001 for each originating company.

    The illustration variant code is a single alpha character, which identifies the variants of a basic illustration. The variant code "A" identifies a basic illustration and "B" identifies the first variant.

    The illustration issue number is a 2 digit sequential numerical value. It starts from 01 for each basic illustration or variant and is incremented each time the illustration is updated.

    The responsible partner company is the company responsible for the data module in which the illustration is used. The responsible partner company code must be defined by the project.

    A single numerical character identifies the security classification of theillustration .

  • 2004 TPSMG

    The Publication Module Code PMC

    The Publication Module Code The Publication Module Code PMCPMC

  • 2004 TPSMG

    Pre Issue 2.0 PMC

    Nothing Nothing NothingNothing

  • 2004 TPSMG

    The Publication Module Code - PMC

    The publication module code is a part of the unique identifier of a publication

    It comprises 12 to 24 characters

    BICYCLEXXXAAAA-U8025-12345-00

    MI IssuingAuthority

    No Vol

  • 2004 TPSMG

    Issue 2.0 PMC

    MIIssuing

    authority

    No.of

    publ

    VolumeNo.

    Identifies the project.

    2-14 A/N characters

    The number of the publication module. The issuing authority assigns the number of the publication module.

    5 N characters

    This element is used in cases where a publication has to be separated into volumes without assigning a new number. Default value is "00".

    2 N characters

    To identify the issuing authority it is recommended to use the NCAGE code.

    5 A/N characters

  • 2004 TPSMG

    Questions!?Questions!?

    Thanks for your attention!

  • 2004 TPSMG

  • 2004 TPSMG

    IDSTATUS sectionIDSTATUS section

    Paul HaslamTen On Eleven, Inc.

    S1000D - Tutorial

    Svante EricssonSrman I&M

    EPWG Chairman

    2004-09-22

  • 2004 TPSMG

    All of

    IDSTATUS

    Meta data about the

    data module

    One of

    CONTENT

    What the user sees

    Issue details

    DM Address

    Security

    Applicability

    QA Status

    Descriptive

    Procedural

    Fault

    Crew

    IPD

    Schedules

    Datamodule

    ProcessWiring

    The data module

    Every data module has this

  • 2004 TPSMG

    Identification and status section

    IDSTATUSStatus part

    Identification part

  • 2004 TPSMG

    Identification and status section

    Identification part

    Data module code

    Data module title

    Issue number

    Issue data

    Language

  • 2004 TPSMG

    Identification

    Contains the unique identifier of the data module. Includes: Contains the data module code Contains the data module title Contains the issue numbering details Contains the issue date details Contains the language details

  • 2004 TPSMG

    DMCExample:

    BICYCLEXXXAAA AAA D00 0 0 00 00 00 041 A A

  • 2004 TPSMG

    DMTITLE

    DMTITLE The title of the data module

    Example:

    Bicycle Description of how it is made

  • 2004 TPSMG

    attribute type

    type new = new data module.

    Only applicable for issue No. "000" and 001"

    changed = data module content changed deleted = data module deleted revised = data module completely revised status = data module status only change rinstate-changed = data module reinstated with content

    changed rinstate-revised = data module reinstated with content

    completely revised rinstate-status = data module reinstated with status

    only change

  • 2004 TPSMG

    Issue numbering rule

    issno.inwork 000.01 new data module, 1st draft/revision type = "new" 000.02 new data module, 2nd draft/revision type = "new" 000.NN new data module, draft/rev "NN" type = "new" 001.00 1st issue of data module type = "new" 001.01 1st issue of data module, first draft/rev type = "new" 001.02 1st issue of data module, 2nd draft/rev type = "new" 001.NN 1st issue of data module, draft/rev "NN type = "new" 002.00 2nd issue of data module eg type = "changed" NNN.00 issue "NNN" of data module eg type = "revised"

  • 2004 TPSMG

    Issue date

    Issue date The that the data module was issued

    Example:

  • 2004 TPSMG

    Language

    Gives the language in which the DM is written

    Example:

  • 2004 TPSMG

    Identification and status section

    Status part

    Security classification

    Responsible partner company

    Originator

    Applicability

    Quality assurance status

    Skill level

    Reason for update

  • 2004 TPSMG

    Security classification

    Security Gives the security classification of the data

    module

    Three types: Class Attribute class

    Commercial classification Attribute commcls

    Caveat Attribute caveat

  • 2004 TPSMG

    Security classification

    class

    Values 01 to 09 51-99 are project available

    01 should be lowest value

  • 2004 TPSMG

    Commercial classification

    commcls

    Independent of security classification

    Value set cc01 - cc99 cc51 - cc99 are project available

    No specific classification suggested Example:

    cc51=Not to be disclosed outside DMA

  • 2004 TPSMG

    Caveats

    caveat

    Independent of security and commercial classification

    Value set cv01 - cv99 cv51 - cv99 are project available

    No specific classification suggested Example:

    cv51=Swedish defence ministry only

  • 2004 TPSMG

    Data restrictions

    ..

    Elements within

  • 2004 TPSMG

    Instructions

    Distribution Instructions on how the data module should be

    distributed.

    Example:

    To be made available to all S1000D users.

  • 2004 TPSMG

    Instructions

    Export Conditions Details and instructions on any export restrictions.

    Example:

    Export of this data module to all countries that are the residence of organizations that are users of S1000D is permitted. Storage of this data module is to be at the discretion of the organization.

  • 2004 TPSMG

    Instructions

    Handling Details and instructions on handling.

    Example:

    There are no specific handling instructions for this data module.

  • 2004 TPSMG

    Instructions

    Destruction Details and instructions on destruction.

    Example:

    Users may destroy this data module in accordance with their own local procedures.

  • 2004 TPSMG

    Instructions

    Disclosure Details and instructions on disclosure.

    Example:

    There are no dissemination limitations that apply to this data module.

  • 2004 TPSMG

    Information

    Copyright: Copyright information for the data module

    Example: TPSMG UK 2003 2010 TPSMG TPSMG 001

  • 2004 TPSMG

    Information

    Policy reference Reference to the document that declares the

    security policy

    Example:

    TPSMG TOR 001

  • 2004 TPSMG

    Information

    Data conditions Any conditions that apply to the data module

    Example:

    There are no known conditions that would change the data restrictions for, or security classification of, this data module.

  • 2004 TPSMG

    Reason for update

    Reason for update of the complete DM

    Is used for the final issue and during the production process

    Includes simple paragraph

    Example:

    New torque value when tightening the hatch.

  • 2004 TPSMG

    Remarks

    Includes simple paragraph

    Example:This is the first remark.

    This is the second remark.

  • 2004 TPSMG

    Questions!?Questions!?

    Thanks for your attention!

  • 2004 TPSMG

  • 2003 TPSMG

    Front matter - WCNFront matter Front matter -- WCNWCN

    Carl WilnSaab Aerosystems

    S1000D - TutorialVxj

    2004-09-22

  • 2003 TPSMG

    Front matter

    Title page Highlights Access illustrations List of illustrations List of effective pages List of effective data modules Change record List of abbreviations

    List of terms List of symbols Technical standard record List of applicable specifications and

    documentation Table of contents List of support equipment List of supplies List of spares

  • 2003 TPSMG

    Front matter

    Chap 3.9.4 Authoring - Front matterChap 5.3.1.2 Common requirements - Front matterChap 6.2.3.1 Lay-out - Front matter and lists - Examples

  • 2003 TPSMG

    Front matter

  • 2003 TPSMG

    Front matter

  • 2003 TPSMG

    Warning

    Warnings are used in data modules and technical publications to alert the user that possible hazards are associated with the materials/processes/procedures/limits.

    These may cause death or injury in any form, if the instructions in the operational or procedural task are not followed precisely.

    Warnings describe the hazards and possible impact.

  • 2003 TPSMG

    Caution

    Cautions are used in data modules and technical publications to alert the user that damage to the Materiel is possible if the instructions in the operational or procedural task are not followed precisely.

    Cautions describe the hazards and possible impact.

  • 2003 TPSMG

    Note

    Notes are used in data modules and technical publications provide the user with additional information, which is helpful but does not belong to the immediate subject.

    Operational and procedural tasks can be made easier by the use of notes, but when used, they do not take the place of operational or procedural information.

  • 2003 TPSMG

    Warning - Caution

    Warnings in data modules shall always precede the text where the hazard arises and shall always precede cautions and notes.

    Cautions in data modules shall always precede the text where the hazard arises and shall always precede notes.

    Warnings/Cautions shall be the first item within that step/para. They shall follow the step/para number and title, if any, and precede any text.

  • 2003 TPSMG

    Notes

    Normally, notes in data modules shall follow the text to which they refer.

    Notes applicable to complete steps/paras or sub-steps/sub-paras, including their sub-steps/sub-paras, shall follow the step/para number and title, if any, and precede any text.

  • 2003 TPSMG

    Warnings, cautions and notes

    Chap 3.9.3 Authoring - Warnings, cautions and notes

    Chap 6.2.3.x Layout examples

    Note: The following examples gives the preliminary style/presentation. The detailed rules are given in Chap 3.9.3

  • 2003 TPSMG

    WCN

  • 2003 TPSMG

    WCN

    The The presentation of presentation of warnings and warnings and cautions are cautions are

    still under still under development. development. A harmonized A harmonized international international

    style/format is style/format is in process.in process.

  • 2003 TPSMG

    WCN

  • 2003 TPSMG

    WCN

  • 2003 TPSMG

    Questions!?Questions!?

    Thanks for your attention!

  • 2004 TPSMG

  • 2004 TPSMG

    The functionality matrixThe functionality matrix

    Denny RaitzAssociate Technical Fellow Tech Data

    The Boeing CompanyS1000D - Tutorial

    Vaxjo2004-09-22

  • 2004 TPSMG

    Agenda

    Background, Problems and Requirement For Another Approach US DoD IETM Standards Shortfall Issues With The Classes Of IETMs Classes of IETMs To Correct The Problem

    Chapter 6.4.2 Functionality Functionality Selection When Contracting S1000D..

  • 2004 TPSMG

    BackgroundProblems &

    Requirement ForAnother Approach

  • 2004 TPSMG

    US DoD IETM Standards Shortfall

    US DoD IETM specs were badly out of date MIL-PRFs 87268 and 87269; over 10 years old Inadequate for newer technologies including migration to web-

    based delivery

    Perry Memorandum Called for Commercial Specs (where possible) US DoD Specs were not maintained No suitable Commercial Specs available meeting military

    requirements

    Program Managers Had To Individually Produce IETM Requirements Documents IETMs became stove-piped within Programs This Practice tied the Program to specific and expensive

    contractor-unique solutions

  • 2004 TPSMG

    Issues With The Classes Of IETMs

    Classes were never official

    Definitions were confusing and overlapped Five classes could have been reduced to two

    (Type I and Type II) if combined with functions and features desired

    Specifications (87268 and 87269) were too loose and out of date

  • 2004 TPSMG

    Classes of IETMs

    Paper

    Multiple Volumes

    Not Linkedor Integrated

    Maintainer Searchesfor Data

    High MMH / FH High False Removals

    Electronic TechnicalManual (ETM)

    Electronic Emulationof Paper Manual

    Data Access Expedited by Page Turner and Hyperlinks

    Reduced Maintainer Searching

    High MMH / FH Reduced False Removals

    Interactive Electronic Technical Manuals (IETM)

    Fully Interactive IETM Provides Data When Needed to Maintainer, Leads Maintainer Down Maintenance Path,Allows for Reduced Training

    MaintainerNever Searchesfor Data

    Lower MMH / FHLow FalseRemovals

    Class IV IETMand Electronic Infrastructure

    IETM Linked to Maintenance Network

    Integrated With Diagnostics

    Expedites Trouble-Shooting, Spare Ordering and Maintenance Planning

    IncreasedAvailability

    Class 0 Class I, II, III Class IV Class V

    Type I Type II

  • 2004 TPSMG

    To Correct The Problem

    US Aerospace Industries Association (AIA) developed The Functionality Matrix (1998)

    Initially created to rid the industry of the unofficial IETM classes

    Used on several USAF conversion programs Matrix has and is being used to define technical data

    requirements in Statements of Work (SOW) Matrix used in estimating

    Revamped by AIA to update to current capabilities (technologies) (2002)

    Adopted by AECMA as Apples to Applescomparison tool

  • 2004 TPSMG

    Chapter 6.4.2 - Functionality

  • 2004 TPSMG

    Functionality Selection

    Functionality TabFunctionality Tab

  • 2004 TPSMG

    Category FunctionalityComplexity

    Factor Fin

    al D

    eliv

    erab

    le I

    mp

    act

    The

    ory

    Loca

    tion

    Gen

    eral

    Inf

    o

    Des

    crip

    tion

    FIP

    Set

    up c

    heck

    s

    Dia

    gnos

    tics

    Tes

    ts

    Str

    uctu

    ral R

    epai

    r

    Wiri

    ng D

    ata

    IETP Functionality Matrix

    Desc Info FaultsProced

    Info

    Tech data that is displayed in a non-linear fashion. There are high levels of interactivity between the data and the user. The sequence of presentation is dictated by inputs by the user, external sources or events

    (as in diagnostics).

    Training/Security Access 2Suspend and Restart 1User creation of bookmarks 1Local Data Annotation 2Personal Annotation 1Global Data Annotation 2Redlining 3CD-ROM 1DVD 1Network Distribution 2

    Access

    Annotation

    Delivery and Distribution

    Key features/principles of the matrixKey features/principles of the matrix

    Category Category The type of function or featureThe type of function or featureFunctionality Functionality The function/feature titleThe function/feature title

    Complexity Factor Complexity Factor Identifies difficulty in developing/authoring this functionIdentifies difficulty in developing/authoring this function(1(1--5, 5 being most difficult)5, 5 being most difficult)

    Types of Data Types of Data -- The types of data that the function is to be applied.The types of data that the function is to be applied.

    Type of DataType of Data

    Chapter 6.4.2

    Functionality

    Functionality

    Matrix

  • 2004 TPSMG

    Category FunctionalityComplexity

    Factor Fin

    al D

    eliv

    erab

    le I

    mp

    act

    The

    ory

    Loca

    tion

    Gen

    eral

    Inf

    o

    Des

    crip

    tion

    FIP

    Set

    up c

    heck

    s

    Dia

    gnos

    tics

    Tes

    ts

    Str

    uctu

    ral R

    epai

    r

    Wiri

    ng D

    ata

    Training/Security Access 2Suspend and Restart 1User creation of bookmarks 1Local Data Annotation 2Personal Annotation 1Global Data Annotation 2Redlining 3CD-ROM 1DVD 1Network Distribution 2Diagnostics - User Determined Entry to ETM 1Diagnostics -Software Driven Entry to ETM 2Dynamic Diagnostics - 5Wire/Fluid System Tracing 4EXTERNAL PROCESSES- Retrieval 2Supporting Technical Data 2EXTERNAL PROCESSES- Transmittal 3Deficiency Report Transmittal 3Maintenance Data Collection 3Operator Debriefing 3

    IETP Functionality Matrix

    Desc Info FaultsProced

    Info

    Tech data that is displayed in a non-linear fashion. There are high levels of interactivity between the data and the user. The sequence of presentation is dictated by inputs by the user, external sources or events

    (as in diagnostics).

    Access

    Annotation

    Delivery and Distribution

    External Processes

    Diagnostics and Prognostics

    Functionality Color Codes Functionality Color Codes Items identified as Items identified as redred are authoring style considerations.are authoring style considerations.

    Items inItems in blueblue denote distribution impacts.denote distribution impacts.Items inItems in blackblack signify viewer issues. signify viewer issues.

    Chapter 6.4.2

    Functionality

    Functionality

    Matrix

  • 2004 TPSMG

    Category FunctionalityComplexity

    Factor Fin

    al D

    eliv

    erab

    le I

    mp

    act

    The

    ory

    Loca

    tion

    Gen

    eral

    Inf

    o

    Des

    crip

    tion

    FIP

    Set

    up c

    heck

    s

    Dia

    gnos

    tics

    Tes

    ts

    Str

    uctu

    ral R

    epai

    r

    Wiri

    ng D

    ata

    Training/Security Access 2Suspend and Restart 1User creation of bookmarks 1Local Data Annotation 2Personal Annotation 1Global Data Annotation 2Redlining 3CD-ROM 1DVD 1Network Distribution 2Diagnostics - User Determined Entry to ETM 1Diagnostics -Software Driven Entry to ETM 2Dynamic Diagnostics - 5Wire/Fluid System Tracing 4EXTERNAL PROCESSES- Retrieval 2Supporting Technical Data 2EXTERNAL PROCESSES- Transmittal 3Deficiency Report Transmittal 3Maintenance Data Collection 3Operator Debriefing 3

    IETP Functionality Matrix

    Desc Info FaultsProced

    Info

    Tech data that is displayed in a non-linear fashion. There are high levels of interactivity between the data and the user. The sequence of presentation is dictated by inputs by the user, external sources or events

    (as in diagnostics).

    Access

    Annotation

    Delivery and Distribution

    External Processes

    Diagnostics and Prognostics

    Functionality Desired for select types of data Functionality Desired for select types of data In some cases, an endIn some cases, an end--user may desire a specific user may desire a specific function the only impacts certain types of data.function the only impacts certain types of data.

    Chapter 6.4.2

    Functionality

    Functionality

    Matrix

  • 2004 TPSMG

    Chapter 6.4.3

    Functionality

    Acquisition

    ManagementTo Be Supplied In A Later ChangeIETP Acquisition Management

    Purpose-To provide information and guidance on the acquisition of IETP (including lessons learned from fielded systems)

  • 2004 TPSMG

    When Contracting S1000D..

    In the Project Business Rules

    #1 - Identify Data Format: Page Orientated Publication Interactive Electronic Technical Publication (IETP)

    #2 - Identify the Functionality Desired If possible, ask the end-user (maintainer) Select functions or features affordable as well as

    desired (and sensible)

  • 2004 TPSMG

    Questions!?Questions!?

    Thanks for your attention!

  • 2004 TPSMG

  • 2004 TPSMG

    Future Issue 2.2/2.3/2.xFuture Future Issue 2.2/2.3/2.xIssue 2.2/2.3/2.x

    Carl WilnSaab Aerosystems

    S1000D - TutorialVxj

    2004-09-22

    What did we miss in Issue 2.1?New stuff and new ideas

  • 2004 TPSMG

    Issue 2.1+

    Remaining CPFs 50+ to discuss, analyze,

    and some to be rejected

    Starter Tool kit - The Bike Will include 45+ DMs and PMs, DDN, DMRL,

    Both SGML/XML instances and output examples

    FOSIs, Style sheets XSL/CSS

    Conversion script (The Sledgehammer)

  • 2004 TPSMG

    Starter Tool kit - The Bike Bicycle data modules

    Descriptive Procedural Illustarted parts data Fault isolation Crew/Operator Schedules (Maintenance planning) Wiring Process data module

  • 2004 TPSMG

    Starter Tool kit - The Bike Exchange

    Data Module List - DML Data Dispatch Note - DDN Publication Module - PM

    Illustrations Computer Grahics Metafile (CGM) Raster

  • 2004 TPSMG

    Starter Tool kit - The Bike Scripts (for IETP-X neutral format)

    SGML to XML conversion URL/URN Resolution XLink attributes RDF/DC Meta data

  • 2004 TPSMG

    Starter Tool kit - The Bike Software

    The Sledgehammer Change 1.6 Change 1.7 Change 1.8 Change 1.8.1 Change 1.9 Change 2.0 Change 2.1

    Converts any S1000D version change to any

    other (both ways)

  • 2004 TPSMG

    Starter Tool kit - The Bike Output

    XSL Stylesheets CSS PDF examples for all data module types FOSI

    Framemaker (?!) Epic (?!)

  • 2004 TPSMG

    Starter Tool kit - The Bike

    Youll find Youll find The BikeThe Bike here!here!

  • 2004 TPSMG

    Issue 2.2 - 2.3The remaining chapters: Chap 6.2.3.x Page-oriented presentation Layout

    examples

    Chap 6.3.1 IETP Look and feel Chap 6.3.2 IETP Output specification

    Chap 6.3.3 IETP User interface functionality Chap 6.4.3 Acquisition management

  • 2004 TPSMG

    Issue 2.2 2.3

    Close up of procedures New model similar to Required conditions

  • 2004 TPSMG

    Issue 2.2 2.3

    Exchange mechanism for project attribute configuration files The BREX!

    Understandable Wiring Data chapters User guidance and examples A data dictionary

  • 2004 TPSMG

    Issue 2.2 2.3

    I hope someone will explain to me what a is what its used for how its coded

  • 2004 TPSMG

    Issue 2.2 2.3

    Result from the eminentEffectivity, Applicability, Sensitivity and Updating Working Group (EASUWG).

  • 2004 TPSMG

    Issue 2.x

    New CPFs

    New CPF procedure and more

    and more

  • 2004 TPSMG

    May 2003

    Issuing of Issue 2.0

    S1000DIssue 2

    Oct 2003

    Release of Issue 2.0

    S1000D The Roadmap 2004 and onwards

    S1000DChange 2.1

    CleaningCleaning

    Feb 2004

    Release of Change 2.1

    S1000DChange 2.2

    Mid 2005

    Release of Change 2.2

    New featuresNew features

    2006

    Release of Change 2.3

    S1000DChange 2.3

    Major changeMajor change

  • 2004 TPSMG

    Calendar 2004Team Location Dates Note .

    Change 2.1 2004-02-29 Available from the web in Sep

    S1000D User Forum Fall 2004S1000D User Forum Fall 2004VxjVxj 20042004--0909--22/2422/24 S1000D, SCORM, SE S1000D, SCORM, SE

    Tutorials on the first dayTutorials on the first day

    46th EPWG Vxj 2004-09-24/28 Sunday free!!!

    Exec - 18th Fort Worth, TX2004-11-29/12-01

  • 2004 TPSMG

    Calendar 2005Team Location Dates Note .

    47th EPWG Italy 2005-01-17/19 Exec - 19th Paris 2005-01-19-21 S1000D 20th

    AnniversaryExec - 20th Web-meting 2005-03-Change 2.2 Mid 2005

    (AIA Prod Support Spring Conf 2005-05-09/11)AIA/Tri-Services Public Workshop

    Clearwater, FL 2005-05-12/13Joint S1000D/Training (ADL) Users Forum and Workshop

    Clearwater, FLS1000D Tutorial - User Forum 2005-05-16/17 Mo/TuTraining (ADL) 2005-05-18/19 We/ThExec - 21st 2005-05-19/20 Th/Fr

    Exec - 21st Munich 2005-10-04/05S1000D User Forum Fall 2005 2005-10-06/07

  • 2004 TPSMG

    Questions!?Questions!?

    Thanks for your attention!