Frequently Used Preferences in the wgmclient.ini File (CATIA V5)

Integration with Other Applications > Windchill Workgroup Manager Documentation > CATIA V5 > Administrator > Preferences for CATIA V5 > Frequently Used Preferences in the wgmclient.ini File (CATIA V5)

This topic lists the most frequently used Windchill Workgroup Manager preferences for CATIA V5 that you manage using the wgmclient.ini file.

This topic does not list every client preference that can be set for CATIA V5. For a complete list of client preferences, refer to the wgmclient.ini file located in your Windchill Workgroup Manager home directory.

If the preference is not listed under the [CATIA V5] section, scroll to the beginning of the wgmclient.ini file and search for the preference name.

After saving the file locally, restart Windchill Workgroup Manager to make modified preferences available.

For more information, see Managing Windchill Workgroup Manager Preferences.

Name

Description

All Values

expose.model.annotations

Controls whether to expose model annotations to Windchill for downstream process upon Save to Workspace or Check In. This preference is applicable only to CATIA V5 and NX.

• All — Expose all model annotations to Windchill.

• Designated — Expose only annotations marked as consumable for manufacturing.

• None (default) — Does not expose model annotations.

checkin.content.options

Specifies how the model is saved on the authoring application menu, Auto Check In and provides default interface setting for Custom Check In.

• Models (default)

• Models and Viewables

save_to_ws.content.options

Provides the default interface setting for the content option in the Tools menu of the Save To Workspace window.

• Models Only (default)

CATIA V5 does not support creation of client-side viewables; therefore viewables cannot be created.

save_to_ws.upload

Provides the default interface setting for the Upload option in the Tools menu of the Save To Workspace window.

• Yes (default)

• No

import.to.workspace.upload

Specifies if the model is uploaded after an Import action.

• No (default)

• Yes

UndoCheckout.overwrite.local.content

Specifies if the model content is overwritten in the cache when using Undo Checkout.

• No (default)

• Yes

overwrite.contents.on.update

Specifies if the model content is overwritten in the cache when using Update from a Windchill Workgroup Manager.

• No (default)

• Yes

wgm.autoattach

Allows configuring the content that is uploaded as additional content of a model.

The format of this preference is: *.CATPart,*. <attachment file extension 1>,<attachment type 1>;… …;<attachment file extension n>,<attachment type n>

The default preference value is blank.

A file type other than those listed can be specified as auto attachment by user.

open.modifies.checkedout.objects

Determines whether checked out models appear as modified in session after system parameters have been updated.

• Yes (default)

• No

unmanaged.read.only.area.folders

Windchill Workgroup Manager ignores files retrieved from specified file system paths assuming there is no need to manage these in Windchill.

Include a semi-colon separated list of folder paths that constitute the ROAs.

catiav5.template.part.nr

Upon retrieval in CATIA V5, if the part number is still set to the default value and the part number is not mapped to any other Windchill attribute, then it will be set to be the same as the model's file name (without extension).

Set the value of this preference with the string used for part number in Windchill templates.

update.drawing.alwaysShowDialog

Determines whether to prompt the user with a window to update the drawing upon save to workspace or checkin.

• Yes (default)

• No

force.update.metadata.on.open

Controls whether to propagate metadata (global attributes (IBAs) and system attributes) when a model is opened and allows delay of this propagation to obtain better performance.

For details about using force.update.metadata.on.open and other preferences to improve performance, see Delaying Metadata Updates of Attributes.

This preference is applicable to CATParts only.

• Yes (default)—CATIA V5 CATParts: Global attributes are updated for documents when they are opened in any mode, including visualization mode. System attributes are updated according to the value of update.metadata.on.load.

• No—CATIA V5 CATParts: Metadata is updated according to the value of update.metadata.on.load.

• Legacy—CATIA V5 CATParts: For legacy data, global attributes are updated according to the value of update.metadata.on.load. This preference is applied only to documents that do not have a neutral data XML file (models upgraded from a release prior to Windchill 9.0).

update.metadata.on.load

Controls when to update metadata (global attributes (IBAs) and system attributes) for CATIA V5 CATPart documents opened within CATIA V5, which can enhance performance.

For more information, see Delaying Metadata Updates of Attributes.

For best performance, set update.metadata.on.load and force.update.metadata.on.open to No.

If force.update.metadata.on.open=Yes, global attributes are updated for documents that are loadedin visualization mode, regardless of the value of update.metadata.on.load (when global attributes update happens, system attributes are also updated). When a drawing is loaded, metadata is updated for any CATIA V5 document that the drawing references with an attribute link, regardless of the value of update.metadata.on.load.

• Yes (default)—Metadata is updated for a CATIA V5 CATPart document when it is loaded in product mode, Brep mode, or design mode. It is not updated when a CATIA V5 CATPart is loaded in visualization mode.

• No—Metadata is not updated until a CATIA V5 CATPart document is loaded in design mode.

If update.metadata.on.load=No, out-of-date metadata values are displayed in CATIA V5 for any CATIA V5 CATPart document that is not loaded in design mode.

update.metadata.on.save

Controls whether metadata is updated during save actions, such as Save to Workspace, Check In, and Import to Workspace.

• Yes (default)—Metadata is updated during save actions.

• No—Metadata is not updated during save actions. The update is delayed until the next open action.

enable.readonly.in.session

Controls whether to enable the "Read Only in Session" feature.

• No (default)

• Yes

allow.missing.design.table

When a design table is missing, this preference controls whether to allow continuing the operations of Save to workspace or checkin by prompting a window.

• No (default)

• Yes

enable.environment.management

Specifies which string to control in enabling and managing environment information.

• No (default)

• Yes

environment.management.parameter

The value of the string defines the name of the environment global attribute.

• PTC_WM_ENVMGMT (default)

• None — disables managing environment information

enable.replace.in.cad.session.on.refresh

Controls whether to enable the feature of Replace in CAD Session on Refresh.

This preference is only applicable when an assembly-level CGR that is out of date is loaded in session which is out-of-date.

• Yes

• No

generic.is.read.only=

Sets the Generic Part/Assembly as Read Only in Session

• No (default)

• Yes

allinonecatpart.name

Specifies the naming rule of the All-in-One CATPart.

_AllCATPart

allinonecatpart.creation.merge.all.bodies

Controls merging of all bodies when generating a part from a product.

• No (default)

• Yes

identify.standard.part

Specifies the pair of strings to control exposing the standard part information. If yes, the values of the string which reflect the customer convention to define the standard part are used to search the standard part in the specification tree.

• The format is pairs of string separated by semicolon, filename of CAD model,name of geometrical set; filename of CAD model,name of geometrical set

• Blank - design information of the standard part will not be exposed

expose.parameters.under.geometrical.set.from.specification.tree

Controls whether to expose the parameters under a specific geometrical set from a specification tree by specifying the name of the geometrical set under which all the parameters need to be exposed.

• Blank

• Names

• All

expose.annotation.text.notes.from.specification.tree

Controls whether to expose parameters under an annotation set from a specification tree upon Save to Workspace or Checkin.

• No (default)

• Yes

expose.measure.inertia.property

Controls exposing measure inertia property upon Save to Workspace or Checkin.

• Blank (default)

• PartBody

store.formula.value.for.parameters

Stores the formula value instead of the display value for parameters that use formulas.

• No (default)

• Yes

expose.manufacturing.information

Controls exposing manufacturing information as secondary content (XML file) in Windchill upon Save to Workspace or Checkin related manufacturing data, such as CATIA V5 CATProcess.

• No (default)

• Yes

ignore.missing.dependents

Determines if missing dependencies are ignored, or if ghost parts are created for them upon Import to Workspace or Save to Workspace or Check In.

• No (default)

• Yes

managed.read.only.area.folders

The Read Only Areas (ROA) preference tells Windchill Workgroup Manager to treat any parts or referenced assemblies retrieved from specified file system paths as objects that already exist in Windchill.

This preference takes a semi-colon separated list of directory paths that constitute the ROAs.

enable.pdm.status.icons

Displays PDM status icons in a structure tree.

• Yes (default)

• No

enable.localPreview.on.save.catalog

Controls whether to enable the feature of forcing the use of "Local Preview" when save to workspace or check in catalog data.

• No (default)

• Yes

import.to.workspace.structure.only

Controls whether to import structure members only during import to workspace.

• No (default)

• Yes

wwgm.download.method.upon.open

Controls how contents are downloaded for CATIA V5 documents during operations such as Add to Workspace and Open in CATIA from the commonspace.

• Full (default)

• CGR

• Async

For details about this preference and its values, see Improving Performance when a Large Assembly Is Downloaded from the Commonspace.

open.assembly.cgrs

Enables opening Assembly-Level CGR assemblies in Assembly-Level CGR mode.

• No (default)

• Yes

cache.size

Specifies a limit for the client's internal cache.

• 0 (default)

• Set value in MB. For example, 800.

Date.Type.Parameter.Format

Determines the format to display the date and time whenever a CAD document is created or last modified.

• %dd-%Mmm-%yy (default)- For example, 11-Jul-18

• The following formats are used to compose the date type string:

◦ %yyyy 4-digit year (for example, 2015)

◦ %yy 2-digit year (for example, 15)

◦ %MMM Month (for example, SEP)

◦ %Mmm Month (for example, Sep)

◦ %Month Full month name (for example, September)

◦ %mm Month number, padded to 2 digits (for example, 09)

◦ %m Month number (for example, 9)

◦ %dd Date, padded to 2 digits (for example, 05)

◦ %d Date, no padding (for example, 5)

◦ %Hh Hour number (for example, 04)

◦ %mi Minute number (for example, 10)

◦ %ss Second number (for example, 59)

◦ %PM Adds anti meridian (AM) /post meridian (PM) designation (for example, PM)

upload.autoattach.searchpath

Specifies paths on disk, separated by a semicolon (;), Searches for attachments that need to be automatically added to a CAD/Dynamic Document upon upload.

User may use environment variables in search path specifying the environment variable as ${environment variable name).

message.slider.timeout

Controls the duration that a pop-up message window stays on a screen.

Enter a numeric value in seconds.

• 10 (default)

• 0 (disables slider window)

add.active.ws.to.dlnames

Determines if the Active Workspace should be added to the CATIA V5 list of DLNames.

• Yes (default)

• No

ascii.only.chars.in.workspace.name

Restricts ASCII characters in workspace name. This preference turns on Windchill Workgroup Manager mapping of Unicode workspace name to an ASCII one on the Workspace Local Directory.

• No (default)

• Yes

open.appVersionSelection.alwaysShowDialog

Determines whether a window to choose an application version is always shown on openInSession.

• No (default)

• Yes

wwgm.remember.last.used.server

Controls whether to reconnect to the last used server upon a subsequent Windchill Workgroup Manager client launch.

• Yes (default)

• No

windows.browser.type

Sets the Windchill Workgroup Manager embedded browser type.

chromium_browser (default)

expose.mass.properties.only.main.body

Controls whether to enable or disable the option of only the main body when exposing mass properties upon save to workspace or check-in of the product or part.

• No (default)

• Yes

network.request.size

Determines the maximum size, in bytes, of an HTTP upload request when uploading content files to Windchill.

• 8000000 (default)

• Integer Value equal to or greater than 0

wf.network.threads

Controls the number of network threads to be used upload and download content.

• 6 (default)

• Integer Value equal to or greater than 0

wwgm.open.dialog.remember.last.location

Controls whether to retain the last selected Folder in an Open Dialog upon open operations, such as Open from Windchill, Insert from Windchill, and Replace (from the information page).

• Yes (default)

• No

java.script.errors

Controls the display and execution of the java script error windows. If the window is presented, the user can choose whether to stop or continue running the script.

• Show (default)

• Hide and run

• Hide and stop

enable.auto.numbering.on.new.document.in.CATIA.session

Controls whether the Windchill-generated number is used as the file name and part number for new documents created in CATIA V5.

• Yes (default)—For new documents created in CATIA V5, the Windchill-generated number is used as the file name and part number.

• No—For new documents created in CATIA V5, the file name and part number are assigned according to the default CATIA V5 behavior.

store.deactivated.component.as.suppressed

Controls whether deactivated components are stored as suppressed in Windchill when saved to workspace, imported to the workspace, or checked in.

• Yes (default)—Stores the deactivated components as suppressed in Windchill.

• No—Stores the deactivated components as regular child members. The components are not stored as suppressed in Windchill.

enable.preselection.file.selection.dialog

Controls whether an object is selected by default in the file selection window for open actions for all Windchill Workgroup Manager clients. This includes actions such as Import to Workspace, Open from Windchill, and Insert from Windchill.

• Yes (default)—The first valid file is selected by default.

• No—No file is preselected.

add.to.workspace.replace.iteration.option

Controls whether the Add to Workspace action replaces local workspace iterations with different iterations selected in the commonspace.

• Conflict (default)—The action fails with an overridable conflict.

• Replace—The local workspace iterations are automatically replaced with selected ones from the server.

confirmation.dialog.display.file.rename.or.delete

Controls whether a confirmation window appears when a file is opened in the CAD tool if it has been renamed or deleted in the local workspace.

• Yes (default)—The confirmation window appears.

• No—The confirmation window does not appear.

open.replace.in.session.dialog.suppress

Controls whether the Replace in Session conflict window is suppressed during an open action if the model is already loaded in a CAD session. If this window is suppressed, the model in the CAD session is automatically replaced, even if it has been modified in session.

This preference affects the Open in [CAD tool] action from Windchill, the Add to Workspace action from Windchill with the Open option, and the Open from Windchill action from your CAD application.

• No (default)—The Replace in Session window appears.

• Yes—The Replace in Session window is suppressed.

allow.import.when.models.in.session

This preference controls whether to allow an import operation to be initiated when models are open in a CAD session.

• No (default)—Prevents the import operation from continuing unless the user closes all models that are open in a CAD session. A window with options to close all open models or cancel the operation is displayed.

• Yes—Allows the import operation to continue if no linked models are open in a CAD session. Otherwise, the import operation is terminated and a notification window is displayed.

save.to.workspace.dialog.suppress

Controls whether to suppress the Save to Workspace window for both new and existing CAD documents for the Save to Workspace, Auto Check In, and Custom Check In actions.

• No (default)—The Save to Workspace window appears.

• Yes, the Save to Workspace window is suppressed.

update.instance.name

Specifies whether to update the instance name with the part number when the part number is changed.

Regardless of this preference setting, a serial number is automatically added according to the native CATIA V5 rule. If the file extension is part of part number, it will be included as part of the instance name.

For a document that was renamed or saved using the Save As action, the instance name is updated when the referencing document is opened in CATIA V5. The parent assembly of the renamed instances will be modified. Therefore, you must check the assembly back into Windchill to save the instance name update.

• No (default)—The instance name is not updated.

• Yes—The instance name is updated if it is different from the part number.

lock.raster.drawing.views.on.publish

Controls whether to lock raster drawing views during publication by the Theorem file synchronization worker. This preference is only applicable when the Theorem worker is used.

• No (default)—Raster views are not locked, and raster views are updated when the representation is generated. If a raster view cannot be rendered successfully, the resulting representation cannot display the raster view.

• Yes—Raster views are locked and not updated. The previous raster views are shown in the new representation.

update.drawing.views.on.publish

Controls whether to download and load all associated 3D Models and update drawing views during publication of a drawing by a file synchronization worker.

• Yes (default) - Downloads and loads all associated 3D Models with their required dependencies and also updates drawing views during publication of a drawing, by a file synchronization worker.

• No- Prevents download of all associated 3D Models and also does not update the drawing views during publication of a drawing, by a file synchronization worker. The drawing views are published as displayed when checked in from CAD. Meta data update of a drawing is propagated during publication.

When this preference is set to ‘No’, the dependencies of CATDrawing are not downloaded during the drawing publication in File Sync enabled CATIA V5 worker. As a result, the attribute values in the drawing are controlled by external attribute links, for example, attributes of the CATPart or CATProduct associated with the CATDrawing are not updated during CATDrawing publication. It means attribute values (both Windchill system parameters and IBAs) of the associated drawing model in the drawing title block may not be updated. Hence, such attribute values may be outdated in the Creo View representation.

conflict.dialog.display.update

Controls whether a conflict window appears when new, Windchill-authored structure changes are detected during an update that affects assemblies that are currently open in the CAD tool. If the conflict window is disabled, the models that are open in the CAD session are automatically updated even they have already been modified.

This preference only affects design contexts and assemblies with annotated structure links. It does not affect whether the conflict window appears when attribute or content changes occur.

This preference affects the following actions:

• Update and Open in CATIA V5 in a configuration context from Windchill

• Save Definition for a design context from Windchill

• Synchronize and Refresh from the local workspace

• Update action from CATIA V5

• No (default)—The conflict window is disabled and does not appear.

• Yes—The conflict window appears. The user can chose to update (default) or not update all affected models.

set.missing.instance.name

Specifies how to set the missing instance name upon save to workspace. A serial number is automatically added as according to the native CATIA V5 rule.

• File Name (default)—The missing instance name is set to the file name.

• Part Number—The missing instance name is set to the part number.

• Initial Name—The missing instance name is set to the name given to the instance at creation.

manage.system.attributes

Controls whether to manage system attributes (such as PTC_WN_NUMBER) when a file is saved to or opened from Windchill. Affected PDM actions include Save to Workspace, Check In, Open from Windchill, Insert from Windchill, and Replace Component from Windchill.

• All (default)—Manage all system attributes.

• None—Do not manage any system attributes.

• [attribute list]—Manage only the user-defined system attributes that are listed. For multiple attributes, use the following comma-separated format:

Attribute1,Attribute2,Attribute3

home.page.url

Specifies the home page of the Windchill Workgroup Manager embedded browser.

The default value is http://www.ptc.com/products/windchill.

hide_default_workspaces.in_server_ management

Controls whether to display virtual workspaces.

For more information, see Displaying or Hiding Virtual Workspaces in the Server Management Utility.

• No (default)—Default workspaces are listed for each context that has no workspace defined.

• Yes—When there is at least one workspace created in any context in selected server, default workspaces that were never used are not listed.

autoupdate.model.upon.filesync.publishing

Controls whether to automatically update the CATIA V5 parts and assemblies upon publishing in file synchronization mode.

• Yes (default) - Automatically updates during file synchronization for part and assembly.

• No - Automatic update is disabled during file synchronization.

Note: Ensure that you set the following native CATIA settings to manual:

• Part Infrastructure: Tools >> Options >> Infrastructure >>Part Infrastructure >> Update >> Manual

• Assembly Design: Tools >> Options >> Mechanical Design >> Assembly Design >>Update >> Manual

enable.revise.and.checkout

Controls the visibility of Revise and Check Out action for all locations in CAD applications like Check Out window, Conflicts window, PDM actions menu, and actions available in the Windchill Workgroup Manager.

• Yes (default) — Enables Revise and Check Out action for all locations in CAD applications.

• No — Hides the Revise and Check Out action for all locations in CAD applications.

allow.instance.to.standalone

Controls whether an instance removed from a family table in CAD session is saved as a standalone part.

• No (default) — Removed instances are excluded from the Windchill family table and are not iterated further.

• Yes - Allows removed instances to be standalone.

preserve.drawing.up.to.date.status.on.save

Preserves the drawing's up-to-date status during save actions. This status can be changed when the drawing's projected product or part document properties are updated while populating system parameters.

• Yes (default) — Checks the drawing's up-to-date status and performs an update before save action. If the drawing is up-to-date before the save action, it will remain up-to-date after the save operation is completed.

• No — Automatic update will not occur when saving a drawing.

Was this helpful?