Deploying Document Management

SIEMENS
Teamcenter 12.0
Deploying Document
Management
PLM00053 • 12.0
Contents
Overview of Document Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
Planning the Document Management deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
Document Management deployment workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
Installing or updating Teamcenter with Document Management . . . . . . . . . . . . . . . . . . . 4-1

The different scenarios to install Teamcenter Document Management . . . . . . . . . . . . . . . . . . 4-1
Create a new Teamcenter environment with Document Management . . . . . . . . . . . . . . . . . . . 4-1
Update an existing Teamcenter environment with Document Management . . . . . . . . . . . . . . . 4-1
Installing Business Modeler IDE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
Installing Visualization Convert and Print . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1
Installing or updating Dispatcher for Document Management . . . . . . . . . . . . . . . . . . . . . 7-1
Setting up Teamcenter Office Online . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1

Workflow to set up Teamcenter Office Online . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1
Install Microsoft Office Online Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1
Install Teamcenter Office Online . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1
Configure Teamcenter Office Online . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-3
Configure Teamcenter Office Online web service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-4
Enable Teamcenter Client for Office . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1
Configuring Document Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1

The different tasks to configure Document Management . . . . . . . . . . . . . . . . . . . . . . . . . . 10-2
Standardizing document formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-3
Standardizing Microsoft Office documents with templates . . . . . . . . . . . . . . . . . . . . . . . 10-3
Import a sample Business Modeler IDE document template file . . . . . . . . . . . . . . . . . . . 10-4
Set up a new document template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-6
Standardizing document behavior . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-7
Why standardize document behavior . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-7
Create an item revision definition configuration to standardize document behavior . . . . . . 10-8
Create a dispatcher service configuration to render documents . . . . . . . . . . . . . . . . . . 10-18
Create a system stamp configuration to set system stamps . . . . . . . . . . . . . . . . . . . . . 10-24
Configuring generic attribute exchange between Teamcenter and Microsoft Word
documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-28
How to configure generic attribute exchange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-28
Define logical objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-28
Relate logical objects with datasets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-30
PLM00053 12.0 Deploying Document Management 3

Contents
Contents
Update the business object constant for generic attribute exchange . . . . . . . . . . . . . . . 10-30
Set up custom properties in Microsoft Word . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-31
Verify the generic attribute exchange configuration . . . . . . . . . . . . . . . . . . . . . . . . . . 10-32
Automating the document rendering process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-32
Configuring document printing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-33
Setting up document printing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-33
Create a print configuration to define print settings . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-33
Specify banner pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-37
Defining printer device and page specifications for UNIX printing . . . . . . . . . . . . . . . . . 10-41
Provide access privileges for batch printing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-45
Configuring system stamps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-46
Setting up system stamps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-46
Setting up logos and distribution statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-50
Set a MetaData Stamp file to add system stamps during PDF rendering and printing
processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-54
Insert system stamps in PDF and Microsoft Office files . . . . . . . . . . . . . . . . . . . . . . . . 10-55
Configuring document markup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-57
Setting up applications for document markup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-57
Turn off Adobe protected mode for markups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-58
Provide access privileges for document markups . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-59
Configuring digital signing for PDF documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-60
Setting up digital signing for PDF documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-60
Provide access privileges for digital signing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-60
Enable thumbnails for documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-61
Configuring full-text search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-61
Configuring Active Workspace features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-63
Requirements to configure Document Management for Active Workspace . . . . . . . . . . . 10-63
Create document revisions in Active Workspace by dragging files to a folder . . . . . . . . . 10-63
View the document page type in Active Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . 10-64
View PDFs in the Active Workspace universal viewer . . . . . . . . . . . . . . . . . . . . . . . . . 10-64
Enable PDF streaming in the Active Workspace universal viewer . . . . . . . . . . . . . . . . . 10-64
Standardize document behavior in Active Workspace . . . . . . . . . . . . . . . . . . . . . . . . . 10-65
Host Active Workspace in Microsoft Office applications . . . . . . . . . . . . . . . . . . . . . . . 10-65
Host Active Workspace in Adobe Creative Cloud applications . . . . . . . . . . . . . . . . . . . 10-65
4 Deploying Document Management PLM00053 12.0

Chapter 1: Overview of Document Management
Documents play an important role in product data management. Documents that support the
development efforts of a product must be maintained in sync with the development process.
However, document authors manage documents in several different environments that have no
connection to their product data. As a result, documents are often out of sync with the product
information. Such misaligned processes cause companies to miss their product launch deadlines due
to incomplete or improper documents, poor labeling, or incorrect regulatory filings. In some cases,
even overabundance of documents affect the product release.
To ensure that documents conform to the required formats, meet product deadlines, and use the
latest product information, you use Teamcenter Document Management.
Using Document Management, you can:

• Standardize document formats by using templates for ease of creating, modifying, and reviewing
documents.
• Render documents to different file formats.
• Print documents with watermarks, stamps, and logos to ensure proper distribution.
PLM00053 12.0 Deploying Document Management 1-1

Chapter
Chapter 1: 1: Overview
Overview of Document
of Document Management
Management
• Mark up documents for simultaneous reviews.
• Digitally sign PDF documents to secure them.
• Manage attribute exchange between Teamcenter and Microsoft Office documents by leveraging
Teamcenter attribute exchange features. Also, manage the generic attribute exchange from
Teamcenter to Microsoft Office documents by using logical objects.
1-2 Deploying Document Management PLM00053 12.0

Chapter 2: Planning the Document Management deployment
Users of Teamcenter Document Management perform various tasks such as creating templates,
rendering documents to different formats, and marking up documents. However, not all sites may
require the users to perform all tasks. As an administrator, you must plan to install the appropriate
components on the server and client machines as per the site requirements.
Requirements Server components Client components

Standardize Microsoft Office Teamcenter Teamcenter Client for Microsoft
document formats by using Office
templates Teamcenter Client for Microsoft
Office (Required for using
a locally installed version of
Microsoft Office)
Teamcenter Office Online
(Required for using Microsoft
Office Online)
Mark up documents in Microsoft Teamcenter Teamcenter Client for Microsoft
Office Office
Teamcenter Client for Microsoft
Office (Required for using
a locally installed version of
Microsoft Office)
Teamcenter Office Online
(Required for using Microsoft
Office Online)
Teamcenter
Mark up documents in Adobe Teamcenter Acrobat/Reader
Acrobat and Adobe Reader Teamcenter Acrobat/Reader Plugin
Plugin
Teamcenter
Teamcenter Lifecycle
Visualization Convert and
Render documents from
Print, Ghostscript 8.64 (Asian
supported source to
font version)
presentation formats
Dispatcher with
RenderMgtTranslator and
PreviewService translators

Chapter
Chapter 2: 2: Planning
Planning the Document
the Document Management
Management deployment
deployment
Requirements Server components Client components

Print documents Teamcenter
Teamcenter Lifecycle
Visualization Convert and
Print, Ghostscript 8.64 (Asian
font version)
Dispatcher with BatchPrint and
PreviewService translators
Digitally sign PDF documents Teamcenter Teamcenter Acrobat/Reader
Plugin
Teamcenter Acrobat/Reader
Plugin
Exchange metadata between Teamcenter Teamcenter Client for Microsoft
Teamcenter and Microsoft Office
Office files by using Teamcenter Teamcenter Client for Microsoft
attribute exchange Office
Access Active Workspace Teamcenter Teamcenter Adobe CC
within Adobe Creative Cloud Integration
applications
The following table describes the role of the components in Document Management deployment:
Component Is used for

Dispatcher Rendering documents in different file formats, generating thumbnails,
and for batch printing, using appropriate conversion and print
translators.
Visualization Convert and Printing native and external file formats (Print). It is also used to
Print convert raster, vector, and document file formats into supported
output file formats (Convert).
Business Modeler IDE Configuring Document Management by creating different
configuration objects.
Teamcenter Office Online Delivering browser-based versions of Microsoft Word, PowerPoint,
and Excel.
Teamcenter Office Online requires Microsoft Office Online.
Teamcenter Client for Providing direct access to Teamcenter through Microsoft Office
Microsoft Office applications. This integration offers the option of either a traditional
Microsoft or Active Workspace look and feel.
Teamcenter Client for Microsoft Office requires a locally installed
version of Microsoft Office.
Teamcenter Acrobat/Reader Providing direct access to Teamcenter through Adobe Acrobat and
Plugin Adobe Reader Document Cloud.
Teamcenter Adobe CC Hosting Teamcenter Active Workspace in Adobe Creative Cloud
Integration applications, and for enabling the integrated viewing or editing of
Adobe Creative Cloud files.

Chapter 3: Document Management deployment workflow

Chapter 4: Installing or updating Teamcenter with
Document Management
The different scenarios to install Teamcenter Document Management

Scenario 1 — You wish to install Teamcenter Document Management but do not have an existing
Teamcenter environment. In such a case, you can install Document Management while installing
Teamcenter on the corporate server.
Scenario 2 — You wish to install Teamcenter Document Management in an existing Teamcenter
environment. You can do so by updating the Teamcenter environment to add features required
for installing Document Management.
Create a new Teamcenter environment with Document Management

If you do not have an existing Teamcenter environment, you can install Document Management while
installing Teamcenter on the corporate server by selecting the following features:
• Server Enhancements→Java EE Based Server Manager (available only for a 4-tier Rich Client
installation), Full Text Search Engine, Sample files, and Security Service.
• Extensions→Enterprise Knowledge Foundation→Teamcenter Client for Microsoft Office,

Dispatcher Client for Rich Client, and Render Document for Rich Client
• Extensions→Content and Document Management→Acrobat/Reader Plugin
After installing Teamcenter, you install Teamcenter patches, if available. Teamcenter updates are
delivered in patches and in maintenance packs.
To create a new Teamcenter environment and to install the patches, refer to the following, as
applicable:
• Windows
Windows Server Installation
• Unix and Linux

UNIX and Linux Server Installation
Update an existing Teamcenter environment with Document

Management
1. Run Teamcenter Environment Manager (TEM) from your TC_ROOT\install directory.
The TC_ROOT directory is the folder containing your Teamcenter installation, for example,
C:\app\tc.

Chapter
Chapter 4: 4: Installing
Installing or updating
or updating Teamcenter
Teamcenter with Document
with Document Management
Management
2. In the Maintenance panel, select Configuration Manager and click Next.
3. In the Configuration Maintenance panel, select Perform maintenance on an existing

configuration and click Next.
4. In the Old Configuration panel, select an existing configuration on which you want to install
Document Management and click Next.
5. In the Feature Maintenance panel, select Add/Remove Features and click Next.
6. In the Features panel:

• Select Server Enhancements→J2EE Based Server Manager (available only for a 4-tier
rich client installation), Full Text Search Engine, Sample Files, and Teamcenter Security
Service.
• Select Extensions→Enterprise Knowledge Foundation→Teamcenter Client for

Microsoft Office, Dispatcher Client for Rich Client, and Render Document for Rich
Client.

Installing or updating Teamcenter with Document Management
• Select Extensions→Content and Document Management→Acrobat/Reader Plugin.

Ensure that you have installed Adobe Acrobat/Reader Document Cloud applications.

Chapter
Chapter 4: 4: Installing
Installing or updating
or updating Teamcenter
Teamcenter with Document
with Document Management
Management
7. Enter information as needed in the subsequent panels.
8. In the Multiplexing Proxy (MUX) panel, click Advanced.

In the SSL Configuration dialog box, select Enable SSL to ensure that the Office Online
Server runs in the Secure Socket Layer (SSL) mode. Next, enter the keystore and truststore
details, and click OK.
9. Enter information as needed in the subsequent panels.
10. In the Security Services panel, you configure Security Services for Teamcenter, which provides
single sign-on authentication. Once you enable these services, the users need not enter logon
credentials each time they launch a different Teamcenter product during a single session.
Select Enable Security Services and enter the following information:

Installing or updating Teamcenter with Document Management
Login URL Specifies the complete URL of the Security

Services Login Service Web application.
Service URL Specifies the complete URL of the Security
Identity Service Web application.
Application ID Specifies the application ID of this instance
of Teamcenter in the Security Services
application registry.
If you use Security Services in the Teamcenter web tier application, you must configure Security
Services using Web Application Management as described in the appropriate server installation
guide.
11. Click Next and enter information, as needed, in the subsequent panels.
12. In the Confirmation panel, click Start.

Chapter 5: Installing Business Modeler IDE
You must install Business Modeler IDE to configure Document Management and to import the sample
BMIDE Document Management template (docmgt_samples.xml).
You can install Business Modeler IDE as a standalone application or install it within your existing
Eclipse (Java IDE) environment.
Caution
Install Business Modeler IDE on a machine separate from the one containing your
corporate server.

Chapter 6: Installing Visualization Convert and Print
For rendering documents to different file formats, to generate thumbnails for documents, and to batch
print documents, you must install Visualization Convert and Print with Ghostscript version 8.64 (Asian
font version) as specified in Teamcenter Convert and Print.

Chapter 7: Installing or updating Dispatcher for
Document Management
You require Dispatcher to render documents in different file formats, to generate thumbnails, and for
batch printing by using the appropriate conversion and print translators.
You can install Dispatcher as a standalone instance or in an existing Teamcenter environment. If
Dispatcher is already installed in your existing Teamcenter environment, you must modify it to include
the print and conversion translators.
• Document Management (DocMgt) Translators→RenderMgtTranslator and BatchPrint
• TcVis Translators→PreviewService

Chapter 8: Setting up Teamcenter Office Online
Workflow to set up Teamcenter Office Online

Teamcenter Office Online is used for delivering browser-based versions of Microsoft Word,
PowerPoint, and Excel.
By leveraging Microsoft Office Online Server features, users can edit and view documents within
Active Workspace instead of using the desktop version of the Microsoft Office applications installed
on their computers. This also eliminates the need to install Microsoft Office on the client machines.
However, if your document authors and reviewers use the desktop version, you must enable the
Client for Microsoft Office feature.
Install Microsoft Office Online Server

To access the browser-based version of Microsoft Word, PowerPoint, and Excel, you require Microsoft
Office Online Server. To install this, perform the steps specified in Deploy Office Online Server to
prepare the server that will run Office Online Server and to deploy the Office Online Server farm.
Install Teamcenter Office Online

You install Teamcenter Office Online by using Deployment Center.
Warning
Teamcenter Office Online web service is only supported on an IIS web server. Therefore,
you must first enable IIS and ASP.NET on the machine on which you plan to install
Teamcenter Office Online web service.
1. Start that the Deployment Center web server.
2. Access the Deployment Center web application from a web browser. The format of the
Deployment Center URL is http://host:serverPort/deploymentcenter

Chapter
Chapter 8: 8: Setting
Setting up Teamcenter
up Teamcenter Office
Office Online
Online
Here, host is the server where Deployment Center is installed, and serverPort is the port number
specified by the -serverPort argument in the installation script.
3. Enter the user name and password as specified in the -user and -password arguments of the
Deployment Center installation script.
4. In the Deployment Center home page, click Environments and select the environment where
you want to install Teamcenter Office Online.
5. If Active Workspace is installed, proceed to step Install Teamcenter Office Online. If it is not
installed:
a. In Deploy Software→Software, click Add .
b. In the Available Software panel, select Active Workspace and click Update Selected
Software.
6. Click Go to Options, select Environment Type and Architecture Type, and click Save
Environment Options.
7. Go to Applications and click Add .
8. In the Available Applications panel:

a. Select Teamcenter→Active Workspace→Teamcenter Office Online.
b. Select Extensions→Teamcenter Office Online Web Service.
c. Click Update Selected Applications.
9. Click Go to Components, and then click Start Configuration.
10. In the Teamcenter Office Online Web Service panel:

• Enter Machine Name to specify the machine on which you want to deploy the web service.
• Enter the URL in Microsoft Office Online Server Discovery URL. A sample URL is
http://host/hosting/discovery.
• Enter the credentials of the Teamcenter sponsor in User ID and Password.
• In IIS Settings, select Create new web site.
• In IIS Web Application Pool Configuration, select Create new application pool.
Click Save Component Settings.
11. In the Components panel, click Go to Deploy.
12. In the Deploy panel, click Generate Install Scripts.

Deployment Center generates installation scripts and submits information about the scripts in
the panel on the right.

Setting up Teamcenter Office Online
Deploy Scripts displays the ZIP files that were generated for each server along with the
associated component names. Each ZIP file contains the installation scripts for a single server. If
all the components were installed on a single machine, there is only one ZIP file. The ZIP file
name ends with the target machine name where you run the script.
13. Go to the ZIP file location, copy the Teamcenter Office Online deployment script to the machine
where you want to install it, and extract the contents of the file.
14. Open a command prompt window and navigate to the location where you extracted the file
contents. Run the deploy.bat (Windows) or deploy.sh (UNIX or Linux) script using the following
arguments:
-dcusername Specify the user name for Deployment Center as defined when installing
Deployment Center.
-dcpassword Specify the password for Deployment Center as defined when installing
Deployment Center.
-softwareLocation Specify the location in the -softwareLocation argument, for example,
-softwareLocation=D:\deploy_software
On Windows, if you mapped a shared location for the scripts using the M
drive, you can run deploy.bat without the -softwareLocation argument.
When the installation is complete, the command prompt returns the message Deployment action
successfully completed.
Configure Teamcenter Office Online

Teamcenter Office Online preferences are automatically set when you install Teamcenter Office Online
Web Service. However, you can change the value of these preferences as per your requirement:
• OfficeOnlineServerURL
Specifies the Office Online Server URL to access Discovery XML. The Web Application Open
Platform Interface (WOPI) server identifies a WOPI client through Discovery XML.
Example:
https://tcofficeonline.example.com/hosting/discovery
• OfficeOnlineTimeToLive
Specifies the life span (in seconds) of the Teamcenter access token.
• OfficeOnlineWopiHostURL
Specifies the URL of the Teamcenter Office Online Web Service, also known as the WOPI host.
The WOPI protocol integrates Office Online Server with Teamcenter.
Example:
https://tcooweb.example.com/TcOOWeb/api/wopi
If the port is changed after the Teamcenter Office Online Web Service installation, you must
manually update the port in this preference.

Chapter
Chapter 8: 8: Setting
Setting up Teamcenter
up Teamcenter Office
Office Online
Online
Example:
https://tcooweb.example.com:7009/TcOOWeb/api/wopi
Configure Teamcenter Office Online web service

Set up the Secure Socket Layer protocol
You must set up the Secure Socket Layer (SSL) protocol on Internet Information Services (IIS) for
the TcOOWeb web application, which integrates Office Online Server with Teamcenter. To do so,
refer to How to Set Up SSL on IIS 7.
Enable single sign-on
For providing single sign-on authentication, in the web.config file, ensure that the connection node
has SSO enabled:
<connections SSO_Enabled="true" SSO_AppId="Teamcenter"
SSO_URL="http://teamcenter.example.com:7001/tcssoservice">
Set up sponsored authentication
Teamcenter Office Online uses sponsored authentication, which allows an application integrated with
Teamcenter to log on to Teamcenter using the sponsored mode. Sponsored authentication uses a
sponsoring user, which allows integrated applications to access Teamcenter and perform a task.
Update the sponsor credentials
Update the sponsor credentials in the <tcsecurity> section of the web.config file. However, this
section is encrypted by default, you must first decrypt it by running the following command in the
command prompt window by using Run as administrator:
aspnet_regiis -pdf "tcsecurity" path_to_web.config_file
Example
aspnet_regiis -pdf "tcsecurity" "C:\inetpub\tcooroot\TcOOWeb"
Next, update the credentials:

<tcsecurity> <add key="Sponsorer_Name" value="sponsor1"/> <add key="Sponsorer_Password"
value="default*PW!shouldBeChanged"/> <add key="Sponsorer_TcSSName" value="sponsor1"/> <add
key="Sponsorer_TcSSPassword" value="default*PW!ShouldBeChange"/> <tcsecurity>
After changing the credentials, you must encrypt the <tcsecurity> section by running the following
command in the command prompt window, using Run as administrator:
aspnet_regiis -pef "tcsecurity" path_to_web.config_file
Example
aspnet_regiis -pef "tcsecurity" "C:\inetpub\tcooroot\TcOOWeb"

Setting up Teamcenter Office Online
Update the Teamcenter 4-tier and FSC URLs
Update the Teamcenter 4-tier and FSC URLs in the <tcresources>→<connections> section of the
web.config file. In this section, you must change the server connection URI, assigned FSC URL
(assignedfscurls), and bootstrap FSC URL (bootstrapfscurls), as necessary, for the Teamcenter
and FMS servers.

Chapter 9: Enable Teamcenter Client for Office
Document authors and reviewers can create and review documents in standalone Microsoft Office
applications. They can also edit or view documents by using Microsoft Office applications within the
Active Workspace browser. To use these applications in Active Workspace, you set up Teamcenter
Office Online.
However, if they wish to use the standalone Office applications, you must enable Teamcenter Client
for Office as follows:
1. Locate the client_specific.properties file in the Teamcenter installation directory.
2. In the client_specific.properties file, set the useAppLauncher value to true.

If the rich client runs on a Teamcenter two-tier server, set the
preferred4TierServerUrlForMSOfficeClient value to the URL of the Teamcenter
four-tier server that connects to the same database as the two-tier server, for example,
preferred4TierServerUrlForMSOfficeClient=http://hostname:7001/tc
3. Run genregxml.bat/sh after you update the client_specific.properties file.

Chapter 10: Configuring Document Management

Chapter
Chapter 10:10:Configuring
Configuring Document
Document Management
Management
The different tasks to configure Document Management

Configuring Document Management
Standardizing document formats
Standardizing Microsoft Office documents with templates

You can standardize Microsoft Office document formats by using templates so that it is easier to
create, modify, and review documents. Templates ensure that a consistent format is followed and that
the required fields are available in documents created by users.
Example
You may want a cover page on specification documents but not on other document types,
or you may wish to apply specific distribution statements to different document types.
For such tasks, you can set up templates in which you can specify the attributes exchanged
with Teamcenter, the cover page, and distribution statements as needed. Once this is
done, users start with the information and format specified while creating documents.
You can either import the Document Management sample template file (DMTemplates.xml) or
set up a new Document Management template.
After you release a document template, you use it to standardize a the behavior of a document at
different stages of its lifecyle.

Chapter
Document Management
Management
A document template can also use properties created in Microsoft Office applications by using the
feature Attribute Exchange in Client for Office. Document properties can also be exchange from
Teamcenter to Microsoft Word by using the generic attribute exchange. Doing so provides a way to
link the properties added in a Microsoft Office application to Teamcenter attributes.
Import a sample Business Modeler IDE document template file

1. Install sample files (if not already done during standard installation).
a. Start Teamcenter Environment Manager (TEM).
b. In the Maintenance panel, select Configuration Manager and click Next.
c. In the Configuration Maintenance panel, select Perform maintenance on an existing

configuration and click Next.
d. In the Configuration panel, select the configuration from which the corporate server was
installed. Click Next.
e. In the Feature Maintenance panel, under the Teamcenter section, select Add/Remove
Features. Click Next.
f. In the Features panel, under Server Enhancements, select Sample files.
g. Click Next.
h. In the Confirmation panel, click Start.

The sample docmgt_samples.xml file is placed at the following location:
server-install-location\sample\document_management
i. Copy the document_management folder to another location where it can be referenced

by Business Modeler IDE.
Note
See the readme file at the following location:
server-install-location\sample\document_management
2. Open the docmgt_samples.xml file and use search and replace to change the prefix of SAM9
on the data model items to reflect your own organization's prefix.
Note
When you name a new data model object, a prefix from the template is automatically
affixed to the name in order to designate the object as belonging to your organization,
for example, A4_.
3. Import the docmgt_samples.xml sample file into Business Modeler IDE.

a. Choose File→Import.
The Import wizard runs.
b. In the Select dialog box, choose Business Modeler IDE→Import template file. Click Next.
c. Click the arrow in the Project box to select the project you want to import the sample file into.
d. Click the Browse button to the right of the Template file box and browse to the directory
where the docmgt_samples.xml file is located, and select the docmgt_samples.xml file.
e. Click the arrow in the Extension file box and choose the extension file you want to receive
the document management data model (for example, default.xml).
f. Click Finish.
The data model is imported from the docmgt_samples.xml file to the extension file in the
project.
4. In the Extensions folder, open the Document Management folder to see the samples in the
Dispatcher Service Config, IRDC, Print Configuration, and System Stamp Configuration
folders. The names of the samples each show your project’s naming prefix that you used for
replacing the SAM9 prefix in the docmgt_samples.xml file.
You can use these as the basis for your own dispatcher service configurations and item revision
definition configurations (IRDCs).
5. Deploy your sample BMIDE document template to a test server.
Note
After deploying the IRDC rules, you may need to restart Teamcenter Server Manager
services to ensure that they are available to the new tcserver processes.
6. Perform the following steps to import the DMTemplates file using My Teamcenter in the rich client:
a. Choose Tools→Import→From PLMXML.
b. Click the browse button (...) to the right of the Importing XML File box and select the
following file:
server-install-location\sample\document_management\importdmtemplates\DMTemplates.xml
c. Leave the Transfer Mode Name set to the default value of ConfiguredDataImportDefault.
d. Click OK.
e. Perform the following steps to verify that the import worked:
Note
Depending on the templates loaded on your system, you may be presented with
other options in this sequence of steps.

Chapter
Document Management
Management
A. Choose File→New→Item, select Document in the New Item dialog box, and click Next.
B. Assign the ID and give the document a name. Click Next.
C. Click Next until you get to the DocumentRevision dialog box.
D. In the Document Subject box, select Functional Specification.
E. Click Finish.
F. Verify that the document revision is created successfully and that the correct sample
functional specification Word dataset is attached to the newly created document revision.
G. Create another document and select the Software Design Document value in the
Document Subject box. Verify that the document revision is created successfully and
that the correct sample software design document Word dataset is attached to the newly
created document revision.
Set up a new document template

Create a document template
1. Select the folder where you want to create the document template and click File→New→Item.
2. In the New Item dialog box, select Document Management Template from the Business
Object Type list.
3. Click Next.
4. Type a name and an ID for the document template. You can also click Assign to automatically
generate the item ID and revision identifiers.
5. (Optional) In the Description box, type a description of the document template.
6. Click Finish.
Attach template files to a document template

You create a dataset to hold the document template file. You can also create a dataset to hold
the cover page, if required.
Attach a document to a document template

1. Select the document template revision and click File→New→Dataset.
2. In the New Dataset dialog box, enter a name and description for the dataset.
3. Select a dataset type from the Type bar, for example, MS Word Template.
If you do not see the type you are looking for, click More to display all defined dataset types.
4. Click the browse button next to Import to import the document template file.
In the Upload File dialog box, choose the required file and click Upload.

5. Set Relation as Attaches and click OK.

Attach a cover page to a document template
1. Create a dataset for the cover page.
2. Click the browse button next to Import to import the cover page.
In the Upload File dialog box, choose the required file and click Upload.
3. Set Relation as Document Page Type Relation and click OK.

After you attach a cover page document to the document template, you must set the page type of
the cover page document as follows:
a. Right-click the cover page attached to the document template revision and click Properties
on Relation.
b. In the Properties dialog box, set the Page Type as Cover Page and click OK.
Release a document template
To use the document template in an item revision definition configuration (IRDC) object, the template
and its attached datasets must be in the released status.
To release the template and attached datasets:
1. Select the Document Management template revision.
2. Choose File→New→Workflow Process.
3. In the New Process dialog box, select TCM Release Process from the Process Template list.
4. In the Attachments tab, expand the document template revision and select the datasets to be
released.
5. Click OK.
Standardizing document behavior
Why standardize document behavior

Documents are critical business items and often have their own development life cycle. Document
Management users perform various actions such as creating, checking in, checking out, and revising
documents as a part of that life cycle. They may also review documents for which they may wish to
render files into different formats, batch print documents, and digitally sign PDF documents.
As an administrator, you can define how a document must behave when a user performs these
actions.

Chapter
Document Management
Management
Example
Consider that a user has checked out a specification document authored in Microsoft Word.
You can define the following behavior: when the user checks in the document, a PDF must
be generated. You can also specify that the PDF must include system stamps. You can
also specify a naming convention for the PDF. Further, you can specify the applications
that can be used for marking up the specification document.
To standardize the document behavior, you must:

• Ensure that you have installed Dispatcher with the RenderMgtTranslator and PreviewService
translators. Additionally, you must ensure that you have installed Visualization Convert.
• Create an item revision definition configuration (IRDC) for a document template. You create an
IRDC for each document template. For example, you can create an IRDC for the specification
document template. Similarly, you can create another IRDC for the functional specification
document template.
• Create a dispatcher service configuration for translating the documents (created using the
document template) from the source format (example, Word) to the presentation or derived
format (example, PDF).
• Configure system stamps to include system stamps in the derived format, if required.
Create an item revision definition configuration to standardize document

behavior
An item revision definition configuration (IRDC) defines how a document revision is handled. IRDCs
standardize document revision behavior at specific times in the life cycle, such as document creation,
checkin, checkout, save as, and revise actions.
To create an IRDC:
1. Choose one of these methods:
• On the menu bar, choose BMIDE→New Model Element, type IRDC in the Wizards box,
and click Next.
OR
• Open the Extensions\Document Management folders, right-click the IRDC folder, and
choose New IRDC.
The New IRDC wizard runs.

2. Perform the following steps in the IRDC Base Criteria Page dialog box to create the IRDC object:
a. The Project box defaults to the already-selected project.
b. In the Name box, type the name you want to assign to the new IRDC in the database.
When you name a new data model object, a prefix from the template is automatically affixed
to the name to designate the object as belonging to your organization, for example, A4_.
c. In the Description box, type a description of the new IRDC.
d. Click the Browse button to the right of the Applies to Business Object box to select the
item revision business object for which you are creating the IRDC. You can only select
children of the ItemRevision business object.
e. Click the Browse button to the right of the Condition box to select the condition for which
this IRDC applies. If the IRDC applies to all objects of a type, use the isTrue condition.
You can also create your own conditions.
Only the conditions that have valid signatures appear. For IRDCs, the valid condition
signatures are as follows:
condition-name(ItemRevision)
condition-name(ItemRevision, UserSession)

Chapter
Document Management
Management
Caution
If multiple IRDCs apply to the same business object type, and the values of their
conditions resolve to true during the creation of the business object, the latest
alphabetical condition drives the IRDC selection. The isTrue condition always
takes the highest priority. The system uses it if no other condition is true.
When an IRDC is defined at the parent business object, such as ItemRevision
and when an IRDC condition does not evaluate to true for the child business
objects, the parent business object's condition is evaluated. If this condition is
true, the IRDC defined for the parent is used when the business object is created.
f. If you want to assign a template, click the Browse button to the right of the Create Template
box to select the Document Management template to provide initial source datasets for the
item revision when it is created. The Teamcenter Repository Connection wizard prompts
you to log on to a server to look up the available templates.
You can also import the sample template (DMTemplate) to the server.
g. Click Next.
The IRDC Dataset Criteria Page dialog box is displayed.

3. Perform the following steps in the IRDC Dataset Criteria Page dialog box to specify the source
and derived dataset types for translation for this item revision. For example, you may want
Microsoft Word document datasets to get translated into PDFs.
a. Click the Add button to the right of the Source Dataset table to select the source dataset type.
b. In the Select Source Dataset Type dialog box, perform the following steps in the Select
Source Dataset Type dialog box:
A. Click the Browse button to the right of the Source Dataset box to select the source
dataset business object. Only children of the Dataset business object are displayed.
B. Click the Browse button to the right of the Item Revision Relation box to specify the
relationship the source dataset has to the item revision. The default is TC_Attaches.
To identify the dataset that contains the page information, such as cover page, signature
page, and index page, select the Fnd0DocPageTypeRel relation.
C. Click Finish.
D. Add as many dataset types as need to be defined for the IRDC. The order of the source
datasets is used to resolve the dataset type for attaching files.
Any dataset type such as Text that allows any file extension must be defined last in the
order in the source dataset list. If it is the first in the list, all the source datasets defined
later are ignored when automatically selecting a type for a file extension.
c. Click the Add button to the right of the Derived Dataset table to select the derived dataset
you wish to translate into when translation is performed.

Chapter
Document Management
Management
d. In the Select Derived Dataset Type dialog box, perform the following steps:
A. Click the Browse button to the right of the Derived Dataset box to select the derived
dataset to translate into. Only children of the Dataset business object are displayed.
The derived datasets must be those that the system can generate using the dispatcher
service configuration objects.
B. Click the Browse button to the right of the Item Revision Relation box to select the
relationship between the derived dataset and to the item revision. The default relation is
TC_Attaches.
To identify the dataset that contains the page information, such as cover page, signature
page, and index page, select the Fnd0DocPageTypeRel relation.
C. Select the Required check box to require that the derived dataset be generated. (If the
required derived dataset cannot be generated or located, checkin cannot proceed.)
D. Click Finish.
e. Click Next.

4. In the IRDC Dataset Naming Page dialog box, perform the following steps to specify how the
dataset is named. The name is built using the rows in the sequence in the table. When the
Document Management system creates a new source data file, it concatenates the entries made
in this table (text and specified portions of all the selected attributes) to create the new file name
and then adds the file extension that is appropriate for the dataset type.
a. Click the Add button to the right of the Source Dataset Naming Rule table to specify a
row for the dataset name.
Perform the following steps in the Add Source Dataset Naming Rule dialog box:
A. (Optional) In the Text for Name box, type the name for the dataset.
B. Click the arrow in the Attribute for Name box to select the item revision property to use
as part of the dataset name. This box specifies an attribute of the item revision to be
used in creating the name of the dataset.
C. In the Starting Character box, type a number to specify the starting character position
in the attribute selected for file naming (for example, 1).
D. In the Number of Characters box, type a number to specify the number of characters to
use from the attribute selected for naming (for example, 50).
E. Click Finish. Repeat for each attribute to be used in building the dataset name.
b. Click the Add button to the right of the Derived Dataset Naming Rule table to specify the
row for the dataset name when the dataset is translated into a derived file.

Chapter
Document Management
Management
Perform the following steps in the Add Derived Dataset Naming Rule dialog box. The
common fields are similar to those in the Source Dataset Naming Rule table.
A. In the Text for Name box, type a name for the dataset.
B. Click the arrow in the Attribute for Name box to select the property to use as part of
the dataset name.
C. In the Starting Character box, type a number to specify the starting character position
in the attribute selected for file naming.
D. In the Number of Characters box, type a number to specify the number of characters to
use from the attribute selected for naming.
E. Click the Browse button to the right of the Derived Dataset box to select the type of
business object. Different derived dataset types can be given different names.
F. Click Finish.
c. Click Next.
5. In the IRDC Checkin Page dialog box, perform the following steps to specify the item revision
behavior when it is checked in:
a. Click the arrow in the Derived Visualization Files to Checkin box to support the client side
creation of derived files that are already in the directory with the source files:
• Same File Name
Attaches and checks in the derived files only if they have the same name as the source
dataset.
• Any File Name

Attaches and checks in the derived files no matter what names they have.

• None
Does not attach and check in any derived files.
Because all first level subdirectories are searched for derived files unless this value is
none, source files that reside in a top-level directory such as C:\ or D:\ lead to poor
checkin performance if the Same File Name or Any File Name are selected. The
source files should be placed in a specific directory without any subdirectories before
performing checkin.
b. Click the arrow in the Create Derived Visualization Data box to translate the dataset on
checkin:
• Required
Creates derived files at checkin. If the required derived file cannot be generated or
located, checkin cannot proceed.
• Optional
Creates derived files if possible, but if not, continues to check in the source dataset.
• No
Does not create derived files at checkin. They may be created by the workflow process
or manually later
c. By default, the system translates one dataset type to the derived dataset based upon the sort
order field of the dispatcher service configuration objects. If other source datasets need to be
translated, the Special Render Control Table can be used to define what gets translated.
Click the Add button to the right of the Special Render Control Table to define controls for
file translation.
In the Render Control Wizard Page dialog box, perform the following steps:
A. Click the Browse button to the right of the Derived Dataset box to select the derived
dataset type to apply the controls to. Only children of the Dataset business object are
displayed.

Chapter
Document Management
Management
B. Click the Browse button to the right of the Input Dataset box to select the source dataset
type to translate. Only children of the Dataset business object are displayed.
C. Click the Browse button to the right of the Item Revision Relation box to select the
relationship that the item revision has to the input source dataset. (The listed business
objects are children of the ImanRelation business object.)
D. Click the arrow in the When to Translate box to choose the conditions to translate file
attachments into visualization files:
• Always
Specifies that the attachments should always be translated into derived dataset files.
• If First
Specifies that the attachments must be translated if the source dataset is the first
one found in the table for this derived dataset type. This is because the rows are
processed in order. For example, an item may have an IRDC defined with both
MSWord and MSExcel source files, but a particular item may have only an MSWord
or only an MSExcel file or both. If the table is defined with MSWord to PDF in the
first row and MSExcel to PDF in the second row, and both rows are set as If First,
an item with both files types only gets the MSWord type translated. Similarly, an item
with only an MSWord setting gets the MSWord type translated, and an item with
only the MSExcel setting gets the MSExcel type translated.
E. In the Input File Names box, type a name pattern for the files to be translated. This
restricts translation to files with specific file name patterns. For example, the pattern
*master* translates only those files with master in the file name.
F. (Optional) Click the Browse button to the right of the Derived From Dataset Relation
box to specify the relation that the derived dataset had to the source dataset. The listed
business objects are children of the ImanRelation business object. If specified, the
system uses it to update the derived dataset instead of creating a new dataset during
subsequent render processes.
G. Click the arrow in the Delete On Translate? box and select No unless the input datasets
must be deleted after successful translation. This is actually provided when the checkin
search attaches files that are used for render only such as intermediate postscript files.
H. Click Finish.
d. Click Next.

6. In the IRDC Rules Page dialog box, perform the following steps to configure deep copy rules
for the item revision. Deep copy rules govern how item revisions are copied during save as
and revise operations.
a. Click the arrow in the Delete Data File? box to specify whether the file data attached to the
item revision should also be deleted when the item revision is deleted. Select Yes to delete
the datasets or No to leave it.
b. To create a deep copy rule, click the Add button to the right of the Deep Copy Rules table.
c. Click Next.
7. In the Enter Markup Information dialog box, perform the following steps to configure markup
rules for the document revision:
a. (Optional) Click the Browse button to the right of the Markup Application box to select the
tool to be used for markup, for example, MS Word or PDF_Tool. If specified, markup is

Chapter
Document Management
Management
limited to the specified tool for the item revision dataset file. This is to prevent some users
marking up with Lifecycle Visualization and other users marking up with Adobe tools.
b. Click the Browse button to the right of the Markup Dataset box to select the dataset type to
use for markup. This field is optional. If specified, markup is limited to the specified dataset
types for the item revision dataset file. This is to prevent some users marking up the Word
files and other users marking up PDF files.
c. Select the Markup in Context of Change? check box to indicate whether the markup is
controlled in the context of a change. When the check box is selected, a user can only create
or update the markup if they have selected a change object.
d. Select the Make Markups Official? check box to indicate that all markups should be created
as official markups.
e. In the Markup ACL box, type the name of an access control list to grant access to markups
made on the document. This is to control if other users can see each other’s markups.
f. Click Finish.
The new IRDC appears in the IRDC folder.
8. To save the changes to the data model, choose BMIDE→Save Data Model, or click the Save
Data Model button on the main toolbar.
9. Deploy your changes to the test server. Choose BMIDE→Deploy Template on the menu bar, or
select the project and click the Deploy Template button on the main toolbar. Restart Pool
Manager to get the servers use the new configuration. You must also restart the Dispatcher
client if it is running.
Note
After deploying IRDC rules, you may need to restart TAO services to ensure they
are available to new tcserver processes.
Create a dispatcher service configuration to render documents

Documents can be rendered to different file formats. For example, a Microsoft Word file (source
dataset) can be rendered to a PDF file (presentation or derived dataset). To translate a document
from one format to another, you create a dispatcher service configuration that maps the source and
derived formats. You can set up the translations to occur:
• automatically at specific times in a document's lifecycle (for example, checkin or revise).
• interactively as a result of a user request (for example, the user clicks Render Document or
starts a workflow process in My Teamcenter).
To create a dispatcher service configuration object, choose one of these methods:

1.

• On the menu bar, choose BMIDE→New Model Element, type Dispatcher Service Config
in the Wizards box, and click Next.
OR
• Open the Extensions\Document Management folders, right-click the Dispatcher Service

Config folder, and choose New Dispatcher Service Config.
The New Dispatcher Service Config wizard runs.
2. Perform the following steps in the Dispatcher Service Config dialog box:
a. The Project box defaults to the already-selected project.
b. In the Name box, type the name you want to assign to the new service in the database.
c. In the Description box, type a description of the new service.
d. Select the Service Available check box to make the service available for use. (If this check
box is cleared, it can indicate the service is not to be used temporarily, or the service is
replaced by a different service.)

Chapter
Document Management
Management
e. In the Provider Name box, type the name of your organization as the provider of the service,
for example, Siemens.
f. In the Provider Display Name box, type the name of your organization as the way you
want it to be displayed in the user interface.
g. In the Service Name box, type the name of the translator you want to perform the translation,
for example, previewservice or pdfgenerator.
Note
The previewservice translator requires Lifecycle Visualization Convert and Print.
h. In the Service Display Name box, type a name for the translation service the way you want it
to be displayed on the user interface, for example, MSWord to PDF.
i. Click the arrow in the Priority box to select the importance of this service configuration
when a queue of multiple configurations is awaiting execution by Teamcenter Dispatcher.
Select Low, Medium, or High. Configurations with a high priority are executed first, while
those with a low priority are executed last.
j. In the Sort Order box, enter a number to assign the precedence for this Dispatcher service
when multiple source dataset types are available to create a given output. The dispatcher
RenderMgtTranslator translator module uses the highest sort order number when multiple
service configurations are available. The lowest number entered in this box is considered to
have the lowest sort order.
Tip
For a selected business object, the Document Management system normally
renders only one dataset type for a specified derived dataset type. It looks for the
renderable dataset type based on the sort order for translation of that dataset
type into the specified derived dataset type. Once rendered, the system does
not use any other dataset type to render dataset types into the same derived
dataset type for the specified business object. This behavior can be overridden by
using the Special Render Control Table table in the IRDC Checkin Page dialog
box when creating an IRDC. To specify the source and derived dataset types for
visualization translation, use the IRDC Dataset Criteria Page dialog box when
creating an IRDC.
The following table illustrates the effect of the sort order setting when Microsoft
Office dataset types are rendered. Assume that on the IRDC Dataset Criteria
Page dialog box that the Source Dataset table lists the MSWord, MSExcel, and
MSPowerPoint types, and the Derived Dataset table lists the PDF type. There
is no IRDC derived dataset naming rule defined for this example, so the derived
dataset name is based on the source dataset named reference file name. In all
examples, multiple renderable dataset types are attached to the ItemRevision
business object, and the output derived dataset types are in PDF format.

Source dataset Derived dataset

(input) Sort order (output) Comments
MSWordA.doc MSWord = 3 MSWordA.doc.pdf Translate the

MSWordB.doc MSExcel = 2 MSWordB.doc001.pdf MSWord dataset
MSWordC.doc MSPowerPoint = 1 MSWordC.doc002.pdf type because
MSWord is the only
attached source
dataset type.
MSExcelA.xls MSWord = 3 MSExcelA.xls.pdf Translate the

MSExcelB.xls MSExcel = 2 MSExcelB.xls001.pdf MSExcel dataset
MSExcelC.xls MSPowerPoint = 1 MSExcelC.xls002.pdf type because
MSExcel is the
only attached source
dataset type.
MSWordA.doc MSWord = 3 MSWordA.doc.pdf Translate the

MSExcelA.xls MSExcel = 2 MSWord dataset
MSPowerPointA.ppt PowerPoint = 1 type because it has
the highest sort
order.
MSWordA.doc MSWord = 2 MSExcelA.pdf Translate the

MSExcelA.xls MSExcel = 3 MSExcel dataset
MSPowerPointA.ppt MSPowerPoint = 1 type because it has
the highest sort
order.
Note
The derived dataset name is composed as follows:
source-dataset number.file-extension
Here, source-dataset is the source dataset named reference file name including its
extension, number is a three-digit sequence starting at 001 (for multiple datasets)
and file-extension is the derived dataset type file type extension.
The IRDC Derived Dataset Naming Rule table can be used to specify the base
name for the derived dataset. However, the three-digit sequence and file extension
are appended to the base name.
k. If you want to pass arguments to the translator application that executes the translation, click
the Add button to the right of the Service Arguments table.
The Dispatcher Service Argument wizard runs.

Chapter
Document Management
Management
l. Perform the following steps in the Dispatcher Service Argument Wizard Page dialog box:
A. In the Name box, type a name you want to assign to this service argument.
B. In the Key box, type the service argument. For example, if you want to pass a true
or false (logical) argument, type true or false. You can also type a number (integer)
or text (string).
C. Click the arrow in the Interface Type box to select the kind of value of the argument:
• Logical
A Boolean value of True or False.
• Integer
An integer without decimals from 1 to 999999999.
• String
A string of characters.
D. In the Default box, type the default value to use for the service argument. The key
and its default value are passed to the translator application as additional command
line arguments. For example, the thumbnail translation uses these values to pass the
thumbnail size to the previewservice translator for the prepare program.
E. Click Finish.
The argument is added to the Service Arguments table.
m. Click Next.
The Dispatcher Service Config Relation Page dialog box is displayed. Use this page to set
up the dataset type to be translated and the type it is translated to.

n. Perform the following steps in the Dispatcher Service Config Relation Page dialog box:
A. Click the Browse button to the right of the Source Dataset Type Name box to select the
input dataset type to be translated.
For example, if you want to translate a Word document, select MSWord.
B. Click the Browse button to the right of the Derived Dataset Type Name box to select the
output dataset type you want to translate into.
For example, if you want to translate into PDF, select PDF.
C. Click the Browse button to the right of the Source Dataset Named Reference box to
select the kind of named reference that the source dataset uses.
Datasets are often used to manage several different types of files. These files are the
named references of the dataset. Each dataset type uses a predefined set of named
references. For example, if your source dataset is an MSWord dataset type, select
Word for the named reference.
D. Click the Browse button to the right of the Derived Dataset Name Reference box to
select the kind of named reference that the derived dataset uses.
For example, if the translated file type is PDF, select PDF_Reference.
E. Click the Browse button to the right of the Derived from Dataset Relation box to
select the relationship that the derived dataset has to the source dataset, for example,
TC_Derived. The source dataset is the primary object and the derived dataset is the
secondary object. This is optional. If it is not defined, each time the source dataset is
translated, a new derived dataset is created. If this relation is defined, it is used to locate
the existing derived dataset and update its named reference file.
F. Click the Browse button to the right of the Item Revision Relation box to select the
relationship that the derived dataset has to the source document revision, for example,
TC_Attaches. The source document revision is the primary object and the derived

Chapter
Document Management
Management
dataset is the secondary object. This is optional, and TC_Attaches is the default relation.
The IRDC Derived Dataset table can specify the item revision relation that overrides this.
G. Click Finish.
The configuration appears in the Dispatcher Service Config folder.
3. To save the changes to the data model, choose BMIDE→Save Data Model, or click the Save
Data Model button on the main toolbar.
4. Deploy your changes to the test server. Choose BMIDE→Deploy Template on the menu bar, or
select the project and click the Deploy Template button on the main toolbar.
5. Verify that the new service is made available to Teamcenter and that it works properly:
a. Ensure that the translation capability (Dispatcher) is installed and configured for Teamcenter,
including document render.
b. Create an IRDC that uses the same source dataset type as the service configuration.
The IRDC must be set up to translate the source dataset type that attached to an item
revision (or its subtype) to a derived dataset type. After the item revision is submitted for
render that matches the defined IRDC (based on the IRDC’s condition), the Document
Management Render Management Dispatcher Client looks up the dispatcher service for the
given source dataset. The client performs the translation of the source dataset file to the
derived dataset type (for example, from MSWord to PDF). If the derived dataset is created
then, the dispatcher service configuration is setup correctly.
c. To further verify, perform the following steps:

A. In the My Teamcenter application in the rich client, select an item revision, or any
subtype of item revision such as a document revision. It must be under item revision
definition configuration (IRDC) control, and must use the source dataset type you set up
in the new service.
B. Choose Translation→Render Document.

The Render Document Selection dialog box is displayed.
C. For the Existing File option, select Preserve to retain the existing translated file or
Replace to replace it.
D. Click Finish to submit for render.

The translation request is created. Choose Translation→Request Administration
Console to view the translation request in the queue awaiting translation.
E. After the translation is complete, check the translated dataset to ensure it was translated
properly.
Create a system stamp configuration to set system stamps

1. Run Business Modeler IDE.

2. Choose one of the following methods:

• On the menu bar, choose BMIDE→New Model Element, type System Stamp Configuration
• Open the Extensions\Document Management folders, right-click the System Stamp

Configuration folder, and choose New System Stamp Configuration.
The New System Stamp Configuration wizard runs.
3. Perform the following steps in the Create a System Stamp Configuration object dialog box:
a. In the Name box, type the name you want to assign to the new system stamp configuration
object in the database. Because stamp configurations are associated with business object
types, you may want to name the configuration according to the business object, for example,
prefixItemRevisionStamp.
b. In the Description box, type a description for the new system stamp configuration object.
c. Click the Browse button to the right of the Business Object box to select the business
object that this stamp applies to, for example, ItemRevision.
d. Click the Browse button to the right of the Condition box to select the condition under which
this stamp is applicable, for example, isTrue.
e. In the Applies To box, select one of the following:

• Print

Chapter
Document Management
Management
Prints the system stamp for batch print operations only. The system stamp is not added
to the PDF file for render operations.
• Render
Adds the system stamp to the PDF file for render operations. The system stamp is not
printed for batch print operations.
• PDF_Control
Adds the system stamp to the PDF file for PDF control operations only.
• PrintAndRender
Adds the system stamp for print and render operations.
Note
The Print, Render, and PrintAndRender operations use the MetaDataStamp
(MDS) file. The PDF_Control operation uses the PDF Control Command XML file.
f. Select the Include User Name? check box to include the print requester's name at the end
of the system stamp on the printed documents.
g. Select the Include Date and Time? check box to include the date and time at the end of the
system stamp on the printed documents.
h. Click Next.
4. In the Stamp Information dialog box, perform the following steps in the Stamp Information
dialog box:

a. Click the Add button to the right of the Properties table to include an object's properties on
the printed documents or on the generated PDF file for render operations or on the PDF file
for PDF control operations.
The Property Prefix wizard runs.
Perform the following steps in the New Prefix Property dialog box.
A. (Optional) In the Prefix box, type a prefix, such as Document name:. This precedes
the properties.
B. Click the arrow in the Property box to select properties, such as its name (object_name),
and description (object_desc).
C. Click Finish.
b. In the User Stamp box, type text that you want to appear on the document, such as Internal
Distribution or Not Current if Printed.
c. In the Watermark box, type text that you want to appear as a watermark, such as Confidential.
d. Click the Browse button to the right of the MDS Template box to specify a metadata stamp
template.
The the MetaData Stamp (MDS) template controls how the stamp elements are applied
during batch printing and document rendering. The MDS template must be saved on the
server as a Document Management template (DMTemplate) object. You can either import a
sample document template or create new templates. The template can contain either the
MDS file or the PDF Control Command XML file.
If the MDS template is not selected, a system stamp or a user stamp is not applied to the
printed document.
e. Click Finish.
The stamp configuration is displayed in the System Stamp Configuration folder.
5. To test the stamp, run a batch print on the type of object for which the stamp is created, such as
an item revision. If the Stamps Supported check box is selected in the print configuration object
for the dataset type, the stamp is automatically placed on the printed documents.

Chapter
Document Management
Management
Configuring generic attribute exchange between Teamcenter and

Microsoft Word documents
How to configure generic attribute exchange

With generic attribute exchange, document properties and content can be exchanged from
Teamcenter to Microsoft Word, thereby reducing the need for typing out properties or content in both
places. You also ensure that up-to-date information is available in both the Teamcenter environment
and Word documents.
As an administrator, you must configure this generic attribute exchange by using logical objects.
Logical objects are used to represent logical views of complex data models in terms of a simplified
structure of members and properties. They are composed of root object, member objects, and
presented properties:
• Root object is the object from which the member objects can be traversed. For Document
Management, the root object is Dataset.
• Member objects are the objects that are traversed through references and relations, starting from
the root object. For Document Management, the member objects can be Document Revision or
Item Revision.
• Presented properties are the properties selected from the root and member objects and added
onto logical objects as first-class properties. For Document Management, presented properties
can be last modified date, created by, created on, and so on.
Workflow to configure generic attribute exchange
Define logical objects

1. In Active Workspace, log on with DBA credentials.
2. Click the LOGICAL OBJECTS tile on the home page.
3. On the Logical Object Configuration page, click Define Logical Object .
4. In the Add panel:

a. Enter Internal Name, Name, and Description for the logical object.
b. In the Root Object section, click Add Root Object . For example, search for Dataset,
and click Add.
c. In the Parent Logical Object section, click Add Parent Logical Object . For example,
search for Logical Object, and click Add.
d. Click Add.
5. In the Overview tab, click Add Member to add new members to the logical object.
6. In the Add Member panel:

a. Enter Member ID and Display Name.
b. To get the attribute values from the business object (for example, document revision) to
which the dataset is attached, select Backward in Segment 1.
You can traverse forward or backward with relationships and business objects. For datasets,
you always start with traversing backward.
c. Select Business Object, for example, Document Revision.
d. Select Relation or Reference, for example, Tc_Attaches.
e. Click Add.
7. Click Add Member again to add another member to the logical object to relate the business
object with the dataset by using a different relation.
8. In the Add Member panel:

a. Enter Member ID and Display Name.
b. Select Backward in Segment 1.
c. Select Business Object, for example, Document Revision.
d. Select Relation or Reference, for example, Tc_Attaches.
e. Click Add Segment in Segment 2.
f. Select Forward.
g. Select Relation or Reference, for example, items_tag.
h. Select Business Object, for example, Document.
i. Click Add.
9. For each member, add member properties that you want to consider for document rendering.
To do so:
a. Select the member first and then select a property, for example, Display Name.

Chapter
Document Management
Management
b. In Presented Properties, click Add .
c. In the Add Property panel, select a property of the member, for example, fnd0Root.
d. In Member Properties, select required property, for example, last_mod_date.
e. Click Add.
You can add as many properties as required for each member.
Relate logical objects with datasets

You can relate one or more logical objects to a dataset. To do so:
1. In My Teamcenter, search for the document item revision and expand it to view its dataset.
2. Right-click the dataset and click Edit Properties.
3. In the Edit Properties dialog box, add the logical object that you created for the document item
revision in Logical Object Type Relation. To do so:
a. Click Edit first and then Add .
b. Select the logical object that you want to relate.
c. Click Save and Check-In .
Update the business object constant for generic attribute exchange

1. In BMIDE, locate the business objects, for example, document revision or item revision.
2. In the Business Object dialog box, click the Business Object Constants tab.
3. Click Edit to add a new business object constant, Fnd0TriggerLOAttrExch, with the following
list of values:
• Disabled
This value indicates that the generic attribute exchange will not be triggered automatically.
This is the default value.
• Configured
This value indicates that the generic attribute exchange will be triggered automatically and
the value of the Fnd0RelToDatasetForLOAttrExch business constant is considered for the
relations to traverse from the item revision to the dataset.
• Enabled
This value indicates that the generic attribute exchange will be triggered for all datasets
attached to the item revision.
4. Add another business object constant, Fnd0RelToDatasetForLOAttrExch, to control the

relations between item revisions and datasets. You can add a list of values such as Tc_Attaches
or IMAN_specification to this business object constant. These values indicate that if datasets

are related to logical objects through these relations, the generic attribute data exchange will be
triggered for these datasets.
5. Click Finish.
Set up custom properties in Microsoft Word

You must add each property that you defined for a logical object member in Active Workspace as a
custom property in Microsoft Word. To do so:
1. Check out the required template file.
2. In Word, click File→Info→Properties→Advanced Properties.
3. In the Properties dialog box, click Custom.
4. Enter the ID of the member property in Name.
5. Select Type.
6. Enter the information in Value. As a default value is required, enter either a space or information
that must be displayed in the document.
7. Click Add.

Chapter
Document Management
Management
8. Add other required properties and finally click OK.
9. To insert the newly created custom properties :

a. In Word, place the cursor at the location where you want to enter a custom property and
click INSERT→Quick Parts→Field.
b. In the Field dialog box, select DocProperty in Field names and select a custom property
that you created in Property.
c. Click OK.
The value of the custom property is inserted at the selected location.
10. Check in the template file into Teamcenter.
Verify the generic attribute exchange configuration

To verify if you have configured generic attribute exchange correctly, you can perform one of the
following:
• Start a workflow process by using the DOCMGT-update-docprop-logicalobject workflow
handler.
• Create, check in, revise, save as, or render a document revision. Verify that attributes are
automatically filled in the Word document.
If a distribution statement is configured for the document revision, the statement is inserted into
the Word document during generic attribute exchange.
Automating the document rendering process

A document can be rendered into different file formats. For example, a Microsoft Word document
(source dataset) can be rendered into a PDF file (derived format). Document rendering can occur:
• As a result of another process such as document create or checkin.
• When a user manually renders a document by clicking Translation→Render Document on the

user interface.
• When the user starts a workflow process to render documents. For this, you must set up a
workflow process task by using the DOCMGT-render-document-revision workflow action
handler.
As a administrator, you can automate the document rendering process so that a document is
automatically rendered into different file formats. You can also set system stamps to be automatically
added to the rendered documents.
To automate the document rendering process, you must:
• Ensure that you have installed Dispatcher with the RenderMgtTranslator and PreviewService
translators. Also, ensure that you have installed Visualization Convert.

• Create a dispatcher service configuration for translating the documents from the source format
(example, Word) to the presentation or derived format (example, PDF).
• Configure system stamps to include the stamps in the derived format, if required.
Supported source and derived formats for document rendering
Source format Derived format

Microsoft Office (Word, Excel, PowerPoint), PostScript PDF
Microsoft Office (Word, Excel, PowerPoint) PostScript
Microsoft Office (Word, Excel, PowerPoint) TIF
DXF, HPGL, Text, PostScript, PDF Thumbnail (JPEG)
Microsoft Office (Word, Excel, PowerPoint, and Project), PostScript, PDF
Encapsulated PostScript (*.eps), Adobe Photoshop (*.psd),
WordPerfect, Rich Text, Bitmap. GIF, JPEG, TIFF, and multipage TIF
Configuring document printing
Setting up document printing

As an administrator, you can set up the document printing process so that users can print documents
without opening the documents in a native editing application. This printing functionality is called
as batch printing in Teamcenter. This is because users can print all documents attached to a
document revision in a batch.
You can also set up banner pages to be printed during a batch printing process. Banner pages are
used to separate and organize print jobs. A banner page helps in identifying the end of a document
and the start of another document during batch printing.
Further, you can also set up system stamps to be included in the printed documents.
To set up document printing:
• Ensure that you have installed Dispatcher with the BatchPrint and PreviewService translators.
Also, ensure that you have installed Visualization Print.
• Create a print configuration to define the batch print settings.
• Specify banner pages, if required.
• Configure system stamps to include the stamps in the printed documents, if required.
Create a print configuration to define print settings

A print configuration object defines the batch print settings. When a user batch prints a document, all
the datasets associated with the document are printed.
To create a print configuration object:
1. Run the Business Modeler IDE.

Chapter
Document Management
Management
2. Choose one of these methods:

• On the menu bar, choose BMIDE→New Model Element, type Print Configuration in the
Wizards box, and click Next.
• Open the Extensions\Document Management folders, right-click the Print Configuration

folder, and choose New Print Configuration.
The New Print Configuration wizard runs.
3. Perform the following steps in the Create a Print Configuration object dialog box:
a. In the ID box, type the name you want to assign to the new print configuration object in
the database.
b. In the Description box, type a description for the new print configuration object.
c. In the Provider Name box, type siemens as the provider of the service.
d. In the Provider Display Name box, type the name of your organization as you want it to
display in the user interface, for example, Siemens PLM Software.
e. In the Service Name box, type batchprint as the name to assign this print configuration.

f. In the Service Display Name box, type the name of the service as you want it to display in
the user interface, for example, Batch Print Service.
g. If you want to pass arguments to the application that executes the batch print, click the Add
button to the right of the Dispatcher Service Arguments table.
The Dispatcher Service Argument wizard is displayed.
Perform the following steps in the Dispatcher Service Argument Wizard Page dialog box:
A. In the Name box, type a name you want to assign to this service argument.
B. In the Key box, type the service argument. For example, if you want to pass a true
or false (logical) argument, type true or false. You can also type a number (integer)
or text (string).
C. Click the arrow in the Interface Type box to select the type of value of the argument:
• Logical
A Boolean value of True or False.
• Integer
An integer without decimals from 1 to 999999999.
• String
A string of characters.
D. In the Default box, type the default value to use for the service argument. The Key
value overrides the Default value.
E. Click Finish.
The argument is added to the Dispatcher Service Arguments table.
h. Click Next.

Chapter
Document Management
Management
4. In the Print Settings dialog box, perform the following steps:

a. Click the Browse button to the right of the Printer Name box to select the networked printer
where this print configuration will be printed.
Note
To obtain available printer names, Business Modeler IDE must be installed on the
same workstation as Lifecycle Visualization.
On Linux systems, define the printer in the vvcp.operating-system.cfg file, and
click the Browse button to the right of the Printer Name box to browse to the
location of this file.
b. Click the Add button to the right of the Paper Sizes table to select paper sizes to make
available for print batch jobs.
c. Click the Add button to the right of the Supported Datasets table to select the dataset types
that can be printed, such as MSWord and MSExcel.
d. Select the Stamps Supported check box to allow stamps on the printed documents such as
the date or a watermark. If object types are printed for which stamps are configured, stamps
are automatically placed on the printed documents.
e. Click Finish.

The print configuration object is displayed in the Print Configuration folder.
f. Deploy the template from the Business Modeler IDE.
g. Restart the pool manager and restart the Teamcenter server
5. Test the batch print.

a. Ensure that document rendering is installed for the rich client. (The batch print menu action is
included with the render action.) In the Features panel of Teamcenter Environment Manager
(TEM), choose Extensions→Enterprise Knowledge Foundation→Dispatcher Client for
Rich Client and Render Document for Rich Client.
b. In My Teamcenter in the rich client, select an object with associated documents, such as an
item revision, and choose Translation→Batch Print.
Your print configuration is displayed in the Print Configuration menu. Click Finish to print
the documents.
c. To monitor printing, choose Translation→Administrator Console. Press Shift + F5 to

refresh the view.
Specify banner pages

Banner pages are used to separate and organize print jobs. For example, you can use banner page
when numerous print jobs are sent to one or more printers, and you want to distinguish where one
job ends and another begins.
To specify banner pages:
1. Open the Lifecycle Visualization print configuration file (vvcp.ini file on Windows systems and
vvcp.platform.cfg on Linux systems).
This configuration file is created in the ...\Visualization\VVCP directory on Windows systems (or
the visualization/app_defaults directory on Linux systems) when Convert and Print is installed
by the Lifecycle Visualization installer or by Teamcenter Environment Manager (TEM).
2. Set the following attributes:

• Banner
Specifies banner pages for all printers.
• PrinterBanner
Specifies the banner page for a specific printer. This overrides the Banner setting for the
specified printer.
• BannerFormat
Specifies either text (TXT) or metadata stamping (MDS) format for banner page processing.
o BannerFormat=mds (BannerFormat: mds on Linux systems)

The banner page is a stamp file printed without an underlying image. All the MDS
commands are supported except \File and \FilePath.

Chapter
Document Management
Management
o BannerFormat=txt (BannerFormat: txt on UNIX systems)

The banner page content comes from a text file.
TXT format supports only the following MDS commands:
\Attribute
\Copies
\Date
\Time
Note
You must not provide values for BannerInfo and PrinterBannerInfo. Teamcenter
provides these values.
For information about configuring banner page printing, see the Introduction to Convert and Print
guide provided with the Lifecycle Visualization application Convert and Print software.





• Print
• Render
• PDF_Control

Chapter
Document Management
Management
• PrintAndRender
Note
h. Click Next.
dialog box:

the properties.
C. Click Finish.
template.
printed document.
e. Click Finish.
Defining printer device and page specifications for UNIX printing

You can use the *Printers: section of the /app_defaults/vvcp.operating-system.cfg configuration file
to configure UNIX printers and plotters and to define page specifications.

Chapter
Document Management
Management
Configure printer syntax

printername DEVICE printertype {,density {,margin} ,other} \n\
Configure printer arguments
The arguments in the following table can be used to configure UNIX printers for batch printing.
Argument Purpose
printername Identifies the printer from the command line.
printertype Specifies the data accepted by the defined printer.
density Specifies the default density in pixels-per-inch format.
This setting is supported by raster and PostScript printers.
margin Specifies the margin for each page.
Printer hardware preferences often set the margin value.
Check your printer documentation to determine if margin
settings can be set using software preferences.
Other Include any other printer specifications provided by your
printer.
Units Specifies the unit of measure for the coordinate system.
This setting supports inches or centimeters. If omitted,
the default setting is inches.
Examples
printername DEVICE HPGL \n\
PS1 DEVICE Postscript,300,0.5,0,0,0,0 in \n\

PS2 DEVICE Postscript,300,1.27,0,0,0,0 cm \n\
HP1 DEVICE HPGL \n\
Define pages syntax

printername PAGE sizespec {text}{,window-coordinates}printcommand \n\
Define pages arguments
The arguments in the following table can be used to define page specifications.
Argument Purpose
printername Identifies the printer from the command line.
Each printer or plotter can have one or more page
specifications.
sizespec Specifies the mnemonic page size.
Supported mnemonics include:
{A|B|C|D|E|J|A4|A3|A2|A1|A0}

Argument Purpose
Text Specifies comment text.
Spaces are supported and commas are not.
printer coordinates Lists the printer coordinates from the lower-left corner to
the upper-right corner of the drawing using the printer
coordinate system (llx, lly, urx, ury).
Coordinates must be separated by commas.
printcommand Specifies printer commands to create printed output.
Enclose the entire string in double quotation marks ("
"). If quotation marks are required within the string, use
single quotation marks (' '). In addition, you can use an
exclamation mark (!) to pipe output into a UNIX command.
Notes
• You can use sample entries as guides when defining your printer and page setup.
• For PostScript and raster-based printers, if the printer uses the lower-left corner as the origin,
the first two values should be 0,0 (default value). To calculate the upper-right corner value,
multiply the sheet size by the density.
• HPGL-based printers use printer logical units (PLUs) to measure the coordinate system. Each
PLU is 1/40 mm; therefore, there are 1016 PLUs per inch.
• Several HPGL printers place the origin in the middle of the paper. This defines the lower-left and
upper-right corners to be symmetric around the origin (0,0). For example, the entry for an A-sized
sheet for an HP7580 is [-4318,-5588,4318,5588].
Examples
• This example defines a PostScript printer with a density of 300 dpi and a margin of 0.5 inch.
To define a PostScript printer with a density of 300 dpi and a margin of 0.5 inch, type the following
line in the configuration file:
To create a portrait A-sized page definition, type the following line in the configuration file:
PS1 PAGE A (8.5x11 in),0,0,2550,3300 "!lpr" \n\
The page definition is determined by multiplying the A-size dimensions by the density (8.5 X
11) * (300).
x-axis y-axis
x dimension = 2550 pixels (8.5 in. * y dimension = 3300 pixels (11 in. * 300 dpi)
300 dpi)
The first line in the example configuration file shows a defined printer (DEVICE), and the second
line shows a defined page size (PAGE).

Chapter
Document Management
Management

PS1 PAGE A (8.5x11 in),0,0,2550,3300 "!lpr" \n\
• This example specifies an HPGL printer that has an automatic density setting equal to printer
logical units (PLUs) and a beginning origin in the lower-left corner.
To specify the HPGL printer, type the following line in the configuration file:
HP1 DEVICE HPGL \n\
To create a page definition specifying a portrait A-sized sheet with its origin in the lower-left
corner, type the following line in the configuration file:
HP1 PAGE A (8.5x11 in),0,0,8636,11176 "!lpr" \n\
The page definition is determined by multiplying the A-sized dimension by the PLUs. You may
find it easier to perform the calculations if you convert the dimension to millimeters.
x-axis y-axis
x dimension = 8636 y dimension = 11176
(8.5 in. * 25.4) * 40PLU (11 in. * 25.4) * 40PLU
The first line in the example configuration file shows a defined printer and the second line shows
a defined page size.
HP1 DEVICE HPGL \n\

HP1 PAGE A (8.5x11 in),0,0,8636,11176 "!lpr" \n\
UNIX configuration file example

! ======================================
! PRINTER SETTINGS
! ======================================
![Printers]
! Set unix printer configuration information !
! NOTES:
! 1) To use a printer on unix, you must either use the standard mechanism
! (which requires setting up the following configuration) or one of the
! alternative mechanisms (please see the documentation for more information
! on these).
! 2) THE FOLLOWING CONFIGURATIONS INCLUDE SAMPLE VALUES, BUT MAY NOT BE
! APPROPRIATE FOR YOUR ENVIRONMENT. PLEASE FOLLOW THE INSTRUCTIONS IN THE
! MANUAL TO ADJUST THESE VALUES BEFORE CALLING CUSTOMER SUPPORT.
! 3) The printer section should be set up as follows:
! ------------------------------------------------------------------------
-----
! lp-device DEVICE POSTSCRIPT [density, margin,x-offset,y-offset],-1,-1 in \n\
! lp-device PAGE A (8.5x11 in),x-offset,y-offset,width,height [file/device] \n\
! OR
! lp-device DEVICE HPGL \n\
! lp-device PAGE A (8.5x11 in),lx,ly,ux,uy \n\
! ------------------------------------------------------------------------
-----

Preview*plotters: \
Std-Post DEVICE POSTSCRIPT,300,0,0,0,-1,-1 in \n\
Std–Post PAGE A (8.5x11 in)),0,0,2550,3300 "!lp -d<device>” \n\
Std-Post PAGE B (11x17 in),0,0,3300,5100 "!lp -d<device>” \n\
Std-Post PAGE C (17x22 in),0,0,5100,6600 "!lp -d<device>” \n\
Std-Post PAGE D (22x34 in),0,0,6600,10200 "!lp -d<device>” \n\
Std-Post PAGE E (34x44 in),0,0,10200,13200 "!lp -d<device>” \n\
Eur-HPGL DEVICE HPGL \n\
Eur-HPGL PAGE A4 (21x29.7 cm),0,0,8400,11880 "!lp
-d<device>” \n\
Eur-HPGL PAGE A3 (29.7x42 cm),0,0,11880,16800 "!lp -d<device>” \n\
Eur-HPGL PAGE A2 (42x59.4 cm),0,0,16800,23760 "!lp -d<device>” \n\
Eur-HPGL PAGE A1 (59.4x84.1 cm),0,0,23760,33640 "!lp -d<device>” \n\
Eur-HPGL PAGE A0 (84.1x129.7 cm),0,0,33640,51880 "!lp -d<device>” \n\
Provide access privileges for batch printing

Teamcenter provides access control lists (ACLs) for managing batch printing information.
The following ACLs are located in Access Manager under Has Class(POM_application_object):
• Batch Print Item
Batch print action privileges for items.
Working→Has Class(Item)→Batch Print Item
• Batch Print Item Revision

Batch print action privileges for item revisions.
Working→Has Class(Item Revision)→Batch Print Item Revision
• Batch Print Dataset

Batch print action privileges for datasets.
Working→Has Class(Dataset)→Batch Print Dataset
You can modify these ACLs or create others using Access Manager.
Note
Commercial off-the-shelf (COTS) ACLs do not grant World batch print access privilege.
To print dataset files you do not own, the ACLs must be modified to grant batch print
access privileges.

Chapter
Document Management
Management
Configuring system stamps
Setting up system stamps

A system stamp can consist of your user name, the print date and time, distribution statements, logos,
watermarks, and other specified document revision attributes. To set system stamps, you:
• Create a system stamp configuration. User stamps can be appended to the system stamp.
• Set up logos and distribution statements. Currently, you can add logos only to PDF files and
distribution statements only to Microsoft Word files.
• Set a metadata stamp file to add system stamps during the PDF rendering and printing processes.
After setting up system stamps, you add them to PDF or Microsoft Office files.
To insert the stamps (except the distribution statement) in PDF files:
• Use the DOCMGTAPP-apply-pdf-control workflow action handler.
• Render files in different file formats, using the RenderMgtTranslator Dispatcher translator. For
the document rending to occur, ensure that you have automated the document rending process.
• Print files, using the BatchPrint Dispatcher translator. Ensure that you have configured batch
printing.
To insert distribution statements in Microsoft Word files:

• Use the DOCMGTAPP-update-docprop-logicalobject workflow action handler.
• Create a new Word file or render another file into Word file format. The distribution statement is
immediately added in the file.
You can also check-in, revise, or save the Word file. The distribution statement is asynchronously
added to the file by the RenderMgtTranslator Dispatcher translator.
Ensure that you have configured generic attribute exchange and installed Dispatcher with
RenderMgtTranslator.





• Print
• Render
• PDF_Control

Chapter
Document Management
Management
• PrintAndRender
Note
h. Click Next.
dialog box:

the properties.
C. Click Finish.
template.
printed document.
e. Click Finish.

Chapter
Document Management
Management
Setting up logos and distribution statements
How to set up logos and distribution statements

Currently, you can add logos only to PDF files and distribution statements only to Microsoft Word
files. You can add multiple logos and distribution statements. After setting up logos and distribution
statements, you can insert them in respective files by using the appropriate workflow handler,
rendering files, and printing files.
Setting up logos
• Ensure that the logo image file is attached to a Document Management template.
• Set up a system stamp configuration.
• Create a dataset for each logo that you want to include in a PDF file.
• Create a dataset for the Document Management configuration XML file. The configuration file
contains information about logos and steps on how to enable logos.
You can use the sample configuration file (DocMgmtConfig.xsd)
to create your own configuration file. The sample file is located at
TC_ROOT\sample\document_management\importdmtemplates. You can view the
sample configuration file directory only if you install the Sample Files feature (in Teamcenter
Environment Manager).
• To insert logos in existing PDF files by using the DOCMGTAPP-apply-pdf-control workflow

action handler, update the PDF Command XML file attached to the released logo dataset. This
file specifies where logos must be placed in the PDF files.
• To insert logos during PDF rendering or printing processes, set a Meta Data Stamp (MDS) file
with the logo placement information.
For the PDF rendering process, ensure that Applies To is set as Print or PrintAndRender in the
system stamp configuration. And, for the PDF printing process, ensure that Applies To is set as
Render or PrintAndRender.
Additionally, ensure that Dispatcher with RenderMgtTranslator and BatchPrint translators is
installed and running.
Setting up distribution statements

• Ensure that the distribution statement Word file is attached to a Document Management template.
• Set up a system stamp configuration.
• Create a dataset for each distribution statement that you want to include in a Word file.
• Create a dataset for the Document Management configuration XML file. The configuration file
contains information about distribution statements and steps on how to enable them.
You can use the sample configuration file (DocMgmtConfig.xsd)
to create your own configuration file. The sample file is located at
TC_ROOT\sample\document_management\importdmtemplates. You can view the

sample configuration file directory only if you install the Sample Files feature (in Teamcenter
Environment Manager).
• Define the placement of distribution statements in Word files.
• Configure generic attribute exchange to insert distribution statements when you create, check
in, revise, save as, or render a file.
Create datasets for Document Management configuration file, logos, and distribution
statements
Currently, you can add logos only to PDF files and distribution statements only to Microsoft Word files.
You can add multiple logos and distribution statements. You must create a dataset for each logo and
distribution statement. You must also create a dataset for the Document Management configuration
file that contains information about the logos and distribution statements that you can use.
To create a dataset for logos, distribution statements, or Document Management configuration file:
1. In My Teamcenter, select an existing Document Management template (DMTemplate) revision
or select the template that you have created.
2. Click File→New→Dataset.
3. In the New Dataset dialog box:

a. Enter Name. Ensure that the name of the dataset matches the name of the logo or
distribution statement specified in the Document Management configuration file. For
example, the datasetName of a logo in the configuration file is Logo_1. Therefore, the name
of the dataset for the logo must also be Logo_1.
Example
<dmcfg:logoList>
<dmcfg:logoDataset datasetName="Logo_1" ID="1">
<dmcfg:enableWhen>
<dmcfg:property key="fnd0CurrentLocationCode"
value="Cypress"/>
<dmcfg:property key="programOrProject"
value="Training"/>
</dmcfg:enableWhen>
</dmcfg:logoDataset>
<dmcfg:logoList>
<dmcfg:logoDataset datasetName="Logo_2" ID="2">
<dmcfg:enableWhen>
value="Shoreview"/>
<dmcfg:property key="programOrProject"
value="Training"/>
</dmcfg:enableWhen>
</dmcfg:logoDataset>
</dmcfg:logoList>
<dmcfg:distStatementList>
<dmcfg:distStatementDataset datasetName="ExportControlledITAR"

Chapter
Document Management
Management
ID="1">
<dmcfg:enableWhen>
value="Shoreview"/>
</dmcfg:enableWhen>
<dmcfg:MSOfficePlacement>
<dmcfg:tag value="Statement_1"
</dmcfg:MSOfficePlacement>
<dmcfg:distStatementDataset datasetName="NonExportControlledITAR"
ID="1">
<dmcfg:enableWhen>
value="Cypress"/>
</dmcfg:enableWhen>
</dmcfg:distStatementList>
b. Import the logo image file, distribution statement Word file, or Document Management
configuration file.
c. In Relation, select Document Page Type Relation.
d. Click OK.
4. Right-click the newly created dataset and click Properties On Relation.
5. In the Properties dialog box:

a. Click Show Empty Properties to view all properties.
b. In Page Type, select Logo, Distribution Statement, or Document Configuration based on

the entity you are creating the dataset for.
c. Click OK.
6. Select the dataset and click File→New→Workflow Process to release the dataset.
7. In the New Process Dialog dialog box:

a. Select TCM Release Process in Process Template.
b. In the Attachments tab, expand Targets to select the logo, distribution statement, or
Document Management configuration file that is attached to the dataset.
c. Click OK.
A release flag is displayed next to the released dataset.
8. If the Document Management template that you selected in the first step to create the dataset is
not the default template, you must also release the template by starting a new workflow process.

Update the PDF command file to specify the placement of logos in PDF files
1. In My Teamcenter, check out a dataset that has the PDF command XML file attached to it. Files
are attached to a dataset as named references.
2. Click View→Named References.
3. In the Named References dialog box, select the attached file and click Download to download
the files to a specific location.
4. Update the downloaded file to specify the location of the logo and to specify the coordinates to
position the logo in a PDF file. If you want to place multiple logos in a PDF file, specify the path
and position of each logo.
<cmd:propertyDefinitions>

<cmd:propertyDefinition key="LogoFilePath_1"/>
<cmd:propertyDefinition key="LogoFilePath_2"/>
</cmd:propertyDefinitions>

<cmd:logo>
<cmd:logoFilepathKey>LogoFilepath_1</cmd:logoFilePathKey>
<cmd:position>
<cmd:coordinates x="36" y="36"/>
</cmd:position>
<cmd:zOrder>0</cmd:zOrder>
</cmd:logo>
<cmd:logo>
<cmd:logoFilepathKey>LogoFilepath_2</cmd:logoFilePathKey>
<cmd:position>
<cmd:coordinates x="36" y="72"/>
</cmd:position>
<cmd:zOrder>0</cmd:zOrder>
</cmd:logo>
5. After making the required changes, first delete the existing named reference file and ensure that
there is only one named reference file available. Then, click Upload to upload the updated file.
Define the placement of distribution statements in Microsoft Word files

You set up template files, which the document authors use to create different documents such as
functional specifications, design specifications, and marketing materials. You can place different
distribution statements in these documents. For example, you may want the distribution statement
Export controlled ITAR in marketing materials. Alternatively, you may want the distribution statement,
For internal purpose only in functional specifications.
You must define the placement of the distribution statements in the different documents. For example,
you may want Export controlled ITAR to appear as the first statement in all marketing materials and
For internal purpose only in the footer of all functional specifications.
To define the placement of distribution statements:

Chapter
Document Management
Management
1. Check out the required template file.
2. In Microsoft Word, click FILE→Options.
3. In the Word Options dialog box, click Customize Ribbon.
4. In Customize the Ribbon, select Main Tabs.
5. In Main Tabs, select the Developer check box and click OK.
6. Go to the DEVELOPER tab.
7. Place the cursor where you want to position the distribution statement and click one of the Aa
icons to insert either rich text content or plain text content.
8. Select Click here to enter text and click Properties in the DEVELOPER ribbon.
9. In the Content Control Properties dialog box, enter Title and Tag. The value of the tag must
be same as that specified in the MSOfficePlacement tag value in the Document Management
configuration file. The value of the datasetName that matches the tag value you specified in
Word is placed as the distribution statement.
<dmcfg:distStatementList>
<dmcfg:distStatementDataset datasetName="ExportControlledITAR" ID="1">
<dmcfg:enableWhen>
<dmcfg:property key="fnd0CurrentLocationCode" value="Shoreview"/>
</dmcfg:enableWhen>
<dmcfg:distStatementDataset datasetName="NonExportControlledITAR" ID="1">

<dmcfg:enableWhen>
<dmcfg:property key="fnd0CurrentLocationCode" value="Cypress"/>
</dmcfg:enableWhen>
</dmcfg:distStatementList>
10. Click OK.
11. Check in the template file into Teamcenter.
Set a MetaData Stamp file to add system stamps during PDF rendering and
printing processes
You set a MetaDataStamp (MDS) file that specifies the stamping options for a rendered PDF file.
This is the file that is generated when another file is rendered to a PDF format. You must also set the
MDS file to include system stamps when a PDF file is printed.
To set an MDS file, you must do one of the following:
• Create your own MetaDataStamp (MDS) template.

• Download the default batchprint.mds and stampinfo.mds sample MDS templates attached to
MDS datasets. These templates are provided in the DMTemplates directory:
TC_ROOT/sample/document_management/importdmtemplates/DMTemplates.
To update the new or existing MDS file with stamping information:

• Check out the required dataset.
• Click View→Named References.
• In the Named References dialog box, click Download to download the sample MDS file.
• Modify the file with the required stamping information.
Example
\Pos(36,16)
Submitted by \Attribute(FullUserName) on \Attribute(DateAndTime)
\Attribute(DialogUserStamp)
\Pos(36,72)
\Char(8)
OS User:\Attribute(TCUserName)
\Attribute(UserStamp)
\Watermark(LL2UR,AUTO)
\Attribute(WaterMark)
\Logo(\Attribute(LogoFilePath_1),72,140)
Here, LogoFilePath_1 is the path of the logo specified in the PDF command XML file.
If there are multiple logos specified in the Document Management configuration file,
add \Logo attribute for each logo.
You can use Teamcenter Visualization Convert to determine the size of the logo in
order to specify the x and y coordinates accurately.
A readme.pdf file is provided in the following directory:
TC_ROOT/sample/document_management
• After making the required changes, first delete the existing named reference file and ensure that
there is only one named reference file available. Then, click Upload to upload the updated
MDS file.
• Check in the dataset.
Insert system stamps in PDF and Microsoft Office files

After setting up system stamps, you can add the stamps (except distribution statements) to PDF
files by using workflow action handlers, rendering files, or printing files. You can add distribution
statements only to Microsoft Word files by using a workflow action handler.
Stamping PDF and Microsoft Office files by using workflow action handlers
To insert system stamps (except distribution statements) in a PDF file, send the PDF to a workflow
process that is set by using the DOCMGTAPP-apply-pdf-control action handler.

Chapter
Document Management
Management
To insert distribution statements in a Word file, send the file to a workflow process that is set by using
the DOCMGTAPP-update-docprop-logicalobject action handler.
Stamping PDF and Microsoft Office files by using Teamcenter Visualization Convert
To apply stamps while rendering PDF and Microsoft Office files to a PDF format, update the
Teamcenter Visualization vvcp.ini file by setting StampFormat=PDF in the Prepare section. This
setting improves the performance and output quality as the stamped PDF files are not rasterized.
The quality of the stamped PDF file is significantly better, especially when you zoom into a page.
Additionally, the text search capability is preserved as the PDF files are not rasterized.
You must set this up on the machine where you have installed Dispatcher and Visualization Convert
and Print.
The following metadata stamp (MDS) commands are not supported when stamp format is set to PDF
in the Teamcenter Visualization vvcp.ini file:
• \BackgroundColor
• \Circle
• \Color
• \FooterCenter
• \FooterLeft
• \FooterRight
• \HalfTone
• \HeaderCenter
• \HeaderLeft
• \HeaderRight
• \Image
• \Include
• \Line
• \Outline
• \Size
For more information on including system stamps in PDF and Office documents, see the Teamcenter
convert and print help.
Inserting distribution statements by using generic attribute exchange

Create a new Word file or render another file into Word file format. The distribution statement is
immediately inserted in the file.

You can also Check-in, revise, or save the Word file. The file is asynchronously updated with the
distribution statement by RenderMgtTranslator.
Stamping PDF files during printing
When you print a PDF file, the system stamps (except the distribution statement) are added to
the printed file.
Configuring document markup
Setting up applications for document markup

As a part of a review process, document reviewers mark up documents by applying geometric and
text markups. Threaded conversations and disposition reports help users to jointly discuss document
changes. The markup can be retained for historical review or audit purposes, is organized by user,
timestamp, and disposition of the markup comments. Dispositions provide a way to track the status of
and comment on reviewers' markup comments. For example, you can add a disposition to a comment
with status of Rejected and add a disposition comment such as, Out of the scope of this project.
Users can mark up documents in:
• Microsoft Word, Excel, PowerPoint and Outlook by using the Markup Manager pane. This
requires Teamcenter Client for Microsoft Office.
• Abode Acrobat/Reader by using Adobe markup. This requires Teamcenter Acrobat/Reader

Plugin.
• Microsoft Word, Excel, and PowerPoint embedded within the Active Workspace browser. This
requires Teamcenter Office Online.
• Active Workspace markup manager that supports the marking up of PDFs and several image
types.
See the Integration Matrix on GTAC to obtain the correct versions of Microsoft and Adobe
integrations.
Enabling applications for document markups
A dataset tool represents a software application such as Microsoft Word or Adobe Acrobat. To
enable software applications to perform markups, you modify the associated tool object and select
the Markup Capable check box. If you do not select this check box, users can only view markups.
Specifying Microsoft applications to be launched for markups
You can specify which Microsoft applications can be launched when a Microsoft document is opened
for review. For example, you can specify that an Excel document can be opened in Word for marking
it up.
To do so, you set the following preferences:
• Excel_ViewMarkup_Launchable_TcTypes

Chapter
Document Management
Management
• Outlook_ViewMarkup_Launchable_TcTypes
• PowerPoint_ViewMarkup_Launchable_TcTypes
• Word_ViewMarkup_Launchable_TcTypes
Turn off Adobe protected mode for markups

Adobe Reader version 11.0.09 or later is set up in protected mode on the Windows platform.
Teamcenter administrators must turn this mode off to facilitate PDF view and markup for users.
Perform the following steps if you have installed Teamcenter Acrobat/Reader Plugin:
1. Create the ProtectedModeWhitelistConfig.txt file.
a. Add FILES_ALLOW_ANY to the ProtectedModeWhitelistConfig.txt file.
By adding locations to this file, you grant access to specified directories and remove them
from the protected mode understood by Adobe Reader. Please consider any security
constraints or concerns when adding directories to this file.
b. Specify a new entry for FILES_ALLOW_ANY when more than one directory is allowed.
If a TEMP environmental variable is defined, set FILES_ALLOW_ANY to the %TEMP%\*
directory. If a TEMP environmental variable is not defined, set FILES_ALLOW_ANY to
point to the C:\temp\* directory.
c. If you have Teamcenter Client for Microsoft Office users who use Microsoft Outlook to view
and mark up PDF files, set FILES_ALLOW_ANY to the %APPDATA%\Siemens\* directory.
2. Copy the ProtectedModeWhitelistConfig.txt file to the same location where Adobe Reader
is installed (where acrord32.exe is located).
For example, if C:\Program Files (x86)\Adobe\Reader 11.0\Reader is an Adobe
Reader-installed directory where acrord32.exe is located, then the file must be copied under
this same directory.
3. Start the Microsoft regedit program so you can add the following registry setting.
a. Go to the HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Adobe\Acrobat
Reader\11.0\FeatureLockDown folder in the Adobe-installed directory.
Please back up the registry first before making the following registry modifications.
b. Right-click FeatureLockDown and choose New → DWORD (32 bit) Value. Enter
bUseWhitelistConfigFile for the name.
c. Double-click bUseWhitelistConfigFile and set the value to 1 (hexadecimal) to enable the

white list.
d. Choose File → Exit to close the registry editor program.
4. Start Adobe Reader so you can turn protected mode off.

a. Choose Edit→ Preferences.

b. From the Categories list, choose Security (Enhanced).
c. In the Sandbox Protections dialog box that appears, choose Enable Protected Mode
at startup.
d. Select Off for the Protected View.
e. Click Ok on the Preferences dialog box and choose File → Exit to close Adobe Reader.
For more details about how to set Adobe Reader protected view to off, see the Adobe description:
http://www.adobe.com/devnet-docs/acrobatetk/tools/AppSec/protectedmode.html#policy-configuration.
Provide access privileges for document markups

Teamcenter provides access control lists (ACLs) for managing markup information.
The following ACLs are located in Access Manager under Has Class(POM_application_object).
• Markup Item
View and markup action privileges for items
Working→Has Class(Item)→Markup Item
• Markup Item Revision

View and markup action privileges for item revisions
Working→Has Class(Item Revision)→Markup Item Revision
• Markup Dataset
View and markup action privileges for datasets
Working→Has Class(Dataset)→Markup Dataset
• Private Markup and Hidden Markup

Read, write, and delete privileges for datasets having private markups
Working→Has Attribute(Dataset:markup_acl=PrivateMarkup)→Private Markup
• General Markup
Read, write, and delete privileges for datasets having general markups
Working→Has Attribute(Dataset:markup_acl=GeneralMarkup)→General Markup
• Markup Official
Read, write, checkin, checkout, and delete privileges for datasets having official markups
Working→Has Attribute(Dataset:markup_official=1)→Markup Official
You can modify these ACLs or create others using Access Manager.
The system also provides ACLs for Markup.

Chapter
Document Management
Management
These ACLs are used with the Markup Capable option value to determine whether users can
perform markups or only view content.
You can use a workflow to grant the markup privilege when appropriate in a review task, or you can
change the access rule to manage it by owner group and role.
The commercial off-the-shelf (COTS) ACL does not grant World View/Markup access privilege. To
let users mark up a rendered PDF file, you can do either of the following:
• Edit the Dispatcher client configuration file
dispatcher_root\DispatcherClient\conf\Service.properties to set
Service.DataSetOwner=CAD.
This generates PDF datasets with the same owner as the source dataset; otherwise, the datasets
are owned by dcproxy.
• Grant World View/Markup access privilege for the ACL rules.

Without this, other users can only view the markups and cannot create and save PDF markups
using Adobe Acrobat.
You can use a workflow to grant markup privileges when appropriate in a review task.
Configuring digital signing for PDF documents

Setting up digital signing for PDF documents
PDF signatures are often used to designate user approval of a document on a PDF file. When a user
digitally signs a PDF, a signature stamp is placed on the PDF file. Digitally signing a document is
different from applying digital signatures. A digital signature is a mathematical stamp on a document
to indicate if the document was modified after the signature was applied. It also identifies who applied
the digital signature. It requires public key infrastructure (PKI) authentication when applying the
signature.
You can specify the applications that may be launched from Microsoft Outlook for digitally signing a
PDF by setting the value of the Outlook_Sign_Launchable_TcTypes preference to PDF.
Provide access privileges for digital signing

You can digitally sign a PDF file stored as a dataset named reference file with:
• Adobe Acrobat
• Adobe Reader
Note
For Adobe Reader, the PDF file must have Enable Usage Rights for Digitally Sign
enabled.
The DIGITAL_SIGN privilege lets users create an access control list (ACL) rule to digitally sign a PDF
file and to cancel a digital signature.

The Digital Sign Dataset ACL rule grants the owning user and owning group digital signing privileges
for the dataset object.
• World access users do not have digitally sign privileges.
The Digital Sign Dataset ACL rule may not be present in an upgraded system. To use the digital
signing capability, this rule must be created.
• Sign a PDF file by choosing the File→Sign command.

o The signed PDF file updates the PDF file stored in Teamcenter.
o To cancel a sign action, choose the Cancel Signing menu command.
The initial configuration for the digital signing of PDF files is set to not include markups
by the Fnd0IncludeMarkupsWithSignedFile business object constant default value,
DoNotIncludeMarkups.
Enable thumbnails for documents

Authors attach thumbnails (images) to a document item revision to represent the type of documents
they are saving in the Teamcenter database. However, these images are displayed only when you set
the value of the TC_display_thumbnail_in_UI preference to true.
If multiple documents are attached to a document item revision, you can prioritize the
documents to determine which document's thumbnail must be displayed by setting the
ItemRevision_thumbnail_relations and ItemRevision_thumbnail_references preferences.
Configuring full-text search

When the Autonomy search engine is installed and configured at your site, you can perform full-text
searches. Full-text searches can be combined with searches for metadata, allowing you to search
datasets by property value as well as search dataset files by keyword. For example, you can
search for all documents containing the keyword cat that belong to owning user jsmith and have
been modified after December 1, 2015.
Enable and configure full-text search
Set up full-text search following this process:

1. Install the Autonomy IDOL full-text search engine using the appropriate server installation
(Windows or UNIX/Linux).
2. Several FTS preferences are required to enable the Autonomy search engine.
3. To enable exact match queries for keywords, set AdvancedSearch to true in the [Server]
section of the IDOL Server configuration file before you index content.
The exact match criteria is submitted by enclosing the search keyword inside quotes, for
example, "cat".

Chapter
Document Management
Management
4. To enable case-sensitive exact match queries for keywords, set AdvancedCaseSearch to true
in the [Server] section of the IDOL Server configuration file before you index content.
The case-sensitive exact match criteria is submitted by prefixing the keyword with a tilde (~) and
enclosing it in quotes, for example, "~Cat".
Caution
Be aware that searching for case-sensitive matches can degrade searching
performance.
5. Use the TC_fts_enforce_master_language preference to specify the language used to index

unlocalized properties in cases where the site master language should not be used.
6. Set up Autonomy and create the index to build keyword indexes.

The build_fts_index utility builds keyword indexes on an object-by-object basis for the properties
of dataset objects and the contents of dataset files.
7. You can enable real time indexing to update the full-text search index automatically whenever
objects or their named references are saved, modified, or deleted.
You can use the UnstemmedMinDocOccs parameter in the [Server] section of the configuration
file to specify the number of documents in which a term must occur for it to be considered in a
wildcard search.
You cannot use wildcards to search for numeric characters if the SplitNumbers configuration setting
is set to true in the [Server] section of the configuration file.
Optional preferences for full-text search
Several preferences can refine the full-text search process:

• TC_fts_any_language
Enables searches to return documents in any language for your query rather than only in the
query's language.
• TC_fts_default_AND_operator
Specifies the default logical operator for keyword search.
true Uses the AND operator in search criteria. Entering dog cat queries for
dog AND cat. Results must contain both search terms.
false Uses the OR operator in search criteria. Entering dog cat queries for dog
OR cat. Results must contain at least one of the search terms.
• TC_fts_result_latest_ItemRevision
Specifies whether keyword searches return only the latest item revisions.
• TC_fts_max_results

Specifies the number of query results returned by the full text search engine. Use this preference
to avoid potential performance overhead on the Autonomy server.
Accepts a single string as a value. Must be single positive integer.
Teamcenter provides full-text keyword search queries for users by default.
Troubleshooting
To help you investigate problems with full-text search, you can check:
• Log files created in the Autonomy installation directory structure.
• Teamcenter log files generated by your session.
• The output from running the build_fts_index utility using the report argument.
Configuring Active Workspace features
Requirements to configure Document Management for Active Workspace

Before you configure Teamcenter Document Management for Active Workspace, you must deploy
Active Workspace with the following server extensions and client features:
• Base Install→Active Workspace→Server Extensions→Active Workspace Document
Management and Digital Signatures
• Base Install→Active Workspace→Client→Document Management Client, Digital

Signatures, and Markup.
For installing these features, refer to Active Workspace Deployment and Configuration.
Create document revisions in Active Workspace by dragging files to a folder

By default, when files are dragged to a folder, they are created as standalone datasets and attached to
the folder. This behavior can be changed to create a document revision with the files as attachments.
Depending on the value of the Dma1CreateDocOnDrop preference, the document revision (with file
attachments) can be created manually or automatically. The default value of this preference is blank.
Changing the value from blank changes the default behavior to create a document when files are
dragged to a folder. However, it does not change the default behavior of files dragged to a non-folder
object. Dragging files to a non-folder object creates standalone datasets with the files as attachments.
Create a document revision automatically
You can change the default behavior to automatically create a document revision and attach
files (as datasets) to it when files are dragged to a folder. For this, you set the value of the
Dma1CreateDocOnDrop preference to an internal name of the object type that must be created (for
example, Item). If set to Item, when files are dragged to a folder, an item is created, the dragged files
are attached to the item revision, and the item revision is attached to the folder.

Chapter
Document Management
Management
Create a document revision manually

You can change the default behavior to manually create a document revision and attach
files (as datasets) to it when files are dragged to a folder. For this, you set the value of the
Dma1CreateDocOnDrop preference to ShowCreatePanel. This setting changes the default
behavior to display the Create Document panel when files are dragged to a folder. The Create
Document panel allows authors to fill in or modify the displayed document attributes and to optionally
send the document revision to a workflow.
The document type created is of the same type as that defined for the Create Document tile available
on the Active Workspace home page. To create a document of a different type or to create a document
subtype, open the Create Document tile object in My Teamcenter, check it out for edit, and modify the
Action Parameters property with the internal name of the required object type or document subtype.
View the document page type in Active Workspace

By default, the Document Page Type relation of a document is not displayed on the Active Workspace
user interface, for example, cover page. However, you can modify the Awp0DocumentRevSummary
style sheet to include the Fnd0DocPageTypeRel.Dataset relation so that it is displayed in Active
Workspace.
...
<section titleKey="tc_xrt_files">
<objectSet source="TC_Attaches.Dataset, IMAN_reference.Dataset, Fnd0DocPageTypeRel.Dataset"
defaultdisplay="listDisplay" sortby="object_string" sortdirection="ascending">
<tableDisplay>
<property name="object_string"/>
<property name="object_type"/>
<property name="relation" modifiable="true"/>
<property name="release_status_list"/>
<property.name="date_released"/>
<property name="owning_user"/>
</tableDisplay>
...
However, once you set the value of the modifiable attribute of the relation property to true, the user
can modify all the relations that are displayed on the user interface.
View PDFs in the Active Workspace universal viewer

To view PDFs in the Active Workspace universal viewer, you must update the value of the
AWC_defaultViewerConfig.VIEWERCONFIG preference to include Fnd0DocPageTypeRel.
Example
SEARCHORDER.DocumentRevision=TC_Attaches, IMAN_reference,
Fnd0DocPageTypeRel
Enable PDF streaming in the Active Workspace universal viewer

To improve the performance of the Active Workspace universal viewer while loading PDF files, you
must enable PDF streaming. When you stream a PDF file, each page of the file is displayed as it is
downloaded. Therefore, you need not to wait for the entire PDF to be downloaded to view it.
To enable PDF streaming, add pdf to the FSC_DoNotCompressExtensions property in the FSC
configuration file. PDF streaming reduces the time taken to display the first page of a PDF file in
the universal viewer. The reduction in the time depends on the size of and the number of pages in
the PDF file. However, if you enable PDF streaming, PDF files are not compressed when they are

downloaded. Due to this, it may take longer to download PDF files. It also uses more network
bandwidth to complete the download.
You can enable PDF streaming only for PDF files that are optimized for page-by-page viewing. To
verify that a PDF file is optimized by this type of viewing:
1. Open the PDF file in Adobe Acrobat or Reader.
2. Click File→Properties and verify that the Fast Web View:Yes is displayed.
To generate PDF files that are optimized for Fast Web View when using Visualization Convert, set
PDFLinearized=om in the converter section of the vvcp.ini configuration file.
PDF streaming also requires the web server to return the Content-Length HTTP response header
for a PDF file. Currently, only IIS servers return this header. Oracle WebLogic and IBM WebSphere
do not return this header.
Standardize document behavior in Active Workspace

An item revision definition configuration (IRDC) standardizes the behavior of a document at specific
stages of its life cycle, including create, checkin, checkout, revise, and save as operations. An IRDC
is provided by default when you install Active Workspace Document Management. However, the
IRDC is not applicable to a document revision by default. This is because the default value of the
Dma1UseCOTSIRDC preference is Drawing Revision. To apply the IRDC to a document revision,
update the value of the Dma1UseCOTSIRDC preference to include DocumentRevision.
Host Active Workspace in Microsoft Office applications

Hosting integrates Active Workspace with installed or cloud-based applications. To host Active
Workspace in Microsoft Office applications:
• Install Client for Microsoft Office.
This places the Teamcenter ribbon on the Microsoft Office applications. Active Workspace
functionality can be accessed from the Teamcenter ribbon. Refer to the Client for Microsoft
Office documentation for instructions.
• Define the following preferences to link to your Active Workspace installation:

o Create the ActiveWorkspaceHosting.URL or ActiveWorkspaceHosting.Office.URL
preferences and set the value of these preferences to the URL of Active Workspace
installation.
o Create preferences to define whether to use Active Workspace elements (for example,
TC_Use_ActiveWorkspace_Create, TC_Use_ActiveWorkspace_Inbox, and
TC_Use_ActiveWorkspace_Summary) and set their value to True.
Host Active Workspace in Adobe Creative Cloud applications

Active Workspace can be hosted within Adobe Creative Cloud (Adobe CC) applications, such as
Illustrator, Photoshop, and InDesign. To access Active Workspace from these applications, you must:
• Install Teamcenter Adobe CC Integration for Active Workspace.

Chapter
Document Management
Management
• Specify the URL for accessing Active Workspace from the Adobe applications.
Install Teamcenter Adobe CC Integration
1. Ensure that Active Workspace is installed. Refer to the Active Workspace Deployment guide.
2. Download the Adobe CC Integration distribution package from GTAC. Refer to the Integration
Matrix on GTAC to obtain the correct version of Teamcenter and Adobe Integration.
3. Download Adobe ExMan Command Line Tool from

https://www.adobeexchange.com/resources/28.
4. Copy the downloaded Adobe CC Integration distribution package into the directory containing
the ExMan tool.
5. From the command line, in the ExMan directory, enter the following command:
• Mac:
"./ExManCmd --install AWIntegration.zxp"
• Windows:
"ExManCmd /install AWIntegration.zxp"
Specify the URL for accessing Active Workspace from Adobe
1. Copy the configuration file from /Library/Applications

Support/Adobe/CEP/extensions/com.siemens.plm.Teamcenter/config.xml to
~/Library/Application Support/Teamcenter/config.xml.
2. Navigate to ~/Library/Application Support/Teamcenter/config.xml.
3. Open the config.xml file and modify the <ActiveWorkspaceUrl> tag to specify the Active
Workspace installation location. Ensure that ?ah=true appears towards the end of the URL.
Example
<ActiveWorkspaceUrl>http://host:port/awc/?ah=true</ActiveWorkspaceUrl?
4. (Optional) Modify the <WorkingDirectory> tag to specify the directory to use when downloading
or uploading files.
Example
<WorkingDirectory>/tmp/com.mb.teamcenter.awc/</ActiveDirectory>
5. Save and close the config.xml file.

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
© 2018 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.

Deploying Document Management

Uploaded by

Copyright:

Available Formats

Deploying Document Management

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Deploying Document Management

Uploaded by

Copyright:

Available Formats

What are the main steps involved in deploying Teamcenter Document Management?

What are the main steps involved in deploying Teamcenter Document Management?

What are some of the key configurations required for Document Management?

What are some of the key configurations required for Document Management?

SIEMENS

Overview of Document Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1

Planning the Document Management deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1

Document Management deployment workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

Installing or updating Teamcenter with Document Management . . . . . . . . . . . . . . . . . . . 4-1

Installing Business Modeler IDE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1

Installing Visualization Convert and Print . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1

Installing or updating Dispatcher for Document Management . . . . . . . . . . . . . . . . . . . . . 7-1

Setting up Teamcenter Office Online . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1

Enable Teamcenter Client for Office . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1

Configuring Document Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1

PLM00053 12.0 Deploying Document Management 3

4 Deploying Document Management PLM00053 12.0

Using Document Management, you can:

• Render documents to different file formats.

PLM00053 12.0 Deploying Document Management 1-1

• Mark up documents for simultaneous reviews.

• Digitally sign PDF documents to secure them.

1-2 Deploying Document Management PLM00053 12.0

Requirements Server components Client components

PLM00053 12.0 Deploying Document Management 2-1

Requirements Server components Client components

Component Is used for

2-2 Deploying Document Management PLM00053 12.0

PLM00053 12.0 Deploying Document Management 3-1

The different scenarios to install Teamcenter Document Management

Create a new Teamcenter environment with Document Management

• Extensions→Enterprise Knowledge Foundation→Teamcenter Client for Microsoft Office,

• Extensions→Content and Document Management→Acrobat/Reader Plugin

• Unix and Linux

Update an existing Teamcenter environment with Document

PLM00053 12.0 Deploying Document Management 4-1

2. In the Maintenance panel, select Configuration Manager and click Next.

3. In the Configuration Maintenance panel, select Perform maintenance on an existing

6. In the Features panel:

• Select Extensions→Enterprise Knowledge Foundation→Teamcenter Client for

4-2 Deploying Document Management PLM00053 12.0

• Select Extensions→Content and Document Management→Acrobat/Reader Plugin.

PLM00053 12.0 Deploying Document Management 4-3

7. Enter information as needed in the subsequent panels.

8. In the Multiplexing Proxy (MUX) panel, click Advanced.

9. Enter information as needed in the subsequent panels.

4-4 Deploying Document Management PLM00053 12.0

Login URL Specifies the complete URL of the Security

12. In the Confirmation panel, click Start.

PLM00053 12.0 Deploying Document Management 4-5

PLM00053 12.0 Deploying Document Management 5-1

PLM00053 12.0 Deploying Document Management 6-1

PLM00053 12.0 Deploying Document Management 7-1

Workflow to set up Teamcenter Office Online

Install Microsoft Office Online Server

Install Teamcenter Office Online

1. Start that the Deployment Center web server.

PLM00053 12.0 Deploying Document Management 8-1

7. Go to Applications and click Add .