Windchill Service Information Manager — S1000D Module: Issue 4.2 Support
Product:
Release: 11.1 M020
Benefit
You can create, edit, and manage data based on Issue 4.2 of the S1000D Specification in your Windchill SLM environment.
Additional Details
New object types and processes have been added to the to support the use of Issue 4.2 data.
• Issue 4.2 Product type and template
You can access the 4.2 product type in the Type and Attribute Management utility, at > >
◦ S1000D 4.2 Product
The product template is available in > > , and when creating a new product. It includes the same objects, roles, and permissions as the S1000D 4.1 Product Template, with the addition of support for 4.2 object types Business Rules Document Data Module and ICN Metadata File.
◦ S1000D 4.2 Product Template
|
|
Publishing of Arbortext Content Delivery A&D output is not supported with S1000D 4.2 products.
|
• Issue 4.2 Information Structure
You can access the 4.2 information structure type in the Type and Attribute Management utility, at > > > >
◦
The 4.2 information structure SNS node types are available at > > > >
◦ 4.2 Model Identification Code
◦ 4.2 System Difference Code
◦ 4.2 System Code
◦ 4.2 Sub System Code & Sub Sub System Code
◦ 4.2 Assembly Code
◦ 4.2 Disassembly Code
◦ 4.2 Disassembly Code Variant
• Issue 4.2 Publication Structure
You can access the 4.2 publication structure type in the Type and Attribute Management utility, at > > > > > .
◦ S1000D 4.2 Publication Structure
The S1000D 4.2 Publication Structure includes the same attributes as the S1000D 4.1 Publication Structure, with the addition of the option to specify a Publication Module Type attribute (new in Issue 4.2).
The 4.2 publication module type is available at > > > >
◦ 4.2 Publication module
The publication module template is available for an S1000D 4.2 product in > , and when creating a new publication structure:
◦ Pub
|
|
Publishing of Arbortext Content Delivery A&D output from an S1000D 4.2 Publication Structure is not supported.
|
• Issue 4.2 Data Module types
You can access the 4.2 data module types in the Type and Attribute Management utility, at > > > > >
◦ 4.2 Applicability Cross Reference Table
◦ 4.2 Brex
◦ 4.2 Business Rules Document (new in Issue 4.2)
◦ 4.2 Check List
◦ 4.2 Common Information Repository
◦ 4.2 Conditional Cross Reference Table
◦ 4.2 Container
◦ 4.2 Crew/Operator
◦ 4.2 Descriptive
◦ 4.2 Fault
◦ 4.2 Front Matter
◦ 4.2 Illustrated Parts Data
◦ 4.2 Learning
◦ 4.2 Maintenance Planning
◦ 4.2 Procedural
◦ 4.2 Process
◦ 4.2 Product Cross Reference Table
◦ 4.2 SCO Content
◦ 4.2 SCORM Content Package
◦ 4.2 Service Bulletin
◦ 4.2 Update
◦ 4.2 Wiring Data
◦ 4.2 Wiring Data Description
• Issue 4.2 Data Interchange types
You can access the 4.2 data interchange types in the Type and Attribute Management utility, at > > >
◦ >
◦ >
These objects are available when creating an S1000D Export package.
• Issue 4.2 Information Control Number (ICN) types
You can access the 4.2 ICN types in the Type and Attribute Management utility, at > > > >
◦ >
◦ >
ICNs with the same name but different file extensions can be imported and will be linked as primary and secondary content.
|
|
While this feature is introduced as part of support for Issue 4.2 of the S1000D specification, it applies to products based on Issues 4.0.1 and 4.1 too.
|
• Issue 4.2 ICN Metadata File type (new in Issue 4.2)
An ICN Metadata File (IMF) is linked to an Information Control Number (ICN) illustration to provide information about the ICN.
You can access the 4.2 ICN Metadata types in the Type and Attribute Management utility, at:
◦ > > > >
◦ > > > > >
The ICN Metadata File (IMF) is an S1000D document and is handled in a similar way to other data module types. It has its own template, Object Initialization Rule (OIR), lifecycles, and workflow although these are based on data module instances.
The Use ICN Metadata Files option for an S1000D 4.2 product specifies that the use of IMFs in the product is supported.
IMFs are created in the information structure in three ways:
◦ The > context menu option for an ICN.
◦ You can import IMFs into an S1000D 4.2 product.
◦ A new IMF is created automatically when an ICN with a linked IMF is raised in issue.
You can purge an IMF from the structure once it has been created.
Editing of the IMF in Arbortext Editor is supported, including the addition of references to BREX data modules.
The data model of an IMF includes the icnKeyword attribute, where you can define keywords for the ICN associated with the IMF. You can browse for ICNs using these keywords as search criteria when inserting an ICN into a data module.
The new product attribute Populate figure/multimedia title from ICN Metadata specifies that the icnTitle attribute of an IMF is automatically added as the figure/multimedia title when inserting the ICN linked to the IMF into content.
IMFs are not included in PDF output of publications that contain them.
• Issue 4.2 Business Rules Document data module type (new in Issue 4.2)
A Business Rules Document data module documents the business rules for a project in a conceptual form, with descriptions and examples, and can be included in an S1000D 4.2 information structure for reference purposes.
You can access the 4.2 Business Rules Document data module type in the Type and Attribute Management utility, at:
◦ > > > > > >
The Business Rules Document is a data module type, and is handled in a similar way to other data module types. It has its own template and Object Initialization Rule (OIR).
The template is available in > for an S1000D 4.2 product, and when creating a new document n an S1000D 4.2 information structure.
Editing of the Business Rules Document in Arbortext Editor is supported, including the addition of references to BREX data modules.
• Support for Business Rules Decisions (new in Issue 4.2)
Business Rules Decisions are listed in Business Rules Document data modules. They can be referenced from another Business Rules Document data module, or from a BREX data module.
Business Rules Decisions are indexed for selection when a Business Rules Document data module that contains them is checked in or imported.
Business Rules Decisions include an ID attribute brDecisionIdentNumber. These must be unique in a Business Rules Document or BREX data module, and within a Windchill product. Validation that the IDs are unique is carried out when checking in a Business Rules Document or BREX data module, and when importing an S1000D package.
• Issue 4.2 Information Codes
Information code templates are available for an S1000D 4.2 product in > , and when creating a new data module. Information codes introduced in Issue 4.2 are supported:
◦ 0A4 - Warnings - List of warnings in the common information repository
◦ 0A5 - Cautions - List of cautions in the common information repository
• Issue 4.2 look-up library objects
New look-up library code types, introduced in Issue 4.2 of the S1000D Specification, are included when you create a new S1000D Lookup Library library:
◦ Business Rules Severity Level
◦ Publication Modules Types
If you have updated an existing installation from 11.1 F000 or later, use this repair utility to update existing look-up libraries:
◦ WinRU: Service Information Manager AAD - Update OOTB Library OIRs and Meta Objects
• Editing Issue 4.2 data in Arbortext Editor
You can edit Issue 4.2 data in Arbortext Editor, using normal data module authoring functionality.
Schemas that represent S1000D 4.2 object types were provided in the com.ptc.arbortext.slmaad application. The document types folder includes schemas for Business Rules Document and ICN Metadata File, which were introduced in Issue 4.2 of the S1000D Specification.
• Changes to BREX Validation
In Issue 4.2 of the S1000D Specification, BREX validation was extended to include the addition of severity levels for business rules. The provides these options to support the updated process:
◦ Support for the brSeverityLevel attribute for individual rules in a BREX data module
◦ Support for the defaultBrSeverityLevel attribute as a general setting for a whole BREX or Business Rules Document data module, or for rules in the data modules that don’t have individual rules set
◦ Business rule breach severity levels preference to specify which levels of severity constitute a validation failure when a rule of one of the specified levels is breached
The values of brSeverityLevel and defaultBrSeverityLevel can be set to one of the Business Rules Severity Level codes configured in the S1000D library.
• Publishing Issue 4.2 data to PDF
You have the option to publish a PDF representation of a 4.2 publication structure (publication module). Sample publishing rules are provided in the S1000D 4.2 Product template. The publishing rules can be selected when publishing a representation:
◦ pdf using S1000D 4.2 Publishing Rules (A4)
◦ pdf using S1000D 4.2 Publishing Rules (US Letter)
Files to style the published 4.2 content (including new object types brDoc and ICNMetadata) are provided in the com.ptc.arbortext.slmaad application.
• Import of Issue 4.2 Data
Import of Issue 4.2 data is supported, using the standard S1000D import feature.
|
|
If the import package contains ICN Metadata Files (IMF), the target S1000D 4.2 product must be configured to allow IMFs.
|
A sample Issue 4.2 data set (Bike Sample) is provided at this location:
codebase\netmarkets\com\ptc\arbortext\windchill\rules\schema\S1000D_4-2\samples\S1000D_4-2_Bike-Samples.zip
It includes samples of Business Rules Document Data Module and ICN Metadata File, which were introduced in Issue 4.2 of the S1000D Specification.
• Export of Issue 4.2 Data
You can create an S1000D Export Package from an S1000D 4.2 information structure. Export S1000D Package functionality has been updated to include any Business Rules Document DMs from the selected node, and any ICN Metadata Files linked to ICNs in the structure.
Related Information
For more information, see:
