AdkCOM Vol1 01 - Oracle

Transcription

Agile Advantage A p p lic a tio n D e v e lo p m e n t K it C O M /V BD e v e lo p e r G u id e – V o l 1v2006 SP4Part No. E12874 Vol1-01December 2008

Agile Advantage 2006Copyright 1995, 2008, Oracle and/or its affiliates. All rights reserved.This software and related documentation are provided under a license agreementcontaining restrictions on use and disclosure and are protected by intellectualproperty laws. Except as expressly permitted in your license agreement or allowedby law, you may not use, copy, reproduce, translate, broadcast, modify, license,transmit, distribute, exhibit, perform, publish or display any part, in any form, orby 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 notwarranted to be error-free. If you find any errors, please report them to us inwriting.If this software or related documentation is delivered to the U.S. Government oranyone licensing it on behalf of the U.S. Government, the following notice isapplicable:U.S. GOVERNMENT RIGHTSPrograms, software, databases, and related documentation and technical datadelivered to U.S. Government customers are "commercial computer software" or"commercial technical data" pursuant to the applicable Federal AcquisitionRegulation and agency-specific supplemental regulations. As such, the use,duplication, disclosure, modification, and adaptation shall be subject to therestrictions and license terms set forth in the applicable Government contract, and,to the extent applicable by the terms of the Government contract, the additionalrights set forth in FAR 52.227-19, Commercial Computer Software License(December 2007). Oracle USA, Inc., 500 Oracle Parkway, Redwood City, CA94065.This software is developed for general use in a variety of information managementapplications. It is not developed or intended for use in any inherently dangerousapplications, including applications which may create a risk of personal injury. Ifyou use this software in dangerous applications, then you shall be responsible totake all appropriate fail-safe, backup, redundancy and other measures to ensure thesafe use of this software. Oracle Corporation and its affiliates disclaim any liabilityfor any damages caused by use of this software in dangerous applications.Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Othernames may be trademarks of their respective owners.

This software and documentation may provide access to or information oncontent, products and services from third parties. Oracle Corporation and itsaffiliates are not responsible for and expressly disclaim all warranties of any kindwith respect to third party content, products and services. Oracle Corporation andits affiliates will not be responsible for any loss, costs, or damages incurred due toyour access to or use of third party content, products or services.

Agile Advantage 2006

C ONTENTSPreface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-iTTY Access to Oracle Support Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-iReadme . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-iAgile Training Aids . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-iiAccessibility of Code Examples in Documentation . . . . . . . . . . . . . . . . . . . . . . . 1-iiAccessibility of Links to External Web Sites in Documentation . . . . . . . . . . . . . 1-iiChapter 1Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1What is the Agile Advantage ADK? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .What’s New for this Release . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Key Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Agile Advantage 2006 ADK Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .AgileAPI Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Documentation Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .LicenseKey Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Samples Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Licensing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Supported Development Environments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Sample Applications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-11-11-21-31-31-31-41-41-41-41-51-51-5Chapter 2Developing Programs with the Agile Advantage API . . . . . . . . . . . . . . . . . . . . . . 2-1Working with Agile Advantage API Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Agile Advantage API Inheritance Model. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Declaring Agile Advantage Objects Using Early or Late Binding . . . . . . . . . . . .Avoiding Name Collisions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Externally Creatable Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Structuring Your Agile Advantage API Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Naming Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Common Terms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Abbreviations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Prefixes for Named Constants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-12-22-32-32-42-52-52-62-72-85

Agile Advantage 2006Properties and Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-9Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-9Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-11Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-13Working with Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-13Referencing Attributes in Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-14Tabs and Tables for Agile Advantage Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-15Attribute IDs Shared Between Multiple Classes . . . . . . . . . . . . . . . . . . . . . . . . . 2-17Memory Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-18Single-Threaded versus Multithreaded Applications . . . . . . . . . . . . . . . . . . . . . . . . 2-19VBScript Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-19Creating and Modifying Agile Advantage Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-20Mapping Agile Advantage Client Features to the Agile Advantage API. . . . . . . . . . 2-22Login Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-22Items. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-22Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-24Manufacturer Parts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-26Manufacturers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-28Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-29Attachments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-30Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-30Queries (Searches) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-31Customers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-32Problem Reports and Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-32Quality Change Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-32Agile Administrator Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-33Suppliers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-34Packaging Your Agile Advantage API Application. . . . . . . . . . . . . . . . . . . . . . . . . . . 2-35Agile Advantage ADK Files You Are Allowed to Distribute . . . . . . . . . . . . . . . 2-35Agile Advantage ADK Files You Are Not Allowed to Distribute. . . . . . . . . . . . 2-36Chapter 3Upgrading Programs to Agile Advantage ADK 2006 . . . . . . . . . . . . . . . . . . . . . . . 3-1Upgrading Programs from Agile 8.5 SDK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Changes Made to Agile Advantage 2006 APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .New Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .New Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .New Constants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Changes Made to Agile 8.5 APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6COM/VB Developer Guide3-13-13-13-23-23-2

ContentsAgile 8.5 Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2Agile 8.5 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3Agile 8.5 Constants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3Chapter 4Tutorials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1Creating an Application Using Visual Basic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1Part I: Setting Up the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2Part II: Using the Object Browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3Part III: Creating the User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4Part IV: Setting Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5Part V: Entering the Code. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6Part VI: Handling Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-9Creating a Query. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-11Part I: Setting Up the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-11Part II: Creating the User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-12Part III: Setting Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-13Part IV: Entering the Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-13Displaying SmartRules Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18Part I: Setting Up the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18Part II: Creating the User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-19Part III: Setting Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-20Part IV: Entering the Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-20Synchronizing the BOMs of Two Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-23Part I: Setting Up the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-24Part II: Creating the User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-24Part III: Setting Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-25Part IV: Entering the Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-26Redlining a BOM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-33Part I: Setting Up the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-33Part II: Logging In. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-33Part III: Declaring Public Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-33Part IV: Adding a RedlineBOM Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-34Part V: Getting a Released Part . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-34Part VI: Creating a Change. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-34Part VII: Adding the Part to the Affected Items Tab of the Change . . . . . . . . . 4-35Part VIII: Setting the Revision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-35Part IX: Modifying the Redline BOM Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-36Complete Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-367

Agile Advantage 2006Creating an ASP Application Using Visual InterDev . . . . . . . . . . . . . . . . . . . . . . . .Part I: Setting Up the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Part II: Designing the Login Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Part III: Setting Properties of the Login Page . . . . . . . . . . . . . . . . . . . . . . . . . . .Part IV: Adding Scripting to the Login Page. . . . . . . . . . . . . . . . . . . . . . . . . . . .Part V: Designing the Main Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Part VI: Setting Properties of the Main Page . . . . . . . . . . . . . . . . . . . . . . . . . . .Part VII: Adding Scripting to the Main Page . . . . . . . . . . . . . . . . . . . . . . . . . . .Part VIII: Adding a Link from the Login Page to the Main Page . . . . . . . . . . .Part IX: Running the Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-394-394-404-424-424-434-444-454-464-46Chapter 5Managing and Tracking Quality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1About Quality Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2Quality-Related API Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2Quality-Related Roles and Privileges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2Working with Customers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3About Customers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3Creating a Customer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3Loading a Customer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4Customer Tabs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5Saving a Customer as Another Customer with a Different Site . . . . . . . . . . . . . 5-5Working with Problem Reports and Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6About Problem Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6About Issues. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7Creating a Problem Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7Creating an Issue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-8Problem Report and Issue Tabs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-10Assigning a Problem Report or Issue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-10Associating a Problem Report or Issue with an Item. . . . . . . . . . . . . . . . . . . . . 5-11Linked Fields for Problem Reports and Issues . . . . . . . . . . . . . . . . . . . . . . . . . . 5-12Working with Corrective Action Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-12About CARs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-12Creating a CAR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-13Assigning a CAR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-14CAR Tabs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-15Saving a CAR as an ECO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-15Using Workflow Features with Problem Reports, Issues, and CARs . . . . . . . . . . . . 5-18Selecting a Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-188COM/VB Developer Guide

ContentsAuditing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-19Working with the Related PSR Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-20Chapter 6Agile Advantage API Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1Agile Advantage API Class Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1ActivityQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3ApprovedMfr. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-12ApprovedMfrs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-14Attachment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-16Attachments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-26Attribute. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-29Base. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-30BOMComponent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-37BOMComponents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-39CCBQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-42Change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-53Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-58CriteriaBag. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-67Customer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-71DataObject. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-75Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-85Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-97Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-112ListElement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-125Mfr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-127MfrPart. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-131Node. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-135ObjectInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-138Package. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-139PrintOption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-143Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-146Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-152RouteObject. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-177Row. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-192Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-206ServiceRequest. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-229SubClass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-233Supplier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2389

Agile Advantage 2006SyncOption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-2416-2436-2446-2506-261Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Index-110COM/VB Developer Guide

Contents11

Agile Advantage 200612COM/VB Developer Guide

PrefaceThe Agile Advantage documentation set includes Adobe Acrobat PDF files. TheOracle Technology Network (OTN) Web site ile.html) contains the latest versions of the AgileAdvantage PDF files. You can view or download these manuals from the Web site,or you can ask your Agile administrator if there is an Agile AdvantageDocumentation folder available on your network from which you can access theAgile Advantage documentation (PDF) files.NoteTo read the PDF files, you must use the free Adobe Acrobat Reader version 7.0 or later. This program can be downloaded from the AdobeWeb site (http://www.adobe.com).If you need additional assistance or information, please contact Customer Support(http://www.oracle.com/agile/support.html) for assistance.NoteBefore calling Agile Support about a problem with an Oracle AgileAdvantage manual, please have the full part number, which is located onthe title page.TTY Access to Oracle Support ServicesOracle provides dedicated Text Telephone (TTY) access to Oracle SupportServices within the United States of America 24 hours a day, 7 days a week. ForTTY support, call 800.446.2398. Outside the United States, call 1.407.458.2479.ReadmeAny last-minute information about Agile Advantage can be found in the Readmefile on the Oracle Technology Network (OTN) Web site ile.html).i

Agile Advantage 2006Agile Training AidsGo to the Oracle University Web page ntry new.html) for more information on Agile Training offerings.Accessibility of Code Examples in DocumentationScreen readers may not always correctly read the code examples in this document.The conventions for writing code require that closing braces should appear on anotherwise empty line; however, some screen readers may not always read a line oftext that consists solely of a bracket or brace.Accessibility of Links to External Web Sites in DocumentationThis documentation may contain links to Web sites of other companies ororganizations that Oracle does not own or control. Oracle neither evaluates normakes any representations regarding the accessibility of these Web sites.ii

iii

Agile Advantage 2006iv

v

Agile Advantage 2006vi

C HAPTER 1IntroductionThis chapter introduces you to the Agile API’s features. It contains thefollowing topics: What is the Agile Advantage ADK? What’s New for this Release Key Features System Requirements Agile Advantage 2006 ADK Folders Licensing Supported Development Environments Sample Applications SecurityWhat is the Agile Advantage ADK?The Agile Advantage ADK is a collection of application programming interfaces(APIs), sample applications, and documentation. ADK stands for ApplicationDevelopment Kit. The Agile Advantage API for COM is contained within an inprocess automation server, a file named AgileAPI.dll. The interfaces expose AgileAdvantage objects to developers, allowing them to build custom applications thataccess the functions of these objects.What’s New for this ReleaseThe Agile Advantage ADK supports these new features by allowing you to createand modify the following Product Quality items:1-1

Agile Advantage 2006 ADK CustomersCompliance SupportProblem ReportsIssuesCorrective Action Requests (CARs)For complete details about Agile Advantage API interface changes, see Chapter 3,“Upgrading Programs to Agile Advantage ADK 2006.”Key FeaturesThe Agile Advantage ADK lets you build custom applications that access AgileAdvantage eHub functionality. By using the Agile Advantage API, you can createscripts or applications that perform Agile Advantage tasks automatically.The Agile Advantage ADK lets you do the following:1-2 Integrate the Agile Advantage system with ERP applications or other customapplications. Extend the functionality of the Agile Advantage system. For example, youcould use the API to create custom reports. Develop applications to process Packages of product data. Perform batch operations against the Agile Advantage eHub. Access the Agile Advantage Windows client features from within other OLEcompatible applications, such as Microsoft Office. Use a variety of different development environments to build applicationsthat control the Agile Advantage eHub.Developer Guide

Chapter 1IntroductionThe Agile Advantage ADK contains the following: Agile Advantage ADK COM/VB Developer Guide (This manual)Agile Advantage API server and supporting librariesRuntime DLLs (such as APMsg32.dll)Sample applicationsSystem RequirementsFor Agile Advantage ADK system requirements, please see the Agile Advantage 2006Installation and Maintenance Guide.Agile Advantage 2006 ADK FoldersThe Agile Advantage ADK files have the following folder structure on yourcomputer:- Agile Advantage Home Folder - ADK- COMAgileAPIDocumentationLicenseKey SamplesAgileAPI FolderThe Agile Advantage ADK\COM\AgileAPI folder contains the following files: AgileAPI75.dll — the Agile 7.5 API library, which contains all Agile 7.5 APIclasses and interfaces. Ag

5 CONTENTS Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-i TTY Access to .