Deploying Document Management
Deploying Document Management
Teamcenter 12.2
Deploying Document
Management
PLM00553 • 12.2
Contents
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.
• Print documents with stamps such as watermarks, stamps, and logos to ensure proper
distribution.
• 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.
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.
The following table describes the role of the components in Document Management deployment:
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
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.
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:
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.
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.
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.
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
• Active Workspace
• Deployment Center
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.
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.
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.
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.
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:
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
8. Once the configuration displays 100% complete in the Selected Components list, click Go
to Deploy to generate the script.
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.
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
Example
aspnet_regiis -pdf "tcsecurity" "C:\inetpub\tcooroot\TcOOWeb"
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"
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.
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.
• 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.
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.
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.
6. Click Finish.
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.
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.
5. Click Finish.
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.
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.
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.
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.
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.
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.
3. In the New Process dialog box, select TCM Release Process from the Process Template list.
4. In the Attachments tab, expand the document template revision and select the datasets to be
released.
5. Click OK.
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.
Task flow to include Teamcenter attributes in Microsoft Office or Adobe PDF by using logical
objects
• Define a logical object.
• Define the placement of attributes in Word, Excel, PowerPoint, and PDF files.
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.
Finally, you may verify if you have set up the attribute exchange correctly.
3. On the Logical Object Configuration page, click New > Define 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.
f. Select Forward.
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.
d. Click Add.
You can add as many properties as required for each member.
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
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
• 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.
• 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.
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.
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.
B. In the Field dialog box, select DocProperty in Field names and select a custom property
that you created in Property.
C. Click OK.
The value of the custom property is inserted at the selected location.
To see the value of a custom property later, right click the inserted property and click
Toggle Field Codes.
a. Click FILE→Options.
d. In Main Tabs, select the Developer check box and click OK.
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.
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.
• 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.
The value of the datasetName that matches the title value you specified in Word is placed as
the logo.
• 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.
• In the Content Control Properties dialog box, enter Title and Tag as WorkflowSignoffTable.
• Click OK.
7. After creating the Word document, attach it to the required document template revision item
and check in the template.
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.
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.
g. Click Add.
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.
6. To insert logos:
a. Click Insert→Pictures.
8. After creating the Excel file, attach it to the required document template revision item and check
in the template.
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.
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.
a. Insert a text box for each property. You can also use the existing text boxes, if any.
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.
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.
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.
8. After creating the PowerPoint file, attach it to the required document template revision item
and check in the template.
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.
After defining the placement information, you attach these files to the system stamp Document
Management template revision.
3. Select the logical object that you created for the document revision in Logical Object Type
Relation.
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.
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.
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.
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.
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.
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.
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.
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.
e. Click Create.
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.
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.
Arguments -user_stamp
(Optional) Specifies any string for the text portion of the stamp.
Restrictions None
To verify if you have configured generic attribute exchange correctly, you can perform one of the
following:
• 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.
• 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.
• 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.
• 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.
You can also provide access privileges to users for marking up documents by using access control
lists (ACLs).
3. Click the Tool Markup Info tab and select the Markup Capable? check box.
• Outlook_ViewMarkup_Launchable_TcTypes
• PowerPoint_ViewMarkup_Launchable_TcTypes
• Word_ViewMarkup_Launchable_TcTypes
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.
• Ensure that you have installed Lifecycle Visualization Convert and Print.
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.
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:
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.
Field Action
Dispatcher Click Add to add arguments that you want to send to Dispatcher.
Service
Arguments
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.
5. Ensure that the print configuration object is displayed in the Print Configuration folder.
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.
• 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.
\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.
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\
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].
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\
! 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\
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.
• 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.
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.
• 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.
<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>
</dmcfg:WorkflowSignOffColumnsToDisplay>
...
By default, all columns are displayed in the workflow signoff table. You can add, remove, or reorder
the columns as required.
...
<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:MSOfficePlacement>
<dmcfg:tag value="Statement_2" />
</dmcfg:MSOfficePlacement>
</dmcfg:distStatementDataset>
</dmcfg:distStatementList>
...
1. In My Teamcenter, select the required system stamp Document Management template revision.
2. Click File→New→Dataset.
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.
c. Click OK.
6. Select the dataset and click File→New→Workflow Process to start a workflow process to
release the dataset.
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.
• 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.
• 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
• (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.
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" />
...
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>
...
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>
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>
...
...
<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>
...
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:
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.
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.
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.
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.
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.
e. Click Create.
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.
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
• \FooterCenter
• \FooterLeft
• \FooterRight
• \HalfTone
• \HeaderCenter
• \HeaderLeft
• \HeaderRight
• \Image
• \Include
• \Line
• \Outline
• \Size
Note
For Adobe Reader, the PDF file must have Enable Usage Rights for Digitally Sign
enabled.
The DIGITAL_SIGN privilege lets users create an access control list (ACL) rule to digitally sign a PDF
file and to cancel a digital signature.
The Digital Sign Dataset ACL rule grants the owning user and owning group digital signing privileges
for the dataset object.
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.
o The signed PDF file updates the PDF file stored in Teamcenter.
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.
2. Specify the source and derived file formats for a document revision.
3. Specify the naming convention of the source and rendered file formats.
5. Set the deep copy rules. Deep copy rules govern how item revisions are copied during save
as and revise operations.
3. In the New IRDC wizard, specify the IRDC base criteria information and click Next:
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.
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.
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.
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:
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.
Field Action
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.
• None
Does not attach and check in any derived files.
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
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
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
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. 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:
Field Action
Service Select this check box to make the service available for use.
Available
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.
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.
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:
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.
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.
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.
• TC_fts_default_AND_operator
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.
Troubleshooting
To help you investigate problems with full-text search, you can check:
• Log files created in the IDOL installation directory structure.
• 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.
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.
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.
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.
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.
• Specify the URL for accessing Active Workspace from the Adobe applications.
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:
• 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
2. Change the directory to the location where you saved the ExManCmd utility, for example,
ExMan_root.
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.
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>
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>
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