Stellent: SDK Development Student Guide

Transcription

1 Stellent: SDK Development Student Guide D48797GC10 Edition 1.0 February 2007 D49224

2 Copyright 2006, 2007, Oracle. All rights reserved. Disclaimer This document contains proprietary information and is protected by copyright and other intellectual property laws. You may copy and print this document solely for your own use in an Oracle training course. The document may not be modified or altered in any way. Except where your use constitutes "fair use" under copyright law, you may not use, share, download, upload, copy, print, display, perform, reproduce, publish, license, post, transmit, or distribute this document in whole or in part without the express authorization of Oracle. The information contained in this document is subject to change without notice. If you find any problems in the document, please report them in writing to: Oracle University, 500 Oracle Parkway, Redwood Shores, California USA. This document is not warranted to be error-free. Restricted Rights Notice If this documentation is delivered to the United States Government or anyone using the documentation on behalf of the United States Government, the following notice is applicable: U.S. GOVERNMENT RIGHTS The U.S. Government s rights to use, modify, reproduce, release, perform, display, or disclose these training materials are restricted by the terms of the applicable Oracle license agreement and/or the applicable U.S. Government contract. Trademark Notice Oracle, JD Edwards, PeopleSoft, and Siebel are registered trademarks of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

3 Table of Contents Stellent IBPM SDK

4

5 Chapter 1: Stellent IBPM SDK Overview Chapter 2: Imaging/Business Process Management SDK From the Instructor Stellent IBPM SDK Help File Stellent IBPM SDK Overview Fundamental concepts of the IBPM SDK: IBPM ActiveX Controls: Viewer ActiveX Control IBPM Data Interface: Intelligent ADO Capabilities: IBPM Data Model: Data Interface and Queries: Data Interface Communication: IBPM Information Provider Interface: Information Providers: What s New Full Microsoft.Net Support The IBPM 7.6 SDK.Net Object Model New and changed Objects, Properties, and Methods The IBPM SDK in.net Primary Interop Assemblies Namespaces Adding References Object Names Thread Safety and Performance ADO vs ADO.Net Managing COM Object Release Stellent IBPM SDK Namespaces REFERENCES (PUBLIC/Supported) Stellent.IBPM.Interop.Common.ActionModifiers Stellent.IBPM.Interop.Imaging Stellent.IBPM.Interop.Imaging.Controls Stellent.IBPM.Interop.Print Stellent.IBPM.Interop.Process Stellent.IBPM.Interop.Process.Controls Stellent.IBPM.Interop.Process.Dialogs Stellent.IBPM.Client WEB SDK Stellent.IBPM.Interop.Common User Security Code Example (ACCRequest and ACCProvider) Return Schema Security: Return Saved Searches Security: SecurityDataGrid.DataSource = DataTable Return Policy Security: Additional Objects Stellent.IBPM.Interop.Imaging Schemas Tables V

6 Fields Saved Searches Ad Hoc Searches QueryConnections Performing the Search Document Manager Creating Documents Deleting Pages from Documents Inserting Pages Into Documents Modifying Document Indexes Retrieving Documents (export) PasteSelect Stellent.IBPM.Interop.Print PrintDialog Viewer ToolKit Stellent.IBPM.Interop.Imaging.Controls ViewerFlag Constant (OptPage) Remarks Stellent.IBPM.Interop.Process Object Hierarchy Profiles, ProfileCriteria, Databases, WFUsers Object Hierarchy - Processes Object Hierarchy - Processes Object Hierarchy Templates Object Hierarchy Templates Object Hierarchy Packages Object Hierarchy Packages Reference: Reference: COLLECTIONS Security and Connection Profiles/Packages Packages WFUsers Templates Profiles Fields ProfileCriteria Templates/Package/FieldValues Attachments Forms Tasks Stellent.IBPM.Interop.Process.Dialogs Stellent.IBPM.Interop.Process.Controls Chapter 3: Deployment, Custom Applications and Custom Tools Deployment Creating the new dependency file Adding a tool to a dependency file Adding a group to a dependency file File definitions IBPM Toolkit Runtime Files Troubleshooting DSMS Setup VI

7 IBPMSTARTUP Installing a custom application Custom Application Switches Tool Object Overview IBPM Client Framework Hosting Custom Tool Installation and Distribution IBPM Client Framework Hosting Dependency file Order of Events called for the custom tool Debugging Custom Tools Messaging Action Modifiers Consumers Implementation Dependency File: ActionModifier/Category keywords Customizing the IBPM Web Client XML Metadata Based Integration Features Code Based Integration Features Tool Interfaces Test Objects (Security/Availability) Query String Generators Work Center Nodes Custom Web Tools IBPM Pages Web Custom Tool Wizard Custom Web Tool Manager Interface BasicAcordeWebTool.asp PackageWebToolWebTool.asp Entry Points Web Custom Tool Wizard Files ASP Tool File Toolset Definition File Page Definition File Custom Tool Bar File (menu for custom tool) Modified Host Tool Bar (tool hosting the menu item for custom tool) CSS Set Properties Online Help Content Phrases Portal Entry Points Chapter 4: Stellent IBPM Web SDK URL Based Tools URL based tools URL Parameters URL Parameters AWSER Sample (using special characters) Menus Global Parameters for URL Based Tools AWSER - Stellent IBPM SDK Web Search & Retrieval (URL Based) AWSER Parameters: Example AWSER VII

8 Troubleshooting AWSER Logging AWSER To Enable Stellent IBPM Web Logging Stellent IBPM Web Package Viewer Tool Direct Login - AWPKVWR ToolName - AWPKVWR AWPKVWR Parameters Package Viewer Window Display Parameters AWPKVWR EXAMPLE Attachment Viewer Sub-Tool Journal Viewer Sub-Tool Troubleshooting Package Viewer Direct Login Stellent IBPM Web Viewer Tool Direct Login (AWVWR) Implementation AWVWR Parameters Auditing Troubleshooting Viewer Direct Login Chapter 5: Stellent IBPM SDK Web Services Stellent IBPM Web SDK Web Services Web Services Installation SOAP Settings Tool WebServerName UNCPathName TicketStorageDir IBPM User Web Service Contents of the AIID: Standard AIID: AIID with Alias information: Basic Login Using an Alias Future methods Logout Stellent Imaging Web Service (Export) Stellent Imaging Web Service (Imaging) Stellent Imaging Web Service (Search) Stellent BPM Web Service Stellent IBPM WebClientUtilities Web Service Soap Client Init Web Reference for Web Services IBPM Infrastructure Initialization Document (AIID) Stellent IBPM Web Services Returns CreatePackagesResultsArray ExportResultsArray PackageArray PackageDecisionsListArray PackageFieldPickListArray PackageFieldsArray PackageResultsArray PackageTemplatesArray PackageTemplateStartEventsArray VIII

9 PlacePackagesInFlowArray ProfileArray SavedSearchNamesArray SavedSearchPromptsArray SavedSearchPropertiesArray SavedSearchResultsArray SavedSearchStopArray TemplateFieldsArray IBPM User ConnectLanguage Purpose ConnectLanguage Return ConnectProcess Purpose ConnectProcess Return LoginAlias Purpose LoginAlias Return LoginAliasProcess Purpose LoginAliasProcess Return LoginUserName Purpose LoginUserName Return LoginUserNameProcess Purpose LoginUserNameProcess Return Logout Purpose Logout Return RegisterAlias Purpose RegisterAlias Return Stellent Imaging Export Export Purpose Export Return ExportBySystemFields Purpose ExportBySystemFields Return ExportEx Purpose ExportEx Return ExportExBySystemFields Purpose EportExBySystemFields Return ExportFromSearchResults Purpose EportFromSearchResults Return ExportFromSearchResultsEx Purpose IX

10 ExportFromSearchResultsEx Return PurgeCache Purpose PurgeCache Return ExportResultsArray Stellent Imaging Search Stellent Imaging Search BeginSavedSearch Purpose BeginSavedSearch Return ContinueSavedSearchBySearchConnectionID Purpose ContinueSavedSearchBySearchConnectionID Return GetAvailableSavedSearches Purpose GetAvailableSavedSearches Return GetSavedSearchPromptsBySearchName Purpose GetSavedSearchPromptsBySearchName Return GetSavedSearchPromptsSingle/Multiple Purpose GetSavedSearchPromptsSingle/Multiple Return GetSavedSearchPropertiesBySearchName Purpose GetSavedSearchPropertiesBySearchName Return GetSavedSearchPropertiesSingle/Multiple Purpose GetSavedSearchPropertiesSingle/Multiple Return StopSavedSearchBySearchConnectionID Purpose StopSavedSearchBySearchConnectionID Return StopSavedSearchMultiple Purpose StopSavedSearchMultiple Return Stellent BPM Profiles GetAvailableProcessProfiles Purpose GetAvailableProcessProfiles Return GetProfilePrompts Purpose GetProfilePrompts Return PromptedProfileArray Stellent BPM Packages Stellent BPM Packages AddJournalEntryByPkgRecID Purpose AddJournalEntryByPkgRecID Return AddJournalEntrySingle/Multiple Purpose AddJournalEntrySingle Return CompletePackage CompletePackage Return CompletePackageByPkgRecID X

11 Purpose CompletePackageByPkgRecID Return CreatePackages Purpose CreatePackages Return GetFieldPickListsFromTemplate Purpose GetFieldPickListsFromTemplate Return GetFieldPickListsFromTemplateByTemplateName Purpose GetFieldPickListsFromTemplateByTemplateName Return GetPackageDecisions Purpose GetPackageDecisions Return GetPackageDecisionsByPkgRecID Purpose GetPackageDecisionsByPkgRecID Return GetPackageFieldsByPkgRecID Purpose GetPackageFieldsByPkgRecID Return GetPackageFieldsSingle/Multiple Purpose GetPackageFieldsSingle/Multiple Return GetPackageListByPkgRecID Purpose GetPackageListByPkgRecID Return GetPackageListByProfileName Purpose GetPackageListByProfileName Return GetPackageListByPromptedProfile Purpose GetPackageListByPromptedProfile Return GetPackageListMultiple Purpose GetPackageListMultiple Return GetPackageTemplateIDFieldsByTemplateID Purpose GetPackageTemplateIDFieldsByTemplateID Return GetPackageTemplateIDFieldsSingle/Multiple Purpose GetPackageTemplateIDFieldsSingle/Multiple Return GetPackageTemplateIDStartEventsByTemplateID Purpose GetPackageTemplateIDStartEventsByTemplateID Return GetPackageTemplateIDStartEventsSingle/Multiple Purpose GetPackageTemplateIDStartEventsSingle/Multiple Return GetPackageTemplateNameFieldsByTemplateName Purpose GetPackageTemplateNameFieldsByTemplateName Return GetPackageTemplateNameFieldsSingle/Multiple XI

12 Purpose GetPackageTemplateNameFieldsSingle/Multiple Return GetPackageTemplateNameStartEventsByTemplateName Purpose GetPackageTemplateNameStartEventsByTemplateName Return GetPackageTemplateNameStartEventsSingle/Multiple Purpose GetPackageTemplateNameStartEventsSingle/Multiple Return GetPackageTemplates Purpose GetPackageTemplates Return LockPackageByPkgRecID Purpose LockPackageByPkgRecID Return LockPackageInQAueueByPkgRecID Purpose LockPackageInQAueueByPkgRecID Return LockPackageInQueueSingle/Multiple Purpose LockPackageInQueueSingle/Multiple Return LockPackageSingle/Multiple Purpose LockPackageSingle/Multiple Return PlacePackagesInFlow Purpose PlacePackagesInFlow Return SetPackageFields Purpose SetPackageFields Return SetPackageFieldsByPkgRecID Purpose SetPackageFieldsByPkgRecID Return UnlockPackageByPkgRecID Purpose UnlockPackageByPkgRecID Return UnlockPackageSingle/Multiple Purpose UnlockPackageSingle/Multiple Return Stellent Web Client Utilities GetAcordeWebServerURL Purpose GetAcordeWebServerURL Return RegisterURLDescription Purpose RegisterURLDescription Return RemoveTicket Purpose RemoveTicket Return Chapter 6: Stellent Complete IBPM SDK Student Labs Lab Installing the Stellent IBPM SDK XII

13 Lab Help Files & Samples Lab Copy Student Files for Labs Stellent Imaging SDK Lab User Security Lab Stellent Imaging SDK Lab User Security Lab Stellent Imaging SDK Lab Ad Hoc Search Stellent Imaging SDK Lab Saved Search Stellent Imaging SDK Lab - Viewer Lab Stellent Imaging SDK Lab Document Manager Export Manager Lab Stellent BPM SDK Lab Security, Display Packages Stellent BPM SDK Lab Security, Display Packages BPM Lab - Profiles Create Package (using Templates) BPM LAB - Display Package Properties and Modify Fields BPM Lab - Package Methods BPM SDK Lab Attachments BPM SDK Lab Forms Active X Custom Application Custom Tools Lab Package Search Tool Custom Tools Lab Messaging (Send Receive) SEND MESSAGE TOOL RECEIVE MESSAGE TOOL Web SDK URL Based Tools URL LAB 1A - URL Search and Retrieval Lab (AWSER) URL LAB 1B - URL Search and Retrieval Lab (AWSER) URL Lab 2A - URL Package Viewer Display All (AWPKVWR) URL Lab 2B - URL Package Viewer (AWPKVWR) URL Lab 2C - URL Package Viewer (AWPKVWR) URL Lab 2D - URL Package Viewer (AWPKVWR) URL LAB 3 - URL Viewer Lab (AWVWR) Web Services (using Acorde2.asmx) IMAGING Webservices Process Webservices XIII

14