0% found this document useful (0 votes)
43 views112 pages

Deploying Document Management

The document outlines the deployment process for Teamcenter Document Management 12.2, detailing the necessary components and workflows for installation and configuration. It emphasizes the importance of document management in product data management, ensuring documents are synchronized with product information to meet deadlines. Key features include document standardization, rendering, printing, markup, and digital signing capabilities.

Uploaded by

cad cad
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
43 views112 pages

Deploying Document Management

The document outlines the deployment process for Teamcenter Document Management 12.2, detailing the necessary components and workflows for installation and configuration. It emphasizes the importance of document management in product data management, ensuring documents are synchronized with product information to meet deadlines. Key features include document standardization, rendering, printing, markup, and digital signing capabilities.

Uploaded by

cad cad
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 112

SIEMENS

Teamcenter 12.2

Deploying Document
Management

PLM00553 • 12.2
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 Microsoft Office Online within Teamcenter . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1


Overview of setting up Microsoft Office Online within Teamcenter . . . . . . . . . . . . . . . . . . . . . 8-1
Install Microsoft Office Online Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1
Requirements for installing Teamcenter Office Online . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1
Install Teamcenter Office Online . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2
Configure Teamcenter Office Online . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-4

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

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


About configuring Document Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1
Import Document Management sample configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-2
Set up the styling of Microsoft Office documents by using templates . . . . . . . . . . . . . . . . . . . 10-4
Setting up synchronization of Microsoft Office and Adobe PDF attributes with Teamcenter . . . . 10-6
About synchronizing Microsoft Office and Adobe file attributes with Teamcenter . . . . . . . . 10-6
Including Teamcenter attributes in Microsoft Office or Adobe PDF by using logical
objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-6
Setting up the rendering of documents into different file formats . . . . . . . . . . . . . . . . . . . . 10-26
Configuring document markup in Teamcenter rich client . . . . . . . . . . . . . . . . . . . . . . . . . . 10-26
Setting up applications for document markup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-26
Enable applications for document markups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-27
Specify Microsoft applications to be launched for markups . . . . . . . . . . . . . . . . . . . . . 10-27
Turn off Adobe protected mode for markups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-27
Provide access privileges for marking up documents . . . . . . . . . . . . . . . . . . . . . . . . . 10-28
Setting up document printing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-28

PLM00553 12.2 Deploying Document Management 3


Contents
Contents

About document printing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-28


Define print settings through a print configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-29
Specify banner pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-33
Defining printer device and page specifications for UNIX printing . . . . . . . . . . . . . . . . . 10-34
Provide access privileges for batch printing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-37
Setting up stamps for rendered or printed files, and existing PDFs . . . . . . . . . . . . . . . . . . . 10-38
About setting up stamps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-38
Specify information about logos, distribution statements,and workflow signoff tables in the
Document Management configuration XML file . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-39
Attach files to a Document Management template revision . . . . . . . . . . . . . . . . . . . . . 10-40
Define the styling of stamps for rendered and printed files . . . . . . . . . . . . . . . . . . . . . . 10-41
Define the styling of stamps for existing PDF files . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-43
Set up system stamps by creating a system stamp configuration . . . . . . . . . . . . . . . . . 10-47
Set up a workflow to include information in PDF files . . . . . . . . . . . . . . . . . . . . . . . . . 10-50
Improve the output quality of stamped PDF files by using Lifecycle Visualization
Convert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-51
Configuring digital signing for PDF documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-52
Setting up digital signing for PDF documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-52
Provide access privileges for digital signing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-52
Define how a document revision is handled in Teamcenter . . . . . . . . . . . . . . . . . . . . . . . . 10-53
Set up file translations by creating a dispatcher service configuration . . . . . . . . . . . . . . . . . 10-66
Enable thumbnails for documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-71
Configure full-text search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-71
Configuring Active Workspace features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-73
Requirements to configure Document Management for Active Workspace . . . . . . . . . . . 10-73
Defining the drag and drop behavior to create document revisions in Active Workspace . . 10-74
View the document page type in Active Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . 10-74
Enable PDF streaming in the Active Workspace universal viewer . . . . . . . . . . . . . . . . . 10-75
Standardize document behavior in Active Workspace . . . . . . . . . . . . . . . . . . . . . . . . . 10-75
Enable the viewing of 2D images in Active Workspace . . . . . . . . . . . . . . . . . . . . . . . . 10-75
Host Active Workspace in Microsoft Office applications . . . . . . . . . . . . . . . . . . . . . . . 10-76
Host Active Workspace in Adobe Creative Cloud applications . . . . . . . . . . . . . . . . . . . 10-76

4 Deploying Document Management PLM00553 12.2


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 authoring documents.

• Render documents to different file formats.

• Print documents with stamps such as watermarks, stamps, and logos to ensure proper
distribution.

PLM00553 12.2 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. You can also manage the generic attribute exchange
from Teamcenter to Microsoft Office documents by using logical objects.

1-2 Deploying Document Management PLM00553 12.2


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

PLM00553 12.2 Deploying Document Management 2-1


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 such as item revision definition configuration,
dispatcher service configuration, system stamp configuration, and
print configuration.
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 to view, markup, and digitally sign
PDFs.

2-2 Deploying Document Management PLM00553 12.2


Planning the Document Management deployment

Component Is used for


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.

See the Integration Matrix at http://www.siemens.com/gtac to obtain the correct versions of


Microsoft and Adobe integrations.
See the Compatibility Matrix at http://www.siemens.com/gtac to view the Lifecycle Visualization
Convert and Print version compatible with Teamcenter for Document Management.

PLM00553 12.2 Deploying Document Management 2-3


Chapter 3: Document Management deployment workflow

PLM00553 12.2 Deploying Document Management 3-1


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.

PLM00553 12.2 Deploying Document Management 4-1


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.

4-2 Deploying Document Management PLM00553 12.2


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.

PLM00553 12.2 Deploying Document Management 4-3


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:

4-4 Deploying Document Management PLM00553 12.2


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.

PLM00553 12.2 Deploying Document Management 4-5


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.

PLM00553 12.2 Deploying Document Management 5-1


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.

PLM00553 12.2 Deploying Document Management 6-1


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

PLM00553 12.2 Deploying Document Management 7-1


Chapter 8: Setting up Microsoft Office Online within Teamcenter

Overview of setting up Microsoft Office Online within Teamcenter


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 eliminates the need to install Microsoft Office on the client machines.
However, if your authors and reviewers wish to use the desktop version, you must enable the Client
for Microsoft Office feature, which embeds the Teamcenter menu within Microsoft Office applications.

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.
While preparing the server, if your site requirement is to view web-based Office files in multiple
languages, install the language packs for Office Online Server.
There are several ways to deploy the Office Online Server farm. Depending on your deployment
strategy, follow the appropriate installation steps specified in Deploy Office Online Server farm.

Requirements for installing Teamcenter Office Online


The following are the requirements for installing Teamcenter Office Online:
• Microsoft Office Online Server on a separate machine

• .NET Framework 4.5.2 (minimum version)

• Active Workspace

• A Sponsored Authentication user in Teamcenter


You can create this user in the Teamcenter Organization application under the Sponsor group
and Sponsorer role. In addition, ensure that the user is sponsorable to view Office files in Active
Workspace.

• Deployment Center

PLM00553 12.2 Deploying Document Management 8-1


Chapter
Chapter 8: 8: Setting
Setting up Microsoft
up Microsoft Office
Office Online
Online within
within Teamcenter
Teamcenter

You must use the latest available Deployment Center to install Teamcenter Office Online. For
instructions on using Deployment Center, see the Deployment Center help collection available at
Siemens PLM Software Doc Center.
Scenarios for installing Teamcenter Office Online
o Scenario 1
You do not have an existing Teamcenter environment. In this case, first install Teamcenter.
To do so, see Windows Server Installation.
Next, install Active Workspace. See the Installation section in the Active Workspace help
collection available at Siemens PLM Software Doc Center.
Finally, install Teamcenter Office Online through Deployment Center.

o Scenario 2
You have an existing Teamcenter environment but Active Workspace is not installed. In this
case, first install Active Workspace. See the Installation section in the Active Workspace help
collection available at Siemens PLM Software Doc Center.
Next, install Teamcenter Office Online through Deployment Center.

o Scenario 3
You have an existing Teamcenter environment with Active Workspace. In this case, you need
to only install Teamcenter Office Online through Deployment Center.

Install Teamcenter Office Online


Ensure that all requirements for installing Teamcenter Office Online are met before installing
Teamcenter Office Online through Deployment Center.

Warning
The 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 the Teamcenter Office Online web service. You must use the same script that
you used to install Microsoft Office Online Server. To do so, refer to the scripts specified
in Deploy Office Online Server.

1. Log on to Deployment Center.

2. Click the SOFTWARE REPOSITORIES tile and verify availability in the software repository of the
Teamcenter Foundation and Active Workspace software kits.

3. In the Deployment Center home page, click the ENVIRONMENTS tile to view the available
environments in Deployment Center. Select the environment on which you want to install
Teamcenter Office Online.
In case you are creating a new environment, click the Add button on the Environments page.
You can also add an existing environment by using the send_configuration_to_dc utility.

8-2 Deploying Document Management PLM00553 12.2


Setting up Microsoft Office Online within Teamcenter

4. Click the Deploy Software tab. In the Software task, select both Active Workspace and
Foundation from the Available Software list, and click Update Selected Software to add
them to the Selected Software list.

After the list is updated, click Go to Options.

5. In the Options task, select the Distributed environment type and based on your environment,
select the appropriate architecture type. Click Save Environment Options.

6. In the Applications task, choose Edit Selected Applications . From the Available
Applications list:

a. Select Teamcenter→Active Workspace→Teamcenter Office Online.

b. Select Teamcenter→Extensions→Teamcenter Office Online Web Service.

Click Update Selected Applications and verify that the applications you selected to install
are listed in the Selected Applications list.

7. Click Go to Components to display the Components tab. Start the individual components
and bring each component to a 100% complete status by supplying the required settings for
each. While supplying settings, record values such as those of installation paths, user names,
and passwords for later reference.

In the Teamcenter Office Online Web Service panel, perform the following actions for
configuring the Teamcenter Office Online Web Service component:

Field Action
Machine Name Enter the name of the machine on which you want to install the web
service. You must install the Teamcenter Office Online web service on
a separate machine and not on the same machine that has Microsoft
Office Online Server. However, ensure that both these are Windows
machines with IIS.
Microsoft Office Enter the reference URL of the deployed
Online Server Microsoft Office Online Server. A sample URL is
Discovery URL http://host_office_online_server/hosting/discovery.
User ID and Enter the credentials of the Teamcenter Sponsored Authentication user.
Password

Click Save Component Settings.

8. Once the configuration displays 100% complete in the Selected Components list, click Go
to Deploy to generate the script.

9. In the Deploy task, click Generate Install Scripts.

10. Copy the scripts to the target machine and run the scripts. Follow the instructions specified in
Run the deployment scripts, available in the Deployment Center help collection.

PLM00553 12.2 Deploying Document Management 8-3


Chapter
Chapter 8: 8: Setting
Setting up Microsoft
up Microsoft Office
Office Online
Online within
within Teamcenter
Teamcenter

Configure Teamcenter Office Online


To configure Teamcenter Office Online, you must:
• Set the Teamcenter Office Online preferences
Teamcenter Office Online preferences are automatically set when you install the Teamcenter
Office Online web service. However, you can change the value of these preferences as per
your requirement:

o 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.
This preference is available in the web.config file. To verify if the preference value is set
correctly, search for officeOnlineServer discoveryURL in this file.

Example
If the Teamcenter Office Online web service was deployed at the default location,
the web.config file is available at C:\inetpub\tcroot\TcOOWeb on the server
that this web service was deployed to.

o OfficeOnlineTimeToLive
Specifies the life span (in seconds) of the Teamcenter access token.

o 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.
Example:
https://tcooweb.example.com:7009/TcOOWeb/api/wopi

• Establish the sponsored authentication user credentials


You specified the Sponsored Authentication user credentials while creating the user. You can
change the user credentials later. To do so, update these 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"

8-4 Deploying Document Management PLM00553 12.2


Setting up Microsoft Office Online within Teamcenter

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"

• 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.

Further, if you have set up Secure Socket Layer and single sign-on in your environment, you can
(optionally) perform the following:
• Set up the Secure Socket Layer protocol
You can 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.
As SSL is necessary for a secure communication between Active Workspace and Office Online
Server, it is recommended that you configure Office Online Server with SSL. SSL termination at
Office Online Server is recommended only if the connection between the Office Online Server
machine and the Teamcenter Office Online web service machine is same as the SSL.

• Enable single sign-on


If single sign on is set up at your site, then you must enable it. To do so, 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">

PLM00553 12.2 Deploying Document Management 8-5


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.

PLM00553 12.2 Deploying Document Management 9-1


Chapter 10: Configuring Document Management

About configuring Document Management


Document authors and reviewers perform various tasks such as authoring documents, rendering
documents into different file formats, marking up documents during review, printing documents, and
digitally signing PDF documents. Depending upon your site requirements, you can configure these
tasks for these users. You perform all the configurations within a template in BMIDE. To help you with
the configuration process, some sample configuration files are available by default. You can import
these sample files to create your own configurations.
Next, you perform the following tasks:
• Set up the styling of Microsoft Office documents by using templates
By setting up Microsoft Office templates, you ensure that a consistent style is followed in
documents authored by users. You then set up Document Management templates to attach
Office templates.

• Set up the synchronization of Microsoft Office and Adobe Acrobat attributes with Teamcenter
By synchronizing file attributes between Teamcenter and Office (Word, Excel, and PowerPoint)
or Teamcenter and PDF files, you reduce the need for typing out information in both places.
You also ensure that up-to-date information is available at both instances: your Teamcenter
environment and your Microsoft Office or Adobe Acrobat files.

• Set up rendering of documents into different file formats


You can render a document into a different file format when a user checks in the document. For
example, you can render a Word document to a PDF so that the user can send the PDF for
review. You can set a naming convention for the rendered file. You can also choose to include
stamps such as a watermark, logo, distribution statement, and user name in the rendered file.

• Set up applications for marking up documents during reviews


As a part of a review process, document reviewers mark up documents by applying geometric
and text markups. Threaded conversations and disposition reports help reviewers to jointly
document changes.

• Set up printing of documents attached to a document revision


You can set up the document printing process so that users can print documents directly from
Teamcenter. All documents attached to a document revision can be printed in a batch. You can
set up banner pages to separate out and organize print jobs when documents are printed in a
batch. Further, you can also choose to include stamps such as watermarks, logos, distribution
statements, or Teamcenter attributes in the printed documents.

• Set up digital signing for PDFs

PLM00553 12.2 Deploying Document Management 10-1


Chapter
Chapter 10:10:Configuring
Configuring Document
Document Management
Management

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.

• Set up the definition of a document revision


You can define how a document revision is handled during its lifecycle in Teamcenter. For
example, you can define that every time a document revision is checked in, a PDF of the dataset
attached to the item revision must be generated. You can also choose to include stamps in the
rendered PDF. You can also set up deep copy rules that define till what level an item revision
must be copied when a new item revision is created from an existing one.
You set up this definition by using item revision definition configuration (IRDC). You must create
an IRDC for every document for which you want a standardized behavior. For example, you can
create an IRDC for a specification document. Similarly, you can create another IRDC for the
regulatory filing document.

Import Document Management sample configurations


To configure Document Management, you require certain configuration files. A sample of these files
is provided by default. You can use these sample files to create your own configuration files. To do
this, you must import the following sample files:
• BMIDE Document Management template file (docmgt_samples.xml)
This file contains the BMIDE Document Management objects required to configure Teamcenter
for managing documents. For example, it contains the item revision definition configuration object
that is required to standardize a document behavior.

• BMIDE Document Management localization file (localization_en_US.xml)


This file contains the necessary localization information required by the BMIDE Document
Management sample template file.

• Document Management template file (DMTempate.xml)


This file contains the sample document template files in a folder structure. For example, the
sample file for setting up the document template for a functional specification is located in
DMTemplateForSampleFSWordDataset.

For more information about these files, see


server-install-location\samples\document_management\readme.pdf.

Import the sample BMIDE Document Management template file

1. Navigate to server-install-location\samples\document_management and open


docmgt_samples.xml.

2. Replace all instances of SAM9 to your organization's prefix, for example, A4_.

3. In Business Modeler IDE, select a BMIDE template project and click File→Import.

4. In the Import dialog box, select Business Modeler IDE→Import template file and click Next.

10-2 Deploying Document Management PLM00553 12.2


Configuring Document Management

5. Click the browse button next to Preference file and open


server-install-location\samples\document_management\docmgt_samples.xml.

6. Click Finish.

7. To verify if you imported the successfully, click Extensions→Document Management to view


the samples available within different folders such as Dispatcher Service Config and IRDC.

Next, you can view the sample tool objects under Extensions→Options→Tool and the sample
conditions under Extensions→Rules→Conditions.
You can use these samples as the basis for creating configuration objects as per your site
requirements.

Import the sample BMIDE Document Management localization file

1. In Business Modeler IDE, select the BMIDE template project in which you imported the sample
BMIDE Document Management template file.

2. Click File→Import.

3. In the Import dialog box, select Business Modeler IDE→Import Localizations and click Next.

4. Click Add and open


server-install-location\samples\document_management\localization_en_US.xml.

5. Click Finish.

Import the sample Document Management template file

1. In My Teamcenter, click Tools→Import→From PLMXML.

PLM00553 12.2 Deploying Document Management 10-3


Chapter
Chapter 10:10:Configuring
Configuring Document
Document Management
Management

2. In the PLMXML Import dialog box, click the browse


button next to Importing XML File and select the
server-install-location\sample\document_management\importdmtemplates\DMTemplates.xml
file.

3. Click OK.

To verify if you imported the BMIDE Document Management template file successfully:
1. In My Teamcenter, click File→New→Item.

2. In the New Item dialog box, select Document and click Next.

3. Enter an ID and a Name for the document and click Next twice.

4. In Document Subject, select Functional Specification.


Depending on the templates loaded on your system, you may be presented with other options
instead of Functional Specification.

5. Click Finish.

6. Expand the newly created document revision and click the Viewer tab to verify that the correct
functional specification document is attached to it.

Set up the styling of Microsoft Office documents by using templates


You can style Microsoft Office documents by using templates. Templates ensure that a consistent
style is followed in documents authored by users.

Task flow to set up Document Management templates

Create Microsoft Office templates


Create templates in different Microsoft Office applications such as Microsoft Word or Excel, as per
your requirements. To create a template file, you may refer to the sample Document Management
templates that your imported by importing the DMTemplate.xml sample file.

Create datasets for Microsoft Office templates


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

10-4 Deploying Document Management PLM00553 12.2


Configuring Document Management

To create a dataset:
1. 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, MSWordX.
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.

5. For a template file, set Relation as Attaches and for a cover page, set it as Document Page.

6. Click OK.

Create a Document Management template revision

1. Select the folder where you want to create the Document Management template revision 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. Enter the required information and click Finish.

Attach datasets to a Document Management template revision

1. Right-click the dataset you wish to attach and click Copy.

2. Right-click the Document Management template revision to which you wish to attach the dataset
and click Paste.

After you attach a cover page to a Document Management template revision, you must set the
page type of the cover page document. To do so:
1. Right-click the cover page attached to the Document Management template revision and click
Properties on Relation.

2. In the Properties dialog box, set the Page Type as Cover Page and click OK.

Release a Document Management template revision

You must release the Document Management template revision and its attached datasets so that
authors can start using it. To release the template and its 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.

PLM00553 12.2 Deploying Document Management 10-5


Chapter
Chapter 10:10:Configuring
Configuring Document
Document Management
Management

4. In the Attachments tab, expand the document template revision and select the datasets to be
released.

5. Click OK.

Setting up synchronization of Microsoft Office and Adobe PDF


attributes with Teamcenter
About synchronizing Microsoft Office and Adobe file attributes with Teamcenter
By synchronizing file attributes between Teamcenter and Office (Word, Excel, and PowerPoint)
and between Teamcenter and PDF files, you reduce the need for typing out information in both
places. You also ensure that up-to-date information is available at both instances: in the Teamcenter
environment and in the Microsoft Office or PDF files.
You can synchronize Microsoft Office and PDF file attributes with Teamcenter by using:
• Logical objects
By using logical objects, you can include Teamcenter attributes in Microsoft Office and PDF
templates. 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:

o Root object is the object from which the member objects can be traversed. For Document
Management, the root object is Dataset.

o 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.

o Presented properties are the properties selected from the root and member objects and
added on to logical objects as first-class properties. For Document Management, presented
properties include information such as last modified date, created by, and created on.

• Teamcenter Client for Microsoft Office


By using Client for Office, you can synchronize attributes between Teamcenter and Microsoft
Office documents.

Including Teamcenter attributes in Microsoft Office or Adobe PDF by using


logical objects

Task flow to include Teamcenter attributes in Microsoft Office or Adobe PDF by using logical
objects
• Define a logical object.

• Define when to add the Teamcenter attributes in template files.

• Set up stamps to be included in the rendered files or in existing PDFs.

10-6 Deploying Document Management PLM00553 12.2


Configuring Document Management

• Define the placement of attributes in Word, Excel, PowerPoint, and PDF files.

• Relate the logical object with a dataset.


For example, for attribute exchange with a Word file, you set the dataset as MSWordX and relate
it to the logical object. Similarly, for attribute exchange with a PDF file, you set the dataset as
PDF and relate it to the logical object.

The Teamcenter attributes and other information such as logos, distribution statements, and workflow
signoff tables are included in a file when a user creates, checks in, revises, saves as, prints, or renders
a document revision. However, a user can also send the file through an attribute exchange workflow
process to include the attributes. For this, you must set up a workflow task for the users by using:
• The DOCMGTAPP-update-docprop-logicalobject action handler for attribute exchange from
Teamcenter to Word, Excel, or PowerPoint files.

• The DOCMGTAPP-apply-pdf-control action handler for attribute exchange from Teamcenter to


PDF files.

Finally, you may verify if you have set up the attribute exchange correctly.

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 New > 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 to add new members to the logical object.

6. 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.

PLM00553 12.2 Deploying Document Management 10-7


Chapter
Chapter 10:10:Configuring
Configuring Document
Document Management
Management

f. Select Forward.

g. Select Relation or Reference, for example, items_tag.

h. Select Business Object, for example, Document.

i. 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. For each member, add member properties that you want to consider for document rendering.
To do so:
a. In Presented Properties, click Add .

b. In the Add Property panel, select a property of the member, for example, fnd0Root.

c. In Member Properties, select required property, for example, last_mod_date.

d. Click Add.
You can add as many properties as required for each member.

Define when to add the Teamcenter attributes in template files


1. In the existing BMIDE template project, click Business Objects→ItemRevision.

2. Double-click ItemRevision and in the Main→Business Object Constants tab, locate


Fnd0RelToDatasetForLOAttrExch and click Edit.

3. In the Business Object Constant dialog box, enter the relations that must be considered
including attributes in datasets attached to a Document Management template revision. You can
specify more than one relation by using commas, for example, tc_attaches, IMAN_specification.

4. Click Finish.

5. In the Main→Business Object Constants tab, locate Fnd0TriggerLOAttrExch and click Edit.

6. In the Business Object Constant dialog box, select one of the following in Value and click
Finish:
• Disabled
This value indicates that the Teamcenter attributes will not be added to template files
automatically. This is the default value.

• Configured
This value indicates that the Teamcenter attributes will be added to template files automatically.
The attributes will also be added to the datasets attached to the Document Management
template revision with relations specified in the Fnd0RelToDatasetForLOAttrExch business
constant.

• Enabled

10-8 Deploying Document Management PLM00553 12.2


Configuring Document Management

This value indicates that the Teamcenter attributes will be added to template files and to all
the attached datasets automatically.

Set up stamps
In Document Management, the following elements are categorized as stamps:
• Logos

• Distribution statements (for example, Export Controlled ITAR)

• Teamcenter attributes such as document name, description, and date and time.

• System stamps such as watermarks, user names, and date and time information.

• User stamps, which constitute any text that you want to include in a document (for example,
Internal Distribution).

You can set up stamps to be included in a rendered or a printed document and in existing PDFs that
are sent to a stamp workflow process by users.
You can also include workflow signoff table information, such as a workflow template name, group,
role, user name, user ID, and comments, in a rendered or a printed PDF. This signoff information
is the one the author sees in the Workflow Signoff dialog box while sending a document revision
through a review workflow.
To set up stamps:
• Attach the logo file to the Document Management template revision that you have created for
stamps. You can attach multiple logo files.

• Specify how the logos and distribution statements must be processed in the Document
Management configuration XML file. You then attach the file to the system stamp Document
Management template revision. You can attach multiple distribution statements.

• Define the styling of the stamps. For example, you can set the font and the position of the
watermark, or the position of the logo and workflow signoff table.
o For rendered or printed files, define the styling in a Meta Data Stamp file and attach the file to
the system stamp Document Management template revision.

o For existing PDF files, update the PDF command file attached to the system stamp Document
Management template revision.

• Set up system and user stamps by creating a system stamp configuration. You can choose to
include these stamps when a file is only rendered, only printed, both rendered and printed,
or in existing PDFs.

After setting up stamps, you can choose to include them in:


• Rendered or printed documents while setting up document rendering and printing.

• Existing PDF files when authors send them through a stamping workflow. For this, you must set
up a workflow process template by using the DOCMGTAPP-apply-pdf-control action handler.

PLM00553 12.2 Deploying Document Management 10-9


Chapter
Chapter 10:10:Configuring
Configuring Document
Document Management
Management

• Microsoft Word documents by first setting up attribute exchange through logical objects.
Next, set up a workflow process template by using the
DOCMGTAPP-update-docprop-logicalobject action handler. When authors send Word
documents through a workflow, stamps are included in the documents.

To improve the output quality of stamped PDF files, update the Lifecycle Visualization vvcp.ini file.

Define the placement of information in Microsoft Word documents

You must add each property that you defined for a logical object member in Active Workspace as a
custom property in Microsoft Word. You must also define the placement of these properties along
with the placement of other information such as logos, distribution statements, and workflow signoff
tables. To do so:
1. Check out the required template file.

2. Open a Word file in which you want to include information.

3. To add each property:


a. Click File→Info→Properties→Advanced Properties.

b. In the Properties dialog box, click Custom.

10-10 Deploying Document Management PLM00553 12.2


Configuring Document Management

c. Enter the ID of the member property in Name, for example, m1DocRev_item_ID.

d. Select Type.

e. Enter the information in Value. As a default value is required, enter either a space or
information that must be displayed in the document.

f. Click Add.

g. Add other required properties and finally click OK.

h. 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.

PLM00553 12.2 Deploying Document Management 10-11


Chapter
Chapter 10:10:Configuring
Configuring Document
Document Management
Management

C. Click OK.
The value of the custom property is inserted at the selected location.

To see the value of a custom property later, right click the inserted property and click
Toggle Field Codes.

4. To insert distributions statements:

a. Click FILE→Options.

b. In the Word Options dialog box, click Customize Ribbon.

10-12 Deploying Document Management PLM00553 12.2


Configuring Document Management

c. In Customize the Ribbon, select Main Tabs.

d. In Main Tabs, select the Developer check box and click OK.

e. Go to the DEVELOPER tab.

f. 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.

g. Select Click here to enter text and click Properties.

h. 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 title value you specified in Word is placed as
the distribution statement.

i. Click OK.

5. To insert logos:
• Go to the DEVELOPER tab.

• Click the Picture Content Control icon.

• Select the image and click Properties.

• In the Content Control Properties dialog box, enter Title and Tag. The value of the tag
must be same as that specified in the logoList tag value in the Document Management
configuration file.

PLM00553 12.2 Deploying Document Management 10-13


Chapter
Chapter 10:10:Configuring
Configuring Document
Document Management
Management

The value of the datasetName that matches the title value you specified in Word is placed as
the logo.

6. To insert the workflow signoff table:


• Go to the DEVELOPER tab.

• Place the cursor where you want to position the workflow signoff table and click one of the Aa
icons to insert either rich text content or plain text content.

• Select Click here to enter text and click Properties.

• In the Content Control Properties dialog box, enter Title and Tag as WorkflowSignoffTable.

10-14 Deploying Document Management PLM00553 12.2


Configuring Document Management

• Click OK.

7. After creating the Word document, attach it to the required document template revision item
and check in the template.

Define the placement of information in Microsoft Excel files


You must add each property that you defined for a logical object member in Active Workspace
as a custom property in Microsoft Excel. You must also define the placement of these properties
along with the placement of other information such as logos, distribution statements, and workflow
signoff tables. To do so:
1. Check out the required template file.

2. Open an Excel file in which you want to include information.

3. Place the cursor at the cell where you want to enter a custom property and change the cell name
to the property value that you specified while defining the logical object, for example, item_ID.

4. To add properties:
a. Click File→Info→Properties→Advanced Properties.

b. In the Properties dialog box, click Custom.

c. Enter the ID of the member property in Name, for example, item_ID.

d. Select Type.

e. Enter the information in Value. As a default value is required, enter either a space or
information that must be displayed in the file.

PLM00553 12.2 Deploying Document Management 10-15


Chapter
Chapter 10:10:Configuring
Configuring Document
Document Management
Management

f. Select the Link to content check box.

g. Click Add.

h. Add other required properties and finally click OK.

5. To insert distribution statements:


a. Select a cell in which you want to insert the distribution statement.

b. In the Name Box, rename the cell to the name of the distribution statement that you specified
in the MSOfficePlacement tag value in the Document Management configuration file.

10-16 Deploying Document Management PLM00553 12.2


Configuring Document Management

6. To insert logos:
a. Click Insert→Pictures.

b. Select the required logo and click Insert.


Ensure that the name of the logo is the same as that specified in the Document Management
configuration file.

PLM00553 12.2 Deploying Document Management 10-17


Chapter
Chapter 10:10:Configuring
Configuring Document
Document Management
Management

7. To insert the workflow signoff table:


• Select a cell where you want to position the workflow signoff table and change the name of the
cell to WorkflowSignoffTable. For example, if you want the workflow signoff table to appear
from cells B7 to F12, you must select the cell B8 and rename it to WorkflowSignoffTable.
This is because the header of the workflow signoff table is placed in cells B7 to F12.

10-18 Deploying Document Management PLM00553 12.2


Configuring Document Management

8. After creating the Excel file, attach it to the required document template revision item and check
in the template.

Define the placement of information in Microsoft PowerPoint files

You must add each property that you defined for a logical object member in Active Workspace as a
custom property in Microsoft PowerPoint. You must also define the placement of these properties
along with the placement of other information such as logos, distribution statements, and workflow
signoff tables. To do so:
1. Check out the required template file.

2. Open a PowerPoint file in which you want to include information.

3. To add each property:


a. Click File→Info→Properties→Advanced Properties.

b. In the Properties dialog box, click Custom.

c. Enter the ID of the member property in Name.

PLM00553 12.2 Deploying Document Management 10-19


Chapter
Chapter 10:10:Configuring
Configuring Document
Document Management
Management

d. Select Type.

e. Enter the information in Value. As a default value is required, enter either a space or
information that must be displayed in the document.

f. Click Add.

g. Add other required properties and finally click OK.

4. To insert the newly created custom properties:

a. Insert a text box for each property. You can also use the existing text boxes, if any.

b. Click Home→Arrange→Selection Pane.

c. In the Selection pane, rename each text box. The name of the text box must be same as
the name of the property you added earlier.

For example, rename the text box in which you the title to appear as m1DocRev_Title.

5. To place a logo, click Insert→Pictures and select an image.

Place the image where you wish the logo to be placed. In addition, rename the image to the value
of the logo specified in the Document Management configuration file.

10-20 Deploying Document Management PLM00553 12.2


Configuring Document Management

6. To place a distribution statement, insert a text box at the appropriate place and rename the text
box so that its name is same as the tag value of the distribution statement in the Document
Management configuration file.

7. To include the workflow signoff table, click Insert→Table.


Place the table where you wish the workflow signoff table to be displayed and rename the table
as WorkflowSignOffTable.

8. After creating the PowerPoint file, attach it to the required document template revision item
and check in the template.

Define the placement of information in Adobe PDF files

To define the placement of information such as logos, distribution statements, Teamcenter attributes,
and workflow signoff tables in Adobe PDF files, you update the:
• styling in a Meta Data Stamp file for rendered or printed PDFs.

• update the PDF command file for existing PDFs.

After defining the placement information, you attach these files to the system stamp Document
Management template revision.

Relate logical objects with datasets

You can relate one or more logical objects to a dataset. To do so:


1. In Active Workspace, search for the document revision containing the required dataset.

2. Select the dataset and Edit > Edit Properties.

3. Select the logical object that you created for the document revision in Logical Object Type
Relation.

4. Click Save Edits.

PLM00553 12.2 Deploying Document Management 10-21


Chapter
Chapter 10:10:Configuring
Configuring Document
Document Management
Management

Set up a workflow to include information in Microsoft Office files


By default, the Teamcenter attributes and other information such as logos, distribution statements,
and workflow signoff tables are included in Microsoft Word, Excel, and PowerPoint files when a
user creates, checks in, revises, saves, or renders a document revision. However, a user can also
send a file through an attribute exchange workflow to include the information. For this, you must
set up a workflow task for the users by using the DOCMGTAPP-update-docprop-logicalobject
action handler.
To set up a workflow task:
1. Create a workflow process template
a. In Workflow Designer, click File→New Root Template.

b. In the New Root Template dialog box, enter a name in New Root Template Name.

c. Select Empty Template in Based On Root Template and Process in Template Type.

d. Click OK to create a workflow process template.

2. Add a task to the workflow process template


a. On the toolbar, click Edit Mode and then click Task .

b. In the process flow pane, double-click where you want to place the new task.
A new task appears with the default name New Task #. In the Name box, type a name for
the task.

3. Link the task to its predecessor and successor tasks


a. Click the task node you want to specify as the predecessor task.

Caution
Do not click the title bar of the task node as this action drags the task node to a
different location.

b. Drag your cursor to the task node that you want to specify as the successor task.
A link arrow follows the cursor as you drag. When your cursor moves over a task node, the
node is highlighted.

c. Release the mouse button.


A link arrow connects the predecessor and successor nodes.

4. Configure the task


a. Right-click the task and click Task Properties.

b. Click the Task Handler pane.

c. In Task Action, select Complete.

10-22 Deploying Document Management PLM00553 12.2


Configuring Document Management

d. In Action Handler, select DOCMGTAPP-update-docprop-logicalobject to create a


workflow task to include stamps in Microsoft Word, Excel, and PowerPoint files during
attribute exchange through logical objects.

e. Click Create.

DOCMGTAPP-update-docprop-logicalobject
Description Update the datasets (for example, MSWordX with a .docx extension or
MSExcelX with a .xlsx extension) associated with the target item revisions
with the latest attribute exchange data. Attribute exchange data can include
Teamcenter properties, logos, distribution statements, and workflow sign
off tables, if the target object is in a review task. Attributes are exchanged
between Teamcenter and the files.

Note
• The generic (logical object) attribute exchange currently
supports Microsoft Word, Excel, and PowerPoint datasets only.

• The Microsoft Word, Excel, and PowerPoint datasets must be


related to the logical objects for the generic attribute exchange
to occur.

• Target item revisions must be valid and checked in.


The attribute exchange process from this workflow action
handler bypasses the Fnd0TriggerLOAttrExch business object
constant configuration.

• Logos and distribution statements must be enabled based on


their document configuration setting.

• System stamp must be enabled for a business object revision


and logical objects must be defined for its datasets.

The update is synchronous.


Syntax DOCMGT-update-docprop-logicalobject
Arguments None
Placement Place on the Start action of a Task.

Caution
Do not place this handler on the perform action of the
perform-signoffs task. Otherwise, this handler runs multiple times.

Restrictions Item revisions with attached datasets such as Microsoft Word, Excel, or
PowerPoint must be included as targets of the workflow process.

PLM00553 12.2 Deploying Document Management 10-23


Chapter
Chapter 10:10:Configuring
Configuring Document
Document Management
Management

Set up a workflow to include information in PDF files

1. Create a workflow process template


a. In Workflow Designer, click File→New Root Template.

b. In the New Root Template dialog box, enter a name in New Root Template Name.

c. Select Empty Template in Based On Root Template and Process in Template Type.

d. Click OK to create a workflow process template.

2. Add a task to the workflow process template

a. On the toolbar, click Edit Mode and then click Task .

b. In the process flow pane, double-click where you want to place the new task.
A new task appears with the default name New Task #. In the Name box, type a name for
the task.

3. Link the task to its predecessor and successor tasks


a. Click the task node you want to specify as the predecessor task.

Caution
Do not click the title bar of the task node as this action drags the task node to a
different location.

b. Drag your cursor to the task node you want to specify as the successor task.
A link arrow follows the cursor as you drag. When your cursor moves over a task node, the
node is highlighted.

c. Release the mouse button.


A link arrow connects the predecessor and successor nodes.

4. Configure the task


a. Right-click the task and click Task Properties.

b. Click the Task Handler pane.

c. In Task Action, select Complete.

d. In Action Handler, select DOCMGTAPP-apply-pdf-control to create a workflow task to


include stamps in the existing PDF files.

e. Click Create.

10-24 Deploying Document Management PLM00553 12.2


Configuring Document Management

DOCMGTAPP-apply-pdf-control

Description Applies a system stamp, watermark, logo, distribution statement text, workflow
signoff table (if the target object is in a review task), and Teamcenter attributes
when the logical object is related to the attached PDF dataset. A target object
can be an item, an item revision or its subtype, or the PDF dataset itself.

The system stamp is an imprint comprising data such as a watermark and


optional boilerplate text. In Business Modeler IDE, the data model administrator
creates a system stamp configuration, associating the configuration with the
XML command file that defines the watermark and text. The system stamp
configuration also contains Document Configuation, Logo, and Distribution
Statement datasets.

For this handler to apply the stamp and watermark, the following conditions
are required:

• The PDF dataset must be related to the item revision or its subtype.

• The system stamp configuration must be enabled for the item revision or
its subtype. The Applies To attribute of the system stamp configuration
must be set to PDF_Control.

• The PDF Control access privilege must be granted.

• Logos and distribution statements must be enabled based on their


document configuration setting.

Syntax DOCMGTAPP-apply-pdf-control -user_stamp=text string

Arguments -user_stamp

(Optional) Specifies any string for the text portion of the stamp.

Placement Place on the Start action or the Complete action.

Restrictions None

Verify if information is included in template files automatically

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


action handler.

• Create, check in, revise, save as, or render a document revision with an attached MSWordX,
MSExcelX, or MSPowerPointX file. Verify that attributes are automatically filled in the attached
dataset. Also verify that other information such as logos, distribution statements, and workflow
signoff tables are inserted into the Word document during the attribute exchange.

PLM00553 12.2 Deploying Document Management 10-25


Chapter
Chapter 10:10:Configuring
Configuring Document
Document Management
Management

Setting up the rendering of documents into different file formats


Documents can be rendered into different file formats. For example, a Word document can be
rendered into PDF.
You can set up documents to render into different file formats when a user:
• Checks in a document.

• Clicks the Render Document option on the user interface.

• Sends a document through a workflow process. For this, you must set up a workflow process
task by using the DOCMGT-render-document-revision workflow action handler.

To set up document rendering, you must:


• Ensure that you have installed Dispatcher with RenderMgtTranslator and PreviewService
translators. Also, ensure that you have installed Lifecycle Visualization Convert and Print.

• Specify the source and derived file formats in item revision definition configuration (IRDC). IRDC
manages the definition of a document revision in Teamcenter.

• Specify the naming convention for the rendered documents in IRDC, if required.

• Set up system stamps, if required.

• Set up the file translation by creating a dispatcher service configuration.

Supported source and derived formats for document rendering

Source format Derived format


Microsoft Office (Word, Excel, and PowerPoint), PostScript PDF
Microsoft Office (Word, Excel, and PowerPoint) PostScript
Microsoft Office (Word, Excel, and PowerPoint) TIF
DXF, HPGL, Text, PostScript, and 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 markup in Teamcenter rich client


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 jointly discuss document
changes. The markup can be retained for retrospective reviews or audit purposes. It 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, a reviewer can add a
disposition to a comment with the status Rejected and add a disposition comment such as Out
of the scope of this project.

10-26 Deploying Document Management PLM00553 12.2


Configuring Document Management

To set up applications for document markups:


• Specify the markup information in an item revision definition configuration (IRDC). IRDC defines
how a document revision is handled in Teamcenter.

• Enable applications for markups by modifying the associated tool objects. A tool refers to a
software application such as Microsoft Word or Adobe Acrobat.

• Specify the applications to be launched for marking up Microsoft Office documents. For example,
you can specify that an Excel file can be opened in Word for marking it up.

• Turn off Adobe protected mode for marking up PDFs.

You can also provide access privileges to users for marking up documents by using access control
lists (ACLs).

Enable applications for document markups


To enable an application for markups, you modify the associated tool object, which represents a
software application such as Microsoft Word or Adobe Acrobat. To do so:
1. In BMIDE, select the project in which you are performing the Document Management
configurations.

2. Go to Extensions→Options→Tool and double-click the required application, for example,


MSWord.

3. Click the Tool Markup Info tab and select the Markup Capable? check box.

Specify 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

• 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 steps specified at
https://www.adobe.com/devnet-docs/acrobatetk/tools/AppSec/sandboxprotections.html#configuration
if you have installed Teamcenter Acrobat/Reader Plugin.

PLM00553 12.2 Deploying Document Management 10-27


Chapter
Chapter 10:10:Configuring
Configuring Document
Document Management
Management

Provide access privileges for marking up documents


You can provide access privileges to users for marking up documents by using the following access
control lists (ACLs) in Access Manager:

ACL Path Description


Markup Item Has Class(POM_application_object) → View and markup action
Working→Has Class (Item) privileges for items.
Markup Item Has Class(POM_application_object) → View and markup action
Revision Working→Has Class (ItemRevision) privileges for item revisions
Markup Dataset Has Class(POM_application_object) → View and markup action
Working→Has Class (Dataset) privileges for datasets
Private Markup Has Class(POM_application_object) Read, write, and delete
→ Working→Has privileges for datasets
Attribute(Dataset:markup_acl=PrivateMarkup) having private markups
General Markup Has Class(POM_application_object) Read, write, and delete
→ Working→Has privileges for datasets
Attribute(Dataset:markup_acl=GeneralMarkup) having general markups
Markup Official Has Class(POM_application_object) Read, write, checkin,
→ Working→Has checkout, and delete
Attribute(Dataset:markup_official=1) privileges for datasets
having official markups

To let users mark up rendered PDFs, you can do one of the following:
• Grant the Markup access privilege for the World accessor type for all markup ACLs.

• Edit the Dispatcher client configuration file


dispatcher_root\DispatcherClient\conf\Service.properties to set
Service.DataSetOwner=CAD.

Setting up document printing


About document printing
You can set up the document printing process such that users can print documents directly from
Teamcenter. All documents attached to a document revision can be printed in a batch. You can set
up banner pages to group and organize print jobs when documents are printed in a batch. A banner
page identifies the end of a document and the start of another documented during printing. Further,
you can configure the process to include stamps such as the watermark, logo, user name, date and
time, or distribution statement in the printed documents.
To set up document printing:
• Ensure that you have installed Dispatcher with the BatchPrint and PreviewService translators.

• Ensure that you have installed Lifecycle Visualization Convert and Print.

• Define the print settings by creating a print configuration.

10-28 Deploying Document Management PLM00553 12.2


Configuring Document Management

For printing from UNIX machines, you must set the printer device and page specifications in the
vvcp.operating-system.cfg configuration file.

• Set the DM_IsBatchPrintingEnabled preference to True to enable the Files print option on
the Active Workspace Print panel.

• Specify banner pages, if required.

• Configure system stamps, if required.

Define print settings through a print configuration


A print configuration object defines the print settings. When a user prints a document revision,
all documents attached to it are printed. A sample print configuration is available in the
TC_ROOT\sample\document_management\docmgt_samples.xml BMIDE template file.
To create a print configuration object:
1. In BMIDE, click BMIDE→New Model Element.

2. In the Add New Model Element dialog box, select Print Configuration in Wizards and click
Next.

3. Enter the following Dispatcher service information for the print configuration and click Next:

PLM00553 12.2 Deploying Document Management 10-29


Chapter
Chapter 10:10:Configuring
Configuring Document
Document Management
Management

Field Action
Provider Name Type the name of your organization as the provider of the service, for
example, A4 Technologies.
Provider Type the name of your organization the way you want it to be displayed
Display Name on the user interface.
Service Name Type the name of the translator that will perform the translation, for example,
batchprint.
Service Display Type a name for the translation service the way you want it to be displayed
Name on the user interface, for example, Batch Print Service.

10-30 Deploying Document Management PLM00553 12.2


Configuring Document Management

Field Action
Dispatcher Click Add to add arguments that you want to send to Dispatcher.
Service
Arguments

4. Enter the following print settings and click Finish:

PLM00553 12.2 Deploying Document Management 10-31


Chapter
Chapter 10:10:Configuring
Configuring Document
Document Management
Management

Field Action
Printer Name Select a network printer. To obtain the 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.
Paper Size Add the supported paper sizes.
Supported Add the supported document file formats that can be printed, for example,
Datasets MSWord.

10-32 Deploying Document Management PLM00553 12.2


Configuring Document Management

5. Ensure that the print configuration object is displayed in the Print Configuration folder.

6. Deploy the template from the Business Modeler IDE.

7. Restart Pool Manager and restart the Teamcenter server.

8. 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 the rich client, in My Teamcenter, select an object with the 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.

PLM00553 12.2 Deploying Document Management 10-33


Chapter
Chapter 10:10:Configuring
Configuring Document
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.

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.
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\

10-34 Deploying Document Management PLM00553 12.2


Configuring Document Management

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}
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].

PLM00553 12.2 Deploying Document Management 10-35


Chapter
Chapter 10:10:Configuring
Configuring Document
Document Management
Management

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:
PS1 DEVICE Postscript,300,0.5,0,0,0,0 in \n\

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).
PS1 DEVICE Postscript,300,0.5,0,0,0,0 in \n\
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


! ======================================

10-36 Deploying Document Management PLM00553 12.2


Configuring Document Management

! 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

PLM00553 12.2 Deploying Document Management 10-37


Chapter
Chapter 10:10:Configuring
Configuring Document
Document Management
Management

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.

Setting up stamps for rendered or printed files, and existing PDFs

About setting up stamps


In Document Management, the following elements are categorized as stamps:
• Logos

• Distribution statements (for example, Export Controlled ITAR)

• Teamcenter attributes such as document name, description, and date and time.

• System stamps such as watermarks, user names, and date and time information.

• User stamps, which constitute any text that you want to include in a document (for example,
Internal Distribution).

You can set up stamps to be included in a rendered or a printed document, and in existing PDFs that
are sent to a stamp workflow by users.
You can also include workflow signoff table information, such as a workflow template name, group,
role, user name, user ID, and comments, in a rendered or a printed PDF. This signoff information
is the one the author sees on the Workflow Signoff dialog box while sending a document revision
through a review workflow.
To set up stamps:
• Attach the logo file to the Document Management template revision that you have created for
stamps. You can attach multiple logo files.

• Specify how the logos and distribution statements must be processed in the Document
Management configuration XML file. You then attach the file to the Document Management
template revision. You can attach multiple distribution statements.

• Define the styling of the stamps. For example, you can set the font and the position of the
watermark, or the position of the logo and workflow signoff table.
o For rendered or printed files, define the styling in a MetaData Stamp file and attach the file to
the Document Management template revision.

10-38 Deploying Document Management PLM00553 12.2


Configuring Document Management

o For existing PDF files, update the PDF command file attached to the Document Management
template revision.

• Set up system and user stamps by creating a system stamp configuration. You can choose to
include these stamps when a file is only rendered, only printed, both rendered and printed,
or in existing PDFs.

After setting up stamps, you can choose to include them in:


• Rendered or printed documents while setting up document rendering and printing.

• Existing PDF files when authors send them through a stamping workflow. For this, you must set
up a workflow process template by using the DOCMGTAPP-apply-pdf-control action handler.

• Microsoft Word documents by first setting up attribute exchange through logical objects. Next,
set up a workflow process template by using the DOCMGTAPP-update-docprop-logicalobject
action handler. When authors send Word documents through a workflow, stamps are included in
the documents.

To improve the output quality of stamped PDF files, update the Lifecycle Visualization vvcp.ini file.

Specify information about logos, distribution statements,and workflow signoff


tables in the Document Management configuration XML file
You specify information about logos and distribution statements in the
Document Management configuration XML file. You may refer to the Document
Management configuration schema file (DocMgmtConfig.xsd) located at
TC_ROOT\sample\document_management\importdmtemplates to create the configuration XML
file. In this file, you can specify the logos to be used, when to use a logo, and where to place the logo
in a PDF file. You can also specify similar information for distribution statements, workflow signoff
tables, and Teamcenter attributes. After specifying the required information, you must attach the
configuration XML file to a system stamp Document Management template revision.

A snippet of a list of columns in the workflow signoff table


You can define the columns to be displayed in a workflow signoff table. To do so, add the column
names in the Document Management configuration XML file:
...
<!--workflow signoff table column names to display, can be removed or reordered
These names listed below are internal names, not the display names-->

<dmcfg:WorkflowSignOffColumnsToDisplay>
<dmcfg:WorkflowSignoffColumnName>processName</dmcfg:WorkflowSignoffColumnName>
<dmcfg:WorkflowSignoffColumnName>group</dmcfg:WorkflowSignoffColumnName>
<dmcfg:WorkflowSignoffColumnName>role</dmcfg:WorkflowSignoffColumnName>
<dmcfg:WorkflowSignoffColumnName>userName</dmcfg:WorkflowSignoffColumnName>
<dmcfg:WorkflowSignoffColumnName>userId</dmcfg:WorkflowSignoffColumnName>
<dmcfg:WorkflowSignoffColumnName>decisionStringDisplay
</dmcfg:WorkflowSignoffColumnName>
<dmcfg:WorkflowSignoffColumnName>decisionDateString
</dmcfg:WorkflowSignoffColumnName>
<dmcfg:WorkflowSignoffColumnName>comments</dmcfg:WorkflowSignoffColumnName>

PLM00553 12.2 Deploying Document Management 10-39


Chapter
Chapter 10:10:Configuring
Configuring Document
Document Management
Management

</dmcfg:WorkflowSignOffColumnsToDisplay>
...

By default, all columns are displayed in the workflow signoff table. You can add, remove, or reorder
the columns as required.

A snippet of the logo and distribution statement information

...
<dmcfg:logoList>
<dmcfg:logoDataset datasetName="Logo" ID="1">
<dmcfg:enableWhen>
<dmcfg:property key="fnd0CurrentLocationCode" value="Shoreview" />
</dmcfg:enableWhen>

<dmcfg:MSOfficePlacement>
<dmcfg:tag value="Logo_1" />
</dmcfg:MSOfficePlacement>
</dmcfg:logoDataset>
</dmcfg:logoList>

<dmcfg:distStatementList>
<dmcfg:distStatementDataset datasetName="ExportControlledITAR" ID="1" />
<dmcfg:enableWhen>
<dmcfg:property key="fnd0CurrentLocationCode" value="Shoreview" />
</dmcfg:enableWhen>

<dmcfg:MSOfficePlacement>
<dmcfg:tag value="Statement_1" />
</dmcfg:MSOfficePlacement>

<dmcfg:distStatementDataset datasetName="NonExportControlledITAR" ID="2" />


<dmcfg:enableWhen>
<dmcfg:property key="fnd0CurrentLocationCode" value="Cypress" />
</dmcfg:enableWhen>

<dmcfg:MSOfficePlacement>
<dmcfg:tag value="Statement_2" />
</dmcfg:MSOfficePlacement>

</dmcfg:distStatementDataset>
</dmcfg:distStatementList>
...

Attach files to a Document Management template revision


To attach the logo, distribution statement, Document Management configuration XML file, PDF
command file, and MetaData Stamp file to a Document Management template revision that you
created for stamps:

1. In My Teamcenter, select the required system stamp Document Management template revision.

2. Click File→New→Dataset.

10-40 Deploying Document Management PLM00553 12.2


Configuring Document Management

3. In the New Dataset dialog box:


a. Enter the Name of the dataset as the name of the logo or distribution statement specified
in the Document Management configuration XML file. For example, the datasetName of
a logo in the configuration XML file is Logo_1. Therefore, the name of the dataset for the
logo must also be Logo_1.

b. Import the logo image file, distribution statement text file, or Document Management
configuration XML file.

c. In Relation, select Document Page while attaching the logo, distribution statement, or
Document Management configuration XML file.
For PDF command and MetaData Stamp files, select Tc_Attaches.

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 start a workflow process to
release the dataset.

7. To release the dataset, 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 schema file that is attached to the dataset.

c. Click OK.
A release flag is displayed next to the released dataset.

Define the styling of stamps for rendered and printed files


To define the styling of stamps for rendered and printed files, you set a MetaData Stamp (MDS) file.
In this file, you can specify the styling, such as the font and position of the watermark. You can also
specify the position of the logo and the workflow signoff table.
To set an MDS file, you must do one of the following:
• Create your own 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.

PLM00553 12.2 Deploying Document Management 10-41


Chapter
Chapter 10:10:Configuring
Configuring Document
Document Management
Management

To update an 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. Use \Attribute to define all stamps that
you want to include.

Example
\RemoveAllStamps
Submitted by \Attribute(FullUserName) on \Attribute(DateAndTime)
\Attribute(DistStmtText_1)
\Attribute(DialogUserStamp)
\Pos(36,-72)
\Char(8)
OS User: \Attribute(OSUserName)
\Attribute(SystemStamp)
\Font(Courier)
\Char(10)
\AutoPos(5,366)
\Attribute(WorkflowSignOffTable)
\Font(Arial)
\Pos(-170,-72)
Teamcenter User: \Attribute(TCUserName)
\Attribute(UserStamp)
\Watermark(LL2UR,AUTO)
\Attribute(Watermark)
\Logo(\Attribute(LogoFilePath_1), 292, 152)

Attribute Description
LogoFilePath_1 Specifies 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
the \Logo attribute for each logo. Also specify the ID of
the logo after the underscore character, for example,
LogoFilePath_1. You can obtain this ID from the
Document Management configuration XML file.
You can use Teamcenter Visualization Convert to
determine the size of the logo in order to specify the x and
y coordinates accurately.
DistStmtText_1 Specifies the distribution statement. To include multiple
distribution statements that you specified in the Document
Management configuration XML file, specify the ID of each
distribution statement after the underscore character, for
example DistStmtText_1

10-42 Deploying Document Management PLM00553 12.2


Configuring Document Management

WorkflowSignOffTable Specifies the workflow signoff information when a


document revision is sent through a review workflow
process.
By default, the workflow signoff table is added to all
pages. To include the table only on the first page,
update the Teamcenter Visualization vvcp.ini file to
set StampPage=first in the Prepare section. However,
for rendered or printed PDFs, stamps are included in all
pages. The PDF dataset must be related to a document
revision.

• (Optional) To remove previously applied text stamps, use the \RemoveAllStamps command.
Include this command before any \Attribute command.

• (Optional) Use the \AutoPos command to move the vertical position of a text stamp when the text
stamp is applied to a PDF file that is previously stamped with a text stamp at the same position.
This command prevents text stamps from overwriting previously applied text stamps.

• 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.

Define the styling of stamps for existing PDF files


To define the styling of the stamps in existing PDFs, you update the PDF command file attached to
the Document Management template revision. Styling a stamp includes specifying the font and
position of a watermark, or the position of a logo and the workflow signoff table. The stamps are
applied to a PDF when it is sent through a stamping workflow. To define the styling:
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 style and placement of the stamps. Include the required
stamps in the propertyDefinitions command:
...
<cmd:propertyDefinitions>
<cmd:propertyDefinition key="FullUserName" />
<cmd:propertyDefinition key="DateAndTime" />
<cmd:propertyDefinition key="SystemStamp" />
<cmd:propertyDefinition key="Watermark" />
<cmd:propertyDefinition key="LogoFilePath_1" />
<cmd:propertyDefinition key="DistStmtText_1" />
...

PLM00553 12.2 Deploying Document Management 10-43


Chapter
Chapter 10:10:Configuring
Configuring Document
Document Management
Management

Specify the Teamcenter attributes that must be added to the PDF file. These are the attributes
that were defined and related to the PDF dataset by using logical objects.

...
<cmd:propertyDefinition key="fnd0Root_object_name" />
<cmd:propertyDefinition key="fnd0Root_object_desc" />
<cmd:propertyDefinition key="m1DocRev_item_revision_id" />
...

5. Specify the text and its styles, such as font and position, in the textStamp command.

Example
The following snippet shows the styles applied to the User Name and Date and Time
stamps:
...
<cmd:textStamp>
<cmd:text>Submitted by \FullUserName on \DateAndTime</cmd:text>
<cmd:font>TimesNewRoman</cmd:font>
<cmd:size>12</cmd:size>
<cmd:position>
<cmd:coordinates y="36" x="36" />
</cmd:position>
<cmd:zOrder>1</cmd:zOrder>
<cmd:additionalText>
<cmd:newline/>
</cmd:additionalText>
<cmd:text>\UserStamp</cmd:text>
</cmd:additionalText>
</cmd:textStamp>
...

The following snippet shows the styles applied to a distribution statement. If you want
to place multiple distribution statements, specify the ID after the underscore character
(for example, \DistStmtText_1). You can get the ID from the Document Management
configuration XML file. Include the backslash character in front of the property name to
retrieve its value.
...
<cmd:textStamp>
<cmd:text>\DistStmtText_1</cmd:text>
<cmd:font>TimesNewRoman</cmd:font>
<cmd:size>10</cmd:size>
<cmd:position>
<cmd:coordinates y="138" x="36" />
</cmd:position>
<cmd:pages>
<cmd:pageRange endPage="1" startPage="1" />
<cmd:pages>
<cmd:textStamp>
...

10-44 Deploying Document Management PLM00553 12.2


Configuring Document Management

The following snippet shows the styles applied to a logo. If you want to place multiple
logos, specify the ID after the underscore character (for example, LogoFilePath_1).
You can get the ID from the Document Management configuration XML file.
...
<cmd:logo>
<cmd:logoFilePathKey>LogoFilePath_1</cmd:logoFilePathKey>
<cmd:position>
<cmd:coordinates x="-170" y="72" />
</cmd:position>
<cmd:pages>
<cmd:pageRange startPage="1" endPage="1"/>
</cmd:pages>
<cmd:zOrder>0</cmd:zOrder>
</cmd:logo>

PLM00553 12.2 Deploying Document Management 10-45


Chapter
Chapter 10:10:Configuring
Configuring Document
Document Management
Management

Example
The following snippet shows the styles applied to the workflow signoff table:
...
<cmd:textStamp>
<cmd:text>\WorkflowSignoffTable</cmd:text>
<cmd:font>Courier</cmd:font>
<cmd:size>10</cmd:size>
<cmd:position>
<cmd:coordinates y="366" x="5" />
</cmd:position>
<cmd:additionalText>
<cmd:newline/>
</cmd:additionalText>
</cmd:textStamp>
...

The workflow signoff table consists of the sign off information contained in the
Workflow Signoff dialog box when a document revision is sent through a review
workflow.
The following snippet shows the styles applied to the Teamcenter attributes:
...
<cmd:textStamp>
<cmd:text>Dataset name:\fnd0Root_object_name
Description:\fnd0Root_object_desc
DocRevID:\m1DocRev_item_revision_id
</cmd:text>
<cmd:font>TimesNewRoman</cmd:font>
<cmd:size>10</cmd:size>
<cmd:position>
<cmd:coordinates y="36" x="255" />
</cmd:position>
</cmd:textStamp>
...

6. (Optional) To specify the pages in which stamps must be includes, use the pages command.
For all pages:
...
<cmd:pages>
<cmd:allPages/>
</cmd:pages>
...

For even pages:


...
<cmd:pages>
<cmd:evenPages/>
</cmd:pages>
...

10-46 Deploying Document Management PLM00553 12.2


Configuring Document Management

For odd pages:


...
<cmd:pages>
<cmd:oddPages/>
</cmd:pages>
...

For a specific range of pages:

...
<cmd:pages>
<cmd:PageRange startPage="1" endPage="3"/>
</cmd:pages>
...

7. (Optional) To remove previously applied text stamps, use the removeStamp command.
...
<!--remove previously applied text stamps-->
<cmd:removeStamp>
<cmd:text>*</cmd:text>
</cmd:removeStamp>
...

8. (Optional) Use the autoposition command to move the vertical position of a text stamp when
the text stamp is applied to a PDF file that is previously stamped with a text stamp at the same
position. This command prevents text stamps from overwriting previously applied text stamps.
...
<cmd:textStamp>
<cmd:text>\DistStmtText_1</cmd:text>
<cmd:font>Courier</cmd:font>
<cmd:size>10</cmd:size>
<cmd:position>
<cmd:coordinates x="36" y="40" />
</cmd:position>
<cmd:autoposition/>
</cmd:textStamp>
...

9. The various commands such as autoposition, textStamp, and removeStamp are


case-sensitive. 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.

Set up system stamps by creating a system stamp configuration


1. In BMIDE, click BMIDE→New Model Element.

2. In the Add New Model Element dialog box, select System Stamp Configuration in Wizards
and click Next.

3. Enter the following information for the system stamp configuration and click Next:

PLM00553 12.2 Deploying Document Management 10-47


Chapter
Chapter 10:10:Configuring
Configuring Document
Document Management
Management

Field Action
Business Object Select ItemRevision.
Condition Select the condition under which this stamp is applicable.
Applies To Choose one of the following:
• Print: To include the system stamps in a printed file.

• Render: To include the system stamps in a rendered file.

• PDF_Control: To include the system stamps in an existing PDF file


when it is sent to a stamp workflow.

• PrintAndRender: To include the system stamps in both printed and


rendered files.
Include User Select this check box to include the print requester's name in the printed
Name? files.
Include Date Select this check box to include the print date and time in the printed files.
And Time?

10-48 Deploying Document Management PLM00553 12.2


Configuring Document Management

4. Enter the following stamp information and click Finish:

Field Action
Properties Specify the properties that must be included in the printed or rendered
files. You can optionally specify a prefix that must precede a property, for
example, Document Name: <object_name>.
User Stamp Type the text that you want to appear on the document, such as Internal
Distribution.
Watermark Type the text that you want to appear as a watermark, such as Confidential.
MDS Template Select the MetaData Stamp template that defines how the stamps must be
applied in the printed and rendered files.
To apply stamps in existing PDF files, select the PDF control command
XML file.

The newly created system stamp configuration is listed under Extensions→Document


Management→System Stamp Configuration.

PLM00553 12.2 Deploying Document Management 10-49


Chapter
Chapter 10:10:Configuring
Configuring Document
Document Management
Management

Set up a workflow to include information in PDF files


1. Create a workflow process template
a. In Workflow Designer, click File→New Root Template.

b. In the New Root Template dialog box, enter a name in New Root Template Name.

c. Select Empty Template in Based On Root Template and Process in Template Type.

d. Click OK to create a workflow process template.

2. Add a task to the workflow process template

a. On the toolbar, click Edit Mode and then click Task .

b. In the process flow pane, double-click where you want to place the new task.
A new task appears with the default name New Task #. In the Name box, type a name for
the task.

3. Link the task to its predecessor and successor tasks


a. Click the task node you want to specify as the predecessor task.

Caution
Do not click the title bar of the task node as this action drags the task node to a
different location.

b. Drag your cursor to the task node you want to specify as the successor task.
A link arrow follows the cursor as you drag. When your cursor moves over a task node, the
node is highlighted.

c. Release the mouse button.


A link arrow connects the predecessor and successor nodes.

4. Configure the task


a. Right-click the task and click Task Properties.

b. Click the Task Handler pane.

c. In Task Action, select Complete.

d. In Action Handler, select DOCMGTAPP-apply-pdf-control to create a workflow task to


include stamps in the existing PDF files.

e. Click Create.

10-50 Deploying Document Management PLM00553 12.2


Configuring Document Management

DOCMGTAPP-apply-pdf-control
Description Applies a system stamp, watermark, logo, distribution statement text, workflow
signoff table (if the target object is in a review task), and Teamcenter attributes
when the logical object is related to the attached PDF dataset. A target object
can be an item, an item revision or its subtype, or the PDF dataset itself.
The system stamp is an imprint comprising data such as a watermark and
optional boilerplate text. In Business Modeler IDE, the data model administrator
creates a system stamp configuration, associating the configuration with the
XML command file that defines the watermark and text. The system stamp
configuration also contains Document Configuation, Logo, and Distribution
Statement datasets.
For this handler to apply the stamp and watermark, the following conditions
are required:
• The PDF dataset must be related to the item revision or its subtype.

• The system stamp configuration must be enabled for the item revision or
its subtype. The Applies To attribute of the system stamp configuration
must be set to PDF_Control.

• The PDF Control access privilege must be granted.

• Logos and distribution statements must be enabled based on their


document configuration setting.

Syntax DOCMGTAPP-apply-pdf-control -user_stamp=text string


Arguments -user_stamp
(Optional) Specifies any string for the text portion of the stamp.
Placement Place on the Start action or the Complete action.
Restrictions None

Improve the output quality of stamped PDF files by using Lifecycle Visualization
Convert
While applying stamps to rendered PDF files, update the Teamcenter Visualization vvcp.ini file
by setting StampFormat=PDF in the Prepare section. This setting improves the performance and
output quality, and preserves the text search capability as the stamped 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 the stamp format is set to
PDF in the Teamcenter Visualization vvcp.ini file:
• \BackgroundColor

• \Circle

• \Color

PLM00553 12.2 Deploying Document Management 10-51


Chapter
Chapter 10:10:Configuring
Configuring Document
Document Management
Management

• \FooterCenter

• \FooterLeft

• \FooterRight

• \HalfTone

• \HeaderCenter

• \HeaderLeft

• \HeaderRight

• \Image

• \Include

• \Line

• \Outline

• \Size

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 Document Cloud

• Adobe Reader Document Cloud

Note
For Adobe Reader, the PDF file must have Enable Usage Rights for Digitally Sign
enabled.

10-52 Deploying Document Management PLM00553 12.2


Configuring Document Management

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.

Define how a document revision is handled in Teamcenter


An item revision definition configuration (IRDC) defines how a document revision is handled during its
lifecycle in Teamcenter. You create an IRDC for every document for which you want a standardized
behavior. For example, you can create an IRDC for a specification document. Similarly, you can
create another IRDC for the regulatory filing document. In IRDC, you:

1. Specify the template for which you want a standardized behavior.

2. Specify the source and derived file formats for a document revision.

3. Specify the naming convention of the source and rendered file formats.

4. Set the check in behavior of a document revision.

5. Set the deep copy rules. Deep copy rules govern how item revisions are copied during save
as and revise operations.

6. Specify the markup information.

Specify IRDC base criteria information

1. In BMIDE, click BMIDE→New Model Element.

2. In the New Model Element dialog box, type IRDC in Wizards.

3. In the New IRDC wizard, specify the IRDC base criteria information and click Next:

PLM00553 12.2 Deploying Document Management 10-53


Chapter
Chapter 10:10:Configuring
Configuring Document
Document Management
Management

Field Action
Applies to Browse for the business object for which you want the standardized
Business Object behavior, for example, search for ItemRevision.
Condition Browse for a condition that is applicable to the IRDC. By default, the isTrue
condition is selected.
If the condition set for a parent business object (ItemRevision) resolves to
true but the condition set for its child business object (DocumentRevision)
evaluates to false, the parent's condition is used. However, if conditions
of both parent and child business objects evaluate to false, the isTrue
condition is used.

10-54 Deploying Document Management PLM00553 12.2


Configuring Document Management

Field Action
Create Template Browse for the required Document Management template.

Note
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.

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.

Specify the source and derived file formats


4. Specify the source and derived dataset and click Next:

PLM00553 12.2 Deploying Document Management 10-55


Chapter
Chapter 10:10:Configuring
Configuring Document
Document Management
Management

10-56 Deploying Document Management PLM00553 12.2


Configuring Document Management

Field Action
Source Dataset Click Add to locate the source dataset.

For datasets that contain the Document Management template files, select
TC_Attaches in Item Revision Relation.
For datasets that contains the page information, such as cover page,
signature page, or index page, select the Fnd0DocPageTypeRel in Item
Revision Relation.
Derived Dataset Click Add to locate the derived dataset.

For datasets that contain the Document Management template files, select
TC_Attaches in Item Revision Relation.

PLM00553 12.2 Deploying Document Management 10-57


Chapter
Chapter 10:10:Configuring
Configuring Document
Document Management
Management

Field Action

For datasets that contains the page information, such as cover page,
signature page, or index page, select the Fnd0DocPageTypeRel in Item
Revision Relation.

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.

Specify the naming convention of the source and rendered file formats

5. Set the naming conventions for the source and derived datasets and click Next:

10-58 Deploying Document Management PLM00553 12.2


Configuring Document Management

Field Action
Source Dataset Click Add to define a naming convention for the source dataset.
Naming Rule
The name is built using the information you provide in Source Dataset
Naming Wizard. 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. For example, the name of the source file will be
FS_source<item_name><item_id> (start from the first character of the item
id till the 5th character).<file extension of the dataset>

Derived Dataset Click Add to define a naming convention for the derived dataset.
Naming Rule
The name is built using the information you provide in Derived Dataset
Naming Wizard.

PLM00553 12.2 Deploying Document Management 10-59


Chapter
Chapter 10:10:Configuring
Configuring Document
Document Management
Management

Field Action

Set the check-in behavior of a document revision


6. Specify the behavior of the item revision when it is checked in and click Next:

10-60 Deploying Document Management PLM00553 12.2


Configuring Document Management

Field Action
Derived Choose one of the following options to standardize the checkin behavior of
Visualization an item revision:
Files to Checkin
• 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 irrespective of the names.

• None
Does not attach and check in any derived files.

PLM00553 12.2 Deploying Document Management 10-61


Chapter
Chapter 10:10:Configuring
Configuring Document
Document Management
Management

Field Action
Create Derived Choose one of the following options to create the derived files on checkin:
Visualization
Data • 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.
Special Render Click Add to define which source files must be rendered to the specific
Control Table derived formats during checkin:

Field Action
Item Type the relation between the source dataset and the
Revision document revision.
Relation

10-62 Deploying Document Management PLM00553 12.2


Configuring Document Management

Field Action
When To • Always
Translate
Specifies that the source dataset must always be
translated.

• If First
Specifies that the source dataset must be translated
if it 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. 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.
Input File Type the file names of the source dataset that must be
Names translated during check in. For example, if you specify
*master*, all files with the word, master, in their name will
be translated to the specified derived format.
Derived Type the relation between the derived dataset and the
From document revision.
Dataset
Relation

Set the deep copy rules


7. Set the deep copy rules for the item revision and click Next:

PLM00553 12.2 Deploying Document Management 10-63


Chapter
Chapter 10:10:Configuring
Configuring Document
Document Management
Management

Field Action
Delete Data Specify whether files attached to the item revision should also be deleted
File? when the item revision is deleted. Select Yes to delete the files.
Deep Copy Click Add to create a deep copy rule.
Rules

Specify the markup information


8. In the Enter Markup Information dialog box, configure the markup rules and click Finish:

10-64 Deploying Document Management PLM00553 12.2


Configuring Document Management

Field Action
Markup Specify the application to be used for marking up documents, for example,
Application MSWord. If specified, users can mark up documents only in the specified
application. This is to prevent some users marking up with Lifecycle
Visualization and other users marking up with Adobe tools.
Markup Dataset Specify the document type that can be marked up. For example, if you
specify MSWordX, users can mark up only Microsoft Word documents.
Markup in Select this check box to indicate whether the markup is controlled in the
Context of context of a change. When the check box is selected, a user can only create
Change? or update the markup if they have selected a change object.
Make Markups Select this check box to indicate that all markups must be created as official
Official? markups.
Markup ACL Type the name of an access control list to grant access to markups made
on the document. This is to control if users can see each other’s markups.

The new IRDC appears in the Extensions→Document Management→IRDC folder. Next, you must
save the changes to the data model and deploy the changes to the server:
1. To save the changes to the data model, click BMIDE→Save Data Model.

2. To deploy the changes to the server, click BMIDE→Deploy Template.


Restart Pool Manager to get the servers use the new configuration. You must also restart the
Dispatcher client if it is running.

PLM00553 12.2 Deploying Document Management 10-65


Chapter
Chapter 10:10:Configuring
Configuring Document
Document Management
Management

Set up file translations by creating a dispatcher service configuration


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. To do so:
1. In BMIDE, click BMIDE→New Model Element.

2. In the New Model Element dialog box, type Dispatcher Service Config folder in Wizards
and click Next.

3. In the New Dispatcher Service Config dialog box, enter the required information and click
Finish:

10-66 Deploying Document Management PLM00553 12.2


Configuring Document Management

Field Action
Service Select this check box to make the service available for use.
Available

PLM00553 12.2 Deploying Document Management 10-67


Chapter
Chapter 10:10:Configuring
Configuring Document
Document Management
Management

Field Action
Provider Name Type the name of your organization as the provider of the service, for
example, A4Technologies.
Provider Type the name of your organization the way you want it to be displayed
Display Name on the user interface.
Service Name Type the name of the translator that will perform the translation, for example,
rendermgttranslator.
Service Display Type a name for the translation service the way you want it to be displayed
Name on the user interface, for example, MSWord to PDF.
Priority Select the importance of this service configuration when a multiple
configurations are queued to be executed by Teamcenter Dispatcher.
Configurations with a high priority are executed first, while those with a
low priority are executed last.
Sort Order Enter a number to assign a 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.

Example
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, the Source
Dataset table lists MSWord, MSExcel, and MSPowerPoint, and
the Derived Dataset table lists PDF.

Source Sort order Derived dataset


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

10-68 Deploying Document Management PLM00553 12.2


Configuring Document Management

Field Action
because
MSExcel
is the
only
attached
source
dataset
type.
MSWordA.doc MSWord = 3 MSWordA.doc.pdf Translate
MSExcelA.xls MSExcel = 2 the
MSPower PowerPoint = MSWord
PointA.ppt 1 dataset
type
because
it has
the
highest
sort
order.
MSWordA.doc MSWord = 2 MSExcelA.pdf Translate
MSExcelA.xls MSExcel = 3 the
MSPower MSPowerPoint MSExcel
PointA.ppt =1 dataset
type
because
it has
the
highest
sort
order.

For a document revision, only one dataset type is rendered for a


specified derived dataset type.

PLM00553 12.2 Deploying Document Management 10-69


Chapter
Chapter 10:10:Configuring
Configuring Document
Document Management
Management

Field Action
Service Click Add to add arguments that you want to use in the file translation.
Arguments

4. Enter the dataset type, named reference, and relation information and click Finish:

10-70 Deploying Document Management PLM00553 12.2


Configuring Document Management

Field Action
Source Select the type of named reference that the source dataset uses.
Dataset Named
Reference 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.
Derived Select the type of named reference that the derived dataset uses.
Dataset Named
Reference For example, if the translated file type is PDF, select PDF_Reference.
Derived From Select TC_Derived to show the relationship that the derived dataset has
Dataset Relation with the source dataset. The source dataset is the primary object and the
derived dataset is the secondary object. This field 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, the named reference file of the existing
dataset is updated.
Item Revision Select the relationship that the derived dataset has with the document
Relation revision. The document revision is the primary object and the derived
dataset is the secondary object. This field is optional, and TC_Attaches is
the default relation. The IRDC Derived Dataset table can specify the item
revision relation that overrides this.

The new dispatcher service configuration appears in the Extensions→Document


Management→Dispatcher Service Config folder. Next, you must save the changes to the data
model and deploy the changes to the server:
1. To save the changes to the data model, click BMIDE→Save Data Model.

2. To deploy the changes to the server, click BMIDE→Deploy Template.

Enable thumbnails for documents


Authors attach thumbnails (images) to a document 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 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.

Configure full-text search


When the IDOL 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.

PLM00553 12.2 Deploying Document Management 10-71


Chapter
Chapter 10:10:Configuring
Configuring Document
Document Management
Management

Enable and configure full-text search


Set up full-text search following this process:
1. Install the IDOL full-text search engine using the appropriate server installation (Windows
or UNIX/Linux).

2. Configure IDOL preferences to enable the IDOL 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".

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 IDOL 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

10-72 Deploying Document Management PLM00553 12.2


Configuring Document Management

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 IDOL 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 IDOL installation directory structure.

• Teamcenter log files generated by your session.

• The output from running the build_fts_index utility using the report argument.

• (If running IDOL on a Linux server for a large database and the IDOL log says "insufficient free
file handles") Increase the number of open file handles in the /etc/security/limits.conf file.

Example
Increase the open file handles from the default value (1024) to 4000.

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

• Base Install→Active Workspace→Visualization Server→Visualization Data Server

PLM00553 12.2 Deploying Document Management 10-73


Chapter
Chapter 10:10:Configuring
Configuring Document
Document Management
Management

For installing these features, refer to Active Workspace Deployment and Configuration.

Defining the drag and drop behavior to create document revisions in Active
Workspace
By default, when files are dragged from the computer to a folder in Active Workspace, they are
created as standalone datasets and attached to the folder. You can change this behavior by using
the Dma1CreateDocOnDrop preference. The default value of this preference is blank. You can
change the value to:
• An internal name of an object type, for example, Document. If set to Document, when files are
dragged to a folder, a document revision is created within the folder and the dragged files are
attached to the document revision as datasets. However, when files are dragged to a non-folder
object, a document revision is not created. The dragged files are created as standalone datasets
instead.
You can also use the Dma1CreateDocOnDrop preference to create other items, such as a part.
For this, you must set the value of the preference to Part.

• ShowCreatePanel:object_type, which changes the default behavior to display the Add panel
when files are dragged to a folder. In this panel, authors enter or modify the necessary document
attributes and optionally send the document revision to a workflow.

Example
If you set the value of the Dma1CreateDocOnDrop preference to:
o ShowCreatePanel:Document, the Add panel for creating a document revision
is displayed.

o ShowCreatePanel:Drawing, the panel for creating a drawing revision is displayed.

o ShowCreatePanel:Document&Drawing, both options are displayed on the user


interface. The user can choose one option to create either a document or a
drawing revision.

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

10-74 Deploying Document Management PLM00553 12.2


Configuring Document Management

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.

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 the create, checkin, checkout, revise, and save as processes. An
IRDC is provided by default when you install the Active Workspace Document Management
feature. This feature also sets the TC_Derived relation for Microsoft Word, Excel and PowerPoint to
PDF. It also set the TC_Derived relation for image files to PDF.
By default, the IRDC is applied to Document Revision and Drawing Revision. To change this
behavior, modify the Dma1UseCOTSIRDC preference.

Enable the viewing of 2D images in Active Workspace


By default, users can only view 2D images of type TIF, HPGL, and DXF in the VIEWER pane
of Active Workspace. To enable the viewing of all types of 2D images, you must first remove the
following value from the AWC_defaultViewerConfig.VIEWERCONFIG preference:
Image.AWp0ImageViewer = Image

Next, you must add the following value:


Image.Awp02dViewer = Image

PLM00553 12.2 Deploying Document Management 10-75


Chapter
Chapter 10:10:Configuring
Configuring Document
Document Management
Management

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 do so:
• Install Teamcenter Adobe CC Integration for Active Workspace.

• Remove Teamcenter Adobe CC Integration.

• Specify the URL for accessing Active Workspace from the Adobe applications.

Install Teamcenter Adobe CC Integration

1. Ensure that Active Workspace is installed. For more information on this, refer to Active
Workspace Deployment in the Active Workspace help.

2. Download the Adobe ExMan Command Line Tool ZIP file from
https://partners.adobe.com/exchangeprogram/creativecloud/support/exman-com-line-tool.html.
You can download the version for Windows or for Macintosh as appropriate. For more
information on Adobe's Extension Manager command line utility and the available commands,
see https://helpx.adobe.com/extension-manager/using/command-line.html.

3. Extract the contents of the ExManCmd_win.zip or ExManCmd_mac.zip file into any folder of
your choice, for example, ExMan_root.

4. In the software distribution image of your Teamcenter version, locate the folder
where you downloaded the Active Workspace distribution package and navigate to:
additional_applications\adobe.
In the adobe folder, verify that the following files exist:

• AWIntegration.zxp (this is the Active Workspace Adobe extension file)

10-76 Deploying Document Management PLM00553 12.2


Configuring Document Management

• config.xml (this is the Active Workspace Adobe configuration file that can be configured for
automated deployments)

5. Copy the AWIntegration.zxp file into the ExMan_root folder so that this is in the same location
as the ExManCmd.exe utility.

6. Close all active Adobe applications that are compatible with the extension.

7. For Windows, open the command prompt and enter the following command:
ExManCmd /install AWIntegration.zxp

For Mac, open Terminal and enter the following command:


./ExManCmd --install AWIntegration.zxp

Remove Teamcenter Adobe CC Integration


1. For Windows, open the command prompt and for Mac, open Terminal.

2. Change the directory to the location where you saved the ExManCmd utility, for example,
ExMan_root.

3. For Windows, enter the following command:


ExManCmd /remove "Teamcenter"

For Mac, open Terminal and enter the following command:


./ExManCmd --remove "Teamcenter"

Specify the URL for accessing Active Workspace from Adobe applications
The steps below are optional. If the config.xml file is not present in the correct location, the user can
set the values while executing the Adobe extension for the first time. However, as an administrator, if
you wish to automate the deployment of the Adobe extension, you can perform the following steps to
preconfigure the settings in the config.xml file for the user and to deploy the file in the proper location:
1. In the software distribution image of your Teamcenter version, locate the folder
where you downloaded the Active Workspace distribution package and navigate to:
additional_applications\adobe.

2. Copy the config.xml file into:


• For Windows:
C:\Users\user_name\AppData\Roaming\Siemens\Teamcenter\AdobeExtension

• For Mac: ~/Library/Application Support/Siemens/Teamcenter/AdobeExtension

3. Open the config.xml file and modify the <ActiveWorkspaceUrl> tag to specify the Active
Workspace URL. Ensure that ?ah=true is appended at the end of the URL.

Example
<ActiveWorkspaceUrl>
http://host:port/awc/?ah=true
</ActiveWorkspaceUrl>

PLM00553 12.2 Deploying Document Management 10-77


Chapter
Chapter 10:10:Configuring
Configuring Document
Document Management
Management

4. (Optional) Modify the <WorkingDirectory> tag to specify the directory to use when downloading
or uploading files.

Example
For Windows:
<WorkingDirectory>c:\temp</WorkingDirectory>

For Mac:
<WorkingDirectory>/tmp/com.mb.teamcenter.awc/</WorkingDirectory>

5. Save and close the config.xml file.

10-78 Deploying Document Management PLM00553 12.2


Siemens Industry Software

Headquarters
Europe
Granite Park One
Stephenson House
5800 Granite Parkway
Sir William Siemens Square
Suite 600
Frimley, Camberley
Plano, TX 75024
Surrey, GU16 8QD
USA
+44 (0) 1276 413200
+1 972 987 3000

Asia-Pacific
Americas
Suites 4301-4302, 43/F
Granite Park One
AIA Kowloon Tower, Landmark East
5800 Granite Parkway
100 How Ming Street
Suite 600
Kwun Tong, Kowloon
Plano, TX 75024
Hong Kong
USA
+852 2230 3308
+1 314 264 8499

About Siemens PLM Software

© 2019 Siemens Product Lifecycle Management


Siemens PLM Software, a business unit of the Siemens
Software Inc. Siemens and the Siemens logo are
Industry Automation Division, is a leading global provider
registered trademarks of Siemens AG. D-Cubed,
of product lifecycle management (PLM) software and
Femap, Geolus, GO PLM, I-deas, Insight, JT, NX,
services with 7 million licensed seats and 71,000 customers
Parasolid, Solid Edge, Teamcenter, Tecnomatix and
worldwide. Headquartered in Plano, Texas, Siemens
Velocity Series are trademarks or registered trademarks
PLM Software works collaboratively with companies
of Siemens Product Lifecycle Management Software
to deliver open solutions that help them turn more
Inc. or its subsidiaries in the United States and in other
ideas into successful products. For more information
countries. All other trademarks, registered trademarks
on Siemens PLM Software products and services, visit
or service marks belong to their respective holders.
www.siemens.com/plm.

You might also like