1[Oracle®] AutoVue Integration SDK Overview and Installation Guide Release 21.0.1 E84712-01 February 2017 Oracle AutoVue Integration SDK Overview and Installation Guide, Release 21.0.1 E84712-01 Copyright © 1998, 2017, Oracle and/or its affiliates. All rights reserved. This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited. The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing. If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable: U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007). Oracle America, Inc., 500 Oracle Parkway, Redwood City, CA 94065. This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners. This software or hardware and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services. Contents Preface ................................................................................................................................................................ vii 1 ISDK Overview 1.1 Introduction ................................................................................................................................. 1-1 1.2 AutoVue and Repository Integration ...................................................................................... 1-1 1.3 GUI Customization..................................................................................................................... 1-3 1.4 Repository Extension.................................................................................................................. 1-4 1.5 VueLink ........................................................................................................................................ 1-4 1.6 Optional Components ................................................................................................................ 1-4 1.6.1 CAD Connector.................................................................................................................... 1-5 1.7 Overview of ISDK Components ............................................................................................... 1-5 1.7.1 Documentation..................................................................................................................... 1-5 1.7.2 ISDK Skeleton Project.......................................................................................................... 1-6 1.7.3 ISDK Web Services Client................................................................................................... 1-6 2 System Requirements 2.1 Required Software ...................................................................................................................... 2-1 2.2 Server ............................................................................................................................................ 2-1 2.2.1 Windows ............................................................................................................................... 2-1 2.2.2 Linux...................................................................................................................................... 2-1 2.3 Client............................................................................................................................................. 2-1 2.4 Application Servers .................................................................................................................... 2-1 2.5 Development Tools..................................................................................................................... 2-2 3 Installation 3.1 Downloading Required Software............................................................................................. 3-1 3.1.1 Oracle JDeveloper 11gR1 .................................................................................................... 3-1 3.1.2 Oracle Enterprise Pack for Eclipse 11gR1 ........................................................................ 3-1 3.1.3 Oracle AutoVue ................................................................................................................... 3-1 3.1.4 WebLogic Server .................................................................................................................. 3-2 3.2 Installing and Configuring ........................................................................................................ 3-2 3.2.1 Installing ISDK ..................................................................................................................... 3-2 3.2.2 Creating a Server Runtime Environment on IDE............................................................ 3-4 3.2.3 Creating Projects on IDE..................................................................................................... 3-5 3.2.4 Configuring ISDK Components ........................................................................................ 3-7 iii 3.3 Configuring Sample Components......................................................................................... 3-10 4 Configuring Sample Projects 4.1 Sample Integration for Filesys DMS......................................................................................... 4-1 4.1.1 Step 1: Copy the AutoVue Jar Files ................................................................................... 4-1 4.1.2 Step 2: Configure the AutoVue Server ............................................................................. 4-1 4.1.3 Step 3: Configure log4j.properties for Debugging .......................................................... 4-2 4.1.4 Step 4: Configure RootDir for the Filesys Repository .................................................... 4-3 4.1.5 Step 5: Configure for an Embedded or Pop-Up Window (Optional) .......................... 4-3 4.1.6 Step 6: Configure the Markup Policy (Optional) ............................................................ 4-3 4.1.7 Step 7: Configuring User Control...................................................................................... 4-4 4.1.8 Step 8: Configure the Picklist ............................................................................................. 4-4 4.1.9 Step 9: Configure the Thumbnail Display........................................................................ 4-4 4.1.10 Step 10: Configure for Redirection .................................................................................... 4-5 4.1.11 Step 11: Configure the Real-Time Collaboration (RTC) Demo ..................................... 4-6 4.1.12 Step 12: Configure the Oracle Enterprise Visualization Framework (OEVF)............. 4-6 4.1.13 Step 13: Configure New Sample Data............................................................................... 4-8 4.1.14 Step 14: Run the Filesys Project ...................................................................................... 4-14 4.2 ISDK Web Services Sample Server ........................................................................................ 4-15 4.2.1 Method 1: Use an Existing Project Template ................................................................ 4-15 4.2.2 Method 2: Create a Project Manually............................................................................