ADMINISTRATION GUIDE SOLIDWORKS ENTERPRISE PDM 2015 Contents Legal Notices...............................................................................................................14 1 Introducing the Administration Tool..........................................................................17 Configuring SOLIDWORKS Enterprise PDM....................................................................................17 Modifying Local Settings...................................................................................................................20 ManagingWebServer.......................................................................................................................20 Starting the Administration Tool........................................................................................................21 Recently Used List............................................................................................................................21 Viewing Administrative Change History............................................................................................22 2 Local Settings...........................................................................................................23 Group Policies...................................................................................................................................23 Log File..............................................................................................................................................23 ViewingtheSOLIDWORKSEnterprisePDMLogFile.................................................................24 Displaying Event Details..............................................................................................................24 Copying the Local Log File..........................................................................................................25 Log File Dialog Box......................................................................................................................25 Settings Dialog Box...........................................................................................................................26 SettingsDialogBox-AutomaticLogin.........................................................................................26 SettingsDialogBox-ExternalReferencesTab...........................................................................27 Settings Dialog Box - Zip Program Tab.......................................................................................27 3 Vaults........................................................................................................................29 Creating and Distributing Vaults........................................................................................................29 Vault Creation..............................................................................................................................29 Creating Local Vault Views..........................................................................................................37 DistributingaVaultViewUsingActiveDirectory..........................................................................42 DistributingaVaultViewinaWANEnvironment.........................................................................44 File Vault Properties Dialog Box..................................................................................................48 AddServerDialogBox.................................................................................................................49 Collecting Support Information..........................................................................................................49 Deleting a Vault.................................................................................................................................51 Logged in users Dialog Box.........................................................................................................51 Remove File Vault Dialog Box.....................................................................................................52 Vault Settings....................................................................................................................................52 ExportingVaultSettings...............................................................................................................52 2 Contents Importing Vault Settings...............................................................................................................53 Vault Archives...................................................................................................................................60 Archive Compression and Cleanup.............................................................................................61 CompressingaVaultArchive.......................................................................................................61 Archive Server Cleanup...............................................................................................................62 Activating the Compression or Cleanup Manually.......................................................................63 Cold Storage Schemas.....................................................................................................................63 Creating a Cold Storage Schema................................................................................................64 ExampleofUsingColdStorage...................................................................................................65 Cold Storage Schema Dialog Box...............................................................................................65 Enterprise PDM Reports...................................................................................................................68 Formatting a Report Query..........................................................................................................68 Creating a Transaction-SQL Query.............................................................................................75 ExecutingaReportQuery............................................................................................................76 4 Archive Servers........................................................................................................77 AddinganArchiveServer..................................................................................................................77 Logging In to an Archive Server........................................................................................................78 Refreshing an Archive Server...........................................................................................................78 RemovinganArchiveServer.............................................................................................................79 Viewing an Archive Server Log File..................................................................................................79 CopyingtheArchiveServerLogFile.................................................................................................79 Displaying Unreplicated Files............................................................................................................80 Identifying the Server Where a File is Replicated.............................................................................80 Collecting Support Information..........................................................................................................80 Add Server Dialog Box......................................................................................................................82 Server Properties..............................................................................................................................82 Archive Status Dialog Box.................................................................................................................82 Replication.........................................................................................................................................83 Replication Settings Dialog Box...................................................................................................84 New Replication Schema Dialog Box..........................................................................................84 Advanced Schema Settings Dialog Box......................................................................................86 5 Enterprise PDM Add-ins...........................................................................................88 InstallingEnterprisePDMAdd-ins.....................................................................................................88 Installing Add-ins for Debugging.......................................................................................................89 Add-in Properties Dialog Box............................................................................................................89 Debug Add-ins Dialog Box................................................................................................................90 6 Dispatch....................................................................................................................91 InstallingtheDispatchAdd-In(32-Bit) ..............................................................................................91 InstallingtheDispatchAdd-In(64-Bit)...............................................................................................92 Accessing Dispatch...........................................................................................................................92 3 Contents Creating Dispatch Action Scripts.......................................................................................................93 Administrate Actions Dialog Box..................................................................................................93 Edit Action Dialog Box.................................................................................................................94 Editing Dispatch Scripts..................................................................................................................111 CreatingVariablesforDispatchScripts...........................................................................................112 Set variables Dialog Box............................................................................................................114 Functions for Variables..............................................................................................................115 Exporting Dispatch Scripts..............................................................................................................120 Importing Dispatch Scripts..............................................................................................................121 7 Bills of Materials.....................................................................................................122 SupportedBOMTypesinEnterprisePDM......................................................................................122 CreatingBillofMaterialsTemplates................................................................................................123 UsingtheWeldmentCutListBOMType.........................................................................................124 BillofMaterialsDialogBox..............................................................................................................125 8 Data Cards.............................................................................................................131 Types of Data Card.........................................................................................................................131 OpeningtheCardEditor..................................................................................................................132 Card Edit - Select File Vault Dialog Box....................................................................................132 Creating a Data Card......................................................................................................................133 Saving Data Cards..........................................................................................................................133 Data Card Inheritance................................................................................................................134 SavingaModifiedDataCardtoaSpecificFolder.....................................................................136 ModifyingaDataCard.....................................................................................................................137 AddingCardControlstoaDataCard..............................................................................................137 Adding Control Logic to a Control...................................................................................................139 Aligning Data Card Controls............................................................................................................139 Glueing Data Card Controls............................................................................................................140 Exporting a Data Card.....................................................................................................................141 Importing a Data Card.....................................................................................................................141 CreatingaSearchCardUsinganSQLList.....................................................................................141 CreatingaSearchCardwithPreselectedValues......................................................................142 Input Formulas................................................................................................................................142 UsinganInputFormula..............................................................................................................143 Using Input Formula Aliases......................................................................................................144 Input Formula Functions............................................................................................................145 Working with Controlled Tabs.........................................................................................................150 ControlledTabExample1-ControllingVisibilityofTabs..........................................................150 ControlledTabExample2-ManagingAccesstoaControl......................................................151 Assigning Default Values................................................................................................................152 AssigningaDefaultValuetoaDateVariable............................................................................152 4 Contents Using a Serial Number as a Default Value................................................................................153 CardEditorControlsToolbar...........................................................................................................154 Card Properties..........................................................................................................................155 Open/SaveAsCardDialogBox.................................................................................................161 Image Properties........................................................................................................................162 Text Properties...........................................................................................................................162 Frame Properties.......................................................................................................................163 Edit-box Properties....................................................................................................................164 Button Properties.......................................................................................................................167 Radio-button Properties.............................................................................................................168 Combobox Properties................................................................................................................171 Droplist Properties.....................................................................................................................173 Combolist Properties..................................................................................................................176 Listbox Properties......................................................................................................................178 Tab Properties...........................................................................................................................181 Checkbox Properties..................................................................................................................181 Date Field Properties.................................................................................................................183 Card Search Control..................................................................................................................186 Variable Search Control.............................................................................................................186 Grid Settings Dialog Box............................................................................................................186 Controlled by Variable Dialog Box.............................................................................................186 9 Card Lists...............................................................................................................188 CentralCardLists............................................................................................................................188 Creating a Text-based Card List.....................................................................................................188 CreatingaCardListfromanSQLSource.......................................................................................188 Creating Dynamically-controlled Card Lists....................................................................................189 UsingAliasesinCardLists..............................................................................................................191 Creating an Alias List.................................................................................................................191 CopyingandPastingAliasCardListValues..............................................................................191 Using an Alias List in a Data Card.............................................................................................192 SQLQueryExamples......................................................................................................................192 RetrievingSQLValues from a Linked Server Source.....................................................................193 List Dialog Box................................................................................................................................194 10 Categories............................................................................................................196 Creating Categories........................................................................................................................196 Category Dialog Box.......................................................................................................................197 Creating Conditions for Categories.................................................................................................199 Editing Categories...........................................................................................................................200 Deleting Categories.........................................................................................................................200 ShowUsageDialogBox..................................................................................................................200 5 Contents Example-AssigningCategoriesbyFileType.................................................................................200 Example-AssigningCategoriesbyVariableValue........................................................................201 11 Columns...............................................................................................................203 CreatingaFileListColumnSet.......................................................................................................203 Creating a Search Result Column Set............................................................................................204 Adding a Column Set to a Search Card..........................................................................................205 Customizable Columns Dialog Box.................................................................................................205 New Configuration Dialog Box........................................................................................................208 12 File Types.............................................................................................................210 Setting File Type Properties............................................................................................................210 FileTypePropertiesDialogBox......................................................................................................210 PreventingDuplicateFileNamesintheVault.................................................................................212 Duplicate File Name Check Dialog Box..........................................................................................212 13 Importing and Exporting Data...............................................................................213 Importing Variable Values...............................................................................................................213 CreatinganXMLFile.......................................................................................................................214 XMLFileStructureandExample.....................................................................................................214 Creating an Import Rule..................................................................................................................216 Import Rule Dialog Box...................................................................................................................217 CreatinganAliasSet.......................................................................................................................218 XML Variable Alias Sets Dialog Box...............................................................................................218 Creating an Export Rule..................................................................................................................218 Export Rule Dialog Box...................................................................................................................220 Working with Transition Actions......................................................................................................224 Troubleshooting Tips.......................................................................................................................225 14 Indexing the Vault.................................................................................................226 Setting Up Indexing.........................................................................................................................226 IndexingVaultArchivesonaSQLServerSystem..........................................................................227 Configuring the Index Service on a Non-SQL Server System........................................................228 Removing a Vault Index..................................................................................................................228 Indexing Settings Dialog Box..........................................................................................................228 Edit File Vault Archive Folder Path Dialog Box...............................................................................229 15 Items.....................................................................................................................230 Item Folders....................................................................................................................................230 Configuring Items............................................................................................................................231 ConfigureItems- ItemID...........................................................................................................232 Configure Items - Descriptive Name..........................................................................................232 6 Contents 16 Installing and Configuring SolidNetWork Licensing.............................................234 ConfiguringtheSolidNetWorkLicenseServerfortheFileVault.....................................................234 UsingSolidNetWorkLicenseServerwithFirewalls.........................................................................235 ModifyingSolidNetWorkLicenseManagerSettingsforWindowsFirewall................................235 SolidNetWork License Administration.............................................................................................236 Starting the SolidNetWork License Manager.............................................................................236 Troubleshooting SolidNetWork Licenses...................................................................................236 Licensing.........................................................................................................................................237 License Types............................................................................................................................237 Changing the Client License Type.............................................................................................237 ViewingVersionInformationforNon-clientSystems.................................................................238 ViewingVersionInformationfor ClientSystems........................................................................238 Adding and Modifying SolidNetWork License Server................................................................238 Set License Dialog Box..............................................................................................................239 17 Message System..................................................................................................241 Types of Message System..............................................................................................................241 Configuring the Message System...................................................................................................243 Message System - General Tab................................................................................................243 Message System - SMTP Settings Tab.....................................................................................244 Test Settings..............................................................................................................................244 Example: Using the Database Message System............................................................................245 18 Revision Numbers................................................................................................246 Creating Revision Numbers............................................................................................................247 RevisionNumberComponentPropertiesDialogBox................................................................247 RevisionNumberPropertiesDialogBox....................................................................................248 Show Usage Dialog Box............................................................................................................249 Setting Revision Numbers Manually...............................................................................................249 Setting Revision Numbers Automatically........................................................................................249 Assigning Revision Numbers to Workflow States...........................................................................250 Example - Changing Revision Numbering for Different Workflow States.......................................251 Example-CreatingRevisionNumberswithMajorandMinorCounters.........................................252 Example-MappingaRevisionNumbertoaDrawingTitleBlock...................................................253 19 Serial Numbers.....................................................................................................255 Creating a Serial Number from a String..........................................................................................255 Creating a Serial Number from an Add-in.......................................................................................256 AddingaSerialNumbertoaDataCard..........................................................................................257 UsingSerialNumberstoAutomaticallyNameFiles........................................................................257 SerialNumberPropertiesDialogBox..............................................................................................258 Serial Number Dialog Box...............................................................................................................259 7 Contents 20 Tasks...................................................................................................................261 Adding Tasks to a Vault..................................................................................................................262 PermittingTaskExecution...............................................................................................................263 Task Host Configuration Dialog Box..........................................................................................264 Creating a New Task.......................................................................................................................264 Task Properties - Add-in............................................................................................................266 TaskProperties-ExecutionMethod..........................................................................................266 Task Properties - Menu Command............................................................................................268 Task Properties - Script.............................................................................................................268 Task Properties - Scheduling.....................................................................................................273 Task Properties - Permissions...................................................................................................275 Task Properties - Success Notification......................................................................................276 TaskProperties-ErrorNotification............................................................................................277 ConfiguringtheConvertTask..........................................................................................................277 EnablingSaveas3DPDFintheConvertTaskScript...............................................................279 ConvertProperties-ConversionSettings..................................................................................279 Convert Properties - File Card...................................................................................................291 Convert Properties - Output File Details....................................................................................292 Configuring the Print Task...............................................................................................................294 Print Properties - Printer............................................................................................................295 PrintProperties-PaperSizeandOrientation............................................................................296 Print Properties - Margins..........................................................................................................297 Print Properties - Files...............................................................................................................297 ConfiguringtheDesignCheckerTask.............................................................................................298 CreatingaTaskVariant...................................................................................................................299 Executing Tasks..............................................................................................................................299 LaunchingaTaskUsingaWorkflow .........................................................................................300 Executing an On-Demand Task.................................................................................................300 Add Task Dialog Box.................................................................................................................301 Monitoring Tasks.............................................................................................................................308 Task List Dialog Box..................................................................................................................308 TaskListOptionsDialogBox.....................................................................................................309 Task Details Dialog Box.............................................................................................................310 TroubleshootingTaskProblems......................................................................................................311 ViewingDetailsforaFailedTask...............................................................................................312 UsingNotificationstoAccessTaskErrorLogs..........................................................................312 Customized Tasks...........................................................................................................................313 Upgrading the SOLIDWORKS Task Add-in....................................................................................313 DeterminingtheCurrentVersionsofEnterprisePDMandtheSOLIDWORKSTask Add-in....................................................................................................................................314 Performingthe SWTaskAddinUpgrade.....................................................................................314 8 Contents Upgrading Tasks........................................................................................................................315 21 Templates.............................................................................................................316 Creating Templates.........................................................................................................................316 New/EditTemplate-TemplateName........................................................................................317 New/EditTemplate-Executeas................................................................................................317 New/EditTemplate-TemplateCards........................................................................................318 Add Card Dialog Box.................................................................................................................319 New/EditTemplate-FilesandFolders......................................................................................319 New/EditTemplate-Icon...........................................................................................................324 New/Edit Template - Users and Groups....................................................................................325 Organize Template Variables....................................................................................................325 Example:CreatingaProjectTemplateUsingaTemplateCard................................................326 Editing Templates............................................................................................................................328 CreatingNewTemplatesbyCopyingandPasting..........................................................................328 Deleting Templates.........................................................................................................................328 22 Toolbox.................................................................................................................329 ConfiguringToolboxinEnterprisePDMandSOLIDWORKS..........................................................329 Toolbox Dialog Box.........................................................................................................................332 Migrating Existing Toolbox Libraries...............................................................................................336 Toolbox Migration Scenarios.....................................................................................................337 MigratingfromPartialtoCompleteToolboxIntegration.............................................................338 Migrating a Shared Toolbox.......................................................................................................338 Post-Migration Instructions for Toolbox Users...........................................................................339 Upgrading Toolbox Software...........................................................................................................340 UpgradingtoManageToolboxEntirelyintheVault...................................................................340 Ongoing Toolbox Upgrades.......................................................................................................341 23 Users and Groups................................................................................................343 AdminUserAccount........................................................................................................................343 Creating User Accounts..................................................................................................................344 CreatingUserAccountsforWindowsorLDAPLogin................................................................344 Creating User Accounts for the Enterprise PDM Login Type....................................................345 User Information Pop-up ................................................................................................................346 DeletingaUserAccount..................................................................................................................347 ChangingaUserAccountPassword...............................................................................................348 DelegatingManagementofUserAccountandGroupPermissions................................................348 Managing Multiple Users Accounts.................................................................................................349 Users/Groups Dialog Box................................................................................................................349 Resolving Missing User Login Information......................................................................................350 Folder and Workflow State Permissions.........................................................................................351 Assigning Folder Rights..................................................................................................................351 9 Contents Setting Caching Behavior................................................................................................................352 Permitting Users to See Private State Files....................................................................................353 User Properties - General Properties..............................................................................................353 Add Users Dialog Box................................................................................................................356 User Properties - Groups...........................................................................................................357 UserProperties-AdministrativePermissions............................................................................358 UserProperties-PermissionsperFolderTab...........................................................................360 UserProperties-AssignedFolderPermissionsTab.................................................................364 UserProperties-StatePermissions..........................................................................................365 User Properties - Transition Permissions..................................................................................366 User Properties - Permissions per File......................................................................................367 UserProperties-SearchCards.................................................................................................367 UserProperties-BillsofMaterials.............................................................................................368 User Properties - Tasks.............................................................................................................368 User Properties - Templates......................................................................................................368 UserProperties-Warnings........................................................................................................369 User Properties - Cache Options per Folder Tab......................................................................373 UserProperties-AssignedCacheOptionsTab........................................................................374 User Properties - Copy Tree Exclude Folders...........................................................................374 User Properties - Copy Tree Excluded Folders.........................................................................375 New User Dialog Box.................................................................................................................376 New User Dialog Box (Windows Login).....................................................................................376 Change Password Dialog Box...................................................................................................376 Select Vault Folder Dialog Box..................................................................................................376 Permission Assignments Dialog Box.........................................................................................377 User Settings...................................................................................................................................377 Adding a Viewer for the View File Command............................................................................378 ClearingValuesfortheCopyTreeCommand...........................................................................378 AddingaComparisonApplicationfortheCompareCommand.................................................379 Displaying Full User Names in the User Interface.....................................................................379 Customizing Enterprise PDM Menus.........................................................................................380 DefiningDefaultsforRetrievingReferencesDuringCheckOut................................................382 SettingsDialogBox-AddingFiles.............................................................................................386 Settings Dialog Box - Adding Folders........................................................................................386 Settings Dialog Box - Check In..................................................................................................387 SettingsDialogBox-CopyTree................................................................................................388 Settings Dialog Box - Explorer...................................................................................................388 SettingsDialogBox-FileCompare...........................................................................................391 Settings Dialog Box - Language................................................................................................391 SettingsDialogBox-Menus......................................................................................................392 Settings Dialog Box - Messages................................................................................................393 SettingsDialogBox-ReferenceDialog.....................................................................................394 10