Applicability Boot CampPart 3 – The CCT Data Module

Michael CookLead S1000D Business AnalystLead S1000D Business Analyst

Michael DavisP i i l B i C lt tPrincipal Business Consultant

Thank You for Joining Us!

S1000D in person… Across the USA: S1000D “Ask An S1000D Expert” Tour Last event this year! Location: Washington, DC – November 15th, 2011

Smithsonian Air and Space Museump Register at www.sdl.com/S1000DTour Please contact AskAnS1000DExpert@sdl.com to request an

“Ask an S1000D Expert” event near you!Ask an S1000D Expert event near you!

2012 Webinar Series Back to Basics! Back to Basics! Kicking off late January Watch your email for announcements!

2

What topics would you like to see covered in 2012? Email us at AskAnS1000DExpert@sdl.com

S1000D: Recorded Events

SDL S1000D Webinar Series RecordingsgIntroduction to S1000D ConceptsS1000D Content WorkflowS1000D ApplicabilityS1000D and IETPsS1000D and MultimediaS1000D and MultimediaS1000D Business Rules Webinar SeriesS1000D Applicability Boot Camp Series

3

pp y pwww.sdl.com/S1000DResources

Abstract

The intent of this webinar is to:Explore the basics of Applicability for Issue 4.0.1 of the S1000D specification with a focus on the Conditions Cross-reference Table (CCT) data module.

Focus audience:This session is for anyone new to S1000D or who wants to know more about applicability data modules.Experts or people who are new to the S1000D methodology willExperts or people who are new to the S1000D methodology will find helpful information regarding content customization and conditional content presentation using a structured method.

Primary knowledge transfer points:Primary knowledge transfer points:Basics of the Conditions Cross-reference Table (CCT) data moduleWhat the conditions schema supports

4

What the conditions schema supportsWhat to avoid when using the CCT data module

CCT – what it’s for

Isolating unique environmental conditions (temperature, pressure, voltages, system states, etc)Isolating or identifying engineering changes to a product after it is released from manufacturing and delivered to a customer (product updates or installation of product custo e (p oduct updates o sta at o o p oductaftermarket add-ons/options)Increases recyclability of informationIncreases flexibility of authoring, maintaining, publishing, and distributing publications and using them in an interactive electronic technical publication

5

Questions

6

At the highest level

ACT PCT Product Cross-reference Table

Domain of the Configuration Manager

ACT PCT

CCT

Product Cross reference Table

Conditions Cross-reference TableCCT

Applicability DMs

Conditions Cross reference TableInferred relationship

Project DMs and PMs

DMs PMs All data modules and publication modules have a reference in their <identAndStatusSection>

ICNs ICNs inherit the applicability of the data modules that

a reference in their <identAndStatusSection> element blocks to the ACT data module

7

of the data modules that reference them

Domain of Technical Writers

Referencing the CCT data module

ALL data modules and publication modules in a project must reference the ACT data module in order to gain access to the CCT data module To do so a reference point is provided inCCT data module. To do so, a reference point is provided in the <identAndStatusSection> element.Example:

<applicCrossRefTableRef> <dmRef xlink:actuate="onRequest" xlink:href="URN:S1000D:DMC-S1000DBIKE-AAA-D00-00-00-00AA-00WA-D" xlink:show="replace" xlink:type="simple"> <dmRefIdent> <dmCode modelIdentCode="S1000DBIKE" systemDiffCode="AAA" systemCode="D00" subSystemCode="0" y y y subSubSystemCode="0" assyCode="00" disassyCode="00" disassyCodeVariant="AA" infoCode="00W" infoCodeVariant="A" itemLocationCode="D"/> </dmRefIdent> </dmRef> </applicCrossRefTableRef>

A common DMC for an ACT file is:DMC-<modelid>-A-00-00-00-00A-00WA-D 001-00.XML

8

DMC modelid A 00 00 00 00A 00WA D_001 00.XML

How the ACT references the PCT and CCT

At the bottom of the ACT data module is a section for referencing the PCT and CCT data modules.Example:

<condCrossRefTableRef> <dmRef xlink:actuate="onRequest" xlink:href="URN:S1000D:DMC-S1000DBIKE-AAA-D00-00- 00-00AA-00QA-D" xlink:show="replace" xlink:type="simple">

<dmRefIdent> <dmRefIdent> <dmCode modelIdentCode="S1000DBIKE" systemDiffCode="AAA" systemCode="D00" subSubSystemCode="0" subSystemCode="0" assyCode="00" disassyCode="00" disassyCodeVariant="AA" infoCode="00Q" infoCodeVariant="A" itemLocationCode="D" /> </dmRefIdent> </dmRef> </condCrossRefTableRef> <productCrossRefTableRef> <dmRef xlink:actuate="onRequest" xlink:href="URN:S1000D:DMC-S1000DBIKE-AAA-D00-00-00-00AA-00PA-D" xlink:show="replace" xlink:type="simple"> <dmRefIdent>

<dmCode modelIdentCode="S1000DBIKE" systemDiffCode="AAA" systemCode="D00" subSystemCode="0" <dmCode modelIdentCode= S1000DBIKE systemDiffCode= AAA systemCode= D00 subSystemCode= 0 subSubSystemCode="0" assyCode="00" disassyCode="00" disassyCodeVariant="AA" infoCode="00P" infoCodeVariant="A" itemLocationCode="D"/> </dmRefIdent> </dmRef> </productCrossRefTableRef>

9

p

CCT structure

Nothing in the CCT is defined in the ACT (other than a reference in the ACT points to the CCT data module)Must contain at least one condition typeMust contain at least one condition typeIs somewhat difficult to understand due to interdependencies between conditions and condition typesContains two basic element structures. Examples:

<condTypeList> <condType id="SB"> <name>Service Bulletin</name>

<condList> <cond id="SB-S001" condTypeRefId="SB"> <name>Service bulletin S001 - Chain guard</name>

<descr>Service bulletin S001 for the installation of the chain guard</descr> <descr>Generic service bulletin type</descr> <enumeration applicPropertyValues="Pre|Post"/> </condType> <condType id="TMP"> <name>Temperature</name> <descr>Temperature Fahrenheit</descr>

<descr>Service bulletin S001 for the installation of the chain guard</descr> <refs> <pmRef> <pmRefIdent> <pmCode modelIdentCode="S1000DBIKE" pmIssuer="SAMPL" pmNumber="00040" pmVolume="01"/> </pmRefIdent> p

<enumeration applicPropertyValues="32|212"/> </condType> <condType id="TP"> <name>Tire Pressure</name> <descr>TirePressure PSI</descr> <enumeration applicPropertyValues="Low|High"/>

p </pmRef> </refs> </cond> <cond id="TMP-001" condTypeRefId="TMP"> <name>Environmental Temperature</name> <descr>Temperature of the Work Area</descr>

</cond>

10

pp p y | g </condType> </condTypeList>

</cond> <cond id="TP-001" condTypeRefId="TP"> <name>Tire Check</name> <descr>Verification of Tire Pressure</descr> </cond> </condList>

CCT structure (cont’d)

Holds definitions of “condition types” and a list of “conditions” with dependencies on the condition types (things which have conditional dependencies or can be(things which have conditional dependencies or can be used as conditional decision points within data modules)Has a reference to the <applicCrossRefTableRef> in the <identAndStatusSection> element<identAndStatusSection> elementShould be updated whenever a service bulletin, product recall, engineering change, or new environmental value is id tifi d i i d t f t t lidentified or is required as part of a test valueShould be re-released only as needed (but no more than once a month)Re-releasing more often than once a month may cause a problem with the “issue” number. There are enough issue numbers to last for 83 years and 3 months if released once

11

a month.

Conditions <cond> element

Is the central source for all condition threshold definitionsShould indicate all engineering changes created for an i t f d li d d t i b ll ti llinstance of a delivered product as service bulletins, recall notices, safety updates, customer originated changes, etcShould identify all environmental condition values used by y ythe project (temperature, pressure, voltage, current, etc)If conditional applicability is not used by a project – based on a business rule decision the CCT data module does noton a business rule decision - the CCT data module does not need to be createdUpdates to the CCT should be managed by one individual, most commonly a configuration manager or possibly an engineer in charge of product design updates

12

Condition Types <condType>

Defined and stored in the <content> section, within the <conditionTypeList> element block. Example:

<condTypeList> <condType id="SB"> <name>Service Bulletin</name>

<descr>Generic service bulletin type</descr> <descr>Generic service bulletin type</descr> <enumeration applicPropertyValues="Pre|Post"/> </condType> <condType id="TMP"> <name>Temperature</name> <descr>Temperature Fahrenheit</descr> <enumeration applicPropertyValues="32|212"/> </condType> <condType id="TP">

<name>Tire Pressure</name> name Tire Pressure /name <descr>TirePressure PSI</descr> <enumeration applicPropertyValues="28|40"/> </condType> </condTypeList>

13

Conditions <cond>

Exposed conditions are defined in the <condList> element block.

<condList><condList> <cond id="SB-S001" condTypeRefId="SB"> <name>Service bulletin S001 - Chain guard</name> <descr>Service bulletin S001 for the installation of the chain guard</descr> <refs>

<pmRef> <pmRef> <pmRefIdent> <pmCode modelIdentCode="S1000DBIKE" pmIssuer="SAMPL" pmNumber="00040" pmVolume="01"/> </pmRefIdent> </pmRef>

</refs> </refs> </cond> <cond id="TMP-001" condTypeRefId="TMP"> <name>Environmental Tempurature</name> <descr>Temperature of the Work Area</descr>

</cond> </cond> <cond id="TP-001" condTypeRefId="TP"> <name>Tire Check</name> <descr>Verification of Tire Pressure</descr></cond> </condList>

14

Conditions Cross-reference Table (CCT)

The CCT should only hold conditions – the “type” and “definitions” of the condition instances dependent on the type (aka thresholds)Conditions defined in the CCT should be measurable and have definitive thresholds which can be quantified and tested forThe CCT is a list of environmental conditions and post customer delivery engineering changesdelivery engineering changesEven though a condition may be testable and have legitimate thresholds, it may not be possible to test for those conditions using stored XML information or digital data provided by the product For example theinformation or digital data provided by the product. For example, the implementation/incorporation of a service bulletin may require a visual inspection by a service technician to identify whether or not the configuration changes applied through the implementation of a service b ll ti li d K i h th t fi ti h ibulletin were applied. Knowing whether or not a configuration change is applied requires updating the <incorporationStatus> of the engineering change.

15

CCT dependencies

No dependencies on the ACT data moduleThe CCT is a self contained conditions reference data moduleIf <incorporation> (and child element <documentIncorporation>) is used, there is a dependency on the PCT data module for applicability information to be posted into the

<incorporation> <condIncorporation condRefId="SB-S001">

<documentIncorporation>

<referencedApplicGroup> element (what and when)

<documentIncorporation> <refs> <pmRef> <pmRefIdent> <pmCode modelIdentCode="S1000DBIKE" pmIssuer="SAMPL" pmNumber="00040" pmVolume="01"/>

</pmRefIdent> </pmRefIdent> </pmRef> </refs> <incorporationStatus incorporationStatus="incorporated" day="31" month="07" year="2007" applicRefId="A-1"/> </documentIncorporation> </condIncorporation>

16

</condIncorporation> </incorporation>

Defining an assert in a data module

The following XML markup can be found in a typical data module’s<identAndStatusSection> element blockApplicability used within the <content> element block must referenceApplicability used within the <content> element block must reference <applic> statements defined in the <referencedApplicGroup> element using the attribute applicRefIdThe following example identifies a mutually exclusive configuration oneThe following example identifies a mutually exclusive configuration, one which is PRE and the other which is POST.

<referencedApplicGroup> <applic id="app-0001">

<displayText> <displayText> <simplePara>Service Bulletin S001 – New chain guard NOT applied</simplePara> </displayText> <assert applicPropertyIdent="SB-S001" applicPropertyType="condition" applicPropertyValues="Pre"/> </applic>

<applic id="app 0002"> <applic id= app-0002 > <displayText> <simplePara>Service Bulletin S001 – New chain guard IS applied</simplePara> </displayText> <assert applicPropertyIdent="SB-S001" applicPropertyType="condition" applicPropertyValues="Post"/>

</applic>

17

</applic> </referencedApplicGroup>

<condList> element

The <condList> is used to associate exposed conditions with condition thresholds defined in the <condTypeList>Condition types define measurable environmental values or testable thresholdsC diti t dd d t th dLi t f d t l ith ifi th h ld fCondition types added to the <condList> are fundamentals with specific thresholds – for example, the temperature of water or a value at which some chemical changes state (turns from red to blue, becomes a solid, etc) may be crucial in testing or in determining what must be done as part of a procedure (and whether or not the procedure can be performed)For example water freezes at 32 degrees Fahrenheit (or 0 degrees Celsius) and boils at 212For example, water freezes at 32 degrees Fahrenheit (or 0 degrees Celsius) and boils at 212 degrees Fahrenheit (or 100 degrees Celsius). This can be translated into “condition type” values and become the set points for a specific condition. For example:

<condType id="tmp-002"> <name>TemperatureF</name>p <descr>Used for identifying freezing or boiling in Fahrenheit</descr> <enumeration applicPropertyValues="32"/> <enumeration applicPropertyValues="212"/> </condType>

<condType id="tmp-004"> condType id tmp 004 <name>TemperatureC</name> <descr>Used for identifying freezing or boiling in Celsius</descr> <enumeration applicPropertyValues="0"/> <enumeration applicPropertyValues="100"/>

</condType>

18

</condType>

<cond> element

A <cond> element references condition types defined using a <condType> elementNote: Exposed conditions must reference a condition type – this is what creates a reusable condition type and a testable threshold value or value set

<condType id="tmp_002"> <name>TemperatureF</name>

<d >U d f id tif i f i b ili i F h h it</d > <descr>Used for identifying freezing or boiling in Fahrenheit</descr> <enumeration applicPropertyValues="32"/> <enumeration applicPropertyValues="212"/> </condType> <condType id="tmp_004"> <name>TemperatureC</name> <descr>Used for identifying freezing or boiling in Celsius</descr>

<cond id="temperatureF" condTypeRefId="tmp_002"> <name>Water thresholds in F</name>

<enumeration applicPropertyValues="0"/> <enumeration applicPropertyValues="100"/> </condType>

<displayName>Water temperature thresholds for Fahrenheit</displayName> <descr>Temperature at the point where water either freezes or boils in Fahrenheit</descr> </cond> <cond id="temperatureC" condTypeRefId="tmp_004"> <name>Water thresholds in C</name>

<displayName>Water temperature thresholds for Celsius</displayName>

19

<displayName>Water temperature thresholds for Celsius</displayName> <descr>Temperature at the point where water either freezes or boils in Celsius</descr> </cond>

Service bulletins, recalls, safety updates

Service bulletins are Publications!Service bulletins, if re-issued, can create significant complexity in the use of applicability markupProduct instance applicability, mixed with service bulletin applicability creates the most complex applicability to resolveResolving service bulletin “pre” and “post” conditions can be confusing – but is relatively simple. Example:

<condType id="ctd_001"> <name>Change paper</name> <descr>Used for configuration change paper (Service Bulletin, Mod, TCO, etc).</descr> <enumeration applicPropertyValues="PRE"/> <enumeration applicPropertyValues="POST-01~POST-05"/>

</condType> /condType – or – <condType id="ctd_001"> <name>Change paper</name> <descr>Used for configuration change paper (Service Bulletin, Mod, TCO, etc).</descr>

<enumeration applicPropertyValues="PRE|POST 01 POST 05"/>

20

<enumeration applicPropertyValues="PRE|POST-01~POST-05"/> </condType>

PRE and POST – how does it work?

You can think of PRE as the configuration of a product PRIOR to the implementation of an engineering change to an instance of a productYou can think of POST as the configuration of a product AFTER a service bulletin is applied (the configuration is a se ce bu et s app ed (t e co gu at o snow new/revised and matches that called out in the Service Bulletin)Subsequent releases of a service bulletin (issue 2 3 4 etc)Subsequent releases of a service bulletin (issue 2, 3, 4, etc) are now the pre releases of the service bulletins that follow that re-issue. If your company does not re-issue service bulletins, then you have no need for multiple posts of a service bulletin configuration.

21

g

Knowing the product is pre or post

Visual inspection for current configurationEvaluating the <incorporation> entries Requires updating the information for each instance of a product where the service bulletin q p g p

was applied. Is managed using PCT data within the CCT <referencedApplicGroup> element and applying

that information to the applicRefId attribute of the given <incorporationStatus> element. Usually requires using the <pmRefIdent> from the <cond> block and the

<documentIncorporation> block<documentIncorporation> block.Keep a separate record of the incorporation of service bulletin information in a database or ledger book

<incorporation>incorporation <condIncorporation condRefId="SB-S001"> <documentIncorporation> <refs> <pmRef>

<pmRefIdent> <pmRefIdent> <pmCode modelIdentCode="S1000DBIKE" pmIssuer="SAMPL" pmNumber="00040" pmVolume="01"/> </pmRefIdent> </pmRef> </refs>

<incorporationStatus incorporationStatus="incorporated" day="31" month="07" year="2007" applicRefId="A 1"/>

22

<incorporationStatus incorporationStatus= incorporated day= 31 month= 07 year= 2007 applicRefId= A-1 /> </documentIncorporation> </condIncorporation> </incorporation>

Example of applicability in a DM

<referencedApplicGroup> <applic id="APPLIC-0006"> <!-- If temperatue is below freezing -->

<assert applicPropertyIdent="temperatureF" applicPropertyType="condition" <assert applicPropertyIdent= temperatureF applicPropertyType= condition applicPropertyValues="-300~32"/> </applic> <applic id="APPLIC-0005"> <!-- If temperatue is above freezing (the likelihood of working in an environment for humans above 130 degrees is unlikely, so no need to provide a third applicability statement) -->

t li P t Id t "t t F" li P t T " diti " <assert applicPropertyIdent="temperatureF" applicPropertyType="condition" applicPropertyValues="33~212"/> </applic> <applic id="APPLIC-0007"> <!-- If R22 pressure is normal --> <assert applicPropertyIdent="R22PressureHighSide" applicPropertyType="condition" applicPropertyValues="50~180"/>pp p y g pp p y yp pp p y </applic> <applic id="APPLIC-0008"> <!-- If R22 pressure is low --> <assert applicPropertyIdent="R22PressureHighSide" applicPropertyType="condition" applicPropertyValues="0~49"/> </applic>

<applic id="APPLIC-0009"> <applic id APPLIC 0009 > <!-- If R22 pressure is high --> <assert applicPropertyIdent="R22PressureHighSide" applicPropertyType="condition" applicPropertyValues="181~500"/> </applic>

23

Example of applicability in a DM (cont’d)

<applic id="APPLIC-0001"> <assert applicPropertyIdent="prodno" applicPropertyType="prodattr" applicPropertyValues="25"/>

</applic> </applic> <applic id="APPLIC-0002"> <assert applicPropertyIdent="prodno" applicPropertyType="prodattr" applicPropertyValues="1~24"/> </applic> <applic id="APPLIC-0003"> <evaluate andOr="or"> <assert applicPropertyIdent="prodno" applicPropertyType="prodattr" applicPropertyValues="8"/> <assert applicPropertyIdent="prodno" applicPropertyType="prodattr" applicPropertyValues="10~17"/> <assert applicPropertyIdent="prodno" applicPropertyType="prodattr" applicPropertyValues="19"/> <assert applicPropertyIdent="prodno" applicPropertyType="prodattr" applicPropertyValues="21"/> <assert applicPropertyIdent="prodno" applicPropertyType="prodattr" applicPropertyValues="23"/>

<assert applicPropertyIdent="prodno" applicPropertyType="prodattr" applicPropertyValues="24"/> <assert applicPropertyIdent prodno applicPropertyType prodattr applicPropertyValues 24 /> </evaluate> </applic> <applic id="APPLIC-0004"> <evaluate andOr="or"> <assert applicPropertyIdent="prodno" applicPropertyType="prodattr" applicPropertyValues="1~7"/>

t li P t Id t " d " li P t T " d tt " li P t V l "9"/ <assert applicPropertyIdent="prodno" applicPropertyType="prodattr" applicPropertyValues="9"/> <assert applicPropertyIdent="prodno" applicPropertyType="prodattr" applicPropertyValues="18"/> <assert applicPropertyIdent="prodno" applicPropertyType="prodattr" applicPropertyValues="20"/> <assert applicPropertyIdent="prodno" applicPropertyType="prodattr" applicPropertyValues="22"/> </evaluate>

</applic>

24

/applic </referencedApplicGroup>

Configuration Management (critical)

Configuration management is a crucial piece of the applicability equation. Without a configuration manager -someone who maintains the ACT and PCT data modules -applicability cannot work. An equivalent individual – a change engineer – needs to work with the configuration manager to manage the CCT.Configuration managers must work with management to keep track of what is coming off the assembly line andkeep track of what is coming off the assembly line and identify which instances of product require service bulletin updates or product recall notices

25

Demonstration of CCT applicability

Mike DavisMike DavisPrincipal Business Consultant

26

27