September 21-23, 2015

Applicability – S1000D Issue 4.1

1

S1000D Issue 4.1 Applicability

Mary McCarthySenior Information AnalystEPS Corporation – Information Management Solutions

Applicability – S1000D Issue 4.1

Issue 4.1 introduced new functionalities related to Applicability:

Value Data Types

Primary and Secondary Keys

Enumeration Labels

Applicability Cross Reference Table Catalog

2September 21-23, 2015

Value Data Types

Prior to issue 4.1, attributes are interpreted as strings. Supporting numeric-based ranges was problematic.

Example, 0-padding:<enumeration applicPropertyValues="001~100">

Signed numeric-based (range) assertions not possible: The “+” character precedes “-” lexicographically.

Specifying values unnatural, non-intuitive.

3

Applicability – S1000D Issue 4.1

September 21-23, 2015

September 21-23, 2015

Applicability – S1000D Issue 4.1

Value Data Types (Cont.)

Issue 4.1 supports valueDataType attribute on <productAttribute> and <condType> to designate applicability attribute data type: boolean

string (default) real

integer

Example:<condType id="Voltage" valueDataType="real">

<enumeration applicPropertyValues="-99.99~+99.99"/>

</condType>

4

Value Data Types (Cont.)

Data typing allows checking during authoring and prompting:

<applic><evaluate andOr=“and"><assert applicPropertyIdent="integerAttr" applicPropertyType="prodattr"

applicPropertyValues="2"/><assert applicPropertyIdent="realAttr" applicPropertyType="condition"

applicPropertyValues="-9.0"/><assert applicPropertyIdent="booleanAttr" applicPropertyType="condition"

applicPropertyValues="true"/></evaluate></applic>

5

Applicability – S1000D Issue 4.1

September 21-23, 2015

Primary and Secondary Keys

Pre-Issue 4.1, there was no way to indicate which attribute uniquely identifies a product (aka product key):

ACT<productAttribute id="serialno"><name>Serial number</name>…

</productAttribute><productAttribute id="model"><name>Model</name>…

</productAttribute>

PCT<product><assign applicPropertyIdent="serialno"

applicPropertyValue="1B070643"/><assign applicPropertyIdent="model"

applicPropertyValue="Brook trekker"/>…

</product><product><assign applicPropertyIdent="serialno"

applicPropertyValue="1B070701"/><assign applicPropertyIdent="model"

applicPropertyValue="Mountain storm"/>…

</product>

Non-standard conventions required to identify key. For example, first assigned attribute of a <product>.

6

Applicability – S1000D Issue 4.1

September 21-23, 2015

September 21-23, 2015

Applicability – S1000D Issue 4.1

7

Primary and Secondary Keys (Cont.)

Issue 4.1 ACT supports optional attribute “productIdentifier” on <productAttribute>: "primary" – Must be assigned for each product in the PCT.

"secondary" –Optional, but still must be unique for each product.

"no" – (Default) Non-identifying product attribute.

<productAttribute id="serialno" productIdentifier="primary"><name>Serial number</name>…

</productAttribute><productAttribute id="model">

<name>Model</name>….

</productAttribute>

Primary and Secondary Keys (Cont.)

Example: A bike is identified by serial number (serialno) and optional Federal Cyclery Administration Number (FCA):

ACT<productAttribute id="serialno“

productIdentifier="primary"><name>Serial number</name>

</productAttribute>

<productAttribute id="FCA“productIdentifier="secondary">

<name>Federal Cyclery AdministrationNumber</name>

</productAttribute>

PCT<product><assign applicPropertyIdent="serialno“

applicPropertyValue="1B070643"/><assign applicPropertyIdent="FCA“

applicPropertyValue="FCA-1"/>…

</product><product><assign applicPropertyIdent="serialno"

applicPropertyValue="1B070701"/>…

</product>

8

Applicability – S1000D Issue 4.1

September 21-23, 2015

Primary and Secondary Keys (Cont.)

.

9

Applicability – S1000D Issue 4.1

September 21-23, 2015

Primary Key Selection Secondary Key Selection

Enumeration Labels

By using the enumerationLabel attribute on <enumeration>, a more human-friendly display label can be associated for a value.

If used, the applicPropertyValues attribute cannot specify a range (applicPropertyValues="01~10") or list (applicPropertyValues="C|D") of values. In order to define a labels for multiple enumerated values, a series

of <enumeration> tags with single values should be authored.

10

Applicability – S1000D Issue 4.1

September 21-23, 2015

Enumeration Labels (Cont.)

Example: A product attribute for “Number of Wheels”, with allowable values of 1, 2, and 4. For each of these values, a special prompt is desired.

ACT<productAttribute id="numWheels">

<name>Number of Wheels</name><descr>Number of wheels on the

bicycle</descr><enumeration applicPropertyValues="1“

enumerationLabel="Unicycle (1)"/><enumeration applicPropertyValues="2"

enumerationLabel="Standard cycle (2)"/><enumeration applicPropertyValues="4"

enumerationLabel="Training cycle (4)"/></productAttribute>

DM<applic><assert applicPropertyIdent="numWheels"

applicPropertyValues="1“applicPropertyType="prodattr"/>

</applic>

11

Applicability – S1000D Issue 4.1

September 21-23, 2015

September 21-23, 2015

Applicability – S1000D Issue 4.1

Enumeration Labels (Cont.)

Boolean attributes can also have enumeration labels. The applicPropertyValues are “true” and “false” by default.

12

CCT<condType id="TD" valueDataType="boolean">

<name>Technical Directive</name><descr>Technical Directive</descr><enumeration applicPropertyValues="true" enumerationLabel="Post"/><enumeration applicPropertyValues="false" enumerationLabel="Pre"/>

</condType>

13

Applicability – S1000D Issue 4.1

September 21-23, 2015

Supplier: Nav

Supplier: Engine

Integrator

BUNO: 456789

Engine Number: 34-A456Engine Mode : 500X

Nav Controller : NC-3000-2ANav Display : ND-5493L

Applicability Cross Reference Table Catalog

Product Configuration

Engine NumberEngine Model

Nav ControllerNav Display

Integrator/Supplier scenario

DMs

DMs

DMs

September 21-23, 2015

Applicability – S1000D Issue 4.1

14

Applicability – S1000D Issue 4.1

September 21-23, 2015

BUNO: 456789

Engine Number: 34-A456Engine Mode : 500X

Nav Controller : NC-3000-2ANav Display : ND-5493L

Applicability Cross Reference Table Catalog

Product Configuration

Engine NumberEngine Model

Nav ControllerNav Display

BUNO: 456789

Engine Number: 34-A456Engine Model: 500X

Nav Controller: NC-3000-2ANav Display: ND-5493L

Serial Number: 34-A456Model: 500X

Controller: NC-3000-2ADisplay: ND-5493L

Applic State Table

Assignments to Integrator attributes automatically set Supplier attributes

Integrator can filter on Supplier attributes

September 21-23, 2015

Applicability – S1000D Issue 4.1

15

Applicability – S1000D Issue 4.1

September 21-23, 2015

<productAttributeList><productAttribute id="Integrator.BUNO"

productIdentifier="primary"><name>Bureau Number</name>

</productAttribute><productAttribute id="Integrator.Engine.No"

aliasFlag="1"><name>Engine Number</name>

</productAttribute><productAttribute id="Integrator.Engine.Model"

aliasFlag="1"><name>Engine Model</name><enumeration applicPropertyValues="400X"/><enumeration applicPropertyValues="500X"/>

</productAttribute><externalProductAttribute id="Integrator.Nav.Controller">

<displayName>Nav Controller</displayName><externalProductAttribute><externalProductAttribute id="Integrator.Nav.Display"/>

</productAttributeList>

Indicate which attributeswill be aliased

Indicate attributes using supplier definitions

Integrator ACT

September 21-23, 2015

Applicability – S1000D Issue 4.1

<productDefinitionRelationship><externalAssert

applicPropertyIdent="Integrator.Engine.No"applicPropertyType="prodattr">

<applicCrossRefTableRef><!-- Ref to Integrator ACT -->

</applicCrossRefTableRef></externalAssert><associate associationType="alias"><externalAssert applicPropertyIdent="Supplier.SerialNo"applicPropertyType="prodattr"><applicCrossRefTableRef><!-- Ref to Engine Supplier ACT -->

</applicCrossRefTableRef></externalAssert>

</associate></productDefinitionRelationship>

16

Applicability – S1000D Issue 4.1

September 21-23, 2015

Identify integratorattribute

Indicate alias association

Integrator ACT Catalog: Alias Engine Number to supplier Serial Number

Assert equivalent supplierattribute

September 21-23, 2015

Applicability – S1000D Issue 4.1

<productAttribute id="Integrator.Engine.Model" aliasFlag="1">

<name>Engine Model</name><enumeration applicPropertyValues="400X"/><enumeration applicPropertyValues="500X"/>

</productAttribute>

<productAttribute id="Supplier.Model"><name>Model</name><enumeration applicPropertyValues="400X"/><enumeration applicPropertyValues="500X"/> <enumeration applicPropertyValues="550X"/><enumeration applicPropertyValues="600X"/>

</productAttribute>

Applicability Cross Reference Table Catalog

Aliased attributes have their own definition. Only share state table value.

17

Applicability – S1000D Issue 4.1

September 21-23, 2015

Model numbers onlyused by Integrator

Supplier defines all modelnumbers it manufactures

September 21-23, 2015

Applicability – S1000D Issue 4.1

<productDefinitionRelationship><externalAssert

applicPropertyIdent="Integrator.Nav.Controller"applicPropertyType="prodattr">

<applicCrossRefTableRef><!-- Ref to Integrator ACT -->

</applicCrossRefTableRef></externalAssert><associate associationType="extref"><externalAssert

applicPropertyIdent="Supplier.NavController"applicPropertyType="prodattr">

<applicCrossRefTableRef><!-- Ref to Nav Supplier ACT -->

</applicCrossRefTableRef></externalAssert>

</associate></productDefinitionRelationship>

18

Applicability – S1000D Issue 4.1

September 21-23, 2015

Identify integratorattribute

Indicate external definitionassociation

Integrator ACT Catalog: Use Supplier definition (external relationship)

Assert equivalent supplierattribute

September 21-23, 2015

Applicability – S1000D Issue 4.1

<externalProductAttributeid="Integrator.Nav.Controller">

<displayName>Nav Controller</displayName><externalProductAttribute>

<productAttribute id="Supplier.Controller"><displayName>Controller</displayName><enumeration applicPropertyValues="NC-3000-1A"/><enumeration applicPropertyValues="NC-3000-2A"/><enumeration applicPropertyValues="NC-4000-1A"/><enumeration applicPropertyValues="NC-5000"/>

</productAttribute>

Applicability Cross Reference Table Catalog

For external attributes, Integrator can only override display name. Definition and state table value shared.

19

Applicability – S1000D Issue 4.1

September 21-23, 2015

Integrator can overridedisplay name

September 21-23, 2015

Applicability – S1000D Issue 4.1

Applicability Cross Reference Table Catalog

ACT Catalog uses the ‘appliccrossreftable’ schema and must be authored with information code 0A3.

An IETM can only have one ACT Catalog DM There is no limit on the number of ACT/CCT/PCT associations.

CPFs have been submitted through the USSMG to address issues and ambiguities in the Issue 4.1 specification.

20

Applicability – S1000D Issue 4.1

September 21-23, 2015