Teamcenter must be restarted after modifying preferences.
View these preferences in
an .xls
file.
Customize the activate latest active shapes setting used during the Load process. This value is modified when the Activate Latest Active Shape option in the CATIAV5 menu is toggled on or off. The default value can also be set in Global Preferences but the value will always be updated in the User Preferences.
CATIA_activate_latestActiveShapes = 0
The default value for this setting is 1. Available values are 1 = true and 0 = false.
Use CATIA_load_bom_traversal_option to set the load level when loading a selected BOM line.
CATIA_load_bom_traversal_option = THROUGH
The default value is THROUGH.
| Value | Result |
|---|---|
| THROUGH (default) | Loads the complete selected sub-assembly, including the selected product and all children. All children components of all sub-assemblies are loaded recursively . |
| FIRST_LEVEL | Loads only the selected product and the first level of its children components. Children components of sub-assemblies are not loaded. |
| TO | Loads only the selected product and its parents. |
| Function | Availability |
|---|---|
| Load, inside the Structure Manager | Available for Load, Load for compare, Export, Load Update Save, Load for Consulting, Load as reference, Export as reference. |
| Load, launched from CATIA | Not available. Includes Load Merge Target, Load Merge Selected Level, Refresh or Read Linked Documents commands. |
| Silent Export processes | Available |
The following structure in CATIA is saved to Teamcenter.
A1
|__A2
|__P1
|__A3
|__P2
A1 is loaded in Teamcenter's Structure Manager and the A2 BOM Line is selected and Loaded in CATIA.
When CATIA_load_bom_traversal_option = THROUGH:A1, A2, P1, A3 and P2 are loaded.
When CATIA_load_bom_traversal_option = FIRST_LEVEL:A1, A2, P1, A3 are loaded and P2 displays a broken icon.
When CATIA_load_bom_traversal_option = TO: A1 and A2 are loaded, P1 and A3 display broken icons.
During the Load Merge Target, Load Merge Selected Level, Refresh and Read Linked Documents processes, CATIA_manage_configurations_on_load_from_CATIA determines whether to use the configuration used to load the assembly or the configuration of the opened BOM window. Variant and Effectivity are also managed during these Load processes, depending on the value of this preference.
The top level .dat file contains the opened BOM window configuration of the Contextual Product. During Load processes from CATIA, the configuration used to load the Contextual Product in CATIA can be applied to the assembly merged in the current CATIA session, depending of the value of this preference.
CATIA_manage_configurations_on_load_from_CATIA = YES
The default value is YES.
| Value | Result |
|---|---|
| YES | Use the configuration defined in the .dat file, if it exists. If it does not exist and Client_0 is running, use the opened BOM window and its corresponding configurations. Otherwise, create a new BOM window using default configurations. |
| YES_BLOCKER | When Client_0 is running, use the configuration defined in
the .dat file, if it exists. If it does not exist, use the opened
BOM window and its corresponding configurations. If the .dat file
and opened BOM window do not exist, stop the process.
When Client_0 is not running, use the configuration defined in the .dat file if it exists, otherwise create a new BOM window using default configurations. |
| NO | Create a new BOM window using default configurations. |
| NO_CONFIG | Create a new BOM window without any configurations. |
| TC_CONFIG | Use the opened BOM window and its corresponding configurations. If the opened BOM window and its corresponding configurations do not exist, use the configuration defined in the .dat file, if it exists. Otherwise, create a new BOM window with default configurations. |
Continue or stop the load process when the BOM window has been modified but not saved.
This preference concerns all processes related to the BOM window in the PSE; Load, Load Merge Target, Load Merge Selected Level, Refresh, Read Linked Document, Create Export Spreadsheet, Create JT, and Load, Update, Save.
CATIA_stop_load_if_modified_bom = NONE
The default value is NONE
| Value | Result |
|---|---|
| NONE (default) | The BOM window automatically saves at the beginning of the process. |
| ERROR | An error message displays, the BOM window is not saved and the process is cancelled. |
| WARNING | Display a warning message. When Yes is selected, the BOM window is saved. When No is selected, the process stops. |
The CATIA_refresh_bom_window_on_load preference was depreciated in 11.0.1.
Display a dialog message prompting to refresh the BOM window during Load processes. A message does not display and the BOM window does not refresh automatically, by default.
This preference affects the Load, Load Merge Target, Load Merge Selected Level, Refresh, Read Linked Documents, Create Export Spreadsheet, Create JT, and Load, Update, Save processes related to the BOM window in the PSE.
CATIA_refresh_bom_window_on_load_2 = NO
The default value is NO.
| Value | Result |
|---|---|
| NO (default) | The BOM window is not automatically refreshed. |
| YES | The BOM window is automatically refreshed. |
| WARNING | Display a warning message. When Yes is selected from the warning message, the BOM window is refreshed. When No is selected, the BOM window is not refreshed. During Silent processes, a warning message does not display and the BOM Window is automatically refreshed. |
Specify the message displayed when an UUID conflict occurs during the load process by setting the value of the CATIA_check_catia_uuid.
CATIA_check_catia_uuid = value
The default value is NONE.
This preference also affects the Save and Import/Import Spreadsheet processes.
| Value of CATIA_check_catia_uuid | Result |
|---|---|
| ERROR | An error message displays and the load process stops. |
| WARNING | A warning message displays. The load process may be continued or cancelled. |
| NONE or not defined | The load process continues and the structure is updated. |
Customize the export only active and default shapes setting used during the Load process. This value is modified when the Export Only Active Shapes option in the CATIA V5 menu is toggled on or off. This setting is ignored when Activate Latest Active Shapes option is toggled off. The default value can also be set in Global Preferences (Site or Group Preferences) but the value will always be updated in the User Preferences.
CATIA_export_only_active_shapes = 0
The default value for this setting is 0.
| Export Only Active Shapes option in the CATIA V5 menu | Value of CATIA_export_only_active_shapes |
|---|---|
off
|
0
|
on
|
1
|
Use CATIA_stop_load_if_filename_conflict to manage file name conflicts during the Load process. By default, the load process stops when a file name conflict occurs. Change this preference to false to permit the load process to continue as a partial load when a file name conflict occurs. In this case, documents with file name conflicts will be excluded from the load process.
When a file name conflict is detected and one of the conflicting instances is not to be loaded, CATIA_stop_load_if_filename_conflict is not taken into account. In this case, a warning message displays and the load process continues.
CATIA_stop_load_if_filename_conflict = true
The default value is true.
| Value | Result |
|---|---|
| true (default) | When two conflicting instances with file name conflicts are to be loaded, an error message displays and the Load process stops. |
| false | When two conflicting instances with file name conflicts are to be loaded, an error message displays and the Load process can be continued. When continued, the conflicting BOM Lines are excluded and the load process continues as a partial load. |
CATIA_stop_load_if_filename_conflict = true
TC_bom_precision_preference = precise
CATIA_stop_load_if_filename_conflict = false
TC_bom_precision_preference = precise
Determine which type of document (Part or Product) will be loaded in CATIA when an item or an item revision is selected, by modifying CATIA_customize_load_process.
CATIA_customize_load_process = 0
The default value is 0. The default value corresponds to previous behavior which analyzed the type of BOM View in your Item.
For each case defined in the cat_USER_hasChildren ITK Function, use the criterion referenced by a number read in this option.
The value of this preference also affects creating datasets for CATParts and CATProducts.
Use CATIA_cache_validate_dataset_for_load to ensure that cache files having a last modification date older than the part file are exported and to improve TcIC Load performance. This preference is read by the cat_USER_validateCacheDatasetForLoad entry point.
Set this preference to true to validate cache.
When the date of the CGR is older than the part, TcIC considers the CGR to be outdated and does not deliver it to CATIA cache.
When the date of the CGR is newer or equal to the part, TcIC considers the CGR to be up-to-date and delivers it to CATIA cache.
When false (default), cache is always valid.
CATIA_cache_validate_dataset_for_load = false
The default value is false.
Use the Load as cgr preference to enable the Load as cgr and Replace Load as cgr processes for dummy parts (false) or cache component (true. By default, Load as cgr is enabled for dummy parts.
Refer to the table comparing the advantages of cache components and dummy parts.
CATIA_manage_load_as_cgr_with_components = false
The default value is false.
When false, TcIC loads a dummy part instead of CATPart geometry in CATIA. A dummy part is a cgr exported to the client machine in place of the CATPart document; its file size is 0 KB.
When true, TcIC loads cache components instead of real CATParts in CATIA. A cache component is a component with a cgr attached as a shape representation. This component replaces the CATPart geometry in the structure.
Use CATIA_load_as_cgr to automatically toggle the Load as cgr Load option on/off from the RAC. Set the value to true to automatically toggle this option; set it to false (default) so that this option is not automatically toggled.
When the Load as cgr option is selected, the Activate Latest Active Shapes option is not available.
CATIA_load_as_cgr = false
The default value is false.
Avoid part number conflicts during the Load for Compare process by setting CATIA_rename_partnumber_during_lfc to true so that part numbers will be renamed according to the value of CATIA_load_for_compare_prefix.
CATIA_rename_partnumber_during_lfc = false
The default value is false; conflicting part numbers will not be renamed.
Designer1 creates an assembly, A1(P1), and saves it to Teamcenter.
Designer2 revises P1 and creates Revision B
| Task | Value of CATIA_rename_partnumber_during_lfc | Result |
|---|---|---|
| Designer1: Compare P1/A and P1/B in the context
of the A1 assembly by:
-- performing a Load for Compare of P1/B -- inserting P1/B under A1 to compare within a single context |
true |
Part Number conflict does not occur, insert is permitted.
The Part Number is renamed according to CATIA_load_for_compare_prefix value. The assembly which was loaded for compare and the assembly which was loaded using the regular load process are merged into a single window. |
false (default) |
Part Number conflict occurs, insert is not permitted because P1/A and P1/B have the same part number. |
When loading an assembly for compare in CATIA, all files are renamed to avoid opening the same file names with different part numbers. Define the prefix added to the new file name by modifying CATIA_load_for_compare_prefix.
CATIA_load_for_compare_prefix = COMP_
The default prefix value is COMP_.
Conflicts occur when CATIA_reference_prefix and CATIA_load_for_compare_prefix contain the same value.
Change CATIA_use_load_for_structure to true to display a message to allow loading of products only when attempting to load a full assembly.
CATIA_use_load_for_structure = true
The default value is false.
This setting should be used if your management is CAD centric in order to avoid data corruption when saving back to Teamcenter after loading assembly products only.
Use CATIA_automatic_load_merge to control whether the Load Merge process runs automatically, without having to start merge from the CATIA toolbar. Possible values are Yes (default), No and Question.
When set to Yes (default), the Load Merge process runs automatically when the top level is already opened. An error message displays when the Load Merge cannot be performed.
When set to No, an error message displays when the top level is already open. In this case, merge must be started from the CATIA toolbar.
When set to Question, a prompt displays when the top level is already opened, asking to perform a Load Merge automatically. An error message displays when the Load Merge cannot be performed.
CATIA_automatic_load_merge = Yes
The default value is Yes.
Change CATIA_load_unconfigured_displayed_bomlines to true to load all parts and products with Variant and Effectivity Conditions, when used in conjunction with the following menu options:
All parts and products containing Effectivity Conditions are loaded when the Show Unconfigured by Occurrence Effectivity menu option is activated. Parts/products that do not contain Effectivity conditions will not be loaded and display a broken icon.
All parts and products containing Variant Conditions are loaded when the Show Unconfigured Variants menu option is activated. Parts/products that do not contain Variant Conditions will not be loaded and display a broken icon.
When CATIA_load_unconfigured_displayed_bomlines is set to false (default), parts and products containing Variant and Effectivity Conditions are never loaded and display a broken icon.
CATIA_load_unconfigured_displayed_bomlines = true
The default value is false.
Refer to the Load with Variant Conditions section for a specific example.
Customize the Occurrences Note type used for Teamcenter Occurrences by setting the following variables within Teamcenter Preferences.
The note that must contain the CATIA occurrence name (instance name):
CATIA_occurrence_note = newOccurrenceNoteName
The default value is catiaOccurrenceName.
The note that must contain the parent component name path between the current occurrence and the parent product:
CATIA_parent_component_note = newParentComponentName
The default value is catiaParentPartName.
The note that must contain the CATIA file name (necessary to replace component in an assembly):
CATIA_filename_note = newCatiaFileName
The default value is catiaFileName.
The note that must contain the occurrence name of the imported instance (necessary for import / export process):
CATIA_occurrence_oem_note = newCatiaFileName
The default value is catiaOccurrenceOEM.
The note that must contain the occurrence description of the imported instance (necessary for import / export process):
CATIA_occurrence_desc_note = newCatiaFileName
The default value is catiaOccurrenceDesc.
The note that must contain the CATIA Internal Identifier (UUID) of the document:
CATIA_uuid_note = newcatiaUUID
The default value is catiaUUID.
Use CATIA_check_packed_lines to define how packed lines or lines with parent packed lines are managed when loading from PSE. Available values are WARNING (default), NONE, and ERROR.
| Value of CATIA_check_packed_lines | Result |
|---|---|
| WARNING (default) |
Display a warning message when the selected line is packed or when one of the parent lines of the selected line is packed. The warning message prompts to continue or to cancel the load process. If Yes is selected (continue the process), only the visible line in the PSE will load. |
| NONE | Do not display a warning message when the selected line is packed or when one of the parent lines of the selected line is packed. The process will continue without a warning message and only the visible line in the PSE will load. |
| ERROR | Display an error message when the selected line is packed or when one of the parent lines of the selected line is packed. The process is cancelled. |
CATIA_check_packed_lines = WARNING
The default value is WARNING.
When the item revision of a part features several BOM View Revisions and an occurrence of it is created within an assembly, the native behavior of Teamcenter is to use the first BOM View Revision type found.
To define a specific list of BOM View Types used in Teamcenter (for leaf node Parts only), create a new variable within CATIA_PSE_alternate_preferred_bv in Teamcenter Preferences.
Multiple values are permitted.
The first type listed becomes the most preferred one. A blank line marks the end of the list. The list is sorted in order of preference, i.e., the first type displayed in the list is the most preferred one.
CATIA_PSE_alternate_preferred_bv =
newView1
newView2
newView3
When CATIA_PSE_alternate_preferred_bv is not defined, Teamcenter uses the first BOM View Revision type found.
Use CATIA_refresh_teamcenter_on_load to force the refresh of the Teamcenter desktop and to maintain integrity of the Teamcenter Portal display.
This issue also appears with deactivated hardware acceleration. It is recommended to turn this setting off to enhance the performance such as when a large assembly is opened in PSE.
CATIA_refresh_teamcenter_on_load = true
The default value is false.
Updating reference properties improves load performance by preventing properties of released or non-modifiable documents from being updated.
Previously, each time an attribute mapping changed either on already released documents or non-modifiable documents, the document's status during load was changed to modified. Use the CATIA_deactivate_update_reference_properties preference to prevent this. This preference can also be used to ensure migrated data is not modified during the load process and improve performance during load processes and, indirectly, during save processes.
This preference is not taken into account during load processes when updating the properties of an instance document; it only applies to reference properties. This preference is also not taken into account during the Load as reference, Export as reference, Export and Load for Compare processes.
| Value | Behavior |
|---|---|
| -empty- (default) | The default value is empty, indicating reference properties are updated for all documents and shape representations. |
| NONE | Update reference properties and shape representations all documents. |
| READ_ONLY | Require write access to update reference properties and shape
representations for documents. Note: READ_ONLY is different from CI. Reference properties are updated when a CI document is writable. |
| STATUS | Do not update reference properties and shape representations when the documents have a status. |
| STATUS:xxx | Do not update reference properties and shape representations when the documents have a specific status. |
CATIA_deactivate_update_reference_properties =
The default value is empty, indicating reference properties are updated for all documents and shape representations.
In Teamcenter, set the following preferences:
| Preference | Value |
|---|---|
| CATIA_deactivate_update_reference_properties | STATUS:TC Baselined |
| CATIA_MAP_Property_PartNumber | Item.item_id ItemRevision.item_revision_id ItemRevision.object_name |
| CATIA_MAP_Property_Nomenclature | Dataset.object_desc |
| CATPART_item_type | Item_NR |
| CATPRODUCT_item_type | Item_NR |
Modify the attribute mappings file by adding the following lines for the related dataset/item type:
{ Dataset type="CATProduct"
{ Item type="Item_NR"
"description"
: ItemRevision.object_desc /description="Mapping Test"
"revision" :
ItemRevision.item_revision_id /description="Mapping Test"
"definition"
: ItemRevision.object_name /description="Mapping Test"
}
}
{ Dataset type="CATPart"
{ Item type="Item_NR"
"description" : ItemRevision.object_desc /description="Mapping
Test"
"revision" :
ItemRevision.item_revision_id /description="Mapping Test"
"definition"
: ItemRevision.object_name /description="Mapping Test"
}
In CATIA, create
the following assembly:
A1
|_P1
|_P2
Save it in Teamcenter with Check-in After Save toggled on.
Close all and Purge catuii.
In Teamcenter, apply the TCM Release Process on P1, then apply the TC Default Baseline Process on P2.
Load A1 from Teamcenter in CATIA.
Result
P1: The partnumber and the CATIA properties are updated for P1 only:
Definition = <ItemRevision.object_name>
Nomenclature = <Dataset.object_desc>
Description = <ItemRevision.object_desc>
Revision = <ItemRevision.item_revision_id>
P2: The CATIA properties are not updated (empty) because its status in Teamcenter matches with the CATIA_deactivate_update_reference_properties preference.
When CATIA_save_shapes_under_released_cad_element preference is set to true, shape representations are managed into CATIA during the load process, whatever the value of the preference CATIA_deactivate_update_reference_properties is.
When CATIA_save_shapes_under_released_cad_element preference is set to false, shape representations are not managed into CATIA during the load process.
Updating structures in CATIA is not managed for components responding to criteria defined by CATIA_deactivate_update_structure. Set this preference to NONE to update all document structures, set it to CATALOG_COMP so that structures for documents referenced in a Catalog are not updated.
CATIA_deactivate_update_structure = CATALOG_COMP
The default value is empty, indicating structures are updated for all documents.
Use CATIA_display_warnings_at_end_of_process to control when warning messages relating to load processes display; either during (empty, default) or at the end of the load process to avoid user interaction (SECRET).
CATIA_display_warnings_at_end_of_process = SECRET
Setting the value to SECRET displays the list of warning messages related to a secret part at the end of the load process instead of displaying during the load process.
The default value is empty; warning messages are displayed during the load process.