SIEMENS

Teamcenter 12.2

Content
Management
PLM00014 • 12.2
Contents

What is Content Management? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1

Before you begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1

Using Teamcenter XMetaL Client to manage content . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

Content Management interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

Content Management views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1
Content Management icons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2
What are perspectives and views? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4

Basic concepts for using Content Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1

Search for Content Management objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1

Part I: Content Management Administration

Preparing Content Management for authors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1

Migrating Content Management data from a previous release . . . . . . . . . . . . . . . . . . . . . 8-1

Update content reference type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1
Add the new relationship for topic references . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1
Remove obsolete saved queries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1

Setting preferences for Content Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1

Importing and exporting administration data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1

Administration data included with Content Management . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1
Import Content Management administration data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1
Export Content Management administration data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-2

Pre-configured Base Content Management objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-1

Relating administrative items to enable authoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-1

Relating administrative items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-1
Relate one administrative item to another . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-1

Managing objects for DITA authoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-1

Creating objects for DITA authoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-1
DITA 1.0/1.1 topic authoring objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-1
DITA 1.0/1.1 composite authoring objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-3
DITA 1.0/1.1 map and bookmap authoring objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-4

PLM00014 12.2 Content Management 3

 Contents
Contents

DITA 1.2 topic authoring objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-6

DITA 1.2 composite authoring objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-10
DITA 1.2 map authoring objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-11
DITA 1.2 anchor and anchorref objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-13
DITA 1.3 topic authoring objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-13
DITA 1.3 composite authoring objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-17
DITA 1.3 map authoring objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-18
DITA 1.3 anchor and anchorref objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-20
Other DITA 1.3 topic types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-20
DITA publishing tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-21
DITA stylesheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-22
Create a DITA value filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-23
Editing DITA object lists of values (LOVs) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-24

Managing objects for S1000D authoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-1

Creating objects for S1000D authoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-1
S1000D 2.2 and 2.3 topic authoring objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-1
S1000D 4.0.1 topic authoring objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-2
S1000D 4.1 topic authoring objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-3
S1000D 4.2 topic authoring objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-5
Using S1000D standard numbering system (SNS) structures . . . . . . . . . . . . . . . . . . . . . . . 14-7
Create, import, and edit S1000D SNS structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-8
Enable publishing of CGM graphics in S1000D content . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-9
Configure Publication Structure columns for S1000D content . . . . . . . . . . . . . . . . . . . . . . 14-10
Modifying S1000D stylesheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-11

Creating schema objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-1

Overview of schemas in Content Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-1
Importing a schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-2
Create a schema object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-2
Create an XML schema object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-2

Creating topic and publication types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-1

Overview of topic and publication types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-1
Create a topic type or publication type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-2
Topic type conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-5
Create a topic type group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-7

Creating a publication structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-1

What is a publication structure? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-1
Define a structure for publication authoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-1

Enabling references and links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-1

Overview of reference types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-1
Create a reference topic type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-2
Enabling navigation links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-5
Overview of navigation links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-5
Enable fixed and floating links and conrefs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-7

4 Content Management PLM00014 12.2

 Contents

Enable link validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-9

Creating XML attribute mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-1

Overview of XML attribute mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-1
DC Base Attributes XML attribute mapping overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-1
Create an XML attribute mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-4
Callback functions in XML attribute mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-8
XML attribute mapping functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-9

Creating style types and stylesheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-1

Overview of style types and stylesheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-1
Create a style type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-1
Create a stylesheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-2
Edit a stylesheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-3
Stylesheet types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-4

Enabling graphics features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-1

Required tasks to enable authors to use graphics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-1
Enabling references between topics and graphics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-1
Create a graphic reference topic type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-1
Defining default graphic usages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-2
Working with graphic priority lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-2
Working with graphic attribute mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-3
Create a graphic attribute mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-4
Maintaining graphic tagging options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-8

Enabling content editing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-1

Setting up tools for editing content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-1
Create an editing tool object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-1
Install editing tool plug-ins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-4

Enabling content publishing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-1

Tasks for enabling publishing content . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-1
Create a publishing tool object . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-3
Publishing tool activations . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-5
Add a custom publishing tool activation . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-6
Enable publishing through Teamcenter Dispatcher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-6
Enable publishing to a file system . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-7

Create a comparing tool object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-1

Create a viewing tool object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-1

Exchange Content Management data between multiple sites . . . . . . . . . . . . . . . . . . . . . 26-1

Setting up translation features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27-1

Tasks required to set up translation features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27-1

PLM00014 12.2 Content Management 5

 Contents
Contents

Establishing languages available for translations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27-1

Create a translation office . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27-1
Setting the graphic priority for translation orders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27-2
Configure your Teamcenter installation to support the UTF-8 character set . . . . . . . . . . . . . . 27-3

Transforming XML content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28-1

Using XSLT scripts to transform XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28-1
Creating XML transformations for publishing and exporting . . . . . . . . . . . . . . . . . . . . . . . . . 28-1
Create a procedure for XML transformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28-2
Create an XML transformation policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28-4

Part II: Content Management Authoring

Creating Base Content Management content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29-1

Overview of Base Content Management content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29-1
Create a topic or template in Base Content Management . . . . . . . . . . . . . . . . . . . . . . . . . . 29-2
Create a publication or template in Base Content Management . . . . . . . . . . . . . . . . . . . . . . 29-3
Create a new topic based on an existing topic revision . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29-4
Create a new publication based on an existing publication revision . . . . . . . . . . . . . . . . . . . 29-6

Creating DITA content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30-1

Overview of DITA content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30-1
Create a DITA item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30-2
Create a new DITA item based on an existing one . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30-5
Working with DITA content references (conrefs) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30-6
What are DITA conrefs? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30-6
Add a DITA conref to reference an element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30-6
Add a DITA conref to reference another topic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30-8
Relate DITA topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30-9
Add topics to a DITA relationship table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30-11
Working with DITA keyrefs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30-12
Validate DITA keyrefs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30-13
Create DITA value filter using a Ditaval topic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30-13
Review broken links in DITA OT output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30-14

Creating S1000D content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31-1

Overview of S1000D content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31-1
Create an S1000D item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31-2
Create a new S1000D item based on an existing one . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31-3
Adding data modules to DMLs, DDNs, and publication modules . . . . . . . . . . . . . . . . . . . . . 31-4
Relate data modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31-5
Creating the structure of an S1000D publication module . . . . . . . . . . . . . . . . . . . . . . . . . . . 31-6
Contents of published S1000D publication modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31-7
Using saved searches to create data module lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31-9
Create a data module list using a saved search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31-9
Apply project-specific standard numbering system (SNS) codes to a new data module . . . . . 31-10
Import a data management requirement list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31-10
Create a data module delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31-12

6 Content Management PLM00014 12.2

 Contents

Validate data modules against a BREX data module . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31-15

S1000D workflow templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31-16

Create a topic or publication from a template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32-1

Copying content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33-1

Copy a topic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33-1
Duplicate a publication or topic structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33-2

Create a new revision of a topic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34-1

Working with a publication structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35-1

Working in the Publication Structure view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35-1
Add publications to the Publication Structure view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35-1
Add and move topics to build publications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35-2
Remove a topic from a publication in the Publication Structure view . . . . . . . . . . . . . . . . . . . 35-3

Working with topic relationships . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36-1

Types of topic relationships . . . . . . . . . . . . . . . . . . . .... . . . . . . . . . . . . . . . . . . . . . . . 36-1
Viewing related objects . . . . . . . . . . . . . . . . . . . . . . .... . . . . . . . . . . . . . . . . . . . . . . . 36-1
Ways to view related Content Management objects .... . . . . . . . . . . . . . . . . . . . . . . . 36-1
View related topics in the Publication Structure view ... . . . . . . . . . . . . . . . . . . . . . . . 36-2
View related objects in the Relation Browser . . . . . .... . . . . . . . . . . . . . . . . . . . . . . . 36-2
View related objects in the Impact Analysis view . . .... . . . . . . . . . . . . . . . . . . . . . . . 36-2
Validate content references . . . . . . . . . . . . . . . . . . . .... . . . . . . . . . . . . . . . . . . . . . . . 36-2

Editing content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37-1

Using an editing tool to edit content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37-1
Create and edit content in an editing tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37-1
Set editing tool preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37-4
Teamcenter CMS menu options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37-5

Working with links between topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38-1

Types of topic links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38-1
Add a navigation link to a topic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38-1
Add a link to content within a topic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38-2

Importing and exporting documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39-1

Prerequisites for importing documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39-1
Import a document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39-1
Import a DITA map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39-4
Export a topic or publication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39-7

Publishing and previewing content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40-1

Overview of publishing and previewing content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40-1
Set publishing preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40-1
Publish and preview output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40-2

PLM00014 12.2 Content Management 7

 Contents
Contents

Preview content in XML or SGML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40-5

Understanding publishing results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40-6

Using variants for publications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41-1

The process for using variants in Content Management . . . . . . . . . . . . . . . . . . . . . . . . . . . 41-1
Create variant options for publications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41-1
Copying and modifying options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41-3
Create new options from existing options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41-3
Change option values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41-3
Rename an option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41-4
Remove an option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41-4
Deleting an option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41-5
Working with option defaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41-5
Add variant conditions to topics in the publication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41-5
Modifying variant conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41-7
Insert a clause before another clause . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41-7
Replace a clause . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41-7
Copy a clause . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41-7
Remove a clause . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41-8
Move a clause . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41-8
Group a clause . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41-8
Remove a variant condition from an occurrence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41-8
Setting variant rules on publications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41-9
Set a variant rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41-9
Unset a variant rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41-9
Working with variant rule checks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41-10
Show and hide unconfigured components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41-11

Comparing topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42-1

How topics are compared in Content Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42-1
Compare two revisions of the same topic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42-1
Compare two different topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42-2

Working with documents for review . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43-1

Overview of composed and reviewer documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43-1
Create a composed or reviewer document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43-2
View a composed or reviewer document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43-2
Exporting and importing composed documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43-2
Export a composed document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43-3
Import a composed document as an XML document . . . . . . . . . . . . . . . . . . . . . . . . . . 43-3
Import a composed document as a named reference . . . . . . . . . . . . . . . . . . . . . . . . . . 43-3

Using graphics in your content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44-1

Overview of graphics in Content Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44-1
Set tagging preferences for graphics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44-2
Import graphics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44-3
Preview a graphic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44-6
Insert a graphic into a topic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44-6

8 Content Management PLM00014 12.2

 Contents

Add a Lifecycle Visualization graphic to a topic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44-7

Edit a graphic option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44-10
Update a graphic option using Named References . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44-11
Update the graphic usage for a graphic option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44-11
Perform a where-used search for a graphic option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44-12

Managing content in different languages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-1

Content translation process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-1
View the status of translation order content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-1
Create a translation order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-2
Create the files for content delivery to a translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-3
Export the translation delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-4
Tasks completed by the content translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-4
Import translated content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-5
Edit a translation topic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-6

PLM00014 12.2 Content Management 9

Chapter 1: What is Content Management?

Content Management, an optional Teamcenter solution, is a single source publishing system for the
creation of technical documentation. Technical publications consist of XML and SGML content
components, which are stored in the Teamcenter database along with any associated graphics used
in the publications. The structure of a publication is validated by schemas, such as DTDs. The
publication layout is implemented with stylesheets, which allows the same content to be available for
different media, such as print or Web applications. Content developed as individual topics may be
reused among different publications.
Content Management works in conjunction with several publishing and editing tools, which enable
publications to be generated for both online and print formats. Content Management includes support
for multiple language versions and includes the ability to manage topics through translations and
release cycles.
Three types of Content Management solutions are available:
• Base Content Management, which can be used with traditional and custom DTDs and schemas
such as DocBook and Structured Product Labeling (SPL).

• S1000D Content Management, which enables management of documentation for either version
2.2/2.3, 4.01, 4.1, or 4.2 of the S1000D standard.

• DITA Content Management, which enables management of documentation for the DITA standard,
through version 1.3, including specialization and support for DITA Open Toolkit (OT) version 2.4.6.

Note
Editing tools are supported only on Windows clients. S1000D version 2.3 is supported only
on Linux and Windows. DITA publishing is supported only on Linux and Windows.

Separate from the Content Management solution, the document management functionality in
Teamcenter enables you to manage documents created by other software applications, such as
Microsoft Word, Microsoft Excel, and other programs.

Note
Teamcenter site consolidation and multisite functionality are currently not supported for
Content Management. To transfer Content Management data, use import and export
features.

Before Content Management can be used for authoring publications, the application administrator
must complete several tasks to prepare Content Management for authors.

PLM00014 12.2 Content Management 1-1

 Chapter
Chapter 1: 1: WhatWhat is Content
is Content Management?
Management?

Pre-configured administration data is included in the TC_ROOT\contmgmtbase_data\data,

TC_ROOT\contmgmts1000d_data\data, TC_ROOT\contmgmts1000d40_data\data, and
TC_ROOT\contmgmtdita_data\data folders.
Two types of users access Content Management:
• Content Management administrators create and manage objects that enable content authoring.

• Content authors use Content Management to create and manage technical documentation.

1-2 Content Management PLM00014 12.2

Chapter 2: Before you begin

Prerequisites Your application administrator must set the appropriate access

privileges to define the data objects that users can access in the
application.
Enable Content During installation:
Management
• Select Content Management Base in the Select Features panel
under Extensions→Content and Document Management in
Teamcenter Environment Manager:

• (Optional) Select one or more of the following in the Select

Features panel under Extensions→Content and Document
Management in Teamcenter Environment Manager:
o Content Management DITA

o Content Management S1000D

o Content Management S1000D 4.0

Configure Content Content Management does not need to be configured before you can
Management use it; however, several tasks must be completed to prepare Content
Management for authors.
Start Content Click Content Management in the navigation pane.
Management
Note
If an application button is not displayed for Content
Management, you can add it using the Configure
Applications button.

PLM00014 12.2 Content Management 2-1

Chapter 3: Using Teamcenter XMetaL Client to manage content

Teamcenter XMetaL Client is an optional application that integrates XMetaL Author with Content
Management for authoring and managing technical publications. Authors log in to Teamcenter using
the XMetaL interface and can perform most authoring tasks and the workflow signoff task, without
using the Teamcenter interface.
To install XMetaL Client, run TC_INSTALL_DIR\additional_applications\xmetal_install\setup.exe.
For configuration instructions, see the Teamcenter XMetaL Client Administrator’s Guide
located on the local drive where XMetaL Client is installed, for example: c:\Program Files
(x86)\Siemens\Teamcenter10\XMetaLPlugin\XMetal\CRCL\adapters
\Teamcenter\docs. For instructions on using Teamcenter XMetaL Client, see the Teamcenter
XMetaL Client Help available from the Help menu in Teamcenter XMetaL Client.
If you are using Teamcenter XMetaL Client, do not install the XMetaL plugin in the Teamcenter
interface.

PLM00014 12.2 Content Management 3-1

Chapter 4: Content Management interface

Content Management views

1 Publication Structure view Enables you to navigate, create, and maintain the structure
of a publication with XML or SGML components, by adding,
relating, removing, and moving topics. The state of the
Publication Structure view may be set to persist between
logins using the ctm0RestoreStateOfPubStructure
preference.
2 Summary view Displays the property information of the selected object.
The Summary view is also used with other Teamcenter
solutions.

PLM00014 12.2 Content Management 4-1

 Chapter
Chapter 4: 4: Content
Content Management
Management interface
interface

3 Preview view Used to display either published content (Publish

Content) or the XML or SGML markup of a publication
(Show Content).
4 Impact Analysis view Provides graphical where-used and where-referenced
search capabilities for topics, graphics, and administrative
objects.
The Impact Analysis view is also used with other
Teamcenter solutions.
5 Details view When a component is selected in the Home component
view or the Publication Structure view, displays the
objects at the level below the selected object, which may
be system objects used to support the selected object.
The Details view is also used with other Teamcenter
solutions.

Content Management icons

Icon Description
Comparing tool

Composed document

Composed document revision

DITA Base

DITA Concept

DITA Dynamic Map

DITA Reference

DITA Static Map

DITA Task

DITA Topic

Editing tool

Graphic

Graphic attribute mapping

4-2 Content Management PLM00014 12.2

 Content Management interface

Icon Description
Graphic revision

Graphic option

Graphic option revision

Graphic priority list

Graphic translation

Graphic translation revision

Language item

Procedure

Publication

Publication revision

Publication type

Publishing tool

Reference topic type

Reviewer document

Reviewer document revision

Schema

Schema revision

Style type

Stylesheet

Stylesheet revision

Topic

Topic type

Transformation policy

PLM00014 12.2 Content Management 4-3

 Chapter
Chapter 4: 4: Content
Content Management
Management interface
interface

Icon Description
Translation

Translation revision

Translation delivery

Translation delivery revision

Translation office

Translation office revision

Translation order

Translation order revision

Viewing tool

XML attribute mapping

XML schema

XML schema revision

What are perspectives and views?

Within the rich client user interface, application functionality is provided in perspectives and views.
View The basic display component that displays related information in a UI window.
Perspective A collection of one or more views and their layout.
Some applications use a perspective with multiple views to arrange how functionality is presented.
Other applications use a perspective with a single view.
You can use the HiddenPerspectives preference to prevent the display of some Teamcenter
perspectives in the rich client.
If your site has online help installed, you can access application and view help from the rich client
Help menu or by pressing F1.

4-4 Content Management PLM00014 12.2

Chapter 5: Basic concepts for using Content Management

Understanding the following basic concepts will help you use the features of Content Management.

Data objects are unique in Content Management

Items and item revisions are the fundamental data objects used to manage information in Teamcenter.
Content Management uses specific types of items and item revisions, including topics, topic revisions,
publications, and publication revisions in Base Content Management, and S1000D and DITA items in
those solutions. Content Management also uses administration objects for defining the authoring
environment, such as topic types, XML attribute mappings, and schemas.
Some administration objects—stylesheets, schemas, procedures, and translation offices—have item
revisions. Content Management objects are managed like other Teamcenter objects.
You perform some tasks with these objects in the Home component view; however you use the
Publication Structure view to create and maintain the contents of publications.

Topics are the basic component of publications

In Base Content Management, a topic is a component that may be part of one or more publications.
A topic may contain text, tables, graphics, and subtopics. The term topic is also used in Content
Management to refer to certain S1000D and DITA objects.

Content versions track edits to a topic

In addition to the revision ID and sequence ID appended to topics, each topic revision has a content
version. The content version is a number that increases each time the content of the topic is edited.
When a topic is first created, its content version is -1. After the content is edited once, the content
version increases to 0, and then to 1, and so on. The content version of a topic revision is displayed
in the Summary view. When a topic has a translation, you can compare the content version of the
topic to the content version of the translation to determine if the topic has changed since the topic
was translated. When you edit the content of a topic, you can save it without increasing the content
version, which is useful when a topic has a related translated topic and you want the versions of the
two to remain synchronized.

Publications are the complete structure and content of technical documents

In Base Content Management, a publication object holds all the contents of a traditional XML
publication. A publication contains topics and subtopics, such as the cover page, back page, header,
footer, and sections or chapters. DITA and S1000D Content Management solutions have unique
publication-type objects that are used to create technical documentation.
The type of topics you can add to specific locations in a publication is defined by the Content
Management administrator in an underlying hierarchical structure of publication types and topic types
created according to the schemas your company uses.

PLM00014 12.2 Content Management 5-1

 Chapter
Chapter 5: 5: BasicBasic concepts
concepts for using
for using Content
Content Management
Management

Schemas define the building blocks of XML and SGML documents

Schemas define the basic structure of elements and attributes used in structured documents. When
you relate publication and topic types to schemas in Content Management, the XML or SGML content
is validated against the schema files that are defined by the Content Management administrator. A
DTD is an example of a schema type.

Stylesheets control the format of documents

A stylesheet contains formatting information used to render, edit, or transform a topic or document.
A style type is used to organize and manage the stylesheets associated with publications. These
objects are defined by the Content Management administrator.

A graphic item may have several graphic options

A graphic item is the main object representing a set of different file types, or graphic options, for
the same illustration. For example, a graphic item may be named piston, and it may have several
associated graphic options named piston.jpg, piston.gif, and piston.bmp, which all represent the
same illustration in different formats.

When you start an editing or publishing process, the Content Management system selects the
applicable graphic option from the graphic, based on how the graphic options are defined by your
application administrator. For example, during the publishing process, the graphic option selected may
be a high-resolution .eps file registered with the PDF usage in the topic; and if the graphic item has a
.png file registered with the VIEW usage, Content Management may display it in the topic for editing.

Integration with third-party tools enable you to author content

Content Management integrates tools, which are installed on each client, to support the following
authoring tasks:

• Publishing

Publishing tools render content to PDF, HTML, XHTML, and other proprietary formats, based on
the stylesheets and applications you have available.

• Editing

Editing tools are used to author and edit XML and SGML content and are launched when topics
are opened for editing.

• Comparing

Comparing tools are used to compare differences in topics.

• Viewing

Viewing tools are used to run an external tool to view topics. This is useful when a quick or
remote preview session is needed, without the processing time required to generate a PDF
document or other process-intensive stylesheet.

5-2 Content Management PLM00014 12.2

 Basic concepts for using Content Management

Note
Cortona3D Teamcenter Integration is a third-party tool that provides the capability to author
publications that are linked with assembly and part data in Teamcenter. The Cortona3D
tool utilizes Content Management software but provides its own interface.

Composed documents assemble documents for reviewing

A composed document is created when you publish content. It contains a publication or topic with
all its child topics collected in one file. A reviewer document is the same type of document, named
differently so that it can be used to distinguish documents between those that have been processed
through the review process (composed documents) and those that have not (reviewer documents).
These documents can be exported and imported for content review outside of the system.

Workflows can aid in document review

You can design Teamcenter workflow process templates that incorporate your company's business
practices and procedures. Your company can use these workflows to process topics through release
cycles and between participants.
You can use Teamcenter workflows for document reviews by using Workflow Designer and Workflow
Viewer.

You can manage content in different languages

Content Management manages multiple language versions of topics and publications, for example:
English, Russian, and Simplified Chinese.
Several object types are used for translations:
• Translations
A translation is an object created with the content of a topic in a different language than the
original. Translations indicate the language and topic for which they are created. A translation is
related to the source topic from which it is derived.

• Translation orders
A translation order is an object in the translation process used to provide information to the
translator. It contains basic information, such as the translation office assigned and the requested
delivery date.

• Translation deliveries
A translation delivery contains the translation topics and has an associated .zip file that can be
exported and sent to the translation company.

• Graphic translations
Graphic translations are objects that are created when graphic options are imported. They store
the language property associated with a graphic option when it is imported. Graphic translations
are related to the original (master language) graphic items and to the graphic options with the
associated translation languages.

PLM00014 12.2 Content Management 5-3

Chapter 6: Search for Content Management objects

You can use system defined searches to search in Teamcenter for existing content, graphics, and
administration objects.
1. Choose Advanced from the quick Search menu at the top of the navigation pane.

2. On the Search pane toolbar, click to select a search type.

3. Click More to display the system defined searches.

4. Under System Defined Searches, select the object you want to search for.
Content Management objects are listed with the Content Management prefix.

5. Click OK.
The dialog box that contains the object properties appears.

6. Type the values for the object properties that you want to search for.

7. Click to search.

PLM00014 12.2 Content Management 6-1

Part I: Content Management Administration

PLM00014 12.2 Content Management

Chapter 7: Preparing Content Management for authors

Tasks in Content Management

Before authors can use Content Management, the Content Management administrator must
complete the following tasks.

Note
Although you can create these objects yourself, it is recommended that you import
the Content Management administration data and modify the objects to meet your
organization’s needs. Depending on the needs of your organization, the administrator may
also be required to complete tasks in addition to the ones listed here.

• Create at least one style type to organize multiple stylesheets based on a unique layout
specification.

• Create stylesheets, which are used to manage formatting information for documents; and relate
the stylesheets to the style type(s).

• Set up editing, publishing, viewing, and comparing tools, which are used to work with content in
Content Management. Relate each tool to stylesheets when required for the tool.

• Create topic types and publication types and relate them to stylesheets. These are the
objects that make up an XML publication structure and are selected by authors as they create
publications and topics. In S1000D and DITA Content Management, topic types are predefined to
match the objects for the standard, such as S1000D data modules and DITA concept topics. You
still may need to create objects for them in Content Management, unless you import them from
the Content Management administration data.

• (Optional) Create at least one publication structure with a publication type and related topic types,
to define a structure that authors can use to create documents.

• Create schema objects, adding the schemas to the database; and relate them to publication and
topic types. Schemas define the basic structure of elements and attributes used in a topic. For
example, a DTD is a schema. DTDs contain the elements, attributes, entities, and notations
used in XML documents.

• Create XML attribute mappings for the exchange of data between XML attributes and database
object properties, and relate them to topic types.

• Create reference topic types, which identify the syntax used for building links and references to
topics. Relate the reference topic types to XML attribute mappings and other topic types.

• Enable navigation links, so authors can create links between topics.

PLM00014 12.2 Content Management 7-1

 Chapter
Chapter 7: 7: Preparing
Preparing Content
Content Management
Management for authors
for authors

• Enable graphics features, so authors can use graphics in publications.

• (Optional) Create translation offices and languages to allow authors to manage content in
different languages.

• (Optional) Create transformation policies and procedures, which are used for specialized
handling of topics.

• Set Content Management preferences to determine behaviors for processing such as graphic
filtering during import, publishing content to a file system, topic type filtering during topic creation,
and XML attribute mapping.

Tasks in other Teamcenter applications

In addition to Content Management tasks, the administrator may complete some of the following tasks.
• Define your organization, including roles, groups, and users, in Organization.

• Control user access to data objects in Access Manager.

• Design Teamcenter workflow process templates that incorporate your company's business
practices and procedures, in Workflow Designer.

• Define projects and programs and assign team members, in the Project and Program applications.

• Customize attributes and elements for Content Management objects, such as adding and
updating business object properties and attaching naming rules to properties, in Business
Modeler IDE.

7-2 Content Management PLM00014 12.2

Chapter 8: Migrating Content Management data
from a previous release

Update content reference type

In Teamcenter 11.2.3 and later, the relationship type between content references and graphic content
references is changed from a GRM (generic relationship management) relation to a PSOccurrence
relation. If you are upgrading from any prior release, you must run the contmgmt_migration_1123
utility to update these relationships.
1. After the upgrade to the current release is complete, run the contmgmt_migration_1123 utility.

2. Determine if any assigned relationships must be corrected, by reviewing the log file created by the
utility in the temp directory. The log file is named contmgmt_data_migration_1123#####.trc,
where ##### is the date and time the log file was created.

Add the new relationship for topic references

In Teamcenter 10.0 and later, a new relationship exists between the PSOccurrence object between
two related topics and the reference topic type that is between the two topic types. If you are
upgrading from any prior release, you must run the contmgmt_migration_100 utility to add this
relationship to PSOccurrence objects. If more than one reference type exists between the two topic
types, then the utility selects one and the selection is noted in a log file.
1. After the upgrade to the current release is complete, run the contmgmt_migration_100 utility.

2. Determine if any assigned relationships must be corrected, by reviewing the log file created by
the utility in the temp directory. The log file is named contmgmt_data_migration_100#####.trc,
where ##### is the date and time the log file was created.

Remove obsolete saved queries

In Teamcenter 10.1 and later, you may see saved queries listed in the Query Builder Saved Queries
tree that are no longer needed.
• Use Query Builder to delete the saved queries with the prefixes DC_ and Civ0.

PLM00014 12.2 Content Management 8-1

Chapter 9: Setting preferences for Content Management

Preferences related to Content Management

Some Teamcenter preferences must be set to determine certain behaviors in Content Management.
• AE_dataset_id_usage
This preference must be set to OFF for Content Management to function properly.

• PLMXML_put_objects_in_newstuff_on_import
This preference can be created and set to TRUE to place imported objects, such as administration
data, in a folder with the same name as the imported XML file under the Newstuff folder. If this
preference is not created and set, you must search for the imported data.

• TcCheckoutReserveOnly
In releases prior to 9.0, setting this preference was recommended for Content Management
classes to optimize performance. In the current release, if this preference is set, users cannot
cancel the checkouts of Content Management objects. If you are upgrading from a release prior
to 9.0 and you want to enable the cancellation of checkouts, you must update the preference to
remove any Content Management classes from the values list after the upgrade to the current
release.

• Multiple_revise_dialog_visible
To enable the ability to edit names of new topic revisions using the Multiple Object Revise dialog
box, this preference must be set to true. If this preference is set to false, you may still revise
multiple topics, but you cannot edit the names.

• PSEVariantsMode
Content Management supports only classic variants. You can set this preference to legacy to
ensure that the variant mode always opens in the classic mode to avoid having to change the
mode that is displayed.

• PSEShowUnconfigdVarPref
When you are working with a publication structure, you can set this preference to show or hide
components containing variants.

• PSM_classic_variants_text_families and PSM_classic_variants_numeric_families

Variant options have a string type or a numeric type and a name. The type of option you can
create depends on the settings of these preferences.

PLM00014 12.2 Content Management 9-1

 Chapter
Chapter 9: 9: Setting
Setting preferences
preferences for Content
for Content Management
Management

Content Management preferences

Use Content Management preferences to determine behaviors for processing such as graphic
filtering during import, publishing content to a file system, topic type filtering during topic creation,
and XML attribute mapping.
You can also set some of these preferences by choosing Edit→Options→Content Management.
• Cdi0KeyrefValidation
Specifies whether keyrefs used in topics referenced in maps are always validated during import
and when you save changes and close the file in an editing session.

• ContentManagerColumnsShownPref
Specifies the list of columns that display in the Publication Structure view.

• ContentManagerDisplayNameWithTypeColumnsShownPref
Stores the internal names of properties that appear as columns in the Publication Structure view.

• ContentManagerShownColumnWidthsPref
Specifies the column width for the list of columns defined in the
ContentManagerColumnsShownPref preference.

• ctm0DisableS1000DItemIdCheck
Disables the schema validation check on attributes that comprise the unique identifier for S1000D
objects at the time the objects are created.

• ctm0FileNameSeparator
Adds the revision ID and sets the separator that is used when creating file names for the XML
files representing Content Management topics.
The value must not be the same character used in any file name or item ID. For example, the
value _ (underscore) cannot be used if a file is being imported as engine_stand.xml.
When using the DITA standard on Linux or UNIX, the value must not be $, %, or +, due to a
limitation of DITA OT.

• ctm0GraphicClassPref
Displays installed graphic classes for selection during import.

• ctm0GraphicExtPref
Filters the files that are listed for selection when graphics are imported.

• ctm0GraphicPref.values
Defines the values listed in the Graphic Link Clipboard preference list box. The values are the
publication_standard part of the ctm0GraphicPref.publication_standard.name preferences.
These values are used to define the default XML tagging used when adding graphics to content
for specific technical publication standards.

• ctm0GraphicPref.dita.name

9-2 Content Management PLM00014 12.2

 Setting preferences for Content Management

Specifies the text to display in the Graphic Link Clipboard preference list box. The value
represents the option to use when working with the DITA standard for publications.

• ctm0GraphicPref.dita.text
Specifies the default XML tagging that you want to use in the editing tool when a graphic is copied
from Content Management and pasted to content in the editing tool. The value is used when
working with the DITA standard for publications.

• ctm0GraphicPref.docBook.name
Specifies the text to display in the Graphic Link Clipboard preference list box. The value
represents the option to use when working with the DocBook standard or a similar XML standard
for publications.

• ctm0GraphicPref.docBook.text
Specifies the default XML tagging that you want to use in the editing tool when a graphic is copied
from Content Management and pasted to content in the editing tool. The value is used when
working with the DocBook standard or a similar XML standard for publications.

• ctm0GraphicPref.s1000d.name
Specifies the text to display in the Graphic Link Clipboard preference list box. The value
represents the option to use when working with the S1000D 4.0 or 4.1 standard for publications.

• ctm0GraphicPref.s1000d.text
Specifies the default XML tagging that you want to use in the editing tool when a graphic is copied
from Content Management and pasted to content in the editing tool. The value is used when
working with the S1000D 4.0 or 4.1 standard for publications.

• ctm0GraphicUsagePref
Maps graphic option usages to graphic file extensions, to provide a default selection when
graphics are imported to Content Management. System-defined graphic usages include: ICON,
PDF, PRINT, SOURCE, THUMBNAIL, VIEW, and WEB.

• ctm0_processing_data
Maps processing data properties to content during the XML attribute exchange in the compose
process.

• ctm0RestoreStateOfPubStructure
Controls the save state of the Publication Structure view.

• ctm0TopicTypeGroup
Limits the topic type groups that can be used for creating new topics. If one or more values
are entered, only topic types in the listed groups are available for selection when new topics
are created.

• ctm0_translation_graphicpriority

PLM00014 12.2 Content Management 9-3

 Chapter
Chapter 9: 9: Setting
Setting preferences
preferences for Content
for Content Management
Management

Specifies the graphic priority preference assigned to translation orders when they are created in
Content Management.

• DCt_Language_fnd0isoLanguageCountryCode_expression
Defines the expression value of the run-time property fnd0isoLanguageCountryCode for the
DCt_Language business object. It combines the values of the ISO language and country code
on the language object.
For example, if the language code is en and the country code is US, the value in this run-time
property on DCt_Language for the default value is en-US. However, this preference can be
modified for the value to appear in another way, such as enUS, en_US, or en.US.

• deploy_absolute_path
Specifies the file path to the folder specified in the publish_to_file_system_loc preference for
published content. This path is platform-specific.

• deploy_link_prefix
Specifies the URL to connect to the folder storing published content.

• publish_to_file_system
Enables publishing to a file system.

• publish_to_file_system_loc
Specifies the name of the parent folder to store published content.

9-4 Content Management PLM00014 12.2

Chapter 10: Importing and exporting administration data

Administration data included with Content Management

Administration data includes the database objects and relationships that are set up to enable
authors to create and manage documentation in Content Management. You can import and export
administration data to transfer it from one system to another. When you install Content Management,
Teamcenter provides example administration data for Content Management.

Note
Default settings in Teamcenter allow users within the same user group (such as dba
and Engineering) to check out objects. Therefore, the administrative objects should be
imported by a user with administration (dba) privileges. However, it is recommended
that the infodba user account not be used for importing administration data, as certain
restrictions apply to the infodba user.

The Content Management installation provides three different sets of administration data. The
Base administration data provides example languages and graphic priority lists in the Organization
application. It also creates example publishing and editing tools, graphic attribute mappings, and
XML attribute mappings. Although you can create these objects yourself in Content Management, it
is recommended that you import this data and modify the objects to meet your organization’s needs.
The S1000D and DITA administration data sets contain pre-configured topic types, schemas, and for
DITA, the DITA Open Toolkit (OT) stylesheets, as defined by these standards. You can use these
as the starting point for S1000D and DITA content management.

Note
It is recommended that you maintain an unchanged version of the provided objects for
testing and comparison purposes.

Import Content Management administration data

Note
Verify that the tool paths assigned to the provided editing and publishing tools match
the paths for your installation of the tools.

1. To place imported objects in the Newstuff folder, ensure the

PLMXML_put_objects_in_newstuff_on_import preference is added. If this preference is not
set, imported objects are saved in the database, but not displayed in My Teamcenter.

PLM00014 12.2 Content Management 10-1

 Chapter
Chapter 10:10:Importing
Importing and exporting
and exporting administration
administration data data

2. Choose Tools→Import→From PLMXML.

3. Click to the right of the Importing XML Object box, to browse for and select the objects
to import.
If you are importing the administration data provided with the Content Management installation,
select one of the following:

• TC_ROOT\contmgmtbase_data\data\admin\contmgmtbase_admindata.xml, to import
Base Content Management administrative objects.

• TC_ROOT\contmgmtdita_data\data\admin\contmgmtdita_admindata.xml, to import
DITA 1.1 Content Management administrative objects.

• TC_ROOT\contmgmtdita_data\data\admin\contmgmtdita12_admindata.xml, to import
DITA 1.2 Content Management administrative objects.

• TC_ROOT\contmgmtdita_data\data\admin\contmgmtdita13_admindata.xml, to import
DITA 1.3 Content Management administrative objects.

• TC_ROOT\contmgmts1000d_data\data\admin\contmgmts1000d_admin.plmxml, to
import S1000D 2.2 and 2.3 Content Management administrative objects.

• TC_ROOT\contmgmts1000d40_data\data\admin\contmgmts1000d_40_admin.plmxml,
to import S1000D 4.0.1 Content Management administrative objects.

Note
If you imported this data in a release prior to 10.0, you must re-import it to update
your data to the S1000D 4.0.1 standard.

• TC_ROOT\contmgmts1000d40_data\data\admin\contmgmts1000d_41_admin.plmxml,
to import S1000D 4.1 Content Management administrative objects.

4. From the Transfer Mode Name list, select ctm0_ContMgmtImportAdmin.

5. Click OK.

Tip
To verify the import, search for some of the object types you imported, or look in the
Newstuff folder if your preferences are set to place new objects there.

Export Content Management administration data

You can export administrative objects such as schemas, topic types, stylesheets, and XML attribute
mappings.
1. Select the object to be exported.

10-2 Content Management PLM00014 12.2

 Importing and exporting administration data

2. Choose Tools→Export→To PLMXML.

3. Click to the right of the Export Directory box, to browse for and select the select the
directory in which to place the file.

4. In the Export Filename box, type the name of the export file.

5. From the Transfer Mode Name list, select ctm0_ContMgmtExportAdmin.

6. (Optional) Select Open PLM XML File to view the file when the export operation is complete.

7. (Optional) Select the Perform Export In Background check box to run the export in the
background.

8. Click OK to export the object in the Object List list and close the dialog box.
When the export completes, a dialog box appears.
If the export was successful, you can click Yes to view the log file for the export.
If there were errors during the export, the dialog box lists the errors. Click Yes to view information
about the errors that occurred.

PLM00014 12.2 Content Management 10-3

Chapter 11: Pre-configured Base Content Management objects

Base Content Management can be used with traditional and custom DTDs and schemas, such
as DocBook and Structured Product Labeling (SPL). Teamcenter provides Base administration
objects and relationships as examples of how administration data works. To begin creating the
required objects for managing documentation for Base Content Management, you can import the
Base administration data, which includes the following example objects:

Note
It is recommended that you maintain an unchanged version of the provided objects for
testing and comparison purposes.

Object type Included objects

Editing tool XMetaL 9.0
Used for editing topics in XMetaL 9.0.
Publishing tool • InternalViewer
An internal tool that publishes XML content to the Preview
view. The view displays XML in ASCII format, with tags,
etc.

• FOP
Supports Formatting Objects Processor, a Java application
included with Teamcenter that converts XSL Formatting
Objects files to PDF.

• PDF serverside
Supports Antenna House XSL Formatter, one of many
available publishing applications that can be purchased
from a third-party supplier. If you were to use this tool,
you would install the publishing application on a server for
publishing content to PDF.

• serverside HTML publish

An internal tool that publishes content to HTML, using
XSLT or CSS scripts, which are processed on the server.

PLM00014 12.2 Content Management 11-1

 Chapter
Chapter 11:11:Pre-configured
Pre-configured
BaseBase Content
Content Management
Management objects
objects

Object type Included objects

Graphic attribute mapping • Default Graphic Attribute Mapping
In this graphic attribute mapping, when a graphic is
imported, all characters after the first period in the file
name become the file extension.

• Default Graphic Attribute Mapping without suffix

In this graphic attribute mapping, when a graphic is
imported, all characters after the last period in the file
name become the file extension.
Graphic priority list The Base administration data provides these graphic priority
lists in the Organization application, which you can use to
associate with graphics and editing and publishing tools as
desired:
• EDIT
Includes graphics with these uses, in this priority: VIEW,
WEB PDF, PRINT.
In the example data, this is used by the XMetaL 9.0
editing tool.

• PUBLISH TO HTML
Includes graphics with these uses, in this priority: VIEW,
WEB.
In the example data, this is used by the serverside HTML
publish publishing tool.

• PUBLISH TO PDF
Includes graphics with these uses, in this priority: VIEW,
WEB.
In the example data, this is used by the PDF serverside
publishing tool.

• REVIEW
Includes graphics with these uses, in this priority: VIEW,
WEB.

• VIEW
Includes graphics with these uses, in this priority: VIEW,
WEB, PDF, PRINT, THUMBNAIL.
In the example data, this is used by the FOP and
InternalViewer publishing tools.

11-2 Content Management PLM00014 12.2

 Pre-configured Base Content Management objects

Object type Included objects

Language The Base administration data configures 28 languages in the
Organization application.
You can add and remove languages as necessary. To minimize
the menu options users must scroll through, it is recommended
that you remove any languages that you do not use.

PLM00014 12.2 Content Management 11-3

Chapter 12: Relating administrative items to enable authoring

Relating administrative items

Administrators relate items such as stylesheets to style types, stylesheets to tools, schemas to topic
types, and XML attribute mappings to topic types. Schemas and stylesheets have revisions; therefore
when you relate items to schemas and stylesheets, you relate the item to the revisions.
You can relate an item to many parent items, creating multiple instances of the same item. Whenever
the item is modified at one location, the modifications are reflected in all locations where the item
is reused.
When you relate administrative items, you build the constraints that govern how authors can create
and work with publications.
The following shows an example of a topic type with a related XML attribute mapping, schema
revision, and stylesheet revision.

When you select an item in the Home component view, its related child items are listed in the Details
view, which also shows the type of relation between the two items.

Relate one administrative item to another

Note
To relate a topic type to itself, you must use the Copy→Paste option instead of dragging
the topic type.

1. In the Home component view, locate the item you want to relate and drag it to the parent item
you want to relate it to.

2. When the parent item appears highlighted, release the mouse button.
The child item appears in the structure below the parent item.

PLM00014 12.2 Content Management 12-1

Chapter 13: Managing objects for DITA authoring

Creating objects for DITA authoring

DITA (Darwin Information Typing Architecture) is an XML-based architecture for developing technical
publications. It includes an architectural specification, language specification, and DTD and schema
implementations of the language. DITA Content Management is an optional Teamcenter solution.
To create the required objects for managing documentation for the DITA standard, you can import the
DITA administration data. The DITA objects are related to version 1.0/1.1, 1.2, or 1.3 of the DITA
DTDs. If you prefer to import modified versions of these DTDs or the DTD schemas, you must create
and configure additional objects and import those DTDs.

Note
• It is recommended that you maintain an unchanged version of the provided objects for
testing and comparison purposes.

• DITA publishing is supported only on Linux and Windows and relies on the DITA
Open Toolkit (OT).

Objects you create include:

• DITA topic types

• DITA maps

• DITA composites

• DITA value filters

• Reference types

• Schemas

• Stylesheets

• XML attribute mappings

• DITA OT publishing tools

DITA 1.0/1.1 topic authoring objects

The DITA administration data includes the following topic types for DITA 1.0/1.1 topics, shown here
with their related objects. You manage these topic types, along with the related objects required for
them to function, so that authors can create and manage DITA topics.

PLM00014 12.2 Content Management 13-1

 Chapter
Chapter 13:13:Managing
Managing objects
objects for DITA
for DITA authoring
authoring

• DITA Generic Topic

• DITA Concept

• DITA Reference

13-2 Content Management PLM00014 12.2

 Managing objects for DITA authoring

• DITA Task

DITA 1.0/1.1 composite authoring objects

The DITA administration data includes a topic type for DITA 1.0/1.1 composites. The DITA composite,
or DITA base, object provides a top-level container for multiple topics when you create single content
documents. It allows the creation of any sequence of generic topics, tasks, concepts, and references.

PLM00014 12.2 Content Management 13-3

 Chapter
Chapter 13:13:Managing
Managing objects
objects for DITA
for DITA authoring
authoring

Note
An XML attribute mapping for defining the translation attribute mappings is not necessary
on DITA composite publication types, because DITA composites are not translated.
Translations are performed on the topics inside the composite.
When using the content of a DITA composite, the reference should be made to the top
level topic within the DITA composite, not the composite itself. Only one top level topic
should be included; all others should be nested or referenced.

DITA 1.0/1.1 map and bookmap authoring objects

The DITA administration data includes topic types for DITA 1.0/1.1 maps. A DITA map is an object
that contains references to DITA topics and organizes the topics into hierarchies, tables, or groups. A
map can contain any combination of references to DITA topics, DITA tasks, DITA concepts, DITA
references, and other DITA maps. Maps are used to create documents that result in separate XML
files in output processing. The <map> element is used in the XML to define a map. Authors can
work with two types of maps: dynamic and static.
Authors can organize topics in a DITA dynamic map in Content Management and edit contents in an
editing tool. Topic references in a DITA static map can be edited in an editing tool but not in Content
Management. A DITA bookmap is a type of dynamic map. The <bookmap> element is used in the
XML to define a bookmap.
bi
The sample data includes the following topic types for DITA maps, shown here with their related
objects.

13-4 Content Management PLM00014 12.2

 Managing objects for DITA authoring

• DITA Dynamic Map

• DITA Static Map

PLM00014 12.2 Content Management 13-5

 Chapter
Chapter 13:13:Managing
Managing objects
objects for DITA
for DITA authoring
authoring

• DITA Bookmap

DITA 1.2 topic authoring objects

The DITA administration data includes the following topic types for DITA 1.2 topics, shown here with
their related objects. You manage these topic types, along with the related objects required for them
to function, so that authors can create and manage DITA topics.

13-6 Content Management PLM00014 12.2

 Managing objects for DITA authoring

• DITA Generic Topic

PLM00014 12.2 Content Management 13-7

 Chapter
Chapter 13:13:Managing
Managing objects
objects for DITA
for DITA authoring
authoring

• DITA Concept

13-8 Content Management PLM00014 12.2

 Managing objects for DITA authoring

• DITA Reference

PLM00014 12.2 Content Management 13-9

 Chapter
Chapter 13:13:Managing
Managing objects
objects for DITA
for DITA authoring
authoring

• DITA Task

DITA 1.2 composite authoring objects

The DITA administration data includes a topic type for DITA 1.2 composites. The DITA composite, or
DITA base, object provides a top-level container for multiple topics when you create single content
documents. It allows the creation of any sequence of generic topics, tasks, concepts, and references.

Note
An XML attribute mapping for defining the translation attribute mappings is not necessary
on DITA composite publication types, because DITA composites are not translated.
Translations are performed on the topics inside the composite.
When using the content of a DITA composite, the reference should be made to the top
level topic within the DITA composite, not the composite itself. Only one top level topic
should be included; all others should be nested or referenced.

13-10 Content Management PLM00014 12.2

 Managing objects for DITA authoring

DITA 1.2 map authoring objects

The DITA administration data includes topic types for DITA 1.2 maps. A DITA map is an object that
contains references to DITA topics and organizes the topics into hierarchies, tables, or groups. A
map can contain any combination of references to DITA topics, DITA tasks, DITA concepts, DITA
references, and other DITA maps. Maps are used to create documents that result in separate XML
files in output processing. The <map> element is used in the XML to define a map.
Authors can organize topics in a DITA dynamic map in Content Management and edit contents in
an editing tool. A DITA bookmap is a type of dynamic map. The <bookmap> element is used in the
XML to define a bookmap.
The sample data includes the following topic types for DITA maps, shown here with their related
objects.

PLM00014 12.2 Content Management 13-11

 Chapter
Chapter 13:13:Managing
Managing objects
objects for DITA
for DITA authoring
authoring

• DITA Dynamic Map

13-12 Content Management PLM00014 12.2

 Managing objects for DITA authoring

• DITA Bookmap

DITA 1.2 anchor and anchorref objects

The DITA administration data includes the DITA 1.2 anchor and anchorref topic types, shown here
with their related objects. The anchorref objects enable authors to define a map fragment that is
copied to the location defined by an anchor object.

DITA 1.3 topic authoring objects

The DITA administration data includes the following topic types for DITA 1.3 topics, shown here with
their related objects. You manage these topic types, along with the related objects required for them
to function, so that authors can create and manage DITA topics.

PLM00014 12.2 Content Management 13-13

 Chapter
Chapter 13:13:Managing
Managing objects
objects for DITA
for DITA authoring
authoring

• DITA Generic Topic

13-14 Content Management PLM00014 12.2

 Managing objects for DITA authoring

• DITA Concept

PLM00014 12.2 Content Management 13-15

 Chapter
Chapter 13:13:Managing
Managing objects
objects for DITA
for DITA authoring
authoring

• DITA Reference

13-16 Content Management PLM00014 12.2

 Managing objects for DITA authoring

• DITA Task

DITA 1.3 composite authoring objects

The DITA administration data includes a topic type for DITA 1.3 composites. The DITA composite, or
DITA base, object provides a top-level container for multiple topics when you create single content
documents. It allows the creation of any sequence of generic topics, tasks, concepts, and references.

Note
An XML attribute mapping for defining the translation attribute mappings is not necessary
on DITA composite publication types, because DITA composites are not translated.
Translations are performed on the topics inside the composite.
When using the content of a DITA composite, the reference should be made to the top
level topic within the DITA composite, not the composite itself. Only one top level topic
should be included; all others should be nested or referenced.

PLM00014 12.2 Content Management 13-17

 Chapter
Chapter 13:13:Managing
Managing objects
objects for DITA
for DITA authoring
authoring

DITA 1.3 map authoring objects

The DITA administration data includes topic types for DITA 1.3 maps. A DITA map is an object that
contains references to DITA topics and organizes the topics into hierarchies, tables, or groups. A
map can contain any combination of references to DITA topics, DITA tasks, DITA concepts, DITA
references, and other DITA maps. Maps are used to create documents that result in separate XML
files in output processing. The <map> element is used in the XML to define a map.
Authors can organize topics in a DITA dynamic map in Content Management and edit contents in
an editing tool. A DITA bookmap is a type of dynamic map. The <bookmap> element is used in the
XML to define a bookmap.
The sample data includes the following topic types for DITA maps, shown here with their related
objects.

13-18 Content Management PLM00014 12.2

 Managing objects for DITA authoring

• DITA Dynamic Map

PLM00014 12.2 Content Management 13-19

 Chapter
Chapter 13:13:Managing
Managing objects
objects for DITA
for DITA authoring
authoring

• DITA Bookmap

DITA 1.3 anchor and anchorref objects

The DITA administration data includes the DITA 1.3 anchor and anchorref topic types, shown here
with their related objects. The anchorref objects enable authors to define a map fragment that is
copied to the location defined by an anchor object.

Other DITA 1.3 topic types

The DITA administration data includes several other DITA 1.3 topic types, shown here.

13-20 Content Management PLM00014 12.2

 Managing objects for DITA authoring

DITA publishing tools

The DITA administration data includes the following publishing tools, used for the DITA 1.0/1.1,
1.2, and 1.3 standards. Content Management supports version 2.4.6 of the DITA Open Toolkit
(OT) publishing tools. You manage these publishing tools so that authors can view and publish
DITA content.

Publishing Tool Purpose

DITA Open Toolkit RTF Publishes DITA content to RTF.
DITA Open Toolkit XHTML Publishes DITA content to XHTML.
DITA Open Toolkit PDF Publishes DITA content to PDF.
DITA Open Toolkit HTML 5 Publishes DITA content to HTML 5.

Note
• Set the path for DITA_ANT_HOME in the Dispatcher_Root\Module\Translators\
contmgmtpublish\config\contmgmtpublish_config.properties file. The path must
be set to the Ant directory in the DITA OT.

• To use an older version of DITA OT, copy the older version of DITA OT to: the
Dispatcher_Root\Module\Translators\contmgmtpublish\lib folder.

PLM00014 12.2 Content Management 13-21

 Chapter
Chapter 13:13:Managing
Managing objects
objects for DITA
for DITA authoring
authoring

DITA OT publishing tools support the following image formats, although .tif and .png formats may not
be supported for PDF output:
• .jpg

• .gif

• .bmp

• .tif

• .eps

• .svg

• .png

DITA stylesheets
The DITA administration data includes the stylesheet objects for Content Management, under the
DITA style type, used for the DITA 1.0/1.1, 1.2, and 1.3 standards.

Stylesheet Used for

DitaOT_RTF Publishing DITA maps to PDF, with the resulting content in
RTF format.
DitaOT_HTML5 Publishing DITA composite topics and maps to PDF, with the
resulting content in HTML 5 format.
DitaOT_XHTML Publishing DITA composite topics and maps to PDF, with the
resulting content in XHTML format.
DitaOT_PDF Publishing DITA composite topics and maps to PDF, with the
resulting content in PDF format.

The actual stylesheet files are included with the DITA Open Toolkit installation on the Dispatcher and
are stored in this directory:
Dispatcher\Module\Translators\contmgmtpublish\lib\dita-ot

The dataset attached to the stylesheets is the build.xml file, which is used by the ANT command.
The ANT command is executed by the Dispatcher, which uses the stylesheets in the above directory.
The build.xml file is located here:
\tc_root\contmgmtdita_data\data\admin\contmgmtdita_admindata\build.xml

13-22 Content Management PLM00014 12.2

 Managing objects for DITA authoring

You can modify the stylesheets for your organization’s needs for viewing and publishing DITA content.
To use different stylesheets for the same tool, you must create new style types. For example, you
may have a style type for parts manuals that includes all the stylesheets used for that type of
publication and another style type and stylesheets for work instructions.

Create a DITA value filter

A DITA value filter contains a table of values that are used to filter topics in a DITA map when you
publish it, based on certain attributes in the topics. For example, you can exclude topics whose
Audience attribute is Advanced or Expert, so that the map includes only those topics whose Audience
is Beginner.
Administrators create these types of DITA value filters. Authors may create DITA value filters by
creating a topic with the Ditaval topic type.
1. Select the folder in which you want to create the new topic type or publication type, and then
either click New Administrative Item... , or choose File→New→New Administrative Item.

2. In the New Administrative Item dialog box, expand Complete List, click DITA Value Filter,
and then click Next.

3. In the dialog box, in the Name box, type a name for the filter.

4. Click Finish.

5. Open the Summary view and select the DITA value filter.

6. Under DITA Value Filter Table, click Add.

7. In the dialog box, do the following to add a filter action:

From this list Select this

DITA Action The type of action on which the filter will be used.
DITA Attribute Name The attribute on the objects that you want the filter to use.
DITA Value The value assigned to the attribute that you want the filter to use.

Note
Additional values can be added using Business Modeler
IDE.

Caution
DITA filter values cannot contain spaces.

8. Click Finish.

9. For each filter action you want to add, repeat the above two steps.

PLM00014 12.2 Content Management 13-23

 Chapter
Chapter 13:13:Managing
Managing objects
objects for DITA
for DITA authoring
authoring

Editing DITA object lists of values (LOVs)

When authors create DITA items or apply DITA value filters, they can choose from predefined values
for audience, platform, product, and other properties. Administrators set the allowed values for
these properties using Business Modeler IDE.

Caution
Values in DITA LOVs cannot contain spaces.

13-24 Content Management PLM00014 12.2

Chapter 14: Managing objects for S1000D authoring

Creating objects for S1000D authoring

S1000D is an international specification for technical publications utilizing a Common Source
Database. S1000D Content Management is an optional Teamcenter solution.
To create the required objects for managing documentation for the S1000D standard, you can import
the S1000D administration data for S1000D versions 2.2/2.3, 4.0.1, 4.1, or 4.2. These administration
objects support the content types defined in the S1000D standard for these versions.

Note
It is recommended that you maintain an unchanged version of the provided S1000D
objects for testing and comparison purposes.

S1000D 2.2 and 2.3 topic authoring objects

The S1000D administration data includes the following topic types in the S1000D-2-3 and S1000D-2-2
topic type groups. You manage these topic types, along with the related objects required for them to
function, so that authors can create and manage S1000D topics.

PLM00014 12.2 Content Management 14-1

 Chapter
Chapter 14:14:Managing
Managing objects
objects for S1000D
for S1000D authoring
authoring

Each topic type has related objects. For example the data module topic type for version 2.3 has a
related reference topic type, XML attribute mapping, and schemas:

S1000D 4.0.1 topic authoring objects

The S1000D administration data includes the following topic types for the S1000D-4-0 topic type
group. You manage these topic types, along with the related objects required for them to function, so
that authors can create and manage S1000D topics.

Each topic type has related objects. For example the data module, process, and SCORM package
topic types for version 4.0.1 have related reference topic types, XML attribute mappings, and

14-2 Content Management PLM00014 12.2

 Managing objects for S1000D authoring

schemas:

S1000D 4.1 topic authoring objects

The S1000D administration data includes the following topic types for the S1000D-4-1 topic type
group. You manage these topic types, along with the related objects required for them to function, so
that authors can create and manage S1000D topics.

PLM00014 12.2 Content Management 14-3

 Chapter
Chapter 14:14:Managing
Managing objects
objects for S1000D
for S1000D authoring
authoring

Each topic type has related objects. For example the data module, process, and SCORM content
package topic types for version 4.1 have related reference topic types, XML attribute mappings, and
schemas:

14-4 Content Management PLM00014 12.2

 Managing objects for S1000D authoring

S1000D 4.2 topic authoring objects

The S1000D administration data includes the following topic types for the S1000D-4-2 topic type
group. You manage these topic types along with the related objects required for them to function.
This enables authors to create and manage S1000D topics.

PLM00014 12.2 Content Management 14-5

 Chapter
Chapter 14:14:Managing
Managing objects
objects for S1000D
for S1000D authoring
authoring

Each topic type has related objects. For example, the data module, process, and SCORM content
package topic types for version 4.2 have related reference topic types, XML attribute mappings, and
schemas:

14-6 Content Management PLM00014 12.2

 Managing objects for S1000D authoring

Using S1000D standard numbering system (SNS) structures

An S1000D standard numbering system (SNS) structure defines the applicable product structure
users document and the numbering scheme used in data modules for specific S1000D 4.0, 4.1, and
4.2 projects. When you create a new data module in Content Management, you select a node of an
SNS structure to apply its data module code (DMC) values and other data module detail values to
the data module.

When you import data modules that use SNS codes, they are related to the appropriate node in
the SNS structure based on that portion of their DMC. Imported graphics are also related to the
node based on their SNS. Objects that don’t use an SNS, such as data dispatch notes, publication
modules, and graphics with commercial and government entity (CAGE) codes, are related to the top
node of the SNS structure.

The SNS typically consists of a structure with the following nodes:

• Root node that contains the data module code values and other data module values, such as the
originator name and responsible party details

• System nodes that specify the titles, codes, and descriptions for the various system levels of
the structure

• Subsystem nodes that specify the titles, codes, and descriptions for the various subsystem
levels of the structure

• Assembly nodes that specify the titles, codes, and descriptions for the various assembly levels
of the structure

PLM00014 12.2 Content Management 14-7

 Chapter
Chapter 14:14:Managing
Managing objects
objects for S1000D
for S1000D authoring
authoring

• Disassembly nodes that specify the titles, codes, and descriptions for the various disassembly
levels of the structure

An SNS also defines data module information codes, which specify the data module types used
in a project. In Content Management, information code objects include the S1000D standard
three-character code, a name, a description, and the topic type reference for each data module type.
For example, the information code for a 4.1 procedural data module is 121. You may edit the name
and description values for each information code.

Create, import, and edit S1000D SNS structures

You can create an S1000D standard number system (SNS) structure in Content Management, node
by node, or create an SNS structure XML file and import it to Content Management.
A sample SNS structure and SNS schema are included in the administration data provided with
the Content Management installation:
TC_ROOT\contmgmts1000d40_data\data\admin\BIKESNS.xml

TC_ROOT\contmgmts1000d40_data\data\admin\sns.xsd

Import an S1000D SNS structure

When you import an SNS structure, the entries in the XML file define the objects and relationships
created in the database, including the SNS root node, related nodes, and information codes used
for the specific project.
1. Select the folder in which you want to place the imported SNS structure, and then choose
Tools→Import→S1000D Project Data→Standard Numbering System (SNS) Structure.

2. In the Bulk Import dialog box, browse to and select the file you want to import.

3. Click OK.

Create an S1000D SNS structure in Content Management

1. Select the folder in which you want to create the new SNS.

2. Either either click New Administrative Item... , or choose File→New→New Administrative

Item.

3. In the New Administrative Item dialog box, expand Complete List, click Standard Numbering
System Root Node, and then click Next.

4. In the dialog box, enter the data for the SNS root node you are creating, according to the S1000D
standard.
For more information on the S1000D standard, see www.S1000D.org.

5. Click Finish.

6. Add nodes to the structure using File→New→New Administrative Item→Standard Numbering

System Node.

14-8 Content Management PLM00014 12.2

 Managing objects for S1000D authoring

Edit an SNS structure

1. In the Home component view, select the SNS structure you want to edit.

2. Open the Summary view.

3. Check out the SNS structure.

4. Edit the properties of the SNS structure in the Summary view.

5. Check in the SNS structure.

Enable publishing of CGM graphics in S1000D content

Graphics in the computer graphic metafile (CGM) format are used in S1000D publications. If you are
using the publishing tools provided in the Content Management installation, you must take steps for
CGM graphics to display in published output. If you are using other publishing tools, these steps
may not apply.

Enable graphics to display in XHTML output

• To enable graphics to display in XHTML output, install a CGM viewer on the client.

Enable graphics to display in PDF output

1. Download these JAR files:

Note
These links are current as of the time of publication. They may differ from the links
listed here.

• jai_imageio_windows_i586.jar
This file is available from:
http://www.oracle.com/technetwork/java/javasebusiness/downloads/
java-archive-downloads-java-client-419417.html#7380-JAI-1.1.1_01-oth-JPR
Select Windows Signed Auto-Install (jai_imageio-1_0_01-windows-i586-jar.zip).

• jcgm-core-0.2.0.jar
This file is available from: http://jcgm.sourceforge.net/download.html
Select jcgm-core-0.2.0-bin.zip.

• jcgm-image-0.1.1.jar
This file is available from: http://jcgm.sourceforge.net/download.html
Select jcgm-image-0.1-1-bin.zip.

2. Save the JAR files to this folder in the dispatcher root directory:

PLM00014 12.2 Content Management 14-9

 Chapter
Chapter 14:14:Managing
Managing objects
objects for S1000D
for S1000D authoring
authoring

Dispatcher\Module\Translators\contmgmtpublish\lib

Configure Publication Structure columns for S1000D content

When authors work with the S1000D standard, you can configure the Publication Structure view so
that it contains default columns that are useful for working with S1000D objects. To do this, you can
import the preferences XML file provided with the Content Management installation that defines the
three preferences for controlling the column configuration in the view. You can modify this file before
you import it to meet your organization's needs. Authors can also change the column configuration
in the Publication Structure view to meet their individual needs. If authors change their column
configurations before you import the preference file, the imported preferences do not affect the
columns configurations in their environments.
1. Review the preference XML file for the definitions it contains, at this location:
TC_ROOT\contmgmts1000d40_data\data\admin\contmgmts1000d40_column_heading_
preference_override.xml
The file sets these columns as the default:

• Item Id

• Document Title

• In Work

• Issue Number

• Topic Type

2. Modify the file if necessary to meet your organization's needs.

3. Choose Edit→Options.

4. In the Options dialog box, click Search at the bottom of the dialog box.

5. In the Preferences by Search pane, click the Import tab.

6. From the Import File Name box, browse for and select the preference file:
TC_ROOT\contmgmts1000d40_data\data\admin\contmgmts1000d40_column_heading_
preference_override.xml

7. From the To Location box, select Site.

8. Click Import.

Tip
To verify the import, search for the ContentManagerColumnsShownPref preference
and verify that the values represent the columns defined in the XML preference file.

14-10 Content Management PLM00014 12.2

 Managing objects for S1000D authoring

Modifying S1000D stylesheets

S1000D XSL stylesheets are used to transform S1000D documents (data modules or publication
modules that contain data modules) to PDF or XHTML for viewing and printing. XSL stylesheets are
provided with the Content Management installation and stored on Teamcenter Dispatcher.
When you publish S1000D documents, the Dispatcher generates output as follows:
PDF output:
1. The S1000D XML is transformed into DocBook XML using the s1000dtodb stylesheet.

2. The DocBook XML is transformed into an XSL-FO document using the dbtofo stylesheet.

3. The XSL-FO document is processed into the PDF file, using a formatting program such as
Formatting Objects Processor (FOP).

XHTML output:
1. The S1000D XML is transformed into DocBook XML using the s1000dtodb_xhtml stylesheet.

2. The DocBook XML is transformed into XHTML using the dbtoxhtml stylesheet and the
Xalan program.

To customize the stylesheets, update or add stylesheets on the Dispatcher in the following subfolders
of the ...\Translators\contmgmtpublish\lib\s1000dpublish folder.
• For PDF output, use the stylesheets in the s1000dtodb and dbtofo folders.

• For XHTML output, use the stylesheets in the s1000dtodb and dbtoxhtml folders.

If the build process must be modified, update the build_pdf.xml or build_xhtml.xml files by editing
the S1000D PDF or S1000D XHTML stylesheets in Content Management, by using Edit→Edit
Stylesheet.

PLM00014 12.2 Content Management 14-11

Chapter 15: Creating schema objects

Overview of schemas in Content Management

You use schemas to define the structure of elements and attributes that can be used in the XML or
SGML files created by the authors in your organization. In Content Management, a schema object
corresponds to a schema file that you import to the database when you create the schema object.
XML topic types are not required to have a related schema, but it is recommended to always relate at
least one. The topic type is related to the schema revision. A schema may also be referenced as
an external entity with another schema. Each SGML topic type must have three related schemas:
an SGML declaration, an SGML DTD, and an SGML catalog file.
You can create your own schemas or use standard schemas, such as those from the S1000D
standard. You import the S1000D standard schemas when you import the S1000D administration
data.
Content Management supports several methods for defining XML and SGML document structure.
You may choose from the following schema types:
• DTD
A DTD is used to validate XML content. It is optional for XML topic types, and it is not used for
SGML topic types (see SGML DTD below). If no DTD is present, XML content is not validated,
and some editing tools may not work correctly.

• Character entity map

A character entity map enables the replacement of certain characters with character entities
during attribute mapping. It is optional for both XML and SGML. If no character entity map is
present, a default character entity map is used.

• Example content
Example content is used as default content for newly created topics. It is optional for both XML
and SGML. If no example content is present, newly created topics will be based on the DTD only.

• SGML DTD and declaration file

The SGML DTD and SGML declaration file are used to validate SGML content. They are required
for SGML topic types. They are not used for XML topic types.

• SGML catalog file

The SGML catalog file lists all supporting files necessary to parse an SGML file. It is required for
SGML topic types. It is not used for XML topic types.

• XML Schema
An XML schema is used to validate XML content similarly to DTDs, with additional capabilities.

PLM00014 12.2 Content Management 15-1

 Chapter
Chapter 15:15:Creating
Creating schema
schema objects
objects

Importing a schema
You can import a schema two ways:

• Import the schema when you create a schema object.

• Import the schema using the PLM XML method. This is useful for transferring between test and
production systems. The data models must be the same between the two systems.

Create a schema object

1. (Optional) Select the folder in which you want to create the new schema.

2. Either click New Administrative Item... , or choose File→New→New Administrative Item.

3. In the New Administrative Item dialog box, expand Complete List, click Schema, and then
click Next.

4. Do the following:

For this option Do this

ID Either type an ID for the schema, or leave the box blank so that the
next available item ID is automatically assigned.
Revision Either type a revision for the schema, or leave the box blank so that
the next available revision is automatically assigned.
Name Type the name for the schema.
Public ID Type the public ID for the schema, which must correspond to the
public ID as it is defined in the schema file. This cannot be modified
after the schema has been created.
Schema Type Select the type of schema you are creating.
Select Content Click Browse to select the content file of the schema.

5. Click Finish.

Create an XML schema object

1. (Optional) Select the folder in which you want to create the new XML schema.

2. Either click New Administrative Item... , or choose File→New→New Administrative Item.

3. In the New Administrative Item dialog box, expand Complete List, click XML Schema, and
then click Next.

4. Do the following:

15-2 Content Management PLM00014 12.2

 Creating schema objects

For this option Do this

ID Either type an ID for the XML schema, or leave the box blank so that
the next available item ID is automatically assigned.
Revision Either type a revision for the XML schema, or leave the box blank so
that the next available revision is automatically assigned.
Name Type the name for the XML schema.
Public ID Type the public ID for the XML schema, which must correspond
to the public ID as it is defined in the schema file. This cannot be
modified after the schema has been created.
Default Prefix Prefix that represents the namespace URI, if a namespace URI
is used.
Schema File Name File name of the schema document that has a target namespace,
if a namespace is used.
Select Content Click Browse to select the content file of the XML schema.

5. Click Finish.

PLM00014 12.2 Content Management 15-3

Chapter 16: Creating topic and publication types

Overview of topic and publication types

In Base Content Management, a publication type is the topmost object in the underlying XML
structure that defines how authors can assemble publications. A topic type is a component of a
publication type that defines a single node in a publication structure definition. You create publication
and topic types for each type of topic and publication that authors may create.
In S1000D and DITA Content Management, topic types are predefined to match the objects for the
standard, for the versions of the standard that are supported, for example, an S1000D data module or
a DITA concept topic. However, before content authors can create these objects, you must create
these topic types in your system or import them from the Content Management administration data or
data from a prior installation.
The structures of the publication and topic types that you create must match the XML tag structure
defined in the DTDs or schemas. The schema revision that is related to a topic or publication type
defines the valid structure of the content when it is edited and published.
The dialog box you use to create a topic type is the same for all types, Base, S1000D, and DITA.
To specify the type of object, you select the appropriate class in the Apply classname option in
the dialog box.
A topic type is related to other topic and publication types, stylesheet revisions, an XML attribute
mapping, and a schema revision. Topic types are related to a different stylesheet revision for each
method in which they are published. For example, a topic type may be related to one stylesheet
revision for publishing to HTML and another for publishing a PDF.

Note
To relate a topic type to itself, you must use the Copy→Paste option instead of dragging
the topic type.

You can also create reference types used to contain extra data used for building links and references
to topics, such as for the functioning of graphics within content.

Tip
Reference types are required for the functioning of graphics within content. You must have
a Content Graphic Reference reference type related to each topic type.

You can create topic type groups to use with the ctm0TopicTypeGroup preference to limit the topic
types that can be used for creating new topics.

PLM00014 12.2 Content Management 16-1

 Chapter
Chapter 16:16:Creating
Creating
topictopic and publication
and publication typestypes

Create a topic type or publication type

1. Select the folder in which you want to create the new topic type or publication type, and then
either click New Administrative Item... , or choose File→New→New Administrative Item.

2. In the New Administrative Item dialog box, expand Complete List, click Topic Type or
Publication Type, and then click Next.

3. In the dialog box, do the following:

For this option Do this

Name Type the name of the topic type or publication type to appear in
the structure tree.
Root Element Name Type the root tag name of the topic type or publication type, which
must correspond to the root tag as it is defined in the schema related
to the topic type. When a document is parsed, this identifies where
to start the new topic object and the type of object to create.
If multiple topic types within the same structure have the same Local
Tag Name, enter the Topic Type Condition below, to distinguish
the topic types.
Usage Select one of the following:
• SYSTEM
The topic type will not appear in selection lists in dialog boxes,
such as those for creating topics.

Note
This is used for special purposes only, such as
for adding new objects that may not be ready for
general use or for objects to be used only by system
processes, such as workflows.

• USER
The topic type will appear in selection lists in the appropriate
dialog boxes, such as those for creating topics.
Validate Incoming Select either True or False, to specify whether data being saved to
the database is validated when content is decomposed.
If True is selected, invalid content produces an error.
Typically, this type of validation is not required if your editing tool
validates content, and it may affect processing time.

16-2 Content Management PLM00014 12.2

 Creating topic and publication types

For this option Do this

Validate Outgoing Select either True or False, to specify whether data being retrieved
from the database is validated when content is composed.
If True is selected, invalid content produces an error.
Typically, this type of validation is not required if your editing tool
validates content, and it may affect processing time.
Validate Example If the topic type is related to a schema with the EXAMPLE_CONTENT
Content schema type, select either True or False, to specify whether the
example content is validated when it is used during compose.
If True is selected, invalid content produces an error.
Typically, this type of validation is not required if your editing tool
validates content, and it may affect processing time.
Class Name Applied Select the Teamcenter subclass of topic that is associated with this
topic type.
The S1000D and DITA entries are available only if the corresponding
solution is installed.
• Topic (Base topic)

• Publication (Base publication)

• S1000D Data Dispatch Note

• S1000D Data Module

• S1000D In Process Review Form

• S1000D Publication Module

• S1000D Data Module List

• S1000D Commentary

• DITA Dynamic Map

• DITA Static Map

• DITA Topic

• DITA Task

• DITA Base

• DITA Reference

PLM00014 12.2 Content Management 16-3

 Chapter
Chapter 16:16:Creating
Creating
topictopic and publication
and publication typestypes

For this option Do this

• DITA Concept

• Non-topic Item

Note
This supports Teamcenter items and subclasses.

Non-topic Class Names Add the Teamcenter subclass of objects that are associated with
this topic type.
(For DITA solution only) Select the appropriate transfer mode for the topic type, to control
Transfer Mode how referenced topics are included during compose:
• For DITA map topic types, select the cdi0_DITAMultiContent
transfer mode.

• For DITA composite, topic, concept, reference, and task topic

types, select the cdi0_DITASingleContent transfer mode.
File Extension Select the appropriate extension to be applied to topics of this topic
type.
Namespace URI Type the URI that serves as a unique identifier for the namespace.

Tip
Namespaces allow different XML vocabularies to be used
in a single XML document and provide an XML parser a
means to categorize each vocabulary. Although this is a
URI, it is not used to identify and retrieve a Web address.

Default Namespace Type the prefix that represents the namespace URI. The prefix
Prefix is added to the beginning of element names to place them in the
namespace.
(When creating a topic If multiple topic types within the same structure have the same Local
type) Topic Type Tag Name, type a topic type condition value to restrict the topic
Condition type, using either containspath, insidepath, or containsvalue,
along with a specified value or path.
If the Local Tag Name of all topic types in a structure is unique,
this attribute is not used.

4. Click Finish.

5. Relate the following objects to the topic or publication type:

• Relate the topic or publication type to other topic and publication types to create a publication
structure.

16-4 Content Management PLM00014 12.2

 Creating topic and publication types

Note
To relate a topic type to itself, you must use the Copy→Paste option instead of
dragging the topic type.

• Relate the schema revision that applies to the topic or publication type.

• Relate the stylesheet revision that applies to the topic or publication type.

• Relate the XML attribute mappings that apply to the topic or publication type.

Topic type conditions

In cases where you want to define multiple topic types using the same tag name, you must use a
topic type condition to distinguish one topic type from another when you create a topic or publication
type. This enables the system to identify topic types that begin with the same initial element and
delineate them based on lower level elements or attributes.

If a topic type condition is defined, it will be used by the system to determine which topic types
are assigned to topics when they are imported or when they are decomposed to be saved to the
database after being created in an XML editor.

In all cases, the syntax used within the condition field is the name of the condition, followed by
parenthesis which contain the values. Examples are provided below.

You may use the following topic type conditions:

Condition Function Example

containspath This condition causes To differentiate the topic type dmodule-age
the system to assign a with element dmodule from the alternative
topic type if the XML in a dmodule-avee, this topic type condition is
topic has a specific series assigned in the Topic type condition box:
of elements or tags that
contain a specific path. Example
containspath(/dmaddress/dmc/avee)

If a topic with the following XML

is imported, since it contains the
path specified in the condition, the
dmodule-avee topic type is assigned:
<dmodule>
<idstatus>
<dmaddress>
<dmc>
<avee>
<modelic>S1000DBIKE</modelic>
</avee>

PLM00014 12.2 Content Management 16-5

 Chapter
Chapter 16:16:Creating
Creating
topictopic and publication
and publication typestypes

Condition Function Example

</dmc>

Example
containspath(/dmaddress/dmc/age)

If a topic with the following XML

is imported, since it contains the
path specified in the condition, the
dmodule-age topic type is assigned:
<dmodule>
<idstatus>
<dmaddress>
<dmc>
<age>
<modelic>S1000DBIKE</modelic>
</age>
</dmc>

containsvalue This condition causes the To differentiate the topic type dmodule-dmc
system to assign a topic with the element dmodule from the alternative
type if the XML in a topic dmodule-arv, this topic type condition is assigned
has an element or attribute in the Topic type condition box:
that contains a specific
containsvalue(/ddnfilen,DMC.*)
value. For example:
containsvalue(/tag/
If a topic with the following XML is imported, since
subtag/subtag/subtag/
it contains a ddnfilen element that contains text
@attribute,ref)
that starts with DMC, the dmodule-dmc topic
type is assigned.
or
<dmodule>
containsvalue(/path/ <ddnfilen>DMC-111–333–444–555.SGM</ddnfilen>
tag,textstring)
insidepath This condition causes the For the topic type refdmavee with the element
system to assign a topic avee, this topic type condition is assigned:
type if the XML in a topic
insidepath(/refdm)
has a specific element or
tag that is inside a specific If a topic with the following XML is imported, since
parent element or a specific it contains the avee element inside the refdm
path. element, the refdmavee topic type is assigned.
<refdm>
<avee>
<modelic>S1000DBIKE</modelic>
<sdc>AAA</sdc>
</avee>
</refdm>

16-6 Content Management PLM00014 12.2

 Creating topic and publication types

Create a topic type group

You can create topic type groups to use with the ctm0TopicTypeGroup preference to limit the topic
types that can be used for creating new topics.
1. Select the folder in which you want to create the new topic type group, and then either click New
Administrative Item... , or choose File→New→New Administrative Item.

2. In the New Administrative Item dialog box, expand Complete List, click Topic Type Group,
and then click Next.

3. In the dialog box, type a name for the group in the Name box.

4. Click Finish.

5. Relate topic types to the topic type group so that the topic type group contains all the topic types
you want to be available when creating a topic.

PLM00014 12.2 Content Management 16-7

Chapter 17: Creating a publication structure

What is a publication structure?

A publication structure is generally described as a set of topics related together to make a larger
document, such as a publication with a header and footer, chapters, sections, and components, as
in this example:

Administrators relate publication and topic types to define the structures that authors can use
to create documents. The structure must match the composition of schemas related to the
corresponding topic types. If a topic type has no related schema, you cannot edit or publish topics
at that level in the structure.
Once a publication structure is created, when content authors create a new publication with the
publication type defined in the structure, they are restricted to adding only topics with the defined
topic types at the allowed locations in the structure.

Define a structure for publication authoring

1. In the Home component view, create the topic and publication types that match the elements in
your organization's schemas.

2. Relate the publication and topic types to create a structure that matches the hierarchy of the
schemas.

PLM00014 12.2 Content Management 17-1

Chapter 18: Enabling references and links

Overview of reference types

Create reference topic types for use with XML content to identify the syntax used for building links and
references to topics. Reference topic types are related to topic types and XML attribute mappings
and hold values that include the file or content and context of the target of a link. Several reference
types are supplied with the DITA and S1000D administration data. The syntax of these reference
types match the syntax requirements of the related DTDs and schemas.
You can create these reference topic types:
• Content Topic Reference
A reference type typically used for enabling navigation links. The reference is created by pasting
a link generated in the Teamcenter client, into content in the editing tool. Authors generate links
in the Teamcenter client by using the fixed and floating navigation links copy options.
Content references are also used for S1000D documentation.

Example
To create a content reference, you create reference type REFDMAVEE with the tag
name AVEE, which is a tag name used in data modules. You then relate reference
type REFDMAVEE to topic type REFDM. You create an XML attribute mapping for a
specific function and relate it to REFDMAVEE. Then when you create a data module
with the topic type REFDM, it contains the reference AVEE as specified by the XML
attribute mapping.

• Content Cross Reference

A reference type with the same functionality as Content Topic Reference. You can use this if
you need to differentiate between two different types of content references.

• Composable Topic Reference

A reference type typically used to enable the creation of DITA dynamic maps and S1000D data
dispatch notes, data module lists, and publication modules. Authors create these types of
references when they relate topics in the Teamcenter client. References are added to content
during the compose process.

• Content Graphic Reference

A topic-to-graphic reference type. The reference is created by pasting a link generated in the
Teamcenter client, into the content in the editing tool. Authors generate links in the Teamcenter
client by using the Copy For Editor→Graphic Content option.
This reference type is required for the functioning of graphics within content. You must have a
Content Graphic Reference reference type related to each topic type. A graphic reference

PLM00014 12.2 Content Management 18-1

 Chapter
Chapter 18:18:Enabling
Enabling references
references and links
and links

type is included in the administration data; however you may need to modify it to work with
your organization's schemas depending on the element, attribute, or reference type that you
use to create those links.

• Composable Graphic Reference

A topic-to-graphic reference type. The reference is created by relating the topic and graphic in
the Teamcenter client. The reference is then added to the content by the compose process.

Create a reference topic type

1. Select the folder in which you want to create the new reference type, and then either click New
Administrative Item... , or choose File→New→New Administrative Item.

2. In the New Administrative Item dialog box, expand Complete List, click Reference Topic
Type, and then click Next.

3. In the dialog box, do the following:

For this option Do this

Name Type a name to assign to this reference type.

Note
This name appears in the Reference Topic Type
box when authors create a DITA object and relate
DITA objects, and it can be edited later in the object’s
properties.

Local Tag Name Type the root tag name to be used for the reference. The tag name
must be valid for in the topic type(s) in which you insert the reference.
If multiple topic types within the same structure have the same Local
Tag Name, enter the Topic Type Condition below, to distinguish
the topic types.
If the reference uses fragments instead of a full tag, type a virtual
tag name. The reference is then defined by the list of Fragment
Tag Names below.

18-2 Content Management PLM00014 12.2

 Enabling references and links

For this option Do this

System Usage Select one of the following:
• SYSTEM
The reference type will not appear in selection lists in dialog
boxes, such as those for creating topics.

Note
This is used for special purposes only, such as
for adding new objects that may not be ready for
general use or for objects to be used only by system
processes, such as workflows.

• USER
The reference type will appear in selection lists in the appropriate
dialog boxes, such as those for creating topics.
Validate Incoming on Select either True or False, to specify whether data being saved to
Parse the database is validated when content is decomposed.
If True is selected, invalid content produces an error.
Typically, this type of validation is not required if your editing tool
validates content, and it may affect processing time.
Validate Outgoing on Select either True or False, to specify whether data being retrieved
Parse from the database is validated when content is composed.
If True is selected, invalid content produces an error.
Typically, this type of validation is not required if your editing tool
validates content, and it may affect processing time.
Validate Example If the topic type is related to a schema with the EXAMPLE_CONTENT
Content on Parse schema type, select either True or False, to specify whether the
example content is validated when it is used during compose.
If True is selected, invalid content produces an error.
Typically, this type of validation is not required if your editing tool
validates content, and it may affect processing time.

PLM00014 12.2 Content Management 18-3

 Chapter
Chapter 18:18:Enabling
Enabling references
references and links
and links

For this option Do this

Reference Type Select the reference type you are creating:
• Composable Topic Reference
A topic-to-topic reference type. The reference is created by
relating the topics in the Teamcenter client and is added to the
content by the compose process.

• Composable Graphic Reference

A topic-to-graphic reference type. The reference is created by
relating the topic and graphic in the Teamcenter client and is
added to the content by the compose process.

• Content Topic Reference

A topic-to-topic reference type. The reference is created by
pasting a link generated in the Teamcenter client, into the
content in the editing tool.
This reference type used to enable fixed and floating navigation
links.

• Content Graphic Reference

A topic-to-graphic reference type. The reference is created
by pasting a link generated in the Teamcenter client, into the
content in the editing tool.

Note
This reference type is required for the functioning of
graphic options and graphic items within content. You
must have a Content Graphic Reference reference
type related to each topic type. A graphic reference
type is included in the Base administration data;
however you may need to modify it to work with your
organization's schemas.

• Content Cross Reference

A reference type with the same functionality as Content Topic
Reference. You can use this if you need to differentiate between
two different types of content references.

18-4 Content Management PLM00014 12.2

 Enabling references and links

For this option Do this

Namespace URI Type a URI that serves as a unique identifier for the namespace.

Tip
Namespaces allow different XML vocabularies to be used
in a single XML document and provide an XML parser a
means to categorize each vocabulary. Although this is a
URI, it is not used to identify and retrieve a web address.

Default Namespace Type a prefix that represents the namespace URI. The prefix is
Prefix added to the beginning of element names to place them in the
namespace.
Topic Type Condition If multiple topic types within the same structure have the same Local
Tag Name, type a topic type condition value to restrict the topic type,
using either containspath, insidepath, or containsvalue, along
with a specified value or path. For example, insidepath(/REFDM)
specifies that the reference is used inside the topic type REFDM.
If the Local Tag Name of all topic types in a structure is unique,
this attribute is not used.
Fragment Tag Names If the topic type reference you are creating uses fragments instead
of a full SGML tag with start and end tags, such as in a S1000D
delivery list, type each tag name that appears in the fragment, in
order of appearance. If you are using this option, enter a virtual tag
name for the Local Tag Name above, which can be any unique
string. Leave this option empty for standard topic types.

4. Click Finish.

5. Create an XML attribute mapping to define what data is read from the reference, and relate it to
the reference type. The attribute mapping must have at least one entry for a key attribute, with
the REFERENCE function.

Enabling navigation links

Overview of navigation links

Content authors use navigation links to add XML references with text to topics, which when
published, create links. When clicked in published output, the user is directed to another topic or
another location within the same topic. Before content authors can use navigation links, you must
enable the ability to create the links, by creating a reference type and XML attribute mapping and
relating those to the topic types in your system. You can create one reference type with the XML
attribute mapping containing all the required attributes for the different types of links used by authors,
or you can create a reference type with an attribute mapping for each link type. These steps enable
both fixed and floating navigation link functionality. When the content author creates a navigation link

PLM00014 12.2 Content Management 18-5

 Chapter
Chapter 18:18:Enabling
Enabling references
references and links
and links

and chooses the type of link, the resulting markup for the link in the content includes the reference,
corresponding to the link type, and the text that is seen in the output.
Authors can insert two types of navigation links into a topic:

• Floating navigation link

This navigation link type always links to the most current version of a topic.

Example
At the time you create a link to a topic, the topic's version is A.1, and the link accesses
version A.1 of the topic. Later, when the topic's version increases to B.1, the link
then accesses version B.1 of the topic.

• Fixed navigation link

This navigation link type always links to a specific version of a topic.

Note
Fixed navigation links are not supported for S1000D content.

Example
At the time you create a link to a topic, the topic's version is A.1, and the link accesses
version A.1 of the topic. Later, when the topic's version increases to B.1, the link
still accesses version A.1 of the topic.

For both types of links, authors can also create a link to content below the topic level, for example, to
a table or figure within a topic.
This example shows a floating link from a paragraph in one Base topic to a paragraph in another
Base topic.

18-6 Content Management PLM00014 12.2

 Enabling references and links

Enable fixed and floating links and conrefs

1. Create a reference topic type, entering the following:

For this option Do this

Topic Type Name Type a name to assign to the reference type, for example, Link
Component to Component.
Local Tag Name Type the root tag name to be used for the reference, for example,
xref. The tag name must be valid for the topic type(s) in which you
insert the reference.
When enabling a DITA conref, type the top level element and +.

Example
topic +
map +
concept +

Reference Type Choose Content Topic Reference

Note
You may choose Content Cross Reference if you are
configuring your system to have another distinguishable
type of reference.

2. Relate the reference type to each topic type in your system, ensuring that you have a reference
type between each of the topic types that can be linked.

3. Create an XML attribute mapping, with the required attributes, such as in the following examples.
Cross-references (xref) in DITA Content Management:

Content references (conref) in DITA Content Management:

PLM00014 12.2 Content Management 18-7

 Chapter
Chapter 18:18:Enabling
Enabling references
references and links
and links

Base Content Management:

The Base example XML attribute mapping contains the following entries:

Attribute Name and Function Purpose of the entry

DocumentTitle/Compose The content of the DocumentTitle attribute
from the topic you are linking to appears in
the link in the topic you are linking from, when
the link is created.
item_id/Compose The item_id attribute from the topic you are
linking to appears in the link’s href attribute in
the topic you are linking from, when the link
is created.
item_id/Reference The item_id attribute from the topic you are
linking to appears in the link’s href attribute
in the topic you are linking from, when the
reference is created. The item ID appears
before the field separator.
item_id/Get Retrieves the item_id attribute from the href
attribute in the content. The item ID appears
before the field separator.
linkType/Fixed link The attribute linktyp in the topic you are
linking from contains the constant fixed,
when a fixed link is used.
item_revision_id/Fixed link The attribute version in the topic you are
linking from contains the revision ID and
sequence ID of the topic you are linking to,
when a fixed link is used.

18-8 Content Management PLM00014 12.2

 Enabling references and links

Attribute Name and Function Purpose of the entry

linkType/Floating link The attribute linktyp in the topic you are
linking from contains the constant floating,
when a floating link is used.
version/Floating link The attribute version in the topic you are
linking from contains the constant CURRENT,
when a floating link is used.
linkType/Get Retrieves the linkType attribute from the
attribute linktyp in the content.
item_revision_id/Get Retrieves the item_revision_id attribute from
the version attribute in the content.
/ctm0destAnchorFragId/Get Retrieves the attribute
ctm0destAnchorFragId from the href
attribute after the field separator in the
content.

4. Relate the XML attribute mapping to the reference topic type.

5. Enable link validation.

Enable link validation

When a link is inserted into a topic, it references an element from another topic. You can enable the
validation of links so that if a referenced element is removed from a topic, an error message appears
when the author tries to save the topic.
To enable this feature:
• Add the ctm0destAnchorFragId attribute to the XML attribute mapping that is related to the topic
types in your system, as shown in the DC Base Attributes XML attribute mapping.

Note
This attribute is already included in the DC Base Attributes XML attribute mapping as
well as the DITA XML attribute mappings. If those XML attribute mappings are already
related to the topic types in your system, you do not have to add the attribute.

PLM00014 12.2 Content Management 18-9

Chapter 19: Creating XML attribute mappings

Overview of XML attribute mappings

Information is exchanged between a database property of an object and an attribute in the object's
XML or SGML. This exchange of information takes place during many processes, such as compose,
decompose, and initial creation. An attribute mapping defines the values that are exchanged, the
user actions that cause the exchange, and the direction of the exchange (from database to attribute
value or from attribute value to database). For example, an attribute mapping may transfer a title
attribute from a topic's XML to the title property in the database whenever the topic is decomposed.
Each topic type must be related to at least one XML attribute mapping. You may have multiple
XML attribute mappings for different topic types, or you may have the same XML attribute mapping
related to every topic type, such as the DC Base Attributes XML attribute mapping provided with
the administration data.
As a best practice, map IDs and XML numbers to the item_id attribute when defining XML attribute
mappings. This way topics can be referenced by a unique ID within the XML document. This enables
version management, import, compose/decompose, and referencing to work between topics. The DC
Base Attributes XML attribute mapping supports the use of XML numbers specifically as the ID.

Caution
• To create attribute mappings, you must have an understanding of the schemas.

• Because Content Management uses attribute mappings to map values between

database properties and XML attributes in topics, it is recommended that you do not
localize any values for properties that are included in attribute mappings. You should
use Content Management translation objects to manage the translation of content
and all mapped attributes.

DC Base Attributes XML attribute mapping overview

The DC Base Attributes XML attribute mapping is provided with the Content Management Base
administration data. It is related to each Base topic type included in the administration data. You can
use the attributes exchanged in this attribute mapping as the minimum exchange setting, modifying
it to meet the differences in schemas and to add additional attributes for exchange. XML attribute
mappings for DITA topic types are also included in the administration data.

PLM00014 12.2 Content Management 19-1

 Chapter
Chapter 19:19:Creating
Creating
XML XML attribute
attribute mappings
mappings

This XML attribute mapping contains the following entries:

Attribute Name and Function Purpose of the entry

DocumentTitle/Decompose During decompose, the content from the
title element in the XML is transferred to the
DocumentTitle property in the database.
If the title is empty, the constant value NO
TITLE is used.
DocumentTitle/First Compose The first time a topic is composed, the content
from the DocumentTitle property in the
database is transferred to the title element in
the XML.
DocumentTitle/Translation Receive When a translation delivery is imported, the
title element in the XML of the translation is
transferred to the DocumentTitle property of
the translation in the database.
If the title is empty, the constant value NO
TRANSLATED TITLE is used.
contentVersion/Translation Submit When a translation delivery is created, the
contentversion attribute from the topic’s XML
is transferred to the contentVersion of the
translation.
contentVersionReference/Translation Receive When a translation delivery is imported,
the contentversion attribute in the XML
of the translation is transferred to the
contentVersionReference property of the
translation in the database.

19-2 Content Management PLM00014 12.2

 Creating XML attribute mappings

Attribute Name and Function Purpose of the entry

contentVersionReference/Translated When a translation is composed, the
Compose From Translation contentversion attribute in the XML
of the translation is transferred to the
contentVersionReference property of the
translation in the database.
ctm0LanguageTagref/Translated Compose When a translation is composed, the
From Translation languagekey attribute in the XML of
the translation is transferred to the
ctm0LanguageTagref property of the
translation in the database, so the content is
composed in the translated language.
ctm0MasterLanguageTagref/Decompose During decompose, the language is
updated. For example, if a user changes the
languagekey attribute from English US to
English UK in the XML editor, when the content
is saved, the master language of the topic is
changed.
ctm0MasterLanguageTagref/Non Translated When content is composed for publishing,
Compose exporting or editing, the language is added to
the XML attribute languagekey.
ctm0MasterLanguageTagref/Translation Not currently used
Receive
ctm0VersionNumber/Bidirectional The ctm0VersionNumber attribute is a runtime
property that is a combination of the revision
and sequence number. During compose
and translated compose, the content of the
ctm0VersionNumber database property from
the topic is transferred to the version attribute
in the topic. During decompose, the value is
transferred from the XML to the database.
/ctm0destAnchorFragId/Reference ctm0destAnchorFragID is the attribute name
on the relation between one topic and another
topic it references. This entry specifies that this
attribute uses the ID attribute from the topic that
is being referenced.
This entry enables link validation.
graphicPath/Processing Data Copies the value defined for graphicPath in
the ctm0_processing_data preference to
the composed content during compose, and
removes the same content during decompose.
This happens only for the root element of the
XML data that is composed.

PLM00014 12.2 Content Management 19-3

 Chapter
Chapter 19:19:Creating
Creating
XML XML attribute
attribute mappings
mappings

Attribute Name and Function Purpose of the entry

graphicPathTarget/Processing Data Copies the value defined for
graphicPathTarget in the
ctm0_processing_data preference to
the composed content during compose, and
removes the same content during decompose.
This happens only for the root element of the
XML data that is composed.
item_id/Bidirectional During compose and translated compose, the
content of the item_id database property from
the topic is transferred to the xmlnumber
attribute in the topic . During decompose,
the value is transferred from the XML to the
database.
item_id/Translation Receive When a translation delivery is imported,
the xmlnumber attribute in the XML of the
translation is transferred to the item_id property
of the translation in the database.
item_id/Clone The content of the item_id attribute from the
topic being referenced appears in the reference
when content is cloned using the Copy For
Editor→Composed Content as Clone option.
protected/Special Attribute used by editing tools to mark content
as protected, or read-only, so it cannot be
edited.
release_statuses/Compose Adds the first release status to the XML attribute
lifecyclestate.

Create an XML attribute mapping

1. Select the folder in which you want to create the new XML attribute mapping, and then either click
New Administrative Item... , or choose File→New→New Administrative Item.

2. In the New Administrative Item dialog box, expand Complete List, click XML Attribute
Mapping, and then click Next.

3. In the dialog box, type a name for the XML attribute mapping in the Name box.

4. (Optional) In the Admin Comment box, type a comment to be saved with the XML attribute
mapping.

5. Click Finish.

6. Open the Summary view and select the XML attribute mapping.

7. If namespaces are used, under Namespaces Table, click Add.

19-4 Content Management PLM00014 12.2

 Creating XML attribute mappings

If namespaces are not used, go to step 13.

Tip
Namespaces allow different XML vocabularies to be used in a single XML document
and provide an XML parser a means to categorize each vocabulary.

8. In the dialog box, in the Namespaces Prefix box, type the prefix that represents the namespace
URI.

Note
Prefixes are added to the beginning of element names to place them in the namespace.

9. In the Namespace URI box, type the URI that uniquely identifies the namespace.

Note
Although this is a URI, it is not used to identify and retrieve a web address.

10. Click Finish.

11. For each namespace you want to add to the mapping, repeat steps 8 - 10.

Note
To remove a namespace, click it, and select Delete.

12. Close the Namespaces Table Entry dialog box.

13. In the Summary view, under XML Attribute Map Table, click Add.

14. In the dialog box, enter the following for an attribute you want to add to the mapping:

In this column Do this

Attribute Name Type the name of the attribute as it is defined in the database.
You can use the following in the attribute name for additional
functionality:
• . (period)
Gets the attribute name on a reference property; for example,
ctm0MasterLanguageTagref.isoLanguageCode.

• / (front slash)
Gets the property on a relationship; for example,
/ctm0KeyName.

PLM00014 12.2 Content Management 19-5

 Chapter
Chapter 19:19:Creating
Creating
XML XML attribute
attribute mappings
mappings

In this column Do this

• Ctm0BOMLine!
Gets the property on an occurrence note; for example
Ctm0BOMLine!Ctm0versionNo .
Constant Value Type the default value to be used when the attribute value is blank.
Field Separator Type the string you want to be used as a field separator. The
field separator enables you to combine multiple values from the
XML/SGML content into a single object attribute during attribute
mapping. If you add multiple rows with the same Function and
Attribute Name in your attribute mapping object, and enter the
Field Separator String on all but one of the rows, the values from
the XML/SGML content are appended together into a single value
during decompose operations. Also, a single value can be split at
the separators and included in the XML/SGML content as multiple
values. It is recommended that you use a field separator that does
not typically appear in the XML/SGML content values.
If the attribute does not allow separators, use the Fixed Field
Length below.
Fixed Field Length For attributes that do not allow separators, type the number of
characters to which you want to truncate values when they are
transferred from the database to XML/SGML content, as an
alternative to the Field Separator String.
Function Select the function for the attribute, from the list of XML attribute
mapping functions.
Omit empty attribute Select either True or False, to specify whether empty attributes are
omitted when content is transferred.
Path Type the path to express the element and attribute in the XML/SGML
tag.

Note
The element and attribute must be defined in the schema
related to the topic type; otherwise it is not allowed in the
content being composed.

A path consists of any number of element tag names separated by

slashes (/), and it may contain no more than one attribute name or
processing instruction (PI) target, although one is not required. An
attribute is separated from the element tag names with the at symbol
(@), and a PI is separated with a question mark (?). Guidelines
for the syntax are:
• A path always starts with a slash.

• A path may not end with a slash, at symbol, or question mark.

19-6 Content Management PLM00014 12.2

 Creating XML attribute mappings

In this column Do this

• A path may not have both an at symbol and a question mark.

• All slashes must appear before any at symbols or questions

marks.

• A path may use two slashes to mark that it should be ignored.

Examples:
/note/para@version = Attribute version of the element para inside
the element note
/note/para?PItarget = PI with target PItarget inside element para
inside element note
/@version = Attribute version
/?PItarget = PI with target PItarget
/note = Element note
/ = Current element
// = Ignore this path
XML Procedure For more complicated mappings, type the name of the procedure
script used to copy the values for an attribute. If a procedure is used,
all other columns except Attribute Name and Function are not
used, and the procedure replaces the standard mapping for this row.

15. Click Finish.

16. For each attribute you want to add to the mapping, repeat steps 14 - 15.

Note
To remove an attribute, click it, and select Delete.

17. Close the XML Attribute Map Table Entry dialog box.

18. (Optional) Add a callback function to an attribute to further configure or customize XML compose
or decompose results.
a. In the line for the attribute, click the Callback Name column, and choose View Properties.

b. In the Properties dialog box, enter the callback name in the Callback Name box, and
click OK.

PLM00014 12.2 Content Management 19-7

 Chapter
Chapter 19:19:Creating
Creating
XML XML attribute
attribute mappings
mappings

Callback functions in XML attribute mappings

Application administrators can add callback functions to attributes in XML attribute mappings to further
configure or customize XML compose or decompose results. A callback adds an interrupt in the
attribute mapping process that allows authors to insert processing to modify the XML using C++ code.
1. Create the callback function, and add it to a library.

Example
int example_compose_xam_callback_fn( tag_t itemRev,
tag_t language,
tag_t xamAttrMapRow,
xercesc::DOMDocument & pDoc,
NameValueMap &keyValueArgs)

int example_decompose_xam_callback_fn( tag_t itemRev,

tag_t topicType,
tag_t xamTblRow,
xercesc::DOMNode* target,
NameValueMap & keyValueArgs,
std::string& returnValue )

2. Install the callback code in your environment using the install_callback utility. For example:

Example
install_callback -u=infodba -p=infodba -g=dba -mode=create
-type=ContmgmtComposeXMLAttrMapping -library=libCtm0Callbacks
-function=example_compose_xam_callback_fn
-name=example_compose_xmlattrmap_callback_fn

install_callback -u=infodba -p=infodba -g=dba -mode=create

-type=ContmgmtDecomposeXMLAttrMapping -library=libCtm0Callbacks
-function=example_decompose_xam_callback_fn
-name=example_decompose_xmlattrmap_callback_fn

3. When you create an XML attribute mapping, add the Callback Name to the appropriate attribute.

Example
In the first example above, the Callback Name is
example_compose_xam_callback_fn.

19-8 Content Management PLM00014 12.2

 Creating XML attribute mappings

XML attribute mapping functions

The following are the functions that may be assigned to an attribute when you are creating an XML
attribute mapping:

Function Description
Bidirectional Copies values from the topic object to the composed content
during compose and translated compose, and copies values
from the composed content to the topic object during
decompose.
Clone Copies values from source topics to target topics when
content is cloned using the Copy For Editor→Composed
Content as Clone option.
Compose Copies values from the topic object to the composed content
during compose and translated compose.
Decompose Copies values from the composed content to the topic object
during decompose.
Export File Name Specifies a separate export file name for exports with
composable and content reference topic types.
First Compose Copies values from the topic object to the composed content
during compose and translated compose, but only if the
topic does not have any content yet. Typically, this applies
to newly created topics.
Fixed link Copies values from source topics to the XML reference
when fixed links are used.
Floating link Copies values from source topics to the XML reference
when floating links are used.
Get Retrieves values from the composed content during
decompose.
Graphic Reference Identifies graphic references during compose and
decompose.
Non Translated Compose Copies values from the topic object to the composed content
during compose, but not during translated compose.
Processing Data Copies the values stored in the ctm0_processing_data
preference to the composed content during compose,
and removes the same content during decompose. This
happens only for the root element of the XML data that is
composed.

Example
If the XML attribute mapping has these entries:

PLM00014 12.2 Content Management 19-9

 Chapter
Chapter 19:19:Creating
Creating
XML XML attribute
attribute mappings
mappings

Function Description

And the ctm0_processing_data preference

contains these values:
graphicPath=[root-dir]graphics\
graphicPathTarget=NONE
The content contains this in the composed
content for the root element:
<graphic-path target="None">C:\Users\username\
Teamcenter\contmgmt\9000.0.0\
graphics</graphic-path>

Reference Copies values when a reference is created or decomposed.

Remove When the XML attribute mapping uses a Compose
or Decompose function for removing a value from the
xmlNumber, versionNumber, or protected attributes, and the
function uses a procedure triggered by another attribute,
use the Remove function to remove the values from those
attributes.
XML attribute mapping functions are checked in this order
for removing a value from the xmlNumber or versionNumber
attributes during compose:
1. Remove

2. Bidirectional

3. Compose

XML attribute mapping functions are checked in this order

for removing a value from the xmlNumber, versionNumber,
contentVersion, or protected attributes during decompose:
1. Remove

2. Bidirectional

3. Decompose
Set For future use.
Special Identifies special attributes used by Content Management
such as protected.
Translate Attribute During the translation receive process, retrieves the value of
the translate attribute the XML document. For example, in
the DITA standard, this attribute is translate. If the attribute's
value is no or false, then the translated topic is skipped.

19-10 Content Management PLM00014 12.2

 Creating XML attribute mappings

Function Description
Translated Compose From Topic Copies values from the topic object to the composed
content during translated compose, but not during standard
compose.
Translated Compose From Copies values from the translation object (not from the topic
Translation object) to the composed content during translated compose.
Translation Receive Copies values when receiving translation deliveries from
the translation office.
Translation Submit Copies values when building translation submittals for the
translation office.

PLM00014 12.2 Content Management 19-11

Chapter 20: Creating style types and stylesheets

Overview of style types and stylesheets

You use stylesheets to customize output. A stylesheet is represented by a source file used for
transforming XML data. Stylesheets are applied for transformations during import or export, for
data presentations in viewing and editing tools, and for the creation of renditions, such as PDF or
HTML files.
If you publish product documentation that uses multiple stylesheets, you can combine and manage
those stylesheets within a style type. The style type establishes defaults for stylesheet options on
preview and publish functions.

Note
You must create a stylesheet to enable the viewing of content in the Preview view using
the Preview option.

Stylesheet items have stylesheet revisions. A stylesheet revision must be related to a topic type, and
it may be related to a style type and an editing or publishing tool before it can be used.
The DITA administration data includes several DITA stylesheets. To locate them, you can use the
system defined searches for Content Management.

Create a style type

1. Select the folder in which you want to create the new style type, and then either click New
Administrative Item... , or choose File→New→New Administrative Item.

2. In the New Administrative Item dialog box, expand Complete List, click Style Type, and
then click Next.

3. In the dialog box, do the following:

For this option Do this

Name Type the name for the style type.

PLM00014 12.2 Content Management 20-1

 Chapter
Chapter 20:20:Creating
Creating
style style
typestypes and stylesheets
and stylesheets

For this option Do this

System Usage Select one of the following:
• USER
The style type will appear in selection lists in the appropriate
dialog boxes.

• SYSTEM
The style type will not appear in selection lists in dialog boxes.

Note
This is used for special purposes only, such as
for adding new objects that may not be ready for
general use or for objects to be used only by system
processes, such as workflows.

4. Click Finish.

Create a stylesheet
1. (Optional) Either select a folder in which you want to create the stylesheet, or select the style
type to which you want to relate the stylesheet.

2. Either click New Administrative Item... , or choose File→New→New Administrative Item.

3. In the New Administrative Item dialog box, expand Complete List, click Stylesheet, and
then click Next.

4. In the dialog box, do the following:

For this option Do this

ID Either type an ID for the stylesheet, or leave the box blank so that
the next available item ID is automatically assigned
Revision Either type a revision for the stylesheet, or leave the box blank so
that the next available revision is automatically assigned.
Name Type the name for the stylesheet.
Public ID Type a public ID for the stylesheet.

Note
The public ID cannot be modified after the stylesheet has
been created because it is unique.

20-2 Content Management PLM00014 12.2

 Creating style types and stylesheets

For this option Do this

Stylesheet Type Select the stylesheet type from the list of stylesheet types.

Stylesheet Main File If the stylesheet is contained in a combined file format, such as a
(for Zipped) .zip file, type the name of the main stylesheet file that includes or
refers to all other files.
Stylesheet Resulting Select the resulting content type of the stylesheet, which specifies
Content Type the kind of content produced by the stylesheet.

Note
When creating a stylesheet to enable the viewing of
content in the Preview view using the Preview option,
select xml.

Ant Build Target Type the reference to the ANT control process target for formatting.
Select Content Browse to and select the content file of the stylesheet.

Note
In the Browse dialog box, the file type you browse for
depends on the tools and types of stylesheets your
company uses. For example, the .xac file type is used
with XMetaL Author. The .xsl and .xml files types are
used with many types of tools.

5. Click Finish.

6. Create the following relationships between the stylesheet revision and other objects:

• Relate the stylesheet revision to the style type if you did not choose the style type in step 1.

• Relate the stylesheet revision to topic types as necessary.

• Relate the editing tool or publishing tool that applies to the stylesheet revision.

Edit a stylesheet
You can edit a stylesheet for Base or DITA Content Management using an editing tool, similarly to
how you edit topics. To edit S1000D stylesheets, you must edit the stylesheet files on Teamcenter
Dispatcher.

1. In the Home component view, right-click the stylesheet and choose Edit→Edit Stylesheet.

2. In the Check-Out dialog box, click Yes.

PLM00014 12.2 Content Management 20-3

 Chapter
Chapter 20:20:Creating
Creating
style style
typestypes and stylesheets
and stylesheets

3. The stylesheet opens with the editing tool and is saved in a local folder. In the Home component
view, the stylesheet appears as checked out and in edit mode .

4. In the editing tool, edit the stylesheet as necessary.

5. When you are done editing the stylesheet, do one of the following:

To do this Do the following For this result

Save your a. Use the editing tool's The editing tool closes the file, and the
changes and options for saving stylesheet is updated in the database.
close the file. files, and then in the
Home component
view, right-click the
stylesheet, and choose
Edit→Save and Close
Edit.

b. Right-click the
stylesheet, and choose
Check-In/Out→Check
In.
Close the file a. In the Home component The editing tool closes the file, the stylesheet
without saving view, right-click the remains unchanged in the database.
your changes. stylesheet, and choose
Edit→Cancel Edit.

b. Right-click the
stylesheet, and choose
Check-In/Out→Cancel
Checkout.

Stylesheet types
The following are the available stylesheet types:

Stylesheet Type Description

ARCHIVE_ A stylesheet used in transformation policies. If the stylesheet is
TRANSFORMATION applied to a set of related objects, it is applied only to the main
object.
CONTENT_ A stylesheet used in transformation policies. If the stylesheet
TRANSFORMATION is applied to a set of related objects, it is applied to all objects
in the set.
COMPOSED_ERROR_LOG A stylesheet for compose error information. This displays the
error log created for a composed document.
COMPOSED_VERSION_ A stylesheet for compose version information. This displays the
LOG compose version log created for a composed document.

20-4 Content Management PLM00014 12.2

 Creating style types and stylesheets

Stylesheet Type Description

EDITOR_VIEW A stylesheet used by an editing tool to display composed topics
for an editing session.
FOSI_VIEW A stylesheet used with the FOSI (Formatting Output Specification
Instance) language.
IMPORT A stylesheet that transforms XML data by Extensible Style
Sheet Transformations (XSLT) during an import into Content
Management.
INTERNET_EXPLORER A stylesheet that transforms data to HTML while displaying it in
_PREVIEW the Preview view.
PREDECOMPOSE A stylesheet that transforms data by XSLT before starting the
decompose of edited topics, which is done when you save and
close the topic.
PUBLISH_FOR_PRINT A stylesheet that transforms data to a format suitable for printing
on paper.
PUBLISH_TO_HTML A stylesheet that transforms data to HTML.
PUBLISH_TO_PDF A stylesheet that transforms data to PDF. This type of stylesheet
is used by any publishing tool that supports the creation of PDF
documents.
TOPIC_DEPENDENT The default stylesheet type for publishing and previewing. The
stylesheet that is applied when a topic is published is dependent
on the topic type, tool, and style type.
TRANSLATION_ORDER This stylesheet type is no longer used.

PLM00014 12.2 Content Management 20-5

Chapter 21: Enabling graphics features

Required tasks to enable authors to use graphics

To enable authors to use graphics in publications, you must do the following:
• Create reference topic types to enable the functioning of graphics within content

• Define default graphic usages

• Create graphic priority lists

• Create graphic attribute mappings

• Maintain graphic tagging options

Enabling references between topics and graphics

Authors create references between topics and graphics by pasting a link generated in the Teamcenter
client into the content in the editing tool. These links are generated in the Teamcenter client by using
the Copy For Editor→Graphic Content option on graphic option revisions.
For these references to function, you must create a reference topic type defined as a Content
Graphic Reference reference type, and this reference topic type must be related to each topic type
used by authors. A graphic reference type is included in the Base administration data; however you
may need to modify it to work with your organization's schemas depending on the element, attribute,
or reference type that you use to create those links.

Create a graphic reference topic type

1. Do one of the following:
• Modify the reference topic type graphic-reference, included in the administration data, to
meet the needs of your organization.

• Create a reference topic type, entering the following:

For this option Do this

Name Type a name to assign to the reference type.
Local Tag Name Type the root tag name to be used for the reference. The tag
name must be valid for the topic type(s) in which you insert the
reference.
Reference Type Choose Content Graphic Reference.

PLM00014 12.2 Content Management 21-1

 Chapter
Chapter 21:21:Enabling
Enabling graphics
graphics features
features

2. Relate the reference topic type to each topic type in your system, ensuring that you have a
reference type between each pair of related topic types.

3. Do one of the following:

• Modify the XML attribute mapping graphic-data included in the administration data.

• Create an XML attribute mapping, with the required attributes.

Example
The graphic-data XML attribute mapping contains entries that copy the item_id
and item_revision_id attributes from the graphic to the name and revision
attributes in the topic when the reference is created.

4. If you did not use the objects in the provided administration data, relate the XML attribute
mapping to the reference topic type.

Defining default graphic usages

Graphic usages are assigned to a graphic to specify the types of deliverables you want to use the
graphic for. System-defined graphic usages include: ICON, PDF, PRINT, SOURCE, THUMBNAIL,
VIEW, and WEB.
When graphics are imported, they may be assigned unique graphic usages, or they may be assigned
the usages defined in the ctm0GraphicUsagePref preference, which assigns usages based on
graphics’ file extensions. To make defined usages available to users, administrators must edit the
ctm0GraphicUsagePref preference to establish them. When values are set for this preference
they apply to the site.
Your publishing and editing tools, as well as the output format and display, must support the graphic
file format you assign. For example, users may need JT2Go or a similar application to view a JT
graphic if included in the published output.

Working with graphic priority lists

A graphic item is the main object representing a set of different file types for the same graphic. A
graphic option is a specific file of a specific file type. For example, a graphic item may be named
piston, and it may have several associated graphic options named piston.jpg, piston.gif, and
piston.bmp.
When a graphic option is imported to the database, one or more usages are assigned to it, such as
VIEW for use in previewing and web publishing, or PDF for use in high-resolution printing. Each
graphic item may be assigned unique usages, or they may be assigned the usages specified in the
ctm0GraphicUsagePref preference.

21-2 Content Management PLM00014 12.2

 Enabling graphics features

You must create graphic priority lists in the Organization application and associate one with each
editing, publishing, and comparing tool when you create the tool. A graphic priority list determines
the priority with which graphic options are selected for use with XML content when it is opened or
published with the tool. Graphic options are selected according to the order of usages in the graphic
priority list. The tool selects the graphic option for the first usage listed; however, if no file with this
usage is found, the graphic option for the usage in the next position is selected, and so on.

Example
An XML document with graphics is opened in an editing tool. The editing tool's graphic
priority list has usages in this order: WEB, ICON, and PRINT. All graphics in the XML
document are first searched for graphic options with the WEB usage. If a graphic has a
WEB graphic option, that graphic option is downloaded with the content. If a graphic does
not have a WEB graphic option, a search for an ICON graphic option is done. If found, the
ICON option is used. If not found, the graphic is searched for the PRINT option, and so on.

This example is illustrated here:

Note
Reference types are required for the functioning of graphic options and graphic items within
content. You must have graphic reference related to each topic type.

Working with graphic attribute mappings

A graphic attribute mapping controls how a file name or attributes on a graphic file being imported
are mapped to properties in Content Management. For example, a graphic attribute mapping can
define how a graphic option's file name is transferred to its Public Identifier property in Content
Management. A graphic attribute mapping can map file names or attributes to both graphic options
and graphic items.

PLM00014 12.2 Content Management 21-3

 Chapter
Chapter 21:21:Enabling
Enabling graphics
graphics features
features

You must have at least one graphic attribute mapping defined in your system. You can import sample
graphic attribute mappings included with Base and S1000D Content Management administration
data. A Base sample graphic attribute mapping follows:

Create a graphic attribute mapping

1. Select the folder in which you want to create the new graphic attribute mapping, and then either
click New Administrative Item... , or choose File→New→New Administrative Item.

2. In the New Administrative Item dialog box, expand Complete List, click Graphic Attribute
Mapping, and then click Next.

3. In the dialog box, in the Name box, type the name for the mapping.

4. In the Admin Comment box, type a comment that you would like to store with the graphic
attribute mapping.

5. Click Finish.

6. Close the New Administrative Item dialog box.

7. Open the Summary view and select the graphic attribute mapping.

8. In the Summary view, click Add.

9. In the Graphic Attribute Mapping Table dialog box, from the Function list, select the following
for the file name, portion of a file name, or attribute to map from the files you are importing:

Note
You may map multiple fields to be combined in one graphic item or option attribute, by
adding functions for each field in the order in which you want them to be mapped.

21-4 Content Management PLM00014 12.2

 Enabling graphics features

To map this Select this

The suffix of the importing ASSUME_SUFFIX_FROM_
graphic file name. For IMPORTGRAPHICFILENAME
example, .eps is the
suffix of piston.eps.
Map a part of the SPLIT_IMPORTGRAPHICFILENAME_
importing graphic file WITHOUT_SUFFIX
name, not including the
suffix

Note
If file names
contain more
than one
separator,
for example:
wheel.right.jpg,
use this
function.

Map a portion of the SPLIT_IMPORTGRAPHICFILENAME

importing graphic file
name, including the suffix

Map an attribute from an SPLIT_ATTRIBUTE_FROM_GRAPHICOBJECT

importing graphic item
Map an attribute from a SPLIT_ATTRIBUTE_FROM_LANGUAGEOBJECT
language object used for
the import
Map the suffix of the SET_SUFFIX_IMPORTORIGINALFILENAME_
importing graphic GRAPHICOPTION
option's original file
name. Use this to define
the capitalization on
the graphic option's
resulting suffix, using the
Capitalization Behavior
option in another
function, COMBINE_
GRAPHICOPTION.
Map the consecutive SET_CONSECUTIVEID_GRAPHICOPTION
numbering of the
importing graphic option

10. Complete the remaining options according to the function you selected:

PLM00014 12.2 Content Management 21-5

 Chapter
Chapter 21:21:Enabling
Enabling graphics
graphics features
features

If this function is selected Do this

ASSUME_SUFFIX_ In the Field Name box, type any name to assign the suffix
FROM_ to, for example, graphicFilenameSuffix.
IMPORTGRAPHICFILENAME
SPLIT_ a. In the Field Name box, type any name to assign to
IMPORTGRAPHICFILENAME_ this part of the file name.
WITHOUT_SUFFIX
b. Do one of the following:

Note
When combining multiple fields to map to
an attribute in Content Management, for
the last field, neither of these options are
required—all remaining characters of the
file name are mapped.

• In the Field Separator box, enter the type of

separator used in the graphic file name at which
point you want to split the file name into multiple
parts and assign this part to the Field Name you
specified.

• In the Fixed Field Length box, type the number

of characters in the file name that you want
to assign to this part as the Field Name you
specified. You must assign a Fixed Field Length
for the part of the file name that is between two
separators; however, you can use an asterisk
(*) to assign a variable length to one field when
combining multiple fields.

Example
You add one function with a Fixed Field
Length of 8 and another function with
a period (.) for the Field Separator.
When you import wheel.right.jpg, the first
function maps wheel.ri and the second
function maps ight. You use another
function, either COMBINE_GRAPHIC or
COMBINE_GRAPHICOPTION, to combine
these fields to map to an attribute in Content
Management.

21-6 Content Management PLM00014 12.2

 Enabling graphics features

If this function is selected Do this

SPLIT_ a. In the Field Name box, type any name to assign to
IMPORTGRAPHICFILENAME the portion of the file name.

b. Do one of the following:

• In the Field Separator box, enter the type of
separator used in the graphic file name at which
point you want to split the file name into multiple
parts and assign this part to the Field Name you
specified.

• In the Fixed Field Length box, type the number

of characters in the file name that you want
to assign to this part as the Field Name you
specified.
SPLIT_ATTRIBUTE_ a. In the Field Name box, type any name to assign to
FROM_GRAPHICOBJECT the attribute you are mapping.

b. In the Attribute Name box, type the name of the

attribute from the graphic files you are importing.
SPLIT_ATTRIBUTE_ a. In the Field Name box, type any name to assign to
FROM_LANGUAGEOBJECT the attribute you are mapping.

b. In the Attribute Name box, type the name of the

attribute from the graphic translation object you are
importing.
SET_SUFFIX_ In the Field Name box, type any name to assign to the
IMPORTORIGINALFILENAME_ attribute you are mapping.
GRAPHICOPTION
SET_CONSECUTIVEID_ In the Field Name box, type any name to assign to the
GRAPHICOPTION numbering you are mapping.

Note
Use the COMBINE_GRAPHICOPTION
function below to specify the attribute in
Content Management you are mapping the
numbering to.

11. Click Finish.

12. Do the following to map the file name, portion of a file name, or attribute to a graphic item or
graphic option in Content Management:
a. From the Function list, choose one of the following:
• COMBINE_GRAPHICOPTION, to map an attribute to a graphic option

PLM00014 12.2 Content Management 21-7

 Chapter
Chapter 21:21:Enabling
Enabling graphics
graphics features
features

• COMBINE_GRAPHIC, to map an attribute to a graphic item

Note
When mapping attributes to a graphic item, you cannot use the results from
these functions:
o SPLIT_ATTRIBUTE_FROM_LANGUAGEOBJECT

o SET_CONSECUTIVEID_GRAPHICOPTION

o SET_SUFFIX_IMPORTORIGINALFILENAME_GRAPHICOPTION

b. Do one of the following:

• In the Field Name, type the field name you defined in step 10.

• Type a value in the Constant Value box, which is a value that is always mapped to
the attribute you specify.

c. In the Attribute Name box, type the name of the attribute in the graphic item or option that
you want to fill in with the mapped value.

d. (Optional) In the Field Separator box, type a string, for example, a hyphen (-), to use as a
separator between fields in the attribute. The field separator is added after the value of the
Field Name or Constant Value.

e. (Optional) In the Capitalization Behavior box, choose either LOWERCASE, UPPERCASE,

or MIXEDCASE to indicate how the mapped value appears in the attribute. MIXEDCASE is
the default, which leaves the capitalization unchanged from the original file.

f. Click Finish.

13. Repeat steps 9–12 for each function to add to the graphic attribute mapping.

14. When you are done adding functions to the graphic attribute mapping, close the Graphic
Attribute Mapping Table dialog box.

Maintaining graphic tagging options

Authors use the Graphic Link Clipboard Window preference to set the tagging used in the
editing tool when a graphic is copied and pasted from Content Management to the editing tool.
Administrators use Teamcenter Content Management preferences to specify the options available in
this preference and how each option functions.

21-8 Content Management PLM00014 12.2

 Enabling graphics features

Upon installation, seven preferences exist to define the options for the Graphic Link Clipboard
Window preference.
The ctm0GraphicPref.values preference defines the values listed in the Graphic Link Clipboard
preference list box. The values at installation are docBook, dita, and s1000d. The names and
graphic tagging are defined in the following preferences:
• ctm0GraphicPref.dita.name
Defines the name of the option to choose when working with the DITA standard. The default is
DITA.

• ctm0GraphicPref.dita.text
Defines the default XML tagging that you want to use in the editing tool when a graphic is copied
from Content Management and pasted to content in the editing tool, when working with the DITA
standard for publications.

• ctm0GraphicPref.docBook.name
Defines the name of the option to choose when working with the DocBook or similar XML
standard. The default is DocBook.

• ctm0GraphicPref.docBook.text
Defines the default XML tagging that you want to use in the editing tool when a graphic is copied
from Content Management and pasted to content in the editing tool, when working with the
DocBook or similar XML standard.

• ctm0GraphicPref.s1000d.name
Defines the name of the option to choose when working with the S1000D 4.0, 4.1, or 4.2
standard. The default is S1000D 4.x.

• ctm0GraphicPref.s1000d.text
Defines the default XML tagging that you want to use in the editing tool when a graphic is copied
from Content Management and pasted to content in the editing tool, when working with the
S1000D 4.0, 4.1, or 4.2 standard.

You can add a new option to the list box by doing the following:

PLM00014 12.2 Content Management 21-9

 Chapter
Chapter 21:21:Enabling
Enabling graphics
graphics features
features

1. Add a new value to the ctm0GraphicPref.values preference.

2. Create a new preference to specify how the new option appears in the list box, for example,
ctm0GraphicPref.newstandard.name.

3. Create a new preference to specify the graphic tagging to use for the new option, for example,
ctm0GraphicPref.newstandard.text.

21-10 Content Management PLM00014 12.2

Chapter 22: Enabling content editing

Setting up tools for editing content

An editing tool is used to author and edit XML and SGML content and is launched when you edit
a topic. Editing tools are installed on each client, following the supplier's instructions. To set up an
editing tool, complete the actions below.
• Create an editing tool object for each editing tool installed on the client.

• Install any additional plug-ins required for the editing tool, unless you are using Teamcenter
XMetaL Client. If you are using Teamcenter XMetaL Client, do not install the XMetaL plugin in
the Teamcenter interface.

• Relate a stylesheet revision to an editing tool if you want a specific stylesheet to be used with the
editing tool when topics are edited.

• Implement any customizations or macros provided by the editing tool that may be useful to
your organization.

Note
Editing tools are supported only on Windows clients.

Examples of editing tools that work with Content Management follow. Additional tools may be defined
to work with Content Management.
• Altova XMLSpy

• Adobe Structured FrameMaker

• JustSystems XMetaL Author

If you import Base Content Management administration data, you import the XMetal 9.0 editing tool
object. If you install XMetal 9.0 and you import this tool object, verify that the assigned tool path
matches the path for your installation of the tool.

Create an editing tool object

1. Select the folder in which you want to create the new editing tool object, and then either click New
Administrative Item... , or choose File→New→New Administrative Item.

2. In the New Administrative Item dialog box, expand Complete List, click Editing Tool, and
then click Next.

PLM00014 12.2 Content Management 22-1

 Chapter
Chapter 22:22:Enabling
Enabling content
content editing
editing

3. In the dialog box, do the following:

For this option Do this

Name Type a name for the editing tool.

Note
If you are using Teamcenter XMetaL Client (released
with Teamcenter 10.1.0.1 and later), locate the XMetaL
installation folder ...\SoftQuad\XMetaL to obtain the
version number, and type the name as XMetaL, space,
and version number. For example, XMetaL 9.0.

Tool Activation Select the tool activation that corresponds to the editing tool object
you are creating:

Note
If no tool activation is available for the editing tool
object you are creating, leave the value blank or select
SIMPLE_TEXT_EDITOR. The tool is launched externally
using the Tool Command.

If the editing tool is Select this

Altova XML-Spy EDITOR_XMLSPY
FrameMaker EDITOR_FRAMEMAKER
Altova Authentic EDITOR_AUTHENTIC
XMetaL Author EDITOR_XMETAL
A text editor, such as SIMPLE_TEXT_EDITOR
Microsoft Notepad,
Microsoft WordPad,
or Textpad

Note
The EDITOR_EMBEDDED_XMETAL tool is for future
use.

22-2 Content Management PLM00014 12.2

 Enabling content editing

For this option Do this

Tool Command Type the command used by Content Management to start the tool.
This includes the start command (for example, an .exe file) and
any required or optional parameters for the tool you are using. The
valid command line parameters for the tool are typically documented
by the tool supplier.
Here are some example tool commands:
XMLSpy.exe "%s"

xmetal90.exe "%s"

FrameMaker.exe "%s"

TextPad.exe "%s"

wordpad.exe "%s"

Note
The valid parameters depend on the tool you use.

Tool Path Type the path where the tool's start file, such as an .exe file, is
stored. For example: C:\Program Files\XMetaL 9.0\Author
Graphic Priority Table Select the graphic priority list to associate with the tool. The graphic
Reference priority list is used to select the graphic options to be downloaded to
the content when it is opened in the editing tool.
Download graphics Select either True or False, to specify whether graphics that are
referenced by the content are downloaded from Teamcenter when
the editing tool is launched. This allows for the most recent graphics
to be distributed to users from a central location.
Download schema Select either True or False, to specify whether schemas on which
content is based are downloaded from Teamcenter when the editing
tool is launched. This allows for the most recent schemas to be
distributed to users from a central location.
Download stylesheet Select either True or False, to specify whether stylesheets are
downloaded from Teamcenter when the editing tool is launched.
This allows for the most recent stylesheets to be distributed to users
from a central location.
Processing instruction Type any necessary processing instruction for the editing tool. The
processing instruction is written into the content files when opened
in the editing tool. XMLSpy requires a processing instruction inside
the content to select the stylesheet to use during editing.
The processing instruction for this tool is:
<?altova_sps%s?>
where %s is the stylesheet main file name.

PLM00014 12.2 Content Management 22-3

 Chapter
Chapter 22:22:Enabling
Enabling content
content editing
editing

For this option Do this

System Usage Select one of the following:
• SYSTEM
The editing tool will not appear in selection lists in dialog boxes.

Note
This is used for special purposes only, like adding
new objects that may not be ready for general use
or for objects to be used only by system processes;
such as workflows.

• USER
The editing tool will appear in selection lists in the appropriate
dialog boxes.

4. Click Finish.

Install editing tool plug-ins

Some editing tools require you to install additional plug-ins within Content Management.

Note
If you use Teamcenter XMetaL Client, do not install the XMetaL plugin in the Teamcenter
interface.

1. Choose Window→Preferences.

2. In the Preferences dialog box, expand Content Management, and expand Edit.

3. Select the editing tool you want to install, and enter the appropriate information.

Example
If you are installing XMetaL, enter the path to the tool's install location, for example:
C:\Program Files\XMetaL 9.0\Author.

4. (For most tools) Click Install.

5. Click Apply.

6. Click OK to close the Preferences dialog box.

22-4 Content Management PLM00014 12.2

 Enabling content editing

Tip
If you are using XML Spy and the Teamcenter CMS menu does not appear on the toolbar,
for the XML Spy tool, click Uninstall and then click Install to reinstall the required plug-in.
Then in XML Spy, choose Tools→Customize→Toolbars, and then select Reset All.

PLM00014 12.2 Content Management 22-5

Chapter 23: Enabling content publishing

Tasks for enabling publishing content

Publishing tools are used to render content to PDF, HTML, and other formats, and are launched when
you publish content. A publishing tool is also used to view content.
Publishing tools can be installed on the client or a server, following the supplier's instructions. Create
a publishing tool object for each publishing tool installed.

To enable authors to publish content you must do the following:

• Create a stylesheet for each type of output.

• Create a publishing tool for each type of output and relate it to the stylesheet revision.

• Relate the stylesheet revision to topic types and publication types.

• (Optional) To enable authors to save output to a file system where your Web server is deployed,
you must enable publishing to a file system.

• If you are upgrading from a version of Content Management prior to 9.0, you must reselect the
Tool Activation option for all the publishing tools you previously created.

• To enable the publishing of S1000D content on UNIX, you must ensure that the correct directories
exist on the computer running the Teamcenter server if the Java version used by the Teamcenter
server is updated.

Example
If the system is updated to Java 1.8.x, these directories must exist:
/usr/lib64/java-1.8.0

/usr/share/java-1.8.0

Publishing tool examples

The following tools are examples of publishing tools that work with Content Management. Additional
tools may be defined to work with Content Management.
• Antenna House XSL Formatter

• Apache FOP (Formatting Objects Processor)

• DITA Open Toolkit

PLM00014 12.2 Content Management 23-1

 Chapter
Chapter 23:23:Enabling
Enabling content
content publishing
publishing

Pre-configured publishing tool objects

If you import Content Management administration data, you import the following pre-configured
publishing tool objects:

Note
Verify that the tool paths assigned to imported publishing tools match the paths for your
installation of the tools.

• Base Content Management tools:

o FOP
Supports Formatting Objects Processor, a Java application that converts XSL Formatting
Objects files to PDF.

o InternalViewer
An internal tool that publishes XML content to the Preview view. This tool is configured to
use Internet Explorer and HTML styled content.

o PDF serverside
Supports Antenna House XSL Formatter, one of many available publishing applications that
can be purchased from a third-party supplier, installed on a server, and used to publish
content to PDF.

o serverside HTML publish

An internal tool that publishes content to HTML. Processing occurs on the Teamcenter server,
and the tool is configured to use XSLT stylesheets.

• DITA Content Management tools:

Note
o If you are using DITA Open Toolkit publishing tools on a UNIX system, the tool
command must be ant and not ant.bat as it is for Windows systems.

o Set the path for DITA_ANT_HOME in the Dispatcher_Root\Module\Translators\

contmgmtpublish\config\contmgmtpublish_config.properties file. The path
must be set to the Ant directory in the DITA OT.

o Content Management supports version 2.4.6 of the DITA Open Toolkit (OT)
publishing tools.
To use an older version of DITA OT, copy the older version of DITA OT to: the
Dispatcher_Root\Module\Translators\contmgmtpublish\lib folder.

o DITA Open Toolkit XHTML

A tool for publishing DITA content to XHTML.

23-2 Content Management PLM00014 12.2

 Enabling content publishing

o DITA Open Toolkit PDF

A tool for publishing DITA content to PDF.

o DITA Open Toolkit RTF

A tool for publishing DITA content to RTF.

• S1000D 4.0/4.1 Content Management tools:

o S1000D Publish XHTML
A tool for publishing S1000D content to XHTML.

o S1000D Publish PDF

A tool for publishing S1000D content to PDF.

Create a publishing tool object

1. Select the folder in which you want to create the new publishing tool object, and then either click
New Administrative Item... , or choose File→New→New Administrative Item.

2. In the New Administrative Item dialog box, expand Complete List, click Publishing Tool,
and then click Next.

3. In the dialog box, do the following:

For this option Do this

Name Type a name for the publishing tool.
Tool Activation Select the publishing tool activation that corresponds to the
publishing tool object you are creating.

Note
When you upgrade from a version of Content
Management prior to 9.0, you must reselect the Tool
Activation option for all the publishing tools you
previously created.

PLM00014 12.2 Content Management 23-3

 Chapter
Chapter 23:23:Enabling
Enabling content
content publishing
publishing

For this option Do this

Tool Command Type the command used by Content Management to start the tool.
This includes the start command (for example, an .exe file) and
any required or optional parameters for the tool you are using. The
valid command line parameters for the tool are typically documented
by the tool supplier.
If you use command line parameters for one or more of the following,
they must be entered in this order. If your tool cannot accept the
parameters in this order, you must use a custom launch program
to publish files.
a. XML file

b. Stylesheet file

c. Output file

Note
If you are using DITA Open Toolkit publishing tools on a
UNIX system, the tool command must be ant and not
ant.bat as it is for Windows systems.

Tool Path Type the path where the tool's start file (for example, an
.exe file) is stored. For example: C:\Program Files\Antenna
House\AHFormatterV62
Graphic Priority Table Select the graphic priority list to associate with the tool. The graphic
Reference priority list is used to select the graphic options to be downloaded to
the content when it is launched with the publishing tool.
Download graphics Select either True or False, to specify whether graphics that are
referenced by the content are downloaded from Teamcenter when
the publishing tool is launched. This allows for the most recent
graphics to be distributed to users from a central location.
Download schema Select either True or False, to specify whether schemas on which
content is based are downloaded from Teamcenter when the
publishing tool is launched. This allows for the most recent schemas
to be distributed to users from a central location.
Download stylesheet Select either True or False, to specify whether stylesheets are
downloaded from Teamcenter when the publishing tool is launched.
This allows for the most recent stylesheets to be distributed to users
from a central location.
Local Indicator Select either True or False, to specify whether the publishing tool is
run from the client instead of being run from a publishing server.
Number of Instances Type the number of licenses you have for this tool, if you want to
store that value here; however it is not enforced by the system.

23-4 Content Management PLM00014 12.2

 Enabling content publishing

For this option Do this

Processing instruction Type any necessary processing instruction for the publishing tool.
The processing instruction is written into the content files when
opened with the publishing tool.
System Usage Select one of the following:
• SYSTEM
The publishing tool will not appear in selection lists in dialog
boxes.

Note
This is used for special purposes only, such as
for adding new objects that may not be ready for
general use or for objects to be used only by system
processes, such as workflows.

• USER
The publishing tool will appear in selection lists in the appropriate
dialog boxes.

4. Click Finish.

Publishing tool activations

The following are the provided tool activations you may select when creating a new publishing
tool object:

Note
Customizers may add additional activations.

If the publishing tool is Select this tool activation

Installed on the client and com.teamcenter.rac.contmgmtbase.publish.publisher
can act as a command line .ClientExternalCmdPublisher
tool or has a command
line interface.
A tool that publishes com.teamcenter.rac.contmgmtbase.publish.publisher
content to the Preview .ClientInternalPublisher
view.
Formatting Objects com.teamcenter.contmgmtpublish.prepare
Processor (FOP) .FOPPublisher
A plain text publishing tool. com.teamcenter.contmgmtpublish.prepare
.PlainTextPublisher

PLM00014 12.2 Content Management 23-5

 Chapter
Chapter 23:23:Enabling
Enabling content
content publishing
publishing

If the publishing tool is Select this tool activation

Installed on the publishing com.teamcenter.contmgmtpublish.prepare
server and can act as a .ServerExternalCmdPublisher
command line tool or has
a command line interface.
An internal publishing tool com.teamcenter.contmgmtpublish.prepare
that is installed on the .ServerHtmlPublisher
publishing server.
Server side XSL Formatter com.teamcenter.contmgmtpublish.prepare
tool .ServerXslFormatterWithStyleSheetParams
DITA Open Toolkit com.teamcenter.ditapublish.prepare
publishing tool installed on .DitaMapExternalCmdPublisher
the publishing server, for
DITA content.
S1000D publishing tool com.teamcenter.s1000dpublish.prepare
installed on the publishing .S1000DExternalCmdPublisher
server, for S1000D
content.

Add a custom publishing tool activation

Customizers may add publishing tool activations for purposes not met by the provided publishing
tool activations.
1. Create a jar file with customized java class(es), and save it in the TC_ROOT\portal\plugins
folder.

2. In the Business Modeler IDE, add the package name of the jar file to the values for the
Ctm0PubToolActivation list of values (LOV).

3. Create a new publishing tool with the newly created tool activation.

Note
For server side publishing tools, select False for the Local Indicator. For client side
publishing tools, select True.

Enable publishing through Teamcenter Dispatcher

When content is published to HTML, PDF, or another format, it can be published at the client or
through Teamcenter Dispatcher, if it is available.
• To enable publishing through Dispatcher, do the following:
o Install Dispatcher.

o When installing Dispatcher, enable the ContMgmtPublish translator.

23-6 Content Management PLM00014 12.2

 Enabling content publishing

o Configure Dispatcher.

o Configure Teamcenter Dispatcher for asynchronous processing. With asynchronous

processing enabled, when you publish content through Dispatcher, the Publish dialog box
closes when you click Finish.

o (Optional) If your organization publishes very large publications,

increase the value of the MaximumProgress property in the
DISPATCHER_ROOT\Module\conf\transmodule.properties file.

Enable publishing to a file system

When content is published to HTML or PDF format, the output can be saved to a file system where
a distribution web server is deployed. When new versions of output are published, the system
creates a folder for each new version.

Note
To access files published to a file system for access by a distribution web server, you must
configure a web server that can access those files.

• To enable publishing to a file system, create the following preferences:

Note
You can set these preferences by choosing Edit→Options→Content
Management→Publish tab.

o publish_to_file_system
Enables publishing to a file system.

o publish_to_file_system_loc
Specifies the name of the parent folder to store published content.

o deploy_absolute_path
Specifies the file path to the folder specified in the publish_to_file_system_loc preference for
published content. This path is platform-specific.

o deploy_link_prefix
Specifies the URL to connect to the folder storing published content.

PLM00014 12.2 Content Management 23-7

Chapter 24: Create a comparing tool object

Comparing tools are used to compare differences in topics. A comparing tool is installed on each
client, following the supplier's instructions.

Note
You may have only one comparing tool object in Content Management.

1. Select the folder in which you want to create the comparing tool object, and then either click New
Administrative Item... , or choose File→New→New Administrative Item.

2. In the New Administrative Item dialog box, expand Complete List, click Comparing Tool,
and then click Next.

3. In the dialog box, do the following:

For this option Do this

Description Type a description for the comparing tool.
Graphic Priority Table Select the graphic priority list to associate with the tool. The graphic
Reference priority list is used to select the graphic options to be downloaded to
the content when it is launched with the comparing tool.
Name Type a name for the comparing tool.
Processing instruction Type any necessary processing instruction for the comparing tool.
The processing instruction is written into the content files when
opened with the comparing tool.
System Usage One of the following:
• SYSTEM
The comparing tool will not appear in selection lists in dialog
boxes.

Note
This is used for special purposes only, such as
for adding new objects that may not be ready for
general use or for objects to be used only by system
processes such as workflows.

• USER

PLM00014 12.2 Content Management 24-1

 Chapter
Chapter 24:24:Create
Create a comparing
a comparing tool object
tool object

For this option Do this

The comparing tool will appear in selection lists in the

appropriate dialog boxes.
Tool Command Type the command used by Content Management to start the tool.
This includes the start command (for example, an .exe file) and
any required or optional parameters for the tool you are using. The
valid command line parameters for the tool are typically documented
by the tool supplier.
Some tools require the use of at least two parameters, such as for
placeholders for the left and right file names.

Example
wincmp3.exe "%1$s" "/=%4$s" "%2$s" "/=%5$s" /1 /R2

In this command line, the following parameters are used:

"%1$s" and "%2$s" are placeholders for the left file name
and the right file name. Quotation marks are often used
with parameters to avoid issues with folder names that
include space characters.
"/=%4$s" and "/=%5$s" are captions for the left and right
files.
/1 allows only one instance of the tool.
/R2 specifies that the right pane is read-only.
The valid parameters depend on the tool you use.

Tool Output State Not currently used

Tool Path Type the path where the tool's start file (for example, an .exe file) is
stored. For example: C:\Program Files\CompareIt

4. Click Finish.

24-2 Content Management PLM00014 12.2

Chapter 25: Create a viewing tool object

Viewing tools are used to run an external viewing tool to view topics. This is useful when a quick
or remote preview session is needed, without the processing time required to generate a PDF
document. Viewing tools are installed on each client, following the supplier's instructions. Create a
viewing tool object for each viewing tool installed.

In order for users to access a viewing tool, you must write the rich client java class to launch the
tool, and then define the tool to use that class.

Note
A viewing tool is an object different from that used to view topics in the Preview view.
Previewing content is enabled with a publishing tool.

1. Select the folder in which you want to create the new viewing tool object, and then either click
New Administrative Item... , or choose File→New→New Administrative Item.

2. In the New Administrative Item dialog box, expand Complete List, click Viewing Tool, and
then click Next.

3. In the dialog box, do the following:

For this option Do this

Description Type a description for the viewing tool.
Graphic Priority Table Select the graphic priority list to associate with the tool. The graphic
Reference priority list is used to select the graphic options to be downloaded to
the content when it is launched with the viewing tool.
Name Type a name for the viewing tool.
System Usage One of the following:
• SYSTEM
The viewing tool will not appear in selection lists in dialog boxes.

Note
This is used for special purposes only, such as
for adding new objects that may not be ready for
general use or for objects to be used only by system
processes such as workflows.

• USER

PLM00014 12.2 Content Management 25-1

 Chapter
Chapter 25:25:Create
Create a viewing
a viewing tool object
tool object

For this option Do this

The viewing tool will appear in selection lists in the appropriate

dialog boxes.
Tool Activation Type a tool activation if one is required for the tool you are using.
If no tool activation is entered, the tool is launched externally using
the Tool Command.
Tool Command Type the command used by Content Management to start the tool.
This includes the start command (for example, an .exe file) and
any required or optional parameters for the tool you are using. The
valid command line parameters for the tool are typically documented
by the tool supplier.
Tool Path Type the path where the tool's start file (for example, an .exe file) is
stored.
Viewable Content Type Select type of file to which you want to assign a viewing tool.

4. Click Finish.

25-2 Content Management PLM00014 12.2

Chapter 26: Exchange Content Management data
between multiple sites

How multisite data exchange for Content Management works

• Extract Content Management data from Teamcenter using the multisite_automation.pl

perl script
By default, this script extracts Content Management data from Teamcenter that has changed in
the last 24 hours and passes it to the data_share utility to transfer the data to the target sites.
You can customize what data is exported and when by modifying the arguments in the script file.

• Transfer data to the target site using the data_share utility

This utility is used for multisite data transfers. It is invoked from the multisite_automation.pl
perl script. The data is imported into the target site and the relationships between the data is
maintained using the default Content Management closure rules.

You also have an option of downloading the data as TC XML files and then importing that data into
the target site.

How administrators can set up and exchange Content Management data?

• Whenever you, as the administrators want to synchronize data between sites, you must run
the multisite_automation.pl perl script. To automate the synchronization, run this script as a
Windows service or as a UNIX cron job.
This script file is located in the TC_ROOT\install\contmgmtbase directory.

• You can customize the data, workspace objects, sites, output directory, and age of data to
synchronize in the script file. You can also specify whether the data in exported as aTC XML file.

• In the script file, you can customize how the data_share utility behaves by specifying the options
you want. For example, you can specify custom check-in and check-out behavior.

• To manually download data as TC XML files, use the -offline argument in the data_share utility.

• If you have downloaded data as TC XML files, you can import the data into the remote site using
the -optionset argument of the data_share utility.

• When data is imported at the target site, the object and relationships are set per the default
Content Management closure rules. You can specify additional closure rules by modifying the
MultiSiteDefaultCR closure rule in PLM XML/TC XML Export Import Administration.

For more information, see the multisite_automation.pl file located in the

TC_ROOT\install\contmgmtbase directory.

PLM00014 12.2 Content Management 26-1

 Chapter
Chapter 26:26:Exchange
Exchange Content
Content Management
Management data data between
between multiple
multiple sites sites

Example
Synchronizing data between sites:

perl multisite_automation.pl -u=infodba -p=infodba -g=dba

-dt="21-Jan-2019 17:00:00" -sites=site1,site2,site3
-o="C:\temp\multisite_output\"

Download data to a directory:

perl multisite_automation.pl -u=infodba -p=infodba -g=dba

-dt="21-Jan-2019 17:00:00" -sites=site1,site2,site3
-offline -o="C:\temp\export_dir"

Import data that was downloaded to a directory:

data_share -optionset -u=infodba -p=infodba -g=dba -site=site1

-filename=C:\temp\test_cm_multisite\DC_TopicRevision.txt
-include_bom -all_revisions -f=send

26-2 Content Management PLM00014 12.2

Chapter 27: Setting up translation features

Tasks required to set up translation features

Teamcenter provides support for the translation of content from a source language to additional
languages and the publication of documents in different languages. To manage the translation
process, authors create translation orders and send them to a translation office along with topics
to be translated to other languages. Before authors can work with translations, the application
administrator must do the following:
• Establish the languages that are available for translations, to ensure that each language needed
for translation is represented by a language item in the database.

• Create translation offices, ensuring that each translation office used for translations is created
in the database.

• Setting the graphic priority for translation orders.

• Configure your Teamcenter installation to support the UTF-8 character set.

Establishing languages available for translations

Each language used for translations in Content Management must be represented by a language item
in the database and managed in the Organization application. Each language item is identified by a
unique language name and stores such attributes as the ISO language code and ISO country code.
You can import language items from the administration data included with Content Management.

Create a translation office

A translation office is an organization that translates content into other languages. A translation office
object contains the necessary information to manage the translation process in Content Management
for a specific translation office, including which languages can be selected for translations. Translation
office items have translation office revisions.
1. Select the folder in which you want to create the new translation office, and then either click New
Administrative Item... , or choose File→New→New Administrative Item.

2. In the New Administrative Item dialog box, expand Complete List, click Translation Office,
and then click Next.

3. In the dialog box, do the following:

For this option Do this

ID Either type an ID for the translation office, or leave the box blank so
that the next available item ID is automatically assigned.

PLM00014 12.2 Content Management 27-1

 Chapter
Chapter 27:27:Setting
Setting up translation
up translation features
features

For this option Do this

Revision Either type a revision for the translation office, or leave the box blank
so that the next available revision is automatically assigned.
Name Type the name that is assigned to the translation office object.
Translation Office Title Type the title of the translation office.
Address Type the address of the translation office.
Contact Name Type the contact name for the translation office.
Phone Type the phone number of the translation office.
Website Type the website address of the translation office.
Email Inbox Type the e-mail address of the translation office to which a
translation order can be sent.
Deliver Composed Select either True or False, to specify whether content is typically
Content delivered to this translation office as composed content. This value
is for informational purposes only; it does not affect the processing
of translation deliveries.
Deliver Decomposed Select either True or False, to specify whether content is typically
Content delivered to this translation office as decomposed content. This
value is for informational purposes only; it does not affect the
processing of translation deliveries.
Include Supporting Select either True or False, to specify whether the content delivered
Data includes supporting data. This value is for informational purposes
only; it does not affect the processing of translation deliveries.

4. Click Finish.

5. Select the translation office revision in the Home component view, and open the Summary view.

6. Under Language Table, click Add.

7. In the Languages Table dialog box, from the Language Reference list, select a language that is
supported by the translation office.

8. For the Review Ordered option, select whether the translation office typically offers a review of
translations in this language. This value is for informational purposes only; it does not affect the
processing of translation deliveries.

9. Click Finish.

10. Add additional languages as necessary.

Setting the graphic priority for translation orders

When translation orders are created, a graphic priority list is assigned. To specify which graphic
priority list is assigned, you must edit the ctm0_translation_graphicpriority preference.
If this preference is not set, the EDIT graphic priority list is used.

27-2 Content Management PLM00014 12.2

 Setting up translation features

Configure your Teamcenter installation to support the UTF-8

character set
If you import translated content in languages that require multibyte characters, such as Russian and
Chinese Simplified, you must configure your Teamcenter installation to support the UTF-8 character
set to ensure that titles and other properties on this content display correctly in your environment.

PLM00014 12.2 Content Management 27-3

Chapter 28: Transforming XML content

Using XSLT scripts to transform XML

Transformation policies can be used to make specific modifications to XML or SGML content during
the loading or storing of content. This can be done using XSLT scripts that transform XML from one
structure to another. To use an XSLT script in a transformation policy, you create a procedure object
that contains the script, and then add the procedure to the transformation policy. Transformation
policies contain a table of entries, where each entry contains a user action and a procedure name.
Procedures are applied to the content when the action is used.

Caution
Configuration of procedures and transformation policies should be performed by
experienced administrators only. Incorrect application of these procedures and policies can
cause errors in your data.

You can also use procedures in XML attribute mappings. XSLT scripts in attribute mappings enable
you to perform more complex tasks than are possible with a basic attribute mapping. For example, a
script may be used to change the values of attributes before they are extracted from the XML.

Creating XML transformations for publishing and exporting

You can create transformation policies that authors select when they publish or export content. For
example, you can create a transformation policy that converts units of measure in the author’s
document from US standard to metric. You create these transformation policies the same way as
other transformation policies: Create a procedure that contains the XSLT script, and then add the
procedure to the transformation policy. When you create the transformation policy, you must select
Publish, Preview, or Export for the User Action.
This example of an XSLT stylesheet contains the scripts to convert inches to centimeters and feet to
meters. The schema you use must include the elements used by the script.

PLM00014 12.2 Content Management 28-1

 Chapter
Chapter 28:28:Transforming
Transforming
XML XML content
content

The author’s document would include the elements in the XML, for example:
<measure unit=”feet”>5</measure>
<measure unit=”inches”>62</measure>

Create a procedure for XML transformation

1. Select the folder in which you want to create the new procedure, and then either click New
Administrative Item... , or choose File→New→New Administrative Item.

2. In the New Administrative Item dialog box, expand Complete List, click Procedure, and
then click Next.

3. In the dialog box, type the following:

In this box Do this

ID Either type an ID for the procedure, or leave the box blank so that the
next available item ID is automatically assigned.
Revision Either type a revision for the procedure, or leave the box blank so that
the next available revision is automatically assigned.
Name Type a name for the procedure.

28-2 Content Management PLM00014 12.2

 Transforming XML content

In this box Do this

Procedure Usage Select one of the following to define what the procedure is used for:
• For procedures in XML attribute mappings:
o DC_ATTRIBUTEMAPPING_COPY_FROM_
OBJECT_TO_TAG
Copies an attribute value from a Teamcenter object to the
specified XML tag in the content. This type does not support
table attributes.

o DC_ATTRIBUTEMAPPING_COPY_FROM_
TAG_TO_OBJECT
Copies data from an XML tag in the content to a specified
attribute of the Teamcenter object. This type does not support
table attributes.

o DC_ATTRIBUTEMAPPING_GET_FROM_TAG
Gets a value from an XML tag in the content. This type does
not support table attributes.

o DC_ATTRIBUTEMAPPING_REMOVE_FROM_TAG
Removes data from an XML tag in the content.

o DC_ATTRIBUTEMAPPING_SET_TO_TAG
Sets a value in an XML tag in the content. This type does not
support table attributes.

• For procedures in transformation policies:

o DC_CONTENT_TRANSFORMATION
For XML transformations, transforms content during an import
or export or during publishing.

• Reserved for future use:

o DC_OPERATOR_PROCEDURE

o DC_OBJECT_MODIFICATION

o DC_PRE_CREATE
Select Content Browse to and select the file containing the XSLT script.

4. Click Finish.

PLM00014 12.2 Content Management 28-3

 Chapter
Chapter 28:28:Transforming
Transforming
XML XML content
content

Create an XML transformation policy

1. Select the folder in which you want to create the new transformation policy, and then either click
New Administrative Item... , or choose File→New→New Administrative Item.

2. In the New Administrative Item dialog box, expand Complete List, click Transformation
Policy, and then click Next.

3. In the dialog box, in the Name box, type the name for the policy.

4. (Optional) In the Admin Comment box, type a comment that you would like to store with the
transformation policy.

5. Click Finish.

6. Open the Summary view and select the transformation policy.

7. In the Summary view, click Add.

8. In the Transformation Policy Table Entry dialog box, from the User Action list, select the user
action for which the transformation will run.

9. From the XML Procedure list, select the procedure that runs when the user actions occurs.

10. Click Finish.

11. For each user action you want to add to the policy, repeat steps 7 - 10.

Note
To remove an item, click it, and click Delete.

28-4 Content Management PLM00014 12.2

Part II: Content Management Authoring

PLM00014 12.2 Content Management

Chapter 29: Creating Base Content Management content

Overview of Base Content Management content

The Base Content Management solution is used to work with traditional XML or SGML topics and
publications. You can create topic and publication objects directly in Content Management, and you
can create topics in an editing tool.
A publication is the root level topic in a document structure and contains topics and subtopics.
Depending on the topic types available in your schema and defined by your application administrator,
the publication you create may contain such topics as a cover page, back page, header, footer, and
manual contents, which may consist of several subtopics such as sections or chapters. You may
also create standard topics, such as legal notices or warranty statements, which can be reused in
all your publications.
Here is an example of a publication structure:

PLM00014 12.2 Content Management 29-1

 Chapter
Chapter 29:29:Creating
Creating
BaseBase Content
Content Management
Management content
content

Create a topic or template in Base Content Management

Note
You can also create a new topic by adding the valid XML elements in another topic that
is open in an editing tool. When you save and check in edited content, new topics are
created in Content Management with the appropriate relationships to the publication
structure you are working in.

1. Select either a folder, publication, or topic in which you want to create the new topic, and then
either click New Author Item... , or choose File→New→New Author Item.

Note
You can select a folder in the Home component view or a publication or topic in either
the Home component view or the Publication Structure view.

2. In the New Author Item dialog box, expand Complete List, click Topic, and then click Next.

3. Enter the following:

In this box Do this

Select Topic Type Select the topic type to associate with the new topic. The topic type
determines which schema is used to validate the topic and which
stylesheets are used when a tool is launched to edit or publish the
topic. If you are creating a topic in an existing publication from the
Publication Structure view, the list of topic types is limited to the
topic types that are valid for the associated schema.

Note
• The topic type may already be selected, or the
options may be limited to a specific topic type
group, depending on how the ctm0TopicTypeGroup
preference is set.

• If no options are listed, your administrator must create

topic types.

ID Either type an ID for the topic, or leave the box blank so that the next
available item ID is automatically assigned.
Revision Either type a revision number for the topic, or leave the box blank so
that the next available revision is automatically assigned.
Name Type the item name for the topic.
Document Title Type the document title of the topic.
Master Language Select the master language of the topic.
Reference

29-2 Content Management PLM00014 12.2

 Creating Base Content Management content

In this box Do this

Is this a template Select whether this topic will be used as a topic template:
True = This topic is a topic template.
False = This topic is not a topic template.
Reference only Store a value to indicate whether this topic should be copied or
referenced when it is referenced by another topic that is used as
template.
True = This topic should be a reference to its original when it is
referenced by another topic that is used as template.
False = This topic should be copied when it is referenced by another
topic that is used as template.

Example
You are creating topic A which will be used in publication
F. Publication F is used as a template to create publication
G. If this option is set to True for topic A, publication G
should contain topic A as a reference. If this option is set
to False for topic A, publication G should contain topic
B, which is copy of topic A.

Note
Use this only to store a value; the system does not read
this value during the creation of content from a template
topic.

4. Click Finish.
The dialog box clears so you can create another topic.

5. When you are done creating topics, close the dialog box.

Create a publication or template in Base Content Management

1. Select a folder in the Home component view in which you want to create the new publication, and
then either click New Author Item... , or choose File→New→New Author Item.

2. In the New Author Item dialog box, expand Complete List, click Publication, and then click
Next.

3. Enter the following:

PLM00014 12.2 Content Management 29-3

 Chapter
Chapter 29:29:Creating
Creating
BaseBase Content
Content Management
Management content
content

In this box Do this

Select Publication Type Select the type of publication, from the list of those defined in
your system.

Note
If no options are listed, your administrator must
create publication types.

ID Either type an ID for the topic, or leave the box blank so that
the next available item ID is automatically assigned.
Revision Either type a revision number for the topic, or leave the box
blank so that the next available revision is automatically
assigned.
Name Type the item name for the topic.
Document Title Type the title of the publication.
Master Language Reference Select the publication's master language.
Is this a template Select whether this topic will be used as a publication
template:
True = This topic is a publication template.
False = This topic is not a publication template.

4. Click Finish.
The dialog box clears so you can create another publication.

5. When you are done creating publications, close the dialog box.

Create a new topic based on an existing topic revision

1. Select the topic revision from which you want to create the new topic, and then choose
File→Save As→Item(Revision).

2. In the Save Topic Revision As dialog box, enter the following:

For this option Do this

Name Type the name for the new topic revision.

Document Title Type the document title of the topic revision.
Is this a template Select whether this topic will be used as a topic template:
True = This topic is a topic template.
False = This topic is not a topic template.

29-4 Content Management PLM00014 12.2

 Creating Base Content Management content

For this option Do this

Reference only Store a value to indicate whether this topic should be copied or
referenced when it is referenced by another topic that is used as
template.
True = This topic should be a reference to its original when it is
referenced by another topic that is used as template.
False = This topic should be copied when it is referenced by another
topic that is used as template.

Example
You are creating topic A which will be used in publication
F. Publication F is used as a template to create publication
G. If this option is set to True for topic A, publication G
should contain topic A as a reference. If this option is set
to False for topic A, publication G should contain topic
B, which is copy of topic A.

Note
Use this only to store a value; the system does not read
this value during the creation of content from a template
topic.

3. Click Next.

4. For the Define Attached Objects step, click Next to accept the selected values.

Caution
Do not modify the Copy Option.

5. For the Related Objects information step, enter the properties for the new dataset and topic:
a. Expand the dataset and the topic information.

b. Type the Name for the new dataset and new topic.

Tip
This is the topic item level, not the topic revision.

c. (Optional) Type a Description for the new dataset and new topic.

d. (Optional) Type an ID or click Assign to create an ID for the topic.

PLM00014 12.2 Content Management 29-5

 Chapter
Chapter 29:29:Creating
Creating
BaseBase Content
Content Management
Management content
content

e. Click Next.

6. (Optional) For the Assign Project Page step, assign the topic revision to one or more projects.

7. Click Finish.

Create a new publication based on an existing publication revision

When you create a new publication using the Save As option, you create a new publication and
publication revision with references to the same topics as in the original publication.
1. Select the publication revision from which you want to create the new publication, and then
choose File→Save As→Item(Revision).

2. In the Save Publication Revision As dialog box, enter the following:

For this option Do this

Name Type the name for the new publication revision.

Document Title Type the document title of the publication revision.
Is this a template Select whether this topic will be used as a publication template:
True = This topic is a publication template.
False = This topic is not a publication template.

3. Click Next.

4. For the Define Attached Objects step, click Next to accept the selected values.

5. For the Related Objects information step, enter the properties for the new publication:
a. Expand the publication information.

b. Type the Name for the new publication.

Tip
This is the publication item level, not the publication revision.

c. (Optional) Type a Description for the new publication.

d. (Optional) Type an ID or click Assign to create an ID for the publication.

e. Click Next.

6. (Optional) For the Assign Project Page step, assign the publication revision to one or more
projects.

7. Click Finish.

29-6 Content Management PLM00014 12.2

Chapter 30: Creating DITA content

Overview of DITA content

DITA (Darwin Information Typing Architecture) is an XML-based architecture for developing technical
publications. It includes an architectural specification, language specification, and DTD and schema
implementations of the language. If you have installed the DITA Content Management solution, you
can manage documentation for the DITA architecture. The DITA solution also includes Base Content
Management features. The way you relate, create, and edit content differs between the Content
Management solutions; however you can use the Publication Structure view to organize DITA
content. For more information about DITA, see OASIS Standards.
Content Management supports these objects through DITA version 1.3:

Note
DITA publishing is supported only on Linux and Windows.
The contents of anchorref elements are not included in documents published with DITA
Open Toolkit 2.4.6 publishing tools.

• DITA maps
A DITA map is an object that contains references to DITA topics and organizes the topics into
hierarchies, tables, or groups. Maps can also be used to produce outlines or tables of contents. A
map can contain any combination of references to DITA topics, DITA tasks, DITA concepts, DITA
references, and other DITA maps. A DITA map includes metadata to describe properties such as
audience, platform, and product. Maps are used to create documents that result in separate XML
files in output processing. The <map> element is used in the XML to define a map. You can import
existing DITA maps to the Content Management application, which includes any references to
DITA topics they may contain. You can work with two types of maps:

o DITA Dynamic Map

You can add, delete, and organize topics in a DITA dynamic map in Content Management
and edit contents in an editing tool. A DITA bookmap is a special type of dynamic map, used
to organize DITA content into a book format. The <bookmap> element is used in the XML to
define a bookmap.

o DITA Static Map

You can edit topic references in a DITA static map in an editing tool but not in Content
Management. In version 9.0 and later, static maps are primarily used only for content
migrated from earlier versions.

• DITA Base

PLM00014 12.2 Content Management 30-1

 Chapter
Chapter 30:30:Creating
Creating
DITA DITA content
content

A DITA base object, also referred to as a DITA composite object, is a top-level container for
multiple topics used to create documents that result in one XML file in output processing. A DITA
base object can contain any combination of DITA topics, DITA tasks, DITA concepts, and DITA
references. A DITA base object can be opened for editing XML content. The content opens in
the editing tool as one XML file containing all its related files. The <dita> element is used in the
XML to define a DITA base object.

• DITA topics
A DITA topic is one unit of content that contains the information for a single subject. The DITA
architecture includes the following four topic types:

o DITA Topic
A DITA topic, also referred to as a generic or unspecialized topic type, provides the base for
specialized topic types and does not meet the definition of a concept, reference, or task topic.

o DITA Concept Topic

A DITA concept topic is a specialized topic type that provides background information to aid
in the understanding of a product, interface, or task.

o DITA Reference Topic

A DITA reference topic is a specialized topic type that provides quick access to facts.

o DITA Task Topic

A DITA task topic is a specialized topic type that provides step-by-step instructions for
completing a task.

Create a DITA item

1. Select the location in which you want to create the new DITA item, and then either click New
Author Item... , or choose File→New→New Author Item..

Note
You can select a folder in the Home component view or a DITA map or topic in either
the Home component view or Publication Structure view.

2. In the New Author Item dialog box, expand Complete List and click one of the following:
• DITA Base

• DITA Concept

• DITA Dynamic Map

Note
Use this option to create a DITA bookmap.

30-2 Content Management PLM00014 12.2

 Creating DITA content

• DITA Reference

• DITA Static Map

• DITA Task

• DITA Topic

3. Click Next.

4. In the New Author Item dialog box, enter the following:

In this box Do this

Select Topic Type Select the topic type to associate with the new object. The topic
type determines which schema is used to validate the object and
which stylesheets will be used when a tool is launched to edit or
publish the content.

Note
• The topic type may already be selected, or the
options may be limited to a specific topic type
group, depending on how the ctm0TopicTypeGroup
preference is set.

• If no options are listed, your administrator must create

topic types.

ID Either type an ID for the object, or leave the box blank so that the
next available item ID is automatically assigned.
Revision Either type a revision number for the object, or leave the box blank
so that the next available revision is automatically assigned.
Name Type the item name for the object.
Document Title Type the document title of the object.
Master Language Select the master language of the object.
Reference
Is This A Template Select whether this object will be used as a template:
True = This object is a template.
False = This object is not a template.

PLM00014 12.2 Content Management 30-3

 Chapter
Chapter 30:30:Creating
Creating
DITA DITA content
content

In this box Do this

Reference only Use this indicator to set whether this object will be copied or
referenced when it is referenced by another object that is used as
template.
True = This object will be a reference to its original when it is
referenced by another object that is used as template.
False = This object will be copied when it is referenced by another
object that is used as template.
DITA Audience Select the audience to assign to this object.
DITA Importance Select the level of importance to assign to this object.
DITA Other Properties Select other properties to assign to this object.
DITA Platform Select the platform to assign to this object.
DITA Product Select the product to assign to this object.
Relation Selection Select the type of relationship to create between the topics:
(appears only when
you are relating a DITA • DC_ComposableReferenceR
topic to another topic of When a composable reference appears in the editing tool, you
the same type from the see only a reference to the topic. However, when a topic is
Publication Structure published with a composable reference to another topic, the
view) published topic includes all the content of the referenced topic.

• DC_TopicTopicR
When a topic-to-topic relation appears in the editing tool, you
see all the content of the related topic. Also, when a topic is
published with a topic-to-topic relation to another topic, the
published topic includes all the content of the related topic.
Reference Topic Type Select the type of reference to create between the two objects:
(appears only when you
are relating a DITA 1.2 Example
topic to a DITA 1.2 map
or a DITA 1.3 topic to a The following options appear if you are using the DITA 1.2
DITA 1.3 map from the administration data included with Content Management;
Publication Structure you may have other options if you are using DITA 1.3
view) administration data or if your administrator created other
reference topic types.
• Topicset map to topic
Use when defining a topicset element that references
a set of topics.

• Topicref map to topic

Use when adding topics to maps, using the topicref
element. When the map is published, the topics
appear in the output.

30-4 Content Management PLM00014 12.2

 Creating DITA content

In this box Do this

• Keydef map to topic

Use when adding topics to maps, using the keydef
element. By default, when the map is published, the
topics do not appear in the output, although you can
configure them to appear.

Key Name (appears only Type the value to assign to the keys attribute.
when you are relating a
DITA 1.2 topic to a DITA
1.2 map or a DITA 1.3
topic to a DITA 1.3 map
from the Publication
Structure view)

5. Click Finish.

Create a new DITA item based on an existing one

1. Select the revision of the DITA item from which you want to create the new DITA item, and
then choose File→Save As→Item(Revision).

2. In the Save As dialog box, enter the following:

For this option Do this

Name Type the name for the new DITA item.

DITA Audience Select the audience to assign to this item.
DITA Importance Select the level of importance to assign to this item.
DITA Other Properties Select other properties to assign to this item.
DITA Platform Select the platform to assign to this item.
DITA Product Select the product to assign to this item.

3. Click Next.

4. For the Related Objects information step, enter the properties for the new dataset and item:
a. Expand the dataset and the item information.

b. Type the Name for the new dataset and new item.

Tip
This is the item level, not the item revision.

PLM00014 12.2 Content Management 30-5

 Chapter
Chapter 30:30:Creating
Creating
DITA DITA content
content

c. (Optional) Type a Description for the new dataset and new item.

d. (Optional) Type an ID or click Assign to create an ID for the item.

5. Click Finish.

Working with DITA content references (conrefs)

What are DITA conrefs?

When you have DITA content that must appear in more than one DITA topic or map, you can use
DITA conrefs to reuse the content. When you publish, referenced content appears in the elements
you create in topics or maps. When you edit content, the modifications are reflected everywhere
it is referenced.
You can reference an entire topic or an element from a topic.
When you import a document with a DITA conref, the filename in the conref must be in the format
item_id.dita for topics and item_id.ditamap for maps.

Example
conref="X000001.dita#X000001"
conref="X000001.dita#X000001/para1"
conref="X000124.ditamap"
conref="X000124.ditamap#topic1"

Add a DITA conref to reference an element

1. Open the topic or map that contains the content you want to reuse in another topic or map.

2. In the editing tool, add an ID to the element of the content you want to reference. For example, if
you want to reference the text of a paragraph, create an ID in the id attribute of the paragraph
element.

3. Save the change to the topic or map.

4. Open the topic or map in which you want the referenced content to appear.

5. Add a new element where you want the reference to appear, and leave it empty. For example, if
you are referencing the text of a paragraph, create a new paragraph element.

6. In the Publication Structure view, right-click the topic or map you want to reference, in which
you just created the ID, and choose Copy for Editor→DITA Content Reference.

7. In the editing tool, paste the reference in the empty element in the content, and replace the
placeholder text with the ID of the element you are referencing. The way you paste the reference
depends on the type of tool you are using:

30-6 Content Management PLM00014 12.2

 Creating DITA content

• In a plain text editor or an XML editor with a plain text view, when you paste the reference, it
appears within the element as in this example of a reference to a topic:
conref="X000006.dita#X000006/<?replace_with_element_id?>"

Or in this example of a reference to a map:

conref="X000124.ditamap#<?replace_with_element_id?>"

You replace the placeholder text. For example:

conref="X000006.dita#X000006/para1"
conref="X000124.ditamap#topic1"

• If you are working in an XML editor view showing XML as tags, the reference is pasted as
text instead of markup, so you must edit it accordingly. In XMetaL Author, you can paste
the reference in the element’s conref attribute in the Attribute Inspector, and edit it to
appear as follows:

8. Add the attributes to set whether the conref is fixed or floating. For example:
• In a plain text editor:
conref="X000006.dita#X000006/para1" rev="A" base="fixed"
conref="X000006.dita#X000006/para1" rev="CURRENT" base="floating"

• In an XML editor:

9. Save the changes to the topic or map.

10. To view the relationship between the topics, in the Home component view, right-click the
referenced topic and choose Properties On Relation.

The Properties dialog box shows the relation type between the topics.

PLM00014 12.2 Content Management 30-7

 Chapter
Chapter 30:30:Creating
Creating
DITA DITA content
content

Add a DITA conref to reference another topic

1. In the Publication Structure view, right-click the topic you want to reference and choose Copy
for Editor→DITA Content Reference.

2. Open the topic or map in which you want the referenced content to appear.

3. In the editing tool, paste the reference in the topic element in the content. The way you paste the
reference depends on the type of tool you are using:
• In a plain text editor or an XML editor with a plain text view, when you paste the reference, it
appears within the element as in this example:
conref="X000001.dita#X000001/<?replace_with_element_id?>"

Or in this example of a reference to a map:

conref="X000124.ditamap#<?replace_with_element_id?>"

In this case, you remove the placeholder text. For example:

conref="X000001.dita#X000001"
conref="X000124.ditamap"

• If you are working in an XML editor view showing XML as tags, the reference is pasted as
text instead of markup, so you must edit it accordingly. In XMetaL Author, you can paste
the reference in the element’s conref attribute in the Attribute Inspector, and edit it to
appear as follows:

4. Add the attributes to set whether the conref is fixed or floating. For example:
• In a plain text editor:
conref="X000001.dita#X000001" rev="A" base="fixed"
conref="X000124.ditamap" rev="CURRENT" base="floating"

• In an XML editor:

30-8 Content Management PLM00014 12.2

 Creating DITA content

5. Save the changes to the topic.

Relate DITA topics

If you are using the DITA 1.2 or 1.3 administration data included with Content Management, multiple
reference topic types are available for topics and maps. When you relate a DITA 1.2 or 1.3 topic
to another topic or map, you must select the reference topic type. You may also use this feature if
you are not using the DITA 1.2 or 1.3 administration data but your administrator has defined multiple
reference topic types for DITA topics.
1. Relate a topic to another topic or map by dragging it to the other topic or map in the Publication
Structure view.

Note
If you select a topic item, not a topic revision, the most current revision is moved.

2. From the Reference Topic Type list, select the type of reference to create between the two
objects.

PLM00014 12.2 Content Management 30-9

 Chapter
Chapter 30:30:Creating
Creating
DITA DITA content
content

Example
The following options appear if you are using the DITA 1.2 administration data; you
may have other options if you are using DITA 1.3 administration data or if your
administrator created other reference topic types
• Topicset to topic
Use when defining a topicset element that references a set of topics.

<map>
<topicset id="maintenance" navtitle="Maintenance"
href="maintenance.dita"
type="topic"/>
<topicref href="tools_needed.dita"
navtitle="Tools Needed to Perform Maintenance"
type="topic"/>

<topicref href="tasks_performed.dita" navtitle="Tasks Performed" type="ta

</map>

• Topicref to topic
Use when adding topics to maps, using the topicref element. When the map is
published, the topics appear in the output.

Example
<map>
<topicref href="maintenance.dita" navtitle="Maintenance"
type="topic"/>
</map>

• Keydef to topic
Use when adding topics to maps, using the keydef element. By default, when
the map is published, the topics do not appear in the output. You can configure
them to appear by setting the processing-role attribute in the referenced topic to
normal. Topics containing keyrefs to the topics defined in keydefs are included
in the output.

Example
<map>
<keydef keys="tools" href="tools_needed.dita"
navtitle="Tools Needed to
Perform Maintenance" type="topic"/>
</map>

3. In the Key Name box, type the value to assign to the keys attribute.

30-10 Content Management PLM00014 12.2

 Creating DITA content

4. Click Finish.

Add topics to a DITA relationship table

The DITA relationship table (reltable) enables you to manage related topic links in publications using
a single map. The relationships defined in the table appear in lists of related topics in the published
output. For more information about relationship tables, see OASIS Standards.
1. In a DITA dynamic map in an editing tool, use standard DITA elements and attributes to create
a relationship table.

2. For each topic you want to add to the table, in the Publication Structure view, right-click the
topic, and choose Copy for Editor→Reference To DITA Map.

3. In the editing tool, paste the reference in the relcell element in the relationship table.
The cell is populated with the tag name from the type of topic you copied the reference from, for
example: topicref. The href, navtitle, and type attributes are populated in the element.

4. Edit the tag if it is not the correct element.

5. Add more attributes, if necessary, such as linking.

The output creates related links to topics in the same row, but not the same cell.

Example

The output for the task topic looks like this:

The output for one of the concept topics looks like this:

PLM00014 12.2 Content Management 30-11

 Chapter
Chapter 30:30:Creating
Creating
DITA DITA content
content

Working with DITA keyrefs

DITA keyrefs are an indirect addressing mechanism available in DITA 1.2 and 1.3, in which you store
symbolic names for topic file paths in one map. When you change a topic’s path in this one place, all
references to the topic are automatically updated.
To use the keyref attribute, you define the keys attribute in a map on an element that references
another topic or map, such as the topicref or keydef elements. You can define keys in the same map
you use for your deliverable, or you can create and reference a map specifically for defining keys. In
the keys attribute you define a name for a topic’s file and in the href attribute you define the file’s path.

Example
<topicref keys="tools" href="tools_needed.dita"/>

or
<keydef keys="tools" href="tools_needed.dita"/>

To create references to the topic from another topic, you use the keyref attribute.

Example
<link keyref="tools"/>

In the above example, the link defined by the keyref goes to the tools_needed.dita file. If the location
of the file changes later, you update the keys definition in the map, and all the references in all the
topics with the tools keyref automatically point to the new file location.
For more information about DITA keyrefs, see the DITA XML.org website.
In Content Management, you can define keyrefs in several ways:
• When you create a new topic in a selected map, in the New Author Item dialog box you define
the Reference Topic Type and Key Name, which is the value of the keys attribute.

• When you relate DITA topics, you drag the topic for which you want to define the keys to the map
in which you want to define it. In the Reference Topic Type Selection dialog box, select the
Reference Topic Type and type the Key Name, which is the value of the keys attribute.

30-12 Content Management PLM00014 12.2

 Creating DITA content

• When you edit the content in an editing tool, you can add the XML elements and attributes to
define keyrefs.

Validate DITA keyrefs

When you define DITA keyrefs and create references to them, you can validate the keyrefs to make
sure they are set up correctly.
You can also set the Cdi0KeyrefValidation preference to true so that keyrefs used in topics
referenced in maps are always validated during import and when you save changes and close
the file in an editing session.
1. Select the map that defines the keys for the keyrefs.

2. Choose Tools→Reference Validation.

The validation finds keyrefs used in the map's topics and verifies that the keys are defined in
the map.
A message appears indicating whether the keyrefs are valid.

Create DITA value filter using a Ditaval topic

DITA value filters are used to filter topics in a DITA map when you publish it, based on certain
attributes in the topics. For example, you can exclude topics whose audience attribute is advanced or
expert, so that the map includes only those topics whose audience is beginner.
Your administrator may create DITA value filters that you can apply to content when you publish it. In
Content Management for DITA 1.3, you may also create your own DITA value filters by creating topics
with the Ditaval topic type.

Create a DITA value filter

1. Create a DITA Topic.
• For the topic type, select DITA 1.3 Ditaval.

• Enter only the required values. Do not select value filters at the bottom of the dialog box.

2. Edit the topic, and define the value filters using the DITA val element according to the OASIS
Standards.

3. Drag the DITA value filter topic to any place in the structure of a map in the Publication
Structure view.

Apply DITA value filters when publishing

1. Begin the steps to publish the map.
DITA value filters created by your administrator appear in the DITA Value Filters list.

2. Choose Find DITAVALs.

PLM00014 12.2 Content Management 30-13

 Chapter
Chapter 30:30:Creating
Creating
DITA DITA content
content

The DITA value filter topics that were added to the map appear in the DITA Value Filter Topics
in the Map list.

3. Select or clear the check boxes for the DITA value filters, from either list, that you want to use
to publish the map.

Review broken links in DITA OT output

When you publish content, a log file is created. If you publish with a DITA Open Toolkit (OT) tool, you
can review the log file for any errors with broken references or links between topics.
1. After you publish content, choose Translation→Administration Console.

2. In the Dispatcher Request Administration Console, select the line containing the publish
request and click .

3. In the Translation Request Properties dialog box, click the Files tab.

4. Select the log file and click Export.

5. In the Save As dialog box, select the location to save the log file.

6. Open the log file with a text editor, and search for the errors that provide the information about
the broken links.

30-14 Content Management PLM00014 12.2

Chapter 31: Creating S1000D content

Overview of S1000D content

If you have installed the S1000D Content Management solution, you can manage documentation for
the S1000D standard. The S1000D solution also includes base Content Management features. The
way you relate, create, and edit content differs between the Content Management solutions. You can
use the Publication Structure view to organize S1000D content.

Note
To import SGML data for authoring in the S1000D solution, the Content Management
S1000D SGML Parser feature must be selected in Teamcenter Environment Manager
(TEM) when you install Teamcenter.

The dialog boxes you use to create S1000D objects contain all the data required by the S1000D
specification. These items become elements in the resulting SGML or XML object. For example, the
SGML or XML files contain the elements of the identification and status section that is required in
certain objects. The content of the objects is created in an editing tool.
To download sample content that you can view or import, see www.S1000D.org, which includes the
sample XML content and illustrations for a fictional bike for the most recent S1000D versions.
Content Management supports these objects for S1000D version 2.3 (SGML objects) and versions
4.0.1, 4.1, and 4.2 (XML objects):

Note
S1000D version 2.3 is supported only on Linux and Windows.

• Data Module
A data module is a self-contained information unit. Every data module contains an identification
and status section and a content section that contains text and illustrations. Content Management
supports the standard S1000D data modules types, including BREX, procedural type, and
descriptive type.

• Data Module List (DML)

A data module list (DML) identifies the data modules in a project. It contains an identification and
status section and the data module requirement list content. The DML object can be related to
data module objects, but it is not required. When you relate data modules to it, the DML can be
used to group data modules together in a compiled dataset.

• Data Dispatch Note (DDN)

PLM00014 12.2 Content Management 31-1

 Chapter
Chapter 31:31:Creating
Creating S1000D
S1000D content
content

A data dispatch note (DDN) contains information about the sender, receiver, and content of a
dispatch. It can be related to many data modules. When the relation to a data module is made,
additional SGML or XML code is automatically added to the DDN about the data module. A
data module can be related to many DDNs.

• Publication Module
A publication module defines the content and the structure of a publication. It contains an
identification and status section and a content section that contains references to data modules,
other publication modules, and legacy technical publications. The publication module for
S1000D content is not the same type of object as the publication topic type used in Base
Content Management.

• Commentary
A commentary, or comment, is used to report issues on data modules during the verification
process and the in-service phase of the product. It contains an identification and status section
and a content section that contains the original comment and/or a response to a comment. A
comment can be related to a data module, publication module, DML, or DDN; it must have at
least one of these relations.

• In Process Review Form

An in-process review form contains the review of data modules by the customer or the contractor.

• SCORM Content Package

A SCORM content package contains the content and metadata for e-learning developed in
accordance with the Sharable Content Object Reference Model (SCORM) standard.

• Standard Numbering System (SNS)

An S1000D standard numbering system (SNS) structure defines the numbering scheme used in
data modules for specific S1000D projects.

Create an S1000D item

1. Select the location in which you want to create the new S1000D object, and then either click New
Author Item... , or choose File→New→New Author Item.

Note
You can select a folder in the Home component view or an S1000D object in either the
Home component view or Publication Structure view.

2. In the New Author Item dialog box, expand Complete List and click the item you want to create.
All S1000D items are listed with the S1000D prefix.

3. Click Next.

4. In the New Author Item dialog box, enter the data for the object you are creating, according to
the S1000D standard.

31-2 Content Management PLM00014 12.2

 Creating S1000D content

For more information on the S1000D standard, see www.S1000D.org.

Note
When you create an S1000D 2.3 data module, you must enter one of the two following
groups of options, even though they may not be marked as required:
• System Difference Code, Chapter Number, Section Number, Subsection,
and Subject

• Support Equipment Variant Code, Equipment Category and Sub-Category

Code, Equipment Identification Code, Component Identification Code,
Extension Code, and Extension Producer

5. Click Finish.
If any of the attributes that comprise the item ID are not valid for the associated schema, a
message box appears indicating which fields are invalid. For example, when creating a data
module, the Model Identifier and System Code values are validated, but the Security Class
value is not.

Create a new S1000D item based on an existing one

1. Select the revision of the S1000D item from which you want to create the new S1000D item, and
then choose File→Save As→Item(Revision).

2. In the Save As dialog box, modify the data for the new item you are creating, according to
the S1000D standard.
For more information on the S1000D standard, see www.S1000D.org.

Note
Any changes you make to the codes that comprise the Export File Name are
automatically updated in the Export File Name when the new item is created. For
example, if you change the Item Location Code, that character in the Export File
Name is updated when the item is saved to the database.

PLM00014 12.2 Content Management 31-3

 Chapter
Chapter 31:31:Creating
Creating S1000D
S1000D content
content

When you create an S1000D 2.3 data module, you must enter one of the two following
groups of options, even though they may not be marked as required:
• System Difference Code, Chapter Number, Section Number, Subsection,
and Subject

• Support Equipment Variant Code, Equipment Category and Sub-Category

Code, Equipment Identification Code, Component Identification Code,
Extension Code, and Extension Producer

3. Click Next.

4. For the Define Attached Objects step, click Next to accept the selected values.

5. For the Related Objects information step, enter the properties for the new S1000D item:
a. Expand the dataset and the S1000D item information.

b. Type the Name for the new dataset and new S1000D item.

Tip
This is the item level object, not the revision.

c. (Optional) Type a Description for the new dataset and new S1000D item.

d. (Optional) Type an ID or click Assign to create an ID for the S1000D item.

e. Click Next.

6. (Optional) For the Assign Project Page step, assign the S1000D item to one or more projects.

7. Click Finish.
If any of the attributes that comprise the item ID are not valid for the associated schema, a
message box appears indicating which fields are invalid. For example, when creating a data
module, the Model Identifier and System Code values are validated, but the Security Class
value is not.

Adding data modules to DMLs, DDNs, and publication modules

You can relate data modules to a data module list (DML), a data dispatch note (DDN), or a publication
module (PM) to group data module references together in one document. When you relate a data
module to a DML, DDN, or PM in Content Management, SGML, or XML elements from the data
module are added to the DML, DDN, or PM.
To relate data modules to DMLs, PMs, and DDNs in S1000D 4.0, 4.1, and 4.2, you must create a
content topic as a child of the DML, PM, or DDN. Also, for PMs and DDNs, you must then create an
additional topic.

31-4 Content Management PLM00014 12.2

 Creating S1000D content

Example

To relate data modules to DMLs in S1000D 2.2/2.3, you relate the data modules directly to the DMLs.
For DDNs, you must create a topic with a delivery list topic type as a child of the DDN. You then
relate data modules to the delivery list topic.
You can also create an S1000D data module list by using a saved search.

Note
Once any data module is related to a data module list, the saved search is no longer used
for that data module list.

Relate data modules

You can relate data modules to a data module list (DML), a data dispatch note (DDN), or a publication
module (PM).
1. Right-click the data module, and choose Copy for Editor→Data Module Reference.
If more than one reference type is defined in your system, the Reference Topic Type Selection
dialog box appears.

PLM00014 12.2 Content Management 31-5

 Chapter
Chapter 31:31:Creating
Creating S1000D
S1000D content
content

2. From the Reference Topic Type list, select the type of reference to create between the data
module and the object you are relating it to.

3. Click Finish.

4. Click in a valid location in the content in the editing tool, and choose Paste.

Creating the structure of an S1000D publication module

To create the structure of an S1000D publication module, you assemble the hierarchy of objects,
such as in this example.

Example
• Publication Module
o PM Content topic
■ PM Entry topic
◊ Front Matter data module (title page appears as first page)

■ PM Entry topic
◊ Other supported data module type (see list below)

■ PM Entry topic
◊ Other supported data module type (see list below)

31-6 Content Management PLM00014 12.2

 Creating S1000D content

With the S1000D stylesheets provide upon installation, you can create the following types of S1000D
publication modules for publishing to PDF or XHTML format. Your administrator can also create
stylesheets for publishing additional S1000D publication types. The objects you add to the hierarchy
and the stylesheets you use determine the contents of the publication modules.
• Service bulletin publication module - references service bulletin data modules

• Illustrated parts publication - references illustrated parts data modules

• General publication module - references one or more types of data modules. The following types
are supported. If you include unsupported data modules in the publication module, the output
includes text explaining that the type is unimplemented.
Descriptive

Fault

Illustrated parts data

Procedure

Schedule

Service bulletin

Front matter

Air crew

Contents of published S1000D publication modules

You can publish three types of S1000D publication modules to PDF or XHTML format. If you use
the stylesheets provided upon installation and assemble the publication modules with the following
structure, the published content contains the following:

PLM00014 12.2 Content Management 31-7

 Chapter
Chapter 31:31:Creating
Creating S1000D
S1000D content
content

Service bulletin publication module

• Front matter content:
Title page

Table of contents for each referenced data module in the publication module

List of effective pages

List of effective data modules

Highlights, which includes reasons for updates and changes

• Content for each service bulletin data module:

Table of contents

List of tables

List of figures

Service bulletin content

• Acronym and term indices

Illustrated parts publication module

• Front matter content:
Title page

Table of contents for each referenced data module in the publication module

List of effective pages

List of effective data modules

Highlights, which includes reasons for updates and changes

• Content for each description data module:

Description content

• Content for each illustrated parts data module:

Illustrated parts content

• Acronym and term indices

General publication module

• Front matter content:
Title page

Table of contents for each referenced data module in the publication module

31-8 Content Management PLM00014 12.2

 Creating S1000D content

List of effective pages

List of effective data modules

Highlights, which includes reasons for updates and changes

• Content for each referenced data module:

Table of contents

List of tables

List of figures

Data module content

• Acronym and term indices

Using saved searches to create data module lists

You can use saved searches to generate S1000D data module lists. If you use a saved search in
a data module list, when you export or publish the data module list, the data modules in the saved
search will be included, as if they were related to the data module list. This is particularly useful
for large data module lists.

Note
The saved search must be related to the topic in the data module list that contains the data
module references. For example, in an S1000D 4.0 data module list this is the topic of
the topic type dmlContent. In the Home component view, the saved search is related to
the dmlContent topic revision.

When you relate data modules to data module lists using a saved search, they are related only as
references. In the Publication Structure view, the data modules do not appear under the data
module list. However, if you open the data module list for edit, and then save it, any data modules
referenced from the saved search will be directly related to the data module list and will appear under
the data module list in the Publication Structure view.

Note
Once any data module is related to the data module list, the saved search is no longer
used for that data module list.
You cannot use a saved search to compose non-S1000D objects.

Create a data module list using a saved search

1. Search for the data modules you want to include in the data module list.

PLM00014 12.2 Content Management 31-9

 Chapter
Chapter 31:31:Creating
Creating S1000D
S1000D content
content

2. Create a saved search that includes the data modules.

3. In the Home component view, drag the saved search to the appropriate object:
• For S1000D 2.3, drag it to the data module list revision.

• For S1000D 4.0, 4.1, and 4.2, drag it to the topic under the data module list that stores all
the references.

Note
The data module must be a valid one for the data module list, as defined by your
organization’s schemas. If it is not valid, the data module is not added to the data
module list when published.

Apply project-specific standard numbering system (SNS) codes to

a new data module
An S1000D standard numbering system (SNS) structure defines the numbering scheme used in
data modules for specific S1000D 4.0, 4.1, and 4.2 projects. Your administrator creates an SNS
structure for you to use. When you create a new data module in Content Management, you select a
node of an SNS structure to apply its data module code (DMC) values and other data module detail
values to the data module.
When you import a data module or graphic that use SNS codes, they are related to the appropriate
note in the SNS structure based on their SNS. Objects that don’t use an SNS, such as data dispatch
notes, publication modules, and graphics with commercial and government entity (CAGE) codes, are
related to the top node of the SNS structure.
Nodes in an SNS structure define the values for systems, subsystems, assemblies, and
disassemblies.
1. Right-click the SNS structure in the Home component view or Search Results view, and choose
Show in Publication Structure.

2. In the Publication Structure view, select the node of the structure whose values you want
to use for the data module you are creating.

3. Create the data module.

Values in New Author Item dialog box are populated from the SNS structure node you selected.

Import a data management requirement list

A data management requirement list (DMRL) identifies the data modules planned for a specific
project. You can import a DMRL to Content Management to create data module objects for all data
modules identified in the DMRL. You can import the data modules to a selected folder or as objects
associated with a standard numbering system (SNS) structure.
To import a DMRL:

31-10 Content Management PLM00014 12.2

 Creating S1000D content

1. Prepare the .csv file.

2. Import the DMRL.

Prepare the .csv file

1. Use a text editor to create a .csv file to create a DMRL that lists the data modules you want to
create in Content Management. Microsoft Office Excel is not recommended for this, since it
may remove leading zeros.
A sample .csv file is included in the administration data provided with the Content Management
installation:

TC_ROOT\contmgmts1000d40_data\data\admin\bulkImportDataModule.csv

2. Include the following values, in the order listed. Use a comma for any optional value that is blank.
Model identification code

System difference code

System code

Subsystem code

Sub-subsystem code

Assembly code

Disassembly code

Disassembly code variant

Information code

Information code variant

Item location code

Language

Extension code (optional)

Extension Producer (optional)

Learn Code (optional)

Learn Event Code (optional)

Technical Name

Information Name (optional)

Security classification

PLM00014 12.2 Content Management 31-11

 Chapter
Chapter 31:31:Creating
Creating S1000D
S1000D content
content

Topic type

Originator name

Originator CAGE code

Responsible partner company name

Responsible partner company CAGE code

Example
This is one line representing a data module:
S1000DBIKE, TEMP, DA2, 0, 0, 00, 00, AB, 042, A, A, English US, , , , , Temp
System,
Temp Description, 01, Description-4-1, ORG Name, ORG41, RPC Name, RPC41

Import the DMRL

1. Do one of the following:

• Select the folder in which you want to place the imported DMRL.

• Associate the DMRL with an SNS structure:

a. In the Home component view or Search Results view, right-click the SNS structure to
which you want to associate the DMRL, and choose Show in Publication Structure.

b. In the Publication Structure view, select the node of the structure whose values you
want to use for the DMRL you are importing.

2. Choose Tools→Import→S1000D Project Data→Data Management Requirement List

(DMRL).

3. In the Bulk Import dialog box, browse to and select the .csv file containing the DMRL.

4. Click OK.
If you did not choose an SNS structure to associate the DMRL with, the Import Status dialog
box appears, indicating that no SNS node was selected. Click either Continue to continue
with the import or Cancel to cancel the import.
When the import is complete, the Import Results dialog box appears, indicating the import
completed successfully.

Create a data module delivery

The data dispatch note (DDN) and data module list (DML) are used to create a delivery to transfer
a set of project data modules between organizations. You create a delivery by first choosing a
DML. During the process of creating the delivery, a DDN is created in Content Management, and

31-12 Content Management PLM00014 12.2

 Creating S1000D content

a .zip file is created with the contents of the delivery. The DDN provides the metadata and the list
of data modules in a CSDB transfer package.

When you create a delivery for a project, you can choose to deliver all data modules, only released
data modules, only those not in last official delivery, or all data modules that have changed since
the last delivery.

1. Select the DML for which you want to create a delivery, and choose Tools→Export→Incremental
Delivery.

2. In the Incremental Delivery dialog box, do the following:

For this option Do this

Language Select the language you want to use for the exported content.
Graphic Mode Select one of the following to indicate how the content
references the graphic names:

Caution
If you are using the S1000D administration data
provided in the Content Management installation,
select Public ID.

• Public ID
The public identifiers of the graphics are used in the
content to reference the graphics.

• Import Original Name

The original names of the graphics are used in the
content to reference the graphics. These are the file
names of the graphics before they are imported into
Content Management.

• XML Number
The XML numbers of the graphics are used in the content
to reference the graphics. When you choose this option,
graphics are included in the export.

• Graphic Name
The names of the graphics are used in the content to
reference the graphics. The graphic name is the name
of the imported file without the file suffix. This option can
be used when you want to import the publication or topic
including graphics into another Content Management
environment. When you choose this option, graphics are
included in the export.

PLM00014 12.2 Content Management 31-13

 Chapter
Chapter 31:31:Creating
Creating S1000D
S1000D content
content

For this option Do this

Graphic Priority (For graphic Select the graphic priority to determine in what order the
modes Public ID or Import topic's graphic options are selected for the output, based on
Original Name only) the graphic usages set on the graphic option.

Note
Graphic usages are set when a graphic is imported.

Transform Policy If you would like to apply an XML transformation policy to the
content you are exporting, select it from the list.
A transformation policy can be used to modify content when
it is published or exported. For example, it could convert
units of measure, such as US standard to metric. Your
administrator must create a transform policy before it is
available for you to use from this dialog box.
Content Select any of the following to choose the contents of the .zip
file:
• Include Supporting Data
Includes the schemas for the exported topics.

• Include Graphic Data

Includes the graphics embedded in the exported topics.
Delivery Select one of the following to choose the data modules to
include in the delivery:
• Full Official
Includes only the data modules that have been released.

• Full Unofficial
Includes all data modules.

• Incremental Official
Includes all released data modules not in the last full
official delivery.

• Incremental Unofficial
Includes any data modules that changed since the last
full official delivery.

3. Click Next.

4. In the Data Dispatch Note for Incremental Delivery dialog box, enter the data for the delivery
you are creating.

31-14 Content Management PLM00014 12.2

 Creating S1000D content

Tip
For the Document Title, enter a title that helps you identify the contents, for example,
include Full Official in the title if it is a full official delivery.

5. Click Next.

6. In the next Data Dispatch Note for Incremental Delivery dialog box, enter the contact
information for the delivery you are creating.

7. Click Finish.

8. In the Save As dialog box, select the folder in which to save the .zip file for the delivery.
The DDN is created and related to the DML.

Validate data modules against a BREX data module

When authoring using the S1000D standard, you validate data modules against a business rules
exchange (BREX) data module to verify that the data modules conform to a project's business
rules. Content Management provides a validation tool, with which you can validate a single data
module, a group of selected data modules, or all data modules in a data module list, data dispatch
note, or publication module.
Your administrator can integrate a third-party editing tool through the ContMgmtS1000D40Service
SOA service to validate a data module against a BREX data module from within the tool. Information
about SOA services is provided in the Services Reference.

Note
To access the Services Reference, install the Teamcenter developer references when you
install Teamcenter online help, or go to the Global Technical Access Center (GTAC):

https://support.industrysoftware.automation.siemens.com/docs/teamcenter/
1. Select one or more data modules, a data dispatch note, or a publication module, choose
Tools→BREX Validation, and then choose one of the following:
• Run In Background
Runs the validation while you perform other tasks in Teamcenter. When the validation is
completed, a log file is attached to each data module you selected.

• Wait for Results

Runs the validation while you wait for it to be completed. You cannot perform other tasks in
Teamcenter while it is running. When the validation is completed, a log file is created.

When the validation is completed, the BREX Validation dialog box appears, providing you with
the option to view the log file. The log file lists the number of data modules that passed and
failed the validation.

PLM00014 12.2 Content Management 31-15

 Chapter
Chapter 31:31:Creating
Creating S1000D
S1000D content
content

2. Click either Yes to show the log file, or No to close the dialog box without showing the log file.

S1000D workflow templates

Teamcenter provides workflow templates to automate processes for the S1000D 4.01,4.1, or 4.2
standard. You can modify the templates to meet your organization’s requirements. The workflows
can be used only for the Content Management objects specified below.

Content Management Comment Process

Use with: Commentary 4.0/4.1/4.2 objects
S1000D commentaries, or comments, are used to report issues for data modules, publication
modules, data module lists, and data dispatch notes. After a comment is created and related to the
object with the issue, this workflow is created with the comment as an attachment and is used to track
the review and acceptance or rejection of the comment.
In the provided workflow template, a task is assigned to the Engineering Designer resource pool.
Most likely, your application administrator will modify this to a resource pool created for your
organization. A resource pool is a group/role combination to which members can be subscribed.
When a task is sent to a resource pool, a notification is sent to its members. Notification is sent to all
members, subscribed members, or none based on the EPM_resource_pool_recipients preference.
Once a member of the resource pool claims the task, it is removed from all other resource pool
members’ tasks and appears in the assigned member’s task list.

Content Management Data Module Process

Use with: Data Module 4.0/4.1/4.2 objects
This workflow manages the data module development process, including assigning an author and
various reviewers, authoring the data module, and reviewing the data module.
Data module properties such as Issue Number, In Work, and Quality Assurance Status, are
updated during the workflow steps according to the S1000D specification. For example, the Quality
Assurance Status of the data module, stored in the <qa> element, is updated when the data module
completes first verification. The <firstVerification> element includes an attribute to indicate the type
of verification: table top (tabtop), on object (onobject), or both (ttandoo). The In Work attribute is
incremented each time the data module is sent back to the author to update.
This workflow requires these participants to be assigned: author, peer reviewer, engineering reviewer,
and editorial reviewer.

Content Management Exchange Export Process

Use with: Data Dispatch Note 4.0/4.1/4.2 objects
Data dispatch notes are created to exchange data modules with partners or OEMs. This workflow
manages the process of validating the S1000D objects in the data dispatch note and exporting
the S1000D objects.

Content Management ICN Process

Use with: Illustration Request topics

31-16 Content Management PLM00014 12.2

 Creating S1000D content

As you develop publications, you may include illustrations in the content. This workflow manages the
graphic creation process, including determining if an existing or new graphic is to be used, requesting
a graphic, assigning an illustrator, and approving the graphic.
This workflow requires participants to be assigned. The lead author must be assigned at the start of
the workflow. The illustrator is assigned during the workflow only if a new graphic is required. Since
this workflow uses the dynamic participants, illustrator and lead author, you must route a topic in the
workflow. This can be a topic type created by your organization or the provided illustration request
topic modified to meet your needs.
To enable the creation of illustration request topics, the administrator must import the illustration
request topic type, available in the TC_ROOT\contmgmts1000d40_data\data\admin folder.
To create an illustration request topic:
1. Choose File→New→New Author Item, and select Topic.

2. In the New Author Item dialog box, choose Illustration Request from the Select Topic Type list.

Content Management Publication Module Plan

Use with: Publication Module 4.0/4.1/4.2 objects

Publication modules define the content and structure of a publication. This workflow manages the
development, review, and approval of a publication module.

Content Management Publication Module Ready for Release

Use with: Publication Module 4.0/4.1/4.2 objects

This workflow manages the review and approval of a publication module as an entire document. The
publication module properties Issue Number, In Work, and Quality Assurance Status are updated
during the workflow steps according to the S1000D specification.

PLM00014 12.2 Content Management 31-17

Chapter 32: Create a topic or publication from a template

1. In the Publication Structure view, click Open Topic By ID .

2. In the ID box, type a string to find the template’s ID.

3. From the Is Template list box, select true.

4. Click Find .

5. Double-click the template in the result list to open it in the Publication Structure view.

6. Select the topic or publication, and choose File→Duplicate to create a new topic or publication.

PLM00014 12.2 Content Management 32-1

Chapter 33: Copying content

Copy a topic
You can copy a topic in several ways. Copying is a quick way to create new topics or reuse the same
topics in different locations.
You can copy a topic with or without its related topics in either the Home component view or the
Publication Structure view. You can also copy topics into content in an editing tool, by either
creating a new copy of a topic or by creating a reference to a source topic.
The location you are copying the topic to must be valid for the schema.
Do one of the following to copy a topic:

To copy this way Do this

Copy a topic or topic revision and its related 1. Right-click the topic, and choose Copy.
topics, and paste it either in a folder in the
Home component view or in a structure in 2. Right-click the location where you want to insert
the Publication Structure view, creating the topic and choose Paste.
another instance of the same topic and the
same related topics.
Note

Note If more than one reference type is defined

in your system for the object type, the
When you paste a topic item, not a Reference Topic Type Selection dialog
topic revision, in the Publication box appears. Select the reference type,
Structure view, the most current and click Finish.
revision of the topic is used.

Copy the content of a topic and any related 1. In the Publication Structure view,
topics from the Publication Structure view right-click the topic, and choose Copy For
into another topic in an editing tool, creating Editor→Composed Content as Clone.
new content without a reference(s) to the
source topic(s). 2. Click in a valid location in the content in the
editing tool, and choose Paste.

PLM00014 12.2 Content Management 33-1

 Chapter
Chapter 33:33:Copying
Copying content
content

To copy this way Do this

Copy a topic and any related topics from the 1. In the Publication Structure view,
Publication Structure view into another right-click the topic, and choose Copy For
topic in an editing tool, creating a reference(s) Editor→Composed Content as Reference.
to the source topic(s).
2. Click in a valid location in the content in the
editing tool, and choose Paste.

Note
You create the same result by dragging
the topic into the Publication Structure
view from another view.

Duplicate an existing publication or topic 1. In the Publication Structure view, right-click

structure to create a new structure. You the structure, and choose File→Duplicate.
can create the new structure with new
objects, references to existing objects, or a 2. Use the Duplicate dialog box to select the
combination of both. options for the new structure.

3. Click OK.

Duplicate a publication or topic structure

Duplicate an existing publication or topic structure to create a new structure based on all or portions
of the existing structure. You can create the new structure with new objects, references to existing
objects, or a combination of both. You can duplicate an entire publication structure or a structure of
topics and subtopics within a publication.

Note
This feature cannot be used for S1000D structures.

When you duplicate a structure that contains a topic with a reference to another topic, the reference is
preserved between the new topics when both target and source topics are duplicated.

33-2 Content Management PLM00014 12.2

 Copying content

Example
If you duplicate the 000132/B;1-headlamp_parts structure and its two topics, and the
000133/A;1-overview topic contains a link to the 000135/A;1-lightbulb topic, in the new
structure 000160/A;1-headlamp_parts, the 000161/A;1-overview topic will contain a link to
000162/A;1-lightbulb. However, if you choose to duplicate 000132 and 000135, but not
000133, the link in 000133 will continue to point to 000135 and not 000162, so the 000133
topic may need to be modified to work correctly where it exists.

1. Open the publication or topic structure in the Publication Structure view.

2. Select the top line of the structure, and choose File→Duplicate.

3. In the Duplicate dialog box, select or clear the check box for each line to select the contents
of the new structure:

• If an item is selected, the item is copied to create a new object in the new structure.

• If an item is not selected, a reference to the original object is created in the new structure.

Tip
To select all objects in the structure, select the Duplicate all items check box.

4. Choose one of the following methods to assign IDs to the duplicated items that are included
in the new structure:
• Automatically assign new IDs to all items.
Do nothing in the New Item ID by Selection and Default ID Mapping sections.

PLM00014 12.2 Content Management 33-3

 Chapter
Chapter 33:33:Copying
Copying content
content

• Assign new IDs by selecting the items you want to assign them to.

a. Use the Ctrl key and click to select the items in the structure to which you want to
assign IDs.

b. In the New Item ID by Selection section, either select Assign New IDs to automatically
assign IDs, or enter one or more of the following:

Prefix Adds a prefix to the original ID of each duplicated item, for example,
new_.
Suffix Adds a suffix after the original ID of each duplicated item, for
example _A1.
Replace Replaces a specified substring in the original ID with another defined
string in the duplicated ID. For example, you could replace template
With with new.

c. Click Apply.

• Assign new IDs by using the Default check boxes in the structure.

a. Select the Default check box for each item in the structure to which you want to assign
IDs.

b. In the Default ID Mapping section, either select Assign New IDs to automatically assign
IDs, or enter one or more of the following:

Prefix Adds a prefix to the original ID of each duplicated item, for example,
new_.
Suffix Adds a suffix after the original ID of each duplicated item, for
example _A1.
Replace Replaces a specified substring in the original ID with another defined
string in the duplicated ID. For example, you could replace template
With with new.

c. Click Apply.

33-4 Content Management PLM00014 12.2

 Copying content

5. Assign items to projects as desired.

6. Click OK.

PLM00014 12.2 Content Management 33-5

Chapter 34: Create a new revision of a topic

When you want to save a topic as it is and also work on a new version of the topic, you create
a new revision of the topic using the Revise menu command and dialog box. The new revision
has an incremented revision number.
• To create a revision for one topic:
1. Select the topic revision and choose File→Revise.

2. Use the Revise dialog box to further define the new topic revision.

• To create revisions for multiple topics:

1. Use the Ctrl key to select the topics and then choose File→Revise.

2. Use the Multiple Object Revise dialog box to edit the names of the new topic revisions.

Note
To enable the ability to edit names of new topic revisions using the Multiple
Object Revise dialog box, the Multiple_revise_dialog_visible preference must
be set to true. If this preference is set to false, you may still revise multiple topics,
but you cannot edit the names.

PLM00014 12.2 Content Management 34-1

Chapter 35: Working with a publication structure

Working in the Publication Structure view

Use the Publication Structure view to create and maintain the contents of publications.
From the Publication Structure view, you can:
• Add and move topics to build the structures of publications

• Remove topics from publications

• Open publications and topics for editing

• Publish publications and topics

Add publications to the Publication Structure view

• Add topics, topic structures, and publications to the Publication Structure view using one
of the following methods:

Note
If you select a topic or publication item, not a topic or publication revision, the most
current revision is selected.

o In the Home component view, double-click the publication or topic.

o Use the Show In Publication Structure command.

■ Right-click the publication or topic in the Home component view, Impact Analysis view,
or Search Results view, and choose Show In Publication Structure.

o Click the Open Topic by ID button.

1. In the Publication Structure view, click Open Topic By ID .

2. In the ID box, type a string to find the ID of the publication or topic in the structure.

3. Click Find .

4. Double-click the topic or publication in the result list.

o Click the Most Recently Used (MRU) button.

This button opens any of the last four publication structures you opened. This list is saved
across sessions.

PLM00014 12.2 Content Management 35-1

 Chapter
Chapter 35:35:Working
Working with
with a a publication
publication structure
structure

1. In the Publication Structure view, click Most Recently Used (MRU) .

2. Click the topic or publication you want to open.

o Click a link.
■ Click a link in the Open Items, History, or Favorites sections of the navigation pane.

Add and move topics to build publications

Caution
Do not attempt to modify the Occurrence Type assigned to topics. This may cause
content processing functions to fail.

Note
When you add and move some DITA topics to another topic or map, you must select
the reference topic type.

• Add and move topics in the following ways:

o In the Publication Structure view, drag topics within publications.

Note
When you move a topic to a new location in a publication, the location must be
valid for the type of topic you are moving and the defined schema. If a location you
point to is not valid, a message appears.

o In the Publication Structure view, drag topics and create specific relationship types:

Note
Depending on the topic types you are working with and how they are configured in
your system, this method may not be available.

1. Select the topic you want to relate to another topic, and begin dragging it.

2. Press and hold Ctrl+Shift.

3. When the topic is over the topic you want to relate it to, release the mouse button, and
then release Ctrl+Shift.

4. In the Relation Selection dialog box, from the Relation Selection list box, select the
relation type.

35-2 Content Management PLM00014 12.2

 Working with a publication structure

5. If you want the selected relation type to be the default in this dialog box for future relation
selections, select Save selection to preferences.

6. Click Finish.

o Drag topics from the Home component view to publications in the Publication Structure
view.

Note
If you select a topic item, not a topic revision, the most current revision is moved.

o Cut and paste objects using Teamcenter functionality.

o Add or edit the XML elements in the publication when it is open in an editing tool.

Remove a topic from a publication in the Publication Structure view

When you remove a topic from a publication, its child topics are also removed.
1. In the Publication Structure view, right-click the topic you want to remove, and choose Remove.

2. In the Remove dialog box, click Yes.

PLM00014 12.2 Content Management 35-3

Chapter 36: Working with topic relationships

Types of topic relationships

When you create the structure of a publication and place topics within other topics, parent and
child topics are related. You can relate a topic to many parent topics, creating multiple instances
of the same topic. Whenever the topic is modified at one location, the modifications are reflected
in all locations where the topic is referenced.
Relationships between topics are created when topics are created or moved in the Publication
Structure view. The following two types of relationships exist between topics in Content Management.
However, depending on the reference types created by your administrator and the topic types you are
working with, you may have only one of these types in your system.
• Topic-to-topic relation
When a topic-to-topic relation appears in the editing tool, you see all the content of the related
topic. Also, when a topic is published with a topic-to-topic relation to another topic, the published
topic includes all the content of the related topic. The Occurrence Type in the Publication
Structure view appears as DC_TopicTopicR for this relation type.

Note
This relationship type is also created when topics are copied using the Copy For
Editor→Composed Content as Reference function in the Teamcenter client and
then pasted in the editing tool.

• Composable reference
When a composable reference appears in the editing tool, you see only a reference to the topic.
However, when a topic is published with a composable reference to another topic, the published
topic includes all the content of the referenced topic. The Occurrence Type in the Publication
Structure view appears as DC_ComposableReferenceR for this relation type.

Viewing related objects

Ways to view related Content Management objects

Objects are related to other objects for different purposes. For example, parent and child topics
are related, and topics have related graphics, documents, and translations. You can view related
objects in these ways:
• View related topics in the Publication Structure view. This is a specialized view of Content
Management objects and their relationships to other Content Management objects.

PLM00014 12.2 Content Management 36-1

 Chapter
Chapter 36:36:Working
Working with topic
with topic relationships
relationships

• View all related objects in the Relation Browser view. This view graphically displays objects and
their related items. It is available for multiple Teamcenter applications.

• View all related objects in the Impact Analysis view. This view graphically displays objects and
their related items and can be used to perform where-referenced analyses. For example, it can
be used to understand the impact of change. It is available for multiple Teamcenter applications.

View related topics in the Publication Structure view

1. In the Home component view, right-click the topic or publication, or the specific revision, and
choose Show In Publication Structure.

Note
If you select a topic or publication item, not a topic or publication revision, the most
current revision is selected.

2. In the Publication Structure view, right-click a topic and choose one of the following expand
options:
• Expand
Displays one level below the topic you selected.

• Expand Below
Displays all levels below the topic you selected.

• Expand Below...
Displays a dialog box for you to select the number of levels you want to display.

• Collapse Below
Hides all the levels below the topic you selected.

View related objects in the Relation Browser

• Right-click the object you want to view in the Relation Browser and choose Send To→Relation
Browser.

View related objects in the Impact Analysis view

• Select the object you want to view, and click the Impact Analysis tab.

Validate content references

When you import content that references another object, such as a topic that references another
topic, and the referenced object does not exist in Content Management, then the reference is
unresolved. If you later import the referenced content, you can resolve the broken reference between
the two objects.

36-2 Content Management PLM00014 12.2

 Working with topic relationships

The reference validation tool checks content for any broken references in Base, DITA, and S1000D
content and creates references between topics that are imported or created at different times. You
can validate references on a selected object or on a selected structure for all topics in the structure.
• Select the object revision and choose Tools→Reference Validation.

State of the content references Result

No unresolved references are found or The Reference Validation Successful
resolved. message box appears.
Unresolved references are found, and Content The references are created and you can see
Management resolves all the references the objects related to one another in Content
between all objects. Management.
Unresolved references are found, and Content The Reference Validation message box
Management cannot resolve one or more of appears listing the content references that
the references. cannot be resolved.

PLM00014 12.2 Content Management 36-3

Chapter 37: Editing content

Using an editing tool to edit content

The XML or SGML content of topics, including S1000D and DITA objects, is created and edited
in an editing tool. You can also create a new topic within an existing topic by using an editing
tool. Examples of editing tools compatible with Content Management include: XMetaL Author,
FrameMaker, and XMLSpy. The editing tool that is launched when you open a topic, structure of
topics, or publication depends on the tool selected in the Edit preferences.
When the content opens with the editing tool, it is saved in a local folder. Your editing tool can be
disconnected from Teamcenter and your work with the content performed offline. While the editing
tool is disconnected from Teamcenter, functions such as Teamcenter CMS→Save and Close are
not available. To save edited and newly created topics to the database, the editing tool must be
connected to Teamcenter. Editing tools are connected to Teamcenter when they are launched from
the Teamcenter rich client. The local folder is typically:
C:\Documents and Settings\user name\Teamcenter\contmgmt\version number\edit\editing
tool

Note
Editing tools are supported only on Windows clients.

Create and edit content in an editing tool

You edit the content of topics in an editing tool. You can also create new topics by adding the valid
XML elements to topics that are open in an editing tool. When you save and check in edited content,
new topics are created in Content Management with the appropriate relationships to the publication
structure you are working in.

Note
If you save a topic with a graphic that does not exist in Teamcenter, a warning message
appears indicating the graphic cannot be found. The next time you edit the topic the
graphic name in the XML is appended with .error.
The Teamcenter CMS menu is not available in all editing tools.

1. In the Publication Structure view, do one of the following:

• Edit a topic:
a. Right-click the topic, and choose Edit→Edit Topic.

PLM00014 12.2 Content Management 37-1

 Chapter
Chapter 37:37:Editing
Editing content
content

b. In the Check-Out dialog box, click Yes.

• Edit a topic without downloading referenced topics:

Tip
For topics with many references, this saves time.

a. Right-click the topic, and choose Edit→Edit Topic Without Referenced Topics.

b. In the Check-Out dialog box, click Yes.

• Edit a structure of topics:

a. Right-click the parent topic, and choose Check-out Structure.

b. In the Check-Out dialog box, click Yes.

c. Right-click the main topic you are working with, and choose Edit→Edit Topic.

The content opens with the editing tool and is saved in a local folder. In the Publication
Structure view, the topics you check out appear as checked out , and the topic you choose to
edit appears in edit mode . The Teamcenter CMS menu appears in the editing tool's menu bar.

2. In the editing tool, edit the content and create new topics as necessary, as the schema structure
allows.

3. When you are done editing the content and creating new topics within the topic, do one of the
following:

Note
If you try to save and close a topic that references another topic that was removed,
Teamcenter displays a message warning you that you cannot save the topic.

To do this Do the following For this result

Save your Use the editing tool's options The file you are editing is updated on your
changes without for saving files. local drive, the file remains unchanged in the
closing the file. database, and the content version of edited
topics is not changed.

37-2 Content Management PLM00014 12.2

 Editing content

To do this Do the following For this result

Save your Do one of the following: The editing tool closes the file, the edited file
changes and is updated in the database, and its content
close the file. • In the editing tool, version increases. Any new topics are
choose Teamcenter created, the relationships between topics are
CMS→Save and created, and the new topics appear in the
Close. Publication Structure view.
• Use the editing tool's
options for saving
files, and then in the
Publication Structure
view, right-click the
topic, and choose
Edit→Save And Close
Edit.
Save your Do one of the following: The editing tool closes the file and the edited
changes, close file is updated in the database, but the content
the file, and • In the editing tool, version of edited topics does not increase.
maintain the choose Teamcenter This is useful when a topic has a related
translations. CMS→Save with same translated topic and you want the versions
Translation and Close. of the two to remain synchronized. Any new
topics are created, the relationships between
• Use the editing tool's topics are created, and the new topics appear
options for saving in the Publication Structure view.
files, and then in the
Publication Structure
view, right-click the
topic, and choose
Edit→Save With Same
Translation and Close
Edit.
Close the file Do one of the following: The editing tool closes the file, the file remains
without saving unchanged in the database, and the content
your changes. • Choose Teamcenter version of edited topics is not changed.
CMS→Close.

• In the Publication
Structure view, choose
Edit→Cancel Edit.

4. In the Publication Structure view, right-click the topmost topic, and choose Edit→Check-in
Structure.

PLM00014 12.2 Content Management 37-3

 Chapter
Chapter 37:37:Editing
Editing content
content

Set editing tool preferences

Use the Edit preferences to select the editing tool you use to edit content. Before you can set these
preferences, your editing tool must be installed, and your application administrator must set up
the tools for editing content.
These preferences apply to only your user account on your client computer. They do not affect
other users' client computers or your user account on other computers. These preferences do not
affect other Teamcenter applications.

Note
• Editing tools are supported only on Windows clients.

• If the editing tool is not starting after you set these preferences, click Restart Tool
Message Server in the Preferences dialog box to assign a new port for the editing tool.

1. Choose Window→Preferences.

2. In the Preferences dialog box, expand Teamcenter, expand Content Management, and expand
and select Edit.

Tip
Use the type filter text box to list preferences you are looking for by typing the name
or part of the name of the preference. Click to clear the box.

3. From the Editor list, select the editing tool to start when you choose to edit a topic.

Note
If the editing tool has been installed and set up by your application administrator but
it does not appear in the list, click Reload Tools, click OK to close the Preferences
dialog box, and then re-open the dialog box and begin again.

4. Select one of the following editing tools, which you are setting the preferences for:
• Other Editors

• Framemaker

• XMLSpy

• XMetal

5. In the Path box, if the path to the tool's start file is different on this client than the one defined for
the tool path in the editing tool object, type or browse to and select the path to the location of the
start file on this client. For example: C:\Program Files\XMetaL 9.0\Author.

37-4 Content Management PLM00014 12.2

 Editing content

6. Click Install to install on the client any required plug-in for the tool. Typically, this installation is
required only once per client.

Note
This applies only to FrameMaker, XMLSpy, and XMetaL.

7. Click Apply.

8. Click OK to close the Preferences dialog box.

Teamcenter CMS menu options

When you work with content in one of the following editing tools, the Teamcenter CMS menu
appears on the toolbar.
• Altova XMLSpy

• Adobe Structured FrameMaker

• JustSystems XMetaL Author

The following describes the actions that can be performed from the Teamcenter CMS menu:

Tip
If you are using XML Spy and the Teamcenter CMS menu does not appear on the toolbar,
in Edit preferences, for the XML Spy tool, click Uninstall and then click Install to reinstall
the required plug-in. Then in XML Spy, choose Tools→Customize→Toolbars, and then
select Reset All.

Menu option Function

Close Closes the editing tool without saving changes. The topic is
no longer in edit mode in Content Management. The edit
icon no longer appears in front of the topic in the Publication
Structure view.
Save and Close Saves all changes and closes the editing tool. The content
version of edited topics is increased. The saved file is stored
in the database. The topic is no longer in edit mode in
Content Management. The edit icon no longer appears in
front of the topic in the Publication Structure view.
Save with same Translation and Functions like Save and Close, except that the content
Close version of edited topics is not increased, so its version
remains the same as the version of any related translated
topics.
Publish Saves all changes and displays the Publish dialog box for
the object.

PLM00014 12.2 Content Management 37-5

Chapter 38: Working with links between topics

Types of topic links

A navigation link is text within a published topic, which when clicked, accesses another topic or
another location within the same topic. You can insert two types of navigation links into a topic:
• Floating navigation link
A floating navigation link enables you to create a link to the most current version of a topic.

• Fixed navigation link

A fixed navigation link enables you to create a link to a specific version of a topic.

For both types of links, you can create a link to content below the topic level, for example, to a
table or figure within a topic. When you do this, you can create a link to another topic or to another
location within in the same topic.
Before you can use navigation links, your application administrator must enable this functionality.

Add a navigation link to a topic

1. In the Publication Structure view, right-click the topic you want to link to, choose Copy For
Editor, and then choose one of the following:
• Floating Navigation Link, to create link that always links to the most current version of
the selected topic.

Example
At the time you create a link to a topic, the topic's version is A.1, and the link
accesses version A.1 of the topic. Later, when the topic's version increases to B.1,
the link then accesses version B.1 of the topic.

• Fixed Navigation Link, to create a link to the version of the topic it exists at now.

Example
At the time you create a link to a topic, the topic's version is A.1, and the link
accesses version A.1 of the topic. Later, when the topic's version increases to B.1,
the link still accesses version A.1 of the topic.

2. Open the topic in which you want to insert the link, if it is not already open.

3. In the editing tool, click in a valid location in the content, and choose Paste.

PLM00014 12.2 Content Management 38-1

 Chapter
Chapter 38:38:Working
Working with links
with links between
between topics
topics

In Content Management, the link is related to the topic as a content reference, and the link
appears in the content. For example:
Floating navigation link:
<xref href="X000151.xml" linktyp="floating" version=
"CURRENT">Creating a topic</xref>

Fixed navigation link:

<xref href="X000151.xml" linktyp="fixed" version="B">Creating a topic</xref>

In the Publication Structure view, links appear in the structure with an Occurrence Type of
Topic Content Reference or Topic Cross Reference, depending on how your application
administrator set up navigation links.

Add a link to content within a topic

1. Open the topic that you want to create a link to, if it is not already open.

2. Go to the location in the topic that you want to create a link to, for example a title, table, or
paragraph tag, and add an ID value to the tag. The value must begin with a letter.

Example
<title id="addrecord">Adding a record</title>

In this example, you use the ID that you are attaching to the title to create a link to
this topic that goes directly to this title.

3. In the Publication Structure view, right-click the topic you want to link to (the one you just added
the ID to), choose Copy For Editor, and then choose one of the following:
• Floating Navigation Link, to create link that always links to the most current version of
the selected topic.

Example
At the time you create a link to a topic, the topic's version is A.1, and the link
accesses version A.1 of the topic. Later, when the topic's version increases to B.1,
the link then accesses version B.1 of the topic.

• Fixed Navigation Link, to create a link to the version of the topic it exists at now.

Example
At the time you create a link to a topic, the topic's version is A.1, and the link
accesses version A.1 of the topic. Later, when the topic's version increases to B.1,
the link still accesses version A.1 of the topic.

4. Open the topic in which you want to insert the link, if it is not already open.

38-2 Content Management PLM00014 12.2

 Working with links between topics

5. In the editing tool, click in a valid location in the content, and choose Paste.

6. In the href value of the link, at the end of the XML number, add a forward slash and the ID you
created in step 2, which you are creating the link to.

Example
<xref href="X000152.xml/addrecord" linktyp="floating" version=
"CURRENT">Adding a record</xref>

In Content Management, the link is related to the topic as a content reference.

In the Publication Structure view, links appear in the structure with an Occurrence Type of
Topic Content Reference or Topic Cross Reference, depending on how your application
administrator set up navigation links.

PLM00014 12.2 Content Management 38-3

Chapter 39: Importing and exporting documents

Prerequisites for importing documents

If you have existing XML or SGML content outside of the Content Management application, you can
import it to Content Management from a local or network drive.
Prerequisites for importing documents are as follows:
• All graphics referenced in the document must be imported to the database.

• The structure of the document must match the topic type structure (and its schemas) defined in
the application.

• The document must have the language attribute defined in order to relate it to other documents
and graphics. If the language attribute is not defined before you import a document, you can
define the language attribute after the import by modifying the document’s properties.

• (Optional) When the structure of the document is different from the topic type structure (and its
schemas) defined in Content Management, an XSLT stylesheet that converts the document(s)
being imported into a valid structure can be used. To use this stylesheet on import, it must
exist in Content Management.

• When you import a document with a DITA conref, the filename in the conref must be in the format
item_id.dita for topics and item_id.ditamap for maps.

Example
conref="X000001.dita#X000001"
conref="X000001.dita#X000001/para1"
conref="X000124.ditamap"
conref="X000124.ditamap#topic1"

• To import SGML data for authoring in the S1000D solution, the Content Management S1000D
SGML Parser feature must be selected in Teamcenter Environment Manager (TEM) when
you install Teamcenter.

Import a document
Import existing XML or SGML content to work with it in the Content Management application.
Imported documents are placed in a folder according to how your user interface (UI) options are set.
1. Complete the prerequisites for importing documents.

PLM00014 12.2 Content Management 39-1

 Chapter
Chapter 39:39:Importing
Importing and exporting
and exporting documents
documents

2. Choose Tools→Import→Document.

3. In the Import Documents from File dialog box, do the following:

For this option Do this

From Directory Browse to and select the folder containing the document you
want to import.
File names a. (Optional) Select the Show all Files check box to show
the hidden files in the folder.

b. Select the check box for each document that you want
to import.

Tip
Click Select All or Deselect All to select or
deselect all files listed.

Stylesheet If the content being imported must be transformed, either

because it is not valid for any existing topic type or because
data in the content must be changed, select a stylesheet to
use for the import. If this option is not available, then no
stylesheet of this type exists.
When the XML document being imported matches the
structure of a topic type and its related schema defined in
the system, select (No StyleSheet) because no part of the
document is to be transformed before import.
Graphic Attribute Mapping Select the appropriate graphic attribute mapping defined by
your application administrator.
Graphic Mode If the XML document contains references to graphics, select
one of the following options to indicate how the document
references the graphic names:

Note
You must import the graphics to be referenced
before importing the document that refers to the
graphics. How these graphics are imported and
named determines which option you choose.

• Public ID
The public identifiers of the graphics are used in the XML
document to reference graphics.

• Import Original Name

39-2 Content Management PLM00014 12.2

 Importing and exporting documents

For this option Do this

The names of the graphics when imported are used in

the XML document to reference graphics.

• XML Number
The XML numbers of the graphics are used in the XML
document to reference graphics.

• Graphic Name
The names of the graphics with or without the file
extensions are used in the XML document to reference
graphics.
Reuse Existing Topic Select the following options to indicate how the import
searches for and handles topics already existing in the
database or if you want to use the ID or XML number of the
imported topic as its item ID in Teamcenter.

Note
If none of these options are selected, all topics
are imported as new objects with new item IDs,
regardless of whether topics with identical item IDs
or content already exist in the database.

• Find by XML Number

Select this option to search the database for a topic with
the same item ID as the ID or XML number of topics in the
document you are importing. If a topic is not found with
the same item ID, then the ID or XML number of the topic
is used as the item ID instead of being auto-generated.
Also, the imported file name is stored in the topic’s
Original Imported Name property.
If your documents use content references, you must
select this option to ensure content references are
preserved for Base Content Management and DITA
documents, since content references use item ID/XML
numbers.

• Overwrite existing
If a topic exists in the database with the same item ID
as the ID or XML number of the topic being imported,
selecting this option causes the topic in the database to
be replaced with the one that is being imported.

PLM00014 12.2 Content Management 39-3

 Chapter
Chapter 39:39:Importing
Importing and exporting
and exporting documents
documents

For this option Do this

If this option is not selected, a message appears

indicating that a topic with the same ID already exists
in the database.
Use this option to preserve content references, since
references use the item ID.

Note
This option can be selected only when the
Find by XML Number option is selected.

• Find by Content
Select this option to search the database for topics with
the same content as any of the topics you are importing.
When a topic is found with the exact content (including
tags, attribute values, etc.) as one being imported, the
topic is not imported.

4. Click Finish.

Import a DITA map

Import a DITA map to bring the map into the Content Management application. When you import a
DITA map, the DITA topics it references are also imported. Imported objects are placed in a folder
according to how your user interface (UI) options are set in the rich client.
When you import a document with a DITA conref, the filename in the conref must be in the format
item_id.dita for topics and item_id.ditamap for maps.

Example
conref="X000001.dita#X000001"
conref="X000001.dita#X000001/para1"
conref="X000124.ditamap"
conref="X000124.ditamap#topic1"

1. Choose Tools→Import→DITA Map.

2. In the Import DITA Map from File dialog box, do the following:

For this option Do this

From Directory Browse to and select the folder containing the maps you want
to import.

39-4 Content Management PLM00014 12.2

 Importing and exporting documents

For this option Do this

File names a. (Optional) Select the Show all Files check box to show
the hidden files in the folder.

b. Select the check box for each document that you want
to import.

Tip
Click Select All or Deselect All to select or
deselect all files listed.

Stylesheet If the map being imported must be transformed, either

because it is not valid for any existing topic type or because
data in the content must be changed, select a stylesheet to
use for the import. If this option is not available, it indicates
that stylesheet of this type does not exist.
When the XML document being imported matches the
structure of a topic type and its related schema defined in
the system, select (No StyleSheet) because no part of the
document must be transformed before import.
Graphic Attribute Mapping Select the appropriate graphic attribute mapping defined by
your application administrator.
Graphic Mode If the content being imported contains references to graphics,
select one of the following options to indicate how the content
references the graphic names:

Note
You must import the graphics to be referenced
before importing the document that refers to the
graphics.

• Public ID
The public identifiers of the graphics are used in the
content to reference graphics.

• Import Original Name

The names of the graphics when imported are used in
the content to reference graphics.

• XML Number
The XML numbers of the graphics are used in the content
reference graphics.

PLM00014 12.2 Content Management 39-5

 Chapter
Chapter 39:39:Importing
Importing and exporting
and exporting documents
documents

For this option Do this

• Graphic Name
The names of the graphics with or without the file
extensions are used in the content to reference graphics.
Reuse Existing Topic Select the following options to indicate how the import
searches for and handles topics already existing in the
database, or if you want to use the ID or XML number of the
imported topic as its item ID in Teamcenter.

Note
If none of these options are selected, all topics
are imported as new objects with new item IDs,
regardless of whether topics with identical item IDs
or content already exists in the database.

• Find by XML Number

Select this option to search the database for a topic with
the same item ID as the ID or XML number of topics in the
document you are importing. If a topic is not found with
the same item ID, then the ID or XML number of the topic
is used as the item ID instead of being autogenerated.

• Overwrite existing
If a topic exists in the database with the same item ID
as the ID or XML number of the topic being imported,
selecting this option causes the topic in the database to
be replaced with the one that is being imported.
If this option is not selected, a message appears
indicating that a topic with the same ID already exists
in the database.
Use this option to preserve content references as
references use the item ID.

Note
This option can be selected only when the
Find by XML Number option is selected.

• Find by Content
Select this option to search the database for topics with
the same content as any of the topics you are importing.
When a topic is found with the exact content (including

39-6 Content Management PLM00014 12.2

 Importing and exporting documents

For this option Do this

tags and attribute values) as the one being imported, the
topic is not imported.

3. Click Finish.

Export a topic or publication

Export an XML or SGML document to transfer it from one Content Management system to another or
to work with it in another application. When you export a document, it is saved in a .zip file.

1. Select the topic or publication you want to export, and choose Tools→Export→Document.

2. In the Export Composition dialog box, do the following:

For this option Do this

Language Select the language you want to use for the exported content.
Graphic Mode Select one of the following to indicate how the content
references the graphic names:

Note
• The way you export graphics impacts whether
the references to graphics can be resolved
when the exported content is imported into
another system.

• To include graphics in the export, select

either Public ID or Import Original Name. If
you select XML Number or Graphic Name,
graphics are not exported.

• These characters are invalid in the public

ID or original import name of graphics:
/|~`’,;:\"*?<>. When you export a topic
containing graphics with these characters, they
are converted to an underscore ( _ ).

• Public ID
The public identifiers of the graphics are used in the
content to reference the graphics.

• Import Original Name

The original names of the graphics are used in the
content to reference the graphics. These are the file

PLM00014 12.2 Content Management 39-7

 Chapter
Chapter 39:39:Importing
Importing and exporting
and exporting documents
documents

For this option Do this

names of the graphics before they are imported into
Content Management.

• XML Number
The XML numbers of the graphics are used in the content
to reference the graphics.

• Graphic Name
The names of the graphics are used in the content to
reference the graphics. The graphic name is the name
of the imported file without the file suffix. This option can
be used when you want to import the publication or topic
including graphics into another Content Management
environment.
Graphic Priority (For graphic Select the graphic priority to determine in what order the
modes Public ID or Import topic's graphic options are selected for the output, based on
Original Name only) the graphic usages set on the graphic option.

Note
Graphic usages are set when a graphic is imported.

Transform Policy If you would like to apply an XML transformation policy to the
content you are exporting, select it from the list.
A transformation policy can be used to modify content when
it is published or exported. For example, it could convert
units of measure, such as US standard to metric. Your
administrator must create a transform policy before it is
available for you to use from this dialog box.
Content Select any of the following to choose the contents of the .zip
file:
• Include Main Content
Includes the XML files for the topic content.

• Include Supporting Data

Includes the schemas for the exported topics.

• Include Graphics Data

Includes the graphics embedded in the exported topics.

39-8 Content Management PLM00014 12.2

 Importing and exporting documents

For this option Do this

References Select any of the following to choose the content to include
in the export:
• Include Content References
Includes topics that are referenced by the topic or
publication you are exporting.

• Include Compose References

Includes topics that are referenced by composable
reference relations. Composable topic references are
created by relating topics in the Teamcenter client. This
reference type is typically used to enable the creation of
DITA dynamic maps and S1000D data dispatch notes,
data module lists, and publication modules.

3. Click Finish.

4. In the Save As dialog box, select the folder in which to save the exported content.

PLM00014 12.2 Content Management 39-9

Chapter 40: Publishing and previewing content

Overview of publishing and previewing content

When you publish a topic or publication, Content Management renders it to the selected output
format, based on the stylesheets and applications you have available. This may be HTML, XHTML,
PDF, or a proprietary format.
To view content in the Preview view, you publish it using the InternalViewer tool. You may also view
topics with viewing tools installed on the client and set up in Content Management by the application
administrator. These are useful when a quick or remote preview session is needed, without the
processing time required to generate a PDF document.
You can set Publish Content preferences to specify the default publishing tool, style type, and
language displayed in the Publish dialog box when you select a topic to be published.
When you publish content through a publishing server, you can use the Dispatcher request
administration console to monitor the publishing progress.
Before you publish a topic or publication, you can view the estimated file size.

Set publishing preferences

Use the Publish Content preferences to set window preferences for how items are published.
These preferences apply to only your user account on your client computer. They do not affect
other users' client computers or your user account on other computers. These preferences do not
affect other Teamcenter applications.
1. Choose Window→Preferences.

2. In the Preferences dialog box, expand Teamcenter, and then expand Content Management.

3. Click Publish Content.

4. From the Default Publish Tool list, select the default publishing tool displayed in the Publish
dialog box when you select a topic to be published.

5. From the Default Style Type list, select the default style type displayed in the Publish dialog
box when you select a topic to be published.

6. From the Default Language list, select the default language displayed in the Publish dialog
box when you select a topic to be published.

7. Click Apply.

8. Click OK to close the Preferences dialog box.

PLM00014 12.2 Content Management 40-1

 Chapter
Chapter 40:40:Publishing
Publishing and previewing
and previewing content
content

Publish and preview output

1. Do one of the following:
• In Teamcenter right-click the topic, publication, or map revision, and choose either Publish
Content or Tools→Publish Content.

• With the topic, publication, or map revision open in an editing tool, choose Teamcenter
CMS→Publish.

2. In the Publish dialog box, do the following:

For this option Do this

Tool Select the publishing tool for the type of
output you are generating. The available tools
depend on the tools that have been installed
on your computer and set up in the system by
your application administrator.
StyleType Select the style type (collection of stylesheets)
to be used to publish the content. The
style types are set up by your application
administrator.
Language Select the language in which to publish the
resulting output.

Note
If the translation of the selected
language does not exist, Content
Management publishes the content
in the master language. Or, if a
Fallback Language is defined and
a translation is available, the content
is published in that language.

Compose Version Selection Select the version of the content to be

published.

Note
This option is not available when
you publish from the Publication
Structure view, as the content is
published with the revision rule in
effect for the view. However, you
can apply a different revision rule in
the view.

40-2 Content Management PLM00014 12.2

 Publishing and previewing content

For this option Do this

Translation Version Selection Select the translated version of the content to
be published when a language other than the
master language is selected:
• Match Topic
If the latest content version in the master
language is the same as the latest content
version of the translation, the translation
is selected for publishing. Otherwise the
master language is used.

• Latest Received
The latest received translation in the
selected language is selected for
publishing regardless of the content
version in the master language. However,
if no translation exists for the selected
language, the master language is used.

• Received
The latest received translation in the
selected language with a content version
older than or equal to the master language
version is selected for publishing. If all
translation content versions are newer,
or if no translation exists for the selected
language, the master language is used.
This option is typically used when you
publish an older version of the content and
you do not want to include translations that
have newer content.
Resulting File Folder Browse to and select the folder in which the
published document will be stored. This path
is saved and is displayed the next time the
Publish dialog box appears.
This option is available only for client-side
publishing tools other than InternalViewer.
Resulting File Name Type the name of the file (without a suffix).
By default, the XML number of the topic,
document, or map is used.
This option is available only for client-side
publishing tools other than InternalViewer.

PLM00014 12.2 Content Management 40-3

 Chapter
Chapter 40:40:Publishing
Publishing and previewing
and previewing content
content

For this option Do this

Register Result (Not available with all tools) If you want to create a composed or reviewer
document, select the type:
• Composed Document
A composed document that has completed
the review process.

• Reviewer Document
A composed document that must be
submitted to a workflow for review.
Transform Policy If you would like to apply an XML transformation
policy to the content you are publishing, select
it from the list.
A transformation policy can be used to modify
content when it is published or exported. For
example, it could convert units of measure,
such as US standard to metric.
DITA Value Filter Topics in the Map To use author-defined DITA value filters:
a. Click Find DITAVALs.

b. Select the filters to apply to the map.

DITA Value Filters To use DITA value filters defined by your
administrator, select the filters to apply to the
map.
Publish to File System
Note
This option appears only if your
application administer has enabled
publishing to a file system.

Select the check box to publish the output to

a folder on your network. If you do not know
the location of the publish folder, contact your
application administrator.

Note
If you select this option, you must
also select Register Result.

40-4 Content Management PLM00014 12.2

 Publishing and previewing content

For this option Do this

View Select the check box to display the output in
the Preview view.
This option is not available for all tools and
output types. The check box is selected
automatically when you use a tool that displays
output in the Preview view.

3. To display the estimated size of the published file before you publish it, click Estimate Size.
The size is estimated from the XML and any included graphics file sizes. This can be different
from the final output size since different file formats have different compression schemes.

4. Click Finish.

Preview content in XML or SGML

You can view the XML or SGML markup of a topic or publication without opening it in an editing tool.
• In the Home component view, right-click the topic or publication and choose Show Content.
The content’s XML or SGML appears in the Preview view.

PLM00014 12.2 Content Management 40-5

 Chapter
Chapter 40:40:Publishing
Publishing and previewing
and previewing content
content

Understanding publishing results

Note
When you publish content through a publishing server, you can use the Dispatcher request
administration console to monitor the publishing progress.

Content published to the Preview view

When you publish content using the InternalViewer tool, it appears in the Preview view.

Content in composed and reviewer documents

You can create a composed or reviewer document when you publish content. The composed
document revision or reviewer document revision is related to the topic you selected for publishing,
and the dataset (.zip file) created by the process is related to the composed or reviewer document
revision. For certain types of output, such as PDF, the output file is also related to the composed or
reviewer document revision as a dataset. The owner of the output file is the same as the owner
of the document revision. You may need to refresh the file structure after publishing to see the
composed or reviewer document related to the publication or topic.

When you publish the same content multiple times, newer composed or reviewer documents
overwrite existing ones if you select the same options when you publish. However, if you publish
content with a different tool or with one or more different options selected in the Publish dialog
box, an additional composed or reviewer document revision is created and related to the topic or
publication you selected for publishing. These options include: Language, Compose Version
Selection, Style Type, DITA Filter Value, and Transform Policy.

Additional composed or reviewer documents are also created each time you publish content with
different variants.

Content published to a file system

You can publish output to a file system if your application administrator has configured your system
to support that. Each time you publish the same revision of a topic or publication, the output file
replaces the one stored in the system folder. However, if you revise content that you published to the
file system, and then publish it again, the system creates a folder for the newly revised files. The
folder structure contains folders for: the content type of the renditions (such as HTML or PDF), the
item ID of the topic or publication, the language, and a subfolder for each revision published. The
first time you publish the topic or publication it is saved in folder A. After you revise and publish it
again, it is saved in folder B, and so on. The most recent revision of the published content is also
saved in a folder named CURRENT. The folder names do not necessarily correspond to revision
levels of the content they contain.

Note
To publish output to a file system, your application administer must configure your system
to enable publishing to a file system.

40-6 Content Management PLM00014 12.2

 Publishing and previewing content

Example

PLM00014 12.2 Content Management 40-7

Chapter 41: Using variants for publications

The process for using variants in Content Management

Variants allow you to create publications that include topics based on the variant configuration you set
on the publication and the variant conditions you set on the items in the publication. For example,
you can create a car owner manual for various trim levels, S (standard), LX (luxury sedan), and LE
(limited edition), and include topics for the features included with the trim levels, such as power seats,
navigation system, and sunroof. When you publish the publication, the resulting composed document
in the Home component view indicates the variants that were selected when it was published.
Variants in Content Management work for publications in a similar way as they do for product
structures in Structure Manager. In fact, in Content Management you can use options that are
defined in Structure Manager.
Although Teamcenter provides you with two methods to create variants, modular or classic, only
classic variants are supported in Content Management. To ensure that the variant mode always
opens in the classic mode, set the PSEVariantsMode preference to legacy.
To configure variants for publications, you follow this process:
1. Create or find options to use for the configuration of the publication.

2. Add variant conditions to topics in the publication.

3. Set variant rules for the different variations of the publication structure.

Create variant options for publications

The first step in configuring variants for a publication is creating the options for the publication
structure.

Example
You are creating a publication for a car owner manual. The car is manufactured with
the following trim levels:
• S (standard), which includes a 2.0 L engine, manual transmission, cloth seats, and
4-speaker sound system.

• LS (luxury sedan), which includes a 2.4 L engine, automatic or manual transmission,

cloth or leather seats, and 6-speaker sound system.

• LE (limited edition), which includes a 2.4 L engine, automatic transmission, leather

seats, and a premium sound system.

PLM00014 12.2 Content Management 41-1

 Chapter
Chapter 41:41:UsingUsing variants
variants for publications
for publications

Instead of creating new options, you could choose options created in the product structure in
Structure Manager. The Structure Manager provides an example of a product structure from which
you could choose options.
Options have a string type or a numeric type and a name. The type of option you
can create depends on the settings of the PSM_classic_variants_text_families and
PSM_classic_variants_numeric_families preferences.

Note
Since Content Management supports only classic variants, ensure the PSEVariantsMode
preference is set to legacy.

1. Open the publication in the Publication Structure view.

2. Choose View→Show/Hide Data Panel or click Show/Hide Data Panel .

3. In the data pane, click the Variants tab and select the line representing the owning publication or
topic revision to store the variant data. Typically this is the top-level item in the structure, in this
example, a publication for the car owner manual. You can also create variants at different levels
of the publication structure, as you might in the product structure.

4. Click the Options branch in the variant data tree.

5. In the Option dialog box, enter the necessary options, for example:
a. In the Name box, type trim level.

b. Optionally, enter the information about the trim level option in the Description box.

c. In the Value box, type an allowed value (LE) and press Enter or + (plus).
The value appears in the list of allowed values.

d. Enter the other allowed values, typing each and then pressing Enter for each one (S, LS).

6. Click Create to create the option. A + (plus) symbol appears against the Options branch in
the variant data tree indicating that Teamcenter created the options.

7. Repeat steps 5 and 6 to define other options on the publication, for example model year (2013,
2014, 2015).

8. Click Save to save the changes. If you forget to do this, Teamcenter prompts you when you
select another line in the publication.
True appears in the Has Classic Variant Data (HCVD) column for the publication line.

9. Repeat steps 3 through 8 to define options on other topics in the structure. For example, you
could create a section of the manual for the operation of a trailer towing package, and set options
on the section for the different types of towing packages.

41-2 Content Management PLM00014 12.2

 Using variants for publications

Copying and modifying options

Create new options from existing options

When an option has values similar to those on an existing option, it may be quicker to create the new
option values from those of the existing option:

1. If necessary, choose View→Show/Hide Data Panel or click the Show/Hide Data Panel
button on the toolbar.
Teamcenter opens the data pane.

2. Click the Variants tab and select the option to copy in the Options branch of the variant data tree.
Teamcenter displays the Option dialog box, prepopulated with the values and name of the
original option.

3. In the Option dialog box, type a new name for the option (duplicate names within an item are not
allowed) and modify the values as required.

4. Click Create to create the new option.

5. Click Save to save the changes.

Change option values

1. If necessary, choose View→Show/Hide Data Panel or click the Show/Hide Data Panel
button on the toolbar.
Teamcenter opens the data pane.

2. Click the Variants tab and select the structure line with the item revision that owns (stores) the
option whose values you want to change. If you are unsure of the owning item, you can identify
this from the Variant Rule dialog box.

3. Expand the Options branch in the variant data tree.

4. Select the option whose values you want to change.

Teamcenter displays the allowed values in the Option dialog box.

5. In the Option dialog box, do one of the following:

• Enter another allowed value and press the Enter key.

• Select the value and click – (minus button) to remove an allowed value from an option.

6. Click Modify and Teamcenter updates the contents of the selected option.

7. Click Save to save the changes.

PLM00014 12.2 Content Management 41-3

 Chapter
Chapter 41:41:UsingUsing variants
variants for publications
for publications

Note
Any variant data that references removed option values can no longer be set as these
values are not available for selection. You typically create a new revision of the item if you
need to preserve the historic data.
You can set the PS_variant_value_protect preference to protect variant values from
unauthorized modifications.
If a value is obsolete but is still referenced by a variant rule, default, derived default, or
variant condition, it is represented by a <?> symbol.

Rename an option

1. If necessary, choose View→Show/Hide Data Panel or click the Show/Hide Data Panel
button on the toolbar.

Teamcenter opens the data pane.

2. Click the Variants tab and select the option to rename in the Options branch of the variant
data tree.

3. Type a new name and click Modify to modify the option.

4. Click Save to save the changes.

Note
You cannot rename an option that is used in more than one revision of the item or in
any expression.
Also, you cannot rename an option that is shared between sites in a Multi-Site Collaboration
environment.

Remove an option

To remove an option from its owning item revision:

1. If necessary, choose View→Show/Hide Data Panel or click the Show/Hide Data Panel
button on the toolbar.

Teamcenter opens the data pane.

2. Click the Variants tab and select the option to remove in the Options branch of the variant
data tree.

3. Click Delete in the Option dialog box.

41-4 Content Management PLM00014 12.2

 Using variants for publications

Note
You cannot remove an option that is used in any expression.

Deleting an option
When you delete (remove) an option, you remove it only from the item revision. When you remove
the option from the last item revision that owns it, you are (in effect) deleting the option.
• You cannot remove an option from an item revision to which you do not have write access.

• You cannot delete an option that is used in a variant condition. If you attempt to do this,
Teamcenter displays an error message that lists all the revisions that have occurrences with
variant conditions referencing that option.

Working with option defaults

Default options allow you to preset option values in the variant rule. The preset value may be:
• Fixed
A fixed default value is a value that you specify. For example, the option engine could have a
default value set to 2.0 L.

• Derived
A derived default is a value that is set to a value that depends on a condition. For example, the
option seats could have a value set to leather if trim level = LX.

Defaults are owned by an item revision, like other variant data. Use the Variant Rule dialog box to
identify the item a default was set on and whether the default is fixed or derived.
You can identify if an item has variant data attached by viewing the HVD - Has Variant Data column
in the Publication Structure view.
You can override option values or reinstate them as necessary.
You specify fixed and specify derived option defaults for publications in a similar way as you do
in Structure Manager.

Add variant conditions to topics in the publication

After you define the options for the publication structure, you add variant conditions to the topics
in the publication. For example, if you have a topic for the operation of the manual transmission
you can assign a condition to the topic that will include it in the owner manuals for the cars with a
manual transmission.
You create variant conditions in the scope of a specific option. If you move the structure line out of the
scope of the option referenced in the variant condition, the variant condition is not retained.
1. Ensure you have displayed the Variant Formula column in the Publication Structure view.

PLM00014 12.2 Content Management 41-5

 Chapter
Chapter 41:41:UsingUsing variants
variants for publications
for publications

2. Select the topic for which you want to create variant conditions.

3. Click Variant Condition , or double-click either the Variant Conditions or Variant Formula
property cells.
Teamcenter displays the Variant Condition dialog box. The upper part of the dialog box shows
the individual clauses that comprise a variant condition. You can use the buttons to move clauses
up or down, delete a clause, or bracket clauses. The lower part of the dialog box allows you to
define a clause, and you can use the following buttons to control how a clause is added to
the list in the upper area:

• Replace

• Insert

• Append

• Clear

4. Click next to the Option box, to view the available options, and click the option you want
to work with, for example, trim level. Only the options currently loaded in the Publication
Structure view are listed, because their owning item is loaded or they are used in a variant
condition in the structure.
The (Owning) Item box is automatically populated.

5. Use the following operators to construct a variant condition:

= Equal to
!= Not equal to
> Greater than
>= Greater than or equal to
< Less than
<= Less than or equal to

Note
If you use >, > = , <, or < = operators, the values of the associated option must be
numeric and only decimal values are permitted.
Not (!) is higher than AND (&); AND (&) higher than OR (|). That is, A OR B AND
A = A OR (B AND A).

6. From the Value list, select the value for the option, for example, LS.

7. Click Append .
The clause is added to the list. It clears the Value box and shows the option's owning item.

41-6 Content Management PLM00014 12.2

 Using variants for publications

8. To add to the list of clauses, click either AND or OR, and repeat the above steps to select
another option.
Teamcenter displays the second clause in the list in the upper part of the dialog box.
Teamcenter constructs a variant condition from the defined clauses joined by AND and OR
operators. When a configuration depends on more than one option, you can configure complex
variant conditions.

Note
If you are only specifying one clause in a condition, you can set the AND switch or
the OR switch.

9. Click OK to create the variant condition on the occurrence.

Modifying variant conditions

Insert a clause before another clause
1. Specify the new clause.

2. Select the clause before which you want to insert the new clause.

3. Click Insert .
Teamcenter inserts the new clause above the selected clause.

Replace a clause
Replacing a clause can be very useful with large compound conditions containing many clauses
because this action does not change the order. Preserving clause order maintains the algebra and
makes scanning for occurrences with similar conditions easier.
1. Specify the replacement clause.

2. Select the clause to replaced in the list.

3. Click Replace .
Teamcenter replaces the original clause with the new one.

Copy a clause

1. Select the clause to copy and click Copy . You can also double-click the clause. This action
copies the option name, value, and operator setting to the boxes and sets the And / Or button
in the lower part of the dialog box.

2. Edit the value and/or operator, set the appropriate AND or OR button, and append the clause.

PLM00014 12.2 Content Management 41-7

 Chapter
Chapter 41:41:UsingUsing variants
variants for publications
for publications

3. Select an existing clause and click Replace to replace the existing clause. You can also
click Insert to place the clause above the selected clause.

Note
You can use Copy in conjunction with Replace, as a convenient way to edit variant
conditions.

Remove a clause

• To remove a clause, select the clause and click Delete .

Move a clause

To change the position of a clause within a condition, select the clause and click Up or Down

.
You can move multiple clauses in a single operation by selecting a range of clauses before clicking
the appropriate arrow button.

Group a clause
You can change the grouping of clauses by adding and removing brackets, as follows:

Note
Teamcenter supports multiple levels of grouping.

To add brackets around a range of clauses, select the range of clauses and click (…).
To remove brackets from around a range of clauses, select the range of clauses, including the lines
that contain both the opening and closing brackets, and click (…).

Remove a variant condition from an occurrence

1. Select the structure line representing the occurrence and click Edit Variant Condition
on the toolbar.
Teamcenter displays the Variant Condition dialog box.

2. Select all of the clauses in the Variant Condition dialog box and click Delete to remove
all the clauses.

3. Click OK to apply the change to the occurrence (that is, effectively remove the variant condition).

41-8 Content Management PLM00014 12.2

 Using variants for publications

Setting variant rules on publications

Set a variant rule

After you create options and variant conditions, you can set a variant rule on a publication structure to
create a configuration of the publication based on the selected options.
1. Select the top level line in the publication in the Publication Structure view.

2. Click Variant Rule or choose Tools→Variants→Configure Variants.

The Variant Rule dialog box appears. If the Configure dialog box appears instead, click
.

3. Find the option you want to set (for example, trim level), and from the Value list, select the
value for the option (for example, LE).
The state of the option changes from Unset to Set by User.

4. Repeat step 3 to set additional options on the publication.

To see the variant rule applied to the publication as you select the options, click Apply.

5. When you are done setting the variant rule, click OK.
The variant rule is applied to the publication, and the topics are included or excluded based
on the rule.

Unset a variant rule

1. Select the top level line in the publication in the Publication Structure view.

2. Click Variant Rule or choose Tools→Variant Rule.

The Variant Rule dialog box appears. If the Configure dialog box appears instead, click
.

PLM00014 12.2 Content Management 41-9

 Chapter
Chapter 41:41:UsingUsing variants
variants for publications
for publications

3. Find the option you want to unset (for example, trim level), and from the Value list, select
a blank value.
The state of the option changes from Set by User to Unset.

4. Repeat step 3 to unset additional options on the publication.

To see the variant rule applied to the publication as you unset the options, click Apply.

5. When you are done working with the variant rule, click OK.
The variant rule is applied to the publication, and the topics are included or excluded based
on the rule.

Working with variant rule checks

Variant rule checks allow you to define combinations of option values that are not allowed. A variant
rule check consists of a condition (for example, trim level = LX AND transmission = manual) and
an error message (for example, Incompatible trim level and transmission). Teamcenter displays
an error message containing the condition and message if the rule check is triggered when you
set values in the variant rule.

Set variant rule check

1. Open the data pane by choosing View→Show/Hide Data Panel or clicking Show/Hide Data
Panel .

2. On the data pane, click the Variants tab.

3. Select the line representing the owning publication or topic revision on which you want to set
the rule check.

4. Select the Rule Checks branch in the variant data tree.

Teamcenter displays the Rule Check dialog box.

5. In the Warning Text box, enter an error message, for example, Incompatible trim level and
transmission.

6. Define the relevant variant condition, for example, trim level = LX AND transmission = manual.

41-10 Content Management PLM00014 12.2

 Using variants for publications

7. Click Create .
Teamcenter creates the rule check.

8. Expand the Rule Check branch and verify the new rule check is added below any that already
existed, for example:
ERROR Incompatible trim level and transmission IF trim level = LX
AND transmission = manual

9. If you need to change the rule check, select it in the Rule Check branch of the variant data tree.
Teamcenter displays the Rule Check dialog box, allowing you to change any of the boxes.

10. Click Modify to apply the changes.

11. Click Save to save the changes.

A Y appears in the Has Variant Data (HVD) column of the properties table, if variant data was
not already created.

Modify a rule check

1. Select the rule check you want to change in the Rule Check branch of the variant data tree.
Teamcenter displays the Rule Check dialog box containing details of the rule check.

2. In the dialog box, change the appropriate boxes.

3. Click Modify to apply the changes.

4. Click Save to save the changes.

Delete rule checks

1. Select the rule check to delete in the Rule Check branch of the variant data tree.
Teamcenter displays the Rule Check dialog box.

2. In the dialog box, click Delete and the selected rule check disappears.

3. Click Save to save the changes.

Show and hide unconfigured components

When you are working with the publication structure, you can choose to show all the topics in the
structure or hide the topics with variant conditions that are not configured for the current variant rule.
The ability to show or hide unconfigured components is determined by the setting of the
PSEShowUnconfigdVarPref preference.
1. With the publication in the Publication Structure view, show or hide all unconfigured components

by clicking Show Unconfigured Variants or by choosing View→Show Unconfigured

Variants, to toggle between the two settings.

PLM00014 12.2 Content Management 41-11

 Chapter
Chapter 41:41:UsingUsing variants
variants for publications
for publications

2. Use the VOC - Variant Occ. Config'd column to identify the configured components. This
column shows a Y if the component is configured, is blank if it is not configured, or ? if
Teamcenter cannot determine if it is configured. The ? indicator appears when a variant condition
contains options that are unset in the variant rule.

41-12 Content Management PLM00014 12.2

Chapter 42: Comparing topics

How topics are compared in Content Management

You can use a third-party comparing tool to view the differences between two topics. You can
compare different topics or two revisions of the same topic; however the topics you compare must be
the same topic type. If your comparing tool supports the merging of content, you can perform the
merge in the tool and then save the changes to the database.
When you compare two revisions of the same topic and open them at the same time, the latest
revision is selected as the left side topic, which means that it appears on the left side of the window
in the comparing tool. If you are merging content, the left side topic is the one that receives and
stores the merged content. When you open topics individually for comparing, the first topic you
select is the left side.

Compare two revisions of the same topic

When you use this method to compare two revisions of the same topic, the one with the latest
revision is selected as the left topic.

1. In the Home component view, hold the Shift key as you click each of the two topic revisions you
want to compare, so that they are both selected. Then right-click one of the topic revisions and
choose Compare/Merge→Launch Compare.

2. If you do not have the left side topic checked out, the Compare: Selection dialog box appears.
Do one of the following:

• If you will not be saving merged content, select Continue Compare.

• If you want the option to save merged content, select Cancel Compare, and then check
out the left side topic.

Depending on the how your comparing tool is set up, both topics may open in the comparing tool,
or a dialog box may appear so that you can select the files to open.

3. Use the comparing tool to view the differences in the topics and merge any differences if
necessary (if the tools supports merging of the contents).

4. If you merged the topics, save the changes in the comparing tool, and in Teamcenter, right-click
the topic that is checked out and choose Compare/Merge→Save Merged Result.

5. Check in the topic.

6. Close the comparing tool.

PLM00014 12.2 Content Management 42-1

 Chapter
Chapter 42:42:Comparing
Comparing topics
topics

Compare two different topics

Use this method to compare two different topics. You can also use this method to compare two
revisions of the same topic if you want to select which of the two revisions is opened as the left topic.
1. In the Home component view, right-click the topic revision of the first topic you want to compare,
and choose Compare/Merge→Select as Left Side to Compare.

2. If you do not have the topic checked out, the Compare: Selection dialog box appears. Do
one of the following:
• If you will not be saving merged content, select Continue Compare.

• If you want the option to save merged content, select Cancel Compare, and then check
out the left side topic.

Depending on the how your comparing tool is set up, the topic may open in the comparing tool, or
a dialog box may appear so that you can select the file to open.

3. Right-click the topic revision for the second topic in the comparison, and choose
Compare/Merge→Launch Compare.

4. Use the comparing tool to view the differences in the topics and merge any differences if
necessary (if the tools supports merging of the contents).

5. If you merged the topics, save the changes in the comparing tool, and then in Teamcenter,
right-click the topic that is checked out and choose Compare/Merge→Save Merged Result.

6. Check in the topic.

7. Close the comparing tool.

42-2 Content Management PLM00014 12.2

Chapter 43: Working with documents for review

Overview of composed and reviewer documents

Composed and reviewer documents contain all the contents of a topic, topic structure, or publication
you select to publish. You can use composed and reviewer documents to distribute content to subject
matter experts or other reviewers or to retain the published documents’ compiled XML for future use.
Composed and reviewer documents contain the same content; they are named differently so you can
choose an appropriate name for the business practice you are using it for.
You can use Teamcenter workflows for document reviews by using Workflow Designer and Workflow
Viewer.
The composed document revision or reviewer document revision is related to the topic or publication
you selected for publishing, and a dataset (.zip file) created by the process is related to the document
revision. The .zip file contains the XML file and all supporting files, such as schemas and stylesheets.
For certain types of output, such as PDF, the output file is also related to the composed or reviewer
document revision as a dataset.
When you publish the same content multiple times, newer composed or reviewer documents
overwrite existing ones if you select the same options when you publish. However, if you publish
content with a different tool or with one or more different options selected in the Publish dialog
box, an additional composed or reviewer document revision is created and related to the topic or
publication you selected for publishing. These options include: Language, Compose Version
Selection, Style Type, DITA Filter Value, and Transform Policy.
Additional composed or reviewer documents are also created each time you publish content with
different variants.

Example
In this example the topic was published three times with different languages selected
(am=US English, and fr=French) or with different variants, which are shown under
ConfigurationContext.

PLM00014 12.2 Content Management 43-1

 Chapter
Chapter 43:43:Working
Working with documents
with documents for review
for review

Create a composed or reviewer document

To create a composed or reviewer document:
• Select the desired Register Result option when you publish content.

View a composed or reviewer document

If a topic has a composed or reviewer document, you can view it with a tool you have installed. You
must have markup capabilities enabled and the markup privilege.
• Select the document revision and choose File→View/MarkUp.

Exporting and importing composed documents

If a topic has a composed (or reviewer) document, it has a related .zip file that contains the XML
file and all supporting files.
You can export the .zip file and unzip and edit its contents outside of Teamcenter, and then import it
back to the system. You can import the content either as a composed document in a .zip file or as an
XML document. When you import an XML document, the edited topic content replaces the content in
the system. When you import a .zip file, the topic content is not replaced.

43-2 Content Management PLM00014 12.2

 Working with documents for review

Export a composed document

1. Right-click the composed or reviewer document you want to export, and choose Named
References.

2. In the Named References dialog box, select the .zip file for the document and click Download....

3. In the Downloading File dialog box, browse to and select the location where you want to save
the .zip file, and click Download.

4. Close the Named References dialog box.

Import a composed document as an XML document

Import the content of a composed document as an XML document if you made changes to the
composed document after you exported it and you want to import the changes to the appropriate
topics.
• Follow the steps to import a document, being sure to:
o Browse to and select the .xml file containing the composed document.

o Select the Find by XML Number option.

Import a composed document as a named reference

Import a composed document as a named reference if you do not want to import changes to the
content of the composed document’s components.
1. Right-click the composed or reviewer document you want to import, and choose Named
References.

2. In the Named References dialog box, select the .zip file for the document and click Upload....

3. In the Upload File dialog box, browse to and select the .zip file you want to import, and click
Upload.

4. Close the Named References dialog box.

PLM00014 12.2 Content Management 43-3

Chapter 44: Using graphics in your content

Overview of graphics in Content Management

To use graphics that are created in graphic editing programs, you must import them to Content
Management. To edit an imported graphic, you must check it out and edit it in the graphic editing
program.

A graphic item is a top level graphic object that has one or more graphic files related to it. Graphic
objects related to the graphic item are called graphic options. Graphic options have related graphic
files, or images. You can import multiple graphic images for different uses. For example, you
can import a higher-resolution image, such as an .eps file, for publishing to PDF, and a smaller
resolution image, such as a .png file, for displaying the graphic in the XML edit tool during an
editing session. Beginning in Teamcenter 10.0, you can import JT files to use as graphic options in
Content Management.

When you import a graphic option, you select the language to associate with it, which is imported
as its Language Reference property. If you choose more than one language, a graphic option is
imported for each language. You can also select Multilanguage for the Language option for a
graphic that can be used for any language translation.

Note
• The naming convention used for graphics impacts whether you can resolve the graphic
references when you import XML content that contains those references. Your Content
Management administrator should provide guidelines for working with graphics to
match the configuration enabled in XML attribute mappings.

• The S1000D standard does not require you to associate a language with graphics, and
the sample S1000D graphic attribute mapping does not support multiple languages
for graphics.

• DITA OT publishing tools support the following image formats, although .tif and .png
formats may not be supported for PDF output:
.jpg

.gif

.bmp

.tif

.eps

.svg

PLM00014 12.2 Content Management 44-1

 Chapter
Chapter 44:44:UsingUsing graphics
graphics in your
in your content
content

.png

Set tagging preferences for graphics

Use the Graphic Link Clipboard preference to set the tagging to be used in the editing tool when a
graphic is copied and pasted from Content Management to the editing tool. When graphic options
are pasted into content and the content is saved to the database, the content is decomposed and
the graphic option is substituted with the graphic item, so that other graphic options can be used
when the content is subsequently composed.
This preference applies to only your user account on your client computer. It does not affect other
users' client computers or your user account on other computers. This preference does not affect
other Teamcenter applications.
1. Choose Window→Preferences.

2. In the Preferences dialog box, expand Teamcenter, and then expand Content Management.

3. Click Graphic Link Clipboard.

4. From the list box, select the option for the publication standard you are using:

Note
If a new option must be added to the list or an existing option must be updated, contact
your administrator to update the graphic tagging options.

44-2 Content Management PLM00014 12.2

 Using graphics in your content

• DocBook (for the DocBook standard or a similar XML standard)

• DITA

• S1000D 4.x

The text box displays the tagging used in the editing tool when a graphic is copied from Content
Management and pasted to content in the editing tool.

5. Click Apply.

6. Click OK to close the Preferences dialog box.

Import graphics
To use graphics that are created in graphic editing programs, you must import them to Content
Management. Imported graphics are placed in a folder according to how your user interface (UI)
options are set in the rich client.
1. Choose Tools→Import→Graphic.

2. In the Import Graphic Options dialog box, do the following:

For this option Do this

From Directory Browse to and select the folder from which graphics are to
be imported.
File names Select the check box for each graphic file that you want to
import.

Tip
Click Select All or Deselect All to select or
deselect all files listed.

Graphic Usage Do one of the following:

• Select the Use Graphic Usages from Graphics
Mapping check box to use the graphic usages defined in
the ctm0GraphicUsagePref preference.

• Select the graphic usages that you want to assign to this

graphic option:

Caution
Each graphic option of the same graphic file
must have unique usages. For example, do
not import piston.png and piston.gif both with
the VIEW option.

PLM00014 12.2 Content Management 44-3

 Chapter
Chapter 44:44:UsingUsing graphics
graphics in your
in your content
content

For this option Do this

If the graphic will be used for Select this graphic

this purpose usage
Icon in published output ICON
High-resolution graphic in PDF
printed output
Graphic in a resolution PRINT
appropriate for the printer
where it will be printed
Small-scale image THUMBNAIL
Low-resolution image, typically VIEW
for viewing only
Image to appear in a Web WEB
browser
Graphic Attribute Mapping Select the appropriate graphic attribute defined by your
application administrator.
Graphic Classname Select one of the following:
• Graphic—for non-S1000D content.

• S1000D Graphic—for S1000D content.

Language Select the languages for the graphics being imported, or
choose Multilanguage if the graphics have no specific
language associated with them. A separate graphic option
will be imported for each language you choose.

Note
For S1000D graphics, select the site master
language. The S1000D standard does not require
you to associate a language with graphics, and the
sample S1000D graphic attribute mapping does
not support multiple languages for graphics.

Overwrite Mode Select one of the following:

Note
If you select neither overwrite mode, the graphic
will be imported as a new graphic if a graphic
option with the same Original Imported Name
property and graphic usage does not already exist
in the system.

• Skip existing

44-4 Content Management PLM00014 12.2

 Using graphics in your content

For this option Do this

The graphics are not imported if they already exist in

Content Management.

• Overwrite existing
If the graphics already exist in Content Management,
they are overwritten.
If you select Overwrite existing, select one of the
following usage handling options:

Tip
To view the usages associated with an existing
graphic option, right-click the graphic option
revision, and choose View Properties.

Note
Edit, publish, and export functions always use
the latest revision of graphic options. If you
revise a graphic, the new revision appears in
all content that references the graphic. If you
want to change a graphic but you do not want
the graphic updated in all content, you must
import the changed graphic as a new graphic
with a different name.

o Keep
The usages of the existing graphics are retained.

o Merge
The usages of the existing graphics are retained,
and the new usages selected for this import are
added to the graphics. For example, if a graphic
being imported already exists with the VIEW and
WEB usages, and the selected usages in the Import
Graphic Options dialog box are THUMBNAIL and
ICON, the graphic is saved with the VIEW, WEB,
THUMBNAIL, and ICON usages after the import.

o Overwrite
The usages of the existing graphics are removed
and replaced by the usages selected in the Import
Graphic Options dialog box.

PLM00014 12.2 Content Management 44-5

 Chapter
Chapter 44:44:UsingUsing graphics
graphics in your
in your content
content

3. Click Finish.

Preview a graphic
• Preview graphics in the following ways:
o Select the graphic option or graphic option revision and open the Summary view. The
graphic appears in the Preview area.

o Right-click the graphic option revision, and choose Show Content.

o Right-click the graphic option or graphic option revision, and choose Open with→Image
Preview.

Insert a graphic into a topic

You can insert a graphic option reference into a topic that is open in the editing tool.
In the Publication Structure view, the graphic appears in the structure with an Occurrence Type of
Content Graphic Reference or Composable Graphic Reference.

Note
When you paste a graphic option into content and you save the content to the database, the
content is decomposed and the graphic option filename is substituted with the graphic item,
so that other graphic options can be used when the content is subsequently composed.
The graphic tag that is pasted is dependent on the Graphic Link Clipboard preference.
If you save a topic with a graphic that does not exist in Teamcenter, a warning message
appears indicating the graphic cannot be found. The next time you edit the topic the
graphic name in the XML is appended with .error.

1. Search for the graphic.

2. Right-click the appropriate graphic option revision, and choose Copy For Editor→Graphic
Content.

3. In the editing tool, right-click the valid position where you want to insert the graphic, and choose
Paste.
The graphic reference is inserted in the topic’s XML, using the tag information from your Graphic
Link Clipboard preference and the identifying information for the graphic file.

4. (Optional) To use a version of the graphic other than the current version, add the appropriate
value to the version attribute in the editing tool.

44-6 Content Management PLM00014 12.2

 Using graphics in your content

Add a Lifecycle Visualization graphic to a topic

You can save 2D images or 3D models in Teamcenter lifecycle visualization so that they can be used
as 2D graphics in print and online publications that are managed in Content Management. You insert
the graphics into topics when they are open in the editing tool from Content Management.
If the 3D model changes, you can recapture the image in Teamcenter lifecycle visualization to update
it in Content Management.
1. In Teamcenter, send a 2D image or 3D model to the stand-alone application viewer or the
Lifecycle Viewer.

2. In Teamcenter lifecycle visualization, choose File tab→Publish 2D graphic to Teamcenter

Content Management.

Note
This option is available only if the graphic is stored in Teamcenter.

3. In the Graphic Option dialog box, do the following:

For this option Do this

Name Type a name for the graphic.
Graphic Usage Do one of the following:
• Select the Use Graphic Usages from Graphics
Mapping check box to use the graphic usages defined in
the ctm0GraphicUsagePref preference.

• Select the graphic usages that you want to assign to this

graphic option:

Caution
Each graphic option of the same graphic file
must have unique usages. For example, do
not use piston.png and piston.gif both with the
VIEW option.

If the graphic will be used for Select this graphic

this purpose usage
Icon in published output. ICON
High-resolution graphic in PDF
printed output.
Graphic in a resolution PRINT
appropriate for the printer
where it will be printed.
Small-scale image. THUMBNAIL

PLM00014 12.2 Content Management 44-7

 Chapter
Chapter 44:44:UsingUsing graphics
graphics in your
in your content
content

For this option Do this

Low-resolution image, typically VIEW
for viewing only.
Image to appear in a Web WEB
browser.
Graphic Attribute Select the appropriate graphic attribute defined by your
application administrator.
Graphic Classname Select one of the following:
• Graphic—for non-S1000D content.

• S1000D Graphic—for S1000D content.

Language Select the languages for the graphics being saved, or choose
Multilanguage if the graphics have no specific language
associated with them. A separate graphic option will be
saved for each language you choose.

Note
For S1000D graphics, select the site master
language. The S1000D standard does not require
you to associate a language with graphics, and the
sample S1000D graphic attribute mapping does
not support multiple languages for graphics.

Overwrite Mode Select one of the following:

Note
If you select neither overwrite mode, the graphic
will be saved as a new graphic if a graphic option
with the same Original Imported Name property
and graphic usage does not already exist in the
system.

• Skip existing
The graphics are not saved if they already exist in
Content Management.

• Overwrite existing
If the graphics already exist in Content Management,
they are overwritten.
If you select Overwrite existing, select one of the
following usage handling options:

44-8 Content Management PLM00014 12.2

 Using graphics in your content

For this option Do this

Tip
To view the usages associated with an existing
graphic option, right-click the graphic option
revision, and choose View Properties.

Note
Edit, publish, and export functions always use
the latest revision of graphic options. If you
revise a graphic, the new revision appears in
all content that it is referenced in. If you want
to change a graphic but you do not want the
graphic updated in all content, you must save
the changed graphic as a new graphic with a
different name.

o Keep
The usages of the existing graphics are retained.

o Merge
The usages of the existing graphics are retained, and
the new usages selected for this save are added to
the graphics. For example, if a graphic being saved
already exists with the VIEW and WEB usages,
and the selected usages in the Graphic Options
dialog box are THUMBNAIL and ICON, the graphic
is saved with the VIEW, WEB, THUMBNAIL, and
ICON usages.

o Overwrite
The usages of the existing graphics are removed
and replaced by the usages selected in the Graphic
Options dialog box.

4. Click Next.

5. In the Export Image dialog box, adjust the settings as needed.

Tip
A resolution of 72 DPI is suitable for images to display on a monitor (e-mail and web
pages). Use a resolution of at least 300 DPI for print content.

PLM00014 12.2 Content Management 44-9

 Chapter
Chapter 44:44:UsingUsing graphics
graphics in your
in your content
content

6. Click Finish.

Note
If your organization uses watermarks, a watermark page may appear before you can
click Finish.

The graphic is saved in Teamcenter.

7. In Content Management, search for the graphic, and then move it to the folder where you want
to store it.

8. Right-click the graphic option revision, and choose Copy For Editor→Graphic Content.

9. In the editing tool, right-click the valid position in the topic where you want to insert the graphic,
and choose Paste.
The graphic reference is inserted in the topic’s XML, using the tag information from your Graphic
Link Clipboard preference and the identifying information for the graphic file.

Edit a graphic option

To edit a graphic, you must check it out and edit it in a graphic editing program. However, you can do
this without re-importing the graphic.

Note
Edit, publish, and export functions always use the latest revision of graphic options. If you
revise a graphic, the new revision appears in all content that it is referenced in. If you want
to change a graphic but you do not want the graphic updated in all content, you must
import the changed graphic as a new graphic with a different name.

1. Double-click the graphic option image you want to edit.

The graphic is checked out and opens in the default program for the file type.

2. Edit the graphic and save the changes.

3. Close the program you used to edit the graphic.

The graphic is checked in.

44-10 Content Management PLM00014 12.2

 Using graphics in your content

Update a graphic option using Named References

If a graphic changes or you want to change the graphic usage or graphic language, you can update
the graphic option image using the Named References option. When you update a graphic option, it
is updated in every topic in which it is referenced.
1. If you want to retain the original graphic option, select the graphic option revision, and choose
File→Revise, and then follow these steps with the new graphic option revision.
Edit, publish, and export functions always use the latest revision of graphic options. If you revise
a graphic, the new revision appears in all content that it is referenced in.

2. Right-click the graphic option image you want to update, and choose Named References.

3. In the Named References dialog box, select the graphic name and click to delete the
referenced file.

4. Click Upload....

5. In the Upload File dialog box, browse to and select the new graphic file to replace the one
you deleted.

6. Click Upload.

7. When the new referenced file appears in the Named References dialog box, click Close.

Update the graphic usage for a graphic option

Graphic usages are assigned to graphic options when you import them, but you can update the
usages for an existing graphic option.

Caution
Each graphic option of the same graphic item must have unique usages. For example, do
not import piston.png and piston.gif both with the VIEW option.

1. Right-click the graphic option revision, and choose Edit Properties.

2. Click Yes to confirm the checkout.

3. Click All to show all properties.

PLM00014 12.2 Content Management 44-11

 Chapter
Chapter 44:44:UsingUsing graphics
graphics in your
in your content
content

4. In the Graphic Usages box, edit the graphic usages.

5. Click Save and Check-In, and click Yes to confirm the check-in.

Perform a where-used search for a graphic option

A where-used search identifies all the publications that contain a specific graphic option.
1. Select the graphic option revision in the Home component view.

2. Select the Impact Analysis view.

3. Select Used from the Where option list, located in the upper left of the pane.

44-12 Content Management PLM00014 12.2

Chapter 45: Managing content in different languages

Content translation process

You can manage translations of individual topics or topics at any level in a publication structure.
Managing a translation begins with creating a translation order, in which you choose the translation
office that will perform the translation. Then you create a translation delivery to select the languages
and create a .zip file to contain the content to be translated and any supporting files. You export the
.zip file, and send it to the translator. When the content is translated and returned, you import it
back into the system.
If necessary, you can use a Teamcenter workflow to manage translations according to your
organization’s business practices.
Once a translation exists in the system, you can work with a translated topic as you would any other
topic. Each translated topic is related to the original topic in the master language. Content versions
are used to determine if content has changed since it was translated.
When creating a translation delivery, you can choose to include the graphics associated with the
topics to be translated.

Note
Graphics are not managed the same way topics are during the translation process.
Graphic options have an associated language property. When you edit and publish content
in a language other than the master language, the graphics that match the language are
selected. When a graphic does not exist for the language, the master language graphic
option is used.

View the status of translation order content

You can use a report to review the status of a translated topic or publication to determine if translated
content is at the same content version as the master language content. If the master language
content has been edited since the translation order was created, the translation order content will
have a different content version than the master language content.

1. In either the Home component view or the Publication Structure view, right-click the topic or
publication revision that has the related translation order, and choose Translation Status.

2. In the Browse dialog box, browse to the location where you want to save the report, which is
a .csv file, and click Save.

3. Open the .csv file in Microsoft Excel to review the translation statuses for the topics in the
translation order.

PLM00014 12.2 Content Management 45-1

 Chapter
Chapter 45:45:Managing
Managing content
content in different
in different languages
languages

The report shows each topic’s master language content version and translated language
content version. The In Sync? column reports Y or N to indicate whether the two versions are
out-of-sync. Out-of-sync versions indicate updates were made to the master language content
since the translation order was created.

Create a translation order

The first step in managing the translation process in Content Management is to create a translation
order, which provides information to the translator about the translation service being requested.
1. Do one of the following to display a dialog box to create the translation order:
• In either the Home component view or the Publication Structure view, right-click the topic or
publication revision to be translated, and choose Translation Order.

• In the Home component view, select the topic or publication revision to be translated, and
then either click New Author Item... , or choose File→New→New Author Item.
In the New Author Item dialog box, expand Complete List, click Translation Order, and
then click Next.

2. In the dialog box, do the following:

For this option Do this

ID Either type an ID for the translation order, or leave the box
blank so that the next available item ID is automatically
assigned.
Revision Either type a revision for the translation order, or leave the
box blank so that the next available revision is automatically
assigned.
Name Type a name for the translation order.
Order Title Type a title for the translation order.
Order Description Type a description of the translation order.
Translation Office Reference Select the translation office responsible for translating this
order.
Request Delivery Date Click the calendar button, and then select the date that you
want the translation returned.

3. Click Finish.

4. (Optional) Submit the translation order to a Teamcenter workflow.

45-2 Content Management PLM00014 12.2

 Managing content in different languages

5. Create the files for content delivery to a translator.

Create the files for content delivery to a translator

To deliver content to a translator, you create a translation delivery. A translation delivery collects into
a .zip file all the files that a translator needs to translate the content. When you create a translation
delivery, the following objects are created in Content Management:

• Translation delivery, related to the translation order

• Translations, related to the translation delivery and the original topic

• A .zip file containing the content to be translated and any selected supporting files, which you can
export and send to the translation company

1. Right-click the translation order revision and choose Create Translation Delivery.

2. In the Create Translation Delivery dialog box, do the following:

For this option Do this

Includes Select the items to include in the translation delivery .zip file:
• Include Graphics
Includes the graphics that are referenced in the content.

• Include Supporting Data

Includes the schemas with which the XML files can be
validated.

• Include Published Content

Includes related composed documents.
Delivery Modes Select the items that you want to include in the translation
delivery .zip file:
• Deliver Composed Topic
Includes the content in one composed document.

• Deliver Decomposed Topic

Delivers the content as separate topics.

• Deliver Out-of-Sync Topics Only

Delivers only topics that were modified since the last
translation. (The content version of the translated topic is
not current with the master language version.)

PLM00014 12.2 Content Management 45-3

 Chapter
Chapter 45:45:Managing
Managing content
content in different
in different languages
languages

For this option Do this

When you select this option, the topics must be delivered

decomposed, so you cannot select this option along with
the Deliver Composed Topic option.
You can view the status of translation order content to
determine if the content has out-of-sync topics.

• Deliver Topics Already Out for Translation

Includes all out-of-sync topics, even those that have
already been sent for translation.
If this is not selected, only the topics that have not yet
been sent for translation will be included.
This option is only available when you select the Deliver
Out-of-Sync Topics Only option.
Available Languages Select each language you want the content translated to,

and then click to move the languages to the Selected

Languages list.
Selected Languages Select each language, and then select Review next to
each language that you would like to flag for a review when
translated content is returned.

3. Click Finish.
The Delivery Type property for the translation delivery is set to Submittal.

4. Export the translation delivery.

Export the translation delivery

You export the translation delivery .zip file to a local or network drive, so that you can send the
files to be translated to the translator.
1. Select the translation delivery revision, and choose Tools→Export→Translation.

2. In the Browse dialog box, browse to the location where you want to save the .zip file, and click
Save.

3. Send the .zip file to the translation office for translating.

Tasks completed by the content translator

When a translator receives the translation delivery as a .zip file, it contains the following:
• A .txt file listing the topics to be translated and the languages to which they are to be translated.

45-4 Content Management PLM00014 12.2

 Managing content in different languages

• The ...original folder, containing the topics (as XML files) to be translated, in the master language.

• The ...translated folder, as a placeholder for the translated topics.

• The ...translationSource folder, containing the topics to be translated.

• The ...supportingData folder, containing the schemas with which the XML files can be validated.

• The ...graphics folder, containing the graphics referenced in the content, if graphics were
included in the translation order when it was created.

The process completed by the translator is as follows:

1. Translate the topics in either the translated\decompose or the translated\compose folder. If
both the decompose and compose folders were included in the delivery, remove the one that
you are not using.
The topics can be edited with an editing tool. These files can also be validated with the respective
schemas included in the translation order.

2. When the translation of the files is completed, create a .zip file with the same contents as the
original translation delivery folder.

3. Send the .zip file back to the appropriate Content Management user.

Import translated content

When you receive translated files from the translator, you import the translated data into Content
Management. The translations can then be tested by previewing or publishing them in the appropriate
language.
1. When you receive a translation from a translator, save the attached .zip file to a local or network
drive.

Note
The .zip file from the translator must contain the original folder structure of the
translation delivery and the translations results contained in the translated folder, as
described in Tasks completed by the content translator.

2. Choose Tools→Import→Translations.

3. In the Receive Translations dialog box, click to browse to and select the folder containing
the .zip file you received from the translation office.

4. In the Translation zip files box, select the check box for each .zip file you want to import.

Tip
Click Select all or Deselect all to select or deselect all files listed.

PLM00014 12.2 Content Management 45-5

 Chapter
Chapter 45:45:Managing
Managing content
content in different
in different languages
languages

5. Click Finish.
The translations are updated with the translated content, and the Translation Received property
on the translations is set to TRUE. Also, a new translation delivery object is created with the
Delivery Type property set to Delivery. A check mark appears next to received translations.

Edit a translation topic

You can edit a translation topic before you send it the translator (in the master language) or after it is
received from the translator and imported to Content Management (in the translated language). Once
you save and check in your edits, the Content Version Reference on the translation is set to the
Content Version of the master language topic.

Caution
If you edit translation content after it is sent to the translator but before it is returned and
imported, once you import the translated content, any edits you made to the source will
be overwritten.

1. In the Home component view, right-click the translation revision, and choose Edit→Edit
Translation.

2. In the Check-Out dialog box, click Yes.

The topic opens with the editing tool and is saved in a local folder. The topic appears as checked
out , and in edit mode . The Teamcenter CMS menu appears in the editing tool's menu bar.

3. In the editing tool, edit the content as necessary, as the schema structure allows.

4. When you are done editing the topic, do one of the following:

45-6 Content Management PLM00014 12.2

 Managing content in different languages

To do this Do the following For this result

Save your Do one of the following: The editing tool closes the file, the edited file
changes and is updated in the database, and its content
close the file. • In the editing tool, version reference is set to the content version
choose Teamcenter of the master language topic.
CMS→Save and
Close.

• Use the editing tool's

options for saving
files, and then in the
Home component view,
right-click the translation
revision, and choose
Edit→Save and Close
Edit.

Then right-click
the translation
revision, and choose
Check-In/Out→Check In.
Close the file Do one of the following: The editing tool closes the file, the file remains
without saving unchanged in the database.
your changes. • Choose Teamcenter
CMS→Close.

• In the Home component

view, right-click the
translation revision, and
choose Edit→Cancel
Edit.

Then right-click
the translation
revision, and choose
Check-In/Out→Cancel
Checkout.

PLM00014 12.2 Content Management 45-7

Siemens Industry Software

Headquarters
Europe
Granite Park One
Stephenson House
5800 Granite Parkway
Sir William Siemens Square
Suite 600
Frimley, Camberley
Plano, TX 75024
Surrey, GU16 8QD
USA
+44 (0) 1276 413200
+1 972 987 3000

Asia-Pacific
Americas
Suites 4301-4302, 43/F
Granite Park One
AIA Kowloon Tower, Landmark East
5800 Granite Parkway
100 How Ming Street
Suite 600
Kwun Tong, Kowloon
Plano, TX 75024
Hong Kong
USA
+852 2230 3308
+1 314 264 8499

About Siemens PLM Software

© 2019 Siemens Product Lifecycle Management

Siemens PLM Software, a business unit of the Siemens
Software Inc. Siemens and the Siemens logo are
Industry Automation Division, is a leading global provider
registered trademarks of Siemens AG. D-Cubed,
of product lifecycle management (PLM) software and
Femap, Geolus, GO PLM, I-deas, Insight, JT, NX,
services with 7 million licensed seats and 71,000 customers
Parasolid, Solid Edge, Teamcenter, Tecnomatix and
worldwide. Headquartered in Plano, Texas, Siemens
Velocity Series are trademarks or registered trademarks
PLM Software works collaboratively with companies
of Siemens Product Lifecycle Management Software
to deliver open solutions that help them turn more
Inc. or its subsidiaries in the United States and in other
ideas into successful products. For more information
countries. All other trademarks, registered trademarks
on Siemens PLM Software products and services, visit
or service marks belong to their respective holders.
www.siemens.com/plm.