opentext applicationxtender connector - fairmont state ......installingandupgradingthesoftware 3....

OpenText™ ApplicationXtenderConnectorVersion 16.3

Administrator's Guide

Legal Notice

This documentation has been created for software version 16.3.It is also valid for subsequent software versions as long as no new document version is shipped withthe product or is published at https://knowledge.opentext.com.

Open Text Corporation

275 Frank Tompa Drive, Waterloo, Ontario, Canada, N2L 0A1

Tel: +1-519-888-7111Toll Free Canada/USA: 1-800-499-6544 International: +800-4996-5440Fax: +1-519-888-0677Support: https://support.opentext.comFor more information, visit https://www.opentext.com

Copyright © 2017 Open Text. All Rights Reserved.

Trademarks owned by Open Text.

Adobe and Adobe PDF Library are trademarks or registered trademarks of Adobe Systems Inc. inthe U.S. and other countries.

Disclaimer

No Warranties and Limitation of Liability

Every effort has been made to ensure the accuracy of the features and techniques presented in thispublication. However, Open Text Corporation and its affiliates accept no responsibility and offer nowarranty whether expressed or implied, for the accuracy of this publication.

https://knowledge.opentext.com/https://support.opentext.com/https://support.opentext.com/https://www.opentext.com/

Table of Contents

Preface ................................................................................................................................. 7

Chapter 1 Overview of the AppXtender Connector Workflow ....................................... 9

Chapter 2 Installing and Upgrading the Software ........................................................ 11Installing and upgrading AppXtender Connector ............................................... 11Installing AppXtender Connector .................................................................. 11Repairing an Installation ............................................................................... 12Uninstalling AppXtender Connector ............................................................. 12Upgrading from 8.1 to 16.3 ............................................................................ 13

Installing and upgrading AppXtender Connector Document Writer..................... 13Installing AppXtender Connector Document Writer........................................ 13Repairing an installation ............................................................................... 14Uninstalling AppXtender Connector Document Writer ................................... 14Upgrading from 8.1 to 16.3 ............................................................................ 14

Installing and upgrading AppXtender Connector Web BrowserInteraction Tool ................................................................................................ 15Installing AppXtender Connector Web Browser Interaction Tool...................... 15Repairing an installation ............................................................................... 16Uninstalling AppXtender Connector Web Browser Interaction Tool ................. 16Upgrading from 8.1 to 16.3 ............................................................................ 16

Chapter 3 Configuring the Software ............................................................................ 19End-user configuration privileges ...................................................................... 19Configuring general information ....................................................................... 20Integrating with Windows NT security .............................................................. 21Configuring toolbar buttons .............................................................................. 22Creating a toolbar button .............................................................................. 22Editing a toolbar button ................................................................................ 22Deleting a toolbar button .............................................................................. 23Reordering toolbar buttons ........................................................................... 23

Configuring tasks ............................................................................................. 23Creating a task ............................................................................................. 24Configuring extension options....................................................................... 26Editing a task ............................................................................................... 27Deleting a task.............................................................................................. 27Changing the task priority ............................................................................ 28

Capturing data ................................................................................................. 28Capturing data from imported content........................................................... 29Capturing data by scraping content ............................................................... 29Capturing data from the Microsoft Windows clipboard................................... 30Capturing data in a Microsoft Windows application ....................................... 31Capturing data in a web browser ................................................................... 32Using the AppXtender Inspector toolbar ........................................................ 33Capturing data in a terminal emulator ........................................................... 33

3

Table of Contents

Extracting data ............................................................................................. 34Formatting data............................................................................................ 35Configuring a capture routine ....................................................................... 35

Configuring extensions ..................................................................................... 37Adding an extension assembly ...................................................................... 37Deleting an extension assembly ..................................................................... 37Rescanning the Extension folder .................................................................... 37

Configuring OCR ............................................................................................. 38Configuring AppXtender Connector Document Writer ....................................... 39Configuring multiple terminal sessions ............................................................. 39Creating a virtual printer .............................................................................. 40Configuring Citrix XenApp ........................................................................... 40

Installing KeyView Viewer on an end-user workstation ...................................... 41Allowing end users to append pages ................................................................. 41Importing a configuration file............................................................................ 41Exporting the configuration............................................................................... 42

Chapter 4 Searching for Content ................................................................................. 43Creating a query task ........................................................................................ 43Modifying the document index ......................................................................... 45Submitting a document to a full text index server from query results ................... 46Sending a document by email from query results................................................ 47Exporting a document from query results .......................................................... 47Viewing search results in the document viewer .................................................. 47Fixing display problems................................................................................ 48

Chapter 5 Importing Documents .................................................................................. 49Importing from a file......................................................................................... 49Importing from the Microsoft Windows clipboard .............................................. 50Importing by screen scraping ............................................................................ 50Importing from a scanner.................................................................................. 50Importing a drop file......................................................................................... 51Printing a document into AppXtender ............................................................... 51Importing a document ...................................................................................... 52Importing a new document ........................................................................... 52Replacing an element.................................................................................... 52Importing a new element .............................................................................. 53Importing a new element version................................................................... 53

Chapter 6 Extending the Software ............................................................................... 55Understanding extensions................................................................................. 55Creating a new extension .................................................................................. 56Understanding the extension interface ............................................................... 56ICapture ...................................................................................................... 56Capture(parameter) .................................................................................. 56GetParameterNames()............................................................................... 57

ICondition ................................................................................................... 57IsConditionMet(parameter)....................................................................... 57GetParameterNames()............................................................................... 58

IPreProcessing.............................................................................................. 58

4

Table of Contents

BeforeOperation(parameter)...................................................................... 59GetParameterNames()............................................................................... 59

IPostProcessing ............................................................................................ 59AfterOperation(parameter) ....................................................................... 60GetParameterNames()............................................................................... 60

Deploying extensions........................................................................................ 61Extension samples ............................................................................................ 61SimpleStringCondition ................................................................................. 61CaptureFromDatabase .................................................................................. 61PreprocessingSample .................................................................................... 62PostprocessingSample................................................................................... 62

Chapter 7 Deploying AppXtender Connector ............................................................... 63Creating an AppXtender Connector Deployment package................................... 63Specifying deployment package properties ........................................................ 64Publishing the deployment package .................................................................. 65Updating the AppXtender Connector deployment package ................................. 66Upgrading from 8.1 to 16.3 ................................................................................ 66

Appendix A AppXtender Connector XML Structure ........................................................ 67

Appendix B Import File Formats ..................................................................................... 75

5

Table of Contents

List of Tables

Table 1. AppXtender Connector XML Structure .................................................................. 68

6

Preface

This guide describes:• How to install, administer, and configure ApplicationXtender Connector (AppXtender Connector)

• How to install and configure ApplicationXtender Connector Document Writer (AppXtenderConnector Document Writer)

AppXtender Connector provides seamless integration between AppXtender and third-partyapplications. It enables you to capture index information from external sources and use the capturedindex information to perform AppXtender content management operations.

AppXtender Connector Document Writer provides third-party printing integration capabilities. Itsaves documents to PDF or TIFF formats and launches AppXtender Connector tasks.

Intended audienceThis guide provides information for the AppXtender Connector administrator. The administrator isusually responsible for installing and administering AppXtender Connector. Administrators havefull access to all AppXtender Connector functions and configuration options.

This guide also provides information for end users who use the AppXtender Connector deployment.End users have limited access to configuring the software but can perform import and query tasks,and can associate those tasks with custom toolbar buttons and hotkeys. For information about enduser configuration privileges, see End-user configuration privileges, page 19. Administrators canoverride custom toolbar buttons and hotkeys during new application deployments.

This guide assumes that you are familiar with OpenText ApplicationXtender.

In addition to this guide, the documentation set for AppXtender Connector includes:

• OpenText ApplicationXtender Connector Release Notes

Detailed configuration and use procedures for AppXtender Connector are available as online help.

7

Preface

Revision historyThe following table lists changes in this guide:

Revision date Description

April 2013 Initial publication

December 2017 16.3 release

8

Chapter 1Overview of the AppXtender ConnectorWorkflow

Administrators can meet their business goals with AppXtender Connector by consulting thefollowing high-level workflow.

1. Install AppXtender Connector and AppXtender Document Writer.

2. Configure AppXtender Connector.

a. AppXtender Connector uses an Optical Character Recognition (OCR) engine to convertregions of the screen or documents to text. Decide whether to run the OCR engine on eachend user machine or on a separate OCR server.

b. Define a query or import task.

c. Configure the task. One way to do this configuration is by configuring a capture routine toextract data automatically.

3. Test the configured tasks. For example, perform a search or import a document, running all of thecapture routines you have defined for each task you have configured.

4. Use Deployment Manager to create and publish deployment packages for each end user group.

9

Overview of the AppXtender Connector Workflow

10

Chapter 2Installing and Upgrading the Software

This chapter explains how to install and upgrade AppXtender Connector and AppXtender ConnectorDocument Writer and is intended for administrators.

This chapter includes the following topics:

• Installing and upgrading AppXtender Connector, page 11

• Installing and upgrading AppXtender Connector Document Writer, page 13

• Installing and upgrading AppXtender Connector Web Browser Interaction Tool, page 15

Before you begin the installation, ensure that your system meets the requirements listed in theOpenText ApplicationXtender Connector Release Notes.

Installing and upgrading AppXtenderConnectorThis section includes the following topics.

• Installing AppXtender Connector, page 11

• Repairing an Installation, page 12

• Uninstalling AppXtender Connector , page 12

• Upgrading from 8.1 to 16.3, page 13

Installing AppXtender Connector

A full AppXtender Connector installation requires up to 870 MB of hard disk space (depending onyour operating system). To minimize hard disk usage, you can select specific features to install.

Microsoft .NET Framework 4.5 and Microsoft Visual C++ 2013 and 2015 Redistributable Package (x86)are required third-party components for AppXtender Connector. If you have not installed thesethird-party components, a message appears during the installation process that prompts you toinstall. In the future, if you decide to uninstall AppXtender Connector, uninstall these third-partycomponents separately.

1. Close all open applications.

11

Installing and Upgrading the Software

2. Obtain the installation files for AppXtender Connector.

3. Go to the ApplicationXtender Connector directory and run setup.exe.

4. Follow the wizard to install the AppXtender Connector. Consider the following points:• If the required third-party components have not been installed, the Installation Requirementspage appears. Click Install.

• Read the license agreement. You can also print it for future reference.

• You can specify the directory where you want to install AppXtender Connector.

• You can choose a complete or custom installation.

5. If you select a custom installation, select which features you want to install, as described inthe following table:

Feature Description

AppXtenderConnector

Installs the main AppXtender Connector files.

Deployment Manager Installs a tool that enables administrators to create and publish anAppXtender Connector deployment package.

Web BrowserInteraction Tool

Installs an Internet Explorer add-on that enables the administrator toconfigure the method of selecting and capturing data from InternetExplorer. This tool includes the Inspector toolbar.

Visual Studio 2010Templates

Installs Visual Studio 2010 project templates that you can use to createAppXtender Connector custom extensions. This feature is availableonly when Visual Studio 2010 is installed on your computer.

OCR Service Installs the OCR service for AppXtender Connector.

KeyView Viewer Installs KeyView Viewer for displaying AppXtender foreign files.

Repairing an Installation

If AppXtender Connector files or registry keys have been deleted, you might have to repair theinstallation.

1. Close all AppXtender components and ensure that the AppXtender Connector OCR Serviceis not running.

2. From the Microsoft Windows Control Panel, select Programs > Programs and Features.

3. From the program list, select AppXtender Connector and click Repair.

Uninstalling AppXtender Connector1. Close all AppXtender components and ensure that the AppXtender Connector OCR Service

is not running.


12


3. From the program list, select AppXtender Connector and click Uninstall.

4. Click Yes to confirm.

Upgrading from 8.1 to 16.3

Before upgrade, the system backs up the configuration file AXConnectorShell.xml under thefolder %ProgramData%\ApplicationXtender\AXConnector. After upgrade, the systemrestores the configuration file.


2. Obtain the installation files for AppXtender Connector.

3. Go to the ApplicationXtender Connector directory and run setup.exe.

4. Follow the wizard to upgrade the AppXtender Connector. Consider the following points:• If the required third-party components have not been installed, the Installation Requirementspage appears. Click Install.

• When the upgrade warning page appears, click Next.

• You can specify the directory where you want to install AppXtender Connector.

• You can choose a complete or custom installation.

5. If you select a custom installation, select which features you want to install, as described inInstalling AppXtender Connector, page 11.

Installing and upgrading AppXtenderConnector Document WriterThis section includes the following topics.

• Installing AppXtender Connector Document Writer, page 13

• Repairing an installation, page 14

• Uninstalling AppXtender Connector Document Writer, page 14

Upgrading from 8.1 to 16.3, page 14

After you install AppXtender Connector Document Writer, you can configure its port and choosewhether to print content to PDF or TIFF files.

Installing AppXtender Connector Document Writer

A full AppXtender Connector Document Writer installation requires up to 17 MB of hard disk space(depending on your operating system).

13


Microsoft .NET Framework 4.0 is a required third-party component for AppXtender ConnectorDocument Writer. If you have not yet installed this third-party component, a message appearsduring the installation process that prompts you to install it. In the future, if you decide to uninstallAppXtender Connector Document Writer, uninstall this third-party component separately.

1. Obtain the installation files for AppXtender Connector Document Writer.

2. Go to the Document Writer directory and run setup.exe.

3. Follow the wizard to install the AppXtender Connector Document Writer. Consider the followingpoints:• If the required third-party component has not been installed, the Installation Requirementspage appears. Click Install.


• You can specify the directory where you want to install AppXtender Connector DocumentWriter.

• After the system installs the print driver, the system copies the files in the destination folder tothe Microsoft Windows System folder. The system uses these files only during the installation.

• If a security warning appears, click Install this driver software anyway.

Repairing an installation

If AppXtender Connector Document Writer files or registry keys have been deleted, you mighthave to repair the installation.


2. From the program list, select AppXtender Connector Document Writer and select Repair.

Uninstalling AppXtender Connector Document Writer1. From the Microsoft Windows Control Panel, select Programs > Programs and Features.

2. From the program list, select AppXtender Connector Document Writer and click Uninstall.


Upgrading from 8.1 to 16.31. Make sure that there are no print jobs in the AppXtender Connector Document Writer virtual

printer. If there are any print jobs, wait until the jobs are finished or restart the windows PrintSpooler service manually.


3. Obtain the installation files for AppXtender Connector Document Writer.

4. Go to the Document Writer directory and run setup.exe.

14


5. Follow the wizard to upgrade the AppXtender Connector Document Writer. Consider thefollowing points:• If the required third-party components have not been installed, the Installation Requirementspage appears. Click Install.


• You can specify the directory where you want to install AppXtender Connector DocumentWriter.

• After the system installs the print driver, the system copies the files in the destination folder tothe Microsoft Windows System folder. The system uses these files only during the installation.


Installing and upgrading AppXtenderConnector Web Browser Interaction ToolThis section includes the following topics.

• Installing AppXtender Connector Web Browser Interaction Tool, page 15

• Repairing an installation, page 16

• Uninstalling AppXtender Connector Web Browser Interaction Tool, page 16

• Upgrading from 8.1 to 16.3, page 16

Installing AppXtender Connector Web BrowserInteraction Tool

A full AppXtender Connector Web Browser Interaction Tool installation requires up to 8 MB of harddisk space (depending on your operating system).

Microsoft .NET Framework 4.0 is a required third-party component for AppXtender ConnectorWeb Browser Interaction Tool. If you have not yet installed this third-party component, a messageappears during the installation process that prompts you to install it. In the future, if you decide touninstall AppXtender Connector Web Browser Interaction Tool, uninstall this third-party componentseparately.

1. Obtain the installation files for AppXtender Connector Web Browser Interaction Tool.

2. Go to the Web Browser Interaction Tool directory and run setup.exe.

3. Follow the wizard to install the AppXtender Connector Web Browser Interaction Tool. Considerthe following points:• If the required third-party component has not been installed, the Installation Requirementspage appears. Click Install.


15


• You can specify the directory where you want to install AppXtender Connector Web BrowserInteraction Tool.


Repairing an installation

If AppXtender Connector Web Browser Interaction Tool files or registry keys have been deleted, youmight have to repair the installation.


2. From the program list, select AppXtender Connector Web Browser Interaction Tool and selectRepair.

Uninstalling AppXtender Connector Web BrowserInteraction Tool1. From the Microsoft Windows Control Panel, select Programs > Programs and Features.

2. From the program list, select AppXtender Connector Web Browser Interaction Tool and clickUninstall.


Upgrading from 8.1 to 16.31. Close Microsoft Internet Explorer browser.


3. Obtain the installation files for AppXtender Connector Web Browser Interaction Tool.

4. Go to the Web Browser Interaction Tool directory and run setup.exe.

5. Follow the wizard to upgrade the AppXtender Connector Web Browser Interaction Tool.Consider the following points:• If the required third-party components have not been installed, the Installation Requirementspage appears. Click Install.


16


• You can specify the directory where you want to install AppXtender Connector Web BrowserInteraction Tool.


17


18

Chapter 3Configuring the Software

This chapter explains some fundamental concepts and procedures for configuring AppXtenderConnector and is intended primarily for administrators. If you are an end user, rather than anadministrator, for information about conditions under which you can customize your deployment ofAppXtender Connector, see End-user configuration privileges, page 19.


• End-user configuration privileges, page 19

• Configuring general information, page 20

• Integrating with Windows NT security, page 21

• Configuring toolbar buttons, page 22

• Configuring tasks, page 23

• Capturing data, page 28

• Configuring extensions, page 37

• Configuring OCR, page 38

• Configuring AppXtender Connector Document Writer, page 39

• Configuring multiple terminal sessions , page 39

• Installing KeyView Viewer on an end-user workstation, page 41

• Allowing end users to append pages, page 41

• Importing a configuration file, page 41

• Exporting the configuration, page 42

End-user configuration privilegesAdministrators can configure AppXtender Connector to allow end users to customize theirdeployment of AppXtender Connector. Administrators have full control of each deployment andcan configure whether end users can create and modify toolbar buttons and tasks. End users cannotdelete the toolbar buttons or tasks that administrators have created.

When administrator changes overlap end-user changes, a new AppXtender Connector deploymentcan impact toolbar buttons and tasks.

19

Configuring the Software

New AppXtender Connector deployments overwrite custom toolbar buttons or tasks when the enduser modifies the original toolbar buttons or tasks and then the administrator updates the sametoolbar buttons or tasks in a new deployment.

Note: To avoid a new deployment overwriting custom toolbar buttons or tasks, it is recommendedthat you create new toolbar buttons or tasks, rather than modify the originals.

If a new deployment includes toolbar buttons or tasks with the same names as the ones the end usercreated, the system renames the ones the end user created.

If a new deployment does not duplicate the toolbar buttons and tasks the end user created, thosetoolbar buttons and tasks remain in the new deployment.

End users can view the configuration of other AppXtender Connector features but cannot modifythem.

Configuring general informationAppXtender Connector is a client application that communicates with AppXtender web services,which administrators can configure by including the web services URL. Administrators can alsoenable or disable scanning from within AppXtender Connector and show or hide common propertiesduring AppXtender Connector operations.

1. Click the Configure button.

2. Select the General Info tab.

3. Set the Web Services URL value to your AppXtender web service. The default URL ishttp://localhost/AppXtender.

4. Click next to the Scan Feature option to enable or disable scanning in AppXtender Connector.

5. Click next to the Common Properties During Operations option to show or hide commonproperties during AppXtender Connector operations.

6. Click next to the KeyView Viewer For Import Wizard option to enable or disable the display ofthe contents of foreign files (such as MSG) when importing documents. The KeyView Viewercomponent must be installed in the workstation.

7. Click next to the Close The Running Task Automatically option to enable or disable theautomatic closure of running tasks when an end user starts a new task. If the currently runningtask displays a dialog box or a message box, the system does not close this task automatically.

8. Next to User Privilege On Tasks, specify which privileges you want to assign to end user tasks:• If you want end users to be able to create tasks, select Create.

• If you want end users to be able to modify any tasks and change the priority of tasks, selectModify.

Even if you allow end users to modify tasks, end users cannot change the name of tasks createdby the administrator.

20


9. Next to User Privilege On Buttons, specify which privileges you want the end users to haveon toolbar buttons:• If you want end users to be able to create toolbar buttons, select Create.

• If you want end users to be able to modify any toolbar buttons, selectModify.

Even if you allow end users to modify toolbar buttons, end users cannot change the name ofany toolbar buttons.

10. Select Automatically Submit New Documents For Full Text Index to enable or disable full-textindexing on new documents at the end of each import task. The system submits importeddocuments to the first processing queue in the AppXtender Index Server configuration.The first queue can be a full-text indexing queue or an OCR queue. Make sure the first queue isthe type that you want to use with this option.

11. Click OK.

Integrating with Windows NT securityYou can integrate AppXtender Connector with Windows NT security so that end users can log into each data store with their current Windows NT account. An AppXtender Connector data storecorresponds to an AppXtender data source.

1. Configure AppXtender Connector:

a. Click .

b. Select the General Info tab.

c. Select Integrated With Windows NT Security option to enable or disable the integration.When this option is enabled, the User Name and Password fields are disabled in the AppXtenderConnector Login dialog box.

2. Configure ApplicationXtender Administrator (AppXtender Admin):

a. In the tree, expand the Environment node and select Data Sources.

b. In the configuration for each data source, set the Security Model toWindows Security.

c. Expand theWeb Services node and select Security.

d. Clear the Users may access the server via Anonymous user account option.

3. Configure end user accounts:

a. Add the Windows NT accounts to a domain.

b. In ApplicationXtender Administrator (AppXtender Admin), add the Windows NT accountsas AppXtender users. For instructions, see OpenText ApplicationXtender Core ComponentsAdministrator's Guide.

21


Configuring toolbar buttonsWhen an administrator first installs AppXtender Connector, the toolbar includes two buttons. Onelaunches an adhoc import task and the other launches an adhoc query task. Adhoc tasks are thosetasks that an administrator has not yet configured. When an end user clicks a button associated withan adhoc task, AppXtender Connector prompts the end user to configure each component of the task.For information about these options, see Configuring tasks, page 23.

Administrators can choose to delete the two adhoc buttons, create custom import and query tasks fora deployment, and then create new toolbar buttons that launch these tasks. Deleting a toolbar buttonremoves it from the toolbar without deleting the underlying task associated with it.

End users with administrative privileges can also create and modify toolbar buttons but newdeployments can overwrite those buttons. For information about which conditions a new deploymentcan overwrite a custom toolbar button, seeEnd-user configuration privileges, page 19.

When you create a toolbar button, you can customize it with a name, image, and tooltip, and thenassociate a hotkey with it to provide quick keyboard access to the task. All new toolbar buttonsbecome menu options that you can access from the AppXtender Connector icon in the taskbar.

The toolbar also contains buttons that support scanning, configuring the software, logging in to andout of the AppXtender data store, and opening the online help.

Creating a toolbar button1. Click .

2. Select the Toolbar Buttons tab.

3. Click .

4. Enter a name and tooltip for this button.

5. Click Change to select an image on your local computer to show on the toolbar.

6. Assign a hotkey to the new toolbar button. The following steps explain how to assign a hotkey.

a. Put your cursor in the Hotkey field.

b. Press Ctrl, Alt, or Shift. Without releasing the key you pressed, press any other key on thekeyboard. The key combination is automatically recorded as the hotkey. You can also useany of the primary function keys (from F1 to F11) as a hotkey.

7. Click OK to save the change.

Editing a toolbar button1. Click .


3. Choose a toolbar button from the list.

4. Change the values of the button.

22



Deleting a toolbar button

Deleting a toolbar button removes it from the AppXtender Connector toolbar but does not delete theunderlying task associated with it.

1. Click .



4. Click .


Reordering toolbar buttons

You can specify the order in which the buttons appear on the AppXtender Connector toolbar. Theorder in which buttons appear in the Toolbar Buttons tab reflects their order as buttons in the toolbar.The button at the top of the list in the tab appears furthest to the left in the toolbar.

1. Click .



4. Click or to move the button up or down in the list. Buttons higher in the list appear furtherto the left in the toolbar than the ones below them


Configuring tasksTasks are operations that an administrator configures in AppXtender Connector. Administratorstypically create and manage tasks and deploy them to many end users. However, administratorscan give end users the privilege of creating and modifying tasks (but not changing the name of atask). Custom operations that you can assign to tasks include querying a document and importing adocument.

Both administrators and end users can configure tasks while they are running them and then savethe changes to the current task or a new one. For information about when a new deployment canoverwrite a custom task, see End-user configuration privileges, page 19. Only administrators candelete tasks.

23


You can associate a task with a toolbar button and hotkey. For information about how to associate atask with a toolbar button and hotkey, see Creating a toolbar button, page 22. AppXtender Connectorstarts a task only if the task meets all of the conditions that the administrator configured for it.

You can also prioritize tasks. If you assign multiple tasks to the same button or hotkey, AppXtenderConnector executes the highest priority task that also meets all of the conditions you have configuredfor it.

Creating a task1. Click .

The Configuration dialog box appears.

2. Select the Tasks tab.

3. In the Task List, click to start creating a task.

4. In the right panel, select the General tab.

5. On the General tab, do the following:

a. Enter a name for the task.

b. Choose the toolbar button that you want to launch this task. If you do not want to associate abutton with this task, choose the blank line at the top of the Button list.

c. (Optional) Enter a description for the task.

d. Specify whether to perform a clipboard copy when the end user presses the hotkey. If an enduser selects text and presses the hotkey while this option is enabled, the task captures theselected text before it displays the task wizard. The task can use this text for an index field.If this option is enabled, AppXtender Connector sends a virtual hotkey (Ctrl+c) to thesystem. If the operating system does not use Ctrl+c to copy content to the clipboard, you canchange the virtual hot key. In the configuration file Connector.exe.config, locate thefollowing element:.

Change ^c to another hotkey.

e. Choose the operation that you want this task to perform. Options include importing a file youdrop onto the AppXtender Connector toolbar, importing a print file, querying a document,and automatically executing a query.

24


6. Select the Input Source tab.

7. On the Input Source tab, do the following:

a. Choose a data store and content type to which you want to import the document or fromwhich you want to query the document. The content type fields populate the grid.

Note: For the query task, if you want to execute the task based on a saved query instead of anew query, you can choose an existing saved query from the list. If you choose a saved query,a new query value column appears in the field grid, which displays the saved criteria. If afield contains saved criteria, this field uses the saved criteria and accepts the capture valueif you have configured a capture method.

b. Configure how to capture values for the desired fields. For information about the captureoptions, see Capturing data, page 28.

Note: You can leave the store, content type, and capture fields empty. When you execute thetask, AppXtender Connector prompts you for values for these fields.

8. Select the Advanced tab.

25


9. On the Advanced tab, do the following.

a. Click New to add one or more conditions. AppXtender Connector executes the task onlywhen all of the conditions you have defined for this task match at runtime.

b. Define each condition. Select the match type, match option, and value. When an end userexecutes a task containing this condition, AppXtender Connector extracts data that matchesthe condition. For example, when a condition equals [MatchType=WindowCaption,Match=Contains, Value=WINDOW], AppXtender Connector extracts data from a runningapplication containing a window title with the string WINDOW.

Note: Delete a condition by selecting it in the list of conditions and then clicking Delete.

c. Configure extension options.

10. Click OK.

Configuring extension options

You can customize tasks in AppXtender Connector by adding extensions to them. For informationabout the extension types, the format to use when you define them, and models you can follow, seeChapter 6, Extending the Software.

1. Click .


3. From the Task List, select a task.

4. Select the Advanced tab.On this tab you can add a condition, preprocess, and postprocess that you have already definedto your task.

26


5. Add one or more existing extensions to the task by selecting them from the Choose ExtendCondition, Choose Pre Process, and Choose Post Process lists. Remove an extension from thetask by selecting the blank line at the top of each list.

Note: You can add a new condition to the task by clicking New and then selecting a MatchType, Match Option, and Value. When an end user executes a task containing this condition,AppXtender Connector extracts data that matches the condition. For example, when a conditionequals [MatchType=WindowCaption, Match=Contains, Value=WINDOW], AppXtenderConnector extracts data from a running application containing a window title with the stringWINDOW.

6. Configure the extension by defining parameters. Extension parameters obtain a value at runtimefrom an AppXtender Connector capture, then pass that value to the extension. Begin by selectingthe extension you want to configure.

Note: One of the extensions you can choose is SimpleStringCondition, a built-in conditionthat enables you to compare two strings (DesiredValue and SourceValue). For example,you could define the DesiredValue parameter as a hardcoded string and the SourceValueparameter to a value captured when AppXtender Connector executes the task.

7. Click Edit.A dialog box appears that lists the parameters for the extension you selected.

8. In the Value or Capture Methods field, enter a value for each parameter or choose a capturemethod that extracts a value for the parameter at runtime.

a. Configure a capture routine.

b. Click Test to test all of the capture methods you have added to the extension, or select a singlecapture method and select Test Selected.

9. Click OK to save the extension configuration.

Editing a task1. Click .



4. Change the task configuration in the tabs on the right. For information about how to configure atask, see Creating a task, page 24.


Deleting a task1. Click .



27


4. Click at the top of the task list.


Changing the task priority

You can associate more than one task with a toolbar button or import event. If all tasks meet theconditions you have configured for them, AppXtender Connector executes the highest priority task.

The tasks in the Task List are arranged from highest to lowest priority and when you change wherethey appear in the list, you change their priority.

1. Click .



4. Click or at the top of the list to move the task up or down. Moving a task up the listincreases its priority.


Capturing dataWhen you run a capture routine, you collect the metadata required for a task. You can use one ormore of the capture methods described in this section to run a capture routine and collect metadatafrom external sources. You can configure capture routines when you create a task and both configureand run capture routines when you import and query data. From any of these starting points, click

to begin capturing data.

AppXtender Connector provides the following capture methods.

• Capturing data from imported content, page 29

• Capturing data by scraping content, page 29

• Capturing data from the Microsoft Windows clipboard, page 30

• Capturing data in a Microsoft Windows application, page 31

• Capturing data in a web browser, page 32

• Capturing data in a terminal emulator, page 33

• Combine any of the capture methods to capture a value for an index field. You can set the orderfor the execution of these capture methods.

• Write your own capture method to capture content. AppXtender Connector provides capturemethod extensions. You can use VB.NET or C# to write a class that inherits the AppXtender

28


Connector capture extension interface. After you add an extension to AppXtender Connector, youcan use it the same as any built-in capture method.

• Capture data manually during an import or a query task by editing the index values resulting froma task. Importing a new document, page 52 and Modifying the document index, page 45 explainthe workflow for manually editing index values during an import and query task, respectively.

Capturing data from imported content

Use this capture method to capture index information from the documents or from a region of animage in an imported file:• If you want to capture content from documents, define a search pattern in the task configurationto extract the exact metadata. For information about how to define a regular expression searchpattern, see Extracting data, page 34. For information about the file formats that this capturemethod supports, see Appendix B, Import File Formats.

• If you want to capture index information from a region of an image, define a page number andzone location to identify the region for OCR. The following procedure provides instructions. Forinformation about options available during an import task, see Chapter 5, Importing Documents.

1. Click in the row of the field name you want to capture.

2. Click . Select OCR Imported File.

3. Specify a page number:• If you specify 0, the OCR engine processes all pages and ignores the zone region.

• If you specify 1, the OCR engine processes the first page in the import file list.

• If you specify a number higher than the number of pages in the import file list, the OCRengine does not process the imported file.

4. Click .AppXtender Connector opens a window to help you identify the OCR zone.

5. Click to open a sample file. Choose an image file with the same size and resolution as the filesthat you intend to process in the import task. Otherwise, the capture method can capture thewrong content from the files.

6. Click the rectangle button and draw a region in the sample file. You can create only one region.You can drag the border of the region to resize it, or you can move region to another area of theimage. The OCR engine processes only the specified zone.

7. Click OK. Coordinates of the specified region appear in the Zone location text box.

Capturing data by scraping content

Use this capture method to capture index information by scraping the content from the screen andextracting an index value. You can scrape content from multiple screen monitors.

1. Click in the row of the field name you want to scrape on the screen.

29


The Capture Configuration panel appears below the field name.

2. Click . Select Scrape Content.The Capture Configuration panel shows the options for screen scraping.

3. Select one of the following scrape procedures: Entire Window, Position In Window, and PositionIn Screen.• Position In Window captures an image using a position coordinate in a specified window.It uses a predefined window caption or process name to identify the window.

• Entire Window captures the image of the whole window. It uses a predefined windowcaption or process name to identify the window.

• Position In Screen captures an image using a position coordinate in the screen.

4. Click .If you selected Position In Window or Position In Screen, AppXtender Connectormoves to the background and crosshairs appear on the screen. If you selected Entire Window,click a window to select it.

5. If you selected Position In Window or Position In Screen, click the mouse at thestarting point of the region you want to capture and drag it to the endpoint. Double-click tocapture the area you have defined.The region you defined is highlighted and AppXtender Connector records the windows captionand position information.

6. If you selected Position In Window or Entire Window, configure the target owner.Configuring the target owner optimizes performance and reduces potential collisions whensearching for controls. For example, the window title can change to reflect the data beingpresented. Change the target owner to ensure a successful execution.• Contains identifies that window as the capture source that has a caption or process namecontaining the owner name. AppXtender Connector uses the discovered window or processto execute the capture method.

• StartsWith identifies that window as the capture source that has a caption or process namestarting with the owner name. AppXtender Connector captures the content of any windowcaption or process name that starts with the content of the predefined value.

• EndsWith identifies that window as the capture source that has a caption or process nameending with the target owner name.

• RegExpMatches identifies that window as the capture source that has a caption or processname matching the regular expression pattern you entered. Provide a regular expressionpattern for the window caption or process name.

Capturing data from the Microsoft Windows clipboard

Use this capture method to capture index information from the Microsoft Windows Clipboard.

1. Click in the row of the field name that corresponds to the content you want to capture.

2. Click . Select Clipboard.

30


You do not configure a capture you take from the Clipboard.

3. Click to run the capture routine.The contents of the Clipboard appear in the preview window.

Capturing data in a Microsoft Windows application

Use this capture method to capture index information from a Microsoft Windows application. Youcan identify the window using a predefined caption or process name.

1. Click in the row of the field name you want to capture.The Capture Configuration panel appears below the field name.

2. Click . SelectWindows Application.The Capture Configuration panel shows the options for capturing from a Microsoft Windowsapplication.

3. If the automation ID of the control in your Windows application exists but is not stable, performthe following:

a. Under Target Information, expand Extraction Properties.

b. Check Use 'Position In Window' Extraction Procedure.AppXtender Connector ignores the automation ID and uses the control position coordinatesto locate the control at runtime.

4. Click .AppXtender Connector minimizes to the system tray and the bulls eye cursor appears on thescreen.

5. Use your cursor to identify the window control you want to select. AppXtender Connectorhighlights each control in red. Click a control to select it.AppXtender Connector populates the extraction properties of Owner, Extraction Procedure,Automation ID, Class Name, and Target Position.

6. Rather than identifying a specific window, you can select or clear the Find target's ownerat runtime option. Specifying the target owner optimizes performance and reduces potentialcollisions when searching for controls. For example, the window title can change to reflect thedata being presented. Change the target owner to ensure a successful execution. Do the followingto specify the target owner.

a. Specify the target owner type, Window Caption or Process Name.

b. Select an operator.• Contains identifies that window as the capture source that has a caption or process namecontaining the target owner name.

• StartsWith identifies that window as the capture source that has a caption or processname starting with the target owner name.

31


• EndsWith identifies that window as the capture source that has a caption or process nameending with the target owner name.

• RegExpMatches identifies that window as the capture source that has a caption or processname matching the pattern of the target owner name.

c. Specify the target owner name. If you selected Window Caption in step a, the ownername is a window caption. If you selected Process Name in step a, the owner name is aprocess name.

Capturing data in a web browser

Use this capture method to capture index information from a browser. This capture method uses apredefined window caption or URL to identify the browser window.


2. Click . SelectWeb Browser.The Capture Configuration panel shows the options for capturing from a web browser.

3. Click .A list appears that shows all of your open browser windows.

4. Select the browser window from which you want to capture data. AppXtender Connector bringsthat window to the foreground and enables the Inspector tool in the lower right corner.

Note: If you do not see the Inspector tool, enable the toolbar that contains it. For informationabout how to enable the Inspector toolbar in Internet Explorer, see Using the AppXtenderInspector toolbar, page 33.

5. Select a window control. AppXtender Connector highlights each HTML element in red. Clicka control to select it.AppXtender Connector populates the extraction properties of XPath, Attribute, and Owner.

Note: If AppXtender Connector is not highlighting any HTML elements, click the Inspector toolfirst, then try again.

6. If the capture requires further configuration, provide target information.

7. Specify the target owner. Specifying the target owner optimizes performance and reducespotential collisions when searching for controls. For example, the window title can changeto reflect the data being presented.Do the following to specify the target owner.

a. Specify the target owner type, Window Caption or URL.

32


b. Select an operator.• Contains identifies that window as the capture source that has a caption or URL containingthe target owner name.

• StartsWith identifies that window as the capture source that has a caption or URL startingwith the target owner name.

• EndsWith identifies that window as the capture source that has a caption or URL endingwith the target owner name.

• RegExpMatches identifies that window as the capture source that has a caption or URLmatching the pattern of the target owner name.

c. Specify the target owner name.

Using the AppXtender Inspector toolbar

When capturing data from a web browser using AppXtender Connector, click

to identify the HTML element you want to capture. TheAppXtender Connector Inspector tool captures the properties of the selection, such as XPath andtarget owner.

1. Enable the AppXtender Inspector toolbar.

a. In Internet Explorer, click Tools >Manage Add-ons.The add-ons that are currently loaded appear.

b. Select Inspector Toolbar and enable it. AppXtender inspector has a toolbar and an Explorerbar. You can use either of them.

2. Show the AppXtender inspector toolbar.

a. In a browser window, click View > Toolbars or Explorer bars.

b. Select Inspector Toolbar.

Capturing data in a terminal emulator

Use this capture method to capture index information from selected terminal emulators.


2. Click . Select Emulator.The Capture Configuration panel shows the options for capturing from an emulator.

3. Select an emulator type. AppXtender Connector can capture content from the following terminalemulators.• Reflection for IBM

• Reflection for HP

33


• Reflection for UNIX Open VMX

• Reflection for ReGIS Graphics

• IBM Client Access

• Rumba

4. For Reflection for IBM, Reflection for HP, Reflection for UNIX Open VMX, Reflection for ReGISGraphics, and IBM Client Access, provide the row, column, and length values. For Rumba, alsoprovide the session name.

Extracting data

For all the capture methods described in Capturing data, page 28, you can extract data from thecapture result in the following ways.

• Line Number: This field is a positive integer that can be a range of lines. Specify which line youwant to extract. If you do not specify a line, AppXtender Connector extracts the whole capture.

• Start Index: This field is a positive integer. Specify which column you want to begin extracting.AppXtender Connector extracts starting at the indicated number of characters and returns Lengthcharacters. Start Index defaults to the value of 0. This option is available only when Line Numberis specified. If Line Number is not specified, AppXtender Connector starts to extract from thefirst index.

• Length: This field indicates how many characters to return starting from the Start Index. Lengthdefaults to the value of All. Specify how many characters you want to extract. If you did notspecify Line Number, AppXtender Connector extracts to the end of the line.

Note: If you add any of these options and a regular expression to a task, these options are executedfirst.

You can also use a regular expression pattern to extract data from the capture result. You can providea pattern and collection number. The collection number is used to extract the matched group inthe pattern. If you provide 0 or nothing, the entire string that matches the pattern becomes theextracted value. When you use regular expressions to search for a pattern, AppXtender Connectorignores character casing.

For example, you want to import a file containing the following string: EmployeeID:1234567890.You want to capture that string during an import task and use it as the value of the EmployeeIDindex field. You could define the pattern as (/w+):(/d+) and make the collection number 2. In thispattern, the operator (/w+) is used to match EmployeeID. If the match is successful, the collectionnumber of the match result is 1. The (/d+) operator is used to match the value 1234567890. If thematch is successful again, the collection number of the match result is 2. The Microsoft DeveloperNetwork library contains more information about .NET framework regular expressions.

34

http://msdn.microsoft.com/en-us/library/hs600312.aspx


Formatting data

After the capture and extraction are finished, you can format the result. There are five optionsavailable for formatting. The order of these options during processing is: remove white spaces, trimleading zeros, add prefix, add suffix, and regular expression format.

For regular expression format, you can provide a regular expression pattern and a replacement.The replacement replaces all content that matches the pattern. For example, in the raw capturedcontent, there is a string like 1234567890. You want to apply the string 1234560000 to the field.You can define the pattern as ((\d){4})$ and fill in the replacement with 0000. The patternmatches the last four digits of the input. After the entire capture method is finished, the capturedvalue is 1234560000. The Microsoft Developer Network library contains more information about.NET framework regular expressions.

Configuring a capture routine

You can configure a capture routine when configuring or running a task. Capture routinesautomatically extract data. You can then view or print the content in the Document Viewer.

1. If running a query task, click in the Query Documents dialog box.All of the index fields in the document appear.

35

http://msdn.microsoft.com/en-us/library/hs600312.aspx


2. In the Captured Value column, type the value of a field you want to capture. If the value requiresfurther configuration, click next to the field.The Capture Configuration screen appears below that field.

3. Click to add a capture routine.The capture method options appear.

4. Select the method by which you want to capture data on the document index field you selected.

5. Configure the capture routine by specifying its properties, as explained in the linked sections.• Capturing data from imported content, page 29

• Capturing data by scraping content, page 29

• Capturing data from the Microsoft Windows clipboard, page 30

• Capturing data in a Microsoft Windows application, page 31

• Capturing data in a web browser, page 32

• Capturing data in a terminal emulator, page 33

6. Click to execute all configured capture methods.

36


Configuring extensionsYou can add custom features to AppXtender Connector by using extensions. After developing anextension, add the extension add-in (assemblies) to enable it. If you modify an extension, rescan itto refresh its contents.

Adding an extension assembly1. Click .

2. Select the Extensions tab.

3. Click to import the add-in.The Open dialog box appears.

4. Go to an extension assembly that contains valid AppXtender Connector extensions.

5. Click Open.

6. Click the row of the assembly to see the details of the extension.


Deleting an extension assembly1. Click .


3. Select an add-in assembly.

4. Click .


Rescanning the Extension folder

Extension assemblies are stored in [InstallFolder]/Extensions. If the contents of that folderhave changed, rescan the folder to refresh its contents.

For example, some extension assemblies can depend on other files, such as resource files or otherassemblies. Copy those dependency files to the Extensions folder and then rescan the folder. Youcan easily access the Extensions folder by clicking .

Note: Do not manually rename assemblies inside the extension folder on your file system.

1. Click .


3. Click .

37



Configuring OCRNote: If you are upgrading from 8.1 to 16.3, change the OCR engine from FineReader to RecoStar andsave the configuration manually before configuring or running any tasks.

You can deploy the Optical Character Recognition (OCR) component to a client workstation or server.These two methods are called Client OCR Component and OCR Server.

If you choose to deploy the Client OCR component, all OCR component files deploy to each clientworkstation. This method is sometimes faster than the OCR Server (depending on the power of theCPU) but it requires more disk space to store the OCR component files.

The OCR Server method enables you to deploy the OCR component as a Microsoft Windowsservice. The OCR component files are not installed on the client workstation. The client only needsto supply the server endpoint address in the configuration. The default server endpoint address ishttp://hostname:9090/OCRWCFService. The host name must match the Microsoft Windowsserver name (or IP address) on which you installed the OCR service.

You can change the default endpoint address. Locate ApplicationXtender.AXConnector.OCRWindowsService.exe.config in the product folder. You can change the base address inthat file and restart the service. Change the endpoint address in each client workstation after youchange it on the server.

The OCR Server supports Network Load Balance (NLB). You can install the OCR services on severalservers and make them an NLB cluster. The client only needs to supply the server endpoint addresswith the virtual name or IP address of the cluster. Refer to the Microsoft Windows help for moreinformation on setting up an NLB cluster.

At this time, RecoStar is the only OCR engine that AppXtender Connector supports.

1. Click .

2. Select the OCR tab.

3. Choose your OCR method.• Use Client OCR Component: Select this option to deploy all OCR component files to eachclient workstation.

• Use OCR Server: Select this option if an OCR service has already been installed.

4. Set the server endpoint address. If you are using an OCR server, you can setthe server endpoint address to your installed OCR service. The default value ishttp://localhost:9090/OCRWCFService.

Note: The AppXtender Connector OCR service uses the Windows Communication Foundation(WCF) service to receive requests from the client workstation. Before using the OCRservice, confirm that your firewall is not blocking it. The default WCF endpoint address ishttp://ipaddress:9090/OCRWCFService. Additionally, use an administrator account to runthe OCR service.

38


Configuring AppXtender Connector DocumentWriterYou can import content from third-party applications by printing the content to a file usingAppXtender Connector Document Writer. By default, AppXtender Connector Document Writerprints content to PDF files, but you can configure it to print to TIFF files.

1. From the Microsoft Windows Control Panel, select Hardware and Sound > Printers.

2. Right-click AppXtender Connector Document Writer and then select Properties.

3. Click the Ports tab.

4. Select AXConnectorPort.

5. Click Configure Port.The Configure AXC Port dialog box appears.

6. Select an output file type.

7. Click OK.

Configuring multiple terminal sessionsEnd users can run multiple instances of AppXtender Connector in different terminal sessions.However, each terminal session can have only one instance of AppXtender Connector running.

AppXtender Connector Document Writer also supports terminal sessions. If an end user is in aterminal session and print documents through the AppXtender Connector Document Writer, thesystem directs the print file to the AppXtender Connector instance in the current terminal session.If multiple end users are using terminal sessions with the same account, AppXtender ConnectorDocument Writer directs the print file to the AppXtender Connector instance that started first.

If you want to allow end users to run multiple instances of AppXtender Connector in differentterminal sessions, perform the configurations described in the following sections:• Creating a virtual printer, page 40

• Configuring Citrix XenApp, page 40

39


Creating a virtual printer

If there is a high volume of end users that are using the AppXtender Connector Document Writer,you can create a virtual printer on each end-user workstation after installing AppXtender ConnectorDocument Writer.

1. Add a local printer.

2. Select Create a new port.

3. Select AXConnector Port Monitor as the type of port.

4. Type a unique name for the port (such as AXCPort1).Do not use the name AXConnectorPort. AppXtender Connector Document Writer uses thisport name.

5. Select an output file type.

6. UnderManufacturer, select EMC. If the print driver AppXtender Connector Document Writerdoes not appear, click Have Disk and browse to the AppXtender Connector Document Writerdriver files folder. The default folder is C:\Program Files\XtenderSolutions\ContentManagement\Connector\PrintDriver. Select the driver file AXConnectorPSRender.inf.

7. Select the print driver AppXtender Connector Document Writer.

8. Select Use the driver that is currently installed.

9. Type a name for the virtual printer.

10. Select the Share this printer option.

11. Finish the wizard.

Configuring Citrix XenApp

To use AppXtender Connector Document Writer, perform a one-time configuration to XenApp:

1. Open Citrix AppCenter.

2. In the tree panel, go to Citrix Resource > XenApp > You Farm > Policies.

3. Select the User tab and then click the Settings tab on the bottom part of the panel.

4. Scroll down to ICA > Printing > Client Printers.

5. Disable the Auto-Create client printers option.

6. Log in to Citrix in Desktop mode and open the printing application.

7. Print to AppXtender Connector Document Writer.The print job goes into its own printing queue.

40


Installing KeyView Viewer on an end-userworkstation1. Install the packages published by the administrator.

2. Click .

3. Select the Integration Tools tab.

4. Select ApplicationXtender KeyView Component and click Install.

Allowing end users to append pagesWhen an end user imports files and provides index values to create a document, if there is anexisting AppXtender document with the same index values, the system response depends on thefollowing factor:• In the configuration file Connector.exe.config, a comment contains the add element withthe IgnoreDupIndex key.

If both of these conditions are true, a message appears, giving the end user the options to appendthe files to the existing AppXtender document, create an AppXtender document, or cancel theimport. Otherwise, the message does not appear and the system creates a separate document inthe AppXtender repository.

If you do not want the message to appear, you can disable this feature:

1. In the configuration file Connector.exe.config, look for the following element:

2. Remove the commenting from this element and make sure that the value is set to true.

Importing a configuration fileWhen you configure AppXtender Connector, your selections modify the file AXConnectorShell.xml. For information about the structure of this configuration file, see Appendix A, AppXtenderConnector XML Structure. You can import and export this configuration file.

The following procedure explains how you can import file configuration settings to AppXtenderConnector.

1. Click .

2. Click . The Open dialog box appears.

3. Select the file called AXConnectorShell.xml.

4. Click Open.

41


Exporting the configurationYou can export your AppXtender Connector configuration settings to a file that you can then importinto the Deployment Manager to create a deployment package.

1. Click .

2. Click . The Save As dialog box appears.

3. Choose a location where you want to save your configuration file.

4. Click Save.

42

Chapter 4Searching for Content

You can configure AppXtender Connector to extract data from your applications by using manualvalues or by defining automatic captures by using capture methods. You use the data resulting froman automatic capture to populate the index fields in a query. After you configure all of your indexfields, you can run the query and find specific content in your applications.

At the end of the query task, you can change the index values in the search results.

You can open each document in the search results and customize the view.


• Creating a query task, page 43

• Modifying the document index, page 45

• Viewing search results in the document viewer, page 47

Note: To search content from multiple applications, first define a cross-application query (CAQ) inAppXtender Desktop or AppXtender Web Access. When you configure the task, select the CAQ asthe saved query.

Creating a query taskAdministrators create query tasks for end users and then assign these custom tasks to toolbar buttonsthat end users can access easily.

You can modify a query by delimiting a field or by configuring a capture routine on a selected field.You can then save the query for future use.

1. Click a query button on the toolbar.AppXtender Connector runs the highest priority task, collecting information from your runningapplications, Microsoft Windows Clipboard, or screen according to the task configuration.If the query task you launched includes a preprocessing extension, all of the captured indexvalues are passed to your preprocessing extension routine.The Query Documents dialog box appears.

Note: If the administrator configured the query button on the toolbar that you clicked to executethe query automatically, skip to step 8.

2. If you want to use a saved query, select it from the Saved Query list. The search criteria fromthe saved query appear in the Query Documents dialog box.

43

Searching for Content

3. If the administrator has not yet defined an AppXtender data source, or store, select one from theStore list and log in to it.Content type options available in the document store appear in the Content Type list.

4. If the administrator has not yet defined one, select a content type.Search criteria relevant to the content type appear in the lower half of the Query Documentsdialog box.

5. Optionally, customize the query criteria. You can customize it manually or by configuring acapture routine.• Type directly in the fields in the Query Documents dialog box. To delimit an index field, click

to select a date on the calendar or click to specify a range or list of field values.

• Click to configure a capture routine. This configuration enables you to capture a valuewhile executing a query task. You can also save the configured capture routine to your currentquery. After configuring the capture routine, click Next to return to the Query Documentsdialog box.

6. Click Include Previous Document Revisions if you want to include these documents in yoursearch results.

7. Click Search.If you provided a postprocessing extension, all values that the operation used and the operationtype of the resulting document are passed to your postprocessing extension routine.The query results appear in the Search Results dialog box.

8. Edit the layout:• Change the width of a column.

• Change the order of columns by dragging and dropping the column headings.

• Click the result set icon. A menu that lists all columns appears. Select the columns you wantto show or hide.

44


The system saves the layout in the following ways:• In the same query task, the system saves the layout for only one application. For example:— If the system saves the layout for APP1 in this task, when an end user queries APP2, thedefault layout appears for the result set of APP2.

— If an end user changes the layout for APP2, the system saves the layout for APP2 in thistask, and the layout saved for APP1 is lost.

— If an end user does not change any layout for APP2, the system still saves the layout forAPP1 in this task.

— If an end user changes the layout, the system saves the layout even if the end user cancelsthe task.

• The system saves the layout by task. In a different task, the layout could be different for thesame application. For example: An end user runs query task 1 to query APP1, and the layoutof APP1 is saved in task 1. When the end user runs query task 2, still to query APP1, the resultset appears with the layout saved in task 2.

9. Open a document in the Document Viewer. Open it by double-clicking an item in the search

results, right-clicking a field and selecting Open, or selecting a row and clicking .or

View and change a document index by selecting a row and clicking .

10. Click Next.A dialog box appears in which you can save any changes you made to an existing task or anew task.

11. Click Save Task and then choose to save the changes you made to the existing task or create atask based on it.

12. Click Finish.

Modifying the document indexAt the end of a query task, you can change the index values of a document resulting from the query.

1. In the Search Results dialog box that appears at the end of a query, select a row.

45


2. Click .The Document Properties dialog box appears.

3. In the Value column, manually change an index value for any field or configure a capture routine.

4. Click Next.A confirmation page appears.

5. Click Yes to save the change you made to the index value.The Task Execution Completed dialog box appears.

6. Click Save and specify whether you want to save the changes you made to the existing taskor create a task based on it.

7. Click Finish.

Submitting a document to a full text indexserver from query resultsAt the end of a query task, you can submit a document from the query results to a full-text indexserver.


2. Right-click the selected document and select Submit Full Text Job. A menu lists all of the FullText and OCR queues.

3. Select the queue to which you want to submit the document.

4. Click OK.

46


Sending a document by email from queryresultsAt the end of a query task, you can use email to send a document from the query results.

1. Install the Microsoft Outlook client.


3. Right-click the selected document and selectMail Document.

4. Configure the mail parameters, including the following:• If you want to use the same parameters while sending other documents, click Save As Default.

ClickMail.The system creates a draft Microsoft Outlook message and adds the export result of the documentas attachments.• If you have started Microsoft Outlook, the system sends the message.

• If you have not started Microsoft Outlook, the system saves the draft message in the Outbox.

Exporting a document from query resultsAt the end of a query task, you can export a document from the query results.


2. Right-click the selected document and select Export Document.

3. Configure the export parameters, including the following:• If you want to use the same parameters while exporting other documents, click Save AsDefault.

Click Export.

Viewing search results in the document viewerAt the end of a query task, you can view and edit a document appearing in the Search Resultsdialog box in the Document Viewer.

You can open a document in the Document Viewer in the following ways.

• Double-click an item in the search results.

• Right-click a field and select Open Document.

• Select a row and click Open Selected Document .

The Document Viewer opens in a new window. You can now work with the document in thefollowing ways.

• From the ApplicationXtender menu, print the current element.

47


• On the Home tab:— Go to the previous and next document, element, or version.

— Show or hide the thumbnail, annotation, text or images for OCR-processed content, text orform overlay, or the content of foreign files.

• On theModify tab, draw and edit annotations, change the text font, and manage documentcontainer elements and element versions.

• On the Scan tab, select a scanner, configure the selected scanner, and scan a new page to thecurrent document.

• On the View tab, rotate or zoom the element.

For information about the Windows Presentation Foundation Viewer, which contains documentoptions similar to the ones in the Document Viewer, see the OpenText ApplicationXtender for MicrosoftOffice 6.5 - 2010 Update Concepts and Planning Guide.

Fixing display problems

Document Viewer allows you to view and edit all documents that have file types thatApplicationXtender supports. OpenText ApplicationXtender for Microsoft Office 6.5 - 2010 UpdateConcepts and Planning Guide lists these file types. If you attempt to view a document with a file typethat ApplicationXtender does not support, your document can appear as a .bin file, preventing youfrom viewing the content.

While you are not always able to fix this problem for all foreign file types, you can adjust the settingsof documents in Portable Document Format (PDF) that appear as .bin files. PDF is a supported filetype but some individual PDF documents are not set to display in a browser. To fix this displayproblem for those documents, do the following.

1. Open the document in Adobe Reader.

2. Click Edit > Preferences.

3. Select the Internet tab.

4. Select Display PDF in browser.

48

Chapter 5Importing Documents

Use an import task to import information or documents to the AppXtender repository. The sourceof the import task can be the Microsoft Windows Clipboard, screen scrape, scanner, drop file, printdriver, or document. Use the AppXtender Connector Document Writer to import content from anythird-party applications that support printing.


• Importing from a file, page 49

• Importing from the Microsoft Windows clipboard, page 50

• Importing by screen scraping, page 50

• Importing from a scanner, page 50

• Importing a drop file, page 51

• Printing a document into AppXtender, page 51

• Importing a document, page 52

Importing from a fileYou can import a document from a file system to the AppXtender repository in the following way.

1. Click an import button or press a defined hotkey for the import task. The import wizard appears.

2. Click Select to select a file.

3. In the Open dialog box, select a file and then click Open.A portion of the selected file appears in the document view. Click the magnifying glass (DisplayIn Large View) to see the document in the preview window.

4. Click Next.The import wizard page that offers options for how to save the document appears.For information about the options for handling the imported file, see Importing a document,page 52.

49

Importing Documents

Importing from the Microsoft WindowsclipboardYou can copy the content of the Microsoft Windows Clipboard to the import task in the following way.

1. Click the import button or press a defined hotkey for the import task.The import wizard appears.

2. Click Clipboard.A portion of the Microsoft Windows Clipboard contents appears in the document view. Click themagnifying glass (Display In Large View) to see the content in the Document Viewer.

3. Click Next. The import wizard page that offers options for how to save the document appears.For information about the options for handling the imported file, see Importing a document,page 52.

Importing by screen scrapingScrape a region on the screen and import that content into the AppXtender repository in thefollowing way.

1. Click the import button or press a defined hotkey for the import task. The import wizard appears.

2. Open the screen you want to scrape.

3. Click Screen Scrape.Crosshairs appear on the screen.

4. Click the mouse at the starting point of the region you want to capture and drag it to the end point.

5. Double-click to capture the area you have defined.The region you defined is highlighted becomes an image file and appears in the document view.

6. Click Next.

7. For information about the options for handling the imported file, see Importing a document,page 52.

Importing from a scannerYou can scan a file and use it as the import source. Before you begin, confirm that you have installedthe scanner driver correctly and that the scanner is connected to the workstation on which youare running AppXtender Connector.

1. Click the import button or press a defined hotkey for the import task. The import wizard appears.

2. Click the arrow next to .A menu appears with Select Scanner and Config Scanner options.

50

Importing Documents

3. Select Select Scanner. Select any scanner that has been installed in your workstation. The option removes the scanner selection.

4. After selecting a scanner, configure it.If the scanner driver provides a configuration interface, it appears; if not, a message appears.

5. After the scan is configured correctly, click Scan to import the scan image from the selectedscanner.If you have not yet selected a scanner, you are prompted to do so. Once the scan operationfinishes, the scan result appears in the document view.

6. Click Next.The import wizard page showing options for how to save the document appears.For information about the options for handling the imported file, see Importing a document,page 52.

Importing a drop fileYou can select any file in Microsoft Windows Explorer and then drop it on the AppXtender Connectortoolbar to start an import task. A file imported in this way is called a drop file. Before you import,define at least one import task that supports importing a drop file. For information about how tocreate an import task and this option, see Creating a task, page 24.

To import a drop file, drop a file on the AppXtender Connector toolbar. To start a specific task thatsupports importing a dropped file, drop the file on the button assigned to the task. The followingrules apply to dragging a file and dropping it on the toolbar:

• If you do not drop the file on a specific button, the highest priority import task that supportsimporting a dropped file starts.

• If you have not defined any task to support a drop file, AppXtender Connector prompts you todefine one.

• If you have defined exactly one task to support a