Introduction
About this help file
Setup
Operating System
Setup Procedure
Floating License Manager
CAD specific Standalone Client
ODBC Configuration
Checking the Product Version
Settings recommended for Mechworks PDM
Overview
Data Management
Query the Database
Display Hierarchical Trees
Bill Of Materials
Variant Notes in Drawings
Troubleshooting - Logfiles
Basic Concepts
Handling of Solidworks Documents Relations
Information not Stored into the Database
Multi-body parts
Revisions of Configurations
Projects
Current Project
Current Grid
Current Document
Other Documents
MetaCategories
Change generic document type
File Attachments
Integration with Other Data Sources
UNC names
Silent vs Non Silent Open
Fundamental Operations
Open for Browsing
Open for Updating
Create a New Project
CAD Save as...
Document Wizard
Integrated Advanced Filter
User Interface
User Interface quick reference
The Bar Menu
Open for Browsing
Open for Updating
Create a New Project
Active Document
View Data
Edit Data
Open Drawing
Check In
Refresh
Edit Variant Note
Highlight all Variant Notes
CAD Save as...
PDM Save as...
Insert New Component...
Create Working Set
Document Wizard
Integrated Advanced Filter
The Utility Submenu
Execute an SQL Script
Backup on an SQL Script
Reset the Event Log Table
Optional User Programs
Repair Wrong External References
Options
About DBWorks...
The Toolbar
Drag&Drop Support in Grids and Trees
Contextual Menus
Intelligent Menus
View
Edit/Revisions ...
Find a Document
Add a Document...
Add an Attachments
Open
Open Drawing
Check In/Out
Check-out
Check-in
Approve
Increment Revision State
Approve no input
Undo Check-out
Undo Check-in
Freeze
Check-Out the Part/Assembly and all the Components
Check-In the Part/Assembly and all the Components
Approve the Part/Assembly and all the Components
Change Quantity
Plot
Add Component
Child Tree
Parent Tree
Event Log
BOM
BOMBalloons
Remove the Child From This Parent
Projects
Add to project/Remove from Project
Create Selection of Parent Projects
Rename/Replace
Rename
Replace Selected Components
Replace
Working Set
Explore
Custom Menu Entries
Entries Specific to Projects
Find a Project...
Order by...
Find a Document...
Create a New Project...
Current Project
Show Current Project's Documents Only
Show Selected Projects Only
Add a Project to the Selection
Create a Sub-Project...
Show Foreign Projects
Show Foreign Documents
Projects<=>Users Assignment
Projects<=>Documents Assignment
Create a New Bom Item...
Child Tree
Parent Tree
Expand
Collapse
Build the Buy List
Pass the Tree Structure to Internet Explorer
Refresh
Show Statistics
The Feature Manager
Feature Manager: search
Simpler popup menu in the Feature Manager
The Browser
Show Browser as a CAD Application Window
SolidWorks Property Manager
The Browser Tabs
Structure of a Grid
Selecting a Document
The Shortcut Bar
Quick Search
Display Tabs with Web Pages
Buttons in the browser
Print
Plot
Zoom Buttons
Sorting Grid Data
Filtering Grid Data
Adding and Removing a List to/from the Project
List Documents in the Grid Currently Locked
Replace Column Values
Delete Selected Rows
List Documents in the Grid Currently Locked
Html Output
Adding and Removing a Branch to the Active Project
Buy List
Restore Previous Revision
Create First Revision
Custom buttons
The Preview Window
Alternative Preview
Keyboard Shortcuts
The Document Page
The Projects Tree
Popup Menus
The Query Page
The Results Window
Mix Information from DBWorks and Other Data Sources
Query Macros
Popup Menus
The Tree Page
Layout of the Page
The Tree Window
Popup Menus
Custom columns in the Tree Page window
Dynamic Tree columns
Properties window inside the Tree Page window
The Workflow Decision View
Dockable and collapsible panels
The Integrated Advanced Filter
Full Text Search in Advanced Filter
The eDrawings Preview
Documents window inside the Tree Page window
Navigating the Composed Of/Used By windows in the Tree Page
DBWorks Entries in the SolidWorks Pop-up Menu
The Data Form
View Mode
Save Mode
Edit Mode
Tabs to Group Fields in Separate Sheets
Fields Grid
Used By Grid
Configurations Grid
Remarkable database fields
Extended Data Form User Interface
Linked tables values (also UNICODE)
Advanced Input
The Scripting Engine
Autofill While Setting a Filter
Running a Form to Edit a Field
Avoid Duplicate Part Numbers
Copy Value to Clipboard
Copy Record to Clipboard
.NET custom controls in Data Forms
Optimize form space
Projects selection
Descendent Traversing Options Dialog
The Revision Form
Customizing the Revision Form
Category Browser
Unicode Secondary Language Support
Revisions
Lifecycle of a Document
States
Actions
Creating the First Revision for a Document and all it's Descendents
Restoring a Previous Revision for a Document and for All its Descendents
Approve on the previous revision
Rollback
How to Remedy a Revision Error
The Revisions Submenu
Check-out
Check-in
Approve
Increment Revision State
Undo Check-out
Undo Check-in
Freeze
Revisions Recursive Commands
Revisions Containers
Revision schema
Revisions by Example
Dirty revisions
Securtity Issues
The Revision Form
Editing Assemblies with Sub-components in Mixed States
Comparison of Assembly Structures
Comparison of Models geomerty
Local Checkout Mode
Revisions and Projects
Drawings
Drawing Title Blocks
The SolidWorks Method
The DBWorks Method
Variant Notes Including Scripting Commands
Variant Notes Querying a Database
SolidWorks Drawing Blocks
Variant Notes Localization
Drawing BOM
Insert/Refresh Drawing BOM
Options for Drawing BOM
Wizards
Drawing Creation Wizard
Assembly Duplication Wizard
Assembly Cleanup Wizard
Conversion Wizard
Registration Wizard
Customization
Administrative Tools
DBCustomizer
Add a Column to the Grids in the Document Page
Modify the Tab Groups in the Data Form
Add Entries to the Pop-up Menus
Localization
Linked Database Tables
Visual Cues
Concepts
Manager
Categorizing Documents
The BOM
The Excel BOM
Overview
Customize the Excel BOM
BOM Wizard Overview
Layout in the BOM Wizard
Custom PARENT_CHILD fields in the EXCEL BOM
Excel BOM Advanced Scripting
Post processing BOM data
Output File Format
Previews
Print area
Support for linked tables
Support for hidden/suppressed components
Calculate Weights
BOM of Revisions
Embedded Excel BOM
Integration with the SolidWorks Document File Properties
Modifying the SQL BOM
The Edit BOM dialog
BOM of Configured Components in Drawings
Special case: BOM of the Balloons of a Drawing
Virtual Entries
Make/Buy assembly dependent
BOM_GROUP Substitute Parts for Assemblies
Outputs
Plotting Documents
Setting up the Plotter
Selecting the Documents to Be Plotted
Plotting on Large Sheets
The BIN\Printerinfo.exe utility
DBWPdfSecurityManager
Options
User
User Interface
Tree
Browser Behaviour
DBW Feat. Manager Behaviour
Preview
Open/Save
Save
Save as
Revisions
Checkin
Approval
Files
Outputs
Projects
Data input
Length Calculation
Feature Names
Not Null Fields
Automatic Fields Population
Rename
Plot Setup
General
Path
Units
Drawings
Assemblies
Event Log
More...
Environment
Configurations
Derived Parts
Link Mode
DBWArm
Workflow
Remote Access
DBWAclServer
Local Checkout Mode
Released Database Mode
Master Drawing Mode
Cut List
Task Manager
CAD/Application Integrations
SolidWorks addin
Assembly SpeedPak
Automatically Created SolidWorks files
Cutlist support in Solidworks
Flexible SubAssemblies Support
Preview of Virtual Components
Sheet names support
SolidWorks Toolbox Integration
VBA x64 support
Inventor addin
Inventor implementation notes
Inventor design tracking properties
.IPN presentation files
Modification of iProperties for iPart and iAsm
Solid Edge addin
Cutlist support in Solid Edge
Configuration concepts in Solid Edge
Solid Edge specific features support
Material support in Solid Edge
Performance issue when saving FOA
AutoCAD integration
AutoCAD integration
DBAutoCAD Installation
MSOffice integration
Outlook integration
Word/Excel integration
BricsCAD integration
BricsCAD integration
DBBricsCAD installation
SpaceClaim integration
DBClaim integration
Team working
Notification system
Document subscription
Concurrent engineering in a network
Read Only Documents and SW Options
DBWACLServer
Introduction
Settings and testing
DBWAclServer protected File Transfer
No-browsing folder permission
DBWAclServerADM.TXT
Scripting and sync
Advanced Features
Briefcase
Briefcase: an example
Briefcase: No AutoCheck Mode
Combinations of COMPANY_ID and OWNER_COMPANY_ID
Briefcase: Technical Information
Briefcase: Other Advanced Options
Briefcase: Consistency after a Get
Briefcase: Native support for x64 environments
Remote Access Mode
Setup
Changing the range of Unique IDs
Commands
Projects Management
Server-side file transfer for the Transfer Ownership functionality
Local Mode
using Remote Access support
using Local Checkout Mode support
OffSite Mode
GDE
Integrated Workflow Module
Released Database Mode
Master Drawing Mode
Task Manager
DBWServer (obsolete)
Introduction
Installation
System requirements
Installation on clients
Installation on server
Uninstall service
Check if it's running
no-browsing folder permission
Autodesk Inventor users
DBWServer.ADM administrative file
Silent mode
Protected script
Start/Stop service
Errors Log
Options
Release notes
DBWARM
Introduction
Installation
Intro and main concepts
Inside DBWARM
The DBWARM tool
Groups
Users
Classes
Auto-populate users
Built-in verification system
Dedicated options
DBWARM.MSG
Set of protected queries
Support for replication
Set/Reset classes from RMB
Appendix
DBWorks feature codes
Mask setting example
OnDBWArmUsersTableUpdated.VBS
Security and Maintenance
Security Levels
Assigning a Security Level
DBWARM User name vs Windows Display Name
Projects<=>Users Assignment
Projects<=>Documents Assignment
Performance Issues
Activity Console
Database Analysis Utility
Zip files
File loading algorithm
Appendix
Parameter Files
DBWConn.par
BomTitle.txt
CustProp.txt
DBWGext.txt
DBWApp.PAR
DBWLApp.PAR
DBWAppUser.PAR
DBWAppH.PAR
DBWDwg2PdfPlotStyle.PAR
DBWDwg2PdfOptions.PAR
DBWDwg2PdfCustomSheetFormats.PAR
DBWGDFCustomConditions.PAR
DBWPdfPrintOptions.PAR
DBWPopupHiddenCmds.TXT
SQLServer topics
Reference for database fields types
Log settings and shrinking in SQLServer 2008
SQLServer maintenance procedures
SQLServer disconnection mangement
SQLServer Database Engine Tuning Advisor
Misc
DMLK
Programming Mechworks PDM
Scripting in MechworksPDM
Python
PowerShell
.NET
.NET API
Introduction
API and Utility script
API and Event script
The API Object Model
Customize the Event System
Debug the Event System
API Example
DBWCommandShell
Introduction
Programmer's Guide
Write Scripting Files
Debug VBS scripts from MechworksPDM
Debug PS1 scripts from MechworksPDM
Execute Scripts without any Message Box
WSH Scripting
Macro for Assigning ID and DESC
Execute a Script on a Remote Server
Use the PDM outside of the CAD environment (out of process programming)
Script entry points and input parameters
Encrypted scripts
Asynchronous scripts
Including other scripts
RMB MenuState to enable/disable scripts in RMB
.UIvbs file to enable/disable scripts in RMB (deprecated)
Script order sequence and saparators in RMB
Native x64 scripting
DBWorks StandAlone Server
Permanently Instantiating the DBWorks Standalone COM Server
DBWArm Login
DDE Server for StandAlone Users
Standard Library support from Standalone Server
Automation Mode
Open browser in a separate window
.NET scripting
Specifics
Getting started
Commands Reference
Index of Shell Commands
BOM
AssignBomFieldValue
AssignBomPositionNumber
Bom
BomBalloons
BomDelete
BomEdit
BomInsert
BomRefresh
BuyList
CreateNewBomItem
GetBomFieldValue
GetBomPositionNumber
IsFakeDocument
ResetBOMAbsolutePositionNumbers
SetBOMAbsolutePositionNumbers
Browser
AddProjectToSelection
CloseSheet
CurrentBrowserPage
LoadBrowserSplitterPositions
LoadProjectSelectionDialog
LoadQuery
MaximizeBrowser
MinimizeBrowser
Navigate
NoRequery
OpenForBrowsing
OpenForUpdating
SaveBrowserSplitterPositions
SaveBrowserState
SaveProjectSelectionDialog
SetBrowserFocus
SetDocPageSplitterPosition
SetGridParameter
SetProjectSelection
SetTreePageSplitterPosition
ShowAdvancedFilterInBrowser
ShowBrowser
WriteActualGrid
CADSystem
ChangePartColor
CloseApplication
EnableDisableUpdateFileCustomProperties
GetActiveDocConfigurationInfos
GetActiveDocUniqueID
GetDocumentExternalReferences
GetInContextChildren
IsDetachedDrawing
IsManagedConfiguration
IsStandardPart
MaximizeSolidWorks
MinimizeSolidWorks
RefreshVariantNotes
SelectVariantNotes
SetDisplayName
ShowMainFrameWindow
ShowSolidWorks
SWClose
SWOpen
SWReplaceReferencedConfiguration
SWReplaceReferencedDocument
SWSave
SWSaveAs
SWVersion
SWVersionHistory
Component
AddComponent
MarkAsNewReference
MarkAsReferenced
ReplaceReferenced
ReplaceSelectedComponents
RebuildComponentNamesFromFileNames
Database
AddToParent
BackupDatabaseRange
DeleteAllChildren
DeleteDocument
DeleteParentChild
DeleteTree
ExecSQL
Fetch
FetchByUid
FetchRevisionByUID
FetchTableFieldByKey
Filter
GetUniqueIdFromRelatedDocuments
GetSortedUIDListForProcessing
GetUniqueIdListFromFIleName
IsPrimaryDatabaseChanged
PopulateParentChildRevisionTable
RemoveFromParent
Requery
ResetPrimaryDatabaseTables
RestoreDatabaseRange
SetPrimaryDatabaseTables
UpdateDatabaseActiveDoc
UpdateReleasedDatabaseDocument
UpdateReleasedDatabaseParentChild
DataForm
EditRecord
EditRevisionRecord
ViewRecord
DBWArm
AddUserToProject
GetUserGroup
GetUserLocalGroup
IsCorrectPassword
IsCorrectPin
IsDeniedFeature
RemoveUserFromProject
UserWorksInProject
Document
AddAttachment
AddDocument
CreateHtmlOutput
CreatePreviewFile
CreatePreviewFileFromFullPath
GetHiddenFilesList
GetRevisionOutputFiles
IsDocumentOpened
IsDocumentUsedByInMemoryAsmOrDrw
OpenDocument
OpenDocumentViewOnly
Rename
File
CopyFileListToClipboard
CreateDir
DeleteFile
DestroyFile
FileCopy
FileExists
FileGetAttributes
FileGetProperties
FileGetSizeAndDates
FileLock
FileMakePath
FileRename
FileSetAttributes
FileSetDates
FileTakeOwnership
FileUnLock
FileUnzip
FileZip
IsFileLocked
IsFileLockedExclusive
isPathInNoDBDirectory
Messages
RaiseNotification
ReloadLookUpTables
SendCommandMessageToUser
SendNotificationMessageToAllUsers
SendNotificationMessageToUser
ShowNotificationMessage
NeutralFormat
MDAddImage
MDAddLine
MDAddRect
MDAddText
MDClose
MDConvert
MDGetFileName
MDGetPageCount
MDGetPageSize
MDMerge
MDOpen
MDSetPageRange
MDSplit
Options
GetHiddenMessage
GetOption
LoadHiddenOptions
LoadOptions
Option
SaveOptions
PDMSystem
AddToDebugLog
AddToEventLog
CheckReleasedStructuresIntegrity
DDEConnect
DDEDisconnect
DDESend
Email
EnableDisableDBWAclServerWindowsExplorerSynchronization
EnableDisableLocalCheckoutModeIntegrityCheckOnLoad
EnableRepaint
ExecMacro
ExecScript
GetProductName
GetSessionID
LoadAddin
SendEmail
ShowAboutInfo
TrackEvents
Wait
Plot
LoadPlotSetup
Plot
PlotAll
PlotPDFTIF
SavePlotSetup
Project
CreateNewProject
RemoteAccess
DeleteLocalCopy
Download
DownloadFile
ExecFileTransfer
GetFromBriefCaseTree
SelectAllDocumentsInBriefcase
SetBriefcaseUniqueId
PutInBriefCaseTree
TakeOwnership
TransferOwnership
Revisions
ActivateRevision
Approve
ApproveTree
Checkin
CheckinTree
Checkout
CheckoutTree
CreateFirstRevision
CreateRevisionOutput
Freeze
IncrementRevisionState
IsRecursiveCheckinApproveOperation
NewRevision
RenameCurrentRevision
RestoreLastRevision
RestoreRevision
UnCheckin
UnCheckout
UnFreeze
ValidateNotNullFieldsBeforeApprove
VisualizeRevision
Selection
AndSelectByUniqueId
AndSelectQueryByUniqueId
AndSelectTreeByUniqueId
CurrentDocument
GetSelection
GetTreeParentChildSelection
SelectById
SelectByUniqueId
SelectQueryByUniqueId
SelectTreeById
SelectTreeByUniqueId
SelectTreeRoot
SetTemporarySelection
SetTemporarySelectionFromRecursiveCheckoutDialog
Tree
ChildTree
CollapseTree
ExpandTree
GetTreeFirstLevelChildDocuments
GetTreeParentProject
ParentTree
ProjectTree
WriteActualTree
WriteTree
TaskManager
TaskAppend
TaskCreate
TaskCreateScript
TaskSubmit
UserInterface
ActivityConsoleCleanAll
ActivityConsoleHide
ActivityConsolePrint
DBWBringToFront
DBWInputBox
DBWMsgBox
GetBrowserTreeCurrentGridInfo
GetComponentFileNameFromSearchDialog
GetFilePathFromFileOpenDialog
PrintInfo
SetBrowserTreeCurrentGrid
ShowChangeQuantityDialog
ShowConfirmationDialog
ShowCreateNewBomItemDialog
ShowDocumentSelectorDialog
ShowEditParentChildDataDialog
ShowPopupWindow
WaitDialogClose
WaitDialogOpen
WaitDialogPoll
WaitDialogSetMessage
Workflow
QueryWorkflowStatePermissions
WorkflowGetNotesAndFileAttachment
WorkflowGotoState
WorkflowRemove
WorkflowSubmit
WorkflowUpdateState
WorkingSet
WorkingSetAppend
WorkingSetCheckIn
WorkingSetCheckOut
WorkingSetCreate
WorkingSetGetInProgressState
WorkingSetIncrementRevisionstate
WorkingSetOpen
WorkingSetRemove
WorkingSetUnCheckIn
WorkingSetUnCheckOut
Object Reference
Special Files
Autoexec.spt File
Autoexec.vbs File
Autosave.spt File
!COMMAND.!!! File
OnCustomTools.VBS
Script parameters
I/O Parameters for MechworksPDM Scripts
List of Input/Result Parameters
List of Input Parameters
List of Result Parameters
Readable and Writeable Options List
List of tracked events
Event Scripts
BOM
OnBuyList.LST
OnEditBomAssignAbsolutePositions.LST
OnSearchBOMItem.LST
Browser
OnFilter.LST
OnSearch.LST
CADSystem
OnConfigurationFilter.LST
OnReadOnlyComponentNotify.LST
OnSearchComponent.LST
OnUpdateVariantnotes.LST
Database
OnAddAttachment.LST
OnDeleteAttachment.LST
OnCopyReleasedFileToSecuredStorageArea.LST
OnDatabaseConnectivityFailure.LST
OnDeleteRecord.LST
OnFilterUids.LST
OnPrepareSqlStatementForReleasedDatabase.LST
OnUpdateDatabaseForOpenedDocument.LST
DataForm
OnCancel.LST
OnCheckForNotNullFields.LST
OnEdit.LST
OnOk.LST
OnOkFilter.LST
Document
Dataentr.LST
OnAddDocument.LST
OnClose.LST
OnOpen.LST
OnOpenG.LST
OnSave.LST
OnSaveAs.LST
OpenDoc.LST
NeutralFormat
OnApproveMasterDrawing.LST
OnCreateMasterDrawing.LST
Options
OnOptions.LST
Plot
OnCreateHtmlOutput.LST
OnplotG.LST
Project
OnAddToRemoveFromProject.LST
OnChangeCurrentProject.LST
OnNewPrj.LST
RemoteAccess
OnRemoteAccessAction.LST
OnRemoteAccessFileTransfer.LST
Revision
OnApprove.LST
OnApproveOnPreviousRevision.LST
OnBeforeCheckin.LST
OnCanRev.LST
OnCheckIfMajorRev.LST
OnCheckin.LST
OnCheckout.LST
OnCheckoutCheckinApproveTree.LST
OnCheckoutRecord.LST
OnFilterRev.LST
OnFreeze.LST
OnIncrementRevisionState.LST
OnNewRev.LST
OnOkRev.LST
OnRevisionOutputFilesCreated.LST
OnUnCheckin.LST
OnUnCheckout.LST
OnUnCheckoutRecord.LST
OnValidateNotNullFieldsBeforeApprove.LST
UserInterface
OnAbout.LST
OnCommand.LST
OnDoubleClick.LST
OnDrop.LST
OnPreviewFileNotFound.LST
OnSelectorDialogItemsDisabler.LST
OnShowPreviewLabel.LST
OnViewDwg.LST
Workflow
OnAboutToChangeWorkflowState.LST
OnChangeWorkflowState.LST
OnCheckForRequiredECR.LST
OnGetWorkflowProcess.LST
OnSendWorkflowNotificationToUsers.LST
OnSubmitToWorkflow.LST
OnWorkflowStateHasChanged.LST
Special Scripts
Open
OpenDoc.LST
SaveAs/Rename
DataEntr_generic.LST
Data input
<FieldName>.LST files
CONFIGURATION_REVISION.SPT file
BOM
ViewXLS.LST
User Interface
OnCustomQueryTab_<TabName>.LST files
OnCustomQueryTabSearch_<TabName>.LST files
Advanced
DBWTran.LST
Filter
AdvFilter.LST
Material
Material.LST
System Scripts
Disconnected Database Replication Model
Examples
DBWDemo
Custom BOM
Handle SolidWorks arrays
PDF Output Support
Plot List
Build Hierarchical Structure
Drawing revision from drawing template
Drive SW UI from DBW script
Retrieve current user
Retrieve/Set current project
Retrieve custom properties
Retrieve document external references
Create a drawing watermark
Traverse project/assembly structure
Create Assembly booklet