© 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications...

180
© 2003 TPSMG S1000D Tutorial S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09

Transcript of © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications...

Page 1: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

S1000D TutorialS1000D Tutorial S1000D TutorialS1000D Tutorial

Compressed introduction to the Spec

AIA/Tri-Service 2004 Publications WorkshopSan Antonio, TX

2004-02-09

Page 2: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Mr Dennis Hoyland BA, MBA

Chairman Technical Specification Maintenance Group

Assistant Director Corporate Technical Services Technical Documentation

Defence Logistics Organisation, United Kingdom

Page 3: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Agenda

• History – Organization - Overview – Future– Dennis/Carl

• AIA Activities– Denny/Sean/Ryan

• Overview of publishing– Paul/Tam/Jan

• S1000D in the digital world– Svante/Peter/Kathy/Ryan

• Discussion

Page 4: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

S1000D Issue 2.0S1000D Issue 2.0The vision – The realityThe vision – The reality

S1000D Issue 2.0S1000D Issue 2.0The vision – The realityThe vision – The reality

The way to a true international tech pubs spec

AECMA S1000D - TutorialSan Antonio, TX

2004-02-09

Page 5: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

The objective of this introduction is to

• explain who AECMA and AIA are?• give a historical flashback to the development history of

AECMA Spec 1000D to S1000D

• describe the international maintenance organization• present the

– new structure of Issue 2.0– Some new features of Issue 2.0

Page 6: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Who are AECMA and AIA?Who are AECMA and AIA?

Page 7: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Who is AECMA?• AECMA is an organization

– The European Association of Aerospace Industries, AECMA, represents the European defense 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 – AECMA S1000D for Technical Publications

Page 8: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 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 AECMA– 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.– AECMA S1000D for Technical Publications

Page 9: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

HistoryHistory

Page 10: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

History

1984 • 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,

Brigadergeneral SwEF, etc 1998• NCMB - Oslo meeting• Goal:

Develop an internationally supported Roadmap for Interactive Technical Documentation

2000• NATO ITD WG - Bonn meeting

Page 11: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

NATO ITD Interoperability Task ForceChair: Bob Kidwell

Reports to NATO CALS Management Board

Participants:Everybody who have interest in

Standard ized Interactive Tech Info

NATO Electronic Information Interoperability WGChair: Bob Kidwell

Participants:A “selection” of p layers from the Task Force

NATO IETP Core Specification GroupChair: Dennis Hoyland

Participants:A “small focus group” from the WG

The NATO ITD Interop Task Force

Page 12: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Result form NATO ITD Interoperability Task Force

Extract the Best/Complementary componentsfrom the above NATO Roadmap

S1000DChange 8

MIL-PRF-87269U.S. DoD

NATORoadmap

“ITD”

IETP “X”Chap #5

Draft XMLMIL-HDBK-511

The JIA

Page 13: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Ch9 → Ch 10 → Issue 2/S1000NAnno 2001

S1000D Ch9

CPFCPF

CPF

MIL-HBK-511

S1000D Ch10

RestructuringRestructuring11

RestructuringRestructuring11

SeaSeaSeaSea

LandLandLandLand

S1000N

RestructuringRestructuring22

RestructuringRestructuring22

SGMLSGMLSGMLSGML

2001-05 2002-01 Mid 2002

Deadline for CPFs

AirAirAirAir

Issuing of Issue 2

Approval of final drafts

Issuing of Change 10

2001-12

MIL-PRF-87268

MIL-PRF-87269

Page 14: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

S1000D – The Roadmap 2003

2004-05

Release of Change 2.x

May 2003

Issuing of Issue 2

S1000D Ch9

CPFCPF

CPF

MIL-HBK-511

S1000DIssue 2

RestructuringRestructuring11

RestructuringRestructuring11SeaSeaSeaSea

Land (+GBF)Land (+GBF)Land (+GBF)Land (+GBF)

S1000DChange 2.x

SGMLSGMLSGMLSGML

AirAirAirAir

MIL-PRF-87268

MIL-PRF-87269

Interactivity 1Interactivity 1(Process DM)(Process DM)Interactivity 1Interactivity 1(Process DM)(Process DM)

Interactivity 2Interactivity 2Interactivity 2Interactivity 2

Oct 2003

Release of Issue 2

XML SchemaXML SchemaXML SchemaXML Schema

Page 15: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

OrganizationOrganization

Page 16: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

S1000D Maintenance organization

AECMA - CPSCCustomer & Product Support

Committee

TPSMGTech Pubs Spec Maint

GroupD Hoyland/C-J Wilén/

Denny Raitz

EPWG

Electronic Publications WG Svante Ericsson/Peter

Zimmermann

Land Publ WG

(LPWG) P Haslam/T Faleij

Sea Publ WG(SPWG)

Tom Malloy

AIAProduct Support Committee

S1000D User Forum

TPSMG Exec

Air Publ WG(APWG)

Ferry Berendi

ChairCo-chair EUCo-chair USSecrChair EPWG Chair LPWGChair SPWG+2 representatives from each country

The “formal” decision forumMeets only “on condition”

Page 17: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

AECMA - CPSCCustomer & Product Support

Committee

TPSMGTech Pubs Spec Maint

GroupD Hoyland/C-J Wilén/

Denny Raitz

EPWG

Electronic Publications WGSvante Ericsson/Peter

Zimmermann

Land Publ WG

(LPWG) P Haslam/T Faleij

Sea Publ WG(SPWG)

Tom Malloy

AIAProduct Support Committee

S1000D User Forum

TPSMG Exec

Air Publ WG(APWG)

Ferry Berendi

TPSMG ChairCo-chair EUCo-chair USSecrChair EPWG Chair LPWGChair SPWGGermany indFrance indItaly indUK MoDUSA DoD

The common working forum - The decision forum

Meets regularly 3-5/year (Europe/US)

S1000D Maintenance organization

Page 18: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

AECMA - CPSCCustomer & Product Support

Committee

TPSMGTech Pubs Spec Maint

GroupD Hoyland/C-J Wilén/

Denny Raitz

EPWG

Electronic Publications WGSvante Ericsson/Peter

Zimmermann

Land Publ WG

(LPWG) P Haslam/T Faleij

Sea Publ WG(SPWG)

Tom Malloy

AIAProduct Support Committee

S1000D User Forum

TPSMG Exec

Air Publ WG(APWG)

Ferry Berendi

Customers and Vendors

Arranged by TPSMG Exec

Bi- annualFall mtg – EuropeSpring mtg - US

S1000D Maintenance organization

Page 19: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

AECMA - CPSCCustomer & Product Support

Committee

TPSMGTech Pubs Spec Maint

GroupD Hoyland/C-J Wilén/

Denny Raitz

EPWG

Electronic Publications WG Svante Ericsson/Peter

Zimmermann

Land Publ WG

(LPWG) P Haslam/T Faleij

Sea Publ WG(SPWG)

Tom Malloy

AIAProduct Support Committee

S1000D User Forum

TPSMG Exec

Air Publ WG(APWG)

Ferry Berendi

Chair and co-chair appointed by TPSMG Exec

+ workers appointed by the chair/co-chairsChair (and co-chair)

appointed by TPSMG Exec

+ workers appointed by the chair/co-chairs

S1000D Maintenance organization

Page 20: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

National supporting organizationAECMA - CPSC

Customer & Product Support Committee

TPSMGTech Pubs Spec Maint

Group

EPWG

Electronic Publications WG

Land Publ WG

(LPWG)

Sea Publ WG(SPWG)

AIAProduct Support Committee

S1000D User Forum

TPSMG Exec

Air Publ WG(APWG)

National representative/TPSMG

Ver Ver 2003-12-02

National EPWG

Electronic Publications WG

National Land Publ WG

National Sea Publ WG

National Air Publ WG

Page 21: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Note to Dennis:Note to Dennis:The flags at the bottom are: The flags at the bottom are:

South Africa, Norway, Hungary South Africa, Norway, Hungary and The Netherlandsand The Netherlands

Page 22: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Some basic definitions …Some basic definitions …

Page 23: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 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 store for the data modules and publications

• DMC (Data Module Code)– A 17- alt 37-charchter code to identify a data module and to facilitate storing and

retrieving them from a CSDB

• ICN (Illustration Control Number)– A 27- alt 45-charchter 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”

Page 24: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

RestructuringRestructuring

Started in 1998

Page 25: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Four and a half years later

• More than 100 CPFs has been generated, discussed, analysed, dissected, … … and some rejected

• 70+ CPFs has been accepted and included

• The Spec has become a tri-service spec incl Land, Sea, Air Materiel

• The spec has been completely restructured

• Change 9 has become Issue 2

Page 26: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Co-Chair Technical Specification Maintenance Group

Technical Fellow Informatics

Saab Aerosystems

Sweden

Mr Carl Wilén M Sc

Page 27: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Structure of S1000DStructure of S1000D

Page 28: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Issue 2

Three becomes one

Change 9

The

Materiel

Page 29: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 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

Page 30: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 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

Page 31: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Chapter 7

Information processing

Issue 2

Chapter 8

Standard Numbering

System (SNS) and information

codes

Chapter 9

Terms - Data dictionary

Page 32: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

What’s new?What’s new?

Page 33: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 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

Page 34: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 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

Page 35: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 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

Page 36: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 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

Page 37: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 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

Page 38: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Wiring DTD - New data module type and wiring DTD- Takes wiring data from engineering into DMs and further to IETP

Chapter 3

Information generation

Page 39: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 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

Page 40: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Ml

BATTLETANK1234BATTLETANK1234

-Y-040Y

SNS IC/ICV ILC

-YYYY

SDC DC/DCV

38-21-0301 -Y -04YYY

New data module code – DMCAn extended, more flexible, numbering system for data module codes

Chapter 4

Information management

Page 41: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 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

Page 42: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

New concept for CSDBPublication module (PM) and Publication Module Code (PMC) has been added to control configuration of IETP content

Chapter 4

Information management

Page 43: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 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

Page 44: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

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

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

Chapter 5

Information and

publication sets

Page 45: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 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

Page 46: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 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

Page 47: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 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

Page 48: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 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

SpecSpec

Page 49: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 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

SpecSpec

Page 50: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 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

Page 51: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Attribute values- flexibility- using configuration files

XML Schema- Now introduced for data

modules (in parallel with SGML DM DTD)

Chapter 7

Information processing

Page 52: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 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

Page 53: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 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

Page 54: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

S1000D Issue 2.0

International Specification for Technical Publications

utilisinga Common Source DataBase

AECMA - AIAThe European Association of Aerospace Industries

Aerospace Industries of America

Issue 2.02003-05-31

Now free on

the web

Page 55: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG Mr Dennis Hoyland

Page 56: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Future – Issue 2.1/2.2/2.3Future – Issue 2.1/2.2/2.3 Future – Issue 2.1/2.2/2.3Future – Issue 2.1/2.2/2.3

What did we “miss” in Issue 2?New stuff

Page 57: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Issue 2.x

• 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 Change 6, 7, 8 or 9 to Issue 2.0

(The Sledgehammer)

Page 58: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Issue 2.x

The 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

Page 59: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Issue 2.x

• Multimedia formats – audio, video, 3D, Virtual Reality, …

• Completion of Interactivity and diagnostics interface– An extended Process data moduleor– A new Interactive data module

• Common ATA / AECMA / AIA SVG profile• Applicability / Effectivity improvements• Include new DM type “DACR” (Damage

Assessment, Control and Repair)

Page 60: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Issue 2.x• Exchange mechanism for project attribute

configuration files• ADL/SCORM linkage (MoU in development)

• PLCS/STEP linkage (MoU in place)

• Close up of procedures – New model

Page 61: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Issue 2.x

• New CPFs • New CPF procedure • and more …• and more …• …

Page 62: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

On the web On the web mid Aprilmid April

May 2003

Issuing of Issue 2.0

S1000DIssue 2

Oct 2003

Release of Issue 2.0

S1000D – The Roadmap 2003 and onwards

S1000DChange 2.1

CleaningCleaningCleaningCleaning

Feb 2004

Release of Change 2.1

S1000DChange 2.2

Nov 04

Release of Change 2.2

New featuresNew featuresNew featuresNew features

Mid/Late 2005

Release of Change 2.3

S1000DChange 2.3

Major changeMajor changeMajor changeMajor change

Page 63: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Questions!?Questions!?

Thanks for your attention!

Page 64: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Mr Denny RaitzAssociate Technical Fellow – Technical Data

Co-Chair Technical Specification Maintenance Group

AndAIA Representative

Page 65: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

AIA Publications Overview

• Last Two Year’s Accomplishments• Current/Ongoing Activities• Future Plans

– 2004 Goals and Objectives

Page 66: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Accomplishments

• Tri-Services Support– Dec. ’03 – First S1000D Tutorial to US DoD

(NAVSEA)– Sept. ’03 – S1000D Published– May ’03 – S1000D Issue 2.0 Released– Feb ’03 – S1000D & Functionality Matrix

Update, IETM Subject Matter Expert Meeting, Huntsville

– Jan ’03 – “Look & Feel” Requirements Meeting, Tri-Service Technology Working Group, Tyson

Page 67: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Accomplishments – Cont’d

• Functionality Matrix Support– May ’03 – AECMA Technical Publications Specification

Maintenance Group (TPSMG) Meeting, Clearwater– Feb ’03 – S1000D “Emergency” Look and Feel Meeting

(Change 10), Washington D.C.– Nov ’02 – S1000D Update, TPSMG Exec. 8th Meeting,

Washington D.C.– Oct ’02 – AIA Fall Conference (MOU, Workshops,

Demos), Williamsburg– May ’02 – S1000D Update, TPSMG Meeting, Saint

Louis

Page 68: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Accomplishments – Cont’d

• December 2003 Tyson’s Corner, VA (Tutorial)

• October 2003 Poitier, FR (1st User’s Forum)

• June 20003 Munich, GE• May 2003 Clearwater, FL• January 2003 Turin, Italy• December 2002 Tyson’s Corner,

VA

• November,2002 Wash, DC• November, 2002 Glasgow, UK• October 2002 Williamsburg, VA• September 2002 Berlin, GE• September 2002 Bordeaux, FR• June 2002 Washington, DC• May 2002 St. Louis, MO

S1000D (Meetings)

Page 69: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Accomplishments – Cont’d

• Resulting In Issue 2 Impact:– 12 Change Proposals with Technical Solutions

Submitted and Excepted– Functionality Matrix Incorporated

• Issue 2.X– Training Incorporation– Diagnostics– Look and Feel Finalization

Page 70: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Accomplishments – Cont’d

Since 2000:

AIA Provided Approximately 450 Work-Weeks of Labor and 120 Trips of

Domestic/International Travel

Page 71: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

On-Going Activities• Tri-Service Support

– Will Continue to Provide Technical Expertise Upon Request– Will Continue to Serve as Interface for S1000D Development

• S1000D Development– US-TPSMG– US-EPWG– Change Proposal Forms

• DoD/ADL/AECMA/AIA MOU– To Incorporate Training Requirements Into S1000D

• Functionality Matrix Updates• Look and Feel Finalized• Multimedia and Other Graphic Format Investigations

Page 72: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Overview of Publishing

Tam Malloy

Chair EU Sea WG

[email protected]

Paul Haslam Chair EU Land WG

[email protected]

Jan Roberson

Co-Chair US TPSMG

[email protected]

Page 73: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Areas to be Covered

• This session covers how information will be:– generated – exchanged and – output

• We are also going to attempt to answer some of the questions raised through our last workshop

• We want it to be relaxed and we want to generate discussion

Page 74: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Questions

• What is done with business rules and any associated documents that support them, like program specific data module selections? And how are those put together so the same kind of manual is generated each time the author starts one? The UK MOD has a standard to tell them how to do this, but the rules documents are not available, as far as I could find. I know we have an idea of what this all means, but a practical example would be helpful.

• Go over examples of business rules. Explain how business rules are generated and maintained.

• Explain issues with integrating data modules developed by various vendors (explain how data modules for components can be built independently and lessons learned in the integration process).

• How are the Data Module contents related/linked to weapon system configuration?

Page 75: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Generation

• S1000D provides– Data Module

• Structure• Coding

– Business Rules – Information Sets

• Specific• Example

Page 76: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG One 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 ModuleEvery data

module has this

Page 77: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Applicability

Page 78: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Applicability

• Part of this allows us to “link” the data contained within the content element to the physical

• The <model> element could be used to “tie” the content to a specific configuration, build status, etc

• Notice this links to last question-How are the Data Module contents related/linked to weapon system configuration?

Page 79: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Security

• Security – Data Restrictions

• Information• Copyright• Security Policy

Reference• Special conditions

• Instructions• Distribution• Handling• Destruction• Disclosure

Page 80: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Data Module Code

Model Ident

DataModule

SystemDifference

SNS DC DCV IC ICV ILC

Issue Details

Data Module Address

IDSTATUS

The Data Module

Page 81: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

All of

IDSTATUS

Issue details

DM Address

Security

Applicability

QA Status

One of

CONTENTDescriptive

Procedural

Fault

Crew

IPD

Schedules

ProcessWiring

CSDB

DataModuleData

ModuleDataModuleData

ModuleDataModule

CommonSource

Database

(CSDB)

Page 82: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

ItemLocation

Code

InfoCode

Variant

InfoCode

DisCode

Variant

DisCode

SubjectSubsectSectionChapnumSystem

DiffCode

Modelic

Identify the project (No change to pre-issue 2)

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 LSAR

Last 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

Identifies differences in the function of a system(No change to pre-issue 2)

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

Issue 2 DMC

Issue 2 Data Module Code

First part of the Standard Numbering System (SNS)Now 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

Disassembly CodeNo change in function from pre-

Issue 2

Fixed length at 2 alpha-numeric characters

Disassembly Code VariantSame basic function as pre-Issue 2

Variable length at 1, 2 or 3 alpha-numeric characters

Eg 1 characters for use as in pre-Issue 2, 2 characters to capture the ALC from 1388 2b based LSAR and 3 characters to capture the

Alternate Indenture Product Code from 49506

Information CodeNo functional change from pre-Issue 2

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

XXX as currently definedXXY 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)

Information Code VariantNo functional change from pre-Issue 2

Fixed length at 1 alpha-numeric character

Item Location CodeNo functional change from pre-

Issue 2

Fixed length at 1 alpha-numeric character

Same structure as pre-Issue 2, therefore

maintains backward compatibility

Page 83: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Implementation

• Allocate project name as pre-Issue 2 and register with NAMSA

• Allocate SDC as pre-Issue 2 but can use for example the UOC

• Optionally use a MICC to allow multiple SNS types

Model IdentSystem

DifferenceSNS DC DCV IC ICV ILC

Page 84: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Implementation

• Allocate SNS as pre-Issue 2 but– 8 SNS‘s that are maintained by TPSMG by

CPF– 17 example SNS‘s not maintained– If none fit – write your own!

• Allocate disassembly under the rules for disassembly as pre-Issue 2

Model IdentSystem

DifferenceSNS DC DCV IC ICV ILC

Page 85: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Implementation

• Allocate Disassembly Code Variant as pre-Iss 2 but you can populate it with the ALC or AIPC

• Allocate Information Codes as pre-Iss 2 but with more scope

• Allocate Information Code Variant as pre-Iss 2

• Allocate Item Location Code as pre-Iss 2

Model IdentSystem

DifferenceSNS DC DCV IC ICV ILC

Page 86: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Data Module

IDSTATUS

DM Address

Issue Details

Security

Applicability

QA Status

Content

Procedure

Basic Structure

Interoperability

Page 87: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Integration Issues

• Integration is only a problem if you do not solve it at initial program stages

• Traditionally S1000D has not dealt with this aspect, however!

• Lessons learned from implementation require:– A project infrastructure be created– The next section deals with this

Page 88: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Management – Program Needs

• S1000D deals with data generically• Requirement still exists to establish program

constraints• Dictated by documents detailed within

program:– TDMP– DMP

• DMRL• Business Rules• Illustration guide

Page 89: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Document ManagementPlan

• Detailed plan covering– Scope of Technical Documentation – Coding, Generation and Storage– Data Module Requirements List (DMRL)– Publishing and Distribution– Amendment Process– Programme Management, Quality, Security– Risk Management

Page 90: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Document ManagementPlan

• High level plan detailing documentation requirements for the project– Covers

• Scope of documentation• Security• QA• Programme• Standards

Page 91: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Scope of TechnicalPublications

• Covers the type of information required and its scope and depth– Corrective maintenance– Logical, concise, step-by-step procedures shall be produced for tasks

detailed in the LSAR. Corrective maintenance includes repair, alignment and adjustment. Repair procedures are to contain instructions for removing, replacing and re-assembling defective equipment. Special procedures for removing, replacing and testing PROMs and similar devices are to be detailed. Where the maintenance procedures require several data modules at a given SNS, then the ICV is to be used commencing with alphanumeric characters 1 – 9 then A onwards. The IC 282 shall not be used on ASTUTE

Page 92: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

DMRL

• What is a DMRL– A Data Module Requirements List identifies all

data modules required for a given program– It can detail links to source data (eg LSAR)– It is recommended

Page 93: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

DMRL (cont)

• The DMRL includes:

– The elements of the IDSTATUS section required within it and their definitions

– Uses the SNS and Information Codes as its prime reference

Page 94: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

In the S1000D Context

• S1000D contains rules in the specification and its DTD/Schema

• However,– Areas of the specification are open to

interpretation by projects– The content of elements may be decided by

projects– There is more than one way to mark-up

information using the DTD/Schema

Page 95: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Business Rules

• Business rules are required to:– Provide help, interpretation and guidance in

using S1000D– Remove ambiguity in the specification by giving

examples– Ensure consistency in CSDB deliverables– Highlight to projects where decisions need to be

made

Page 96: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Business Rules

• Each project may need to define its own project specific Business Rules which will cover:– The population of the content of mandatory

elements – How to tailor the content and usage of elements

• Element level• Attribute level

Page 97: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Business Rules

Essential in:

– Managing customer requirements

– Collaborative projects

– Providing a requirement to suppliers

– Avoiding re-work or disputes

Page 98: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Business Rules

• IDSTATUS Elements: Detail how to use the address and status section

and relate the rules to the DTD eg:

– DMC, how to construct and how to mark-up

– Relationship between DMC and DMTITLE

– Issue Date

– Language, etc

Page 99: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Business Rules

<dmtitle>The element <dmtitle> is mandatory for the Type 45. The element comprises technical name <techname> element and information name <infoname> element.The title gives the meaning to the SNS and information code elements of the DMC. To ensure the data modules are generated in a standardised manner, the following rules apply:The <techname> is related to the item identifier, detailed in the Terminology database (Reference 6) and contained within the elements <chapnum>, <section>, <subsect> and <subject> in the DMC.

In this example AE7-70-00 indicates “Internal Telephones”.The <infoname> is the short definition of the element <incode> in the DMC. In this example, “520” indicates “Remove Procedures”.Data module titles are to be entered in Title Case (e.g. “Internal Telephones” rather than “Internal telephones”).Markup example:

<dmtitle><techname>Internal Telephones</techname><infoname>Remove Procedures</infoname></dmtitle>

Example:

Page 100: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Business Rules

Content Section Mark-up

Rules for all data module types– Required conditions– Rules completion of procedural data module,

including mark up– Rules for Descriptive, including rules for primary

paragraphs, sub paragraphs etc.– Rules on use illustrations, tables, lists etc

Page 101: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Partner company business rules

Business Rules

Project Business Rules

S1000DBusiness

Rules

The AECMA business rules are at the core.Eg for RPC record the NCAGE

Project Business Rules:The responsible partner company shall identify itself by: Use of its NCAGE. Company A = K9999. Company B U5647Company C = D3432

Partner Company Business RulesResponsible Partner Company shall contain the company NCAGE

Page 102: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Business RulesSummary

• They are required and projects need to recognise this

• Issue 2 contains many examples where projects can make a choice

• Other choices will be project specific• Business rules are essential for success• Example Business Rules will be available

for Bike Test Pack

Page 103: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Business RulesSummary (cont’d)

Agreed between parties and recorded

– Guide to the different types of data modules and explanation of their purpose

– Covers optional elements– Records population and content of elements– Details the use of specific values in the

configuration file (Svante to explain)– Relates the rules in the specification to the

construct of the DTD/Schema– Contains Authoring guide

Page 104: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Info Set/Publication

• An Information Set defines the scope and depth to meet the requirement (author view)

• A publication is the compilation and publishing of information for a customer (customer view) – Note that a publication can be a subset of or

equal to an info set, but it may also be a superset of several info sets or parts of them

Page 105: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Generic Set

• S1000D information sets were reviewed by each of the working groups and a generic set was agreed that could be used by all three environments

Page 106: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Generic Info 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

Page 107: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Specific Info Setsfor Land and Sea

• Crew/operator descriptive information

• Crew/ operator operation• Crew/ operator sequential operation• Crew/ operator fault detection,

isolation and resolution• International, national and

regulatory scheduled

Page 108: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Crew/Operator OperationInformation

• Land/sea Materiel operation• Land/sea Materiel operation• Operation (physical

breakdown orientated)• Operation (functional

breakdown orientated) • Land/sea Materiel operating

data • Operating under special

conditions• Heat conditions• Cold conditions

• Dust conditions• Recovery or tow away• Crossing of stretch water• NBC conditions• In case of fire at the land/sea

Materiel• Make unserviceable or

destruction of the land/sea materiel

• Emergency procedures• Transportation• Equipment stowing

What does an Information Set look like?

Page 109: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Information Sets

Operation (physical breakdown orientated)

The operation data modules shall include all descriptions necessary to perform the operation of 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-A-YY-YY-YY-YXA-XXXA-A, where value for IC shall be 111, 112, 121, 131, 141 or 151

Note that this is a 17 character code and is not a mandatory length

This defines the scope of the required information

This is how that information is coded on data modules

What information is presented in an information set?

Page 110: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Publications

• List of Applicable Publications• User Reference Guide (or

Operator’s handbook)

– Crew/operator information – Description

– Crew/operator information – Operation

– Crew/operator information – Sequential operation

– Crew/operator information – Fault detection, isolation and resolution

– Crew/operator information – National checks

– Crew/operator information - Maintenance

• Mass and Balance

• Maintenance

– Description

– Maintenance procedures

– Check lists

– Work cards

– Fault detection, isolation and resolution

– Schematic diagrams

– Wiring data

– Cross servicing

– Structure repair

– Non-destructive testing

– Corrosion control

– Illustrated parts data

– Illustrated tools and equipment

– Battle damage repair

Page 111: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Publications

• Maintenance planning– Maintenance requirements– Check lists– Work cards

• Loading and storage– Cargo loading– Weapon loading– Stores loading– Storage

• Operation

– Operation

– Role change

– Recovery• Material data

– Material data sheets

– List of consumables/expendables• Service bulletins

Page 112: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Exchange

• S1000D used to provide the Mil Std 1840 profile

• This process has been replaced:– The transfer “file type” has to be agreed within

the project, and can include:– GZIP, ZIP, TAR, etc

Page 113: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Exchange

• Several types of packages can be transferred within S1000D, however each must have– A Data Dispatch Note (DDN) and at least one of

the following:• One or more data modules and associated

illustrations• One CSDB Status List (CSL)• One Data Module Requirement List (DMRL)• One or more Comment forms (COM)• One or more Publication Modules (PM)

Page 114: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Exchange

• What S1000D mandates is the contained file types and naming conventions

• Example– Data dispatch note (DDN)– CONTROLNUMBER is the data dispatch note identifier in the form:– MI-SSSSS-RRRRR-XXXX-NN_III-WW– MI = model identifier– SSSSS = NCAGE code of sending Agency or Partner Company (A/PC)– RRRRR = NCAGE code of receiving A/PC– XXXX = Year (eg 1999, 2001)– NN = Unique sequential hex interchange number per year starting with

value "00"– III = Issue number– WW = inwork number– DDN-AE-C0419-K0999-2001-02_001-00.SGM

Page 115: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Output

• S1000D has two output mediums:– Page Oriented– IETP (IETD,ITD,IETM etc)– This is probably the area that will have the most

significant input from the US and is currently being developed

Page 116: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Output - Page Oriented

• Page oriented within the specification is detailed in various areas and covers:– Rules for the page layout of standard and oversize pages – Rules for headers and footers are detailed together with basic rules

for paper publications– Rules for all layout elements used to present the SGML/XML

information in the data modules to the S1000D standard– Formatted Output Specification Instances (FOSI), XML Style

Sheets (written in the XML Style Sheet Language) or cascading style sheets

– Examples of S1000D standard presentations of front matter, descriptive, procedural, etc

Page 117: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Output - IETP

• S1000D will provide details of presentation and use, however this is under development

• Various browsers will be shown at the AIA Technology Demonstration and some of these will reflect the S1000D constructs

Page 118: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

IETP Navigation

• There are many methods of IETP navigation currently available. These include but are not limited to:– Table of Contents– Graphical

Page 119: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

IETP Navigation(TOC)

• A breakdown of the equipment based on the system structure

– 00-00-00 Main Equipment• 00 -10 -00 System Level

–00-11-00 Sub System Level

»00-11-10 etc.

Page 120: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

IETP Navigation(Graphical)

• A sequence of figures linked to provide a ‘drill-down’ provides rapid access to data– Rapid access to required data– At each level of drill-down access to

Descriptive, Maintenance, Fault Diagnosis and Parts list information may be given by buttons

Page 121: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Simplified ViewerGraphical User Interface (GUI)

• Interface is clean and simple

• Buttons provided on tool bar for advanced functions

• Menu options also provided

Page 122: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Navigation

• S1000D will define:– Use of Windows– The control pane– Data pane templates– Typographic guidelines– Display of tables– Display of warnings cautions and notes– Display of animation and video– Display of links– Use of colour, etc

Page 123: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Navigation

• The minimum functional Navigation The minimum functional Navigation aids are as follows:aids are as follows:– Frame forward / backward / return to start– Search (simple search) - To start of

module only to avoid possible oversight of Warnings, Cautions or other safety related information

– Mark (with a bookmark)– Retrace (list of previous steps)

Page 124: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Output – The Future

• The following issues are under The following issues are under development:development:– Look and Feel– Navigation– Functionality

Page 125: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Overview of PublishingSummary

• The following issues have been The following issues have been covered:covered:

– The generation of data modules

– The exchange of information

– Output

Page 126: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Questions

Page 127: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

S1000D in a digital worldS1000D in a digital world

Svante Ericsson, Chairman EPWGSörman I&M, Sweden

Page 128: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Session agenda

• Technical concepts, entities and techniques(Svante Ericsson, SI&M)

• S1000D, XML and the web(Peter Zimmermann, EADS)

• S1000D data distribution strategy in perspective(Kathy Rainbolt, US AF)

• S1000D relation to PLCS and Scorm(Ryan Augsburger, CDG)

• What will happen next?(Svante Ericsson)

Page 129: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Concepts, entities and techniques

• The Digital Data objectsData modules, publication modules, data dispatch notes, comments, data module lists (illustrations)

• The Common Source Database (CSDB)• Legacy data• Tailoring• www.s1000d.org

Page 130: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

The Data Module

• From the very beginning S1000D has provided a standard way for represen-tation of technical publications in a digital format– Marked-up using SGML

– A number of DTDs for various types of data modules

– Marked-up using XML

Page 131: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

The Data Module (contd)

• Consists of a number of files– a text file

• Doesn’t contain any layout information

– a number of illustration files

• Contains its meta data– identification– status

This is the content section of a This is the content section of a data module. It contains all the data module. It contains all the

factual information in one specific factual information in one specific respect, applying to a certain respect, applying to a certain

materiel item ……..materiel item ……..

This is the content section of a This is the content section of a data module. It contains all the data module. It contains all the

factual information in one specific factual information in one specific respect, applying to a certain respect, applying to a certain

materiel item ……..materiel item ……..

contentcontent

id & statusid & status

Page 132: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

The Publication Module

• Provides a method to collect data modules into publications

• Hierarchical structures• Configurations• By referencing• A marked-up file (SGML/XML)

Page 133: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

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

Page 134: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

The Data Module List

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

Page 135: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

The Comment

• Used to submit comments between parties in a project

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

Page 136: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

The Illustration

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

PDF

• Can contain hotspots (CGM)• S1000D tries to follow ATA iSpec 2200

Page 137: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

The CSDB

• Is a storage for the various digital objects, in particular the Data Modules incl. their illustrations

• Can be implemented in any thinkable way– It doesn’t have to be a DBMS– It can be any proprietary file system– Usually it is some sort of document

administration tool

Page 138: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Legacy data

• There are a couple of ways of addressing legacy data in accordance with S1000D:– Conversion

– Encapsulation in a data module(as an “illustration”)

– Contained in an publication (referenced by a Publication Module)

Page 139: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Tailoring of S1000D

• An implementation of S1000D can be tailored in many respects– Either of SGML or XML

– Implement a subset of DTDs/Schemas

– Implement a subset of a certain DTD/Schema (!)

– Apply a subset of attribute values (project.cfg)

Page 140: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

• Apart from the specification chapters:• DTD/Schema packages for SGML/XML

(downloadable)• Data dictionaries for all DTDs and

Schemas – on-line and downloadable• More to come ….

www.s1000d.org

Page 141: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Thank you! Thank you!

Page 142: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Page 143: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

S1000D – XML – The WebS1000D – XML – The Web

S1000D TutorialSan Antonio, TX, USA

2004-02-09

Peter Zimmermann (EADS Germany)

Page 144: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Transition to XMLTransition to XML

• First step with Issue 1.9 taken in 2001– New IETP category (XML-oriented)

– CSDB data modules only in SGML

– Transformation to XML for IETP delivery

• Why XML?– Optional SGML features not needed/utilized

– Make CSDB objects usable over the Internet

– More widespread use (not only Tech Pubs)

– Supported by more and cheaper tools

Page 145: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

SGML in Issue 2.0SGML in Issue 2.0

• Retained as CSDB format• All textual information objects in SGML

– Data modules (wiring + process types are new!)

– Publication modules (new!)

– Data dispatch notes

– Comments (new!)

– Data module lists

Page 146: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

XML in Issue 2.0XML in Issue 2.0

• XML DTDs supporting the publication process object types

– Publication modules

– Data dispatch notes

– Comments

– Data module lists

Page 147: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

XML in Issue 2.0 (contd.)XML in Issue 2.0 (contd.)

• XML Schemas supporting all textual objects – Data modules

– Publication modules

– Data dispatch notes

– Comments

– Data module lists

• XML Schemas 2.0 reflect SGML DTDs

Page 148: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

XML in Issue 2.0 (contd.)XML in Issue 2.0 (contd.)

• Arguments for XML Schemas

– Schemas are XML instances (same “language”)

– Data typing possibilities

– Technological trend

• Potentials for S1000D with XML Schemas

– First step in Issue 2.0 taken (1:1 from SGML)

– Incorporation of project business rules

– Reduction of effort for guidance document / project specific style guides

Page 149: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Generation of IETPGeneration of IETP

XML neutral translationCSDB source data + Xlink + RDF/DC:- Translate SGML to XML- Add Xlink attributes- Add RDF/DC metadata

IETP display transformationXML neutral form + IETP generated data:-Apply output transformation (XSLT, XSL-FO)-Resolve URN to URL- Add navigational links- IETP state management

Authored sourceXML or SGML- Data modules- Publication modules

CSDB source data files

IETP EntitiesXML + XLinkxlink:href with URN

IETP neutral

repository

Rendered IETPXML output spec- CSS/XSL- Hyperlinks (URL)- View in web browser

IETP end user display form repository

Page 150: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Resource resolutionResource resolution

• Location independence of S1000D resources– Data modules and publication modules

– Illustrations

– Catalog sequence numbers (references to IPD)

– Comments

• URN Namespace registration: S1000D• Example for a unique data module web address

URN:S1000D:DMC-AE-A-07-00-0000-…

• Resource resolution (URN to URL translation)

Page 151: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

XML NamespacesXML Namespaces

Publication module namespace

<pm xmlns:pm=“http:// xmlns=”http: xmlns:xlink=”http://… xmlns:rdf=”http://… xmlns:dc=”http://…

Data module namespace

<dmodule xmlns:dm=”http:// xmlns:xlink=”http://… xmlns:rdf=”http://… xmlns:dc=”http://…

XLink namespace

<refdm xmlns:xlink=”http://… xmlns:rdf=”http://… xmlns:dc=”http://…

RDF and DC namespace

xmlns:rdf=”http://…” xmlns:dc=”http://…”

Page 152: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

XML Namespaces (contd.)XML Namespaces (contd.)

ddn http://www.s1000d.org/ddn

dml http://www.s1000d.org/dml

comment http://www.s1000d.org/comment

Page 153: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Link transformation exampleLink transformation example

Reference to another data module

Page 154: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

refdm – SGML CSDBrefdm – SGML CSDB

<refdm><avee><modelic>AE</modelic><sdc>A</sdc><chapnum>07</chapnum><section>0</section><subsect>7</subsect><subject>0400</subject><discode>00</discode><discodev>A</

discodev><incode>040</incode><incodev>A</incodev><itemloc>A</itemloc></avee></refdm>

Page 155: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

refdm – XML Repositoryrefdm – XML Repository

<refdmxlink:type="simple"xlink:actuate="onRequest"xlink:show="replace"xlink:title="IETP resource resolution"xlink:href="URN:S1000D:DMC-AE-A-07-07-0400-00A-040A-A"><avee><modelic>AE</modelic><sdc>A</sdc><chapnum>07</chapnum><section>0</section><subsect>7</subsect><subject>0400</subject><discode>00</discode><discodev>A</discodev><incode>040</incode><incodev>A</incodev><itemloc>A</itemloc></avee></refdm>

Page 156: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

refdm – HTML displayrefdm – HTML display

<a href="http://www.s1000d.org/

DMC-AE-A-07-07-0400-00A-040A-A.XML">

AE-A-07-07-0400-00A-040A-A</a>

Page 157: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Questions?Questions?

Peter Zimmermann

EADS Military AircraftD-81663 Munich / GermanyPhone: +49-89-607-21738

Fax: +49-89-607-21875Email: [email protected]

Thanks for your attentionThanks for your attention

Page 158: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

What is ADL?

• Advanced Distributed Learning• DoD initiative • Purpose: “Ensure access to high-quality

education and training materials that can be tailored to individual learner needs and made available whenever and wherever they are required.”

Page 159: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

What is SCORM?

• Shareable Content Object Reference Model• Suite of Standards

– Defines Content Aggregation Model – Defines Run Time Environment

• SCORM defines meta-data to describe reusable content objects

• SCORM does not define structure of training content objects (ala S1000D DTD)

Page 160: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Content Aggregation

• Assets are aggregated into Shareable Content Objects which are sequenced and structured into packages that meet specific learning objectives.

AssetWAV

AssetHTML

Fragment

AssetGIF

AssetXML

Doc

AssetJavaScript

Functions

AssetFlash

Object

AssetJPEG

SCO content.htmApi=getAPI();Var result = api.LMSInitialize(“”);Var val = api.LMSGetValue(cmi.abc.xyz”);

Var result = api.LMSFinish(“”);

CSF SCO

SCO

SCO

SCO

SCO

SCO

SCO

Tagged Content Aggregation

Meta-data

Meta-data

Meta-data

Meta-data

Meta-data

Page 161: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

S1000D / ADL / AIA MOU

• Memorandum of Understanding between S1000D, ADL, and AIA– In signature cycle– “The Parties wish to co-ordinate their

activities to develop an integrated approach to development and distribution of learning and technical data/information.”

Page 162: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

S1000D / ADL / AIA MOUBenefits

• Position work with respect to other groups• Minimize duplication of effort & unintended

differences• Minimise effort in preparing future Tech Pub

and Training objects by improving alignment of technical data with SCORM.

• Develop standardized linkage between tech data modules and learning information objects

• Assist the ADL to achieve the Training Transformation Initiative

Page 163: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

S1000D / PLCS

• What is PLCS?– Product Life Cycle Support– Extension to STEP (ISO 10303-239)

• STEP is traditionally focused on engineering and manufacturing

• PLCS extends STEP to the maintained fleet

– Organized by product structure– Model includes maintenance data as well as

operational data

Page 164: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

S1000D / PLCS

• Four pillars of PLCS– Configuration Management

• As-maintained Bill of Material• Enhanced master records center/database

– Maintenance and Feedback• Management and execution of maintenance tasks• Maintenance Feedback / Records• Maintenance history• Configuration changes

– Support Engineering• Logistical Support Analysis• Reliability Centered Maintenance• Maintenance Tech pubs and service bulletins

– Resource Management• Supply Chain, Spares• People, skills, tools, facilities

Page 165: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

S1000D / PLCS

• Memorandum of Understanding between S1000D and PLCS– Dated 2002-04-29– Established framework of cooperation– Agreed initial work plan– Potential future work

Page 166: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

S1000D / PLCS

• Agreed Initial Work Plan (verbatim)– Initial agreed work program under the Memorandum of Understanding between

PLCS and S1000D.– PLCS will review AECMA 1000D Change 9 to:

• Identify potential gaps in PLCS Requirements• Identify a set of PLCS Ref Data which is consistent with S1000D

– The Parties will co-operate in developing a process diagram illustrating how the S1000D process would interact with the PLCS Application Activity Model.

– PLCS will offer the Data Modules Requirement Statements for Task & Resource and Document Modules for review by S1000D participants.

– S1000D will identify volunteer(s) to work with PLCS to develop a common set of requirements for effectivity/applicability management.

– S1000D participants will seek to identify and release compliant sample Data Modules from S1000D for use in testing PLCS.

– PLCS will investigate and advise how the S1000D Data Module Code breakdown could best be represented in PLCS and to develop appropriate Reference Data.

– The Parties will meet to plan a joint campaign to promote awareness of this co-operation and its potential benefits to both communities.

Page 167: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

S1000D / PLCS

• S1000D and PLCS will be able to peacefully co-exist– PLCS will be able to provide the baseline for

writing instruction DMs – PLCS will be able to provide configuration

data for use in applicability/effectivity – PLCS will be able to interpret S1000D Data

Module ID and Status section

Page 168: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Overview

• What is a publication?– Linear– IETM– S1000D

• Data Distribution Concepts• Summary

Page 169: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Tech Data Structures

A weapon system using linear electronic tech pubs (eg 38784)…

All Pubs for the materiel

Descriptive Information

Procedural Information

Operator Manual

LOAPs

Fault Isolation Procedures

Etc.

Illustrated Parts Data

Each pub is a separate, individually configurable object

Their primary relationship to each other is that they are associated with the same materiel

Linear tech pubs do not require the use of a DB or a logic engine

Page 170: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Tech Data StructuresA weapon system using an 87269 IETM…

A single 87269 IETM DB contains all* the technical data associated with the materiel

(*with exception of externally referenced data)

The entire IETM DB is the smallest* configurable object

(*with exception of graphic objects)

The logic and presentation engines are separate from the data Presentation Engine

Logic Engine

Descriptive InformationProcedural Information Illustrated Parts Data

Fault Isolation ProceduresOperator Manuals

LOAPs etc.

Page 171: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Tech Data Structures

A weapon system using S1000D…Common Source Data Base (CSDB) contains all the technical data associated with the materiel as individual data modules

The Data Module is the smallest configurable object allowed by the spec

The logic and presentation engines are separate from the data

Presentation Engine

Logic Engine

A pub is a collection of Data Modules

Page 172: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Linear Distribution ConceptETM or Linear Electronic Tech Data Example:

This is meant to represent the concept of distributing electronic TO content to an end user (not Paper). It is not meant to represent an actual architectural view.

All Pubs for the materiel

Descriptive Information

Procedural Information

Operator Manual

LOAPs

Fault Isolation Procedures

Etc.

Illustrated Parts Data

Repository User eTool

Linear P

ub(eg 38784)

S1000D

(w/out Process D

ata M

odule)

Entire CSDBCSDB sub-set

Individual Pubs

TO–2B

TO-1A

Newly Requested Pubs

TO-3C

TO–4D

Newly Requested Pubs Modules

Procedural Information

Fault Isolation ProceduresTO–4D

TO-3C

Page 173: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Linear Distribution ConceptETM or Linear Electronic Tech Data Change Example:

This is meant to represent the concept of distributing electronic TO content to an end user (not Paper). It is not meant to represent an actual architectural view.

All TOs for the materiel

Descriptive Information

Procedural Information

Operator Manual

LOAPs

Fault Isolation Procedures

Etc.

Illustrated Parts Data

Repository User eTool

Entire CSDBCSDB sub-set

TO–4D

TO-3C

Individual Pubs

TO–2B

TO-1A

Operator Manual

Illustrated Parts Data

TO–2B

TO-1A

Changed data

TO–2B – change 001

TO-1A – change 001

Linear P

ub(eg 38784)

S1000D

(w/out Process D

ata M

odule)

Page 174: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

IETM Distribution ConceptIETM or Non-Linear Tech Data Example:

Repository User eTool

Entire IETM DB Entire IETM DB

87269

S1000D

(w/ Process D

ata M

odule)

This is meant to represent the concept of distributing IETM TO content to an end user. It is not meant to represent an actual architectural view.

CSDB sub-setEntire CSDB

Newly Requested Pubs Modules

Entire IETM DBEntire IETM DB

No standard for distributing IETM

sub-sets

Page 175: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

IETM Distribution ConceptIETM or Non-Linear Tech Data Change Example:

Repository User eTool

Entire IETM DB Entire IETM DB

87269

This is meant to represent the concept of distributing IETM TO content to an end user. It is not meant to represent an actual architectural view.

CSDB sub-setEntire CSDB

Changed data

Changed dataChanged data

No standard for distributing

IETM sub-set changes

Entire IETM DB Entire IETM DB

S1000D

(w/ Process D

ata M

odule)

Page 176: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Summary

• S1000D has discrete data modules with well-defined metadata

• This allows for more granular configuration management

• This enables the development of architectures and support process that can handle linear and non-linear data in a consistent and standard manner

Page 177: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

What will happen next? What will happen next?

Svante Ericsson, Chairman EPWGSörman I&M, Sweden

Page 178: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Ongoing development

To pick some:• Consolidated use of XML• Support of multimedia objects• Mechanism for formalized exchange of

business rules• Interactivity further developed

(US EPWG meeting Tuesday!)• Enrichment of online data dictionaries

Page 179: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG

Thanks again!Thanks again!

Questions?Questions?

Page 180: © 2003 TPSMG S1000D Tutorial Compressed introduction to the Spec AIA/Tri-Service 2004 Publications Workshop San Antonio, TX 2004-02-09.

© 2003 TPSMG