Import Files from Folders

Transcription

1 DS SOLIDWORKS CORPORATION Import Files from Folders SolidWorks Enterprise PDM [SolidWorks Enterprise PDM 2011] [January, ] [Revision 1] January 2011 Page 1

2 Index Contents Summary of Task... 3 Understanding SolidWorks File References... 3 Using SolidWorks Toolbox and Design Library... 3 Understanding SolidWorks Enterprise PDM File References... 4 Maintaining References as files are Moved or Renamed... 4 File Reference Dialog examples... 5 Using the Update References Tool... 6 Import Strategies... 7 Import all files into a single folder... 7 Import files using reference search paths... 7 Import files using relative paths... 7 Import files using pre-processing repair tools... 7 Do s, Don ts, and How to s... 8 Beware of Relying on Reference Search Paths... 8 Look out for rogue files outside the local vault view... 8 Estimating Effort... 8 Evaluating strategies and Data Quality... 8 January 2011 Page 2

3 Brief Overview: This document has been written to provide general guidelines to follow when bulk loading CAD Files from a Windows Explorer folder structure into a SolidWorks Enterprise PDM file vault. The purpose of this process is to ensure that all file references are established and maintained within the Enterprise PDM file vault. (i) (ii) (iii) (iv) This best practice was written as a guideline and should not be used without proper alignment to the customer situation. These guidelines apply specifically to SolidWorks files however the general principals apply to all file types for which SolidWorks Enterprise PDM has a plug-in to manage file references. Refer to solution S for specific File Types. This process applies to scenarios where there is only one version of each file being loaded into Enterprise PDM. When multiple versions of files need to be imported, the SolidWorks Enterprise PDM XML Import Tool should be used. Two resources for assistance with these processes are the SolidWorks Knowledge Base and our SolidWorks Service Partners. For additional resources please contact SolidWorks Field Services at fieldservices@solidworks.com. Summary of Task A customer has a large number of files residing in one or more Windows Explorer folders that need to be moved into a SolidWorks Enterprise PDM file vault view. The files will be organized into project folders within the Enterprise PDM file vault. All file references must be established between the newly added files in the Enterprise PDM file vault. Understanding SolidWorks File References When SolidWorks files are opened, a dynamic search is performed to find the file s references. This allows for the same parent file to find its references in different locations each time the file is opened depending on the state of various factors at the time the file is opened. SolidWorks has a well established and documented process for searching for file references. To review this process, search for Search Routine for Referenced Documents in the SolidWorks Help file. SolidWorks file references can be read and updated using the SolidWorks Document Manager API without having to open the files in SolidWorks. This allows the references of a large dataset to be evaluated and or updated rather quickly. Using SolidWorks Toolbox and Design Library The SolidWorks Toolbox functionality is now completely integrated within Enterprise PDM. The Toolbox library should be loaded into the vault prior to running the import. Design Library files need to be added to the vault; however there is no functionality to manage them similar to the Toolbox files. SPR : Add support for the SolidWorks Design Library in SolidWorks Enterprise PDM. Also, see solution S for more information on importing datasets containing Design Library components. January 2011 Page 3

4 Understanding SolidWorks Enterprise PDM File References When a file is added to a SolidWorks Enterprise PDM File vault the references of the file are not evaluated. Therefore files do not need to be added to the vault in any particular order. Enterprise PDM will search for references when the check in process is initiated. To understand the Enterprise PDM search routine, search for Enterprise PDM Settings Dialog Box - External References Tab in the SolidWorks Enterprise PDM Help file. During the check in process, a reference dialog will display the reference tree and indicate if a file cannot be found or is found outside the vault. It is not until the file is actually checked in that the references are written in the Enterprise PDM database. As such, all references need to be properly accounted for prior to completing the check in process. In order for Enterprise PDM to manage file references, the files must exist within the vault. Files stored outside the vault will not be included in the Enterprise PDM Where-Used or Contains tabs. Once the references have been established through the check in process, Enterprise PDM will maintain the file references as files are moved or renamed within the vault. Maintaining References as files are Moved or Renamed When a file is moved or renamed, SolidWorks Enterprise PDM will make a note in the database of the new reference name and/or location. The parent references will be updated in the local view where the action occurred, however the parent files are not updated in the Enterprise PDM Archive folders or in the locally cached versions on other client computers. During the Get operation, if a parent file has reference locations that differ from the updated reference names or paths in the database, the file references are updated as the file is cached locally. The Get version dialog will show Updating file references... as shown in Figure 1. Figure 1: Updating File References January 2011 Page 4

5 File Reference Dialog examples Import Files from Folders Figure 2: References found in same directory as parent Figure 3: References not found in sub folder January 2011 Page 5

6 Using the Update References Tool SolidWorks Enterprise PDM 2011 has a new tool available to help users find and connect missing references with parent files. This tool allows the users to select a file and search for its references within the file vault. The user can then choose from the list of matching results and update the file references. This tool is designed to repair only one parent file at a time. To learn more about this new tool, search for Updating Broken File References in the SolidWorks Enterprise PDM Help file. Figure 4: Update References tool showing missing references Figure 5: Update References tool showing updated references January 2011 Page 6

7 Import Strategies Determining the best process for importing a dataset into SolidWorks Enterprise PDM requires a thorough review of the state of the existing dataset in comparison to the desired state of the imported data. There are few common methods for importing data to consider. When choosing an import strategy, the long term affects for interacting with the files in both their native CAD system and Enterprise PDM need to be considered as some methods may only work for one or the other. Import all files into a single folder Importing all files into one folder for the initial check in and then moving the files into sub folders is a simple process that will set all references properly. This method is great for small datasets; however performance issues will be encountered when trying to work within a large import folder. Another item to consider with large datasets is that a custom program will likely be required to move files into the desired folder structure. Import files using reference search paths Importing files and relying on reference search paths is an effective solution when the reference paths are both manageable and predictable. When a large number of search paths are required, it can be time consuming to enter all the paths and difficult to be sure that all required paths have been specified. A custom program may be required to ensure the reference paths are set correctly. While relying on search paths will add a small amount of time to the display of the reference tree, once all files have been successfully checked in, the reference paths will no longer be required as SolidWorks Enterprise PDM will maintain the references. Import files using relative paths Most CAD systems understand references based on the relative path between the parent and its reference. If the existing dataset is stored in a folder structure that matches the folder structure of the vault, the files can be added to the vault using the same structure and the references will be found as is. This approach is based on the assumption that the references are correct in their current state, therefore the references should be verified which for larger datasets will require a custom program. Import files using pre-processing repair tools In all most all cases, the existing dataset will contain some elements of incorrect references or structure. It is therefore recommended to compile the existing dataset into the proper directory structure using a custom program that can also read the file references and correct them as needed. Although it is possible to place the files into the vault before running the program to update the references prior to check in, it is recommended to repair the files outside the vault to avoid having the files be automatically checked in at version two as Enterprise PDM does not allow edits to the initial version of documents in the vault. This method requires the ability to modify file references which is possible for SolidWorks files but may not be possible with all CAD systems. January 2011 Page 7

8 Do s, Don ts, and How to s Regardless of which import strategy is utilized to import a customer dataset, there will be challenges along the way and there are a few scenarios to watch out for and some common things to consider before getting started. Beware of Relying on Reference Search Paths There are inherent risks when using reference search paths as this process is very dynamic and difficult to predict the end results. Also, if the file vault will contain duplicate file names, reference search paths may select the wrong matching file name. While the SolidWorks Enterprise PDM Settings Dialog Box - External References Tab is a great way to ensure that Enterprise PDM is aware of the file references, this option will not update the references in the parent CAD document. The end result is that the Enterprise PDM check in dialog looks correct, however when the file is opened in CAD, the references are not found. Therefore, additional measures also need to be taken to ensure that the CAD references are correct. Also, in most cases, if SolidWorks can find the reference file than Enterprise PDM will be able to find them also without using the External References list. Look out for rogue files outside the local vault view When files are copied into a SolidWorks Enterprise PDM local vault view, the original files could potentially be found in the CAD reference search process instead of using the new copy of the reference file in the local vault view. This can also be an issue if there are other random copies of the file in locations both locally and on available network paths. Understanding the SolidWorks Search Routine for Referenced Documents and controlling the location of all copies of a reference file outside the vault will eliminate this scenario. Estimating Effort When a customer is using Windows Explorer to manage their dataset, the quality of the dataset is the primary variable to consider when estimating the effort to complete a data import. Another major factor to consider is if the dataset needs to be altered during the import. For instance, do files need to be renamed or moved to different folders? The other main factor is simply the size and composition of the dataset. At the start of an import project a quick assessment should be done to generate a report of all the different file types, size, and quantity. Regardless of if the project is to be done by the customer with guidance from the reseller or as a paid services project, careful planning needs to be done in the early stages to set the appropriate expectations. Evaluating strategies and Data Quality Most datasets are too large to be manually verified. During the planning stages, test imports using smaller subsets of the data should be performed using various strategies and including all file types. While testing sample datasets is great for validating an import strategy, the remainder of the dataset will also need to be verified. Therefore, customized tools will be required to scan and evaluate the entire dataset. Some things to check for are duplicate file names, parent files that cannot find existing references and references that are missing altogether. Typical programming skills required to achieve this task include traversing Windows directories and using the SolidWorks Document Manager API. January 2011 Page 8