VueLink for SAP PLM An Integration between AutoVue Client-Server Edition and SAP PLM System Administrator Manual VueLink Contents INTRODUCTION .......................................................................1 How VueLink Works .......................................................................1 SYSTEM REQUIREMENTS .....................................................3 AUTOMATIC INSTALLATION ..............................................4 Running InstallShield for VueLink for SAP PLM .......................4 MANUAL INSTALLATION ....................................................15 DMS Customization .......................................................................15 DMS Extension ...............................................................................15 VueLink Servlet .............................................................................15 Configuration .................................................................................15 Verification .....................................................................................15 Manually Installing VueLink for SAP PLM ...............................16 DMS Customization .................................................................16 DMS Extension ........................................................................16 Configuration ...........................................................................17 Verification ..............................................................................17 Installing VueLink Servlet for the Servlet Engine ......................17 Deploying VueLink to Any J2EE-enabled Application Server 17 Deploying VueLink to SAP J2EE Engine ...............................18 CONFIGURATION ...................................................................24 Customizing SAP GUI for Cimmetry Viewer .............................24 Installing VueLink Module ......................................................24 Configuring the Program's VueLink Settings ..........................25 Configuring VueLink based on Client Numbers .....................29 Configuring VueLink based on Storage Categories .................30 Mapping the Viewer Application for Inplace Viewing ............31 Mapping the Viewer Application for Outplace Viewing .........32 Enabling the Client for Format Modification ...........................34 Viewing Multiple Originals ...........................................................36 Setting Parameters inside vuelink.properties ..............................36 Configure web.xml for SAP J2EE Engine ...................................39 Configure vuelink.properties for SAP J2EE Engine ..................41 Completing the Configuration for XRefs ....................................41 Object Links .............................................................................41 Defining XRefs via the Document Structure ...........................42 Cimmetry Systems Corp. VueLink Defining Data Carrier Type ..........................................................42 Defining Custom Types for Cimmetry Documents .....................44 Cimmetry Markup Authorization Policy ....................................51 Sample Code ............................................................................52 Enabling HTTPS/SSL ....................................................................54 Updating java.security to Enable HTTPS/SSL ........................54 VERIFICATION .......................................................................56 Verifying that VueLink Servlet is running properly ..................56 Verifying the Version of SAP JCo ................................................57 APPENDIX A .............................................................................59 Customizing SAP to View Multiple Originals from the Product Structure ....................................................................59 Customize SAP to View Multiple Originals from the Display Document page ...........................................................61 APPENDIX B .............................................................................65 com.cimmetry.vuelink.sap.core.DocID ........................................65 FEEDBACK ...............................................................................67 General Inquiries ...........................................................................67 Sales Inquiries ................................................................................67 Customer Support ..........................................................................67 Cimmetry Systems Corp. VueLink 1 Introduction VueLink for SAP PLM provides an interface between SAP PLM System and AutoVue. This interface enables users to add powerful viewing and Markup capabilities to the following SAP GUI front end components: • SAP GUI for Windows on Windows platforms (cid:129) SAP GUI for Java on the Macintosh platform The VueLink servlet allows AutoVue server to communicate with SAP PLM System using the standard HTTP protocol. The following illustration shows a typical configuration of AutoVue integrating with SAP PLM System. How VueLink Works The client logs on to the Document Management System (DMS) through a web browser such as Microsoft Internet Explorer or Netscape Navigator. With DMS Customization in place, clicking on a file launches AutoVue. When you click this Cimmetry Systems Corp. 2 VueLink link, the AutoVue applet is launched and you can view that file inside the web browser window. Depending on AutoVue configuration, AutoVue client communicates with AutoVue server either through servlet tunneling for HTTP connection or through direct socket connection. Then AutoVue server communicates with the VueLink servlet using standard HTTP connection. With DMS Extension installed on the server, the VueLink servlet can communicate with SAP PLM to handle any request made by AutoVue server, like file 'fetching.' To display a composite file (a file with external references), the VueLink servlet retrieves the file along with all its component files from DMS and makes them available to AutoVue server. AutoVue server then processes them and AutoVue client displays the composite file. From here you can annotate the file, create new Markups, save Markups into DMS and open Markups from DMS. Cimmetry Systems Corp. VueLink 3 System Requirements Note: For the most up-to-date list of system requirements and for a list of known issues, see the release notes available in the etc subfolder of the VueLink distribution. (cid:129) AutoVue Client-Server Edition v19.1 (and any Service Packs for v19.1) (cid:129) SAP Java Connector v2.1.6 for mySAP ERP 2004 and ECC 5.0 (cid:129) SAP Java Connector 2.1.3 for SAP R/3 v4.7 (cid:129) SAP Front End 6.40 (GUI for Windows or Java) (cid:129) One of the following Application Server/Servlet Engine with Sun's Java Runtime Environment (JRE) v1.3.1 or later: (cid:129) SAP J2EE Engine v6.20 (cid:129) J2EE compatible Application server Example: Tomcat (cid:129) One of the following SAP b ack end server installations: (cid:129) SAP R/3 Enterprise v4.7 installed on any platform or (cid:129) mySAP ERP 2004 with ECC 5.0 (cid:129) One of the following client installations: (cid:129) SAP GUI for Windows v6.40 on Windows platforms or (cid:129) SAP GUI for Java v6.40 on Windows or MAC (cid:129) One of the following web browsers: (cid:129) Safari 2.0 on Macintosh or (cid:129) Firefox 1.5 on Windows platforms or (cid:129) Microsoft IE 6.0 on Windows platforms Cimmetry Systems Corp. 4 VueLink Automatic Installation This document's installation instructions for installing VueLink servlet support these SAP PLM System installations: (cid:129) SAP R/3 Enterprise v4.7 (cid:129) mySAP ERP 2004 with ECC 5.0 Before installing the VueLink for SAP PLM, ensure SAP PLM and AutoVue are installed and configured according to manufacturer’s instructions. Verify that they are operating correctly. Try testing SAP PLM and AutoVue independently to verify that the installation was successful and that all functions are available and produce the expected results. The following instructions are for installing VueLink for SAP PLM with the help of the InstallShield Wizard. For manual installation instructions instead, see Manual Installation. Running InstallShield for VueLink for SAP PLM The VueLink Installer for SAP PLM installs the VueLink servlet, and customizes and configures SAP PLM and AutoVue. Note: (cid:129) If you have a previous copy of VueLink for SAP PLM installed, please uninstall it before proceeding with the new installation. (cid:129) SAP Java Connector should be installed for the VueLink to work. You can download SAP Java Connector from the SAP PLM market place: http:// service.sap.com/netweaver. (cid:129) To be able to save Markups and metafiles, you must first define the Data Carrier Type. To run InstallShield for VueLink: 1 Verify that SAP PLM and AutoVue are properly installed on the server computer. 2 To install VueLink for SAP PLM, run setupwin32.exe found on the distribution CD under \AutoVue_Client_Server_Edition\ vuelink_setup\ win32. Cimmetry Systems Corp. VueLink 5 The installer starts installing VueLink for SAP PLM. 3 Enter the directory where you want VueLink for SAP PLM installed. The setup copies necessary integration files into this directory. Cimmetry Systems Corp. 6 VueLink 4 Select the components you want to install. Note: The Application Server Components installs VueLink for SAP PLM to a servlet engine. The SAP GUI components customize SAP GUI for Java and Windows. After selecting all the components you want to install, click Next. 5 For VueLink for SAP PLM to work, SAP Java Connector needs to be installed. Cimmetry Systems Corp.