appxtender reportsmgmt

Upload: shomin

Post on 01-Jun-2018

231 views

Category:

Documents


0 download

TRANSCRIPT

  • 8/9/2019 AppXtender ReportsMgmt

    1/380

    EMC Corporation

    Corporate Headquarters:

    Hopkinton, MA 01748-91031-508-435-1000www.EMC.com

    EMC ApplicationXtender

    Reports Management6.5

    Administrators Guide

    300-010-538REV A01

  • 8/9/2019 AppXtender ReportsMgmt

    2/380

    ApplicationXtender Reports Management Administrators Guide2

    Copyright 1994 - 2010 EMC Corporation. All rights reserved.

    Published March, 2010

    EMC believes the information in this publication is accurate as of its publication date. The information issubject to change without notice.

    THE INFORMATION IN THIS PUBLICATION IS PROVIDED AS IS. EMC CORPORATION MAKES NOREPRESENTATIONS OR WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION IN THISPUBLICATION, AND SPECIFICALLY DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY ORFITNESS FOR A PARTICULAR PURPOSE.

    Use, copying, and distribution of any EMC software described in this publication requires an applicablesoftware license.

    For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com.

    All other trademarks used herein are the property of their respective owners.

  • 8/9/2019 AppXtender ReportsMgmt

    3/380

    ApplicationXtender Reports Management Administrators Guide 3

    Preface.............................................................................................................................. 9

    Chapter 1 Introduction

    AppXtender Reports Mgmt............................................................. 14AppXtender Reports Mgmt Architecture...................................... 15AppXtender Reports Mgmt Print Stream Processor ............ 16AppXtender Reports Mgmt Report Processor ...................... 17AppXtender Reports Mgmt Report ConfigurationAdministrator............................................................................. 18AppXtender Reports Mgmt Report ConfigurationAdministrator (Reports Only) ................................................. 19

    What are Report Files and Print Stream Files? ............................. 20What are Report Files? .............................................................. 20What are Print Stream Files?.................................................... 20

    Processing Different File Types....................................................... 21

    Chapter 2 Installing ApplicationXtender Reports Management

    Preparing to Install AppXtender Reports Mgmt.......................... 24

    The AppXtender Reports Mgmt Service Account ....................... 25Configuring the Service Account ............................................ 26Running AppXtender Reports Mgmt Setup Wizard ................... 35

    Uninstalling AppXtender Reports Management.................. 42

    Chapter 3 Using ApplicationXtender Reports Management

    How AppXtender Reports Mgmt Processes a File....................... 46

    What Happens to a Print Stream File ..................................... 46What Happens to a Report File ............................................... 48

    Contents

  • 8/9/2019 AppXtender ReportsMgmt

    4/380

    ApplicationXtender Reports Management Administrators Guide4

    Contents

    The Extraction Process ..................................................................... 50

    Extracting the Index Values ..................................................... 50Understanding Propagation of Index Values ........................ 51Using Different Indexing Options........................................... 56Compressing Report Files for Storage.................................... 59Important Information about Extracting Dates .................... 60

    Support for AppXtender Features.................................................. 61HIPAA Compliance Support ................................................... 61

    Configuring AppXtender Reports Mgmt...................................... 63

    Configuring AppXtender Reports Mgmt for Print StreamFiles.............................................................................................. 63Configuring AppXtender Reports Mgmt for Report Files .. 64Configuring AppXtender Reports Mgmt for BusinessIntelligence Applications.......................................................... 65

    Maintaining AppXtender Reports Mgmt...................................... 71

    Chapter 4 ApplicationXtender Reports Management

    Configuration Admin

    Introduction....................................................................................... 74Opening the AppXtender Reports Mgmt Configuration Admin... 75Using the AppXtender Reports Mgmt Configuration Admin... 76

    AppXtender Reports Mgmt Configuration AdminApplication Setup for Web Access .......................................... 77

    Navigating the AppXtender Reports Mgmt ConfigurationAdmin Application ................................................................... 80The AppXtender Reports Mgmt Configuration AdminToolbar......................................................................................... 81Customizing the Application................................................... 82

    Transferring AppXtender Reports Mgmt Configuration Data .. 84Exporting Configuration Data................................................. 85Importing Configuration Data ................................................ 86

    Using Help......................................................................................... 87AppXtender Reports Mgmt Configuration Properties ............... 88

    Viewing Information about AppXtender Reports Mgmt .... 88Configuring AppXtender Reports Mgmt Licensing ............ 88Changing the AppXtender Reports Mgmt ConfigurationData Directory............................................................................ 91

    Chapter 5 Managing AppXtender Data SourcesIntroduction....................................................................................... 94

  • 8/9/2019 AppXtender ReportsMgmt

    5/380

    5ApplicationXtender Reports Management Administrators Guide

    Contents

    About Content Repositories ............................................................ 96

    Viewing Existing AppXtender Data Sources ................................ 98Preparing AppXtender Reports Mgmt Servers as AppXtenderDatabase Clients................................................................................ 99

    Preparing AppXtender Reports Mgmt Servers as IBM DB2Database Clients....................................................................... 100Preparing AppXtender Reports Mgmt Servers as OracleDatabase Clients....................................................................... 104Preparing AppXtender Reports Mgmt Servers as Sybase SQL

    Anywhere Database Clients ................................................... 107Preparing AppXtender Reports Mgmt Servers as MySQLDatabase Clients....................................................................... 112Preparing AppXtender Servers as Microsoft Access DatabaseClients ........................................................................................ 114

    Linking to AppXtender Data Sources .......................................... 117Linking to an SQL Server Database ...................................... 118Linking to an IBM DB2 Database .......................................... 120

    Linking to an Oracle Database............................................... 122Linking to a Sybase Database................................................. 124Linking to a MySQL Database ............................................... 126Linking to a Microsoft Access Database............................... 128

    Modifying an Existing Data Source.............................................. 131Removing an AppXtender Data Source....................................... 133Support for AppXtender Data Features....................................... 134

    Configuring Volume Label Search Drive(s) ......................... 134

    Configuring Max Future Years............................................... 135

    Chapter 6 Configuring Print Stream Types

    Introduction ..................................................................................... 138Print Stream Type Configuration Glossary ................................. 139Creating a New Print Stream Type............................................... 140

    Starting the Print Stream Type Creation Wizard................. 141

    AFP Print Stream Type Creation Wizard.............................. 142ASCII Print Stream Type Creation Wizard........................... 156EBCDIC Print Stream Type Creation Wizard....................... 160EBCDIK Print Stream Type Creation Wizard ...................... 163Metacode Print Stream Type Creation Wizard .................... 166PCL Print Stream Type Creation Wizard.............................. 179

    Modifying Print Stream Type Properties..................................... 189Opening the Print Stream Properties Dialog Box................ 189

    Renaming a Print Stream Type............................................... 191Deleting a Print Stream Type......................................................... 192

  • 8/9/2019 AppXtender ReportsMgmt

    6/380

    ApplicationXtender Reports Management Administrators Guide6

    Contents

    Chapter 7 Configuring Report Types

    Introduction..................................................................................... 194Managing Report Types................................................................. 196

    Creating a New Report Type ................................................. 196Modifying Report Type Properties ....................................... 211Viewing the Sample Report ................................................... 214Deleting a Report Type ........................................................... 216

    Managing Index Fields .................................................................. 217Checking the Index Field List................................................ 218

    Synchronizing Index Fields with the Database................... 219Changing Index Field Propagation....................................... 220

    Managing Data Fields .................................................................... 223Creating Fields for Export to Business Intelligence Files .. 223Changing Data Field Properties ............................................ 225Deleting a Data Field............................................................... 226

    Managing Procedures .................................................................... 228Creating a New Procedure ..................................................... 228

    Recommended Method of Testing Procedures ................... 235Changing the Order of Procedures....................................... 236Editing Procedures.................................................................. 237Deleting a Procedure............................................................... 239

    Using XDS Visual Tester ................................................................ 241Displaying XDS Visual Tester for a Sample Report............ 242Displaying XDS Visual Tester for a Processed Report ....... 243Using XDS Visual Tester to Test a Report ............................ 248

    Chapter 8 Managing the Print Stream Processor

    Introduction..................................................................................... 252The Print Stream Processor Glossary........................................... 254

    The Configuration Data Directory........................................ 256The Print Stream Processor Working Directory .................. 257The Working Subdirectory for a Print Stream Type ........... 257

    Resources Directory for a Print Stream Type....................... 258The Print Stream Processor System Log Directory............. 259The Source Directory for each Print Stream Type............... 260

    Configuring the Print Stream Processor...................................... 262Print Stream Processor Paths ................................................. 264Log View Path.......................................................................... 264Changing the Working Directory.......................................... 265Changing the System Log Directory..................................... 266Configuring Print Stream Processor Performance.............. 267Managing Source Specifications for Print Stream Types ... 275

  • 8/9/2019 AppXtender ReportsMgmt

    7/380

    7ApplicationXtender Reports Management Administrators Guide

    Contents

    Monitoring the Print Stream Processor........................................ 287

    Using Logs to Monitor the Print Stream Processor............. 287Viewing Logs for Failed Print Stream Processes ................. 293Allowing a Print Stream to be Processed Again.................. 295Deleting the Logs for a Processed Print Stream .................. 296

    Chapter 9 Managing the Report Processor

    Introduction ..................................................................................... 298

    The Report Processor Glossary ..................................................... 299The Configuration Data Directory......................................... 301Report Processor Paths............................................................ 302Report Log View ...................................................................... 303The Report Processor Working Directory............................. 304The Working Subdirectory for a Report Type...................... 304The Report Processor System Log Directory ....................... 305The Source Directory for a Report Type ............................... 306

    Configuring the Report Processor ................................................ 308Changing the Report Processor Working Directory ........... 310Specifying the Data Export Path............................................ 311Specifying the B.I. Gateway Path........................................... 312Changing the Report Processor System Log Directory ...... 313Configuring Report Processor Performance........................ 314Accessing Report Data in WMI.............................................. 319Managing Source Specifications for Report Types.............. 323

    Monitoring the Report Processor.................................................. 336Using Logs to Monitor the Report Processor....................... 336

    Chapter 10 Using Form Overlay

    Introduction ..................................................................................... 348Creating the _FORMS Application............................................... 350

    Index Fields for _FORMS Application.................................. 351

    Adding Forms to the _FORMS Application................................ 353Enabling Form Display................................................................... 355Modifying the Document Position in Relation to Form............ 356

    Glossary........................................................................................................................ 357

    Index .............................................................................................................................. 365

  • 8/9/2019 AppXtender ReportsMgmt

    8/380

    ApplicationXtender Reports Management Administrators Guide8

    Contents

  • 8/9/2019 AppXtender ReportsMgmt

    9/380

  • 8/9/2019 AppXtender ReportsMgmt

    10/380

    10 ApplicationXtender Reports Management Administrators Guide

    Preface

    The following is a list of documentation for related products that may

    be useful when working with AppXtender Reports Mgmt:

    ApplicationXtender Concepts and Planning Guide

    ApplicationXtender Core Components Administrators Guide

    ApplicationXtender Administrator Quick Reference

    All documents are in Adobe Acrobat Portable Document Format(PDF), and can be viewed by downloading and installing the Adobe

    Acrobat Reader. The Reader is available directly from Adobe atwww.adobe.com. To install and use the Reader on the preferredplatform, refer to the instructions on the Adobe website.

    Conventions Used inthis Document

    EMC uses the following conventions for special notices.

    Note: A note presents information that is important, but not hazard-related.

    CAUTION

    A caution contains information essential to avoid data loss ordamage to the system or equipment. The caution may apply tohardware or software.

    IMPORTANT

    An important notice contains information essential to operation ofthe software. The important notice applies only to software.

  • 8/9/2019 AppXtender ReportsMgmt

    11/380

    ApplicationXtender Reports Management Administrators Guide 11

    Preface

    Where to get help EMC support, product, and licensing information can be obtained asfollows.

    Product information For documentation, release notes, softwareupdates, or for information about EMC products, licensing, andservice, go to the EMC Powerlink website (registration required) at:

    http://Powerlink.EMC.com

    Technical support For technical support, go to EMC CustomerService on Powerlink. To open a service request through Powerlink,

    you must have a valid support agreement. Please contact your EMCsales representative for details about obtaining a valid supportagreement or to answer any questions about your account.

    http://powerlink.emc.com/http://powerlink.emc.com/
  • 8/9/2019 AppXtender ReportsMgmt

    12/380

    12 ApplicationXtender Reports Management Administrators Guide

    Preface

  • 8/9/2019 AppXtender ReportsMgmt

    13/380

    Introduction 13

    1

    Introduction

    This chapter provides an introduction to ApplicationXtenderReports Management (AppXtender Reports Mgmt).

    For more information, see the following sections:

    AppXtender Reports Mgmt.............................................................. 14 AppXtender Reports Mgmt Architecture....................................... 15 What are Report Files and Print Stream Files? .............................. 20 Processing Different File Types........................................................ 21

  • 8/9/2019 AppXtender ReportsMgmt

    14/380

    14 ApplicationXtender Reports Management Administrators Guide

    Introduction

    AppXtender Reports Mgmt

    AppXtender Reports Mgmt is a solution for electronically storingcomputer output reports. You can use AppXtender Reports Mgmt toprocess reports for retrieval, printing, faxing, and routing inWindows environments.

    To process or store reports, AppXtender Reports Mgmt extracts indexvalues from predefined locations on report pages and imports the

    index records into an ApplicationXtender (AppXtender) database forfuture retrieval.

    The report files are also compressed and copied to the write pathlocation specified in AppXtender. This location could be a massstorage device such as magnetic, DVD-RAM, WORM, erasableoptical, tape, or CD-ROM media.

    This network product is designed for those who need a complete,

    turnkey Enterprise Report Management (ERM) and/or contentmanagement solution.

  • 8/9/2019 AppXtender ReportsMgmt

    15/380

    AppXtender Reports Mgmt Architecture 15

    Introduction

    AppXtender Reports Mgmt Architecture

    AppXtender Reports Mgmt runs on Windows and can be integratedinto any Windows-supported network. Refer to the

    ApplicationXtender Release Notesfor a list of supported operatingsystems.

    An OLE DB-compliant database server is used to store index valuesand report page/image locations. Any mass storage device (hard

    disk, disk array, optical, DVD-RAM, tape) can be used to store thecomputer reports. AppXtender, the universal viewer of theApplicationXtender product suite, is used on workstations to searchfor and display reports and other documents.

    AppXtender Reports Mgmt comprises feature-rich components thattogether provide a powerful and flexible system for converting printstream files, extracting index values, and uploading the resultingindexed documents to AppXtender. You can then use AppXtender to

    retrieve and view report files. AppXtender Reports Mgmt includesthe following components:

    The AppXtender Reports Mgmt Print Stream Processor detectsand converts print stream files into PDF or standard ASCII formatthat can be used by the AppXtender Reports Mgmt ReportProcessor.

    The AppXtender Reports Mgmt Report Processor detects report

    files, extracts data and creates index values, uploads indexrecords to an AppXtender database, and compresses reports forstorage in a designated location, which may be a mass storagedevice.

    The AppXtender Reports Mgmt Report ConfigurationAdministrator is a user interface for storing and modifyingconfiguration data for the AppXtender Reports Mgmt Print

    Stream Processor and the AppXtender Reports Mgmt ReportProcessor, for creating or debugging index procedures, and forviewing error log and status information. The AppXtenderReports Mgmt Report Configuration Administrator has twoviews: AppXtender Reports Mgmt Report Configuration andAppXtender Reports Mgmt Configuration.

    The AppXtender Reports Mgmt Report Configuration viewonly allows access to the AppXtender Reports Mgmt Report

    Processor.

  • 8/9/2019 AppXtender ReportsMgmt

    16/380

    16 ApplicationXtender Reports Management Administrators Guide

    Introduction

    The AppXtender Reports Mgmt Configuration view allowsaccess to both the AppXtender Reports Mgmt ReportProcessor and the AppXtender Reports Mgmt Print StreamProcessor. For simplicity, procedures in this manual refer tothe AppXtender Reports Mgmt Report ConfigurationAdministrator to refer to either view.

    Note: You may install AppXtender Reports Mgmt on more than onemachine, but only one instance of it may run at any given time. Whenconfiguring AppXtender Reports Mgmt remotely, be sure that the

    instance you are using is the only one currently running.

    AppXtender ReportsMgmt Print StreamProcessor

    The AppXtender Reports Mgmt Print Stream Processor detects printstream files from other sources and converts them into a PDF orstandard ASCII format. The following table lists the file formats thatcan be converted:

    Converted report files can then be output to the AppXtender ReportsMgmt Report Processor for extracting and indexing the specifieddata.

    The AppXtender Reports Mgmt Print Stream Processor is a Windows

    service that continuously processes print stream files according toconfiguration information in source specifications and print stream

    Table 1 Files that Can be Processed by the AppXtender Reports Mgmt PrintStream Processor

    Print Stream File Format Conversion Output

    IBM AFP format

    Note: Line data and mixed mode files that print on AFP printers through PSFare supported, as well as fully composed MO:DCA-P files. The AFP parserdoes not support the output of PSF (IPDS).

    PDF

    Xerox Metacode format (also known as DJDE)

    Note: Line data and mixed mode files that print on Metacode printers aresupported, as well as pure Metacode files.

    PDF

    HP PCL (level 4 and 5, but not 6) PDF

    Non-standard ASCII Standard ASCII

    EBCDIC Standard ASCII

    EBCDIK Standard ASCII

  • 8/9/2019 AppXtender ReportsMgmt

    17/380

    AppXtender Reports Mgmt Architecture 17

    Introduction

    types. Source specifications indicate the location and file name masksof print stream files. Print stream types specify necessary parameters

    for processing print stream files. At the end of a successful process, aPDF or standard ASCII file is created and placed into a specifieddirectory. Following a successful conversion, the source file may bedeleted, renamed, or moved to a new location for archival purposes.

    During this conversion process, the AppXtender Reports Mgmt PrintStream Processor generates one or two logs. For AFP, Metacode, andPCL print stream file conversions, the processor generates a detailed

    conversion log. For all print stream file conversions, includingEBCDIC, EBCDIK, and nonstandard ASCII, the processor generates amessage log, to indicate a success or failure. In addition, theAppXtender Reports Mgmt Print Stream Processor creates asystem-level message log.

    You may monitor the processing of print stream files by viewing thegenerated conversion log, message log, and the system log in theAppXtender Reports Mgmt Report Configuration Administrator. Forinstructions on viewing these logs, see Monitoring the Print StreamProcessor.

    AppXtender ReportsMgmt ReportProcessor

    The AppXtender Reports Mgmt Report Processor detects report files,extracts index values from the report files, and stores the resultingindex record with the report pages in an AppXtender database as anindexed document. You can then use the index record to retrieve the

    report file through an AppXtender application.

    Report files are also compressed and stored for viewing inAppXtender. Report files can be generated on any platform but mustbe one of the following file types: ASCII or PDF.

    You can use the AppXtender Reports Mgmt Print Stream Processor toconvert many print stream types into either ASCII or PDF, which canthen be processed with the AppXtender Reports Mgmt ReportProcessor.

    The AppXtender Reports Mgmt Report Processor is a Windowsservice that continuously processes report files according toconfiguration information in source specifications and report types.

    Source specifications indicate the location and a method for theAppXtender Reports Mgmt Report Processor to recognize report files(either by file name masks or by INI files). Report types specifynecessary parameters for processing report files.

  • 8/9/2019 AppXtender ReportsMgmt

    18/380

    18 ApplicationXtender Reports Management Administrators Guide

    Introduction

    At the end of a successful extraction process, the AppXtender ReportsMgmt Report Processor performs the following tasks:

    Uploads reports as new documents to the AppXtender documentstorage location

    Uploads index records for those reports to the AppXtenderdatabase

    Exports records to files for use in business intelligenceapplications, if AppXtender Reports Mgmt is appropriately

    configuredFollowing a successful extraction, the source file may be deleted,renamed, or moved to a new location for archival purposes.

    For more discussion of the extraction process, see The ExtractionProcess.

    During this extraction process, the AppXtender Reports MgmtReport Processor generates two logs. One of these logs is a detailed

    history log. The other log is a message log generated to indicate asuccess or failure. In addition, the AppXtender Reports Mgmt ReportProcessor creates a system-level message log if it cannot start aprocess.

    You may monitor the processing of report files by viewing thegenerated history log, message log, and the system log in theAppXtender Reports Mgmt Report Configuration Administrator.

    For instructions on viewing these logs, see Monitoring the ReportProcessor.

    AppXtender ReportsMgmt ReportConfigurationAdministrator

    The AppXtender Reports Mgmt Report Configuration Administratorstores AppXtender Reports Mgmt configuration data for both printstreams and reports.

    This advanced interface allows you to directly develop or modifyextraction procedures, review and modify configuration data forAppXtender Reports Mgmt components, and view error and statuslogs.

    For more detailed information about the AppXtender Reports MgmtReport Configuration Administrator, see The AppXtender ReportsMgmt Configuration Admin Toolbar.

  • 8/9/2019 AppXtender ReportsMgmt

    19/380

    AppXtender Reports Mgmt Architecture 19

    Introduction

    AppXtender Reports

    Mgmt ReportConfigurationAdministrator(Reports Only)

    The AppXtender Reports Mgmt Report Configuration Administrator

    (Reports Only) stores AppXtender Reports Mgmt configuration datafor reports only.

    Like the Configuration Admin, this advanced interface allows you todirectly develop or modify extraction procedures, review and modifyconfiguration data for AppXtender Reports Mgmt components, andview error and status logs.

    For more detailed information about the AppXtender Reports Mgmt

    Report Configuration Administrator, see ApplicationXtenderReports Management Configuration Admin.

  • 8/9/2019 AppXtender ReportsMgmt

    20/380

    20 ApplicationXtender Reports Management Administrators Guide

    Introduction

    What are Report Files and Print Stream Files?

    What are ReportFiles?

    A report file is any generated file that provides information in anorganized way.

    You can use the AppXtender Reports Mgmt Report Processor toextract index information from two types of report files: PDF andstandard ASCII.

    Although the term reportusually has a broader meaning, thisdocumentation uses the term to refer to only those files that can beprocessed by the AppXtender Reports Mgmt Report Processor.

    The AppXtender Reports Mgmt Report Processor can process PDFand standard ASCII files that were created using the AppXtenderReports Mgmt Print Stream Processor, but is not limited to only thosePDF and standard ASCII files.

    What are PrintStream Files?

    A print stream file is output that would normally be destined for theprinter but has been diverted to a computer file instead.

    You can use the AppXtender Reports Mgmt Print Stream Processor toconvert AFP, Metacode, PCL, EBCDIC, EBCDIK, and non-standardASCII print stream files. The AppXtender Reports Mgmt ReportProcessor can in turn, process these converted files.

    Although the termprint streamusually has a broader meaning, thisdocumentation uses the term to refer to only those files that can beprocessed by the AppXtender Reports Mgmt Print Stream Processor.

  • 8/9/2019 AppXtender ReportsMgmt

    21/380

    Processing Different File Types 21

    Introduction

    Processing Different File Types

    The procedure for extracting index records depends on the type offile that needs to be processed. Use the following table to determinewhether your file must be converted before processing:

    The following table describes the input and output of eachAppXtender Reports Mgmt processor:

    Table 2 What You Should Do with Each File Type

    If Files to be Processed are Then You

    PDF or standard ASCII report files Can process them with the AppXtender Reports MgmtReport Processor. The files do not need to be convertedbefore processing.

    AFP, Metacode, or PCL print stream files Must convert them first with the AppXtender ReportsMgmt Print Stream Processor. Then you can process theresulting PDF report files with the AppXtender ReportsMgmt Report Processor.

    EBCDIC, EBCDIK, or non-standard ASCII printstream files

    Must convert them first with the AppXtender ReportsMgmt Print Stream Processor. Then you can process theresulting standard ASCII report files with the AppXtenderReports Mgmt Report Processor.

    Any other file format Must use a separate conversion tool to convert them toAFP, ASCII, EBCDIC, EBCDIK, Metacode, PCL, or PDFand then process them with the appropriate AppXtenderReports Mgmt processor.

    Table 3 Input and Output for Each AppXtender Reports Mgmt Processor

    Processor Input Output

    AppXtender ReportsMgmt Print Stream

    Processor

    AFP, Metacode, PCL, non-standardASCII, EBCDIC, or EBCDIK print

    stream files

    PDF or standard ASCII report files (forinput into the AppXtender Reports Mgmt

    Report Processor)

    AppXtender ReportsMgmt Report Processor

    PDF or standard ASCII report files Indexed and compressed documentsuploaded to AppXtender (plus f iles for usein business intelligence applications,depending on AppXtender Reports Mgmtconfiguration)

  • 8/9/2019 AppXtender ReportsMgmt

    22/380

    22 ApplicationXtender Reports Management Administrators Guide

    Introduction

    The following figure provides a diagram of the input and output ofeach AppXtender Reports Mgmt processor:

    Figure 1 Input and Output for each AppXtender Reports Mgmt Processor

    PDF

    Standard ASCII

    AppXtender Reports Mgmt

    Print Stream Processor

    AFP

    Metacode

    PCL

    Non-standard ASCIIEBCDICEBCDIK

    AppXtender Reports Mgmt

    Report ProcessorIndexed Documents

    Uploaded to AppXtender

    Records Exported to

    a File for Business

    Intelligence Applications

  • 8/9/2019 AppXtender ReportsMgmt

    23/380

    Installing ApplicationXtender Reports Management 23

    2

    Installing

    ApplicationXtenderReports Management

    This chapter describes how to install, configure, and uninstallAppXtender Reports Mgmt.

    For more information, see the following sections: Preparing to Install AppXtender Reports Mgmt........................... 24 The AppXtender Reports Mgmt Service Account......................... 25 Running AppXtender Reports Mgmt Setup Wizard .................... 35

  • 8/9/2019 AppXtender ReportsMgmt

    24/380

    24 ApplicationXtender Reports Management Administrators Guide

    Installing ApplicationXtender Reports Management

    Preparing to Install AppXtender Reports Mgmt

    To install AppXtender Reports Mgmt:

    1. Make sure the computer on which you want to installAppXtender Reports Mgmt has access to the computer on whichAppXtender has been installed. For best performance, considerinstalling AppXtender Reports Mgmt on a computer other thanthe one where the AppXtender database is located. For moreinformation, refer to theApplicationXtender Installation Guide.

    2. Make sure the computer on which you want to installAppXtender Reports Mgmt meets AppXtender Reports Mgmtrequirements. For information, refer to theApplicationXtenderReports Management Release Notes.

    3. Configure an AppXtender Reports Mgmt service account. Forinstructions, see Configuring the Service Account.

    4. Run the AppXtender Reports Mgmt setup wizard. Forinstructions, see Running AppXtender Reports Mgmt SetupWizard.(To upgrade from previous versions of AppXtenderReports Mgmt, you need only run the AppXtender Reports Mgmtsetup wizard.)

    Note: You can install MMC, MDAC, or Adobe Acrobat Reader from theAppXtender Reports Mgmt setup media kit. You can download Microsoft

    Internet Explorer from the Microsoft website.

    Note: To determine the operating system version, service pack, and physicalmemory available for Windows, from the Start menu, select Run. In the Opentext box, typewinver. Click OK.

  • 8/9/2019 AppXtender ReportsMgmt

    25/380

    I t lli A li ti Xt d R t M t

  • 8/9/2019 AppXtender ReportsMgmt

    26/380

    26 ApplicationXtender Reports Management Administrators Guide

    Installing ApplicationXtender Reports Management

    Configuring the

    Service Account

    This section describes how to configure the AppXtender Reports

    Mgmt service account on a Windows computer for use withAppXtender Reports Mgmt. The following procedure provides anoverview for this section.

    To configure the AppXtender Reports Mgmt service account:

    1. Create an account that can be used as an AppXtender ReportsMgmt service account. For instructions, see Creating theAppXtender Reports Mgmt Service Account.

    2. Make sure the account that you want to configure as theAppXtender Reports Mgmt service account is a member of theLocal Administrators group on the computer where you intend toinstall AppXtender Reports Mgmt. For instructions, see Addingthe AppXtender Reports Mgmt Service Account toAdministrators Group.

    Note: This step is necessary because the AppXtender Reports Mgmtservice account requires the rights of an Administrator. These rightsallow the AppXtender Reports Mgmt services to access remote resources.

    3. On the domain, make sure the account that you want to configureas the AppXtender Reports Mgmt service account has the Log onas a service advanced right.

    For instructions, see Adding Advanced Rights to the

    AppXtender Reports Mgmt Service Account.

    Note: This step must be performed on the domain because the rights fora user on the domain override the rights for the same user on thecomputer on which AppXtender Reports Mgmt is installed.

    The AppXtender Reports Mgmt service account is configured andyou are ready to install AppXtender Reports Mgmt.

    Installing ApplicationXtender Reports Management

  • 8/9/2019 AppXtender ReportsMgmt

    27/380

    The AppXtender Reports Mgmt Service Account 27

    Installing ApplicationXtender Reports Management

    Creating theAppXtender Reports

    Mgmt ServiceAccount

    To create the AppXtender Reports Mgmt service account:

    1. Log on to the computer on which you intend to installAppXtender Reports Mgmt.

    2. Make sure that you are logged on as a member of the LocalAdministrators group.

    Note: This step is necessary because configuring the AppXtenderReports Mgmt service account requires the rights of an administrator.

    3. From the Windows Start menu, select Programs and thenAdministrative Tools.

    4. From the Administrative Tools program group, select ComputerManagement. The Computer Management console appears.

    Figure 2 Computer Management Console

    5. Expand the System Tools tree item, and then expand Local Usersand Groups.

    6. Right-click Users, and select New User. The New User dialog boxappears.

    Installing ApplicationXtender Reports Management

  • 8/9/2019 AppXtender ReportsMgmt

    28/380

    28 ApplicationXtender Reports Management Administrators Guide

    Installing ApplicationXtender Reports Management

    Figure 3 New User Dialog Box

    7. Enter a User name, Full name, Description, Password, andPassword confirmation in the available text boxes.

    8. Disable the User must change password at next logon check box,and enable the Password never expires check box.

    9. Click Create. The new AppXtender Reports Mgmt service

    account is created.

    10. Click Close to exit the New User dialog box.

    11. Keep the Computer Management console open. You now need toadd the AppXtender Reports Mgmt service account to theAdministrators group.

    For instructions, see the Adding the AppXtender Reports Mgmt

    Service Account to Administrators Group.

    Installing ApplicationXtender Reports Management

  • 8/9/2019 AppXtender ReportsMgmt

    29/380

    The AppXtender Reports Mgmt Service Account 29

    Installing ApplicationXtender Reports Management

    Adding theAppXtender Reports

    Mgmt ServiceAccount to

    Administrators Group

    The account that you want to configure as the AppXtender ReportsMgmt service account must be a member of the administrators group.

    The following procedures describe how to add the AppXtenderReports Mgmt service account to the administrators group in theWindows environment.

    To add the AppXtender Reports Mgmt service account to theadministrators group:

    1. In the Computer Management console, expand the System Tools

    tree item, and then expand Local Users and Groups.2. Select the Users folder. The list of local users appears in the

    consoles right-side pane.

    3. Right-click the AppXtender Reports Mgmt service account andselect Properties. The Properties dialog box for the selected userappears.

    4. Click the Member Of tab.

    Figure 4 User Properties Dialog Box - Member Of Tab

    5. Click Add. The Select Groups dialog box appears.

  • 8/9/2019 AppXtender ReportsMgmt

    30/380

    Installing ApplicationXtender Reports Management

  • 8/9/2019 AppXtender ReportsMgmt

    31/380

    The AppXtender Reports Mgmt Service Account 31

    8. Click OK to return to the Computer Management console.

    9. Close the Computer Management console.

    10. You now must configure the new account to have the Log on as aservice advanced right.

    For instructions, see Adding Advanced Rights to theAppXtender Reports Mgmt Service Account.

    Adding AdvancedRights to the

    AppXtender ReportsMgmt Service

    Account

    The AppXtender Reports Mgmt service account requires the Log onas a service advanced right.

    The following procedures describe how to add this right to theaccount you want to configure as the AppXtender Reports Mgmtservice account.

    To add advanced rights to the AppXtender Reports Mgmt serviceaccount:

    1. Log on to the domain. Make sure you are logged on as a member

    of the Local Administrators group.

    Note: This step must be performed on the domain because the rights fora user on the domain override the rights for the same user on thecomputer on which AppXtender Reports Mgmt is installed.

    2. Open the Local Security Settings console. From the Start menu,select Programs, then Administrative Tools. From the

    Administrative Tools program group, choose Local SecurityPolicy.

    The Local Security Settings console appears.

    Figure 7 Local Security Settings Console

    3. Expand the Local Policies folder, and then select User Rights

    Assignment. All user rights should appear in the right-side paneof the Local Security Settings Console.

    Installing ApplicationXtender Reports Management

  • 8/9/2019 AppXtender ReportsMgmt

    32/380

    32 ApplicationXtender Reports Management Administrators Guide

    4. Right-click Log on as a Service and choose Properties. TheProperties dialog box for that advanced right appears.

    Figure 8 Properties Dialog Box

    5. Click Add User or Group. The Select Users, Administrators, orGroups dialog box appears.

    Figure 9 Select Users, Administrators, or Groups Dialog Box

    6. Click Locations. The Locations dialog box appears.

    Installing ApplicationXtender Reports Management

  • 8/9/2019 AppXtender ReportsMgmt

    33/380

    The AppXtender Reports Mgmt Service Account 33

    Figure 10 Locations Dialog Box

    7. Select the domain where you created the AppXtender ReportsMgmt service account and click OK to return to the Select Users,Administrators, or Groups dialog box.

    8. Click Advanced. The advanced view of the Select Groups dialogbox appears.

    Figure 11 Select Groups Dialog Box, Advanced View

    Installing ApplicationXtender Reports Management

  • 8/9/2019 AppXtender ReportsMgmt

    34/380

    34 ApplicationXtender Reports Management Administrators Guide

    9. Click Find Now. The Search results panel appears. Select theaccount you created to use as the AppXtender Reports Mgmt

    service account and then click OK.

    10. Close the Local Security Settings console.

    Your Windows service account for the AppXtender ReportsMgmt services can now be used during AppXtender ReportsMgmt installation.

    Installing ApplicationXtender Reports Management

  • 8/9/2019 AppXtender ReportsMgmt

    35/380

    Running AppXtender Reports Mgmt Setup Wizard 35

    Running AppXtender Reports Mgmt Setup Wizard

    This section describes how to run the AppXtender Reports Mgmtsetup wizard.

    The account used to install AppXtender Reports Mgmt must be amember of the Local Administrators group of the computerwhere the installation is performed.

    In addition, the account used to install AppXtender Reports

    Mgmt should have the Log on as a Service Advanced Right. The AppXtender Reports Mgmt service account must be used to

    install AppXtender Reports Mgmt.

    To start the AppXtender Reports Mgmt setup wizard:

    1. Close all open applications.

    2. Obtain the installation files for AppXtender Reports Mgmt. You

    have the following choices: Download the ReportsMgmt_6.5.xxx.zip file from the EMC

    download center (http://Powerlink.EMC.com) to atemporary directory on your computer.

    Extract the installer zip file to the temporary directory. If youdownload multiple products, download all of them to thesame temporary directory.

    Insert the AppXtender Reports Mgmt setup media into yourmedia drive.

    3. In the temporary directory or media drive, navigate to theAppXtender Reports Mgmtdirectory and run setup.exe.

    AppXtender Reports Mgmt setup checks the computer forMicrosoft Data Access Components (MDAC), which is requiredto run AppXtender Reports Mgmt. If this is missing, AppXtender

    Reports Mgmt setup installs it.

    AppXtender Reports Mgmt setup also checks the computer forAdobe Acrobat Reader (which is required to view PDF reports inthe Report Viewer). If it is missing, a message appears remindingyou to install it before continuing with AppXtender ReportsMgmt setup.

    Installing ApplicationXtender Reports Management

    http://powerlink.emc.com/
  • 8/9/2019 AppXtender ReportsMgmt

    36/380

    36 ApplicationXtender Reports Management Administrators Guide

    If you want the ability to view PDF sample reports in ReportView, install Adobe Acrobat Reader (refer to the

    ApplicationXtender Release Notesfor the supported version of thesoftware). Start the setup wizard again.

    4. Click Next. The Welcome page appears.

    Figure 12 AppXtender Reports Mgmt Setup - Welcome Page

    5. Click Next. The License Agreement page appears.

    The License Agreement page allows you to read and accept thesoftware license agreement.

    Note: A product conflict page appears instead of the License Agreementpage if you have a previous version of the software. The Product Conflictpage allows you to uninstall previous releases. Click Remove all touninstall these releases. Click Next in the Ready to Continue page to

    display the License Agreement page.

    Installing ApplicationXtender Reports Management

  • 8/9/2019 AppXtender ReportsMgmt

    37/380

    Running AppXtender Reports Mgmt Setup Wizard 37

    Figure 13 AppXtender Reports Mgmt Setup - License Agreement Page

    6. Read the agreement, enable the I accept the license agreementoption and click Next to continue. The Customer Informationpage appears.

    Note: If you disagree with the terms, click Cancel to exit setup.

    Installing ApplicationXtender Reports Management

  • 8/9/2019 AppXtender ReportsMgmt

    38/380

    38 ApplicationXtender Reports Management Administrators Guide

    Figure 14 AppXtender Reports Mgmt Setup - Customer Information Page

    The User Name and Organization fields are self-populated, butyou are able to make changes to that information on this screen.

    7. Click the radio button to specify who can use this application onthe computer. If you select the top option, anyone who is usingthe computer has permission to use this application. If youspecify the bottom option, only the user name specified above has

    permission.

    8. Click Next to continue. The Destination Folder page appears.

    Installing ApplicationXtender Reports Management

  • 8/9/2019 AppXtender ReportsMgmt

    39/380

    Running AppXtender Reports Mgmt Setup Wizard 39

    Figure 15 AppXtender Reports Mgmt Setup - Destination Folder

    The Destination Folder page allows you to customize theAppXtender Reports Mgmt installation directory (the destinationfolder).

    By default, AppXtender Reports Mgmt installs to:

    C:\Program Files\XtenderSolutions\Content

    Management\AppXtenderReportsMgmt.

    In addition, the following folders are created during installation:

    Resource files for print stream processing reside in theConfiguration Server Data Path directory permanently, regardlessof configuration.

    When AppXtender Reports Mgmt detects AFP, Metacode, PCL,EBCDIC, EBCDIK, or non-standard ASCII print stream files in aspecified source directory, the AppXtender Reports Mgmt PrintStream Processor processes them and generates intermediate andlog files in the AppXtender Reports Mgmt Print Stream Processorworking directory.

    C:\ERMX\Config for configuration files

    C:\ERMX\PS Working for Print Stream working files

    C:\ERMX\RP Working for Report Processor working files

    Installing ApplicationXtender Reports Management

  • 8/9/2019 AppXtender ReportsMgmt

    40/380

    40 ApplicationXtender Reports Management Administrators Guide

    When designating a directory as the Configuration Server DataPath, Print Stream Working Path, or Report Processor Working

    Path, keep in mind that files may reside in these directoriespermanently, depending on your configuration.

    If you want to change a default destination folder for anyAppXtender Reports Mgmt data component click the Changebutton next to that component.

    9. Click Next.

    A Service Account page appears. This page lets you enter theaccount information for the AppXtender Reports Mgmt serviceaccount.

    Figure 16 AppXtender Reports Mgmt Setup - Service Account Page

    The Service Account Page lets you specify a domain, username

    and password that Reports Management can use to access localand network resources.

    The account is used by the Reports Management services, so itmust have the Log on as a service account privileges on thiscomputer.

    Note: The AppXtender Reports Mgmt services (Configuration Server,Report Processor, and Print Stream Processor) DO NOT install if the

    AppXtender Reports Mgmt user account is set up without a password.

    Installing ApplicationXtender Reports Management

  • 8/9/2019 AppXtender ReportsMgmt

    41/380

    Running AppXtender Reports Mgmt Setup Wizard 41

    10. Click Next after entering desired account credentials. The Readyto Install page appears.

    Figure 17 AppXtender Reports Mgmt Setup - Ready to Install Page

    11. Click Next. AppXtender Reports Mgmt begins installing thecomponents you selected. The Updating System page indicatesthe progress of the installation.

    Figure 18 AppXtender Reports Mgmt Setup - Installing Page

    Installing ApplicationXtender Reports Management

  • 8/9/2019 AppXtender ReportsMgmt

    42/380

    42 ApplicationXtender Reports Management Administrators Guide

    12. Wait for AppXtender Reports Mgmt to finish the installationprocess. This may take several minutes. A page appears,

    indicating a successful installation.

    Figure 19 AppXtender Reports Mgmt Setup - Installation Complete Page

    13. Click Finish. A Restart System prompt appears.

    14. Click Yes to restart the system.

    Note: It is highly recommended that you restart your system afterinstalling AppXtender Reports Mgmt. Otherwise, conflicts may occur.

    UninstallingAppXtender ReportsManagement

    This section describes how to uninstall AppXtender Reports Mgmt.

    To uninstall AppXtender Reports Mgmt:

    1. From the Windows Start menu, select Settings and then ControlPanel. From the Control Panel, select Add/Remove Programs.The Add/Remove Programs window appears.

    2. From the list of Currently installed programs, select AppXtenderReports Management Server. Click Remove. A confirmationmessage appears.

    Installing ApplicationXtender Reports Management

  • 8/9/2019 AppXtender ReportsMgmt

    43/380

    Running AppXtender Reports Mgmt Setup Wizard 43

    3. Click Yes. A message indicates the progress of the uninstallation.When AppXtender Reports Management has been successfully

    uninstalled, a message indicates that the system must berestarted.

    4. You have the following choices:

    To restart your computer now, click Yes.

    To close the message without restarting your computer, clickNo.

    CAUTION

    Restart your computer before installing the latest release ofAppXtender Reports Mgmt.

    For more information, see Preparing to Install AppXtender ReportsMgmt.

    Installing ApplicationXtender Reports Management

  • 8/9/2019 AppXtender ReportsMgmt

    44/380

    44 ApplicationXtender Reports Management Administrators Guide

    3

  • 8/9/2019 AppXtender ReportsMgmt

    45/380

    Using ApplicationXtender Reports Management 45

    Using

    ApplicationXtenderReports Management

    This chapter briefly describes how to configure AppXtender ReportsMgmt to process a print stream file or report file, and refers you to theappropriate chapter or sections of this manual for each step. This

    chapter also describes in detail what happens to a file as AppXtenderReports Mgmt processes it.

    For more information, see the following sections:

    How AppXtender Reports Mgmt Processes a File........................ 46 The Extraction Process ...................................................................... 50 Support for AppXtender Features ................................................... 61 Configuring AppXtender Reports Mgmt....................................... 63

    Maintaining AppXtender Reports Mgmt....................................... 71

  • 8/9/2019 AppXtender ReportsMgmt

    46/380

    Using ApplicationXtender Reports Management

    Wh t H t P i t St Fil ( ti d)

  • 8/9/2019 AppXtender ReportsMgmt

    47/380

    How AppXtender Reports Mgmt Processes a File 47

    If the processing attempt is not successful, AppXtender ReportsMgmt renames the stamp.CXEXTprint stream file tostamp_ext.FAILED, so that you can investigate the cause of the failure.

    4. AppXtender Reports Mgmt generates logs(stampCNV.LOGand stampMSG.LOG) inthe working directory for the print stream type.AppXtender Reports Mgmt updates these filesduring the whole process.

    AppXtender Reports Mgmtgenerates logs(38F4F7F2CNV.LOGand38F4F7F2MSG.LOG) inC:\ERMXDATA\PSWORKING\MY-AFP-PS.

    5. AppXtender Reports Mgmt creates a new recordin the STAT.DBFfile in the working directory

    for the print stream type. AppXtender ReportsMgmt updates this record during the wholeprocess.

    AppXtender Reports Mgmt updates theSTAT.DBFfile in

    C:\ERMXDATA\PSWORKING\MY-AFP-PS.

    6. AppXtender Reports Mgmt attempts to convertthe renamed print stream file to either a PDF fileor a standard ASCII file, depending on yourconfiguration.

    AppXtender Reports Mgmt converts38F4F7F2.CXAFP to RECORDS.PDFbecause the MY-AFP-PSprint stream type isconfigured for converting an AFP file to PDF.

    7. AppXtender Reports Mgmt places the resulting

    PDF file or ASCII file in the output directoryspecified for the print stream type.

    AppXtender Reports Mgmt places RECORDS.PDF

    in the C:\RPTSOURCESdirectory, which is thespecified output directory for the MY-AFP-PSprintstream type.

    8. AppXtender Reports Mgmt deletes the originalfile or moves the original file to the Archive,depending on your configuration.

    AppXtender Reports Mgmt moves the original file toC:\PSARCHIVE\2000\04\07, because thespecified source for the MY-AFP-PSprint streamtype is configured for archiving the original printstream files into subdirectories by year, month, anddate.

    9. Depending on configuration for the print streamtype, AppXtender Reports Mgmt might delete theSTAMP.CFGfile immediately after processing.

    AppXtender Reports Mgmt does not delete the38F4F7F2.CFGfile yet because theMY-AFP-PSprint stream type is not configured todelete this file immediately after processing.

    10.AppXtender Reports Mgmt deletes the generatedCFG and LOG files in the working directory forthe print stream type after the amount of time

    specified in the Purge Log Files after text box forthe print stream type.

    After 24 hours, AppXtender Reports Mgmt deletes38F4F7F2.CFG, 38F4F7F2CNV.LOG, and38F4F7F2MSG.LOGbecause the

    MY-AFP-PSprint stream type is configured tokeep these files only 24 hours after they weregenerated.

    Table 4 What Happens to a Print Stream File (continued)

    Event Example

    Using ApplicationXtender Reports Management

  • 8/9/2019 AppXtender ReportsMgmt

    48/380

    48 ApplicationXtender Reports Management Administrators Guide

    What Happens to a

    Report File

    The following table describes the sequence of events that begin whenyou place a report file that matches the specified file name mask inthe source directory. This sequence of events includes the upload ofindexed documents to AppXtender.

    Table 5 What Happens to a Report File

    Event Example

    1. You place a report file that matches the specifiedfile name mask in the source directory.

    The specified source for the my-pdf-rpt report type isany file that has a PDF extension in theC:\RPTSOURCESdirectory. You place a filenamed RECORDS.PDFin theC:\RPTSOURCESdirectory.

    2. AppXtender Reports Mgmt renames the reportfile to stamp.CXextwhere stampis atime-generated text string and extis the same asthe original file's extension. (AppXtender ReportsMgmt uses the same time-generated text string

    for all related files.)

    AppXtender Reports Mgmt renamesRECORDS.PDF to38F4F863_RECORDS.CXPDF.

    3. AppXtender Reports Mgmt copies the currentCFG file for the report type to the workingdirectory for the report type and renames it tostamp.CFG. This file is a snapshot of theconfiguration settings that AppXtender ReportsMgmt is using for the report file currently beingprocessed.

    AppXtender Reports Mgmt copiesMY-PDF-RPT.CFG fromC:\ERMXDATAtoC:\ERMXDATA\RPWORKING\MY-PDF-RP

    Tand renames it to 38F4F863.CFG.

    4. AppXtender Reports Mgmt generates logs(stampHST.LOGand stampMSG.LOG) inthe working directory for the report type.AppXtender Reports Mgmt updates these filesduring the whole process.

    AppXtender Reports Mgmt generates logs(38F4F863HST.LOGand38F4F863MSG.LOG) inC:\ERMXDATA\RPWORKING\MY-PDF-RP

    T.

    5. AppXtender Reports Mgmt creates a new recordin the STAT.DBFfile in the working directoryfor the report type. AppXtender Reports Mgmt

    updates this record during the whole process.

    AppXtender Reports Mgmt updates theSTAT.DBFfile inC:\ERMXDATA\RPWORKING\MY-PDF-RP

    T.

    Using ApplicationXtender Reports Management

    Table 5 What Happens to a Report File (continued)

  • 8/9/2019 AppXtender ReportsMgmt

    49/380

    How AppXtender Reports Mgmt Processes a File 49

    If the processing attempt is not successful, AppXtender ReportsMgmt renames the stamp.CXextreport file to stamp.FAILEDext, so thatyou can investigate the cause of the failure.

    6. AppXtender Reports Mgmt attempts to extractindex information from the renamed report file.AppXtender Reports Mgmt creates thestamp.CXIDX file. While AppXtenderReports Mgmt extracts values, AppXtenderReports Mgmt updates the CXIDX file with thosevalues.

    AppXtender Reports Mgmt extracts indexinformation from 38F4F863_RECORDS.CXPDFand uploads the indexed document toAppXtender.

    7. AppXtender Reports Mgmt deletes the originalfile, leaves the renamed file in the sourcedirectory, or moves the original file to the Archive,depending on your configuration.

    AppXtender Reports Mgmt moves the original file toC:\RPTARCHIVE\2000\04\07, becausethe specified source for the my-pdf-rpt report type isconfigured for archiving the original report files intosubdirectories by year, month, and date.

    8. AppXtender Reports Mgmt deletes the generatedCFG and LOG files in the working directory forthe report type after the amount of time specifiedunder Files Keeping (After Failure or After

    Success Completion) for the report type.

    After 24 hours, AppXtender Reports Mgmt deletes38F4F863.CFG, 38F4F863HST.LOG, and38F4F863MSG.LOGbecause the my-pdf-rptreport type is configured to keep these files only 24

    hours after they were generated.

    Table 5 What Happens to a Report File (continued)

    Event Example

    Using ApplicationXtender Reports Management

  • 8/9/2019 AppXtender ReportsMgmt

    50/380

    50 ApplicationXtender Reports Management Administrators Guide

    The Extraction Process

    The following sections introduce concepts to help you understandthe AppXtender Reports Mgmt Report Processor's extraction process.

    Extracting the Index Valuesbriefly describes how theAppXtender Reports Mgmt Report Processor extracts indexvalues from report files.

    Understanding Propagation of Index Valuesdescribes theconcept of index field propagation.

    Using Different Indexing Optionsdescribes some of theindexing options available to you and explains how these optionsaffect the resulting index records and document pages.

    Compressing Report Files for Storagedescribes howAppXtender Reports Mgmt Report Processor provides flexibilitywith compression.

    Note: When you create an application in AppXtenderfor storing documentsfrom AppXtender Reports Mgmt, if you configure any of the index fieldswith a date format, select the date format carefully. For more information, seeImportant Information about Extracting Dates.

    Extracting the IndexValues

    The major function of AppXtender Reports Mgmt is report indexing.The report-structured indexing performed by the AppXtenderReports Mgmt Report Processor is a process of generating index tablerecords by extracting data from report pages.

    The Extract Definition Script (XDS), a specialized, high-levelprocedure language developed specifically for AppXtender ReportsMgmt, provides the means for defining the extraction procedure foreach report.

    The role of the AppXtender Reports Mgmt Report Processor is tointerpret the extraction procedure created for a report. The XDSinterpreter processes a report page by page and extracts dataaccording to XDS instructions to create a set of index values that arestored in an AppXtender database table.

    The report file is stored in the AppXtender data storage location andcan be retrieved in AppXtender using the stored index values.

    If your AppXtender Reports Mgmt license supports the businessintelligence gateway (B.I. gateway) feature, you can use AppXtender

    Using ApplicationXtender Reports Management

    Reports Mgmt to extract a set of index values from your reports and

  • 8/9/2019 AppXtender ReportsMgmt

    51/380

    The Extraction Process 51

    Reports Mgmt to extract a set of index values from your reports andexport this data in a format that can be used in business intelligence

    applications.

    Figure 20 AppXtender Reports Mgmt Indexing Process

    For information on the XDS language, refer to the XDS ReferenceOnline Help.

    UnderstandingPropagation ofIndex Values

    Extracting index records from a report may be complex if the report'sstructure is hierarchical. The report may begin with headerinformation and contain a series of subsections. Each of thesesubsections may begin with header information, contain a list ofunique values, and end with a total.

    Each subsection must be represented by a series of index records, onefor each of the unique values. In the index records for each

    subsection, the subsection's header information and totals must berepeated. In the index records for the whole report, the report'sheader information must be repeated.

    AppXtender Reports Mgmt Report Processor

    (extraction procedure

    written in XDS)

    Index

    Record 1

    1 2 3 4

    Index

    Record 2

    Report Pages

    1 2

    3 4

    Report

    AppXtender Document

    Storage Location

    AppXtender Database

    Data for Use in

    BI Analysis

    Sets of Index Values

    Using ApplicationXtender Reports Management

  • 8/9/2019 AppXtender ReportsMgmt

    52/380

    52 ApplicationXtender Reports Management Administrators Guide

    Figure 21 Forward, Non-Propagating, and Backward Index Values

    In other words, the index value for the report's header must be

    propagated forward until the next report's header occurs. The indexvalue for each subsection's header must be propagated forward untilthe next subsection header occurs. The index value for eachsubsection's total must be propagated backward until the previoussubsection total occurs. The unique values are not propagated at all.

    1 2

    3 4

    5 6

    Forward-propagating Value

    Backward-propagating Value

    Non-propagating Value

  • 8/9/2019 AppXtender ReportsMgmt

    53/380

    Using ApplicationXtender Reports Management

  • 8/9/2019 AppXtender ReportsMgmt

    54/380

    54 ApplicationXtender Reports Management Administrators Guide

    Figure 23 Example Report Structure for Using Propagation Levels

    In this example, you would want to use no level setting (default) forPage #, level 1 for Invoice #, and level 2 for Customer # and Address.

    Invoice #

    13579

    Page#

    1

    Customer#

    111

    Address

    88 Bit Rd. 20906

    Item Description Price

    Item Description Price

    Item Description Price

    Total

    Invoice #

    14703

    Page#

    (blank)

    Customer#

    222

    Address

    88 Byte St. 20817

    Item Description Price

    Item Description Price

    Total

    Invoice #

    24680

    Page#

    2

    Customer#

    333

    Address

    (blank)

    Item Description Price

    Item Description Price

    Total

    SHOULD be Forward-propagated

    Non-propagating

    Backward-propagating

    SHOULD NOT be Forward-propagated

    Forward-propagating

  • 8/9/2019 AppXtender ReportsMgmt

    55/380

  • 8/9/2019 AppXtender ReportsMgmt

    56/380

    Using ApplicationXtender Reports Management

    The Date field is forward propagated, and the date value wasextracted from a separate page so that page is not associated with the

  • 8/9/2019 AppXtender ReportsMgmt

    57/380

    The Extraction Process 57

    extracted from a separate page, so that page is not associated with theindex records.

    Figure 24 Using Neither Group Nor Combine

    For instructions on disabling the Group pages by index option andthe Combine pages by forward propagated values indexing option,

    see Configuring the Upload Page.

    For instructions on setting index field propagation, see ChangingIndex Field Propagation.

    Combining Pages ofDuplicate Index

    Records

    If you enable the Group pages by index option, AppXtender ReportsMgmt combines the pages of duplicate index records (within eachsession) into a single document. All pages that share all of their index

    values will be grouped together as one document in AppXtender.Pages need not be consecutive to be grouped together.

    In the following figure, the Account # field and the Amount field arethe non-propagated index fields. The pages from which the accountnumber and amount were extracted are associated with the indexrecord. The Date field is forward propagated, and the date value was

    Report

    Page 5

    111116

    123456

    111117

    111118

    $20.00

    $41.50

    $20.00

    $40.00

    Report

    Page 2

    111113

    123456

    111114

    111115

    $20.00

    $41.50

    $20.00

    $40.00

    Index Records

    Account# Date Amount

    123456

    123456

    2000/01/01 $41.50

    $41.502000/01/01

    Two Separate Documents

    Using ApplicationXtender Reports Management

    extracted from a separate page, so that page is not associated with theindex record.

  • 8/9/2019 AppXtender ReportsMgmt

    58/380

    58 ApplicationXtender Reports Management Administrators Guide

    index record.

    Figure 25 Combining Pages of Duplicate Index Records

    For instructions on enabling the Group pages by index option, seeConfiguring the Upload Page.

    For instructions on setting index field propagation, see ChangingIndex Field Propagation.

    Combining allRelevant Pages

    If you enable the Combine pages by forward propagated valuesoption, AppXtender Reports Mgmt associates with each index recorda sequence of pages (all pages of the report in sequence in which theforward-propagating index values and the backward-propagatingindex values are the same).

    In the following figure, the Account # field and the Amount field arethe non-propagated index fields. The Date field is forward

    propagated. The pages from which each index value was extractedare associated with the index record.

    Report

    Page 5

    111116

    123456

    111117

    111118

    $20.00

    $41.50

    $20.00

    $40.00

    Report

    Page 2

    111113

    123456

    111114

    111115

    $20.00

    $41.50

    $20.00

    $40.00

    Index Record

    Account# Date Amount

    123456 2000/01/01 $41.50

    Two Pages of One Document

    Using ApplicationXtender Reports Management

    Index Record

  • 8/9/2019 AppXtender ReportsMgmt

    59/380

    The Extraction Process 59

    Figure 26 Combining All Relevant Pages

    If you enable the Combine pages by forward propagated valuesoption, AppXtender Reports Mgmt also associates multiple indexrecords to the same document.

    That is, all of the index records that have been produced from thesame set of pages are associated with the same BIN file. This is trueregardless of the applications setting for the Multiple indexesreferencing a single document option.

    For instructions on enabling the Combine pages by forwardpropagated values indexing option, see Configuring the Upload Page.

    For instructions on setting index field propagation, see ChangingIndex Field Propagation.

    Compressing Report

    Files for Storage

    The AppXtender Reports Mgmt Report Processor compresses

    standard ASCII report files during the extraction process, whichallows for flexibility in how the reports are stored. In addition, thecompression used on the report file is configurable.

    If it is more important to you to save time than to save space, youcan configure reports to be stored using no compression.

    Report

    Page 2

    111116

    123456

    111117

    111118

    $20.00

    $41.50

    $20.00

    $40.00

    Report

    Page 1

    111113

    111114

    111115

    $20.00

    $20.00

    $40.00

    Index Record

    Account# Date Amount

    123456 2000/01/01 $41.50

    Two Pages of One Document

    2000/01/01

    Using ApplicationXtender Reports Management

    If it is more important to you to save space than to save time, youcan configure reports to be compressed using size as the

  • 8/9/2019 AppXtender ReportsMgmt

    60/380

    60 ApplicationXtender Reports Management Administrators Guide

    g p p gcompression criteria. You can also use speed or a balance betweenspeed and size as compression criteria.

    For instructions, see Configuring the Storage Page.

    ImportantInformation aboutExtracting Dates

    When you create an application in AppXtender for storingdocuments from AppXtender Reports Mgmt, if you configure any ofthe index fields with a date format, select the date format carefully.

    If you select one of the following date formats, you must make surethe dates you intend to extract with AppXtender Reports Mgmt usehyphens to set apart the year, as shown in the Example column of thefollowing table:

    CAUTION

    If, while processing a report file, AppXtender Reports Mgmtextracts a date that does not set apart the year (for example,059206) and attempts to upload the indexed report to anAppXtender application that has one of these date formats, the datefield will not be populated.

    Table 7 Date Formats that Require a Hyphenated Year

    Date Format Example

    MM-YY-DD 05-9206

    MMM-YY-DD MAY-9206

    YY-MM-DD 92-0506

    YY-DD-MMM 92-06MAY

    Using ApplicationXtender Reports Management

    Support for AppXtender Features

  • 8/9/2019 AppXtender ReportsMgmt

    61/380

    Support for AppXtender Features 61

    AppXtender Reports Mgmt supports several AppXtender features.

    Some of these features require configuration in the AppXtenderReports Mgmt Configuration Admin, some in AppXtender. For moreinformation, see the following sections.

    HIPAA Compliance Supportdescribes the audit trail commentAppXtender Reports Mgmt supplies to support HIPAAcompliance.

    Configuring Volume Label Search Drive(s)describes how tospecify one or more volume label search drives for anAppXtender data source.

    Configuring Max Future Yearsdescribes how to configure theMax Future Years setting so that AppXtender interprets two-digityears appropriately.

    Creating a New Report Typeincludes a description of theAppXtender Reports Mgmt Enable report view option, whichsupports the AppXtender Report View feature.

    Using Form Overlaydescribes form overlay, one of theAppXtender features supported by AppXtender Reports Mgmt.

    HIPAA Compliance

    Support

    The Health Insurance Portability and Accountability Act of 1996

    (HIPAA) was put in place to protect health care patients by regulatinghow patient records are stored and accessed.

    AppXtender Reports Mgmt facilitates compliance with the HIPAAregulations by adding an audit trail comment for HIPAA-compliantenabled applications for each new document and page as follows.

    [2003-06-02 21:06:57]

    SYSOP,100001,RKWSKA.legato.com,Unknown

    Action(500),2,1,ERMXtender added a new

    document;MODULE=ERMXReportProcessor

    [2003-06-02 21:06:57]

    SYSOP,100001,RKWSKA.legato.com,Unknown

    Action(500),2,1,ERMXtender added a new

    page;MODULE=ERMXReportProcessor

    Using ApplicationXtender Reports Management

    When the Reason Code option is enabled for an AppXtenderapplication and the Audit Trail option is enabled, all document

    i i i il d i di d

  • 8/9/2019 AppXtender ReportsMgmt

    62/380

    62 ApplicationXtender Reports Management Administrators Guide

    creation, printing, e-mail, and export actions are audited.

    For more information about audit trails, refer to theApplicationXtender Core Components Administrator s Guide.

    Note: Only users with the User Security Maint privilege granted can modifyglobal audit trail settings. To modify each applications audit trail settings,the user must have the Modify App privilege on that application.

    Using ApplicationXtender Reports Management

    Configuring AppXtender Reports Mgmt

  • 8/9/2019 AppXtender ReportsMgmt

    63/380

    Configuring AppXtender Reports Mgmt 63

    This section provides the following overview procedures for thismanual

    Configuring AppXtender Reports Mgmt for Print Stream Filesprovides an overview for the entire process of configuringAppXtender Reports Mgmt to convert a set of print stream filesinto report files, and extract index information from that set ofreport files.

    Configuring AppXtender Reports Mgmt for Report Filesprovides an overview for the entire process of configuringAppXtender Reports Mgmt to extract index information from aset of report files.

    Configuring AppXtender Reports Mgmt for BusinessIntelligence Applicationsdescribes how to configureAppXtender Reports Mgmt to export data from your reports to a

    file that can be used in business intelligence applications.

    ConfiguringAppXtender ReportsMgmt for PrintStream Files

    The following procedure provides an overview for the entire processof converting a set of print stream files of a particular type into reportfiles, and extracting index information from that set of report files.

    To process a set of print stream files:

    1. Create a print stream type for the set of print stream files.

    For instructions, see Creating a New Print Stream Type.

    2. Make sure the computer on which AppXtender Reports Mgmt isinstalled is connected to the system AppXtender data source towhich you intend to upload indexed documents.

    For instructions, see Linking to AppXtender Data Sources.

    3. Make sure the AppXtender application to which you intend tostore indexed documents has been created.

    For instructions, see theApplicationXtender Core ComponentsAdministrators Guide.

    Note: When you create an application in AppXtender for storingdocuments from AppXtender Reports Mgmt, if you configure any of theindex fields with a date format, select the date format carefully. For more

    information, see Important Information about Extracting Dates.

    Using ApplicationXtender Reports Management

    4. Create a report type for the set of report files that you want toprocess. For instructions, see Creating a New Report Type.

  • 8/9/2019 AppXtender ReportsMgmt

    64/380

    64 ApplicationXtender Reports Management Administrators Guide

    5. Make sure the propagation of index fields is appropriate for thestructure of the report files.

    For instructions, see Changing Index Field Propagation.

    6. Create extraction procedures.

    For instructions, see Creating a New Procedure.

    7. You can use XDS Visual Tester to test these procedures.

    For instructions, see Using XDS Visual Tester.

    8. Create at least one source specification for the report type. Forinstructions, see Specifying a Source for a Report Type.

    9. Create at least one source specification for the print stream type.You can specify the source directory for the report type as theoutput directory for the print stream type.

    For instructions, see Specifying a Source for a Print StreamType.

    10. Place the files that you want to convert in the print stream sourcedirectory.

    The AppXtender Reports Mgmt Print Stream Processor processesthe files according to the current print stream type configurationand source specifications for the print stream type.

    If you have specified the source directory for the report type asthe output directory for the print stream type, then theAppXtender Reports Mgmt Report Processor immediatelyprocesses the files according to the current report typeconfiguration, procedures, index field propagation settings, andsource specifications for the report type.

    ConfiguringAppXtender ReportsMgmt for ReportFiles

    The following procedure describes how to process a set of report files.

    To generate indexed AppXtender documents from a set of reportfiles:

    1. Make sure the system AppXtender data source to which youintend to upload indexed documents has been added on thecomputer on which AppXtender Reports Mgmt is installed. Forinstructions, see Managing AppXtender Data Sources.

  • 8/9/2019 AppXtender ReportsMgmt

    65/380

    Using ApplicationXtender Reports Management

    Business intelligence applications generally extract data only fromASCII files in which the data has already been organized into rows(records) and columns (fields).

  • 8/9/2019 AppXtender ReportsMgmt

    66/380

    66 ApplicationXtender Reports Management Administrators Guide

    ( eco ds) a d co u s ( e ds)

    If your AppXtender Reports Mgmt license supports the BusinessIntelligence Gateway (B.I. gateway) feature, you can use AppXtenderReports Mgmt to extract data from your reports and export this datain a format that can be used in business intelligence applications. Thisexport is performed simultaneously with the upload of indexeddocuments to AppXtender.

    The B.I. Gateway interface of AppXtender Reports Mgmt includes theability to initiate a script file, written in either VBScript or JavaScript,immediately following completion of the data export file.

    For more information about scripting for business intelligenceapplications, see theApplicationXtender Reports Management ScriptingUser's Guide.

    In addition, if you have already used AppXtender Reports Mgmt togenerate indexed AppXtender documents from reports, you cansubmit those reports from AppXtender to AppXtender Reports Mgmtand use AppXtender Reports Mgmt to process those reports again.

    When these reports are processed by AppXtender Reports Mgmt asecond time, if you have configured AppXtender Reports Mgmt forbusiness intelligence analysis, AppXtender Reports Mgmt exportsdata from these reprocessed reports to a file for use in a businessintelligence application.

    When a report is submitted from AppXtender to AppXtender ReportsMgmt, AppXtender generates an INI file that preserves data integrityby disabling the upload of documents to AppXtender for that report.

    If your AppXtender Reports Mgmt license supports the B.I. gatewayfeature, the ways in which you can use AppXtender Reports Mgmthave been expanded.

    The following figure shows that you can generate AppXtenderindexed documents, an exported file for use in business intelligenceapplications, or both.

    This figure also demonstrates that the exported file can be generatedeither from original reports or from indexed documents inAppXtender.

    Using ApplicationXtender Reports Management

    Basic AppXtender Reports Mgmt Additional AppXtender Reports Mgmt

    Usage Scenarios

  • 8/9/2019 AppXtender ReportsMgmt

    67/380

    Configuring AppXtender Reports Mgmt 67

    Figure 27 AppXtender Reports Mgmt Usage Expanded by B.I. Gateway License

    Note: If the Enable report view option was not used in the report type thatAppXtender Reports Mgmt originally used to process a report, the report thatAppXtendersends back to AppXtender Reports Mgmt is not the originalreport. It is a report reconstructed from the selected documents.

    The procedure for configuring AppXtender Reports Mgmt to exportdata for business intelligence applications varies depending on thescenario in which you are using AppXtender Reports Mgmt.

    The following sections provide overview procedures for eachscenario.

    Uploading Indexed Documents to AppXtender and Exporting aFile for Business Intelligence Analysis from Original Reports

    Exporting a File for Business Intelligence Analysis from IndexedDocuments

    Original Reports

    Indexed Documents

    in AppXtender

    AppXtender Reports Mgmt

    Usage Scenario

    Original Reports

    AppXtender Reports Mgmt

    Indexed Documents

    in AppXtender and Exported File

    (both simultaneously)

    Indexed Documents

    in AppXtender

    AppXtender Reports Mgmt

    Exported File Alone

    (not uploading to

    AppXtender)

    Usage Scenarios

    Allowed by B.I. Gateway License

    Using ApplicationXtender Reports Management

    In each case, consider using XDS Visual Tester to test each report typebefore using it in a production environment. For instructions, seeRecommended Method of Testing Proceduresand Using XDS

  • 8/9/2019 AppXtender ReportsMgmt

    68/380

    68 ApplicationXtender Reports Management Administrators Guide

    Visual Tester.

    Uploading IndexedDocuments to

    AppXtender andExporting a File for

    Business IntelligenceAnalysis from Original

    Reports

    The following overview procedure describes how to configureAppXtender Reports Mgmt to simultaneously generate indexeddocuments in AppXtender and export files for use in a businessintelligence application.

    To configure AppXtender Reports Mgmt:

    1. Configure AppXtender Reports Mgmt to process report files (andprint stream files, if necessary).

    For instructions, see Configuring AppXtender Reports Mgmt forReport Filesand Configuring AppXtender Reports Mgmt forBusiness Intelligence Applications.

    2. Perform the following additional configurations in theAppXtender Reports Mgmt Configuration Admin.

    Specify the data export path. For instructions, see Specifyingthe Data Export Path.

    Configure the B.I. Gateway tab for the report type. Forinstructions, see Configuring the B.I. Gateway Page.

    3. If you want AppXtender Reports Mgmt to extract moreinformation for business intelligence gathering purposes (in

    addition to the index information extracted for AppXtenderdocument creation), perform the following additionalconfigurations in the AppXtender Reports Mgmt ConfigurationAdmin.

    Create additional data fields for the report type. Forinstructions, see Creating Fields for Export to BusinessIntelligence Files.

    Edit the report types procedures to extract and store values inthe new data fields. For instructions, see Editing Procedures.

    When AppXtender Reports Mgmt processes a report based on theconfigured report type and report source, indexed documents areuploaded to AppXtender and a file is exported to the data exportpath.

    Using ApplicationXtender Reports Management

    Exporting a File forBusiness Intelligence

    Analysis from Indexed

    The following overview procedure describes how to configureAppXtender Reports Mgmt and AppXtender so that you can submitdocuments in AppXtender back to AppXtender Reports Mgmt for the

  • 8/9/2019 AppXtender ReportsMgmt

    69/380

    Configuring AppXtender Reports Mgmt 69

    Documents purpose of exporting files for a business intelligence application.

    To configure AppXtender Reports Mgmt and AppXtender:

    1. Configure AppXtender Reports Mgmt to process report files (andprint stream files, if necessary). For instructions, see ConfiguringAppXtender Reports Mgmt for Report Filesand ConfiguringAppXtender Reports Mgmt for Print Stream Files.

    2. Perform the following additional configurations in theAppXtender Reports Mgmt Configuration Admin.

    Specify the data export path. For instructions, see Specifyingthe Data Export Path.

    Specify the B.I. gateway path. For instructions, see Specifyingthe B.I. Gateway Path.

    Configure the B.I. Gateway tab for the report type. For

    instructions, see Configuring the B.I. Gateway Page.

    Configure a report source to use an INI file and specify a UNCpath as the source directory. For instructions, see AccessingReport Data in WMI.

    Note: At this point, AppXtender Reports Mgmt generates informationabout the report type and report source in an ERMX.INI file in thespecified B.I. gateway path.

    3. If you want AppXtender Reports Mgmt to extract moreinformation for business intelligence gathering purposes (inaddition to the index information extracted for AppXtenderdocument creation), perform the following additionalconfigurations in the AppXtender Reports Mgmt ConfigurationAdmin.

    Create additional data fields for the report type. Forinstructions, see Creating Fields for Export to BusinessIntelligence Files.

    Edit the report types procedures to extract and store values inthe new data fields. For instructions, see Editing Procedures.

    4. Specify a Business Intelligence Gateway Path in AppXtender (onthe Paths tab of the Configuration dialog box). This path must be

    equivalent to the B.I. gateway path in AppXtender Reports Mgmt

    Using ApplicationXtender Reports Management

    so that AppXtender can find the ERMX.INI file. For instructions,refer to theApplicationXtender Core Components AdministratorsGuide.

  • 8/9/2019 AppXtender ReportsMgmt

    70/380

    70 ApplicationXtender Reports Management Administrators Guide

    5. Submit reports from AppXtender to AppXtender Reports Mgmt.For instructions, refer to theApplicationXtender Users Guide.

    AppXtender generates a TXT or PDF report and its correspondingINI file in the specified source directory. Because of the reportsource that is configured to use an INI file, AppXtender ReportsMgmt processes the AppXtender-generated report.

    When this processing is complete, AppXtender Reports Mgmtexports a file to the specified data export path. Because of theUpload=No line in the AppXtender-generated INI file,

    AppXtender Reports Mgmt does not generate indexeddocuments from the reports.

    Note: Two different kinds of INI files are used in this scenario:AppXtender Reports Mgmt generates the ERMX.INI file for the purposeof communicating with AppXtender about the report types for which theB.I. gateway feature is configured. AppXtender, in turn, generates INIfiles for the purpose of communicating with AppXtender Reports Mgmtabout the reports that are submitted from AppXtender. The root filename of each INI file matches the root file name of its correspondingreport.

    Using ApplicationXtender Reports Management

    Maintaining AppXtender Reports Mgmt

    Th t i t t A Xt d R t M