Frequently Used Preferences in the wgmclient.ini File (NX)
This section contains the most frequently used Windchill Workgroup Manager preferences for NX that users can manage using the wgmclient.ini file.
 |
This section lists the most “frequently used” preferences, and not every preference that can be set for NX using the wgmclient.ini file. Refer to the wgmclient.ini file, located in your Windchill Workgroup Manager home directory, for a complete list of preferences.
|
If the preference is not listed under <name> 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. The modified preference is available.
The following table describes the most frequently used preferences that can be set or modified underNX or in the general section of the wgmclient.ini file.
|
Name
|
Description
|
Values
|
|---|---|---|
|
expose.model.annotations
|
Controls how to expose annotations in CAD models as control characteristics inWindchillfor downstream manufacturing processes. This preference is applicable only to CATIA V5 and NX.
|
• All — Expose all model annotations to Windchill.
• Designated — Expose only annotations that have a Boolean parameter PTC_IS_DESIGNATE set to True.
• 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 Only (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 dialog.
|
• Models Only (default)
• Models and Viewables
|
|
save.upload
|
Specifies if the model is uploaded after a native Save action in the authoring application. For example, > .
|
• No (default)
• Yes
|
|
UndoCheckout.overwrite.local.content
|
Specifies if the model content is overwritten in cache by default when using Undo Checkout.
|
• No (default)
• Yes
|
|
overwrite.contents.on.update
|
Specifies if the model content is overwritten in cache by default 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.
|
• CAD/Dynamic Document Type
• Attachment File Type
• Content Category
|
|
open.modifies.checkedout.objects
|
Determines how checked out models will appear in session after update.
|
• Yes (default)
• No
|
|
upload.related.drawings
|
Native upload or auto check in of CAD Documents will also upload or check in associated drawings.
|
• Yes (default)
• No
|
|
unmanaged.read.only.area.folders
|
Windchill Workgroup Manager will ignore files retrieved from specified file system paths assuming there is no need to manage these in Windchill. Windchill Workgroup Manager will not store these file in the WLD, will not perform checks against the Windchill database, and will not establish Windchill dependencies.
|
This preference takes a semi-colon separated list of folder paths that constitute the ROAs. Search path will include sub-folders.
|
|
force.update.metadata.on.open
|
Controls propagation of Windchill Workgroup Manager attributes as properties upon opening of models from workspace and allows delay of this propagation to get better performance during open.
|
• Yes (default)
• No
|
|
enable.replace.in.cad.session.on.refresh
|
Controls whether to enable the feature of Replace in CAD Session on refresh.
|
• 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 (;), searched 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 screen.
|
• 10 (default)
• 0 (disables slider window)
Enter an numeric value in seconds.
|
|
ascii.only.chars.in.workspace.name
|
Restricts ASCII characters in the workspace name. This preference turns onWindchill Workgroup Manager mapping of Unicode workspace name to an ASCII name in the Local Workspace.
|
• No (default)
• Yes
|
|
open.appVersionSelection.alwaysShowDialog
|
Determines whether dialog to choose an application version is always shown on openInSession.
|
• No (default)
• Yes
|
|
wwgm.remember.last.used.server
|
Controls whether to reconnect to last used server upon subsequent Windchill Workgroup Manager client launch.
|
• Yes (default)
• No
|
|
windows.browser.type
|
Sets the Windchill Workgroup Manager embedded browser type.
|
chromium_browser (default)
|
|
update.drawing.alwaysShowDialog
|
Determines whether to prompt the user with a dialog box to update the drawing upon save to workspace or checkin.
|
• Yes (default)
• No
|
|
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.
|
• Yes (default)
• No
|
|
java.script.errors
|
Controls the display and execution of the java script error dialogs. If the dialog is presented, the user can choose whether to stop or continue running the script.
|
• Show (default)
• Hide and run
• Hide and stop
|
|
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, Insert from Windchill, and Replace.
|
• 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.
|
||
|
hide_default_workspaces.in_server_management
|
Control whether to display or hide virtual workspaces in the Server Management utility.
For more information, see Displaying or Hiding Virtual Workspaces in the Server Management Utility.
|
• No (default)
• Yes
|
||
|
update.nx.reuse.library.definition.file
|
Controls whether to update the NX reuse library definition file (ReuseLibraryFileType.xml) during NX launch. This is based on updates about new contents in Windchill library locations defined for preference Reuse Library Folders.
|
• Yes (Default)- Updates the NX reuse library definition file (ReuseLibraryFileType.xml) with Windchill server information.
• No- Updated content check for NX reuse library location on Windchill is ignored during NX launch and NX reuse library cache xml file is not updated.
|
||
|
wfs.add.temp.file.extensions
|
Enables adding a list of file extensions that can be saved to the Windchill File System (WFS) folder by an authoring application for temporary usage.
Removing the added file extension prohibits the corresponding file extension to be saved to the WFS folder.
|
Value is a list of file extensions that are separated by semicolons (for example,.png; .docx).
By default, the preference value is empty.
|
||
|
wfs.add.applications
|
Enables the addition of a list of executables that are permitted to read and write to WFS folders.
|
Value is a string containing the list of application names separated by semicolons (for example, app1.exe; app2.exe).
|
||
|
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.
|
||
|
wgm.release.nx.license
|
• Yes — NX licenses that are additionally checked out by a Windchill action will be forcefully released once the action is complete. However, NX licenses that were checked out before the Windchill action was called will not be released.
• No — Windchill action will not forcefully release NX licenses. Instead, the responsibility for license release will be left to NX itself.
|
• Yes
• No (default)
|