Administering Manufacturing Planning
Administering Manufacturing Planning
manufacturing
process
management 13.0
Administering
Manufacturing
Planning
PLM00260 - 13.0
Contents
Configuring studies
Enable Study Manager ───────────────────────────────── 11-1
Set up study synchronization ───────────────────────────── 11-1
Study Manager preferences ────────────────────────────── 11-3
Glossary A-1
As you build the process structure, you can assign resources to the various processes, operations, and
activities. You can also identify the specific locations within the plant where each operation and activity
will be performed.
You typically use Manufacturing Process Planner to design and manage the manufacturing processes for
large assemblies. Common tasks are:
• Using enterprise bills of process (BOPs) to capture standards and best practices across the business as
generic processes and operations.
• Comparing structures to find missing parts in source or targets or differences in properties of the two
structures.
For many of these tasks, you must configure aspects of your installation, including setting various
preferences. For example:
Additionally, you can customize Manufacturing Process Planner features to suit your business needs. For
example:
• 3D PDF reports
1. Display the required menu command by adding the following extension to the plugin.xml file
located in portal\plugins\com.teamcenter.siemens.lookandfeel_10000.1.0:
<extension point="org.eclipse.ui.menus">
<menuContribution
allPopups="false"
locationURI="menu:window?after=additions">
<command
commandId="com.teamcenter.rac.cme.contextSuppression"
mode="FORCE_TEXT"
style="push">
<visibleWhen>
<reference
definitionId="com.teamcenter.rac.cme.mpp.inMainView">
</reference>
</visibleWhen>
</command>
</menuContribution>
</extension>
Note:
To activate the command you may need to register your client by double clicking on
genregxml under ..\Teamcenter Root\portal\registry. Without this the command will not be
visible.
Note:
This command may be hidden in your installation. Your administration can display it.
Teamcenter displays the Save dialog box where you can create an XML file that stores the
suppression data or select an existing XML file that you want to modify.
3. Type the name of a new file or select an existing file to modify and click Save.
Teamcenter displays the Suppress Context Menus dialog box. This dialog box allows you to
specify the type of object for which the context menu is customized. Additionally, you select the
view, perspective, and application in which this customization is visible.
4. Select the application, perspective, view, and type of selected object for which you want to limit
the context menu commands.
You can select any of the Open With commands to suppress entries in the Open With context
menu.
You can also suppress context menus in customized Manufacturing Process Planner perspectives.
5. Add the commands by typing their names in the Commands dialog box, selecting them from the
commands list, and adding them to the list on the right with the arrow.
6. Click OK.
7. Make the configured menu available to different groups, roles, or users as follows:
a. Save the XML file from the previous step to a Context Menu Suppression dataset.
b. Add the name of the dataset to the TC_ContextMenuSuppression preference and publish
this preference to the required group, role or user.
MEFilteredChildTypes_type-of-new-dialog_type-of-selected-component
For example:
• MEFilteredChildTypes_Item_Item for the New Item dialog box opened on a selected item
• MEFilteredChildTypes_OP_Process for the New Operation dialog box opened on a selected process
• MEFilteredChildTypes_Item_None for the New Item dialog box when no selection is active
You then publish the preference to the appropriate user, group, or role.
<activity
description="Turn off MyCustomizedPerspective
perspective"
id=”ID-of–MyCustomizedPerspective”
name=”MyCustomizedPerspective”
</activity>
<activityPatternBinding
activityId="com.teamcenter.rac.cme.mpp.MyCustomizedPerspective"
pattern="com\.teamcenter\.rac\.cme\.mpp/
com.teamcenter.rac.cme.mpp.
MyCustomizedPerspective">
</activityPatternBinding>
The ID is the value assigned in the perspective definition in the plugin.xml file.
The pattern value is derived from the value of the ID in the customized perspective definition in the
plugin.xml file.
Note:
Regardless of how you configure the preference, when pasting objects with multiple occurrence
types, the system will only show occurrence types common to both the source and target. If no
common occurrence types are found, the end user receives a message informing him of that fact.
1. Check that VisAutomationApp is installed on the same machine on which Dispatcher is installed.
2. Set FMS_HOME as a system environment variable with the appropriate value and restart the
Dispatcher machine.
3. Install the Update Mass Product Views translator using the TEM installer.
6. Open Windows services and restart the following two services in the following order:
a. Dispatcher Scheduler
b. Dispatcher Module
The administrator must install the following features using Teamcenter Environment Manager to
connect Product Configurator to Manufacturing Process Planner and Structure Manager.
1. Run Teamcenter Environment Manager (TEM) and navigate to the Features list.
2. Navigate to the Extensions branch and select Product Configurator and Product Configurator
Support for Structure Manager.
5. Choose Edit→Options to open the preferences dialog box and set the Product Configurator
preference.
6. Click the Search button and type PSM in the Search On Keywords box.
9. Click Close.
Set up 4D planning
Adding a time component to process planning to simulate and visualize construction over an extended
period of time is referred to as 4D planning. 4D planning is used in very large structures to ascertain
what parts are already assembled on a specific date in a specific part of the structure. For example, if
you build a ship, you may want to begin fitting the cabins with furniture. It is necessary to know if the
piping and electrical work is complete by April 30th to begin subsequent work. You can query your
structure, taking the date into consideration, to see what has been assembled by April 30th.
Teamcenter uses an embedded Schedule Manager view to help you associate scheduling information
with process planning operations. The Manufacturing – 4D Scheduling perspective already contains
this view, in addition to structure views to assist you. This is the same view that is contained in the
Schedule Manager application. Making a change in one changes the data in the other.
To configure 4D planning:
2. Set the time zone on the computer running the rich client to UTC (GMT). This is the only supported
time zone.
3. In the rich client, open the Organization application and modify the Calendar setting.
b. Remove lunch breaks in the calendar by clicking Details next to the weekday entries and
modifying the times.
Preference Value
MECopyIdInContextToAssignedLine true
ScheduleTaskAvailableAttributesWithRelations ScheduleTask.fdp0AssociatedProcesses
QS_QSEARCH_ENABLED true
QSEARCH_update_enabled true
QS_BBOX_GENERATION_ENABLED true
QS_BBOX_GENERATION_FROM_NX_ENABLED true
Preference Value
QS_TRUSHAPE_GENERATION_ENABLED true
QS_SPATIAL_ENABLED true
QSEARCH_foreground_processing_halted false
Preference Value
ME4DResultsViewDisplayNameColumnsShownPref Mfg0BvrProcess.bl_indented_title
Mfg0BvrProcess.ScheduledStartDate
Mfg0BvrProcess.ScheduledFinishDate
Mfg0BvrProcess.ScheduledCalculatedDuration
ME4DSearchCriteriaDate fdp0ScheduledStartDate
MEProcessIconPropertyNames start_date
MECopyIdInContextToAssignedLine true
Nonadministrative users can see these search criteria in the Broken Links dialog box. They can modify
them and save their changes to a user preference with the same name as the original search criteria
preference. The next time they use the search criteria, they see the values stored in the user preference
including their modifications. If they want to use the original search criteria that the administrative user
saved, they must delete the user preference.
To avoid this, you can use the BOM Line Title column instead of the BOM Line column. Add the BOM
Line Title column, move it to the far left, and then remove the BOM Line column from the display.
You should then choose Tools → Options in Structure Manager and enter a custom title in the BOM
Line Title format for Items of type: Item box. For example, the following entry shows only the item ID
and name separated by two dashes, but no quantity value:
$bl_item_item_id — — $bl_item_object_name
Note:
As the Options dialog box lists only actual item types in Structure Manager, you cannot customize
process or manufacturing item types directly in this window. To do this, you must first choose
Options → Preferences and create a new preference for each applicable item type, for example,
BOMLine_Title_Format_OP or BOMLine_Title_Format_Process. You can then define the current
value of the preference name in the format shown in the example.
• Define the properties that are combined to create the new property value in the
MEIdGenerationPropertySetting preference.
These can be any single-valued BOM line property. If the property value is empty, Teamcenter uses
that empty value. Two typical properties that you may combine are item ID and absolute
transformation matrix.
ME_angular_tolerance
ME_translation_tolerance
Note:
If you use a CAD integration with Catia or other CAD application and use BOM (Bill of Materials)
to BOM or BOM to BOE (Bill of Equipment), updates sometimes cause small BOM CAD tolerance
variations so that many parts in the model show as changed during advanced accountability
checks. To reduce the number of outliers during such checks, increase the
ME_angular_tolerance and ME_translation_tolerance values to reduce the tolerances.
• Run the me_stamp_ids utility to generate the new property value for an entire structure, based on a
closure rule.
• Create a workflow process based on the ME-stamp-ids-AH action handler to automate the process
from the user interface.
When using the utility or action handler, you can specify whether Teamcenter allows duplicate property
values in the MEIdGenerationAllowDuplicates preference.
1. By default, incremental changes are not enabled. To enable incremental changes, set the
Incremental_Change_Management preference to true.
2. Configure the change types to use with incremental change with the Change Viewer application.
3. By default, all incremental changes (configured and unconfigured) are visible to the user. To hide
unconfigured changes, set the ShowUnconfiguredByChangeEffectivity preference to true.
4. Define a release status that is attached to an incremental change when the user first creates it. For
example, the following setting creates each incremental change with a Pending status.
Incremental_Change_ReleaseStatus=Pending
The status must already exist and have an Access Manager rule that allows write access to objects
with this status.
5. Ensure an In IC Context rule is available in Access Manager, allowing a user write access to a
released structure.
Example:
Process
Mfg0MEPlantBOP
You can also set MCN requirements by a structure's root node type and release status name.
Note:
MCN capabilities require a special license and installation to work in Teamcenter. After installation,
set the MEMCN_management_enabled preference to true to enable change notice revision
commands in Manufacturing Process Planner.
To allow users to set statuses on an MCN, change notices must have valid release statuses defined in the
MEMCN_release_statuses preference.
You can make change notices mandatory before users may edit certain types of structures. To configure
such types of structures, adding the item type of the structure's top line to the role-based
MEMCN_change_notice_mandatory_types preference.
Example:
Process
Mfg0MEPlantBOP
Use the MEMCN_release_revision_mode preference to control how statuses are created on item
revisions being tracked by a change notice revision. Use closure rules, such as a rule to exclude tools
with a status of TCM Released, to exclude items from being captured by a change notice.
Tip:
You can customize change notice report layout and elements using preferences with the suffix
MECTRev.
Note:
When a subassembly node is assigned from an EBOM to an MBOM, change notices track the
assigned node and all of its children because the default value of the preference
MEMCN_solution_object_collection_rule is GetChangedProcessLines. To add custom business
objects to change notices, you must add them to the closure rule GetChangedProcessLines. If an
EBOM line type is different from MBOM (for example, part versus item), you can modify the
closure rule in this preference to define which lines are assigned and which are not. For example,
to keep the assigned line of type PART from being added to the change notice, define the closure
rule:
BOMLine:BOMLine:bl_all_child_lines:SKIP:PRIMARY.bl_item_object_type=
=
"Part"
Using the utility with various mode types lets you upgrade product views in different ways. When
mode=bopwithpv, you can generate an XML file that lists all affected product views.
Example:
C:\Siemens\Tc116\tcroot\tc_menu> upgrade_pv_with_visiblelineinfos -u=zz -p=zz g=myGroup -
mode=bopwithpv -outputfile=13Nov2018.xml -log=13Nov.log
The file lists each individual BOP with its itemID and other attributes, along with each affected product
view (PV). You can compare the product views in the XML by opening the BOPs in Teamcenter and
performing a product view search.
You can also extract item IDs for product views that need to be upgraded by setting -
mode=pvsneedingmigration. The XML file can be used to upgrade all affected product views reported in
a BOP by running the utility once more and setting rootitemid to the BOP itemID.
Example:
C:\Siemens\Tc116\tcroot\tc_menu> upgrade_pv_with_visiblelineinfos -u=zz -p=zz g=myGroup
rootitemid=L029084 -log=13Nov.log
Once you have run the utility, you can verify that the product views have been upgraded by running the
utility again as in the first example. If fixed, the product views do not appear in the resulting XML file.
You can also batch update all BOPs in the XML file by setting -mode=upgradepv and specifying the XML
file as the inputfile.
Example:
C:\Siemens\Tc116\tcroot\tc_menu> upgrade_pv_with_visiblelineinfos -u=zz -p=zz g=myGroup -
mode=upgradepv -inputfile=13Nov2018.xml -log=13Nov.log
If you have a collaboration context (CC) that contains multiple BOPs, you can also use the utility to
upgrade all BOPs contained in it by extracting BOP IDs.
Example:
C:\Siemens\Tc116\tcroot\tc_menu> upgrade_pv_with_visiblelineinfos -u=zz -p=zz g=myGroup -
cc=myCC -log=13Nov.log
To force upgrades to affected views in a BOP and thereby verify all are updated, you can set -
mode=upgradeallpvs
Example:
C:\Siemens\Tc116\tcroot\tc_menu> upgrade_pv_with_visiblelineinfos -u=zz -p=zz g=myGroup -
mode=upgradeallpvs -log=13Nov.log
To configure the Custom Process View, you can do any of the following:
• Modify the types of tables on the right side of the view and the occurrence types that are displayed in
these tables.
• Modify the commands available in the toolbars of the child lines and consumed items tables.
You can add or remove commands by setting the preferences selected in the
MECustomViewChildLinesCommandNames and
MECustomViewConsumedItemsCommandNames preferences.
Note:
To view all related preferences, choose Edit→Options, select Search, and type mecustomv in the
top Preference By Filters line.
You can use the following preferences to define the appearance of the Customer Process View.
• Define the names of the style sheet datasets in the following preferences:
Mfg0BvrProcess.SUMMARYRENDERING
Mfg0BvrOperation.SUMMARYRENDERING
• Define the commands available for the main table on the left. These commands are shown above the
table.
MECustomViewChildLinesCommandNames
• Define the commands available for each of the child tables on the right in this preference:
MECustomViewConsumedItemsCommandNames
MECustomViewConsumedItemsOccTypes
• Define the properties shown as columns and the widths of these columns in the main table on the
left:
MECustomViewChildLinesColumnsShownPref
MECustomViewChildLinesColumnWidthsPref
• Define the properties shown as columns and the widths of these columns in the tables on the right:
MECustomViewConsumedItemsColumnsShownPref
MECustomViewConsumedItemsColumnWidthPref
Ensure that you have a backup copy of each of the style sheets in order to return to the default
configuration if necessary.
5. Send a process from My Teamcenter to Manufacturing Process Planner. If the Custom Process
View is already open, close it.
6. Open the Custom Process View view for that process line by right-clicking the process and
choosing Open With→Custom Process View.
The changes you made in My Teamcenter are visible in the Custom Process View in the order specified
in the XML.
relation-property-type:occurrence-type
You can add additional table types by checking the Business Modeler IDE for more occurrence types.
To enable the comparison, you must configure the mapping of the properties between the design
features and the manufacturing features.
BOM-line-property:design-element-property
For example:
Bl_absolute_transform:DE_absolute_transform
Bl_effectivity:DE_effectivity
Bl_note_type1:DE_custom_attribute1
The selection of properties that are carried forward during the assign process is specified in the
Cpd0DEPropertiesForMBOM global constant. The value of this constant consists of a list of design
element properties, for example:
DE_absolute_transform
DE_effectivity
DE_custom_attribute1
The properties that are carried forward to the BOM line are the properties that are available for
propagation after running an accountability check.
Additionally, if the design element has an associated attribute group, these attributes are copied to a
designated form on the BOM line. The mapping between attribute group and form type is specified in
the Cpd0DEAttrGroupTypeToFormType global constant. This constant has the following format:
attribute-group:form-type
For example:
EngAttributes:FormEngAttributes
Caution:
You should only map one attribute group to one form. Mapping multiple attribute groups to one
form results in errors in the partial match report of the accountability check.
Teamcenter uses graphic data stored in datasets attached to the process structure. The data originates
from Teamcenter or Process Simulate. The recipients of the report do not require Teamcenter to view
them; Adobe Acrobat Reader (Version 9.4.3 or later) is sufficient.
To assist you in quickly creating and formatting effective 3D PDF reports, Siemens provides the following
standard templates:
• 2DPDF Work-instructions
Creating a typical 3D PDF report can be time-consuming. Therefore, the Teamcenter external server
(ETS), consisting of Dispatcher Server and translators, is used to generate the report remotely and free
up your computer for other tasks.
The import files for the default templates are located at Teamcenter_root_directory\ install
\cmtmes\pdftemplates. You can duplicate any of these and use them as a starting point for your
customized files.
2. Compose an XML file listing the import files and other information, as shown in the following
example:
-<ME_3DPDF_ImportData>
-<Templates>
-<TemplateInput name=”PDF_Template”>
-<Contain2D val=”False”/>
-<Contain3D val=”True”/>
-<ContainSimulation val=”False”/>
-<DataSource val=”TC”/>
-</TemplateInput>
-</Templates>
-</ME_3DPDF_ImportData>
The first entry contains the TemplateInput name node. This is the name of the dataset in
Teamcenter and is displayed by the 3D PDF wizard when creating the report.
• Contain 2D
Set to True if the 3D PDF report contains 2D elements; otherwise, set to False.
• Contain 3D
Set to True if the 3D PDF report contains 3D elements; otherwise, set to False.
Note:
If your report contains both 2D and 3D elements, set Contain 2D and Contain 3D to
True.
• ContainSimulation
Set to True if the 3D PDF report contains simulations originating in Process Simulate;
otherwise, set to False.
Note:
If the data source for the report is Teamcenter, set ContainSimulation to False.
• DataSource
If the data source for the report is Teamcenter, set this parameter to TC; if the data source is
Process Simulate, set it to PS.
• Run the following command from the command line: install_mes_templates -u -p -g -file.
■ -u=administrative_user
■ -p=password
■ -g=group
■ -file=inputFile.xml
For more information, consult the Help_Patching_3D_PDF_Solution.txt file found in the following
directory:
Teamcenter-root\install\cmtmes
Caution:
Do not overwrite 3D PDF templates as they may be replaced when you upgrade to the next
software version. Make a copy and modify the copy.
2. On the same host, define the TC3DSS_ENABLE_PRUNED_LAUNCH system variable and set it to
True.
3. Set FMS_HOME as a system environment variable with the appropriate value and restart the
Dispatcher host.
• Install Dispatcher Client for Rich Client, Dispatcher Server, and Dispatcher Client.
5. For four-tier installations, use the Web Application Manager to add Dispatcher Client for Rich
Client Solution to the third stage.
8. Open Windows services and restart the following two services in the following order:
a. Dispatcher Scheduler
b. Dispatcher Module
• Teamcenter Manufacturing 3D PDF documentation license on the same machine as the Teamcenter
licenses
6. Click Save and Check-In in the Edit Properties dialog box to save the changes.
3D PDF reports
By default, Teamcenter delivers a variety of templates that it uses to create 3D PDF reports. You can use
these templates as a basis to create your own templates that reflect the business needs of your
company.
Caution:
Do not overwrite these templates as they may be replaced when you upgrade to the next software
version. Make a copy and modify the copy.
The 3D PDF mechanism is based on having a dataset that contains specific document types and
relations. When creating your own template, you must be careful to include all the required documents
and create the required relations so that the mechanism functions properly.
To assist you with creating the required files and relations, Teamcenter provides you with an import
utility, install_mes_templates.exe, that creates the dataset containing files and relations that you can
modify. As input, this utility uses an XML file that describes the contents of the dataset.
1. Run a dataset search on the *PDF* string to locate all 3D PDF report datasets in My Teamcenter
and choose the one that most closely resembles the report you want to create.
2. Open the named references and locate each of the files contained in the named reference list. The
following files are contained in the dataset:
• A JavaScript file that you can use to modify various control behaviors.
• A PDF file whose layout you can modify using Adobe LiveCycle Designer.
• An XSL style sheet that you can use to modify the format of the report and to add new
properties.
• A JPEG file that is used as a thumbnail to display the new report template in the list of available
templates in the Generate 3D PDF Report wizard.
3. Copy each of these files under a new name and place them in the same directory as the originals.
4. Modify the XML file that specifies how to populate the dataset.
5. Run a dataset search on the *PDF* string to locate the dataset in My Teamcenter.
6. Open the named references and identify the following files in the dataset:
7. Modify the 3D PDF preferences. In particular, add the template name to the
ME3DPDFAllowedReportTemplates preference.
The following preferences affect the behavior of the 3D PDF report generation:
• ME3DPDFAllowedReportTemplates
Lists all 3D PDF report templates. If you add a new template, you must add the new template name to
this preference. By default, it lists all the templates included with the Teamcenter installation.
• M33DPDFReportDatasetType
Specifies the dataset type of the 3D PDF report. You generally do not have to change the value of this
preference.
• ME3DPDFAllowedImageDatasetTypes
Lists supported Teamcenter image types for 2D PDF reports.
The import utility is used to create a dataset containing all the files and relations required for a 3D PDF
report. You must create an XML file as input. The XML file contains the paths to the required files and
additional parameters required to create the dataset. You can view the following sample file:
tc_root_directory\install\cmtmes\pdftemplates\TemplateInfo.xml
Customizable components
You can customize the following components when using 3D PDF templates:
Note:
Multipage reports are Acrobat forms and are created using Adobe Acrobat Pro only. They are not
created using LiveCycle Designer.
• Style sheet
PLM XML exported from Teamcenter is not hierarchical. You must write an XSL style sheet that parses
the PLM XML and extracts and rearranges data as required. The PDF template reads this XML using
JavaScript and populates different controls.
• Closure rules
Closure rules are part of the standard Teamcenter infrastructure. Closure rules help you interpret the
PLM XML. You may need to create new closure rules or modify existing ones to export custom
attributes or existing attributes that are currently not exported. For example, sample closure rules
provided with setup include a new closure rule defined for the default implementation. You must
create this rule before using the report. You can add additional clauses to the closure rule as needed.
Teamcenter delivers two Process Simulate and four Teamcenter templates that you can modify to create
a template reflecting your needs. You find these in the cmtmes\install\pdftemplates directory.
You create templates using Adobe LiveCycle Designer. You can either start from a blank template by
choosing Use a Blank Form or start by importing existing templates. Siemens Digital Industries
Software recommends that you build a new template based on one of the sample templates provided.
This ensures that the core JavaScript support required for some basic features is automatically imported.
There are several objects that are essential to the proper functioning of 3D PDF document generation. To
ensure that your new template works properly, you must retain some objects in the sample templates.
This example uses the U3D template to describe these objects as it is a superset of all such objects that
are used for 3D PDF document generation with U3D or PRC data.
• A3DR_3DFrame
This button is replaced with the 3D annotation at runtime during report generation. The dimensions
of the button are used for the 3D annotation area. It is essential that the caption of the button is
retained as A3DR_3DFrame. You can change the size of the button or the 3D annotation to suit your
needs.
• Populate Steps
This is a hidden button responsible for initializing the PDF the first time it opens. This is handled by
the JavaScript on the initialize event of this button.
• Setup3DButton
This is a hidden button responsible for setting up 3D annotation and setting the view associated with
the first step in the 3D annotation. This is achieved by the JavaScript on the docReady event of this
button.
• Change3DViewButton
This is a hidden button responsible for switching views in the 3D area on step selection. Views
(snapshots in Process Simulate) can be associated with operations during generation of the U3D/PRC
files using the Create 3D Documentation command in Process Simulate. This is achieved by the
JavaScript on the form::ready event of this button.
• TextField1
This stores the index used to retrieve the global variables from the global variable list.
• 3D simulation buttons
Each button has associated JavaScript on the click event that has code to achieve the required
behavior.
• Button1 (Rewind)
• Button2 (Pause)
• Button3 (Play)
You can choose from a variety of controls to design your PDF template. Drag the desired control from
the Object Library area to the Design View area.
You can use the script editor included with Adobe LiveCycle Designer to view and modify JavaScript code
on various controls.
You can modify the style sheet to suit your needs but you cannot modify the following sections of the
style sheet. These sections are required by the Generate 3D PDF Report wizard.
When you create a 3D PDF, Teamcenter creates an Adobe XML file. The following section parses that
XML file:
var doc=event.target;
//For consistent highlighting of report fields
app.runtimeHighlight=false;
var inputStream=doc.getDataObjectContents(“TCXMLData”);
var A3DXMLData=util.stringFromStream(inputStream);
A3DXMLData=A3DXMLData.substring(A3DXMLData.indexOf(“<TCXML”));
myTCxml=newXML(A3DXMLData);
The following initializes or adds a global variable to the global variable list. This is necessary to work
around a problem with the 3D PDF where Adobe updates all open PDFs.
if(typeof indexCounter===”undefined”)
{
indexCounter=1;
objectsListArray=newArray();
ViewListArray=newArray();
}
else
{
indexCounter=indexCounter+1;
}
objectsListArray[indexCounter]=newObject();
ViewListArray[indexCounter]=newObject();
TCXMLProcessStep.TextField1.rawValue=indexCounter.to.String();
Every template has its associated style sheet. You can modify this style sheet by changing the format or
adding new properties to the report.
Mandatory extensions
• isIdAvailable
This extension is used in Process Simulate based templates and in Teamcenter templates for product
views only. In the Generate 3D PDF wizard, a user can select which process, operations, and product
view are available in the report. Similarly, a user can select such objects in Process Simulate during
creation of 3D PDF data. This information is stored in XML files. During parsing of the PLM XML using
XSL, this API is used to identify whether the given object is selected by the user.
Syntax
Input
Parameter Description
Output
Output Description
Example
Refer to the style sheet contained in the 3DPDF Work instructions (Process Simulate) dataset.
• AddOccIdToCloneStableIdMap
This extension can be used in Teamcenter based templates only. In the Generate 3D PDF wizard, a
user can select which process, operations, and product view are available in the report. This
information is stored in XML files. During parsing of the PLM XML using XSL, this API is used to
identify whether the given object is selected by the user. Additionally, this API also allows part and
tool selection in the generated 3D PDF report. To do this, call this API for parts and tools during
parsing of the PLM XML.
Syntax
Input
Parameter Description
Parameter Description
type Type of the object. This is an optional parameter that you pass
for process and operation revision only. To use this API for
parts and tools, you do not have to pass this parameter.
The following options are possible:
Output
Output Description
For parts and tools, this API does not return any value.
Example
Refer to the style sheet contained in the 3DPDF Work instructions dataset.
Optional extensions
• getDefaultView
This extension returns the default product view or snapshot the user has selected for the current
process or operation revision.
Syntax
Input
Parameter Description
Output
Returns the UID (for Teamcenter templates) or name (for Process Simulate templates) of the snapshot
or default view selected by the user.
Example
Refer to the style sheet contained in the 3DPDF Work instructions dataset (for Teamcenter) and the
3DPDF Work instructions (Process Simulate) (for Process Simulate).
• isOfRequiredType
This extension identifies whether the currently parsed element is a part or a tool. This is required
because Teamcenter differentiates between parts and tools according to a preference that can be
modified.
Syntax
Input
Parameter Description
Output
Output Description
Example
Refer to the style sheet contained in the 3DPDF Work instructions dataset (for Teamcenter) and the
3DPDF Work instructions (Process Simulate) (for Process Simulate).
• generateGDTConversion
This extension converts the given string to HTML format that represents the correct replacement of
GD&T symbols. Teamcenter checks whether the given string contains any GD&T character and
converts it to the proper format so it can be displayed in the PDF report (text field with rich text
support).
Syntax
Input
Parameter Description
Output
Returns a formatted HTML string that can be displayed in the report text field.
Example
Refer to the style sheet contained in the 3DPDF Work instructions dataset (for Teamcenter) and the
3DPDF Work instructions (Process Simulate) (for Process Simulate).
• ImportImage
This extension imports the given image in the PDF report as an attachment that can later be accessed
by the report.
Syntax
Input
Parameter Description
Output
Returns the name with which the image file is imported into the 3D PDF report. This name is used in
the 3D PDF report to access the imported file.
Example
Refer to the style sheet and PDF file template contained in the 2DPDF Work-instructions dataset
• ImportTWIPDFFile
This extension imports the specified textual work instructions (in PDF format) into the 3D PDF report
without any content loss.
Syntax
Input
Parameter Description
Output
Returns the name with which the textual work instruction is imported into the 3D PDF report. This
name is used in the 3D PDF report to access the imported file.
Example
Refer to the style sheet and PDF file template contained in the 3DPDF Rich textual work instructions
dataset
• addSpecific
This extension adds specified product views to the PDF report, even if they are not selected by the
user in the wizard.
Normally, when you use the IsIdavailable API for a product view, Teamcenter checks whether the
user has selected the specified product view in the wizard or in Process Simulate and if selected,
returns a value of true. If, however, you want a product view in the 3D PDF report even if it is not
selected by the user in the wizard, or want only one product view in the report even if the user selects
all product views in the wizard, you can use this API to specify the desired product views.
Syntax
Input
Parameter Description
Example
Refer to the style sheet contained in the Part list with 3D dataset
The standard text library is a Teamcenter structure comprised of standard text folders and standard text
elements nested under the folders. Standard text is associated with standard text elements and is
accessible in the Teamcenter Attachment pane.
• Managing standard text content. Standard text enables you to write once only and reuse the same
text many times.
• Easy maintenance of up-to-date work instructions when products are upgraded. Make a single change
in a procedure and propagate the change through all the relevant documents.
• Improved accuracy. Work instructions are intrinsically connected with the process structure; they are a
textual expression of the manufacturing process.
• Work instructions are composed by the planners or engineers who designed the product, increasing
accuracy.
• Standard text is stored in the Teamcenter database, enabling you to search for text by its ID, name, or
the text itself.
• Easy localization.
Typically, there are three user roles involved in creating work instructions:
• Administrator
Responsible for creating and maintaining standard text and work instruction templates. If required,
the administrator can configure different system templates for standard text and work instructions.
The administrator can change these templates or create new ones according to organizational
requirements. The templates are in Microsoft Word DOCX format and are associated with a dataset
object.
• Librarian
Responsible for creating standard text libraries, managing standard text folders and elements, writing
standard text, and creating and managing standard text symbols. Standard text is written in a generic
style so that it can be reused in varying contexts. An example of standard text is a procedure
describing how to mount a wheel on a car and this can be reused in multiple projects. The librarian
uses the standard text editor to write standard text elements and the standard text library interface to
manage them. Additionally, the librarian may use the Teamcenter Search view and the Results
window as aids.
• Planner or engineer
Uses standard text as building blocks to compose work instructions. Planners cannot edit standard
text in the standard text library; however, they may copy and edit standard text and save it in a new
document associated with an operation or process in the process structure. Additionally, the planner
may use process structure, the textual work instructions editor, Teamcenter Search view, and the
Results window as aids.
• Requires Microsoft Word. For certified versions, see the Hardware and Software Certifications
knowledge base article on Support Center.
You can use Access Manager to configure various permissions for different roles. Siemens Digital
Industries Software recommends using the scenario of administrator, librarian, and planner, as
described.
Note:
During installation, Teamcenter imports the following work instruction templates to
Teamcenter Environment Manager:
• Default_WIObjectTemplate.docx
• STX_TC91OOTB_spec_template
• WI_TC91OOTB_spec_template
• TWI_TC101OOTB_spec_template
• TWIfor3DPDF_TC101OOTB_spec_template
Note:
• During installation, Teamcenter updates the MEWiStandardTextTemplate preference
that defines the template to be used by the Standard Text view and the
MEWiWorkInstructionTemplate preference that defines the template to be used by the
Textual Work Instructions view. These preferences enable you to use different templates
for the Standard Text and Textual Work Instructions views. Both preferences are
updated to the TWI_TC101OOTB_spec_template value.
• If the textual work instructions are created to be used as part of the 3DPDF Rich Textual
Work Instructions report, set the MEWiWorkInstructionTemplate preference to
TWIfor3DPDF_TC101OOTB_spec_template.
2. If Microsoft security bulletin MS09-073 is installed on your machine, you may encounter the
following error messages when loading work instructions. Microsoft has provided complete
information on this issue at:
http://support.microsoft.com/kb/973904/.
• Converter mswrd632
HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Shared Tools\
Text Converters\Import\MSWord6.wpc
HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\Shared Tools\
Text Converters\Import\MSWord6.wpc
HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\
Applets\Wordpad
HKEY_LOCAL_MACHINE\Software\Wow6432Node\Microsoft\Windows\
CurrentVersion\Applets\Wordpad
a. Select the new entry in Regedit, choose Edit→New, and select DWORD Value.
b. Type AllowConversion for the name of the DWORD value, and press the Enter key.
e. Close Regedit.
A. Create an LOV business object of any basic type: String, Integer, and so on (for example,
ProjectStatusLOV: Green/Yellow/Red).
C. For ProjectStatusDataCollection:
i. Create a property of the same type as the LOV basic type (for example, Value).
A. Create an LOV business object of any basic type: String (for example, ProjectStatusLOV:
Green/Yellow/Red).
C. For ProjectStatusPlannerInputField:
• Symbols section
Symbols associated with the standard text or the work instructions are displayed in a dedicated
symbols section at the top of the document. When editing templates, leave this section at the top of
the document (first line) or remove it if symbols should not be displayed. Do not insert the symbols
section in the header or footer.
• Character styles
Use these to create the look-and-feel of the document. You can edit these styles, but you must retain
the same style names.
• WIDataCollectionStyle
Applied to the placeholder string of data collection definitions. The formatting is: Font: Calibri, Size:
11 points, Color: Gray-50%, Bold.
• WIPlannerFieldStyle
Applied to the value of planner input fields. The formatting is: Font: Calibri, Size: 11 points, Italic.
• WIInvalidPlannerFieldStyle
Applied to invalid planner input fields identified while running the Validate PIF command.
The formatting is: Font: Calibri, Size: 11 points, Italic, Color: Red.
Note:
If you add new styles, ensure that Style type is Character. If you add new styles whose Style
type is Paragraph, errors may occur.
• Remove the user interface customization that limits the available Microsoft Word commands.
Note:
When creating new templates, always use one of the document templates supplied with the
Teamcenter installation as your starting point. Either copy one of these templates, rename it, and
edit it; or open a template, edit it, and perform a Save As operation. You can clone a template in
one of the following ways:
3. Modify the file name so that you can import it later; the import fails if there is already a
template with this name.
a. Remove the user interface customization that limits the available Microsoft Word
commands.
Note:
If using OOTB templates, you should only use the latest template file available –
TWI_TC1017OOTB_spec_template.
Warning:
Old templates for past versions of Teamcenter have known issues in newer versions.
3. Modify the file name so that you can import it later, the import fails if there is already a
template with this name.
4. Click Finish.
The specification template is created under the Newstuff folder. You can move it to a
dedicated folder.
Note:
User interface customization ensures document standardization throughout your organization.
After importing the template, define which templates are to be used by the Standard Text and Textual
Work Instructions views:
1. Edit the MEWiStandardTextTemplate preference so that it contains the name of the new standard
text template (without the .docx suffix). This template becomes the default template for creating
standard text.
2. Edit the MEWiWorkInstructionTemplate preference so that it contains the name of the new work
instructions template (without the .docx suffix). This template becomes the default template for
creating work instructions.
Remove customization
1. Change the template file name to include the .7z extension. For example, rename
TWI_TC10OOTB_spec_template.docx to TWI_TC10OOTB_spec_template.docx.7z.
2. Open the archive file in 7-Zip, extract customUI.xml, customUI14.xml, and .rels, and store these
files for later use.
3. Delete customUI.xml and customUI14.xml from the archive and close 7-Zip.
Note:
User interface customization ensures document standardization throughout your
organization. Siemens Digital Industries Software recommends retaining the default
customization. However, you can edit the customUI.xml file to change the customization, or
delete the customUI.xml file to remove customization.
Deleting customUI.xml removes all customization from the template file. You can now edit it as
you would any other Microsoft Word file.
Restore customization
1. Save the modifications and close the document.
2. Change the template file name to include the .zip suffix. For example, rename
WI_TC9OOTB_spec_template.docx as WI_TC9OOTB_spec_template.docx.zip.
3. Locate the customUI.xml, customUI14.xml, and .rels files that you saved when you removed the
customization, right-click, and choose Add to archive....
4. Type the template ZIP file name in the Archive name box and click OK.
Note:
Siemens Digital Industries Software recommends restoring the customUI.xml and
customUI14.xml files. This restores the default customization. However, you can edit the
customUI.xml and customUI14.xml files to change the customization or not restore the
customUI.xml and customUI14.xml files to remove customization.
Editing options
This topic details all the template editing functions. For each one, it notes whether the procedure can be
performed directly from Teamcenter or whether you must access the template from the %Root%\install
\cmtmes directory. To modify the template directly in Teamcenter, access My Teamcenter, expand under
the specification template up to the FullText element, and double-click the FullText item.
Note:
This instance of Word is independent of Teamcenter.
b. From the Customize Ribbon list on the right, select Main Tabs, and select Developer.
c. Click OK to accept the change and exit the Word Options dialog box.
If the property you want to add requires more than a single paragraph, use a Rich Text Content
control. For example, the description property may require multiple paragraphs.
8. In the Tag box, type the name of the BOM line property you want to insert in the template header.
To retrieve the property name, proceed as follows:
a. Right-click the column area in Manufacturing Process Planner and choose Insert Column. The
Change Columns dialog box appears.
10. In the Tag box, preface the BOM line property name with one of the following:
• LNP_ for a line property, for example, LNP_bl_rev_object_name for a line object name or
LNP_bl_rev_item_revision_id for a line revision identification number
• LPP_ for a line parent property, for example, LPP_bl_rev_object_name for a parent object name
Note:
Ignore the Locking and Plain Text Properties sections.
12. Open the target template and double-click the top to activate the header area.
13. Type the name of the property you want to insert in the template header.
14. From the Word document, copy the content control you created and paste it after the property
name you typed.
15. Add as many BOM line properties as you want to the template header.
Note:
You can add a table to the document header and insert the BOM line properties into the
table. This enables you to add multiple properties in an orderly way.
17. Discard the original Word document in which you created the content control.
Symbols associated with the standard text or the work instructions are displayed in a dedicated symbols
section at the top of the document. When editing templates, leave this section at the top of the
document (first line) or remove it if symbols should not be displayed. Do not insert the symbols section
in the header or footer.
By default, the symbol section exists in the template and is protected. To prevent symbols from
appearing, delete the symbol section as follows:
1. In Word, choose Options→Popular and select Show Developer tab in the Ribbon.
3. The symbol section is not visible, therefore, to place your cursor inside the symbol section, click
anywhere in the body of the document and then press the Home key and the right arrow (→) key.
5. Clear the Content control cannot be deleted and Contents cannot be edited check boxes.
6. Click OK.
Siemens Digital Industries Software recommends deleting any empty lines in your template file.
Note:
Word automatically places the new control at the top of the document, below the header.
Note:
You must type SymbolsSection exactly or the symbol section does not work.
6. Select the Content control cannot be deleted and Contents cannot be edited check boxes.
7. Click OK.
• Add a symbol to the standard text element in the Standard Text view. You subsequently add the
standard text element to the work instruction.
• Add a symbol directly to the work instruction in the Textual Work Instructions view.
The position of this button is defined in the MEWiEnableAddSymbolCommand preference. The valid
values for this preference are STXView or TWIView.
• DOCX files containing tables, images, formatting, header and footer content.
After import, a standard text librarian can modify the library structure and an author can modify the
documents and save the modifications.
The following is an example of an input file with a simple library structure. The first four columns
represent the structure of the standard text library. The last column, the StxFilePath column, contains
the path to the document that will be attached to the standard text element.
Note:
This example imports only DOCX files, but both DOCX and TXT files are supported.
You can import this structure into Teamcenter by saving the Microsoft Excel spreadsheet as a text file
and import that file into Teamcenter using the following tcexcel_import utility call:
Note that the standard text elements have documents attached. You can modify these documents, save
them, and continue to work with them in the customary fashion.
Note:
You can only use the tcexcel_import utility to create new library structures. You cannot use it to
update structures.
Requirements
After a standard text library object has been revised, updated and approved, it is a valid candidate for
the textual work instructions (TWI) bulk update utility.
• The update_stx_elements utility requires a Microsoft Office version compatible with the Teamcenter
version you have installed.
• To provide controlled and predictable results, it is strongly recommended that you update only a
single standard library object prior to executing the bulk update. Because an individual TWI document
may contain references to multiple standard library elements, all standard library elements referenced
within a TWI document are regenerated within an updated TWI document.
• You should run the utility at a time when users are not authoring TWI documents, and you should
prenotify users of expected changes. The TWI documents may be in a working or released state.
Caveats
The following are not part of the update_stx_elements utility process and must be addressed
separately:
• Change management.
Teamcenter recommends that you set a single manufacturing change notice (MCN) on a single
standard text library object. An in-depth understanding of the nature of changes made by the
update_stx_elements utility is essential to successful results. The TWI preview dataset used by TWI
and Electronic Work Instructions (EWI) supports one of several formats: PDF (default), MHT, docx, and
rtf, based on the Teamcenter preference MEWiPreviewFormat. Changes made to the TWI preview
dataset attached to an Process/OP item revision are absolute and datasets have no revision history.
• If a standard text library object change requires additional changes to the BOP, such as changes to the
number of operations or changes to consumed parts, this is not a valid use of the bulk update utility.
If you create a generic manufacturing process structure from the generic product structure, the
occurrences in the generic product structure are consumed in the generic process structure.
In a template process, although no real parts are consumed in the operations that comprise the generic
process, each consumed item has an identity. This identity of the item in the process structure is the
same as it is in the product structure. Consequently, if you use this process structure as a template for
the creation of a new process structure for manufacturing a product that maps exactly to the generic
product structure, the product and process share the same absolute occurrences. The new process that
you create from the template consumes the parts from the real product structure with the same
absolute occurrences.
Similarly, if you define a mapping between the plant structure referenced by the template and the actual
plant structure, generic work areas are substituted with specific absolute occurrences.
You can use any process as a template for a new structure. However, if you have many of these
processes, it can be more efficient to save such manufacturing processes as templates in a library, and
then use the templates as the basis of new manufacturing processes for similar products. The template
may include configuration rules that map the product data to process operations, and may include
references to standard resources. You can classify the templates in the Classification application for easy
retrieval later.
When you create a new process operation, you can browse the available templates and select one to
create the process operation. After it is created, you can attach the geometry of the part to be
processed.
Similarly, you can create assembly setup templates containing assembly information for a typical
assembly setup. When you initialize a setup from a template, Teamcenter loads the related method,
equipment, features, and manufacturing operations.
Note:
By default, classify immediately is disabled for a root item in Manufacturing Process Planner.
Note:
• Specify the release status type that is assigned to any newly created incremental change
revisions during cloning in the Clone_Pending_Release_Status preference.
• Specify the release status type that should be considered as secure in the
Clone_Secured_Release_Status preference.
In the following figure, the vertical line represents the point of cloning.
3 IC3 Incremental change 3 is the current IC (set at the bottom of the pane) that is
configured and pending. This is the target IC.
• Disregards IC1.
• Clones IC2 to a new IC5 and the change elements in IC2 (that is, add or remove) that are associated
with the cloned object are cloned and added to IC5. IC5 then has a pending status.
• IC4 is left alone and the new change elements are added to it. This is not cloned because the status is
pending and the out effectivity does not match the currently set IC revision (IC3).
By default, the Clone Assembly in Context command clones an MBOM subassembly and pastes the
clone within the same MBOM. This command:
• Lets the MBOM author copy, reference, or exclude in-context attachments from the structure being
cloned, and optionally, split occurrence effectivity dates or ranges between the assembly being
cloned and the cloned assembly.
Direct and in-context attachments of the new (cloned) line, cloning of children below the new line, and
attachments on referenced children below the line added in the context of lines above the new line, are
controlled by cloning rules. Cloning rule names are listed in the preference
MECopyAssemblyInContextTemplates.
This command pastes a copied assembly with in-context edits elsewhere in the same MBOM, creating a
new absolute occurrence of the assembly while retaining in-context edits and attachments.
Copied and referenced children are again controlled by cloning rules. Cloning rule names are listed in
the preference MEDuplicateAssemblyInContextTemplates.
The Replace Assembly with Any Item Type command replaces an MBOM subassembly item with a new
item of a different item type while retaining the original subassembly's in-context edits. The procedure
is similar to the File→New item command, but retains in-context edits and also copies, references, or
excludes attachments from its original structure.
The Replace Assembly with Any Item Type command always preserves in-context attachments of the
new line. Direct attachments of the replaced line, cloning of children below the replaced line, and
attachments on children below the replaced line—in the context of lines above the replaced line—are
controlled by cloning rules. Cloning rule names are listed in the
MEReplaceAssemblyInContextTemplates preference. Properties on the new line can be mapped from
properties on the replaced line using the MEReplaceAssemblyInContextAlignProperties preference.
You can define three cloning rule preferences, one each for process templates, product templates, and
plant templates. You can associate multiple action rules with each preference.
When Manufacturing Process Management encounters an object that is mapped between the template
and the actual structure, it determines if a substitution is necessary and takes one of four actions,
according to the mapping of the object type:
• Clone
Copies the object referenced by the template to a new object in the structure.
• Reference
The structure references the same object as the template.
• Ignore
The new structure does not reference the object.
• Map
The system maps the template to a replacement structure. For example, this allows you to create a
process structure from an existing process or from a process template. Optionally, this rule may be
allowed by a second (default) action: Reference or Ignore.
You can also define a cloning rule to ignore the cloning of an MBOM recipe.
Example:
*:*:Relation.Mfg0MEAssignmentRecipeRel:Ignore
Note:
You cannot apply a Reference action to an MBOM recipe. A Reference action will log an error and
ignore the cloning.
Manufacturing Process Management only takes the specified action if an absolute occurrence or its ID is
the same in the template and the structure. If the same absolute occurrence appears more than once,
only the first matched instance is mapped.
You can specify a second action after the Map action. The second action is the default action and is
taken if the mapping fails. For example:
*:*:OccType.MEConsumed:Map.Ignore
*:*:OccType.MEWorkArea:Map.Reference
In this example, the MEConsumed occurrence type is mapped to the occurrence in the new structure.
Manufacturing Process Management uses the absolute occurrence referenced from the template and
finds the corresponding occurrence in the new product. It links the consumed items for that operation
to the occurrence in the new product. When there is no mapping for the Consumed item,
Manufacturing Process Management ignores it. When there is no mapping for the WorkArea item,
Manufacturing Process Management creates a reference to the item from the cloned element.
Note:
By default, the MEConsumed occurrence type maps consumed items to the corresponding
occurrences. The site administrator can change the controllingOccsForProcessConfiguration
preference to map another occurrence type. Alternatively, this preference may be left unassigned,
in which case the configuration of consumed items does not affect the configuration of
operations.
Each site can define a set of cloning rules from which users may select. In addition, individual users may
change the cloning action rules by editing their preference file.
Note:
These rules determine if objects are cloned, referenced or ignored. You cannot change this
behavior with the Business Modeler IDE application.
Process.Template=
Action_Rule_Name1
Action_Rule_Name2
.
.
Product.Template=
Action_Rule_Name3
Action_Rule_Name4
.
.
Plant.Template=
Action_Rule_Name5
Action_Rule_Name6
For each set of action rules, you must define a new variable. The following example shows a typical
Action_Rule_Name1 variable for the Process.Template variable:
Process.Template.Action_Rule_Name1=
*:*:Attribute.items_tag:Clone
*:*:Attribute.structure_revisions:Clone
*:*:Attribute.bom_view:Clone
*:*:Attribute.parent_item:Clone
The following example shows two cloning rules (Mapping_Consumes and Ignore_Consumes) for
process templates:
Process.Template=
Mapping_Consumes
Ignoring_Consumes
Process.Template.Mapping_Consumes=
*:*:Attribute.items_tag:Clone
*:*:Attribute.structure_revisions:Clone
*:*:Attribute.bom_view:Clone
*:*:Attribute.parent_item:Clone
*:*:Attribute.variant_expression_block:Clone
*:*:OccType.Null:Clone
*:*:OccType.MEConsumed:Map.Ignore
*:*:OccType.MEWorkpiece:Ignore
*:*:OccType.*:Reference
*:*:Relation.TC_Rendering:Clone
*:*:Relation.TC_specification:Clone
*:class.MEActivity:Relation.TC_MEFolder:Clone
class.MEActivity:*:Attribute.contents:Clone
class.Folder:*:Attribute.contents:Reference
Process.Template.Ignoring_Consumes=
*:*:Attribute.items_tag:Clone
*:*:Attribute.structure_revisions:Clone
*:*:Attribute.bom_view:Clone
*:*:Attribute.parent_item:Clone
*:*:Attribute.variant_expression_block:Clone
*:*:OccType.Null:Clone
*:*:OccType.MEConsumed:Ignore
*:*:OccType.MEWorkpiece:Ignore
*:*:OccType.*:Reference
*:*:Relation.TC_Rendering:Clone
*:*:Relation.TC_specification:Clone
*:class.MEActivity:Relation.TC_MEFolder:Clone
class.MEActivity:*:Attribute.contents:Clone
class.Folder:*:Attribute.contents:Reference
parent-object:object:relation:action
For example:
*:type.MEPSDRevision:Occtype.*:Reference
In this example, the system searches through any parent (*), and when it finds a child of type
MEPSDRevision (type.MEPSDRevision), with any occurrence relation (Occtype.*), it creates a new
reference to that MEPSD element (Reference).
To create or view manufacturing documentation, install Microsoft Visio on each workstation where you
author publishing pages. Both Visio Standard and Visio Professional are supported. You can install Visio
before or after the Teamcenter installation. For certified versions, see the Hardware and Software
Certifications knowledge base article on Support Center.
Publishing pages can be published to PDF or HTML so that they can be viewed independently of
Teamcenter or Visio.
You create a template for each of the publishing page types needed in your organization from assets
(Visio shapes) that are bound to Teamcenter data. The process planners use these templates to create
publishing pages that may include text, tables, graphics, 2D or 3D snapshot (product views), and link
assets. When all the publishing pages are complete, the process planner can collect them into a
technical portfolio that may contain all the activity, operation, and process documentation for a
particular assembly line. Users manipulate publishing pages and portfolios in the Manufacturing Process
Planner, Part Planner, Resource Manager, Plant Designer, and Multi-Structure Manager applications. They
may also add 3D annotations where appropriate. For detailed procedures, see the procedures for
viewing, creating, and editing manufacturing documentation in the guides for those applications.
In addition to creating manufacturing documentation in Microsoft Visio, you can create links that point
to manufacturing documentation in Microsoft Word and text files.
You can optionally publish manufacturing documentation in PDF format. If you publish a PDF of a
portfolio, Teamcenter attaches the PDF dataset to the portfolio. If you create a PDF of a publishing page,
Teamcenter attaches the PDF dataset to the page dataset. You must install PDF generation software to
use this feature, for example, one of the Adobe products or the freeware GhostScript utility.
Understanding roles
Publishing pages have content that reflects a specific purpose or role. By default, Teamcenter supports
two roles, Work Instructions and Product Manual. You can customize Teamcenter to support any
desired roles, for example, Repair Manual. The same dataset types are used for all roles. When
publishing pages are attached to BOM lines or item revisions, the role is determined by the type of
relation that attaches the dataset to the parent item revision. Multiple datasets can be attached to an
item revision and the datasets can fulfill different roles according to the relation type. When a publishing
page is attached to an activity, its role is determined by a preference setting. All publishing pages
attached to an activity fulfill the same role. When a portfolio is generated from a structure, the pages
that are added to it are determined by the role that the user specifies for that portfolio. Internally, each
role is typically associated with:
A set of preferences associates the role with the relation type, the transfer mode, and the default alias
files, as well as the following:
You can create a custom roles to reflect your company’s needs. There are two steps necessary to do this:
• Add a new relation object for the new role using the Business Modeler IDE.
icon="icons/workinstructions_view_16.png"
id="com.myCompany.viewId"
name="%viewId.VIEW">
</view>
</extension>
<extension
point="com.teamcenter.rac.cme.tcpublishwrapper.publishingPageViewRoles">
<viewRoleType
tcPublishRole="Fnd0MyPersonalRole"
viewId="com.myCompany.viewId">
</viewRoleType>
</extension>
<extension
point="com.teamcenter.rac.aifrcp.openWithViewMenuDef">
<menuItem groupId="secondary"
icon="icons/workinstructions_view_16.png"
label="%viewId.VIEW"
viewId="com.myCompany.viewId">
<visibleWhen>
<and>
<count value="1"/>
<iterate ifEmpty="false" operator="and">
<with variable="rac_command_suppression">
<not>
<iterate operator="or">
<equals value="com.teamcenter.rac.openWith"/>
</iterate>
</not>
</with>
<adapt type="com.teamcenter.rac.kernel.TCComponent">
<test
property="com.teamcenter.rac.kernel.TCComponent.typeClass"
value="ImanItemBOPLine,BOMLine,CfgAttachmentLine,MEActivity"/
>
</adapt>
</iterate>
</and>
</visibleWhen>
</menuItem>
</extension>
</plugin>
• AppInterface_TCPublishingTechnicalPortfolio_default_relation
Defines the default relation used when a TCPublishingTechnicalPortfolio dataset is pasted under an
intermediate data capture (IDC) while creating technical portfolios.
• AppInterface_TCPublishingTechnicalPortfolio_shown_relations
Defines the relations available when pasting a TCPublishingTechnicalPortfolio dataset under an
intermediate data capture (IDC) while creating technical portfolios.
• IMAN_PublishingPageAssetContext_relation_primary
Defines which Teamcenter objects can be used with a IMAN_PublishingPageAssetContext relation.
• IMAN_TCPublishedPortfolio_relation_primary
Defines which Teamcenter objects are used as primary objects with a IMAN_TCPublishedPortfolio
relation.
• ItemRevision_TCPublishingPage_default_relation
Defines the default relation created when a publishing page is pasted within an item revision.
• IMAN_PortfolioConfiguredPage_relation_primary
Defines which Teamcenter objects are used as primary objects with a
IMAN_PortfolioConfiguredPage relation.
• IMAN_PortfolioPage_relation_primary
Defines which Teamcenter objects are used as primary objects with a IMAN_PortfolioPage relation.
• TechnicalPortfolioRoles
Use this preference to define the roles of technical portfolios.
• TechnicalPortfolioTransferMode_IMAN_MEWorkInstruction
Defines the transfer mode of the specified technical portfolio. TransferMode objects control the
related data exported into a PLM XML document.
• TCPublishing_Default_Alias_File
The name of the installed alias file, as described later. Defines the default alias file loaded when a new
publishing page is viewed.
• TCPublishing_Aliases.IMAN_MEWorkInstruction
The names of the available alias files for work instruction pages. If this preference is not set, the user
can choose from any alias file in the database.
• TCPublishing_Activities_Role
Defines the role of all publishing page datasets that are attached to activities in Manufacturing
Process Planner, for example, IMAN_MEWorkInstructions (the default setting). The role determines
the tab name shown in Manufacturing Process Planner and also how portfolios are generated. If you
change the relation name defined in this preference, you must define a new closure rule and transfer
mode to generate portfolios. You must also add the new role to the TechnicalPortfolioRoles
preference.
• TCPublishing_Aliases.Activities
Contains the names of the alias file datasets that appear when the user wants to load alias files for
activity pages.
You should also ensure that the Dataset_DefaultChildProperties preference for each user contains the
following settings:
TC_PublishingPageAssetContext
TC_PortfolioPage
TC_PortfolioConfiguredPage
These settings allow users to cut and paste publishing pages and portfolios.
The following environment variables are set during installation and you should not normally change
their values.
• PUBLISH_PDF_TIMEOUT
This environment variable sets a time-out period for stalled PDF conversions. Enter a number of
milliseconds after which the conversion is terminated, enter 120000 for 2 minutes. If you require an
infinite time-out, set this environment variable to INFINITE.
• PUBLISH_PDF_MAX_JOBS
Defines the maximum number of outstanding PDF conversion jobs that are allowed to run
simultaneously. This environment variable is effective only when you publish a portfolio to PDF and
select multiple PDFs.
• PUBLISH_PDF_INTERVAL
This environment variable defines the number of milliseconds Teamcenter waits before issuing each
subsequent PDF conversion job. Set a value that ensures there are no conflicts between PDF jobs
starting simultaneously. Typically, you do not need to change the default value of 1000 (one second).
This environment variable is effective only when you publish a portfolio to PDF and select multiple
PDFs.
If necessary, you can reinstall this transfer mode by running the following command from a Teamcenter
shell:
Ensure you enter the complete path for the xml_file argument, for example:
file=C:\Tc2007\tcdata\mfg\defaultTransfermodes.xml
You would only reinstall the file if you make system-specific changes, for example, you customize the
mode for your site environment.
When you select an object in Teamcenter, and then populate an asset, a number of things happen.
1. If the selected object is a BOM line, Publish creates a structure context object in the database to
persist the selection.
2. Publish creates a PLM XML file that contains information about the selected persistent object and
about related objects. This additional content about the related objects is determined by the
definition of the transfer mode that was assigned to the asset in the Bind dialog box.
3. Publish searches through the PLM XML file’s content to find the exact data to expose in the asset.
To do this, it retrieves the alias definition for the alias that was bound to the asset. The definition
contains a list of paths. Publish attempts to follow each path from the root object in the PLM XML
file until it finds some valid data. This data can consist of anything from a string, such as a form
attribute value, to a file containing an image.
4. Teamcenter creates a snapshot of the data in the asset on the Visio pane.
5. Teamcenter stores the ID of the selected persistent object in the Visio file, associating it with the
asset, for later retrieval during an update operation.
The transfer modes and aliases that are available in the Bind dialog box are all defined in the alias file.
Each transfer mode functions as a recipe for what is included in the PLM XML file. The definition of each
alias functions as a recipe that tells Teamcenter which parts of the exported PLM XML information to
expose in an asset.
The snapshot of Teamcenter’s data is visible whenever you open the page file for viewing. You can also
update an asset so that it displays changes that were made in Teamcenter since the asset was first
populated. When the asset is updated, new PLM XML is generated from the same selected object using
the same transfer mode, and the same alias is then used to find the exact data from that PLM XML to be
displayed in the asset.
A sample set of alias definitions is provided with the default installation, but you should create alias
definitions and transfer modes to support other situations. To do this, you should:
• Ensure that the information appears in the PLM XML file. If it does not, create or modify a transfer
mode so that the information is visible.
• Ensure that an alias definition correctly extracts this information from the PLM XML file. If not, modify
existing aliases or create new aliases. The default alias definition file contains instructions and
examples of aliases.
Teamcenter includes a default alias file (TcPublishSystemAlias.xml) that you can use as the basis for
your own mapping files and its location is defined in the TCPublishing_Default_Alias_File preference.
The comments within this file contain detailed notes on the structure and usage of the alias file. Read
these before beginning with customization.
Caution:
Do not edit this file directly. Create your own alias dataset and work in this file.
Example result – table asset populated with child item names and form descriptions
This example starts with a simple product structure containing a parent item with two direct child items.
Each child item has an attached form. This scenario is shown in the following figure.
To populate the table asset with data, you must assign a binding to the table asset. The binding used is
ProductPartList & Name and ProductPartList & FormDescription, as shown in the following figure.
You can find the sample alias file that was used to create this example
(ProjectTcPublishSystemAlias.xml), as well as the PLM XML code generated by the selected transfer
mode (tcm_export.xml) in the Sample directory of your installation. This must be installed separately.
If you do not have a Sample directory, contact your Teamcenter administrator.
In the example, the second binding involves the Description property of a form attached to the child
item. The default alias file does not provide a definition for attaching the Description field of a form to a
child item so you must modify this alias file.
This new entry is created by adding a new top level alias definition into the alias file. The following code
shows excerpts from the DefaultTcPublishSystemAlias.xml file. The line shown in bold print results in
the new entry in the Bind dialog box shown in the figure. The statements in italics refer to other alias
definitions.
<!--#########Product part list information addresses the first level parts list of
an
occurrence it will return only the child occurrences of the first level occurrence
selected.
#################-->
<Alias name="ProductPartList" assetType="8" toolTip="product data"
qualifier="2" accumulate="Quantity">
&OCC-ATTR-DEF;
</Alias>
For the new alias definition to traverse the PLM XML file, another edit is necessary. The following entry
shows the traversal performed by the new alias definition. This entry is added to the <!ENTITY FORM-
MASTER-ATTR "> section of the alias file.
<Alias name='FormDescription'>
<Path>*:AssociatedAttachment[@role='IMAN_specification']:@associatedAttachmentRefs</
Path>
<Path>*:Form:@attachmentRef</Path>
<Xpath>Description</Xpath>
</Alias>
To determine what to add and how the traversal works, reference the PLM XML file generated by the
example and found in the Samples directory.
In the binding, ProductPartsList & FormDescription was selected. Find the Alias and AliasAlternate
sections for ProductPartsList in the alias file. The following code section shows the relevant lines from
the generated PLM XML file. All PLM XML files have a traverseRootRef entry like this:
#id3 is the start node for the traversal. The transferContext transfer mode is used to generate this PLM
XML code.
Look through the alias file in the ProductPartsList section for all alias definitions that have a primary
object specifying an AssociatedAttachment node. The following code contains the first one:
The traversal tries each alias rule that has a primary object matching the start node and traverses
through each path statement until it gets to the Xpath statements. If any Path statement fails during
the traversal, the traversal tries the next matching alias statement. The first Path statement is:
<Path>AssociatedAttachment:AssociatedAttachment[@role='contents']:@childRefs</Path>
This statement causes the traversal to proceed to AssociatedAttachment nodes with role=contents via
the childRefs attribute in the PLM XML file. The PLM XML statement childRef attribute is:
childRefs="#id4 #id72">
Therefore, the traversal moves to PLM XML nodes with id4 and id72, if they match the role=contents
condition. The PLM XML node containing id4 is:
<Path>AssociatedAttachment:*:@attachmentRef</Path>
This Path statement indicates that the system expected AssociatedAttachment nodes as results from
the last statement. If it did not, this alias definition would fail at this point.
The current Path statement tells the system to use the attachmentRef and return whatever is there.
The * symbol is a wildcard indicating that any node is sufficient. Consequently, the traversal proceeds to
the node containing #id9.
Node 9 is an occurrence.
<Path depth="1..1">*:*:@occurrenceRefs</Path>
This Path statement tells the system to go to the nodes referenced by the occurenceRefs attribute.
Again, the * wildcard is used, so the traversal picks up whatever node is contained in the PLM XML. The
first node ID is #12.
This node is also an occurrence. The first line contains all the relevant reference information.
&OCC-ATTR;
This is a macro statement that implies that the traversal expects to be on an occurrence node at this
point and is getting ready to traverse its attributes.
At this point, the traversal again encounters alias names as shown for OCC-ATTR, ID, Description,
Name, and so on.
Remember that the binding specified was ProductPartsList & FormDescription. The traversal started at
the ProductPartsList node and arrived at this point. Now, it must find an alias name matching
FormDescription to find any additional XML traversal rules to use. Going through the OCC-ATTR
statement, the traversal cannot find any alias names that match FormDescription because the edit was
not added to that entry. Therefore, the traversal continues on to the next entry in the original alias
definition.
</Alias>
<Alias name='Name'>
<Path>*:*:@instancedRef</Path>
<Xpath>@name</Xpath>
</Alias>
… many more Occurrence attribute Alias Names
“>
&FORM-MASTER-ATTR;
The traversal looks in the alias file for this macro and starts traversing through the macro looking for an
alias named FormDescription. The traversal finds the newly added alias as follows:
<Alias name='FormDescription'>
<Path>*:AssociatedAttachment[@role='IMAN_specification']:@associatedAttachmentRefs</
Path>
<Path>*:Form:@attachmentRef</Path>
<Xpath>Description</Xpath>
</Alias>
Now the first Path statement in the current alias rule is this:
<Path>*:AssociatedAttachment[@role='IMAN_specification']:@associatedAttachmentRefs</Path>
This means the traversal is looking for AssociatedAttachment nodes with an IMAN_specification role.
This should be available through the AssociatedAttachmentRefs statement. In this case, the only node
that matches these criteria is the one with #id22 shown here.
<Path>*:Form:@attachmentRef</Path>
This means that using the attachmentRef attribute, the traversal expects to move to a form. #id23
indicates the node for which the traversal needs to search.
At this point, the traversal has successfully executed all the Path statements and ends with a final
destination node. The next statement in the alias rule is:
<Xpath>Description</Xpath>
The Xpath statements describe what information to take from the resulting node to use in the
publishing page. In the example, the property originally sought was the Description property of the
form attached to the ChildItem item. This Xpath statement says to return the data for the Description
entry for the current node. Looking at the PLM XML, this is:
<Description>ChildItem 1 Description</Description>
Looking at the populated publishing page in the figure entitled Example result – table asset populated
with child item names and form descriptions, you see the same description in the FormDescription
column for ChildItem 1. This accomplishes the goal of the example.
The Path statements are used to traverse from the start node to the final node. The Xpath statements
are used to extract information from the final node. There are potentially several valid paths from the
start node to the final node in the PLM XML. You need to determine any valid set of path statements to
reach the final node.
<AliasAlternate name="2DGraphic">
<Path>AssociatedAttachment:AssociatedAttachment[@role='contents']:@childRefs</Path>
<Path>AssociatedAttachment:ConfiguredOccurreceGroup:@attachmentRef</Path>
<Path>ConfiguredOccurrenceGroup:*:@childRefs</Path>
<Path>Occurrence:AssociatedAttachment:@associatedAttachmentRefs</Path>
<Path>AssociatedAttachment:DataSet[@type='Image']:@attachmentRef</Path>
<Path>DataSet:ExternalFile[@format='jpg' or @format='jpeg' or
@format='gif' or @format='bmp']:@memberRefs</Path>
&FILE-ATTR;
</AliasAlternate>
To identify the end object, use the createRelation attribute on the last Path element:
<Path createRelation=”VisAssetPopulatedByEndobj”>
This causes the end object UID to be sent back through Lifecycle Visualization to the Teamcenter rich
client, along with the createRelation identifier. The rich client then creates the
VisAssetPopulatedByEndobj relation from the publishing page dataset to the end object.
To create two different relationships to the same end object, use this syntax:
<Path createRelation='VisAssetPopulatedByEndobj,AnotherVisRelationship'>
When customizing alias definitions, you can identify the end object for any asset and Teamcenter
creates the relation specified. You can define your own custom relations and have them created too by
adding appropriate createRelation clauses or by adding additional relation names to existing
createRelation clauses.
1. The ChildItem 1 Description node, the data you want to expose in the asset, is in the Form
id=id23 node.
4. The Id12 node is referenced by the Occurrence id=id9 statement as an occurrenceRef type.
6. The Id4 node is referenced by the AssociatedAttachment id=id3 statement as a childRef type.
7. The Id3 node is the traverseRootRef node from which traversal always starts.
There is another reference to id22, but if you follow it back you see a pseudofolder. Pseudofolders are
generally not useful in a path traversal and can be ignored. After a while, it is useful to recognize what
entities in the rich client relate to which nodes in the PLM XML file. Through some experimentation,
these relationships become clearer. If you compare this pseudo XML code with the actual Path XML
statements traversed in the example, you can see how they relate to each other. Therefore, when you
need to update an alias file, if you can first determine a set of pseudo XML statements, it is easier to
write the Path and XPath statements needed to edit the alias file.
1. Determine what will be selected and what you want to see in what type of asset.
2. When creating a template that will be used repeatedly, it is easier if the user can select a single
object with which to populate all of the data in the work instruction.
3. Find an example of the data in the database that you can select, for example, a BOM. If possible,
make it unique so you can find it easily in the PLM XML file.
4. Determine whether to use an existing alias or to add a new one to the Bind dialog box.
5. Determine what alias file to use. You can develop an alias file for this user or this use case only
that is simple to use and contains only one transfer mode, or you can add to an existing alias file.
1. Generate a PLM XML file by populating an asset with the transfer mode that you think will work.
2. Examine the resulting file and make sure it has the data that you want to expose in the asset. If it
does not, you must find a better transfer mode, or you must modify the transfer mode’s closure
rules to include your data.
3. In some cases, it makes sense to create a custom transfer mode whose closure rules are
optimized to efficiently generate XML that supports only the assets in a single template.
• Examine the PLM XML file and identify the nodes that provide a path from the root ref to the data in
which you are interested.
• Define an alias alternate that follows the node path. To save time, test the alias definition using the
stand-alone test utility on the generated PLM XML file. The utility is described in the alias file header.
• Decide what other use cases need to be supported by your alias definition.
1. The data may be attached to the object in more than one way.
2. Export the TcPublishSystemAlias.xml file to your local disk using the Named References dialog
box.
4. Choose File→New→Dataset.
Teamcenter displays the New Dataset dialog box.
5. In the list of dataset types, select TCPublishingAliases, and then type a name and description for
the new dataset.
6. Click the Import button, browse to the renamed alias file and click OK.
Teamcenter creates the new publishing alias.
7. Load the XML file into a text editor and read the notes at the top of the file.
Note:
Each time you create an alias dataset, you must load the alias file.
You can optionally include packing of tables in the alias definition. If you choose to pack tables,
lines that are identical except for quantity are collapsed into a single line. Two aliases with
collapsed tables are provided as templates, CollapsedProductPartList and
OperationConsumedParts.
2. Choose Edit→Cut to remove the existing named reference for this alias.
3. Click the Import button, browse to the modified alias file and click OK or Apply. Teamcenter
updates the publishing alias.
Note:
Each time you modify an alias dataset, you must reload the alias file.
2. Select the viewer pane and verify that the publishing page is loaded.
4. To load a new alias file, select it in the Available Aliases pane and click the + button. To remove
(unload) an existing alias, select it in the Loaded Aliases pane and click the – button.
When the aliases are listed correctly, click OK or Apply to load and unload alias files as necessary.
Note:
If you update an existing alias dataset by replacing its named reference, reload it by selecting the
Reload aliases check box and clicking OK or Apply.
2. Show the data tabs and select the tab for the required type of publishing page. You can configure
Teamcenter to show each publishing context in a separate tab. For example, a user clicks the Work
Instructions tab and the tab shows all the publishing pages associated with the occurrence by an
MEWorkInstructions relationship. If none exist, an empty page is displayed.
Note:
You can create publishing pages for activities only in Manufacturing Process Planner.
3. Browse though the existing publishing pages or create a new publishing page from a defined
template.
When editing an existing publishing page, the user can add, remove or edit Visio shapes and
associate them with Teamcenter assets. An asset is typically 3D geometry, a 2D or 3D snapshot, a
2D image, or a link to a Microsoft Word file or a text file.
4. Save the new or changed publishing page to associate it with the selected occurrence.
Batch processing uses the Dispatcher infrastructure for scheduling create and update features.
Additionally, Dispatcher has built-in status, logging, and error reporting features. You can use the
Request Administrator Console dialog box to obtain status information about the submitted task. Find
this in the Translation menu of My Teamcenter after you install Dispatcher.
You must set up the batch processing in the Manufacturing Process Planner or Multi-Structure Manager
applications. You can use My Teamcenter to modify the scheduling of the batch process.
• VisAutomationApp, Microsoft Visio, FMS file client cache (FCC), and the Teamcenter service-oriented
architecture (SOA) client are installed on the translator machine. VisAutomationApp is installed
automatically when you install Lifecycle Visualization.
• The startPublishBatch.bat file is installed in a directory that is specified during installation of the
PublishBatch translator. Each setting in this file must be modified as specified in the file.
• The transmodule.properties file in the module/conf directory has a MaximumTasks setting that
defaults to 3. This defines the maximum number of instances of publish batch tasks that can run
simultaneously. Do not increase this value above 3.
• The clients and Dispatcher Server should point to the common staging directory, and both should
have read/write permissions to that directory.
The following global constants and preferences configure the logical designator form.
Preference/Constant Purpose
The following preferences configure cloning of generic BOPs and product BOPs.
Preference Purpose
Preference Purpose
Preference Purpose
The following preferences configure the allocation mechanism between product BOP and plant BOP.
Preference Purpose
The following preferences configure the expansion and display of the BOP.
Preference Purpose
Preference Purpose
• EBOPCreate
Indicates the origin link relation. For example, this is used when cloning a product BOP from a generic
BOP.
• EBOPReference
Indicates that a product BOP origin link is used as a reference to construct the generic BOP link.
For these actions, configure the following copy action rule entries to use when cloning enterprise BOP
structures:
• MapLD.Ignore
Map according to logical designator equivalence. If unsuccessful, do not add the occurrence to the
clone.
• MAPLDAO.Reference
(Default action) Map according to logical designator equivalence. If unsuccessful, map according to
the absolute occurrence ID. If one is not found, the clone references the source.
• MAPLDAO.Ignore
Map according to logical designator equivalence. If unsuccessful, map according to the absolute
occurrence ID. If one is not found, do not add the occurrence to the source.
To use this feature, your administrator must configure the asynchronous services.
Note:
Because asynchronous tasks run in a separate session, the current rich client session is not
updated to reflect any changes that are made. If you choose to execute the task immediately, you
do not see all of the results in the current session. Refreshing the window or reloading the
structure after the task is complete updates your session to see the changes made by the
asynchronous process. This is not an issue for sessions that start after asynchronous processing is
complete.
• Vendor management
Teamcenter installs or modifies the following preferences when installing this solution. Normally, you
should not need to modify these preferences:
MEPlantRevision.RENDERING
MEPlantRevision.SUMMARYRENDERING
MEPlantRevision_DefaultChildProperties
MEPlantRevision_CompanyLocation_default_relation
MEAssignCustomizedOccurrenceType
• Vendor items set up in the vendor management system representing each supplier, including an exact
street address for each one
• A logistic BOP structure containing a linked plant and plant BOP structure
To allow the logistics station resolver to function properly with a collapsed plant BOP, you must ensure
that the in-context ID is populated on all the consumed lines of the plant BOP. Set the
MECopyIdInContextToAssignedLine preference to true before you assign any objects to the plant BOP
structure.
Line balancing is a method to improve the throughput of assembly lines while reducing manpower
requirements and costs. Line balancing addresses the problem of assigning operations to work stations
along an assembly line in such a way that the assignment be optimized in some sense. You perform line
balancing in Manufacturing Process Planner.
During the line balancing planning activities, you can create a variety of reports.
Line balancing uses the Teamcenter report framework to generate reports. The reports are created in
the Microsoft Excel XML format and saved in datasets. By default, the dataset is attached to the scope of
the view from which the report is launched. There is a defined default report definition and style sheet
associated with each report type. These are defined in preferences.
You can create a new report definition in the Report Builder application and modify the report
preference to point to that new definition. You can modify the report definition to change parameters or
add style sheets.
2. In the Parameters section, modify the parameters using the following parameters.
Enter this To
Enter this To
Enter this To
SHOW_COLUMN BOM-line-property- Display a column for the specified BOM line property.
name
2. Open the Activity Category in the Classic LOV folder in the Extensions view.
You can add predefined activities based on information available in the Methods Time Measurement
(MTM) system to operations in the Time view in Manufacturing Process Planner. This system sets
industry-standard times required to perform standard manual tasks. The standards include a list of time
elements where each element represents a specific and short step a worker can perform as part of the
execution of an operation. Typically, the time elements are organized into groups according to types,
distance, and difficulty. The standards are based on repeated measurements done on real production
lines.
In the Time view, you can open a data card and select individual tasks containing a set time. Each of
these tasks is added as a separate activity. You can then use these standard times to run time
calculations and analyses.
The standard MTM data cards hold times in TMU (time measurement units). Teamcenter stores times in
seconds. The METimeDataCardConversionFactor preference specifies the factor to convert from data
card time units to seconds.
You can also replace the MTM data card with a customized one that includes times required for tasks
that are specific to your company. If your customized data card contains times in units other than TMU,
you must define the conversion rate between your data card units to seconds in the
METimeDataCardConversionFactor preference.
Note:
Please be aware that the proper use of the time data card functionality does require thorough
training in MTM methodology. Without such training the user activities may lead to erroneous
results and does not represent a true MTM analysis.
For MTM training please contact your local MTM association.
You must install the data cards using Teamcenter Environment Manager before you can use them in
Manufacturing Process Planner. The default data cards are not available until you install them.
Each cell holding the time data must contain a hyperlink with the following format:
usercode://code1|time_as_double|description
Where Is
code1 The time code that appears in the Code column in the
Activities table.
Note:
You must use the pipe character (|) as a separator. To prevent illegal characters, you can use
the ASCII hexadecimal representation %7C. You can use other hexadecimal symbols to
replace special symbols in your URL text if you get incorrect results.
2. In Excel, choose File→Save As... to save the spreadsheet as a Web page (HTM or HTML extension).
3. Type the path to the HTM or HTML file in the METimeDataCardPath preference.
If you enter seconds as the unit in the Excel sheet, set this factor to 1.
Tip:
You can also find these preferences in the Data Card section of the Time tab of the
Manufacturing section of the preference Options dialog box.
5. Restart Teamcenter.
When you open a data card in the Time view, Teamcenter displays a tab for each sheet in the Excel
file. When you click an activity cell in the data card, the activity time is displayed in the Activities
table of the Time view.
TiCon integration
You can access time data from TiCon, an external time management system, and assign it to activities in
Manufacturing Process Planner using a Web service. You can search for time elements in TiCon, create
new activities, or overwrite existing activities with the timing data of time elements, and update
activities assigned to time elements that were changed in TiCon. You can use the existing time
management features to calculate time analysis based on the TiCon data.
By default, Teamcenter uses the following internal mapping system to map Teamcenter activity
properties to TiCon time element attributes:
You can use the default mapping as a starting point to create your own mapping file. You can modify
the default mapping to map your company’s activity properties to the TiCon time element attributes.
1. Create a mapping file to map activity properties used by your company to TiCon time elements.
Siemens Digital Industries Software recommends you create a Text dataset as it is easiest to edit.
Note:
You must create this dataset within a folder.
3. Add the name of this dataset, its type, and reference type to the
METimeSystemFieldMappingDataset preference.
3. On the Teamcenter 4-tier client, paste the .jar files into the TC_ROOT\portal\plugins folder.
Note:
You must have DBA privileges to perform this task.
The synchronization rules are set up using a combination of object type and property that are to be
considered.
• Event-Based
Performs a partial synchronization or publish of only the selected properties.
• Time-Based
Performs a full synchronization or publish.
• Select To Study to set up synchronization changes from the source process structure to the
study.
• Select From Study to set up publish changes from the study to the source process structure.
4. Choose whether to include or exclude the properties you select in the list.
b. Press Ctrl and select the object type and property name of each property you do not want
to include.
Tip:
To perform a full Time-Based synchronization, select Exclude the following properties
and remove all entries from the properties list.
c. Click Add.
d. Click each newly highlighted cell and open the list of entries by clicking the down arrow.
Tip:
To synchronize children of selected structures, select the object type and the
Mfg0sub_elements property.
5. Click Save.
Teamcenter saves the settings in study preferences. You do not need to modify these preferences
manually.
Note:
You can set up custom synchronization rules by adding modes to the Mfg0SimStudyRuleMode
global list of values (LOV) in the Business Modeler IDE. By default, this LOV contains only Time-
Based and Event-Based entries. Your new mode is then displayed in the Manage
Synchronization Rules dialog box, and you can create corresponding synchronization and publish
rules for the custom mode.
• MEStudyManagerEnabled
Indicates if the Study Manager is enabled and prevents studies connected to a collaboration context
with the relation specified in the preference
CCObject_Mfg0StudyStructureContext_default_relation from loading in Manufacturing Process
Planner directly. By default, this preference is true.
• Default_StructureContext_Type
Determines which type of structure context will be the default for an item type. Accepts one or more
strings as values; each string must make valid use of the following format:
<item_type>:<StructureContext_type>
Values:
Process:MEProcessContext
OP:MEProcessContext
WorkArea:MEPlantContext Item:MEProductContext
MEGenericBOP:MEProcessContext MEProductBOP:MEProcessContext
Mes0MESTXLibrary:MEProcessContext
Mfg0MEProdPrgCol:Mfg0MEProdPrgContext
Mfg0MEStudy:CompositionContext
Note:
To enable Study Manager in the Teamcenter rich client, the Mfg0MEStudy value must be set to
Mfg0StudyStructureContext.
• ActiveWorkspaceHosting.PS.URL
Specifies the URL used by Process Simulate to communicate with the Teamcenter environment for the
Teamcenter Manufacturing Access application.
Example:
http://pnv6s1325:7333/tcmaccess
• TCMAAccessHosting.RAC.URL
Specifies the URL used by Teamcenter rich client for showing the Study Manager view via the
Teamcenter Manufacturing Access application.
• TCMAccessHosting.RAC.URL
Specifies the URL used by the Teamcenter rich client to show the Study Manager view of the
Teamcenter Manufacturing Access application. Default value: empty. After installing Teamcenter
Manufacturing Access, you must update this preference with the correct URL.
• CCObject_Mfg0StudyStructureContext_default_relation
Specifies the relation that has to be created when Mfg0StudyStructureContex is pasted under a
collaboration context object. The relation specified is the default relation between the source and
target. Default value: Mfg0CCStudyRel.
• CCObject_DefaultChildProperties
Lists properties that can be used as children for the indicated type (collaboration context object). By
default, Mfg0CCStudyRel is added to the list in order to show all studies in the collaboration context
tree and in My Teamcenter. After installing Teamcenter Manufacturing Access, you must change this
preference and remove Mfg0CCStudyRel using the following format:
<TypeName>_DefaultChildProperties=my_property
• Mfg0MEShdStudyRevision.CellProperties
Defines the list of properties to be displayed under a cell for objects of the type
Mfg0MEShdStudyRevision in the Active Workspace client. Valid values are property internal names.
Default values: object_name, item_id, and item_revision_id.
• Mfg0MESimStudyRevision.CellProperties
Defines the list of properties to be displayed under a cell for objects of the type
Mfg0MESimStudyRevision in the Active Workspace client. Valid values are property internal names.
Default values: object_name, item_id, and item_revision_id.
• AWC_Mfg0MEShdStudy.CREATERENDERING
Defines the rendering stylesheet for the Mfg0MEShdStudyCreate wizard. Default value:
Awp0Mfg0MEShdStudyCreate.
• AWC_Mfg0MESimStudy.CREATERENDERING
Defines the rendering stylesheet for the Mfg0MESimStudyCreate wizard. Default value:
Awp0Mfg0MESimStudyCreate.
• CCObject_VisStructureContext_default_relation
The Mfg0CCStudyRel value sets the relation for VisStructureContext to Study Manager.
• CCObject_DefaultChildProperties
When the value Mfg0CCStudyRel is added to this preference, a study structure context under the
collaboration context tree is displayed.
• CCObject_VisStructureContext_default_relation
When the value Mfg0CCStudyRel is added to this preference, the default relation for
VisStructureContext is Mfg0CCStudyRel and not IMAN_CCObject.
• Generally, manufacturing engineers do not have write privileges on the EBOM and cannot modify it.
For example, a design engineer may specify that a part is going to be purchased and sets a property
value to buy. Subsequently, the manufacturing department determines that it is more economical for
them to make this part. They want to change that property to make but do not have the privilege to
do so.
• Assembling a part requires a structure that is different from the EBOM structure. For example, in the
BOM, the exhaust manifold is part of the engine compartment. During assembly, however, the
exhaust manifold must be added after the body is built onto the chassis as the exhaust pipe must be
put through the bumper. This type of regrouping and adding of manufacturing-specific parts is most
efficiently performed in a separate manufacturing BOM structure.
• Especially for final assembly, companies often have manufacturing parts that they consume in
different MBOMs. These can only be created in a structure to which you have write access.
• There may be changes to an EBOM that should not immediately be reflected in the process structure.
For example, you may want to continue manufacturing using the current parts to use up existing
inventory. By using an MBOM, the manufacturing engineers have control over when the changes to
the EBOM are reflected in the manufacturing process.
• Some companies do not author the EBOM in Teamcenter. It is imported from another system so that
the EBOM in Teamcenter is a replication of the status of the EBOM in another system. Using an MBOM
provides you with a buffer for these changes so that you can monitor and process them in a
controlled manner.
To ensure that all required parts in the EBOM are contained in the MBOM you can run an advanced
accountability check. This feature uses the in-context ID (IDIC represented by the AbsOccID property) to
establish logical equivalence between aligned occurrences. If you want to use this feature, you cannot
use the in-context ID for any other purpose. Using an accountability check, you can see if parts have
been added or removed from the EBOM, discern any property changes, propagate any changes from the
EBOM to the MBOM, or run the accountability check at a scheduled time.
If you use Multi-Site Collaboration and want to consume a remote EBOM in the MBOM, you must create
the in-context IDs for the BOM lines to be consumed at the owning site before you export the EBOM to a
remote site. Otherwise, a check does not report differences between the structures.
Caution:
• You cannot link an EBOM to an MBOM contained in a composition structure context. If you use
a structure context to hold the MBOM, you cannot use the alignment check feature.
• Cutting and pasting the same line back into an MBOM creates a new occurrence without an in-
context ID. This removes the equivalence between the new occurrence and the original source
part in the EBOM and causes the pasted line to be displayed as missing in the other structure in
an accountability check.
EBOM-MBOM preferences
Preference Description
MEAlignedPropertiestoExcludeFrom- Defines the list of BOM line properties that are not
Initialization copied to an MBOM when the part is originally
assigned from the EBOM to the MBOM.
Preference Description
Preference Description
• What constitutes a make part using the USER_create_or_ref_item user exit (exposed in Business
Modeler IDE using the BMF_ITEM_create_or_ref_id operation on an Item object).
• How to synchronize equivalent lines and align properties using the USER_synch_item user exit
(exposed in Business Modeler IDE using the BMF_ITEM_sync operation on an Item object).
• What constitutes equivalent lines if there is no in-context ID or occurrence thread using the
USER_item_find_equivalent_line user exit (exposed in Business Modeler IDE using the
BMF_ITEM_find_eqv_line operation on an Item object).
• Which action to take on a released MBOM Item Revision object during update using the
USER_item_action_on_release user exit (exposed in Business Modeler IDE using the
BMF_ITEM_action_on_release operation on an Item object).
Note:
Neither of the methods to create MBOMs supports part replacement through propagation.
Beginning with an MBOM template that contains phantom levels, you define a recipe for each part that
is to be manufactured. When you run the search, Teamcenter searches in the specified EBOM for parts
that fulfill the criteria and assigns them to the MBOM.
Unless a cloning rule is set up to ignore MBOM recipes, wWhen you clone an MBOM that contains
recipes, Teamcenter clones the recipes as well.
2. Right-click a node on which you want to save a search criteria and choose Open With→BOM
Recipes.
4. In the BOM Recipe Details view, enter a name for the search and the search criteria that describe
the parts that you want to add to the MBOM at the selected node.
What you enter as search criteria is company-specific but may include usage address, position
designator, or a function-based numbering scheme making up the ID.
You can add multiple criteria to one search box by separating them with a semicolon.
Teamcenter runs the search on the EBOM and lists the parts that fulfill the search criteria in the
BOM Recipe Validation Results view. Use this step to verify that you have entered the correct
criteria.
Teamcenter lists the new recipe in the BOM Recipes view. You can save multiple recipes on an
MBOM node.
• To resolve one node of the MBOM template, select the recipe in the BOM Recipes view and click
Resolve BOM Recipe .
• To resolve multiple nodes of the MBOM template, select a node in the MBOM template and
choose Tools→Resolve BOM Recipe.
8. In the Resolve BOM Recipe dialog box, select whether to remove the previously assigned parts
and click OK. If you open the dialog box from the Tools menu, you can choose to resolve all nodes
underneath the selected node by selecting Resolve recipe recursively.
Teamcenter adds the parts from the EBOM that fulfill the search criteria to the MBOM.
Additionally, the resolved parts are listed under the recipe in the BOM Recipes view.
You cannot directly copy a BOM recipe. You can, however, select a recipe in the BOM Recipes view, and
then select a different node in the MBOM. The search criteria are still visible in the BOM Recipe Details
view where you can save them as a new recipe on a different MBOM node.
Do not use this utility to update the MBOM. To update an MBOM, use an accountability check or an
advanced accountability check.
You can create a manufacturing bill of materials (MBOM) from an engineering bill of materials (EBOM)
automatically using the me_create_mbom utility. This utility creates a new MBOM root node, and then
either:
• Replaces the parts designated as Make with new manufacturing parts containing the same in-context
ID (IDIC) as the engineering part for future comparison.
Example:
me_create_mbom -u=kj -p=kj -g=Engineering -
key="item_id=000159,object_type=Item" -revrule="Latest Working" -
mrevrule="Latest Working" -log=D:\workdir\create3.csv –usemfk
Caution:
Log off any interactive session that uses the same structures as the structures you update with the
utility before you use the utility to avoid failures due to locking of objects in that user session.
• MEMBOM_Mirror_MakeRules
This preference specifies a BOM Line property, such as bl_item_object_type, and property value pair
that serve as input for the decision as to whether to create a manufacturing-specific part.
There are two ways to view defined BOM Line property names:
1. In the BMIDE, you can check the properties defined for the object BOM Line.
2. In Structure Manager, if you right-click on the column title line and choose Insert Column(s)…,
you get a list of the defined BOM Line properties.
Preference syntax
KEY:<BOMLinePropertyInternalName>,VALUE:<PropertyValue>,ACTION:<ActionValue>
• <BOMLinePropertyInternalName> is the property on which the value criterion will apply (e.g. "GCS
CP").
Note:
ACTION is only meant for Design/Part like structures. If more than one value for a given
property can determine the action, the operator OR ('|') can be used as follows:
"KEY:<BOMLinePropertyInternalName>,VALUE:<PropertyValue1>,ACTION:<ActionValue1>|
VALUE:<PropertyValue2>,ACTION:< ActionValue2>" (e.g. "KEY:GCS CP,VALUE:Make|
VALUE:MakePart,ACTION:PartAssign|VALUE:MakeLink,ACTION:PartLink"). If there is no
preference value, the item is shared between Engineering BOM (EBOM) and Manufacturing
BOM (MBOM) structures.
A common criteria may be, for example, whether you make or buy a part. Any parts designated as
Make or Phantom (for organizational purposes) in the EBOM are replaced by manufacturing-specific
parts in the MBOM. In this case, the value of this preference may look like this:
KEY:Usage_MakeOrPurchase,VALUE:Make|VALUE:Phantom
You can use a custom property in this preference. If you do not assign any value, the utility carries
over the parts from the EBOM directly.
Note:
You should write your own Business Modeler Framework extension to control a make or buy
decision.
• MEMBOM_Mirror_TypePrefixSuffix
This preference specifies the item type for the new manufacturing-specific item and any prefix or
suffix to add to the item ID of the part in the EBOM that is being replaced by a new part in the MBOM.
If you use custom manufacturing business object types, you can add this type to the value of this
preference.
The default value of -usemfk is false. If true, and only the object type is present in
MEMBOM_Mirror_TypePrefixSuffix, use that type and the ebom item id for MFK value. If you set the
command line option -usemfk to true and specify only the item type, you can enter multifield keys.
If your company uses naming rules for new items, you must ensure that the prefix that you assign in
this preference corresponds to the naming rules for the manufacturing item. Alternatively, you can
remove all naming rules for manufacturing items. A conflict with item naming rules leads to this error
message:
• MEMBOM_Mirror_ReplaceMakeOnChange
This preference specifies the behavior when, after creation of an MBOM, you change a make/buy
property value from Make to Buy. At update, by default, Teamcenter simply appends the buy part to
the existing structure without removing the make part already in the MBOM. If you set this preference
to TRUE, at update, Teamcenter replaces the make part in the MBOM with the buy part from the
EBOM, avoiding duplication of parts.
• MEMBOM_Mirror_RemoveLineWithIDIC
This preference is applicable to updating an MBOM with the utility. It specifies that if the in-context ID
(IDIC) of a line in the MBOM is not found in the EBOM, or if a line in the MBOM has no IDIC, it is not
removed at update if it is already stamped with an IDIC.
• MEMBOM_Mirror_IDICOnChildren
This preference determines whether the IDIC is retained on a make part in the MBOM when updating
it using the utility after changing a make part to a buy part in the EBOM. When updating, if the
MEMBOM_Mirror_ReplaceMakeOnChange preference is set to FALSE, both the original make part
and the buy part exist in the MBOM after updating. This causes the accountability check to display
multiple matches. Removing the IDIC on the make part ensures that there is only one match in an
accountability check. If the MEMBOM_Mirror_ReplaceMakeOnChange preference is set to TRUE,
the make line is replaced with the buy line from the EBOM so this preference is irrelevant.
• MEMBOM_Mirror_IgnoreRules
This preference uses the keyword ACTION to skip an EBOM node or to traverse below an EBOM node
while ignoring that EBOM node. The children of the traversed EBOM node become the children of the
corresponding MBOM parent.
• MEMBOM_Mirror_AlignProperties
This preference controls which properties and attachments are copied from the EBOM to the MBOM
by enabling the alignment of properties on Make items and revisions. The Make nodes are of
different types than the original EBOM nodes.
The following examples of running the utility demonstrate its use and the differences in output caused
by changing the utility arguments. The initial values of the preferences are as follows.
MEMBOM_MakeRules=KEY:Usage_Product,VALUE:Make|VALUE:Phantom
MEMBOM_RemoveLineWithIDIC=FALSE
MEMBOM_TypePrefixSuffix=Company,,
Note:
No prefix is used in this course due to the naming rule conflict.
Creating an MBOM
• The make and phantom parts are replaced with new manufacturing-specific parts.
• The buy parts of the EBOM are directly copied over to the MBOM.
• An IDIC is generated for all parts except for those below a buy part.
• The in-context ID (IDIC) of the new parts is the same as the original part in the EBOM. This is true if
the IDIC is already present in the EBOM part.
• When you right-click the top node of the EBOM or MBOM and choose Link/Associate→Link
Structures, you can see that the utility has linked the two structures.
Note that the new MBOM contains only two levels of structure. The remaining levels in the EBOM are
ignored.
You now update the MBOM above, but only for the M_000225 line and down, requiring the following
utility command:
You change the Make value to Buy for the drive gears and change the Buy value to Make for the rcvr
remote control in the EBOM and run the utility as follows:
When the rcvr remote control part is changed from a Buy to a Make, the utility replaces the buy part in
the MBOM during update. Buy to make behavior is not affected by preference settings. For the make to
buy change (the drive gears), the behavior depends on two preferences:
• If MEMBOM_Mirror_IDICOnChildren is set to FALSE (or does not exist), the IDIC on the make part
in the MBOM is retained. Performing an accountability check between the EBOM and MBOM results
in multiple matches as the MBOM contains both a make and a buy part with the same IDIC.
• If MEMBOM_Mirror_IDICOnChildren is set to TRUE, the IDIC on the make part in the MBOM is
deleted and an accountability check displays the make part as missing in source.
Caution:
You must exercise caution when removing an IDIC on any part. This can cause problems in
other areas, for example, if the part is consumed in an process structure, you lose the link to
that line.
In the following EBOM and MBOM, M_000229/A;1–M_rear_drive_asm is released and then the
make/buy property on its child, 000230/A;2–rear_axle, is changed from Buy to Make.
You revise the MBOM part so you have write access and run the update utility.
The utility revises the part and replaces the old revision with the new one.
To detect property changes in the EBOM, run an accountability check between the EBOM and MBOM.
You can propagate any property differences using the accountability check mechanism.
Attachments
Attachments are always synchronized as the attachment is created as a reference on the new make part.
Any changes to the attachments on the EBOM side are automatically reflected in the MBOM. If you add a
new attachment to the EBOM, you must run the update to see it in the MBOM part.
The ID is generated in the context of the top-level item. Even if you do not have write access to the top
level of the EBOM, Teamcenter allows this ID to be generated and saved with the top-level item. If you
are using Multi-Site and the EBOM is at the remote site, however, this mechanism does not work as
Teamcenter must be able to check out the top level to generate the ID. A similar problem arises if you
want to assign from an EBOM that exists on a remote site to a local process.
To enable a remote site to use the EBOM-MBOM mechanism in these situations, you can generate in-
context IDs on the EBOM that are available when you paste parts to the MBOM. Use the bom_expand
utility to generate these IDs on the EBOM. For the EBOM shown in the figure, enter this command:
Generate these IDs on a regular basis, for example, nightly, so that they are up-to-date when users
assign parts from the EBOM to MBOM.
Caution:
Attaching an in-context ID to a line in a structure creates several new objects in the database. If
you work with large amounts of data, this may have a detrimental affect on performance or
scalability. You should only pregenerate these IDs if you use EBOM and MBOM in a Multi-Site
environment.
Example:
Assigning EBOM line 000155/A;1-c7 to the linked MBOM inherits its effectivity from that line, not
from any line with a different effectivity higher in the structure.
Example:
Assigning EBOM line 000156/A;1-c8 to a linked MBOM results in the assigned line inheriting its
effectivity from its parent line because it has no effectivity. If you assign EBOM line 000156/A;1-c7
to the MBOM, it retains its own effectivity of 11-25.
Net effectivity calculates the intersection of effectivities set on the path from the EBOM line to be
assigned up the parent chain. Starting from the selected EBOM line, and including the EBOM line itself,
net effectivity traverses up the parent chain until it finds the first parent with an explicitly defined
occurrence effectivity. The occurrence effectivity defined on that parent becomes the MBOM line’s net
effectivity. If an effectivity is defined in the BOM window’s revision rule, the computation intersects the
parent’s occurrence effectivity with that defined in the revision rule. The result of the intersection is the
final net effectivity.
To apply calculated net effectivity behavior, set the value of MEEffectivityAssignmentMode to 2 and
add the value bl_occ_effectivity to the MEAlignedPropertiesList preference. You must also ensure that
no preference beginning with the text MEAlignedPropertiesToExclude... has the value
bl_occ_effectivity, and turn on net effectivity calculations using the Business Modeler IDE.
Example:
The top line of the EBOM shown is associated with a multi-unit configured effectivity group with
values of 1–10 (not visible). Line 000156/A;1-c8 has no effectivity, but its parent, 000154/A;1-
Deform has a value of 1–20. Net effectivity calculates the available range shared by the multi-unit
configured effectivity group value (1–10) and the 000154/A;1-Deform value (1–20), which is 1–
10.
Note:
• End users can edit the relative transform matrix in the BOP to align the absolute transformation
matrix.
• By default, quantity is copied to the BOP. If end users delete a quantity value in the BOP, the
quantity value is delegated from the MBOM.
Additional properties that can be delegated include bl_formula (variant formula), bl_abs_occ_all_ids
(ID in context, all levels), and bl_variant_condition (variant condition).
• Part structures that are created in a part BOM using heavy alignment have parts with BOM view
revisions (BVRs) that are not actually assemblies. Change any existing customizations to treat parts
with BVRs as leaf lines if they are to be marked as end items.
• The CAD BOM design items and structures must either be created in a CAD system or empty design
items created by a manufacturing engineer as a work order for the designer.
• In the part BOM, add a precise clause to the top of the revision rules.
Example:
The group feature can be used to create the following clause: Has Item Type (Design)
{Precise}.
To calculate rolled-up variant conditions from the CAD BOM and add the logically equivalent variant
condition to the aligned part line, add the bl_condition_tag property to the
MEDesignToBomAlignmentProperties preference.
To avoid errors during heavy alignments, if you are using the TCAllowedChildTypes_<Part> preference,
you must modify it to allow design items. Similarly, if you use the TCAllowedParentTypes_<Design>
preference, modify it to allow part Items.
For broken links, the system looks for the following in order.
Example:
AIE_OCC_ID and AIEAIE_OCC_NAME.
If any of these do not match, the CAD object is excluded from the end user's search results. If the part
object was never linked to the CAD object, the system looks for the following in order.
Note:
If no previous alignment exists and there is a change to the CAD part (for example, the ATM has
changed), the search may not locate the object.
ME_update_part_alignment_on_design_change-AH
This action handler updates part revisions in a part BOM related to an input CAD BOM design revision.
• The reference folder can optionally contain a previous design revision. If a reference folder is not
provided, the handler tries to find a previously linked design revision.
• Allowed values:
/**
@returns
<ul>
<li>#ITK_ok on success.
<li>#EPM_invalid_argument_value if 'forceupdate' argument is not
'0 or
1 or 2'.
<li>#EPM_wrong_number_of_arguments if more than one Design
Revision
is provided.
<li>#EPM_target_object_not_attached if an invalid Design
Revision is
provided.
<li>Possibly other errors
</ul>
*/
extern ME_API int
ME_update_part_alignment_on_design_change_action_handler (
EPM_action_message_t msg );
ME_update_part_bom_alignment_to_mature_design-AH
This action handler recursively aligns previously aligned part lines in a part BOM to a currently
configured design revision in a CAD BOM that matches maturity criterion. If the
MEDesignToBom_check_maturity preference value is false, the alignment considers the currently
configured design revision as mature. The target folder requires a collaboration context containing one
design scope line and one part scope line.
/**
Action handler to update part bom for mature designs in design bom.
@returns
<ul>
<li>#ITK_ok on success.
<li>#EPM_target_object_not_attached if an invalid Collaboration
Context is provided.
<li>Possibly other errors
</ul>
*/
extern ME_API int
ME_update_part_bom_alignment_to_mature_design_action_handler(
EPM_action_message_t msg );
You can view the in-context ID by displaying the ID in Context Top Level column. It is usually
automatically generated, and you should exercise caution in modifying its value.
• Reconciling and engineering bill of process (EBOM) with a manufacturing bill of process (MBOM)
• When you assign a bill of materials (BOM) to a BOM or a bill of process (BOP) to a BOP
• When you assign a BOM to a BOP or enterprise BOP (EBOP) structure if the
MECopyIdInContextToAssignedLine preference is set to true
An in-context ID is not generated when you assign from an EBOP structure to an EBOP structure.
Caution:
If a line has an in-context ID and you cut it and paste the same line back into the structure,
Teamcenter creates a new occurrence without an in-context ID. Therefore, any of the above
comparisons based on the in-context ID no longer work.
• Lines in a view
Whether you need to expand a target structure before choosing the Find in All Visible Views menu
command depends on the settings of the following two preferences:
MECopyIdInContextToAssignedLine
MECopyIdInContextLowerLevels
Note:
Whether you need to expand a structure before a found component can be highlighted within it
depends on the value of the MEExpandToSelection preference. If this preference is set to false,
you must manually expand the target structure to highlight lines found within that structure.
• MECopyIdInContextToAssignedLine
If set to True, Teamcenter copies any existing in-context IDs to the target structure when assigning a
product to a process or copying a process or operation from one structure to another. If an in-context
ID does not exist, Teamcenter creates one on the source and copies it to the target object. Any
generated IDs are unique within the source and target structures.
If set to False, no in-context ID is copied.
• MECopyIdInContextLowerLevels
If set to True, Teamcenter copies any existing in-context IDs of consumed items under subprocesses
and suboperations to the target structure when copying a process or operation from one structure to
another. If an in-context ID does not exist, Teamcenter does not create one.
If set to False, no in-context ID gets copied for the consumed items under subprocesses and
suboperations, even if one is present.
Note:
The MECopyIdInContextLowerLevels preference is considered only if
MECopyIdInContextToAssignedLine is set to True.
In the following example, if you copy process P1.1 from Proc1 in the upper pane to Proc4 in the lower
pane:
• Teamcenter only generates an in-context ID for the process that is being copied. It never generates an
in-context ID for subprocesses, suboperations, or their consumed items, regardless of the settings for
these preferences.
Note:
For P1.1, the ID is not generated at the source if it is not present (in the following example, it is
already generated).
After copying, under the Proc4 process, note that there are no in-context IDs in the ID In Context
(Top Level) column.
Note:
For P1.1, the in-context ID is generated at the source if it is not present and then copied. For
I1.1, the ID is not generated if it is not present.
Note:
For P1.1 the ID is generated at the source if it is not present and then copied. For I1.1 and I1.2,
if the ID is not present, it is not generated, but if it is present, it is copied.
• You want to assign parts to a relevant process or operation where the parts in the BOM are changing
often resulting in a loss of occurrence information and you want to avoid having to assign the new
parts to the same process or operation manually.
• You want to clone an existing structure and automatically assign the same parts to the new cloned
structure.
• You want to compare an intermediate data capture to the structure from which it was made to see
what changes have occurred since you created the intermediate data capture.
• When performing EBOM-MBOM maintenance, for example, by overwriting existing IDIC values in a
BOM to ensure consistency.
You can automate the generation of IDICs for BOM lines to be based on the concatenation of other
properties of the BOM line. The combination of these properties results in a unique string that
Teamcenter assigns as an IDIC.
• ME_angular_tolerance
• ME_translation_tolerance
Note:
If you use a CAD integration with Catia or other CAD application and use a bill of materials
(BOM) to BOM or BOM to bill of equipment (BOE), updates sometimes cause small BOM CAD
tolerance variations so that parts in the model show as incorrectly changed during advanced
accountability checks. To reduce the number of outliers during such checks, increase the
ME_angular_tolerance and ME_translation_tolerance values.
Caution:
You may notice performance issues when setting this preference.
• Run the me_stamp_ids utility to generate IDICs for an entire structure, based on a closure rule.
• Create a workflow process based on the ME-stamp-ids-AH action handler to automate the process
from the user interface.
When using the utility or action handler, you can specify whether Teamcenter allows duplicate IDICs in
the MEIdGenerationAllowDuplicates preference.
Note:
• The command may take some time to complete its task.
• After the command completes you must restart Manufacturing Process Planner to see the
changes.
Warning:
IDIC values are not stamped if:
• There are multiple empty IDICs in the EBOM or assigned lines in the process structure for a given
itemid and propertyset (that is, for the same itemid and the transform for multiple lines with
no IDIC).
• An IDIC on a target line exists but is different from the source IDIC, even though the itemid and
propertyset values match.
You can configure the PreExpandProcess closure rule to suit your needs.
• For custom root (top level) items, the preference MEDynamicIPARootItemTypes needs to include all
object types included in the assembly. This preference specifies the types of root items allowed in a
DIPA (default = Item).
• Modify the DynamicIPAProcessOnlyWithPA preference to allow the custom process object types.
• To export DIPAs:
• If you use the ConfiguredDataFilesExportDefault transfer mode, you must add the following
closure rule:
• If you use the ConfiguredDataExportDefault transfer mode, you do not need to make any
changes.
• To import DIPAs:
• If you use the incremental_import transfer mode, you do not need to make any changes.
• If you use any other transfer mode, including ConfiguredDataImportDefault, you must add the
following closure rule:
Top
Sub/A
EndItem/A
Child1/A
Child2/A
Child3/A
• If you want to export Top and Sub and suppress everything from the EndItem level (including
EndItem), use the following conditional clause:
SECONDARY.fnd0bl_is_mono_override!= "1"
• If you want to export Top, Sub, and EndItem and suppress everything below the EndItem level (but
not EndItem), use the following conditional clause:
PRIMARY.fnd0bl_is_mono_override!= "1"
CLASS.BOMLine:CLASS.BOMLine:PROPERTY.bl_child_lines:PROCESS+
TRAVERSE:PRIMARY.fnd0bl_is_mono_override != "1"
• MEDefaultExportTransferOptionSet
Specifies the list values to be made available in the Export to Briefcase dialog box transfer option set
drop-down list. The values displayed are dependent on the values in the
MEDefaultExportTransferOptionSet preference and the values of the transfer mode in the
TC_gms_export_default_transfermode preference.
If TC_gms_export_default_transfermode has a value of TIEExportDefaultTM, there are two cases:
• Only the values that are specified in this preference and have a transfer mode value of
TIEExportDefaultTM are displayed in the Export to Briefcase dialog box transfer option set drop-
down list.
• If none of the transfer option set names specified in this preference have a transfer mode value of
TIEExportDefaultTM, all transfer option sets with a transfer mode value of TIEExportDefaultTM
are displayed in the Export to Briefcase dialog box transfer option set drop-down list.
Default values for the transfer option set drop-down list are:
Note:
The first value specified in this preference defaults to the selected transfer option set in the
Export to Briefcase dialog box.
• MECCBriefcaseExportWithMultipleVariantRules
Enables the briefcase export of a collaboration context containing a product structure with multiple
variant rules. The default value is false.
• MERuleForBriefcaseExport
Defines the rule to govern creation of an appearance path node (APN) for the BOM lines during
briefcase export of a collaboration context. This helps the recipient of exported data perform certain
operations, such as the consumption of product to bills of process (BOPs) where if a particular object
does not have ownership, Teamcenter does not allow it to create an APN there. Therefore, in such
cases, it can use the created APN during export using this preference.
The default values for this preference are:
• MEAutomaticOwnershipTransferClosureRules
Specifies the closure rule to be used in recursive ownership transfer of export to briefcase
functionality for collaboration context objects. The default value is MfgDefaultOTCR.
The closure rule governing recursive ownership transfer should be based on BOM line to BOM line
traversal. Do not use any persistent object for defining traversal for recursive ownership transfer. For
example, the clause shown allows traversal from the parent BOM line to child BOM line when the parent
is of type MEProcessRevision and the child is either MEProcessRevision, MEOPRevision, or
MEWorkAreaRevision.
In the example, if a parent line of type MEProcessRevision is marked for ownership transfer, any child
line with types MEProcessRevision, MEOPRevision, or MEWorkAreaRevision are considered for
ownership transfer as well when the recursive ownership check box is selected while exporting the
collaboration context.
You can activate geometric dimensioning and tolerance symbols for any type of form, including master
forms for a Teamcenter object. You can apply normal Access Manager rules to any form that contains
geometric dimensioning and tolerance symbols.
Users may only edit or add geometric dimensioning and tolerance symbols or rich text in a box after
clicking the edit button next to the relevant box. They may then enter symbols, control characters or
font formatting from the buttons provided or the keyboard. When editing or additions are complete, the
user saves changes and leaves edit mode. This feature is available in any application that allows viewing
of forms, including Manufacturing Process Planner, Part Planner, and Multi-Structure Manager. Detailed
usage information is given in the guides for the applications that support this feature.
You can print and view reports that are generated from forms that contain geometric dimensioning and
tolerance symbols or rich text. You can generate forms in two formats:
• HTML
Teamcenter generates a PLM XML file from the process structure, which is parsed, interpreted with
XSL style sheets, and converted to HTML files.
• PDF
Teamcenter generates a PLM XML file from the process structure, which is parsed, interpreted with
XSL style sheets, and converted to Formatting Object (FO) files. The information must then be
converted to PDF format by a third-party formatting tool.
Note:
This feature is only supported on Microsoft Windows systems.
Ensure you have a supported browser installed on your workstation if you want to view or print
HTML reports of information containing GD&T symbols.
b. For this preference, enter the names of the GD&T and rich text form fields you want
Teamcenter to recognize in the Values box, for example, work_instruction and tolerance.
c. Similarly, create a new preference at the SITE level or above called GDT_formtypes, and enter
a list of form type names as the value of this preference. Teamcenter recognizes these form
types and, if a form of one of these types has a GDT box (that is, the name of the box is
defined in the GDT_properties preference), it renders this field as a GD&T/rich text box.
You have now defined names of GD&T/rich text attributes (fields) and form types. By default,
Teamcenter renders GD&T and rich text fields as specified by the GDT_properties and
GDT_formtypes preference entries. You can also use the XML style sheet mechanism to override
these settings, as described in step 4.
2. Create the form types that can display geometric dimensioning and tolerance symbols or rich text,
as follows:
a. Start the Business Modeler IDE and create new classes that have attributes listed in the
previous step under POM_object. For example, you might create a new class called
DemoGdtForm. Define the attributes for GD&T and rich text as String type with the
maximum length possible.
b. In the Business Modeler IDE, create new form types that use the class you created as the
underlying POM class. Similarly, you can also create item master forms or item revision master
forms to support GD&T and rich text in those master forms.
3. Copy the gdtex.ttf font file from the rich client installation directory to the FONTS directory of your
Microsoft Windows system.
Note:
You must install this font file on every workstation where HTML are generated, viewed or
printed.
4. Define an XML style sheet for the form type that contains GD&T or rich text fields. Enter gdtpanel
as the rendering hint of the intended GD&T and rich text fields. If you do not give a rendering hint,
Teamcenter uses the default renderer (it checks if a box contains GD&T or rich text by looking at
the preference settings).
The following XML example shows a style sheet for a form. In this example, comments and
tolerance are rendered GD&T or rich text, while work_instruction is rendered as a text area. These
rendering hints override any conflicting preference settings.
<rendering>
<page title="General" titleKey="General" format="TwoColumn">
>firstcolumn>
<property name="Quantity" modifiable="false"/>
<property name="comments" renderingHint="gdtpanel" modifiable="true"/>
<separator/>
<property name="tolerance" renderingHint="gdtpanel" modifiable="false" />
</firstcolumn>
<secondcolumn>
<property name="work_instruction" renderingHint="textarea"
modifiable="false"/>
</secondcolumn>
</page>
<page title="Reservation" titleKey="Reservation">
</page>
<page title="Project" titleKey="Project">
</page>
<page title="All" titleKey="All">
</page>
</rendering>
5. Verify you can now display and edit geometric dimensioning and tolerance symbols or rich text on
the appropriate forms and can export the data into reports.
Note:
If Teamcenter indicates it cannot find the corojdk11.dll library, locate this file on the
Teamcenter installation CD, and copy it into your system path.
If the display of GD&T and rich text becomes unstable when you type quickly, increase the
value of the EDITOR_UPDATE_LATENCY variable in the com\teamcenter\rac\form\gdt
\gdt.properties file from the default value of 50 and restart Teamcenter. This instability
occurs on slower machines.
• NoClassDefFoundError
Java cannot access the embedded viewer JAR files. This error is identified by an error message similar
to the following:
java.lang.NoClassDefFoundError:
com/ugs/plmvis/components/<AnyClassName>
Possible solutions:
• Check the Java console and verify the correct classpath is set, as described previously. Ensure the
SingleEmbeddedViewer.jar file is included in the classpath.
To view the classpath, open the Java console and type s to dump all system properties. Note the
displayed value of the javaplugin.vm.options property and check that it contains the classpath
string you entered when you configured the Java console.
• If the classpath is not correct, there may be more than one Java control panel; you may not have
modified the correct one. Choose Start→Settings→Control Panel and select the button that
matches the version number in the Java console window. Modify the classpath for this Java control
panel.
• Verify there are no typographical errors or unnecessary spaces in the classpath definition. For
example, ensure there is an = character between -classpath and the path name. Also, if you have
multiple classpath entries, ensure they are separated by ; characters.
• If none of the solutions work, copy the SingleEmeddedViewer.jar file manually from PV _Base_Dir
\Program to JRE_HOME\lib\ext folder. Close all Internet Explorer browser instances, restart the
browser and try again.
• NoClassDefFoundError: com/eai/visweb/components/...
You are trying to run reports from a previous version of Teamcenter. You should convert your reports
to use the current embedded viewer.
• VerifyError
The JRE version is incompatible with the HTML page. This error is identified by an error message
similar to the following:
java.lang.VerifyError: (class:CMEReportJTViewerApplet,
method: destroy signature: ()V)
Incompatible object argument for function call
at java.lang.Class.getDeclaredConstructors0(Native Method)
Possible solutions:
• Ensure you have installed the supported JRE version, as specified in the installation guide for your
operating system, and update it if necessary.
• Verify you have installed the correct version of the CMEReportJTViewer.jar file and update it if
necessary.
• EXCEPTION_ACCESS_VIOLATION
The version of the embedded viewer you have installed is not compatible with the
CMEReportJTViewer.jar file in the reports directory. This error is identified by an error message
similar to the following:
Possible solutions:
• Ensure you have the correct version of the embedded viewer. You must also update the PATH
environment variable and modify the classpath for the new version.
• Ensure you have the latest version of the CMEReportJTViewer.jar file in the reports directory.
• java.security.AccessControlException
If you see a blank HTML page with the following error in the Java console window, the Java policy file
is not edited correctly. Check the file and edit.
Note:
The following instructions assume you are configuring a Microsoft Windows system. Similar
configuration steps are necessary if you are using another operating system.
Some of the steps may vary depending on which operating system, browser, or JRE version you
use.
• If you are using the Microsoft Internet Explorer browser, modify the Internet properties, as follows:
3. Select the Allow active content to run in files on My Computer check box in the Security
group of entries and the Java console enabled check box in the Microsoft VM group of entries.
4. Click OK or Apply, and then close and reopen the browser to complete any changes.
Note:
If you are using the Firefox browser, this procedure is not required. However, if you encounter
problems viewing reports with Firefox, choose Tools→Options and verify the Enable Java
check box on the Content pane is selected.
• Install the embedded viewer and run its setup program, if you did not already do so when you ran
Teamcenter Environment Manager (TEM). During installation, avoid spaces in installation directory
names, as these may cause incorrect operation in certain circumstances.
• Ensure that the JRE version you have installed is at least version 1.6.0_20 or later.
• Click the Advanced tab of the Java control panel and ensure the Place Java icon in system tray
check box in the Miscellaneous group is selected. This ensures the Java console is always present in
the Windows system tray, allowing easy access to it for troubleshooting.
When troubleshooting, you can also select the Enable tracing and Enable logging check boxes in the
Debugging group. This displays more detailed information in the Java console window that may help
you debug problems.
Optionally, you can click the Show Console button in the Java Console group to open the Java
console for debugging purposes whenever the applet is active.
• Click the Browser tab and ensure that the check box for your browser is selected. If you have more
than one browser on your system, check each applicable check box.
If you changed the Java run-time parameters in the previous step, clear your current browser, click
Apply, then recheck the current browser and click Apply again. This loads the new environment
variable setting into the browser.
• Modify the Java security settings to allow the browser to open the DLL files for the embedded viewer
and JT files in one of the following ways:
• Edit the java.policy file in your JRE_HOME\lib\security directory with a text editor, not a word
processor. Add the following entry to this file:
grant {
permission java.security.AllPermission;
};
• Use the policytool.exe application in your JRE_HOME\bin directory to grant the same permissions.
See the Sun documentation for information on using this tool.
If you have more than one version of the JRE on your system, or if you also have the Java Software
Development Kit (SDK) installed, there may be more than one copy of the java.policy file. If possible,
identify the version that is used by the browser. Identify the policy deployment directory by opening
the Java console, typing s to dump all system properties, and noting the displayed value of the
application.home property. Place your modified java.policy file in the directory indicated by this
property; if the directory does not exist, create it. Alternatively, if you are using Internet Explorer, you
can modify the file pointed to by the deployment.system.security.policy value.
Note:
Close all browsers before testing changes.
2. Click the button next to the Type box and select a report from the list of available types.
3. Click the Generate Reports button to create the report. Optionally, you can click the Save button
to save the report you generated.
4. Open the Attachments view. The generated report is shown as an attachment to the process or
operation item revision. You can double-click the report to open and view it.
For example, you may want to create a report that details the usage of various machined components in
assembly operations. From the definition of the product structure, Teamcenter extracts the following
information:
• The name or identification of each part consumed in the manufacturing process. Thumbnail pictures
can also be included if required.
• Detailed information about each part, such as the dimensions, quantity, and Make/Buy status.
• A graphical representation of the manufacturing structures and assemblies. Each part is linked to
others to show the hierarchy in the assembly structure.
A summary page may define the total number of components, welds, and the comparative number of
bought and manufactured parts.
When running the accountability check, it is helpful to have the selection between the Accountability
Check Results view and the structure view synchronized—selecting a line in the results view selects the
same line in the process view. You can control selection synchronization using the
MEExpandToSelection preference. Set it to True if you want a selection on the results pane to select
the equivalent line in the BOM. This can be set in the Options dialog box in the Manufacturing pane.
3. Select the user, role, or group for whom the setting should be available.
When that user, role, or group signs in, the setting is available for them when they want to run an
accountability check on structures of the same type.
The mechanism used to manage these preferences is common to all Teamcenter preferences.
You may need to create new or modify existing closure rules for your own business use case. The closure
rules you create for the accountability check are referred to as inclusion rules and are not available for
importing and exporting. You can create and modify closure rules in the PLM XML/TC XML Export Import
Administration application.
Note:
Expanding a structure based on closure rules also plays a role in which objects are taken into
consideration in the accountability check. If you expand using an appropriate closure rule, you
may not have to set an inclusion rule when running an accountability check.
All the existing closure rules created for the accountability check begin with Accountability or AC. When
creating new closure rules, note the following:
• If you want a line in the structure to be considered in the accountability check, set the Action Type
entry to PROCESS.
If the Show Unconfigured view options are set to show the unconfigured structure and you want to
only consider the configured lines for the accountability check (using closure rules mode), adding the
following clause to the existing list of closure rule clauses causes the accountability check to skip the
unconfigured lines.
If you create your own inclusion rules for the accountability check, you must add them to the following
preferences to have them displayed in the Accountability Check dialog box.
• MEAccountabilityCheckSourceStructureExpansionFilterRules
List of closure rules that are displayed in the Accountability Check dialog box.
• MEAccountabilityCheckTargetStructureExpansionFilterRules
List of closure rules that are displayed in the Accountability Check dialog box.
You can also set the maximum number of lines to be returned by the accountability check using the
preference MEAccountabilityCheckMaximumAllowedLines. If the actual number exceeds the
maximum, a printable report is generated and attached to the accountability check target structure.
If you want to customize the report using the temporary XML file before Teamcenter deletes it, do the
following.
2. Open the Report Builder application and in the Reports Home pane, expand the Teamcenter
Reports node.
5. From the Selected Stylesheets section, select the default stylesheet and click .
6. Click Modify.
9. Use this XML file to help you customize the stylesheet and then give it a unique name (for example,
my_acc_chk_rpt_excel.xsl).
10. Click and in the Import Stylesheet dialog box, from the Dataset Type list, select MSExcel.
11. Browse to the custom stylesheet you want to use and click OK.
12. From the Defined Stylesheets list, select the custom stylesheet and click to add it to the
Selected Stylesheets list.
13. Set the value of the preference AccountabilityCheckReportStylesheetName to the name of your
custom stylesheet.
14. Click Modify, log out of Teamcenter, and then log in again.
When you now generate an accountability Check Excel report, Teamcenter will use the customized
stylesheet. The above steps need to be executed every time you change the stylesheet.
2. Open the Report Builder application and in the Reports Home pane, expand the Teamcenter
Reports node.
5. Click and in the Import Stylesheet dialog box, from the Dataset Type list, select MSExcel.
6. Browse to the custom stylesheet you want to use and click OK.
7. From the Defined Stylesheets list, select the custom stylesheet and click to add it to the
Selected Stylesheets list.
When you now generate an accountability Check Excel report, Teamcenter will use the customized
stylesheet. The above steps need to be executed every time you change the stylesheet.
Note:
If you created a custom stylesheet prior to upgrading to Teamcenter 11.4 or greater, by default,
the Excel report uses a new stylesheet called acc_chk_rpt_excel.xsl. Your customized stylesheet
must have a different, unique name (for example, my_acc_chk_rpt_excel.xsl). When the value of
the preference MEAccountabilityCheckReportCombineLines is true (default), the generated xml
file will not support legacy stylesheets. To generate legacy data xml files, change the preference
value to false.
This controls whether the accountability check mechanism checks for net effectivity.
3. Implement a user exit and register a method for it in the Business Modeler IDE.
By default, the preference value is empty. The preference is at the site location but each user can create
his own copy and modify the value since the protection scope is set to user. The user must restart
Teamcenter after setting its value.
You must configure this user exit in the Business Modeler IDE application. When doing so, note that the
extension point is Fnd0BOMLINE_ask_effectivity_by_parent and the method is
BMF_BOMLINE_compute_net_effectivity.
Teamcenter offers you two separate methods for running an accountability check in batch mode.
• Run an accountability check in the rich client using the Accountability Check→Schedule
Accountability Check and Accountability Check→Schedule Structure Propagation commands.
Use this method if:
• You want to output to both Microsoft Excel and occurrence groups simultaneously.
• You want to output occurrence groups to both the source and target structures. For example, you
can get Missing in Source results that you cannot get with the rich client commands or with a
regular accountability check.
You can schedule an accountability check or structure propagation to run at a later date or time or at a
specific recurring time. This is helpful if you are comparing large structures where the action is time-
consuming or if you require comparison results on a regular basis. Teamcenter uses the Dispatcher
application to run the comparison and propagation at a time you specify.
To use this feature, your administrator must configure the asynchronous services.
Note:
Because asynchronous tasks run in a separate session, the current rich client session is not
updated to reflect any changes that are made. If you choose to execute the task immediately, you
do not see all of the results in the current session. Refreshing the window or reloading the
structure after the task is complete updates your session to see the changes made by the
asynchronous process. This is not an issue for sessions that start after asynchronous processing is
complete.
Running an accountability check of the product can take several hours. You can use the
acc_check_client utility to run the accountability check if you:
• Want to output occurrence groups to both the source and target structures. For example, you can get
Missing in Source results that you cannot get with the rich client commands or with a regular
accountability check.
You can run this utility offline, after hours, using the operating system scheduling to provide up-to-date
reports for Teamcenter users the following day. This utility logs onto Teamcenter, performs an
accountability check, stores the results in occurrence groups and/or an Excel report and logs off. You can
run this utility from a Teamcenter command window or from a batch file that is developed to perform a
specific check on two specific structures.
Running the acc_check_client utility creates the same output that is obtained by running the
accountability check in rich client. Teamcenter stores results in one or both of the following:
• Results are stored in occurrence groups that are created on the source and (optionally) the target
structures. These occurrence groups appear as tabs when the top item or revision is opened in
Manufacturing Process Planner. If structure contexts are used as input arguments, the occurrence
groups appear as tabs when the structure contexts are opened in Manufacturing Process Planner.
• Results are stored in an Excel report. The report appears in a dataset that is attached to the target
structure’s top line item revision. You can find the dataset by opening the structure, selecting the top
line, and viewing the Attachments tab. You can view the Excel content by opening the dataset.
Using the acc_check_client utility, you can run checks on a nightly basis and use them to update
existing occurrence groups and/or excel reports. To run checks in a two-tier environment:
c. For a two-tier environment: start the server on the specific port with ID.
d. Start the utility executable and specify that port and ID or a four-tier connection.
2. For nightly runs, schedule a job to run the script so that the results are updated nightly.
Note:
Selecting the Dynamic Equivalence check box automatically selects the Multiple Match
checkbox in the Display Options group on the Reporting tab of the Advanced Accountability
Check dialog box. When Dynamic Equivalence is deselected, check boxes in the Display Options
group return to their previous selections.
• Add a line in the transfer mode that skips the DIPA structures, for example:
CLASS.BOMLine:CLASS.AppGroupBOPLine:PROPERTY.bl_all_child_lines:SKIP:
SECONDARY.bl_line_object_class==”Mfg0MEDynamicIPA”
• If you want to compare the entire structure, create the in-context IDs using the bom_expand utility.
• If you want to compare only partial structures, when writing the PLM XML transfer mode for IDC
creation, include a line in the transfer mode that creates in-context IDs on the desired lines in the
structure. For example:
Similar to the acc_check_client utility that is intended for the service-oriented architecture (SOA) client,
the accountability_check utility allows you to run accountability checks on sandbox machines without
having to set up a four-tier infrastructure that requires you to maintain processes such as pool managers
on each machine. This capability lets you run many accountability checks simultaneously and to manage
the loads yourself. The utility also outputs occurrence groups to both the source and target structures,
while the rich client advanced accountability check can only output occurrence groups to the source.
activity (manufacturing)
Individual action to be performed within an operation. Each activity is associated with a start time and
duration. The total time for the operation is based on the cumulative duration of all activities within the
operation.
Activities can be sequenced using time data and predecessor activities.
appearances
Cache of configured BOM lines in the context of a specific top-line item. Appearances are created to
allow quick searches of the entire structure.
appearance set
Collection of objects that define the use of every part ever included in an end item. The appearance set
enables Teamcenter to rapidly search the product structure of a family of related configurations without
caching the entire product structure for each configuration. The appearance set is optional and typically
maintained for a few end items that represent large assemblies when fast searching is critical. The
system administrator defines the items requiring appearance sets.
assembly
Compound object that is assembled from other objects and may add additional information to their
interpretation.
• In the context of an assembly, other assemblies are called subassemblies, while noncompound
objects are called components.
• A single-level compound object that is distinct from a multilevel product structure or bill of materials,
which is a hierarchy of assemblies. Assembly data is stored in a BOM view revision.
assembly classification
Resource assembly ID and name of the class where the assembly is classified. An assembly classification
is also the process of associating an assembly with a class and entering the attribute values that
characterize it within its class.
assembly view
View of the product data. See also BOM and manufacturing view.
attribute
Named storage variable that describes an object and is stored with the object. Users can search the
database for objects using object attributes.
In an object, an attribute is a name/value pair. In the database, an attribute is a field.
attribute propagation
Process of transferring attribute values from one object to another. In Resource Manager, attribute
values are propagated from a propagation start point up the assembly structure to the assembly object.
For example, on a cutting tool, the cutting material of the insert, the cutting diameter of the extension,
and the holder type of the machine adapter can all be propagated to the assembly level. This provides a
mechanism to make all attributes required for a cutting tool definition available at the tool assembly
level.
B
base product view
The as designed bill of materials of the product. Contrast with manufacturing bill of materials.
BOM
Bill of materials.
• 100% BOM
The as sold product configuration, for example, the configuration of a car to be built and shipped to
the dealer.
• 120% BOM
Partial overlay of selected variant conditions. You cannot build the product from a 120% BOM.
• 150% BOM
Overlays of all possible variant configurations. You cannot build the product from a 150% BOM.
BPV
See base product view.
class folder
Representation of aggregation of objects. In the Classification and Classification Search dialog class
hierarchies, classes are displayed with class folder icons because they represent an aggregation of
objects.
class hierarchy
Structure defining subclasses that inherit the attributes of their superclasses, also called their parents or
ancestors.
classification
Process of categorizing objects according to similarity in characteristics. While the objects in one class
share the same characteristics, the values of these characteristics may differ. For example, drill bits all
share the length and diameter characteristics, but drill bit objects differ in length and diameter.
classification hierarchy
Structure used to categorize a company's data by common attributes.
classification instance
Lowest-level component of the classification hierarchy. Also referred to as an ICO (internal classification
object).
client tier
Teamcenter architectural tier that comprises the Teamcenter clients, Teamcenter integrations with third-
party applications, and the third-party applications associated with the integrations.
cloning rules
In a collaboration context, a set of rules that defines how structures are created when copying other
structures of the same type. A cloning rule can also be applied when creating a structure from a
template.
collaboration context
Teamcenter object that holds a collection of data contained in structure and configurator contexts. This
data allows you to capture multiple different Teamcenter structures in one container. You can open a
collaboration context in the Multi-Structure Manager application, in Manufacturing Process Planner, or
in Part Planner. You can also use a collaboration context to collect data to share with a third-party
application. See also structure context.
component
• Objects used to build up an assembly or subassembly.
• Part in a product structure defined in Teamcenter. A component is the lowest level part in the product
structure: it cannot be broken down into subparts.
composition
Special kind of structure context that allows components to be added from one or more structure
contexts, each of which may contain a different product structure. Compositions are used for design
studies and manufacturing processes that contain data from both product and plant structures.
consumed item
Item that is required during a manufacturing process or operation and must be ordered regularly to
meet the production quota. A consumed item can include parts or components from the product
structure in addition to materials such as oil, grease, and gloves.
Copy by Reference
Copy action rule when using templates to create process structures. The same database object is
referenced in the clone. The relation type is the same as in the template.
D
delivery unit
Subassembly that is manufactured separately and delivered to the assembly plant as a consumed part.
One of the operations in the assembly process uses the delivery unit as a consumed part. The
components of a delivery unit are not consumed in any of the operations.
E
effectivity rule
Rule used to set effective dates on released products and processes with a released status.
end item
Top-level node of an assembly that can represent a product or a factory structure.
enterprise tier
Teamcenter architectural tier that comprises a configurable pool of Teamcenter C++ server processes
and a server manager. Larger sites can distribute the pool of server processes across multiple hosts.
Smaller sites can run the pool of servers on the same host as the web tier.
equipment
Description of the equipment used to perform manufacturing operations.
F
feature
Physical or geometric object associated with a product, component, or part. Alternatively, a logical
attribute of a product, component, or part. Examples: a weld point, a signal, or a geometric pattern. A
feature may be represented by a generic design element (GDE) in a BOM. See also generic design
element.
folder
Graphical representation of an aggregation of objects, such as a group, class, or subclass. For easy
distinction in the class hierarchy, each of these aggregations has a different type of folder icon
associated with it: a group folder icon, a class folder icon, or a subclass folder icon.
four-tier architecture
Teamcenter architecture that includes four tiers: resource tier, client tier, web tier, and enterprise tier.
Contrast with two-tier architecture.
four-tier deployment
Deployment of the Teamcenter four-tier architecture. The web tier, enterprise tier, resource tier, and
client tier can each be hosted on the same or separate computers.
G
GDE
See generic design element.
group
Type of class that does not have a list of attributes associated with it; highest level in the classification
hierarchy.
group folder
In the classification hierarchy, group folders represent a group of related classes.
H
hierarchy
Structure in which each node can have only one parent but possibly multiple siblings and children.
I
ICM root folder
Root folder in the classification hierarchy. There is one root per database.
Ignore
Copy action rule when using templates to create process structures. No action is taken to duplicate the
object in the cloned structure.
in-process model
Product resulting from application of a manufacturing operation.
input data
In-process model and other data generated from the previous steps in an operation.
instance
Single data object that is associated to a class. The instance can correspond to a line in the BOM.
manufacturing process
Collection of manufacturing subprocesses, operations, and activities that make up a process plan.
Processes can have both sequential and parallel ordering. They are associated with a product and a work
area.
manufacturing view
Hierarchical structure of occurrence groups. The manufacturing view describes the components and
subassemblies used by the assembly operations.
The components of subassemblies in the manufacturing view represent references to lines in the
targeted product structure. These components can be consumed in operations if their parent assembly
is not consumed.
See also assembly view.
MBOM
See manufacturing bill of materials.
method
Description of how equipment is used to perform work on a feature. Each method can be used by
several manufacturing operations to perform work on different features.
Multi-Structure Manager
Teamcenter application that enables users to view and manipulate data in a specific context.
O
occurrence
Hierarchical structure relationship between the immediate parent assembly and its child component
item or item revision in a precise assembly. Sometimes called relative occurrence.
occurrence group
Collection of occurrences and absolute occurrences in the BOM. An occurrence group typically
represents an assembly.
occurrence path
Representation of the path from a top-level assembly to an occurrence of a component or subassembly.
An occurrence path is unique to the context of a specific BOM; different BOMs cannot contain the same
occurrence paths. The occurrence path does not change if the configuration of the BOM changes.
output data
Data generated as a result of applying instructions to input data. Output data can be the resulting in-
process model and any instructions for the next step.
P
Part Planner
Teamcenter manufacturing process management application that enables a user to design a plan
detailing how to manufacture a part.
plant
Manufacturing facility described by a hierarchical structure of work areas.
plant structure
Hierarchy of the physical layout of a work area. Different levels in the hierarchy represent the plant, a
work cell, and individual workstations. Compare with product structure and process structure.
process operation
Step in the manufacturing process executed at a specific work area. It is the lowest revisable element in
the manufacturing process structure.
process revision
Modified version of a process. A process revision can be used to handle different configurations of
assemblies, alternative methods for building the target item, or changes to methods.
process structure
Hierarchy of manufacturing processes and operations with a sequenced relationship that together
describe how a related product is manufactured. Compare with product structure.
product
Item or assembly (hierarchy of components and subassemblies) to be manufactured.
product appearance
Persistent representation of a product line. All appearances of a product are collected into a set that is
associated with one revision rule. This allows one set of appearances that can be configured by the
effectivity of the part they represent.
product view
Saved configuration of the assembly viewer, including the selection of objects, zoom factor, rotation
angle, and pan displacements.
propagation
Process of transferring characteristics of one object to another object.
PSP
See propagation start point.
R
raw material
Initial in-process model before any manufacturing operations are performed.
relative occurrence
See occurrence.
Report Generator
Teamcenter manufacturing process management application that provides a format for producing
reports about information in Teamcenter manufacturing process management.
resource
Item used to perform an operation or define a process. Examples of resources include robots, tools, and
machines. Both standard equipment and custom tools can be identified as resources.
resource assembly
Set of resource components and/or subassemblies that are grouped to create an assembly to be used in
a process, such as a manufacturing process.
Resource Browser
Plug-in component that allows users to retrieve classification-related data, such as a hierarchy with
corresponding groups, classes, and classification objects from a Teamcenter database when working in
an external application.
resource component
Object that is a component of a resource assembly or subassembly.
Resource Manager
Teamcenter manufacturing process management application that enables a user to store and retrieve
resource-related data such as tools, fixtures, machines, and process templates from a company-wide
accessible database.
resource structure
Structure in which resource assemblies are hierarchically built.
resource tier
Teamcenter architectural tier comprising the database server, database, file servers, and volumes.
root
Starting point of a hierarchy. Hierarchies are usually displayed as hanging trees with the root of the
structure at the top and the leaves at the bottom.
S
setup
In a manufacturing environment, configuration of the work area. The setup also identifies the parts
consumed and the resources used.
spare part
Small item that in Resource Manager is commonly entered as other components are. Examples include
nuts, bolts, washers, and screws.
structure
Representation of multiple objects and their interdependencies. For example, a classification structure
represents classes and their inheritance dependencies, and an assembly structure represents how
components and subassemblies are associated to build up an assembly. The structure can be viewed in
several applications, including Structure Manager, Manufacturing Process Planner, Part Planner, Multi-
Structure Manager, and Resource Manager.
In Resource Manager, most structures are hierarchical. For example, they acquire the form of a tree
where each node can have only one parent but multiple siblings and children.
structure context
BOM or assembly structure contained in a collaboration context. The structure context can contain
occurrence groups, items, and item revisions. See also collaboration context.
subassembly
Assembly that is built into the assembly structure of another assembly or intended for that use. In a
manufacturing view, either a delivery unit or a workpiece. See also delivery unit and workpiece.
T
Teamcenter Environment Manager (TEM)
Tool with a wizard-style interface that installs Teamcenter servers and two-tier and four-tier rich clients.
TEM also performs maintenance operations, such as upgrading servers and installing patches.
Teamcenter installers launch TEM using the tem.bat command (on Windows systems) or the tem.sh
command (on Linux systems).
TEM
See Teamcenter Environment Manager (TEM).
top level
Object at the root of a product structure where a process plan is being developed. The top level can be
either an end product being manufactured or a subassembly used in the end product (for example, an
engine for a tractor where the tractor is the end product).
two-tier architecture
Teamcenter architecture that includes a resource tier and a client tier. The resource tier comprises the
database server and database. The client tier comprises the Teamcenter rich client, third-party
applications that integrate with the rich client, and a local server. This architecture supports only the
Teamcenter rich client. Contrast with four-tier architecture.
V
variant condition
• Rules applicable to one component in a product structure.
• Condition set on an occurrence to specify the features required to configure that occurrence (for
example, Load IF engine = 1200).
view (Classification)
Tailored representation of attributes within a class. Views are associated with abstract and storage
classes. Attribute properties can also be applied. For example, a class may define the physical and
accounting attributes for its objects, but a view for tool designers may display only the physical
attributes, and a view for accountants may display only pricing and order number attributes.
W
web tier
Teamcenter architectural tier that comprises a Java application running in a Java Platform, Enterprise
Edition (Java EE) application server. The web tier is responsible for communication between the client
tier and enterprise tier.
work area
Plant location performing an operation. The work area can represent the entire plant, the work line, an
individual work cell, or a station within the plant. Work areas are described by their location on the shop
floor and the process capabilities they provide. Users can generate a hierarchy of work areas that is
unique to their organizations.
• Human readable instructions are primarily used to provide information to the operator about how to
perform the operation.
• Machine instructions are program files that include numerical code used to run numerically controlled
machines, such as robots and NC machines.
workpiece
Intermediate state of the product during the manufacturing process. In each step of the manufacturing
process, the workpiece is positioned in the work area and the work instructions are performed. The
resulting workpiece then flows to the next operation in the sequence, where the next operation is
performed.
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