Drawing Manager 2.5.1

Transcription

1 Drawing Manager Installation Guide May 2004

2 Drawing Manager Installation Guide Product Version: Guide Version: 1.0 McLaren Software All rights reserved. Information in this document is subject to change without notice and does not represent a commitment on the part of McLaren Software. The software described in this document is furnished under a license agreement, evaluation agreement or non disclosure agreement. The software may be used or copied only in accordance with the terms of the license agreement, evaluation agreement or non disclosure agreement. The purchaser may make one copy of the software for backup purposes or as defined in the license agreement, evaluation agreement or non disclosure agreement with McLaren Software. No part of this manual may be reproduced or transmitted in any form or by any means, electronically or mechanically. This includes photocopying, recording or information storage and retrieval systems, or for any purpose other than the purchaser s own use, without the express written permission of McLaren Software. Enterprise Engineer, Drawing Manager, Transmittals Manager, Business Action Manager, Concurrent Engineering Manager, CADLink, VueServer, RenderCenter, DocLoader and Solo are trademarks of McLaren Software. All other company and product names are used for identification purposes only and may be trademarks of their respective owners.

3 CONTENTS About this Guide Organization of the guide Conventions used in this guide Technical Support Product Version Number Online Help Build Number Guide Version Number Documentation Feedback Introducing Drawing Manager Product Overview Installation Overview Installation Pre-requisites Related Documentation Installing Drawing Manager Server Installation Installing Drawing Manager in your repository Initializing the Docbase for Drawing Manager Applying Drawing Manager Settings Client Installation Installing the Drawing Manager Client Configuring your Drawing Manager Client Installation Drawing Manager Configuration Common Tab Drawing Manager Configuration MicroStation Tab Drawing Manager Configuration AutoCAD Tab Manual Steps for AutoCAD Integration Setting the AutoCAD Support File Search Path Setting Xref Loading to Enabled with Copy Setting Up the Drawing Manager Menu Manual Steps for Upgrading AutoCAD Modifying the Cell Library Association Adding the Cell Library Format Modifying the CELLLIBRARY Association Type Configuring the Browser Filter Modifying the Cell Library Client Area Appendix A: Launching MicroStation for CADLink without Command Line Parameters A.1 Default CADLink for MicroStation Command Line A.2 Launching MicroStation using cadlink4.ma

4 ABOUT THIS GUIDE This product guide contains information about the installation of Drawing Manager Organization of the guide This guide contains four chapters. The table below lists the information that you can expect to find in each. Chapter Introducing Drawing Manager Installing Drawing Manager Modifying the cell library Association Appendix Contents An overview of the functionality and features of the product. How to install Drawing Manager, including any manual installation steps. How to create an additional, Drawing Manager controlled, cell library Launching MicroStation for CADLink without Command Line Parameters Conventions used in this guide This guide uses the following conventions: Convention Description Indicates a Note. This is usually pertinent additional information that may be useful. Indicates the introduction to a procedure. Follow the steps outlined to complete the procedure. Indicates a Tip. These are usually usage suggestions or other information that may make product usage easier. Indicates a Caution. There may be an issue you should consider before proceeding. Indicates a Warning. Please read these before continuing. They are used to protect you and your work from any potential loss of data. Represents a pop-up or pull-down menu. typewriter Represents code samples, and computer output. Technical Support If you have any support issues with either CADLink or DocLoader, please contact Documentum Support in the first instance. For all other McLaren products, please contact us directly: support@mclarensoftware.com When you contact support by phone, or fax, please have the following information ready: Your name 4-16

5 About this Guide Documentation Feedback Product Version Number Company name Company address Phone number address A detailed description of the problem, including any error messages A detailed description of the exact steps required to reproduce the problem The priority and impact on your ability to use the system. Names and versions (including service packs) of all software in use. For example: Windows 2000 Server, Oracle 8.1.3, and AutoCAD Details of any customizations you have on your repository or special permissions on your workstations. Any log files, configuration sheets, sample files etc. Please supply any attachments within a single.zip archive file to reduce their size. Failure to provide McLaren Support with the above information will cause delays and limit our ability to provide you initial suggestions which could potentially resolve the issue. Our system has been configured to remove any mail attachments that may contain executable code, or may contain links to executable code. This includes self-extracting archive files. For more support information, please visit our website: The product version number for Drawing Manager can be viewed by locating the relevant McLaren application object in your repository. Typically it will be located in the \System\kVisia\Applications folder. Online Help Build Number Guide Version Number If you are reporting a problem with the online help, please ensure you provide the help build number. To access the help build number: 1. Open the product help file. 2. In the main window, right-click and select View Source. 3. The help build number is stated near the top of the file. If you are reporting an error or omission in this guide, please give the guide version number as stated on the second page (inside front page). Documentation Feedback You can help us improve future documentation, if you have any feedback please contact us or visit our website and take our short survey. techpubs@mclarensoftware.com 5-16

6 INTRODUCING DRAWING MANAGER Product Overview Drawing Manager effectively integrates Autodesk AutoCAD and Bentley MicroStation applications within a document management environment. CAD Drawings, including full reference file handling, are automatically stored within the underlying platform repository, making it easy to maintain, version and manage CAD drawings in the same effective way as any other document that is subject to the automated business processes of Enterprise Engineer. AutoCAD and MicroStation drawings that are controlled by Drawing Manager are based on the Object Types installed with Enterprise Engineer and all the functionality that is supplied in the configuration: CAD Draftsman and CAD Manager User Roles to which the permissions for the creation and import of drawing documents is restricted; drawing document content templates; customized user dialogs for New, Import, Copy, Properties and QuickFind; drawing document lifecycles. In addition to those supplied by Enterprise Engineer, Drawing Manager installs content templates for standard Title Blocks that are synchronized with repository attributes, automatically updating drawing information. Reference File reports are made available through the Reporter component. The user can select to obtain information about the references files attached to the selected drawing, or drawings that the selected drawing is referenced by Installation Overview The installation for Drawing Manager requires tasks to be completed on both the server and each client machine. The information in this manual is structured around those requirements. 1. Server Installation Tasks: 1.1 Install the Repository Foundation Classes (RFC) for Documentum. The RFC may already have been installed on your system. 1.2 Initialize the repository for Drawing Manager using the RFC Administrator s Docbase Setup tab. 1.3 Apply the required Drawing Manager settings using the RFC Administrator s Drawing Manager Setup tab. 2. Client Installation Tasks: 2.1 Install Drawing Manager. 2.2 Ensure that the required CAD application is installed. 2.3 Complete the manual steps for AutoCAD integration, if required. 3. License Drawing Manager. 1.2 Installation Pre-requisites Please refer to the McLaren Product Support Matrix document posted on our corporate website at Related Documentation For information on the underlying technology, please refer to the following documentation: Enterprise Engineer Configuration Guide Enterprise Engineer Installation Guide 6-16

7 Introducing Drawing Manager Related Documentation 1 Enterprise Engineer XML Reference Guide. You can access all McLaren s product documentation on our website:

8 INSTALLING DRAWING MANAGER 1 The installation of Drawing Manager requires the completion of both the installation Wizard and some manual tasks. All the required steps are detailed in this chapter. To successfully install Drawing Manager you must have installed the Repository Foundation Classes. Please refer to the current Repository Foundation Classes Installation Guide for detailed instructions and information. 2.1 Server Installation The following tasks should be completed on your repository server, please ensure you have the required system administrator privileges before continuing Installing Drawing Manager in your repository The Repository Setup installation supplies Title Block templates which include out-of-the-box attribute synchronization between the CAD application and Documentum. To set up the repository for Drawing Manager: 1. In the Autorun screen, select Install Drawing Manager. 2. Click Install Drawing Manager Server. 3. In the dialog that warns you that the McLaren DocApps must be installed in the target Docbase, click Yes to continue if this is the case. If you have not yet installed Enterprise Engineer Core and Foundation, click No to exit from the setup. 4. If you agree with the License Agreement, click Yes. 5. Enter your User Name, Company Name and Serial Number. 6. When you have reviewed the Repository Setup details, click Next to proceed, or Back to change the settings. 7. Log in to the Docbase. The Wizard Complete screen is displayed when the Repository Setup has completed. You should now install the RFC Administrator. Please refer to the RFC Installation Guide for detailed instructions and information Initializing the Docbase for Drawing Manager The first time that you run the RFC Administrator you will see the Docbase Setup tab only: the other RFC Administrator tabs will be absent. The tab is provided because certain formats must be set up in the Docbase so that the Repository Foundation Classes can function correctly. In the Docbase Setup tab, select Install the required formats and click Apply. You will then see an Information dialog which informs you that the formats were installed successfully. To perform further administrative tasks you must firstly close and then restart the RFC Administrator Applying Drawing Manager Settings If you have installed Drawing Manager for Documentum, the RFC Administrator contains an additional tab, the CADLink Setup tab. It displays the Apply default CADLink settings checkbox and a warning that certain default settings must be applied to the repository if Drawing Manager is to function 8-16

9 Installing Drawing Manager Client Installation 2 correctly. These settings are format mappings for the MicroStation and AutoCAD Association Types and Formats that will be installed in the repository. To apply the default Drawing Manager settings in the repository: 1. Select Apply default CADLink Settings and click Apply. You will view a message that certain format mappings have been created based upon best guesses from the format name present in the repository, for example ustn and dwg. You must then ensure that the mappings that have been created are correct through the Formats and Application Integrations tabs. Note: You may have to create suitable Native Formats in the repository if none exist. If you run the RFC Administrator again the CADLink Setup tab will still be visible: it is provided in case you accidentally delete or incorrectly edit the settings that you have previously applied. Remember to license your Drawing Manager product. See Chapter 2 of the Enterprise Engineer Installation Guide for more details. 2.2 Client Installation All installation processes must be conducted through an Administrator account on the client machine, or by a user with administration privileges on the local machine. Drawing Manager users must be added to the Power Users group on systems running on Windows 2000 or XP. Do not use the RFC Import Wizard with files that are to be controlled by Enterprise Engineer. If you need to import drawings with reference files, import all the relevant files in one batch using the standard Enterprise Engineer Import functionality. Use the Import Check to resolve the references using the Interactive Resolution of References option. Do not use the Automatically Import References option under any circumstances Installing the Drawing Manager Client This installation provides options for Drawing Manager for MicroStation, Drawing Manager for AutoCAD and Drawing Manager for IRAS B. To install Drawing Manager for Desktop Client: 1. In the Autorun screen, click McLaren Drawing Manager. 2. Click Install Drawing Manager Client. The setup program checks that the correct version of the RFC is installed and halts if this is not the case. The setup program also checks for the presence of an existing instance of Drawing Manager on the client machine: if one is found you will be advised to uninstall it before proceeding. 3. In the Welcome screen, click Next. 4. If you agree with the License Agreement, click Yes to continue. 5. Enter the machine name of your McLaren License server. You may leave this blank and continue with the installation, but must manually copy the license file to the system before using Drawing Manager. 6. Click Next. 7. In Choose Destination Location, click Next to accept the displayed default Destination Folder, or use Browse to appoint an alternative then click Next. 8. In Select Components, select the CAD package option that you require for Drawing Manager, for example Drawing Manager for MicroStation and/or Drawing Manager for AutoCAD. If you are a MicroStation user and want to install integration files for use with IRAS B, also select Drawing Manager for IRAS B. 9. Click Next. 10. If you selected Drawing Manager for MicroStation, select the version that you require, or 8.x, then click Next. 9-16

10 Installing Drawing Manager Configuring your Drawing Manager Client Installation If you selected Drawing Manager for AutoCAD, select the version that you require, 2002 or 2004, then click Next. You will view a Setup Status screen with progress dialog informing you that the requested operations are being performed. 12. You will be prompted to confirm the location(s) of your CAD package(s) which the setup program attempts detect automatically. If the displayed location(s) are incorrect, use Browse to locate the application(s) then click Next. If the displayed location(s) are correct, simply click Next. You will view a status message that Drawing Manager command packages and areas are being registered. 13. In the InstallShield Wizard Complete screen, select Yes to restart your computer now. 14. Click Finish. 2.3 Configuring your Drawing Manager Client Installation The Drawing Manager Configuration Tool provides some configuration options for the Drawing Manager client machine. To start the Drawing Manager Configuration Tool: 1. Select Start Programs McLaren Drawing Manager Drawing Manager Configuration Drawing Manager Configuration Common Tab The Common tab in the Drawing Manager Configuration Tool provides a range of options which can be set for both AutoCAD and MicroStation deployments of Drawing Manager: Check Refs On Open? Select this option if you want Drawing Manager to check for uncontrolled references when the file is opened from the repository. If you do not select this option you will not be informed of the existence of uncontrolled references when the file opens. View Annotations On Open? Select this option if you want the Annotations attached to a file to be displayed when it is opened from the repository. Prompt for Detach All References? If you want the user to be prompted by a confirmation dialog after choosing to detach all reference files, select this option. Prompt for Detach All Rasters? If you want the user to be prompted by a confirmation dialog after choosing to detach all raster files, select this option. Update Title Blocks on Edit? If you want data items such as Title Blocks, Text Nodes or Tags that are linked to repository property values to be updated when a file is opened in the CAD application, select this option. Default Open Mode Select Ask, View or Edit from the drop-down list to determine the mode that the file is opened in: Ask Select this option if you want the user to be prompted to select between View and Edit modes when they open a file. View Select View if you want files to be opened in View mode. Edit Select Edit if you want files to be opened in Edit mode

11 Installing Drawing Manager Manual Steps for AutoCAD Integration Drawing Manager Configuration MicroStation Tab The MicroStation tab in the Drawing Manager Configuration Tool contains the following options for users of MicroStation repository files: Tag Set Name If your MicroStation files make use of a named Tag Set, you can enter the Tag Set Name here so that instances of that Tag Set are updated from the repository when the file is opened. If the Tag Set Name field is left blank, all Tag Sets in the file will be updated. If you want to update particular Tag Sets only, in Tag Set Name enter the names of each Tag Set separated by commas. Ensure that no spaces are entered before or after the commas. By default the Tag Set Name is set to Drawing Manager in the Drawing Manager Configuration dialog. Command On Open If your System Administrator has created any custom code that you want to be executed when files are opened, the command to run the code is entered here Drawing Manager Configuration AutoCAD Tab The AutoCAD tab in the Drawing Manager Configuration Tool contains the following options for users of AutoCAD repository files: Command On Open If your System Administrator has created any custom code that you want to be executed when files are opened, the command to run the code is entered here. 2.4 Manual Steps for AutoCAD Integration Setting the AutoCAD Support File Search Path By default the Drawing Manager installation creates folders entitled raster and reference in the target directory selected during installation and it is to there that Drawing Manager Reference Files of each type are fetched when a document is retrieved from the docbase. For each user account on the client machine, the folder must be added to the AutoCAD Support File Search Path so that it can find the reference files. To add the raster and reference folders to the AutoCAD Support File Search Path: 1. On the client machine, load AutoCAD. 2. Select Tools Options. 3. In the Options dialog, on the Files tab, select Support File Search Path. 4. Click Add. 5. Enter the path to the raster folder in the text box provided, %DRAWINGMANAGER_HOME%\areas\raster (for example, C:\Program Files\mclaren\Drawing Manager\areas\raster) or click Browse to locate it on the file system. 6. Repeat steps 4 & 5 to enter the path to the reference folder, %DRAWINGMANAGER_HOME%\areas\reference. 7. Click Apply Setting Xref Loading to Enabled with Copy Drawing Manager supports Reference Files in a read-only manner. This functionality must be set up in AutoCAD through the Options dialog for each user account on the client machine

12 Installing Drawing Manager Manual Steps for Upgrading AutoCAD 2 To set up Drawing Manager to open reference files as read-only: 1. On the client machine, load AutoCAD. 2. Select Tools Options. 3. In the Options dialog, select the Open and Save tab. 4. In the External References(Xrefs) area, in Demand load Xrefs, select Enabled with Copy. 5. Click Apply Setting Up the Drawing Manager Menu The Drawing Manager pull-down menu must be incorporated into the AutoCAD menu system for each user on each client machine. To load and position the Drawing Manager menu within the AutoCAD menu system: 1. On the client machine, load AutoCAD. 2. Select Tools Customize Menus. 3. On the Menu Groups tab, click Browse to locate the cadspa15.mns menu file in Program Files\mclaren\Drawing Manager\AutoCAD\2002 or Click Load. 5. Select the Menu Bar tab. 6. In Menu Group, select Drawing Manager. 7. In the Menu Bar list, highlight the AutoCAD menu that you want the Drawing Manager menu to be displayed before. 8. Click Insert. 9. Click Close. 2.5 Manual Steps for Upgrading AutoCAD To amend the localref search path, see Setting the AutoCAD Support File Search Path on page 11. You must also clear the option to load the lsp file with every drawing and, if applicable to the previously installed patch, remove the dtccheck.dvb file as described below within AutoCAD. The lsp file is a set of commands that are run when a file is opened in AutoCAD; dtccheck.dvb was supplied with some Drawing Manager patches to enable Drawing Manager to call the Desktop Client Check In component rather than Drawing Manager s own Check In component. To ensure that acad.lsp is not loaded with every drawing: 1. Open AutoCAD. 2. select Tools Options. 3. Select the System tab. 4. Clear the Load lsp with every drawing option. 5. Click Apply. To remove the dtccheck.dvb file: 1. At the acad prompt, type appload. 2. In the Start Up Suite, click Contents. If present, select and remove dtccheck.dvb

13 MODIFYING THE CELL LIBRARY ASSOCIATION 1 By default, a Cell Library Format of type MicroStation is installed with Drawing Manager. However, if you want to set up a Drawing Manager-controlled cell library of another type, carry out the following steps: Add the required cell library format to the repository. Modify the format of the installed CELLLIBRARY Association Type. Modify the cell library entry on the Application Integration tab to match the new format so that the browser is filtered on the correct format when the user attaches a Cell Library. Modify the Cell Library Client Area to accept the new format. The first three steps need only be carried out once for an individual repository. 3.1 Adding the Cell Library Format To add the Cell Library format: 1. In RFC Administrator, on the Formats tab, click New. 2. In App Format, enter a name for the format, i.e., Cell Library, in Format Name. 3. In Native Format, select the repository format that you want to map the format to. 4. Click OK. 5. Click Apply. 3.2 Modifying the CELLLIBRARY Association Type To create the Cell Library Association Type: 1. In RFC Administrator, on the Association Types tab, click select the default Cell Library Association Type. 2. Click Edit. 3. In Suitable Formats, select the new format. 4. Click OK

14 Modifying the Cell Library Association Configuring the Browser Filter Configuring the Browser Filter To configure the Browser to filter for Cell Library files only when attaching a Cell Library: 1. In the RFC Administrator s Application Integration tab, click select the Cell Library Application Integration. 2. Click Edit. 3. In Formats, select the name for the Format that you entered previously, for example Cell Library. 4. Click OK. 3.4 Modifying the Cell Library Client Area Reference files and associated files attached to drawings which you are editing are fetched from the repository to the local machine to speed up the opening of such drawing files subsequently. The folders on the local machine which store these files are known as Areas. You can modify an Area on your computer through the Areas dialog. To set up a Cell Library Client Area: 1. Select Start Programs McLaren RFC Area Manager. 2. In the Cell Library Area Type row, edit the Formats field to include the new format. 3. At the end of the field entry, click Enter

15 LAUNCHING MICROSTATION FOR CADLINK WITHOUT COMMAND LINE PARAMETERS A A.1 Default CADLink for MicroStation Command Line Out of the box, CADLink for MicroStation is configured to launch MicroStation with a set of command line parameters the user edits a drawing from the desktop client, or launches CADLink for MicroStation from the CADLink Start Menu icon. This is the standard CADLink/MicroStation startup s command line: ustation.exe -waclinit com.kvisia.product.cadlink.client.applications.cad.ustn.ustnappcontroller showdialog -WUCADLink -wa tells ustation.exe to load an MDL application on startup. The MDL application that we are loading is called clinit (CADLink Initialisation). That application takes one parameter: the name of a Java class to run. The com.kvisia.product.cadlink.client.applications.cad.ustn.ustnappcontroller is the name of the Java class. "showdialog" is actually the parameter to the Java class. -WU tells ustation.exe what user configuration file to use. We set up a user configuration called CADLink (defined in a UCF file) that contains all the appropriate Java path settings. A.2 Launching MicroStation using cadlink4.ma The sample source code contains an alternative method of launching MicroStation with the required CADLink modules. The source code may be found in the Sample Code\MicroStation Examples\initapp folder. This MDL code may be customized and compiled for use with CADLink 4.1. The main function of the cadlink4.ma file is to read in the two MicroStation configuration variables that tell the application which JMDL class to load and what arguments to pass to it. The main function is shown below: Private int main(int argc, char *argv[]) { char keyin[512];// keyin to send to ustn char classname[256];// name of the class to load char args[256];// argument to pass to the class // init the class and args strings. *classname = 0; *args = 0; // If we don't have the required parameter, then we don't go any further. mdlsystem_getcfgvar(classname,"cadlink_class",255 ); // get the arguments for out java class. mdlsystem_getcfgvar(args,"cadlink_class_args",255 ); if (strlen(classname) == 0) { // unload the MDL program mdldialog_cmdnumberqueue (FALSE, CMD_MDL_UNLOAD, mdlsystem_getcurrtaskid(), TRUE); } else { // This call will load the JVM, but not display any graphics yet. mdlsystem_entergraphicsextended(0); // construct the keyin to send 15-16

16 Launching MicroStation for CADLink without Command Line Parameters Launching MicroStation using cadlink4.ma A } sprintf(keyin,"java %s", classname); // if we have any arguments to pass, then append them to the keyin if (strlen(args) > 0) { sprintf(keyin, "%s %s", keyin, args); } // now send the keyin mdlinput_sendkeyin(keyin,1,0,null); mdlsystem_setfunction(system_reload_program, reloadfunction); // set the function to call when the system is to be unloaded mdlsystem_setfunction(system_unload_program, unloadfunction); } return SUCCESS; To use cadlink4.ma, simply place cadlink4.ma in the mdlapps folder and add it to the MS_INITAPPS variable. You must then create the following MicroStation configuration variables: CADLINK_CLASS - com.kvisia.product.cadlink.client.applications.cad.ustn.ustnappcontroller CADLINK_CLASS_ARGS showdialog MicroStation may now be launched with no parameters and the CADLink modules will be loaded