Technical Notes. ApplicationXtender Software Developer s Kit (SDK) January 2006

Transcription

1 ApplicationXtender Software Developer s Kit (SDK) 5.30 Technical Notes January 2006 These technical notes provide information on the following topics: Introduction... 2 Contents of the AppXtender SDK... 2 Requirements... 3 Related Documentation... 4 Basic Features of the AppXtender SDK... 5 Getting Started... 5 Creating Documents... 5 Retrieving Documents... 6 Viewing Documents... 7 Managing Documents... 7 Additional Features of the AppXtender SDK... 8 The Enterprise Application Interface... 9 Database Layer Plug-in Scripting The SDK for AppXtender Workflow Windows Management Information AppXtender SDK Usage Examples Adding Toolbar Buttons Improving a Custom Interface Importing Images Image Enabling an Application and Allowing Full-Text Searches15 Creating a Button to Display a Document Collecting Audit Information for Hundreds of Documents Providing Document Access Through the Web AppXtender SDK Objects

2 Contents of the AppXtender SDK AppXtender Application Automation Interface Objects...18 AppXtender Database Automation Interface Objects...19 AppXtender View OCX Control...22 Annotation Object...22 Enterprise Application Interface Objects...22 Scripting Objects...23 AppXtender Workflow Objects...23 AppXtender SDK Code Samples...24 AppXtender Application Automation Interface Samples...24 AppXtender Database Automation Interface Samples...25 Annotations Sample...26 Enterprise Application Interface Sample...26 Buic Scanner MICR Output Script Samples...27 AppXtender Workflow Samples...27 Introduction This document is intended to help you decide whether to purchase a license for the ApplicationXtender (AppXtender) Software Developer s Kit (SDK). The AppXtender SDK provides a set of documentation and sample code (Visual Basic and Visual C++) that illustrates the capabilities of the ApplicationXtender Application Programming Interface (API). The documentation provides a complete reference for the AppXtender automation interfaces and the AppXtender View OCX, an ActiveX control designed to display and manipulate AppXtender documents. The AppXtender SDK was created to help you integrate AppXtender with your own Windows business solutions. The automation interface is separated into two distinct interfaces: The AppXtender application automation interface allows you to control the Aex32.exe application. The AppXtender database automation interface allows you to control the Aex.dll data objects. Contents of the AppXtender SDK The AppXtender SDK contains the following items: Complete AppXtender SDK documentation in PDF format (ApplicationXtender SDK User s Guide) 2

3 Requirements Requirements Requirement Programmer s familiarity with Software Processor Available hard disk space Memory AppXtender SDK documentation in Windows HTML Help format (AppXtender Automation Interfaces Help, AppXtender View OCX Help, and AppXtender Scripting Help) AppXtender SDK sample code in Microsoft Visual Basic and Microsoft Visual C++ format (For details, see AppXtender SDK Code Samples on page 24.) The following table describes each of the AppXtender SDK usage requirements: Table 1 AppXtender SDK Usage Requirements Details ApplicationXtender and related Content Management products (See Related Documentation on page 4) Proper Microsoft Windows Programming techniques and Microsoft Component Object Model (COM) technologies (ActiveX Components & Automation). For details, refer to and search for topics on COM Visual Basic 6, Visual Basic Scripting Edition (VBScript), Microsoft XML, XML, Visual Basic.NET, C++, and C#. Development of Windows COM-based applications AppXtender 5.3 and the AppXtender SDK of the same version A Microsoft Visual Basic 6.0 Professional compiler or a Microsoft Visual C Professional or greater compiler License Server 5.6 Scanner driver (optional). Scanner drivers may be included with the scanner or can be obtained from the scanner manufacturer. In addition to AppXtender scanner support files, a scanner driver specific to the scanner to be used must be installed. Pentium PC (A faster processor increases AppXtender productivity). The hard disk space required varies, depending on the AppXtender workstation type and third-party components needed. For instance, an AppXtender Admin workstation installation requires up to 455 MB, and the Demo database requires up to 42 MB. AppXtender also needs additional space on the drive to store temporary files during the installation process. For details, refer to the ApplicationXtender Installation Guide. The memory required varies ( MB of RAM), depending on the AppXtender workstation type and operating system. For details, refer to the ApplicationXtender Installation Guide. 3

4 Related Documentation Requirement Operating system Details Windows 98 SE Windows Millennium Edition Windows NT 4.0 Workstation or Server (Service Pack 6a is required) Windows 2000 Server, Advanced Server, or Professional (Service Pack 4 is required) Windows XP Professional (Service Pack 1a is required) Windows 2003 Server, Standard or Enterprise Note: Novell networking is supported as long as the NetWare client is installed on any workstations with AppXtender components. Related Documentation The following table lists documentation to which you can refer for information on each of the EMC Documentum Content Management products: Product ApplicationXtender ApplicationXtender Report Management Table 2 ApplicationXtender Media Distribution ApplicationXtender Image Capture ApplicationXtender Web Access ApplicationXtender Workflow Related Documentation Documentation ApplicationXtender Technical Notes ApplicationXtender Installation Guide ApplicationXtender User s Guide ApplicationXtender Core Components Administrator s Guide ApplicationXtender Report Management Technical Notes ApplicationXtender Report Management Administrator s Guide ApplicationXtender Media Distribution Administrator s Guide ApplicationXtender Media Distribution Database Reintegration Guide ApplicationXtender Media Distribution Viewer Guide ApplicationXtender Image Capture User s Guide ApplicationXtender Web Access Technical Product Overview ApplicationXtender Web Access Administrator s Guide ApplicationXtender Web Access User s Guide ApplicationXtender Workflow Technical Product Overview ApplicationXtender Workflow Administrator s Guide ApplicationXtender Workflow User s Guide ApplicationXtender Workflow Quick Start Guide ApplicationXtender Workflow Process Builder Guide ApplicationXtender Workflow Basic Language Guide 4

5 Getting Started Basic Features of the AppXtender SDK Nearly all of the tasks that you can perform through the standard AppXtender Desktop interface can also be performed through the AppXtender SDK. The following sections summarize these tasks: Getting Started on page 5 Creating Documents on page 5 Retrieving Documents on page 6 Viewing Documents on page 7 Managing Documents on page 7 Finishing on page 8 Getting Started The following table lists initial tasks that can be performed through the AppXtender SDK (tasks that would be performed before documents are created, viewed, or managed): Table 3 Category of Tasks Starting ApplicationXtender Displaying AppXtender Standard Toolbars Displaying AppXtender Script Toolbar and Menu Auditing Events Configuring an AppXtender Workstation Getting Started Tasks Logging a specific user on to a specific AppXtender data source. Logging a specific user on to ApplicationXtender Workflow (AppXtender Workflow). Hiding or showing specific AppXtender standard toolbars (Main, Annotation, Image, Scan, Script, or Batch Index). Hiding or showing the AppXtender Script toolbar and Script menu. Auditing all of the Audit Trail settings listed in AppXtender AppGen. Auditing for purposes of compliance to the Health Insurance Portability and Accountability Act of 1996 (HIPAA). Configuring an AppXtender workstation, equivalent to several of the options on various tabs of the AppXtender Configuration dialog box. Configuring the use of WorkflowXtender with AppXtender, equivalent to the options on the AppXtender Workflow Workbox Properties dialog box. Creating Documents After AppXtender has been started, users have been logged in, and the system has been configured, you can create AppXtender documents. The 5

6 Retrieving Documents following table lists document creation tasks that can be performed through the AppXtender SDK: Table 4 Category of Tasks Creating New Documents Indexing Documents Creating New Batches Indexing Batches Creating Documents Tasks Scanning, importing by file selection, pasting, inserting as an object, or faxing-in. Setting the scanner scan area (by specifying left, top, width, and height) and starting the scan operation. Controlling the display of the Index view. Entering individual index values. Using automated indexing features. Using index validation. Importing using a batch import file. Importing by file selection. Faxing-in. Indexing pages of a batch to create a new document. Adding pages from a batch to an existing document. Retrieving Documents After documents have been created in your AppXtender system, you can retrieve those documents. The following table lists document retrieval tasks that can be performed through the AppXtender SDK: Table 5 Category of Tasks Searching a Single Application Searching Multiple Applications (CAQ) Displaying Documents from the Result Set Retrieving Documents Tasks Entering index values, full text values, or both as search criteria. Adding or removing query columns. Executing a query. Saving changes to a query and query reference file. Closing the query. Specifying the query attribute for a specific index field (searchable, displayable, or neither). Checking in a document. Checking out a document. Resuming check-out mode (if the document is already checked out by the current user). Canceling the checked-out status of a document. Opening an AppXtender Reports Mgmt report, or viewing full-text search results. 6

7 Viewing Documents Viewing Documents After documents have been retrieved, you can change the way the document is displayed. The following table lists document-viewing tasks that can be performed through the AppXtender SDK: Table 6 Category of Tasks Navigating within a Document Viewing Multiple Documents and Pages Page View Functions Available for Multiple Page Types Viewing Specific Page Types Viewing Documents Tasks Navigating to the next, previous, or a specific page of a document. Viewing thumbnails. Navigating to the next, previous, newest, or oldest version. Navigating to the next or previous sub-page. Cascading document windows. Tiling document windows. Using Split View. Displaying a document in a duplicate window. Using full screen view, Sticky View, zoom, rotate, the Magnifier, scaleto-gray, and regions. Viewing image pages, text pages (using form overlay), PDF files, foreign files, and OLE objects. Managing Documents After a document has been retrieved, you can process the document in a variety of ways such as adding pages, changing the index record, printing, faxing, sending by , and exporting. The following table lists document management tasks that can be performed through the AppXtender SDK: Table 7 Category of Tasks Adding Pages to Documents Modifying Document Indexes Setting ODMA Document Attributes Managing Documents Tasks Scanning, importing by file selection, pasting, inserting as an object, or faxing-in. Setting the scanner scan area and starting the scan operation. Inserting after the current page, inserting before the current page, or appending to the end of the document. Adding sub-pages to documents. Modifying the index values of an existing document. Specifying attributes on the General and Summary tabs of the AppXtender Document Properties dialog box: App Name, Modified By, Subject, Author, Keywords, and Comment. Specifying the document s owner. 7

8 Managing Documents Category of Tasks Printing and Faxing ing Exporting Enhancing Images Using OCR Submitting Documents to a Fulltext Queue Managing OCR, Full-text, or IPS Queues Submitting Documents to AppXtender Workflow Using Annotations Deleting Finishing Tasks Standard printing or submitting a print job to the Image Print Server (IPS) queue. Opening an composition window with the full document, the document reference, or the current page as attachments. Exporting a document, optionally with OCR processing. Processing a page using image enhancement. This is a feature that allows you to improve the clarity of an image in many configurable ways, such as the removal of lines or dot shading. Processing a document or page using standard OCR or submitting documents to an OCR queue. Submitting documents to a full-text queue for either the ProIndex or Verity full-text engines. Starting processing of the job. Marking the job as finished or in error. Deleting the job. Submitting documents to AppXtender Workflow and starting a business process. Configuring annotation settings (such as redactions or line thickness). Creating or changing annotations. Deleting documents, batches, index records, pages, sub-pages, versions, revisions, or annotations. Saving changes. Closing the document. Quitting the application. Logging out of AppXtender and AppXtender Workflow. Additional Features of the AppXtender SDK The following sections describe features of the AppXtender SDK that may not be familiar to standard AppXtender users: The Enterprise Application Interface on page 9 Database Layer Plug-in on page 10 Scripting on page 10 The SDK for AppXtender Workflow on page 12 8

9 The Enterprise Application Interface The Enterprise Application Interface The Enterprise Application Interface (EAI) simplifies the implementation of the AppXtender SDK. The following figure shows AppXtender being accessed via the AppXtender SDK (Application and Database automation interface) objects. These AppXtender SDK objects are in turn accessed via the AppXtender EAI object. Enterprise Application Interface Object Application Interface Object Database Interface Object ApplicationXtender Figure 1 Relationship Between AppXtender SDK and EAI The following table compares the advantages of using the AppXtender SDK with the EAI and alone: Table 8 Using the AppXtender SDK with the EAI vs. Using the AppXtender SDK Alone Advantages of Using AppXtender SDK with the EAI Each function is easier to perform. (A function that requires only one call with the EAI may require multiple calls with the SDK alone.) Query results are saved in standard Microsoft ADO format. Advantages of Using the AppXtender SDK Alone Each function may be performed in a variety of ways, providing more flexibility. A wider range of functions can be performed, such as annotating. (The EAI allows you to perform only the functions listed below.) The EAI allows you to perform many of the same functions as the AppXtender Application and Database automation interfaces: Connecting to AppXtender Creating a new document Showing or hiding the Applications view remotely 9

10 Database Layer Plug-in Setting search query criteria Running a search query Opening one or more documents Inserting a new index record Deleting an existing index record Deleting one or more documents Changing index values Obtaining AppXtender index fields Printing one or more documents Disconnecting from AppXtender More of the AppXtender SDK functions may be included in later releases of the EAI as requests are received from customers. Database Layer Plug-in Scripting ApplicationXtender has been enhanced with a COM automation-based functionality plug-in added to the AEX object model. Operations in both AppXtender and AppXtender Web Access invoke these objects, which may be used to control and monitor certain user activities. The plug-in is not invoked for bulk-object-based operations and the import utilities also do not utilize this plug-in. There are several integration points available: Query execution, which allows the user to modify the application query string before it is processed. Document access, which allows the user to deny access to an existing document. Document index update and deletion, which allow the user to prevent an index from being committed or deleted. Document deletion, which allows the user to prevent a document deletion or perform a function after it has been deleted. Document index creation, update, and deletion, which generate XML data. User authentication, which allows the user to configure security based on an existing system rather than on Documentum Content Management s CM security provider. The following sections describe each available scripting tool: 10

11 Scripting Buic Scanner MICR Output Script on page 11 The AppXtender Script Toolbar and Script Menu on page 11 Batch Import Helper on page 11 Rubber Stamp Editor on page 12 Annotation File Manipulation on page 12 Sample scripts are provided with the AppXtender SDK. For details, see Error! Reference source not found. on page Error! Bookmark not defined.. Buic Scanner MICR Output Script ApplicationXtender supports a script for Buic scanner MICR output. The method used takes one parameter consisting of the string of MICR code to be parsed. This method is called for every scanned check. You can set document index values from the parsed MICR string. Buic scanner scripting is not useful in batch mode, as each image must be manually indexed. An AppXtender Application object (which is already referenced) is exposed in the object model as the Application object. The AppXtender Script Toolbar and Script Menu The AppXtender Script toolbar and Script menu allow you to provide to the AppXtender user a convenient way to perform tasks in AppXtender. Your script may be written in VBScript or JScript. When writing or editing a script for the AppXtender scripting toolbar, you can debug your script using the Microsoft Script Debugger, Microsoft Visual Interdev, Visual Studio.NET, or Microsoft Script Editor. For information on VBScript, JScript, or the Microsoft Script Debugger, or to download the Microsoft Script Debugger, refer to Three objects are added to the global space of the scripting engine. They are the Application object, the ScriptToolbar object, and the ScriptMenu object. The Application object gives you full access to both the AppXtender Application and Database object hierarchy. The ScriptToolbar and ScriptMenu objects give you access to the properties and methods available for manipulating the code included in the script file. Batch Import Helper The Batch Import Helper, which is accessible through the AXTOOLS automation interface, provides a user interface for importing batch files into an AppXtender application. The complete source code (in C++) for the Batch Import Helper is provided. 11

12 The SDK for AppXtender Workflow Rubber Stamp Editor The RubberStampEdit control, which is accessible through the AXTOOLS automation interface, provides a user interface for creating or editing an XML string for a text rubber stamp annotation in AppXtender. Annotation File Manipulation Annotation files to be used in AppXtender may be manipulated in VB 6.0 by referencing the OTGAXV 1.0 type library. This type library allows you to use the properties, methods, and events contained in the Annotation object and the Annotations collection. A sample VB application that uses the OTGAXV 1.0 type library is provided with the AppXtender Automation SDK. For more information, see Annotations Sample on page 26. The SDK for AppXtender Workflow The SDK for AppXtender Workflow(AppXtender Workflow) provides access to the business services of AppXtender Workflow. Using the SDK, a developer can manipulate AppXtender Workflow to more closely meet the needs of the local users. This SDK was developed using COM, which provides developers with language-independent access to the services provided by the SDK. The SDK for AppXtender Workflow is laid out in a hierarchical manner with emphasis on reusable objects. Access to those objects and the data that they possess is dictated by the source. The top-level object is the IWfxSession object, which provides access to all of the other business objects. Workflow OCX The AppXtender Workflow OCX allows you to customize the items in the Action Pending dialog box of the Workbox. Sample VB scripts are provided that may be used to assist you with the customization of the Workbox. For more information, see AppXtender Workflow Samples on page 27. AppXtender Workflow Web Access Customizable Form Fields Component The customizable form fields component for AppXtender Workflow Web Access allows you to create unique data collection form fields. The customizable form fields component comes in two parts. One is a customized OCX that is installed on the AppXtender Web Access server. 12

13 Windows Management Information The other is an HTML document generated by the customized OCX at run time. The HTML document is inserted into the customizable form fields area on the client's browser. The types of data that are communicated between AppXtender Workflow Web Access and the customizable form fields component include the following items: Data that goes into the combo box to represent a list of Acts HTML document data that goes into the customized form fields Well-formed, valid XML document data Data exchanged through the Clipboard for index Copy/Paste, if Copy/Paste is supported The customizable form fields component must accomplish and support the following functionalities: Copy/Paste form data in a well-known XML format (optional) Given an Act, the ability to generate an HTML document that goes into the customized form fields area The ability to collect user input from the form fields The ability to commit user input The ability to generate an XML document for the Workflow server component to commit an Act. Windows Management Information Windows Management Instrumentation (WMI) is a component of the Microsoft Windows operating system that provides management information and control in an enterprise environment. WMI uses the Common Information Model (CIM) industry standard to represent system, applications, networks, devices, and other managed components. Applications that use WMI require Windows Server 2003, Windows XP, Windows Me, Windows NT, Windows 2000, Windows 98, or Windows 95 operating systems. Beginning with the 5.0 product release, WMI is used to monitor statistical information for the following: ApplicationXtender (AppXtender) ApplicationXtender Index Server (AppXtender Index Server) ApplicationXtender Reports Management (AppXtender Reports Mgmt) Report Processor and Print Stream Processor services ApplicationXtender Web Access (AppXtender Web Access) 13

14 Adding Toolbar Buttons ApplicationXtender Rendering Server (AppXtender Rendering Server) Definitions of classes and properties for all data retrieved are provided in MOF files for each of the three products (i.e., AppXtender, AppXtender Report Mgmt, and AppXtender Web Access). Additional information on WMI provided in the AppXtender SDK is a list of the class names and associated properties for which data are retrieved and how to retrieve WMI information using either the WMI CIM Studio tool or Microsoft's Scriptomatic utility. AppXtender SDK Usage Examples The following sections provide use case scenarios that illustrate how the AppXtender SDK has been used. Adding Toolbar Buttons In this example, a programmer for a government office was asked to add two toolbar buttons to the AppXtender Script toolbar. One of these toolbar buttons would run a specialized query and display the documents found. The other button would run a different query and export the documents found. He used the AppXtender scripting interface to add these buttons to the Script toolbar. (Keep in mind that the buttons on the AppXtender Script toolbar can be programmed to perform many other functions.) Improving a Custom Interface In this example, a law firm had a custom interface for members of the proposal development department. A programmer for this law firm was asked to make improvements to this custom interface for these users. These users receive proposals on paper. They needed to be able to scan these proposals into AppXtender and attach each of these AppXtender documents to a record using their custom interface. They wanted the programmer to add a toolbar button to the interface to allow the user to scan and automatically attach the resulting AppXtender document to the displayed record. The users did not want the entire AppXtender application to be viewed, so the programmer called the AppXtender View control to handle document display. The users also needed to full-text index each proposal document, so the programmer used the AppXtender scripting interface 14

15 Importing Images Importing Images and the AppXtender database automation interface to add a toolbar button that calls the function that automatically submits the document attached to that record for full-text indexing. In this example, the president of a data engineering software company had ten sites that needed to be able to quickly import new records into an AppXtender application, based on specified index values, paths, and file names. He did not want any dialog boxes to appear, such as for navigating to the file. They needed to import and index documents behind the scenes. He assigned this as a project to one of the programmers in the company. The programmer used the AppXtender database automation interface to handle the import. Image Enabling an Application and Allowing Full-Text Searches In this example, a programmer for a records management company wanted to allow users to store files in AppXtender and allow other users to retrieve them using the company s own records management application. In other words, the programmer wanted to image enable the records management application. In addition, she wanted the users to be able to run full-text searches from the records management application. The programmer used AppXtender database and application automation interfaces to handle the storage and retrieval of documents and the AppXtender View control to handle the display of the documents. Creating a Button to Display a Document In this example, an Oracle programmer for a state s department of health used the AppXtender SDK to improve the efficiency of an AppXtender system. His department uses AppXtender to scan documents for one of their application systems. The AppXtender software is installed on only a few workstations and is used only for this one application. The AppXtender software and the Oracle software are installed on the same workstations. When a new document is created, AppXtender automatically inserts the new record into an Oracle database and generates a document ID for the document in the database. This programmer has been asked to add a button to an Oracle form. This button, when clicked, must pass a document ID from the Oracle database 15

16 Collecting Audit Information for Hundreds of Documents to AppXtender and display that document, without displaying a search query window. The programmer installed the AppXtender SDK on the AppXtender workstations. This programmer is more familiar with Visual Basic than with C++, so he wrote Visual Basic code. In this code, the programmer created a dialog box that appears when a user clicks the new button on the Oracle form. This dialog box prompts the user for an AppXtender user name and password. After the user has provided these credentials, the code passes them along with startup commands, a document ID, an application name, the command to retrieve the document, and the command to display the document in AppXtender View. Collecting Audit Information for Hundreds of Documents In this example, a programmer for a health care automation software company wanted to find a way to generate a weekly report on new AppXtender documents that includes the page count and read/write status of each document. She knew that more than 1500 new AppXtender documents were created in her company every week. She used the AppXtender SDK to collect the information and purchased a separate reporting tool to generate a report from the collected information. The open architecture of the AppXtender database made it easier for her to accomplish this. Providing Document Access Through the Web AppXtender SDK Objects In this example, a programmer for a law firm wanted to provide document access through his firm s own interface and Web content management system. He created his own interface to provide dynamic criteria for querying the AppXtender Web Access system, and then used the AppXtender Web Access interactive client component for document display. This feature allows users to perform queries and get results from AppXtender Web Access without using the AppXtender Web Access Application List page or Search Fields Page. The query is manipulated by setting query string parameters. This section provides a brief description of each AppXtender SDK object. The following figure shows the hierarchy of collections (shown as 16

17 Providing Document Access Through the Web folders) and objects (shown as pages) in the AppXtender application automation interface and the AppXtender database automation interface. Application Object Windows Toolbar Documents Window UIDataSources Scanner Document UIAppl UIAppls UIDataSource Options Panes UIQueries UIQuery Results Pane Queues Connection AXPID Bulkload Apps Queue Jobs Query QueryResults Queries QueryResult App Bulkload Job JobElements ObjectFile JobElement Docs Batches Fields DocRevisions DocRevision Pages Page Doc DocIndexes DocIndex Batch BatchPages Field BatchPage PageVersions PageVersion Signatures Signature Figure 2 Relationships between Objects and Collections 17

18 AppXtender Application Automation Interface Objects AppXtender Application Automation Interface Objects Some of the basic functions that are available with the AppXtender application automation interface objects are as follows: Application Object: This object is the parent object that controls the navigation through the application hierarchy. Methods are available with this object to log a user into or out of AppXtender Workflow, open an AppXtender document, print a list of documents, and quit the application, plus various other functions. Document Object: This object represents an AppXtender document. Methods available with this object control the display of the Index view, create a document by indexing a batch, index a document, manipulate a document s index records, or submit a document to a queue for OCR or full-text processing, plus various other functions. Options Object: This object allows you to configure many of the same settings that can be configured on various tabs of the AppXtender Configuration dialog box. Pane Object: The properties available with this object return information relevant to a pane. Scanner Object: The methods available with this object set the scanner scan area and start the scan operation. Toolbar Object: The methods available with this object set or return the state of the specified toolbar. UIAppl Object: The methods available with this object create a batch for importing files; open a specified batch in AppXtender and index it; return either an existing or a new, unindexed AppXtender Document object (or optionally a HIPAA-compliant Document object); or print a specified list of documents. UIDataSource Object: The methods available with this object log a user into AppXtender; log into a configured data source; print a specified list of documents; or log the user off from AppXtender. UIQuery Object: The UIQuery object represents an AppXtender document search query. The methods available activate the query object; add or remove a query criteria column; set or return the data value for the specified query column or query field at the specified query criteria column; execute the query; save changes to the current query; or close the query. UIWfxAct Object: The methods available with this object set or return the Name property value, cancel an act, or commit an act. Window Object: The methods available with this object activate or close the window. 18

19 AppXtender Database Automation Interface Objects AppXtender Database Automation Interface Objects Some of the basic functions that are available with the AppXtender database automation interface objects are as follows: AexUser Object: This object represents an AppXtender user. App Object: This object represents an AppXtender application. The methods available with this object return AppXtender Auto Index or Key Reference results; remove a specified AppXtender Auto Index entry or all AppXtender Key Reference entries; return a BulkLoad object for the DT or DL table; return a resource token string for a specified document ID; validate a list of rubber stamp IDs in the database; return a RubberStamps collection object; determine whether a specified permission type has been granted; return the first available ID for one or more new application objects, documents, or batches; update the path ID or annotation path ID in the application page location table; or validate whether the application is HIPAA compliant. AuditEventLog Object: The method available with this object logs an audit event into the database and log file with an event ID, an application ID, a document ID, and an event description. This object allows you to audit all of the Audit Trail settings available in AppXtender AppGen. AXPID Object: The methods available with this object check whether a processing state (or states) for an AppXtender application is active; and set, delete or update an AppXtender application's processing state. The state may be set to any of 40 different states, including Idle. Batch Object: This object represents a batch. The methods available with this object change the class ID or the ownership of a batch; delete a Batch object and all of its pages from the database; update a Batch object's properties from the database; or rename a batch and its group. BatchPage Object: This object represents a page in a batch. The methods available add the current page to the specified document or delete a page from the batch. When deleting a batch page, this method checks whether the file is shared by either the other batch pages or in page versions in the same application. BulkLoad Object: The methods available with this object bulk load one specified row of data or finish the bulk loading. CXReport Object: This object represents a CX or AppXtender Reports Mgmt report. The methods available return documents associated with the specified page of the report or delete the report. 19

20 AppXtender Database Automation Interface Objects CXReportPage Object: This object represents a page of a CX or AppXtender Reports Mgmt report. (Each report contains one or more report segments and each report segment contains one or more report pages.) CXReportSeg Object: This object represents a segment of a CX or AppXtender Reports Mgmt report. Connection Object: This object implements a single ApplicationXtender database connection. Multiple DbConnection objects can be used to interface with multiple AppXtender databases. The methods available with this object log into or out of the AppXtender database; log into or out of the AppXtender Workflow Server system; retrieve or set a configuration entry from the AE_CFG table; create a BulkLoad object for a specified database table; execute a Structured Query Language statement; return a data source specified by the resource token string; determine whether a specified permission type has been granted; load the base registry key for DX connectivity settings; create an object of the specified type (application, document, page, or version); output the results of a cross-application query (CAQ) in XML format to a specified file; or perform several other functions. Doc Object: This object implements an AppXtender document. The methods available with this object determine whether a specified permission type has been granted; determine whether a document has an index; add an empty index to a document; add a new page or sub-page to a document; determine whether a document has been versioned; determine whether a document is checked out; cancel checked-out status for the document; check in or check out the document; return the latest revision of the document; delete the current revision of a document and reset the previous version to the current version; delete the document; or perform a variety of other functions. DocIndex Object: This object implements an AppXtender index record. The methods available with this object determine whether document-level security allows access; return the number of index records in the database with the same set of index field values as the current index record; allow for retrieval of an index value that exists only in the Key Reference table; validate an index field; delete the index record; and commit changes made to index fields to the database. DocRevision Object: This object implements an AppXtender document revision. The method available with this object deletes this document revision from the repository. 20

21 AppXtender Database Automation Interface Objects Field Object: This object implements an AppXtender index field. The methods available convert a field value from display format to internal database format or vice versa; or validate a field value and format it if necessary. FormOverlay Object: This object implements a COLD form overlay. The method available with this object commits changes made to form parameters to the database. Job Object: This object implements an OCR or full-text processing job. The methods available with this object submit the job to a processing queue; start processing the job; mark the job as finished or in error; or delete the job. JobElement Object: This object implements an element of a processing job. ObjectFile Object: This object implements a file I/O interface for an AppXtender object file. The methods available with this object copy a specified file to the object file, copy the object file to a specified file, delete the object file, generate the object file name, or return a string containing information for retrieving a Minolta COLD object. Page Object: This object implements a document page. The methods available add a new version to the page, add a new version with the specified object file settings to the page, or delete the page. PageVersion Object: This object implements a document page version. The methods available with this object update the page version annotation, remove annotations from a page version, or delete the page version. Query Object: This object implements a search query. The methods available allow you to build a search query by setting the query name, CAQ query attribute for a specific index field, index value for a specific index field and query column, full text search criteria, operator to join full text and basic search, ODMA field value for a specific index field and query column, or SQL query statement. A variety of other functions are also available. QueryResult Object: This object implements a single row in a query result set. Queue Object: This object implements a processing queue for OCR jobs, full-text indexing jobs,or Image Print Server (IPS) jobs. The methods available with this object pause the queue, lock or unlock the queue, or delete the queue from the AppXtender database. Queue2 Object: The methods available with this object return the next available Job object in the queue with the WAITING status or delete a specified queued job. 21

22 AppXtender View OCX Control RubberStamp Object: This object implements a rubber stamp annotation. Signature Object: This object implements a single digital signature on a page version. AppXtender View OCX Control AppXtender View OCX is an ActiveX control designed to display and manipulate images. The methods available with this object allow you to perform annotation, annotation group, COLD form overlay, display, magnifier, OCR, OLE object, printing, text highlight, Windows Clipboard, and other tasks. Annotation Object The annotation COM object allows you to load, create, manipulate, and store AppXtender annotation files. The properties and methods available with this object return the annotation type; return the annotation create time or the time the annotation was last modified; return the user name of the person who created or who last modified the annotation; return or set a coordinate of the annotation; add a logical point at specific left and top coordinates for polygon, polyline, or freehand line annotation types; return or set the fill state for the annotation; return or set the redaction state for the annotation; return or set the foreground or background (fill) color of the annotation; return or set the line width for the annotation; and perform various other functions. Enterprise Application Interface Objects The following functions are available with each AppXtender Enterprise Application Interface object: AxIndexData: This object is a single index placeholder used to send and receive data between AXEAI Business Service and the AxAccess object. AxAccess: This is the main object that is used to access AppXtender Automation. Most of the methods of this object use AxIndexData to receive data from the AXEAI Business Service. AxUIRemote: This object controls the behavior of the AppXtender user interface based on nine property values. 22

23 Scripting Objects Scripting Objects The following objects provide a variety of functionality related to scripting: ScriptToolbar Object: The sub declarations, properties, and methods available with the ScriptToolbar object specify the bitmap for the script toolbar, return or set the toolbar visibility state, enable or disable the specified button in a toolbar control, specify the text for a particular toolbar button's tool tip, or initiate the code that should be executed when a specific toolbar button is clicked. ScriptMenu Object: The sub declarations and methods available with this object load one or more new script menus, create a new menu in the AppXtender menu bar, add an item to a new menu, add a separator line between menu items, enable or disable a menu item, or initiate the code that should be executed when the specified menu item is selected from the menu. Batch Import Helper: The key methods and functions of the Batch Import Helper take the batch file, sequence the batch import process, and create a log file to record key information about the batch import process; prompt the user to select batch file names through a standard file open dialog and then continue the import file process; create the Batch object for the current batch file; start the process of adding a batch page; take a batch page file, generate a new file name, get the path ID and the object ID, and input the file into the database table; add a specified foreign file as a batch page file; open the file and examine the file's pages; save the batch pages and add them to the database table; and close the Batch object. Rubber Stamp Editor: This method either validates all the user interface values and generates the new XML string of the rubber stamp or initializes the control user interface with the settings in the XML string from the property. AppXtender Workflow Objects Some of the basic functions that are available with the AppXtender Workflow SDK objects are as follows: IWfxDataField Object: This object is a generic AppXtender Workflow data field that does not pertain to a workflow instance. 23

24 AppXtender Application Automation Interface Samples IWfxDocNotify Object: This object provides a means to notify AppXtender Workflow when a document is being added or deleted from AppXtender. The methods available with this object start a new or existing business process; start a transaction for creating business processes based on the AppXtender application provided and identify all business process definitions that are linked to the application; commit the current transaction or a range of transactions; notify AppXtender Workflow that an AppXtender document has been deleted and delete all references to the document except business processes; and roll back all of the transactions that have not been committed. IWfxFormField Object: The method available with this object verifies that the data provided is valid. IWfxSession Object: This interface provides access to all of the functionality provided by AppXtender Workflow. The methods available with this object determine whether the user is valid, log the user into the AppXtender Workflow server, log into the AppXtender Workflow Server without connecting to License Server, change the password for the current user, commit the acts for an item using XML, commit a business process using XML, log the user out of the AppXtender Workflow server, and log out of the AppXtender Workflow Server without disconnecting from AppXtender License Server. AppXtender SDK Code Samples This section describes each of the code samples provided with the AppXtender SDK. AppXtender Application Automation Interface Samples Purpose The following table describes each of the samples provided for the AppXtender application automation interface: Table 9 Connecting and Logging In to AppXtender Controlling the User Interface AppXtender Application Automation Interface Samples Description Opens the standard AppXtender login dialog box for the user to enter a username and password. Passes the username and password to AppXtender through a custom form. Controls the size and positioning of the window, the presence of toolbars, and the presence of the Application, Query, and AppXtender Workflow window bars. 24

25 AppXtender Database Automation Interface Samples Purpose Querying an Application Using the Result Set Manipulating a Document Closing AppXtender Description Runs a new query on a specified application. Returns all documents contained within the application. Runs a saved query on a specified application. Returns all documents contained within the application that match the specific query criteria in the saved query. Runs a saved query, selects and displays all documents in the result set, maximizes the application window, and then arranges the windows (from result set) as tiled horizontally within the application window. Runs a saved query and then opens and displays the first item of the result set. Runs a saved query, opens a document from the result set, and then rescales the document image to fit the AppXtender window. De-references any AppXtender objects referenced in code statements and closes AppXtender. AppXtender Database Automation Interface Samples Purpose The following table describes each of the samples provided for the AppXtender database automation interface: Table 10 Connecting and Logging In to the AppXtender Database Retrieving a List of AppXtender Applications Accessing an AppXtender Application's Fields Accessing Existing Documents Creating a New Document Copying Files into or out of AppXtender Displaying and Manipulating Foreign Files AppXtender Database Automation Interface Samples Description Does not require a user interface. Creates the Connection object and completes the login process with the Login method. Sub procedure may be used to log in to the AppXtender Workflow database Retrieves the names of all AppXtender applications for the current data source and then lists them in a combo box. Returns the collection of fields for the named AppXtender application. Documents, pages, and indexes may be accessed. You must know either the document ID or the 1-based index number of the desired document. Adds a new document, its indexes and its pages to the AppXtender database. Copies native files supported by AppXtender either into or out of AppXtender. Attempts to open a file as an image and then, if that fails, opens it as a foreign file. It then uses the Viewer control to save the file to the destination. 25

26 Annotations Sample Purpose Querying an Application Logging Off from the AppXtender Database Description Runs a query on two different values. Sorts the result set into two columns according to the two query values. Includes a commented code statement to search on a value in the database ODMA Author field. Sorts the result set in ascending order according to each document's ID. Runs a query on one field name and one field value. Sorts the result set in ascending order according to each document's ID. Runs a specified stored query for a specified application Releases all objects and logs off the connection to the AppXtender database. Annotations Sample A Visual Basic sample is provided to demonstrate the AppXtender Annotations object. You can use this sample to perform each of the following functions: Loading and saving annotation files Creating a new annotation, including a rubber stamp annotation Navigating through a file of annotations Editing an annotation Deleting an annotation Enterprise Application Interface Sample A sample AXEAI application demonstrates the basic functionality of AppXtender, such as the following: Retrieving a result set Adding a new document Opening one or more documents Displaying a document in AppXtender Printing one or more documents Deleting one or more documents Creating a new index record for an existing document Deleting an index record Updating an index record 26

27 Buic Scanner MICR Output Script Samples Buic Scanner MICR Output Script Samples To facilitate using the Buic scanner script, sample scripts are provided, which perform the following functions: A sample Visual Basic application for testing a script for use with the Buic scanner and AppXtender. A sample VBScript file that is designed to be used with the CHECKS application in the AppXtender Demo database. The script extracts the routing, account, and check numbers from the bottom of the check and then writes the account number and check number to the associated index fields in the CHECKS application. An AppXtender Scripting file (in VBScript) for the AppXtender Script Toolbar that specifies the toolbar button to be used and includes the script necessary to initiate the Buic scanner script when the button is clicked. It also automatically saves the index information for the previously scanned check before scanning the next check. AppXtender Workflow Samples The AppXtender Workflow OCX allows you to customize the items in the Action Pending dialog box of the Workbox. The following sample VB scripts may be used to assist you with the customization of the Workbox: One sample may be used to support scrolling within the window. A customization note is provided within the script. Another is an actual sample of a custom control. The script is heavily commented to assist you with your own customization. A third sample duplicates the basic functionality of the AppXtender Workflow workbox OCX. A document is included that outlines the basic functionality and the associated AppXtender Workflow and AppXtender object models required to implement each function. 27