RM 50a SysAdmin Guide

u
Report Manager
Report Manager System Administrators Handbook

Release 5.0a April 2009
Notices
This document contains information proprietary to FileNet Corporation (FileNet). Due to continuing product development, product specifications and capabilities are subject to change without notice. You may not disclose or use any proprietary information or reproduce or transmit any part of this document in any form or by any means, electronic or mechanical, for any purpose, without written permission from FileNet. FileNet has made every effort to keep the information in this document current and accurate as of the date of publication or revision. However, FileNet does not guarantee or imply that this document is error free or accurate with regard to any particular specification. In no event will FileNet be liable for direct, indirect, special incidental, or consequential damages resulting from any defect in the documentation, even if advised of the possibility of such damages. No FileNet agent, dealer, or employee is authorized to make any modification, extension, or addition to the above statements. FileNet may have patents, patent applications, trademarks, copyrights, or other intellectual property rights covering subject matter in this document. Furnishing this document does not provide any license to these patents, trademarks, copyrights, or other intellectual property. Please take a few moments to read the End User License Agreement on the Image Services 4.0.0 documentation CD. By installing the Image Services 4.0.0 software, the customer agrees to be bound by the terms of this agreement. FileNet, ValueNet, Visual WorkFlo, and OSAR are registered trademarks of FileNet Corporation. Document Warehouse and UserNet are trademarks of FileNet Corporation. All other product and brand names are trademarks or registered trademarks of their respective companies. Copyright 1994, 2007 FileNet Corporation. All rights reserved.
FileNet Corporation 3565 Harbor Boulevard Costa Mesa, California 92626 800.FILENET (345.3638) Outside the U.S., call: 1.714.327.3400 www.filenet.com
Contents
Contents
Introduction
18
19 20 22 22 22 24 24 23
Report Manager Components Service Controller Server Components Traffic Service Storage Service Index Service
Report Manager Administration Administrative Component Statement Processing Image Services IDM Desktop Web Services 25 25 25 24
The Report Manager Process Flow Standalone Server 26 28 Rollover to Image Services Feature Chart 39
26
Cross-cataloging with Image Services 29 System Administrator Responsibilities 41
Document Types
44
44 45
Data Format Requirements Line Printer ASCII Data
April 2009
Report Manager System Administrators Handbook, Release 5.0a 3
Contents
Data Files Using ANSI Carriage Control Processing Text Data Processing APA Data IBM AFP Data Transferring Data AFP 49 50 48 49 49 49 45 47
45
Xerox Metacode Data
Choosing a File Transfer Method Metacode
Organizing Folders 52
Folder Structure 53 54 55 Default Folder Settings The Loading Process Items in Folders Folder Security 57 58
Limits and Constraints 57 Number of Folders 58 Creating a Folder 58 Changing Folder Names 59
Loading Documents
Storage Service 65
64
To load documents 65 Storage Service Processing 66
April 2009
Contents
Data in PRMLoad
66 67 71 74
Processing ASCII line data
Processing AFP and Metacode Reports Running Multiple Services Storage Service Loading 80 81 82 83 77 78 General Guidelines Report Processing 76
Processing AFP and Metacode Statements
Statement Processing
Compressed Archive Structure
Working with Document Templates

Understanding Document Templates The Document Template Components Document Type Document Layout Form Overlay 87 87 88 89 87 86 87 84 86
84
Document Storage Profile Report Cataloging Using Document Templates
Initial Document Template Settings Using the Open Document Dialog Box Creating a New Document Template
Using the Document Template Management Dialog Box 92 94
90
April 2009
Contents
Completing the Storage Tab Loading Options Reports 100 100
95 96
Defining a File Specification Statements 100
ANSI Carriage Control 101 Storage Profiles 108 108 109 110 Modifying Document Templates Deleting Document Templates Copying Document Templates Exporting a Layout 112 114
Configuring Document Storage Profiles 112 Creating New Document Storage Profiles Document Record Removal Document Delete 121 121 122 118
Modifying a Document Storage Profile Identifying Where Profiles are Used Deleting a Document Storage Profile Completing the Display Tab Completing the IDM Tab 125 132 128
Changing the Default Document Storage Profile 123 124
Completing the Statement Tab
Creating Statement Templates

Statement Administrator Statement vs. Page Security 135 136 136 Statement vs. Report Comparison
135
April 2009
Contents
Creating New Templates
139
Starting the Statement Administrator 140 Displaying the Statement Template Window 141 Loading the AFP or Metacode Statement Specifying a Page Name and Page Type Page 158 159 172 167 143 152 157
Conditional vs. Unconditional Statement Start Defining Locators Defining Fields
Testing Your Layout
Locate Statement Pages Results 173 Display Text in Zones Results 174 Completing Statement Administrator Activities Editing Fields and Locators Deleting Fields and Locators Deleting Pages 177 177 178 181 183 180 Editing Statement Templates Deleting Statement Templates 176 176 176
Renaming a Statement Template Changing Statement Preferences
Specifying Traffic Service RPC Parameters Specifying APA File Parameters 184 Specifying Zone Colors 185 What to do After Creating Statement Templates
186
Statement Indexes 187

The Indexing Process 187 191 Generating Indexes for Statement Documents
April 2009
Contents
Avoiding Multiple Indexing
192 192 196 197 197 198
Defining Index Storage Profiles
Creating New Index Storage Profiles 193 Modifying an Index Storage Profile Deleting an Index Storage Profile Changing the Default Index Storage Profile Identifying Where Profiles are Used
Document Layouts
Planning a Layout
199
200 200 200 200
Understanding Layouts
Identifying Document Characteristics Understanding Layout Components Layout Sections 201 205 Section Types Groups 206
Detail Sections 205 Page Headers and Page Footers 206 Document Header and Document Footer 207 Section Type Examples 207 Section Locators Section Fields Layout Tips 214 215 216 216 223 209 213
AFP and Metacode Issues
Defining a Document Layout Defining Sections in a Document Accessing Layout View
216
Editing Document Sections
April 2009
Contents
Deleting Document Sections Defining Section Locators Literal Locators Pattern Locators Editing Locators Deleting Locators 224 229 234 234 224
223
Defining Fields in a Document Editing Document Fields Deleting Document Fields 241 242
234 239
Copy Forward Value to Null Descendants
Saving a Document Layout 242 Creating Statement Templates 242
Document Form Overlays

Graphic Formats 244
244
245
Using a Print File Text as a Guide Importing a Form Overlay 245
Matching a Form Overlay with a Document Deleting a Form Overlay 249
247
10
Document Indexes
Index Types 250 251 251
250
250
The Report Manager Index Index Structure Index Properties
Index Storage Profile

April 2009
251
Contents
Index Type Index Fields Data Types
252 252 254 254 255 256 256 256 257 257
252
Native Indexing
The Indexing Process Cross-Catalog Types
Cross Cataloging (Indexing to Image Services) Cross-Catalog by Index Cross-Catalog by Report
Cross-Catalog by Statement Managing Document Indexes
Avoiding Multiple Indexing 258 Adding a New Index 259 261 Completing the General Tab Naming the Index 261 Enabling or Disabling the Catalog 261 Adding Index Fields 264 Completing the Retention Tab Completing the Filter Tab Every Occurrence 270 First Occurrence on Every n Pages 270 Complete the Index Properties Dialog Box Finish Adding the New Index 271 276 280 271 269 267
Linking the Index to Document Templates 271 Linking the Index and Document Fields Modifying or Removing an Existing Index
April 2009
Report Manager System Administrators Handbook, Release 5.0a
10
Contents
11
Cross-Cataloging
Overview 282
282
284 287 288 292 297 294
Index Field Requirements Cross-Cataloging Types Cross-Cataloging by Report
Cross-cataloging by Transaction Indexes Cross-Cataloging by Statement
Cross-Cataloging Effects on Image Services F_doclocation values 297 Effects of Cross-cataloging by Report 299
Effects of Cross-Cataloging by Transaction Index or by Statement 300 Additional Considerations Cross-Cataloging Events Loading 302 Administration of Existing Documents 302 De-Cataloging by Index Storage Profile 302 300 301 Indexer Queue Entries 301
12
Security
304
304 305 305
Setting Up Security
IDM Integrated Security
Single Logon Account for Multiple IDM Users Report Manager Security Security Hierarchy Example
April 2009
To set up a single logon account for multiple IDM users 305 306 306 309
11
Report Manager Security Hierarchy
Contents
Setting Up Report Manager Security Working with Groups 311
309 312
Adding Groups to Report Manager Security
Defining User Type and Group Name 312 Granting and Denying Document Access 315 Viewing and Modifying Group Properties Working with Users 319 317 318 Removing Groups from Report Manager Security Adding Users to Report Manager Security 319 Defining User Type, Login Name, and User Name 319 Defining Report Manager Function Access Document Access 321 Administrative Functions 321 Selecting a User Stamp Adding Users to Groups 323 328 331 333 336 Granting and Denying Document Access 326 Viewing and Modifying User Properties 330 Removing Users from Report Manager Security Working with Superusers 332 335 Adding Superusers to Report Manager Security Viewing and Modifying Superuser Properties 321
Removing Superusers from Report Manager Security
13
Managing Documents
Moving Documents Deleting Documents Deleting Folders 347 338 343
338
April 2009
12
Contents
14
Archiving and Rollover

Defining Terms Process Flow Optical Transfer Document Delete Index Purge 357 349 352
349
Reports Archival (Archive Generation) 355 356 356 357 Document Record Removal Magnetic Cache Purge
354
Appendix A - Service Controller

SCM Connections RPC Connections 358 360
358
358
Service Controller Connections
RPC Connection Protocols Adding Connections 361
360 361 362 363
Security and Administrative Rights
Running the Service Controller for the First Time Creating a New Index Service Saving the Connections 366 365
Creating a New Traffic Service or Storage Service Connection
Appendix B Traffic Service
367
Accessing Traffic Service 367
April 2009
13
Contents
Active Users
369 370 370 371 371 372
Open Documents Indexing Errors Storage Options Magnetic Storage Optical Storage
Documents Being Indexed
Configuring Storage Options 373 377
Appendix C Storage Service

Accessing Storage Service Storage Service Options
383
384 387
Configuration Settings 388 Changing File and Rollover Settings File Scan Options Rollover Options Special Files 396 397 400 392 394 395 390
Overview of the Rollover Process
Adding Files to the Exceptions Path/Filename List Creating Report Manager Folders Scheduler Settings 401 Loading Settings 402 402 408 410 Add New Scheduler Setting Loading Settings Example Redistributing Files 408
Editing the SS_COPY.INI File

April 2009
14
Contents
Appendix D Index Service

Starting Index Service
412
412
Understanding the Index Service Window 413
Appendix E Burst Service

Starting Burst Service
414
415 415
Using the Report Manager Burst Service for the First Time Understanding the Burst Service Window 417 Starting the Bursting Process Settings File Criteria 423 423 424 424 431 Locator 420 419 420
Setting Up the Bursting Process
Output Information Pickup Information Defining Criteria 425
Selecting a Fixed Output Filename Selecting a Pick-up Filename 433
Appendix F Conversion Utility

Overview 436 Input and Output Directories Foreground Operation Background Operation
April 2009
435
436
436 439
15
Contents
Appendix G Troubleshooting
Report Manager Version Identifying Problems SQL and Issues 443 442 442
442
442
Before You Contact Technical Support
Hardware and Operating System Information Solving Problems 444 444 445 Enabling Debugging Tools
444
Cannot Start Storage or Index Service
Storage Service Does Not Process Data 446 Error Message Displays when Storage Services Tries to Load Data Cannot See Documents in the Desktop Class Errors 449 450 451 451 Rollover Errors 448 448
Insufficient Hard Drive Space Metacode Troubleshooting
Error: Invalid input directory: \\<machine name>\PRMLoad while loading documents. 452 Error: Unable to connect to the Services Control Manager cannot access <machine name>. Error: Overlapped I/O operation is in progress. 452 Blank page adds to busted document 453 453 454 Error: Report loading failed, unexpected exception.
Report Manager Services fail to start when system is rebooted RMServices fail to start on a Server with IE7 installed Technical Support 458 457
Logon failure error for Report Manager services using SQL Server 2008 456
April 2009
16
Contents
Appendix H Report Manager Initialization Files 459

Report Manager Server Files Prm_ts.ini File Contents Prm_ss.ini File Contents Prm_is.ini File Contents Prm_sdm.ini File Contents Report Manager Client File 460 461 464 465 468 470 459
Report Manager APA Utility File
Appendix I IS Data Migration Issues
472
Procedure to be followed by Report Manager Users while migrating IS data 472
Appendix J Compressed Archive Information Appendix K IPv6 Support 473

473
473
Known Issues and workarounds
Cannot add new RM connections using IPv6 address in Windows 2003 Report Manager fails to connect to Image Services Server. 475
474
FileNet End User License Agreement
477
April 2009
17
1 Introduction
1
1Introduction
Report Manager provides online statement and report management for Enterprise Content Management applications that require access to legacy data. You can use Report Manager to electronically store, access, mine, and analyze computer-generated reports and forms such as customer statements, claims, billing statements, and payroll histories. This chapter describes the Report Manager components, process flow, and system administrators responsibilities. Report Manager is designed to manage detailed reports in high volume production environments. Enhanced performance capabilities enable Report Manager systems to load and process high volumes of data efficiently, making it an effective and robust solution for microfiche or paper-intensive environments. Report Manager lets you accomplish all of the following: Statement processing Integration with Web Services (WS) Integration with Image Services (IS) OLE Automation
April 2009
18
1 Introduction Report Manager Components
Report Manager Components

The following figure provides a high-level view of the Report Manager components. The boxed areas show the various client services which are associated with the Report Manager components .
Microsoft Internet Explorer or Netscape Navigator Browser Service Controller Report Manager Desktop IDM Web Services Statement Administrator
IDM Desktop
Storage Service Index Service Services
Traffic Service
Image Services
Storage (Optical, Magnetic) SQL Database
April 2009
19
Service Controller
A typical production environment may consist of multiple loading stations, each running a separate instance of the Report Manager Storage Service and all connecting to a Report Manager Traffic Service running on a separate workstation. In earlier releases, these services were Windows applications running on the same server. You controlled and configured the services through a Graphical User Interface (GUI). Report Manager 5.0a offers the flexibility and convenience to administer various aspects of each server remotely through the use of a Service Controller. Report Manager 5.0a
Storage Service Index Service Traffic Service Storage Service Storage Service
Service Controller
April 2009
20
The Report Manager Service Controller is a stand-alone executable that can run on any Windows 2000/2003/XP operating system and connect to various Report Manager services across the network. You need to go to a specific workstation to control the Report Manager service running on it. You simply establish an administrative account on each workstation running a service and use the service controller to connect to that workstation and manage the service remotely. Note You must have identical administrative accounts on all servers that you will connect to using the Service Controller. For more information, see Security and Administrative Rights on page 361. You can use the Service Controller to start, stop and manage the status of: Note Traffic Service Storage Service Index Service
Do not run multiple instances of the same service on a single machine. You can also use the Service Controller to: Establish Traffic Service connections View and manage the Index Service index queue and the indexing error queue Manage Storage Service configuration, processing and status
For more information on setting up and using the Service Controller, see Appendix A - Service Controller on page 358.
April 2009 Report Manager System Administrators Handbook, Release 5.0a 21
Server Components
Traffic Service The Traffic Service coordinates communication between all other Report Manager processes. For more information, see Appendix B Traffic Service on page 367. Note Do not connect a single instance of Traffic service to more than one Service Controller.
Storage Service The Storage Service loads documents into the Report Manager system. 1 2 3 Searches load directories for documents ready to be loaded. Combines documents into archive files. Migrates archived documents from local magnetic storage to optical storage devices (Image Services or third-party Hierarchical Storage Manager). Updates the Report Manager database to reflect the location of documents. For more information, see Appendix C Storage Service on page 383.
April 2009
22
Index Service The Index Service indexes data from the Report Manager Desktop, IDM Desktop, or Web Browser. Index Service also cross-catalogs indexes to Image Services, enabling IDM Desktop users to view and query documents. For more information, see Appendix D Index Service on page 412.
April 2009
23
Report Manager Administration

Administrative Component In addition to viewing and querying documents, you can use the Report Manager Desktop to: Annotate documents Imbed OLE objects into Report Manager documents Perform data mining Print and fax documents Define document properties and layouts Create indexes Configure security Perform administrative tasks remotely
Statement Processing Use Report Manager Statement Processing to create, modify or delete statement templates. A statement template defines how statement batch files are separated into individual statements as well as how the information in the statement will be extracted. For more information, see Chapter 6, Creating Statement Templates, on page 135.
April 2009
24
Image Services
Image Services is one of FileNets Extended Enterprise Content Management (ECM) software solutions designed to deliver high-volume image and static object storage. Image Services is a storage repository for data. IS is also used to store cross-catalog references to Report Manager documents that you want to make available to IDM clients. Use of Image Services is optional, and third-party optical devices can be used instead. However, IS is required if you want to utilize IDM Web Services or IDM Desktop.
IDM Desktop
Integrated Document Management (IDM) Desktop is a client-level software application that allows users to view, manage, revise, share and distribute documents across an enterprise for ad hoc or mission critical use, from Microsoft Windows-based clients. IDM Desktop provides Report Manager with a thick client capability using IS. This capability provides a single interface when accessing IS-based documents as well as Report Manager documents.
Web Services
Web Services is the leading application and development platform for Enterprise Content Management applications and serves as the webbased access point into all repositories. The Web Services application provides a complete set of content management functionality, allowing users to search, browse, share, revise and change properties of a repository document.
April 2009
25
1 Introduction The Report Manager Process Flow
Web Services Documents created by Report Manager can be referenced in Image Services (IS) and accessed using Microsoft Internet Explorer or Netscape Navigator. This thin client capability allows users to use their Web browser to view IS-based documents as well as query and view Report Manager documents.
The Report Manager Process Flow

The Report Manager system can be configured in different ways, depending on your operating requirements. This section describes the process flow of each of the following configurations: Standalone Server Integration with Image Services Integration with Image Services and Web Services
Each of these configurations offer different features.
Standalone Server
Use the Standalone Server configuration for loading, indexing, retrieval, and archiving.
April 2009
26
Report Manager Desktop
Report Manager Server (Application Server)
Retrieval Admin
Loading Indexing Archiving
April 2009
27
Rollover to Image Services

Use this setup to archive to Image Services. Report Manager Desktop Report Manager Server
Loading Indexing Archiving Retrieval Admin
Archival to Image Services
IS Server
April 2009
28
Cross-cataloging with Image Services

Use this configuration to retrieve Report Manager information from IDM Desktop, thin or superthin clients.
Report Manager Server Loading Indexing Archiving
Retrieval Admin Retrieval Archival IDM Desktop
Image Services Server
Retrieval Retrieval Thin/Superthin Web Client
Web Services Server
Retrieval
April 2009
29
Before you can access Report Manager documents via IDM Desktop or the Web Client, you must cross-catalog the index values of these documents to the index database in Image Services. Note When you cross-catalog a Report Manager document, you are actually storing index values and location information of that document in Image Services. You do not store the document in Image Services. Both IDM Desktop and the Web Client are connected to Image Services so these stations can use the index database in Image Services to find Report Manager documents. The next section describes the flow of data in each of the following configuration: Retrieving documents via IDM Desktop (document resides on the Report Manager server) Retrieving documents via the Web Client (document resides on the Report Manager server) Retrieving documents via IDM Desktop (document resides on storage media connected to the IS Server) Retrieving documents via Web Client (document resides on optical storage connected to the IS Server)
April 2009
30
Retrieving Report Manager documents via IDM Desktop (document resides on the Report Manager server):
Juke
IS
Report Manager
Mag Disk Cache SQL Server
Box Rollover
Cross-Cataloging
Oracle or SQL
Retrieval
Query
IDM Desktop Web Services
Web Client
Note
Web Client queries are managed by the Web Services server.
April 2009
31
Flow Number
Description
The IDM Desktop user specifies document search criteria which is sent to Image Services. Image Services locates and retrieves records that meet the search criteria and returns the hit list to IDM Desktop. In case of a request for a Report Manager document, IS only maintains a record of each document in the Report Manager system. The complete document(s) may reside on the Report Manager (RM) server or in storage media attached to IS. Image Services locates one or more report records that match the criteria specified in the request and sends it directly to IDM Desktop. The IDM Desktop user selects a single record which is sent to the IS server. The Image Services server retrieves index values pertaining to the requested document from its index database. These values are then sent to the Report Manager server which will search for a document match. After Report Manager finds the document, a copy is sent to the Image Services server. The Image Services server sends the document to IDM Desktop.
2 3 4
5 6
April 2009
32
Retrieving Report Manager documents via a web client (document resides on the Report Manager server):
Web Services Server
Web Client
1 4 5 9 6
7 8 IDM Desktop

Report Manager Server
April 2009
33
Flow Number
Description
Using the Web Client, user specifies criteria to locate and retrieve records for one or more Report Manager documents. This criteria is passed on to the Web Services server. The Web Services server passes the request to the Image Services server. Although the document(s) reside on the Report Manager server, if the document was cross-cataloged, a record for the same exists in the Image Services server. Image Services locates one or more records that match the criteria specified in the request and sends the matching record set to the Web Services server. The Web Services server sends the matching records directly to the Web Client. The Web Client user selects a single record which is sent to the Web Services server. The Web Services server sends the request to the Image Services server. The Image Services server retrieves index values pertaining to the requested document from its index database. These values are sent to the Report Manager server which retrieves the specific document match. After Report Manager finds the document, a copy is sent to the Web Services server. The Web Services server sends the document to the Web Client.
2 3
4 5 6
7 8 9
April 2009
34
Retrieving Report Manager documents via an IDM Desktop (document resides on optical storage connected to the IS Server):
IDM Desktop

1 2 3 8 4

Report Manager Desktop 5
6 7
Optical Storage
April 2009
35
Flow Number
Description
Using IDM Desktop, user specifies criteria to locate and retrieve records for one or more Report Manager documents. This criteria is sent to the Image Services server. Although the document(s) reside on the Report Manager server, if the document was cross-cataloged, a record for the same exists in the Image Services server. Image Services locates one or more report records that match the criteria specified in the request and sends the matching record set to IDM Desktop. The IDM Desktop user selects a single record which is sent to the Image Services server. The Image Services server retrieves index values pertaining to the requested document from its index database. These values are sent to the Report Manager server which will search for a document match. Although the document is stored locally on optical media, the record in the Image Services index database reflects it is a Report Manager document and points back to the documents information in the Report Manager database.
3 4
The entry for that record in the Report Manager database reflects that the document is now on optical storage on the Image Services server. Report Manager sends a request to the Image Services server to retrieve the document from optical. The Image Services server searches for the document. When the document is found, it is sent to the Image Services server. The Image Services server sends the document to IDM Desktop.
6 7 8
April 2009
36
Retrieving Report Manager documents from a web client (document resides on optical storage connected to the IS Server):
IDM Desktop
Web Client
1 4 5 13
2 3 6 9
10
Optical Storage
Web Services Server Image Services Server
11 7
12
April 2009
37
Flow Number
Description
Using the Web Client, the user specifies criteria to locate and retrieve records for one or more Report Manager documents. This criteria is passed on to the Web Services server. Although the document(s) reside on the Report Manager server, if the document was cross-cataloged, a record for the same exists in the Image Services server. The request is sent from the Web Services server to the Image Services server. Image Services locates one or more report records that match the criteria specified in the request and sends the matching record set to the Web Services server. The Web Services server sends the matching record set to the Web Client. The Web Client user selects a single record and sends it to the Web Services server. The Web Services server sends the request to the Image Services server. The Image Services server retrieves index values pertaining to the requested document from its index database. These values are sent to the Report Manager server to search for a document that contains the corresponding properties. Although the document is stored locally on optical media, the record in the Image Services index database reflects it is a Report Manager document and points back to the documents information in the Report Manager database.
4 5 6 7
The entry for that record in the Report Manager database reflects that the document is now on optical storage on the Image Services server. Report Manager sends a request to the Image Services server to retrieve the document from optical. The Image Services server locates the document on optical disk. The document is sent to the Image Services server. The Image Services server sends the document to the Report Manager server.
9 10 11
April 2009
38
1 Introduction The Report Manager Process Flow Flow Number Description
12 13
The Report Manager server sends the document to the Web Services server. The Web Services server sends the document to the Web Client.
Feature Chart
The following chart lists the features available with each of the configurations described.
Category Viewing Feature View APA reports View Text reports View Text reports with background image Configure background on Text reports Annotations Output transaction report as CSV file Find text within a report Find a specific annotation within a report Magnifier Navigator Copy to Clipboard Report Mining Search Data from report extracted into a spreadsheet view for manipulation Access to folders maintained by loading process Personalized folder management Browse folders by filing date range Native yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes IDM Desktop Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Web Yes Yes Yes
April 2009
39
Category
Feature Index based queries Stored searches Search templates
Native Yes Explicitly selected As displayed only Text Docs only Yes Yes Yes Yes
IDM Desktop Yes Yes Yes Yes Implicitly selected Yes
Web Yes
Security
Secured statement access Access to multiple Report Manager repositories
Printing
Local Print
Server Printing Print Annotations
Workflow/ Email Administration OLE Support Automation
Email reference Administer Report Manager system/server OLE Document Server ActiveX View Control Report Mining Query
Yes Yes Yes Yes
April 2009
40
1 Introduction System Administrator Responsibilities
System Administrator Responsibilities

This section describes the system administrators responsibilities in setting up and maintaining a Report Manager system.
1 2 3
Document Types Organizing Documents (Folders) Loading Documents Document Templates (Storage Management)
Statements
Statement Templates Statement Indexes Statement Security
Reports
Document Layouts Document Form Overlays Document Indexes Document Data Mining
6 7 8 9
Native Indexing and Cross Cataloging to IDMIS Security Managing Files Archiving/Rollover
Some system administrator tasks are performed on the Report Manager server computer, while others are performed on the Report Manager client computer. Before you can do any of these tasks, you must install and configure Report Manager on the server. See the Report Manager Installation document for more information.
The following general guidelines describes the system administrators tasks: 1 Determine the document types you are loading into Report Manager, and the method to transfer the data. You can load ASCII line data documents, AFP or Metacode reports, or AFP or Metacode statement documents into Report Manager. See Chapter 2, Document Types, on page 44 for more information. Organize Documents and Folders and create document templates. In preparation to load documents, set up load directories and create document templates for the files you want to load. See Chapter 3, Organizing Folders, on page 52 for more information. Load documents into Report Manager. This step moves the load documents into the Report Manager system. See Chapter 4, Loading Documents, on page 64 for more information. Create statement-style statement templates, and set up indexes and security settings. This section describes statement processing, a key feature of Report Manager. See Chapter 6, Creating Statement Templates, on page 135 and Chapter 7, Statement Indexes, on page 187 for more information. Create report-style document layouts, optional form overlays, indexes and optional data mining. See Chapter 8, Document Layouts, on page 199, Chapter 9, Document Form Overlays, on page 244 and Chapter 10, Document Indexes, on page 250 for more information. Set up optional Cross-cataloging to Image Services server. Before a Report Manager document can be retrieved via IDM Desktop or Web
April 2009
42
Client, an entry for that document must exist in the IS system. See Chapter 11, Cross-Cataloging, on page 282 for more information. 7 8 Set up optional security settings. See Chapter 12, Security, on page 304 Manage files and documents. Report Manager Desktop provides options in the Administration menu to manage files. This chapter describes how to use these options to move documents, delete documents and folders, and copy and delete templates. See Chapter 13, Managing Documents, on page 338 for more information. Archiving and Rollover set up and maintenance. Archiving and Rollover is the process of removing documents from the Report Manager system to an archive file. An archive file can be stored on an optical disk for long-term or permanent storage. See Chapter 14, Archiving and Rollover, on page 349 for more information.
April 2009
43
2 Document Types Data Format Requirements
2
2Document Types
The first step in making data available to Report Manager users is identifying the data and transferring it from its source location to the Report Manager services. This chapter describes the types of data supported and the transfer process.
Data Format Requirements

Report Manager has the ability to load a variety of data streams from host or mainframe sources. The following print data streams are supported: Line Printer ASCII Data ASCII Text Data IBM ANSI Form Feed Data
All Points Addressable Stream IBM Advanced Function Presentation (AFP) Xerox Metacode Xerox DJDE
April 2009
44
Line Printer ASCII Data

Line printer ASCII data intended for a Report Manager system must meet the following requirements: An ASCII carriage return <CR> or line feed <LF> must end each line. Pages with form feeds <FF> cannot exceed 200 lines and must end with an ASCII form feed. If no form feed is encountered, Report Manager assumes that a new page starts after the 66th line. A line cannot exceed the Max Chars Per Line setting under the PDF section in the Prm_ss.ini file (the default setting is 1024).
ASCII files intended for a Report Manager system can have any three character extension in their file name. Other than .AFP and .MTA, the extension .SPL, indicating spool files, is commonly used.
Data Files Using ANSI Carriage Control

To load data files with ANSI carriage control, you must configure Report Manager to apply a document template with ANSI carriage control channel mapping enabled. For more information, see ANSI Carriage Control on page 101.
Processing Text Data

When Report Manager starts processing ASCII line mode data, Storage Service reads the document and searches for an ASCII <CR> that indicates the separation of data rows (lines), as well as a <FF>, which indicates a page break. If a Form Feed is found, Storage Service
April 2009
45
assumes the document will contain additional <FF>s. If no <FF> is found, Storage Service assumes the document does not contain <FF>s and inserts them every 66 lines. If no parameter is entered in the Prm_ss.ini file, the default maximum line length is set to 256 characters. Lines that exceed this number are truncated to conform to the maximum value set. Note that you can change this setting to accommodate your requirements. For more information, see Appendix H Report Manager Initialization Files on page 459 If a Form Feed is not found, Storage Service automatically inserts one in the document every 66 lines. Storage Service also searches for a <FF> or <LF>. If one is found without the other, Storage Service appends the missing one on the end of the line. For example, if a <FF> is found without an <LF>, Storage Service appends a Line Feed to the end of the line.
April 2009
46
Processing APA Data

Report Manager accepts two forms of All Points Addressable (APA) data as input: IBM Advanced Function Presentation (AFP) Xerox Metacode APA files
These are traditional print streams, originally designed to be sent to and processed by a print server and which can be redirected and loaded directly into Report Manager. Report Manager uses the Xenos conversion engine to generate textbased data and PDF from the APA print stream.
April 2009
47
Line Mode
ANSI Channel Mapped Data ASCII Text Data
Report Manager
ASCII TEXT
Compressed Archive File
IBM AFP Data All Points Addressable Data (APA) Xerox MetaCode Data
Report Manager
Flat Text
Xenos Engine
Compressed Archive File
PDF
IBM AFP Data AFP is a print data stream format that is sent to an IBM Print Service Facility. File extensions for the AFP format is *.afp. For more information on AFP files, see the FileNet Report Manager APA Technical Reference Guide.
April 2009
48
2 Document Types Transferring Data
Xerox Metacode Data Xerox Metacode is centralized print data stream formats that include DJDE (Dynamic Job Description Entry) line conditioned data streams. File extensions for the Xerox Metacode format is *.mta. For more information about Metacode files, see the FileNet Report Manager APA Technical Reference Guide.
Transferring Data
This section provides planning guidelines to help the system administrator devise a dependable and timely means of delivering reports to the Report Manager server for processing and dissemination to the Desktop users. Your reports will likely be produced by one of the following systems: An IBM or compatible mainframe computer. An IBM AS/400 (or related System 36/38) computer. A UNIX/Internet Host. IBM compatible PC.
Choosing a File Transfer Method

AFP AFP is usually created on Multiple Virtual Storage (MVS), which has a record-based file system. When processing these files on a PC system, take care when transferring the AFP files and AFP resources since, unlike MVS, PC file systems have no logical understanding of records.
Important!
Never translate AFP documents or resources from EBCDIC to ASCII or from ASCII to EBCDIC because the translation may not be reliable. Most AFP resources and fully composed AFP documents can be transferred without any data changes. Since AFP has the length field definition within its records, the files transferred binary will still have a logical means in which the software can determine records. However, sometimes records on the MVS host will have an inaccuracy between the true record length and the record length within the AFP structured field. In these cases, the AFP Parser requires some additional information to determine record breaks. Adding CRLFs to resources and input files will sometimes correct the situation, but not always. For AFP line data and mixed mode files, no record length information exists on the records. The easiest and most common method for transferring these files is to add CRLFs at the end of the records during transfer. But the problem indicated in the above paragraph remains. If RDW or some other type of length field can be added to the beginning of each record during transfer, this method is preferred.
Metacode Metacode is a record-based architecture usually created on MVS, which has a record-based file system. When processing these files on a PC system, be extra cautious while transferring the Metacode files and resources since, unlike MVS, PC file systems have no logical understanding of records. Important! Never translate Metacode documents or resources other than JSL files from EBCDIC to ASCII or from ASCII to EBCDIC because the translation may not be reliable.
April 2009
50
All Metacode resources except JSLs are binary, and do not have logical record boundaries; thus, no record information need be maintained. The resources should be used as is. JSL resources are readable text files and should be translated into the encoding used by the operating system that runs the software, either ASCII or EBCDIC. For Metacode line data and mixed mode data streams, no record length information exists on the records. The easiest and most common method to transfer these files is to add CRLFs at the end of the records during transfer. However, this is not recommended and will cause problems when the data stream contains inline images. If RDW or some other type of length field can be added to the beginning of each record during transfer, this method is preferred.
April 2009
51
3 Organizing Folders
3
3Organizing Folders
Report Manager software organizes documents into folders. You can arrange folders in hierarchical order and they can contain other folders or documents. Proper folder planning and organization ensures quick and easy access for users. You will find references to the terms directories, subdirectories and folders across this chapter. If you are familiar with Windows Explorer, you would have worked with directories and subdirectories. Within Report Manager, this familiar hierarchical structure is used and referred to as folders. Although there are some important differences between folders (Report Manager) and directories (Windows), which will be discussed in a later section of this chapter, there is also a very close structural correlation - Each folder corresponds to a Windows subdirectory. This chapter describes how to use folders to categorize documents, as well as how to set and change defaults applied to folders. These are things you should set up before loading documents. After documents have been loaded you may want to manipulate the documents further. For more information, see Moving Documents on page 338, Deleting Documents on page 343 or Deleting Folders on page 347.
April 2009
52
3 Organizing Folders Folder Structure
Folder Structure
Report Manager data is stored in hierarchical Windows directories and subdirectories. The load directory is separate from the storage directory. The loading process replicates the directory structure from the load directory to the storage directory. The process begins with the documents in the load subdirectories. When a document is first loaded from the subdirectory of the load directory, a corresponding directory is created under the storage directory and a folder corresponding to the subdirectory name is created in the Report Manager database. Report Managers hierarchical approach to storing documents provides a logical and flexible way to organize documents. For example, assume your company has branch offices throughout the United States. To categorize the documents from each branch office, you can set up a USA folder, with subfolders that correspond to each city that has a branch office, as an example, CHICAGO, LOS ANGELES, NEW YORK, and SAN DIEGO. Each office location can have any number of subfolder levels to represent different departments (the screenshot should help you understand better).
April 2009
53
3 Organizing Folders Default Folder Settings
[C:] PRMLoad USA Chicago DDA GL Los Angeles DDA GL NY San Diego PRMStore
Default Folder Settings

Data transferred into the Report Manager system is placed in file system folders within the PRMLoad subdirectory on the Report Manager server. Before loading data, you must create the subfolders under PRMLoad that will contain the data to be transferred into the Report Manager system. These subfolders should reflect a logical file folder hierarchy that will be used with your Report Manager documents. See Creating a Folder on page 58 for more information. Note You can use Storage Service to specify an input directory other than PRMLoad, in the Load Directory field of the Scheduler configurations pane. This document assumes you are using the default input directory, PRMLoad. Although subdirectories and folders are similar, there are some important differences.
3 Organizing Folders The Loading Process
Folders in Report Manager are related to tables in the Report Manager database. Simply creating a subdirectory in Windows Explorer does not create a folder within Report Manager. Within Report Manager, a folder name may be changed at any time to clearly indicate its purpose. When a folder name is changed, the original folder name is retained internally, but an alias is presented to the user through the Report Manager desktop. Changing the Report Manager name does not change the actual subdirectory name as viewed through Windows Explorer. See Changing Folder Names on page 59 for more information.
The Loading Process

When Storage Service starts processing data, it verifies whether the subfolder structure in the PRMLoad directory already exists in the PRMStore directory. If the folder does not exist, a new record for the folder is added to the Report Manager SQL table, and the folder is then created in the PRMStore directory. During the load process, Storage Service: Note duplicates the folder structure from PRMLoad to PRMStore.
The folder hierarchy will not be reproduced in PRMStore if no data file loads are performed when Storage Service is running. compresses the load files and stores each file in the corresponding folder in PRMStore.
April 2009
55
3 Organizing Folders The Loading Process
Before loading... [C:] PRMLoad USA Chicago DDA GL Los Angeles DDA GL NY San Diego PRMStore
Load Process Folder Structure
After loading... [C:] PRMLoad PRMStore USA Chicago DDA GL Los Angeles DDA GL NY San Diego
Storage Services
The compressed files are assigned the following naming convention: <hexadecimal equivalent of the Document ID>.lzh. For example, a compressed file stored with the Document ID 90 (in the PRMDocument table) would be renamed 0000005a.lzh. A file with the Document ID equal to 91 would be 0000005b.lzh, and so on. Note Data must be loaded into subdirectories under the PRMLoad directory. Documents placed directly in the root load directory (C:\PRMLoad by default) will not be processed.
April 2009
56
3 Organizing Folders Limits and Constraints
Limits and Constraints

Items in Folders
When planning your folder layout, you must keep in mind the maximum number of items that can be listed in each folder when the folder is opened through the Report Manager desktop. The default number of items displayed per folder is 16,255 and can be configured to a maximum of 64,000 items. Note Increasing the default values may increase network traffic and slow the Report Manager Desktop displays. To change the number of items listed for each folder: Add the following to the prm_ts.ini file: [CUSTOM] RowsReturned=XXX If XXX=0, or if the key is not present, then the number of rows returned defaults to 16255. If XXX>64,000, the number of rows returned is set to 64,000, the maximum limit. This setting affects the number of items that are listed when a folder is opened through the Report Manager Desktop. The setting will affect all Report Manager Desktop clients connecting to the Report Manager Traffic service.
April 2009
57
3 Organizing Folders Creating a Folder
Number of Folders
Large number of folders or excessive folder depth can increase network traffic resulting in degraded performance for Report Manager desktop clients.
Folder Security
Earlier versions of Report Manager supported 65535 (16-bit) folders to which folder security settings could be applied. The current release of Report Manager supports security settings on double(32-bit) the number of folders.
Creating a Folder
Folders are created automatically by Storage Service the first time a document is loaded from a load subdirectory. Alternately, you can create a new folder in the Report Manager database manually. To create a folder manually: 1 Use Windows Explorer to create a new folder in the current load directory. For example, you may create a folder called San Diego in the load directory PRMLoad. Start Storage Service. Select Configurations node and click Create Folder button on the right pane. Click the load subdirectory to associate with the new folder. In our example, you click the Chicago folder. Click OK. To view the new folder, start Report Manager Desktop and select File> Open Document. In the Open Document dialog box, you will see the new folder.
2 3 4
April 2009
3 Organizing Folders Changing Folder Names
Note
You may have to click Refresh to view the updated directory.
Changing Folder Names

A folder name should indicate the folder contents. For instance, if you set up a Report Manager folder for each city where your company has a branch office: The CHICAGO folder contains statements from the Chicago branch. The LOS ANGELES folder contains statements from the Los Angeles branch. The NY folder contains statements from the New York branch. The SAN DIEGO folder contains statements from the San Diego branch.
While some users might infer that the NY folder refers to the New York branch, other users might not make this inference. Moreover, NY is not consistent with the other folder names in this example, which are not abbreviated. To change the NY folder name to NEW YORK using the Report Manager Desktop:
April 2009
59
Report Manager
Windows Explorer
New York Original_folder_name:NY Folder_name_alias: New York
NY
Directory Name in Explorer: NY
1 Note
Start Report manager Desktop and on the File menu, click Open Document. The Open Document dialog box displays. There are several reasons why a document may not display in the Document(s) list box. The document may reside in another folder or the Type list may be set to display only certain types of documents (for example, Statement Documents only). In addition, you may need to specify a wider filing date range in the Open Document dialog box. (By default, Documents will be displayed based on their filing date.)
April 2009
60
Under Folder(s) on the left pane of the dialog box, click the folder you want to rename and click Properties. The Folder/Document Properties dialog box displays. The folder name (NY, in our example) displays in the Folder Name field.
Click the Edit button next to the Folder Name. The Folder Properties dialog box displays.
April 2009
61
4 5 6
In the Folder Name text box, type a new folder name (New York, in our example) Click OK. The Folder/Document Properties dialog box displays. Click OK to exit the Folder/Document Properties dialog box. In our example, the renamed folder displays as shown in the following screenshot.
April 2009
62
Note that If you change a folder name, the new name is displayed within the Report Manager software. However, the folder retains its original name when viewed through Microsoft Windows. For example, if you change the folder name from NY to NEW YORK, the user sees NEW YORK in the Report Manager Desktop Open dialog box. However, the subdirectory name, as viewed through Windows Explorer remains \PRMStore\NY and you should use \PRMLoad\NY as the Storage Services input directory when loading additional NEW YORK documents.
April 2009
63
4 Loading Documents
4
4Loading Documents
The previous chapters covered the types of documents you will be loading into the Report Manager system and how to organize them using folders. This chapter describes how to make the data available to the Report Manager users.
1 2 3
Document Types Organizing Documents (Folders) Loading Documents Document Templates (Storage Management)
Statements
Statement Templates Statement Indexes Statement Security
Reports
Document Layouts Document Form Overlays Document Indexes Document Data Mining
6 7 8 9
Native Indexing and Cross Cataloging to IS Security Managing Files Archiving/Rollover
April 2009
64
4 Loading Documents Storage Service
Storage Service
After you transfer data from a mainframe or other source to the load directories on the Report Manager server, Storage Service performs the following steps: 1 2 3 4 Applies the document template assigned to the documents file specification. Creates a storage directory that replicates the load directory structure. Uses the documents template to determine how the document is loaded. Moves the documents to the storage directory in a compressed format. To load documents 1 Start Storage Service. Select Start > Programs > FileNet Report Manager Services > Report Manager Service Controller. Right-click on the specific Storage Service Connection and click Start. Click Load Files button on the Storage Service pane. If the Load Files button appears disabled, there are no files to load in the PRMLoad directory.
2 Note
April 2009
65
Storage Service Processing

Storage Service processing differs based on source data type. If the document is ASCII line data, Storage Service processing is described by Processing ASCII line data on page 67. If the document is an APA document to be processed as a report, Storage Service processing is described by Processing AFP and Metacode Reports on page 71. If the document is an APA document to be processed as a statement, Storage Service processing is described by Processing AFP and Metacode Statements on page 74.
Data in PRMLoad Before processing a load file, Storage Service verifies that at least one data file is present in the PRMLoad directory. Note A new folder will not be created in PRMStore if there is no document file loaded in PRMLoad. If the folder does not exist, Storage Service adds a new folder record in the PRMFolder table and creates the folder in the PRMStore directory. If the folder exists, Storage Service looks for a document template associated with the document that describes how the document will be processed.
Note
If the data file is an AFP or Metacode document, but there is no statement template associated with the document, Storage Service loads the document as a report, using default parameters and a font correlation table.
April 2009
66
Processing ASCII line data Storage Service performs the following actions on data that it loads as ASCII line data reports: 1 Storage Service determines if the document template assigned to the file specifies that channel mapping parameters are to be applied to the document. If channel mapping is used, Storage Service applies the parameters to convert the channel-mapped file to a text file and skips steps 2 and 3. Otherwise, processing continues with step 2. For more information on channel mapping see page 102. Standard text files may contain characters such as CR, LF, and FF. They should NOT contain other non-printing characters such as EOF (Cntl Z), and Nulls. Refer to Data Format Requirements on page 44 for more information. Storage Service validates the first segment of the document searching for: An ASCII form feed. If one is not found, Storage Service inserts one every 66th line in the document. A carriage return and line feed combination. If Storage Service finds one without the other, it automatically appends the missing character to the end of the line. For example, if Storage Service finds a carriage return without a line feed, it appends a line feed to the end of the line. Files that have no carriage returns or line feeds. In this case, Storage Service generates an error message, reports the error to the Windows Event Log, and skips the file.
Note
April 2009
67
3 4
Storage Service scans the segment and gathers information about lines and pages in the next segment. Storage Services compresses the segment using the industry-standard Lemple-Ziv compression algorithm to compress segments using multiple threads. By default, the number of running threads corresponds to the number of processors installed in the server. You can change this parameter using the Max_Threads parameter in the Prm_ ss.ini file Appendix H Report Manager Initialization Files on page 459. Compressed segments always end at page breaks. If a segment does not end at a page break, the segment is shortened so it ends at the last page break. The remaining portion of the shortened segment is included in the next segment. Storage Service repeats steps 3 and 4 until all new segments have been scanned and compressed. Storage Service combines and stores the compressed segments as individual files in a subdirectory within the PRMStore subdirectory. The name of the file is the hexadecimal equivalent of the ID field, with the extension .LZH appended. For example, a file stored with an ID equal to 90 is named 0000005a.LZH. PRMStore has the same directory structure as PRMLoad.
Note
5 6
Note
When Storage Service runs the archive (rollover) process, it renames the file. The new file name starts with the letter G, followed by 7 hexadecimal digits that represent the archive ID number and the extension .LZH.
April 2009
68
Note
After Storage Service loads a document into the Report Manager system, the document is, by default, deleted from the PRMLoad directory. In addition, after the file is compressed, Storage Service updates the files record in PRMDocument with the correct FolderID, DocDescrID, report size and other information. If the document has a corresponding document template with fields defined as index fields, or Report Cataloging is active, Storage Service queues the document for Index Service by adding it to the table PRMIdxqueue.
April 2009
69
Start
ASCII files stored within a sub-folder of the PRMLoad directory structure
Storage Service scans PRMLoad directory structure for new data If yes, applies the mapping then compresses the file to .lzh format and moves it to a corresponding folder within the PRMStore directory
If the data file has an associated Document Template, Storage Service checks for Channel Mapping to be applied to the document No Storage Service validates first segment of ASCII document, then scans the entire document for information regarding lines and pages within the segment. Storage Service then compresses the document segment. This step continues until all new segments are scanned and compressed, then all segments are combined within one .lzh file and moved to a corresponding folder within the PRMStore directory.
Yes
Storage Service updates SQL tables with information regarding the location of the document
Done
If the document has a corresponding Document Template which has Transaction Indexes associated with it, an entry is made to the PRMIDXQueue for the item to be processed (indexed) by Index Services.
Processing ASCII Line Data Flow Chart
April 2009
70
Processing AFP and Metacode Reports Storage Service performs the following actions on data that it loads as AFP and Metacode reports: 1 2 Storage Service generates an index file, calculating the number of pages and page breaks in the document. Storage Service passes the file to multiple threads. By default, the number of running threads corresponds to the number of processors installed in the server; however, you can change this number by changing the Threads parameter in the prm_ss.ini file. For more information, see Appendix H Report Manager Initialization Files on page 459. Each of the threads creates a PDF and a text version of the file. Storage Service scans the segment and gathers information about lines and pages in the segment. Storage Services compresses the segment using the industry-standard Lemple-Ziv compression algorithm to compress segments using multiple threads. By default, the number of running threads corresponds to the number of processors installed in the server. However, you can change his number using the Max_Threads parameter in the prm_ss.ini file. For more information, see Appendix H Report Manager Initialization Files on page 459. Compressed segments always end at page breaks. If a segment does not end at a page break, the segment is shortened so it ends at the last page break. The remaining portion of the shortened segment is included in the next segment. Storage Service repeats steps 3 and 4 until all new segments have been scanned and compressed.
3 4
April 2009
Storage Service combines and stores the compressed segments as individual files in a subdirectory within the PRMStore subdirectory. The name of the file is the hexadecimal equivalent of the ID field, with the extension .LZH appended. For example, a file stored with an ID equal to 90 is named 0000005a.LZH. PRMStore has the same directory structure as PRMLoad. When Storage Service runs the rollover process, it renames the file again to G followed by 7 hexadecimal digits that represent the archive ID number and the extension .LZH.
Note
After Storage Service loads a document into the Report Manager system, the document is, by default, deleted from the PRMLoad directory. In addition, after the file is compressed, the Report Manager software updates the files record in PRMDocument with the correct FolderID, DocDescrID, report size and other information. If the document has a corresponding document template with fields defined as index fields, or Report Cataloging is active, Storage Service queues the document for Index Service by adding it to the table PRMIDXqueue.
April 2009
72
Start
Storage Service scans PRMLoad directory structure for new data The file is passed to multiple threads for processing. Each thread generates a flat text file and a PDF file
AFP and/or Metacode data files retrieved from Mainframe AFP and/or Metacode data files stored within a sub-folder of the PRMLoad directory structure
The text files and PDF versions are consolidated into a single flat-text file Storage Service scans the entire document for information regarding lines and pages within the segment. Storage Service then compresses the document segment. This step continues until all new segments are scanned and compressed, then all segments are combined within one .lzh file and moved to a corresponding folder within the PRMStore directory. Storage Service updates SQL tables with information regarding the location of the document If the document has a corresponding Document Template which has Transaction Indexes associated with it, an entry is made in the PRMIDXQueue for the item to be processed (indexed) by Index Services
Done
Processing Reports Flowchart
April 2009
73
Processing AFP and Metacode Statements Storage Service performs the following actions on data that it loads as AFP and Metacode statements: 1 2 Storage Service processes one statement file per thread. Storage Service creates a Table of Contents (TOC) for the PDF file, with index data and page locators. Storage Service appends the TOC to the end of the PDF file. Index Service uses the TOC to index the document. For more information, see Generating Indexes for Statement Documents on page 191. Storage Service combines and stores the PDF segment within the LZH file in the PRMStore subdirectory. The name of the file is the hexadecimal equivalent of the ID field, with the extension .LZH appended. For example, a file stored with an ID equal to 90 is named 0000005a.LZH. PRMStore has the same directory structure as PRMLoad. After Storage Service loads a document into the Report Manager system, the document is, by default, deleted from the PRMLoad directory. In addition, after the file is compressed into the LZH format, the Report Manager software updates the files record in PRMDocument with the correct FolderID, DocDescrID, report size and other information. If the document has a corresponding document template with fields defined as index fields, Storage Service queues the document for Index Service by adding it to the table PRMIdxqueue. Report Manager does not generate a text representation of the rendered PDF file when loading statement documents. For this reason, data mining cannot be performed on Statement documents. Refer to Chapter 6, Creating Statement Templates, on page 135.
Note
Note
April 2009
74
Start AFP and/or Metacode data files retrieved from Mainframe AFP and/or Metacode data files are stored within a sub-folder of the PRMLoad directory structure Storage Service scans PRMLoad directory structure for new data Each file is rendered as a PDF file segment. Utilizing an administrator-defined Statement Template, page numbers and zones determine segment boundaries. Storage Service generates an index file and appends it to the end of the document Storage Service creates a TOC for the PDF file and appends to the end of the PDF file
The file is compressed and moved to a corresponding folder within the PRMStore directory
The document is then placed within the PRMIDXQueue for the item to be processed (indexed) by Index Services
Done
Processing Statements Flowchart
April 2009
75
4 Loading Documents Running Multiple Services
Running Multiple Services

You can optimize the throughput of a Report Manager system by running multiple services. Storage Service is scalable allowing you to load documents using two or more loading stations, each running one copy of Storage Services on a separate Windows server. This configuration streamlines Report Manager operations and may result in a significant increase in throughput. Note Multiple instances of Storage Service should not be run on the same station. This configuration is not supported.
Load Directory Data Streams Report Manager Loading Station Load Directory Data Streams Report Manager Loading Station Load Directory Data Streams Report Manager Loading Station Archive Files
e iv ch Ar Ar ch iv e Fi le s le Fi s
Store Directory
Optimizing throughput using multiple loading stations
Ideally, the PRMStore directory should be set up on the Traffic Service station.
April 2009
76
The loading process is disk I/O and CPU intensive, but typically, more CPU intensive. Both faster throughput with disk and CPU processing power directly affect loading speed. In addition, the loading process can be made parallel on a multi-processor platform by having processors work on different parts of a single report simultaneously (each part is about 250k bytes of raw line data).
Storage Service
Storage Service uses multiple threads to process ASCII documents, AFP and Metacode reports, and AFP and Metacode statements. ASCII documents and AFP and Metacode Reports. Storage Service uses multiple threads to load and process ASCII documents and AFP and Metacode reports. For these documents and reports, multiple threads work in concert to process a single document or report, yielding greater efficiency and performance. AFP and Metacode Statement Documents. Storage Service uses multiple threads to load AFP and Metacode statement documents. Each thread loads a separate document. To take advantage of multithreaded statement loading, place multiple statement documents in the load directory so Report Manager can load multiple statement documents at the same time.
April 2009
77
General Guidelines
You should observe the following guidelines when running two or more Loading Stations: The magnetic and optical drive destinations must be identical for all Report Manager Windows servers. For example, if your magnetic storage resides on K:\PRMStorage of the Traffic Service system, all Storage Service systems must map to that drive and refer to it as drive K. Each Loading Station running Storage Service must have its own separate load directory. For best results, this load directory should be on the servers local hard drive rather than on a network drive.
Note
The load subdirectory is locked while the Loading Station is processing documents. Each load station should be processing from separate/distinct subdirectories. All Storage Services must communicate with the same Traffic Service (TS). The Windows account that you log onto to run Storage Service must be known to the Traffic Service system and the passwords must be identical. For example, if you log onto the Storage Service system as Sally, using the password Xyz, the Traffic Service system must also have an Windows account named Sally with the password Xyz. Windows domain or local accounts can be used.
Note
Unlike loading activities, rollover activities cannot be conducted on multiple servers; they can only be performed on a single server. There can be only one Rollover Instance. For best performance keep it with
April 2009
78
Traffic Service. Fore more information see Chapter 14, Archiving and Rollover, on page 349.
April 2009
79
Loading
The loading process handles report and statement data streams in very different ways, resulting in very different scalability models, particularly in a multi-processor environment. In general, multiple loading Windows platforms enable processing of multiple data streams in parallel. Multiple loading stations allow simultaneous processing of files.
Data Stream 1
Report Manager Loading Station
Report Manager Archive File 1
Data Stream 2 Report Manager Loading Station
Report Manager Archive File 2
Data Stream N
Report Manager Loading Station
Report Manager Archive File N
April 2009
80
Report Processing
The loader engine breaks up reports and processes parts of the reports simultaneously. Adding processors allows a higher degree of parallel processing for a single report as shown below:
SMP Report Manager Loading Station
f No ~1/ of Report ~1/N ~1/ No fR epo Data Stream 1 rt
por Re
CPU1
CPU2 Report Manager Archive File 2
CPUN
This scalable architecture requires processing of relatively large report data streams to efficiently use multi-processor hardware resources and subsequently realize optimal throughput rates.
...
April 2009
81
Statement Processing
For processing APA data streams that contain subdocuments, or statements, Statement Processing is recommended to achieve higher throughput performance. When loading APA data streams as reports, an additional textual representation of the data is generated, compressed and stored in the resulting archive file. This text representation (referred to as flat text) is used when extracting data for indexing and report mining. Generation of this additional textual representation is avoided in loading under Statement Processing. Note Statement processing does not generate text. As a result, data mining cannot be performed on Statement documents. The loader engine processes numerous statement data streams simultaneously. Adding more processors allows more parallelism by processing more data streams simultaneously as illustrated below.
SMP Report Manager Loading Station
CPU1 Data Stream 1 CPU2 Data Stream 2 Report Manager Archive File 2 Report Manager Archive File 1
...
Data Stream N
...
CPUN Report Manager Archive File N
April 2009
82
4 Loading Documents Compressed Archive Structure
Compressed Archive Structure

Report Manager 4.x and later uses an archive structure to store the data in compressed form. Each archive file includes a segment that will be compressed and stored as the first segment (segment number 0) of the archive file. This segment contains the segment list for the archive. The segment list contains an entry for each segment to provide quick access to the entire file. Report Manager 4.x and above is compatible with the archive formats used in previous versions of Report Manager. In the previous version, each time a query was made, Report Manager decompressed the header information for each segment, generating a list of header information to access the appropriate page. With Report Manager 4.0.0 and above, the list is stored in the archive file, eliminating the overhead involved with generating the list. Each compressed segment still contains the header information to permit decompression using third-party tools such as WinZip.
April 2009
83
5 Working with Document Templates Understanding Document Templates
5
5Working with Document Templates
This chapter describes document templates as well as how to create, modify, and delete them. This chapter also describes the statement, channel mapping and storage management parameters associated with document templates.
Understanding Document Templates

Document templates enable Report Manager to recognize and handle related documents in a folder. Using document templates, you can specify how Report Manager transforms input data. For example, you can have Report Manager: Load AFP, Metacode, and DJDE files as collections of statements with a specified statement template. Load text files with ANSI carriage control with a specified channel mapping template. Apply a storage profile that determines how classes of documents associated with the document template are managed over time.
Document Templates are assigned to documents within each folder. A template links each loaded document to their respective:
April 2009
Document Type Document Layout Form Overlay

Document Storage Profile
Document templates and their corresponding documents can also be indirectly linked to: Document Index(es) Index Storage Profile(s)
We recommend that you create a document template in each folder for each class of documents you load into the Report Manager system. A class refers to a set of documents that have a similar layout and contain similar types of data that Report Manager users will want to view and possibly extract. For example, you might want to have one document template for credit card statements, another for overdraft documents, and another for DBA notices. Assigning a document template allows you to: Define a document layout that lets Report Manager users search for and extract data. See s. Apply a form overlay to the document. See Document Form Overlays on page 244. Designate the document as a collection of statements. See Defining a File Specification on page 96. Specify a document storage profile for the document. See Configuring Document Storage Profiles on page 112.
April 2009
85
The Document Template Components

A document template consists of several components as illustrated below.
Document Template
Document Type
Document Layout
Overlay
Form
Document Storage Profile
Document Index(es) Index Storage Profile(s)
The next sections briefly describe each of these components. Document Type Report Manager supports two types of documents: Reports Text Reports APA Reports
Statements
April 2009
86
Document Layout A Document Layout defines the document structure. The document structure must be defined in order to mine data, as well as create document indexes based upon field definitions. A document layout has three components:sections, section locators and fields. For more information, see Chapter 8, Document Layouts, on page 199. Form Overlay A form overlay is a graphic image that resembles a pre-printed form. When a form overlay is imported into a Report Manager document, the document appears to be printed on the form. For more information see Chapter 9, Document Form Overlays, on page 244. Document Storage Profile A Document Storage Profile specifies how the document is retained over a period of time. The Document Storage Profile includes information about archival to optical disk, magnetic purge, document fiche, deletion, or Image Services Document Class assignment (for crosscataloged documents). For more information see Configuring Document Storage Profiles on page 112. Report Cataloging Report Cataloging is the process of making Report Manager reports available to the IDM client. For more information see Chapter 11, Cross-Cataloging, on page 282.
April 2009
87
Using Document Templates

Document templates define what processes are applied to new reports in the Report Manager System. You can: automatically apply a document template to all files that conform to a naming specification that you indicate. create new document templates as necessary for new classes of documents. edit document templates to suit your changing requirements. copy document templates to other folders. delete document templates you no longer use.
You can also change the document template associated with a particular type of document. In some cases, you must create a document template before documents load into the Report Manager system. For example, to have Report Manager load a file as a statement document, or to use an administrator-defined ANSI carriage control mapping template, you must create the document template with the appropriate parameters configured before the document loads into the Report Manager system. Before you can create a document template, you must create a document folder. Note You can manually create a new folder by selecting Storage Service> Options>Configuration and click Create Folder.
April 2009
88
5 Working with Document Templates Initial Document Template Settings
After a file loads as a report into the Report Manager system, you cannot change it to a statement document by assigning a different document template to it. Therefore, it is vital that you create the document templates you need before loading files into the Report Manager system.
Initial Document Template Settings

Initially, the Report Manager system has no user-defined document templates. If you load files before you create templates, Report Manager automatically assigns the designation Undefined Document to that file. This designation indicates that a document template has not been assigned to the document. The Undefined Document designation displays in the Open Document dialog box when you view newly loaded documents. The following figure shows an example of a newly-loaded document in the Open Document dialog box.
April 2009
89
5 Working with Document Templates Using the Document Template Management Dialog Box
Using the Document Template Management Dialog Box

You create, edit, delete, and copy document templates using the Document Template Management dialog box. You can also export a layout file. The following figure shows an example of the Document Template Management dialog box.
April 2009
90
The Folder(s) list on the left shows the folder hierarchy of the Report Manager input directory. When you double-click a folder in this column, the document templates associated with that folder display under the Document Template(s) list on the right. Initially, <Undefined Template> displays in the Document Template(s) list, because there are no document templates in the Report Manager system until you create them. There are two ways to open the Document Template Management dialog box from the Report Manager Desktop:
April 2009
91
Use the Open Document dialog box to assign document templates to a document that has been loaded. See Using the Open Document Dialog Box on page 92. Click Document Templates on the Administration menu to define a new document template or modify an existing document template.
Both methods let you create, edit, delete, and copy document templates and export file layouts. In addition, the first method lets you change the template assigned to a selected document.
Using the Open Document Dialog Box

The following procedure describes how to open the Document Template Management dialog box by clicking on a document in the Open Document dialog box on the Report Manager Desktop. 1 2 3 Tip On the File menu, click Open Document. The Open Document dialog box displays. Under Folder(s), click the folder that contains the document to which the document template will be assigned. Under Document(s) select the document and click Properties. If the Document(s) list does not display the desired document you might need to specify a wider filing date range or the Type list might be set to display only certain types of documents (for example, Statement Documents only). The Folder/Document Properties dialog box displays. Undefined Document displays in the Document Name field to show that the selected
April 2009
92
document has no document template associated with it. If it did, the name of the template displays next to Document Name.
Next to Document Name, click Edit. The Document Template Management dialog box displays.
April 2009
93
5 Working with Document Templates Creating a New Document Template
Creating a New Document Template

The following procedures describe how to create a new document template. Before you can create a document template, you must create a document folder. Note You can manually create a new folder by selecting Storage->Service-> Options. From the Document Template Management dialog box in the Folder(s) area, click the folder with which you want the new document template associated. Any document templates associated with the selected folder display under Document Template(s). Initially, only <Undefined Template> displays. Click New. The New Document Template dialog box displays. Complete the following tabs in the New Document Template dialog box: Storage lets you define file specification, loading, ANSI carriage control, channel mapping, and document storage profile parameters. See Completing the Storage Tab on page 95. Display lets you specify the document template name and the icon associated with documents. See Completing the Display Tab on page 125. IDM lets you provide the IDM Desktop with access to documents and statements under the IDMIS Document Class. This tab only appears when you have IDM Desktop installed. See Completing the IDM Tab on page 128.
2 3
April 2009
94
Statement (this tab appears when the Collections of AFP or Metacode Statements option on the Storage tab is selected) lets you enable native and/or IDMIS cataloging. This tab only appears when you specify a statement template on the Storage tab. See Completing the Statement Tab on page 132.
Completing the Storage Tab

On the Storage tab of the New Document Template dialog box, you can define: A file specification that enables Report Manager to automatically apply a document template to newly loaded documents that match a user-defined pattern. See Defining a File Specification on page 96. Loading parameters that determine whether the document template will be associated with statements, transaction-style reports, or text data that uses ANSI carriage control channel mapping. See Defining a File Specification on page 96. A document storage profile that determines how Report Manager treats the document over time. See Configuring Document Storage Profiles on page 112.
April 2009
95
Defining a File Specification Using File Specification, you can have Report Manager automatically
April 2009
96
apply a document template to all newly loaded files whose filenames match a particular pattern. You type this pattern in the File Specification text box, using alphanumeric characters and one or more of the wildcard characters shown below.
Wildcard Character Description
Numeric wildcard. Example: 123# applies a template to all files starting with 123 and followed by a single digit: 1231, 1232, and so on. Alphabetic wildcard. Example: ABC@ applies a template to all files starting with ABC and followed by a single alpha character: ABCD, ABCE, etc. Wildcard for any character, except null. Example: ABC%% applies a template to all files starting with ABC and followed by two alphanumeric characters: ABCDF, ABC68, ABC8A, ABCZ4, but not ABC4 (ABC4 is not returned because these wildcards do not return null characters), etc. Example: A?C applies a template to all files starting with A as the first letter, followed by a character and the letter C: ABC, A6C, ANC, etc. Wildcard character for multiple characters (asterisk). Example: ABC* applies a template to all files starting with ABC: ABC, ABCJAZEQ, ABC05938, ABC34ZUA, etc.
% or ?
For example, typing the file specification gl_*.spl tells Report Manager to automatically apply this document template to all documents that start with gl_ and end with the extension .spl. Note: You cannot use one of the other wildcards after the asterisk unless you are looking for one of these as a literal. In that case, precede the character with a slash ( / ). For example: /#### on string abc#1234567 returns #123.
&
Wildcard character for a single alphanumeric (0-9, A-Z) character.
April 2009
97
The File Specification field lets you specify the loading parameters for the selected document. If you want the document template to be associated with statement documents, click Collections of AFP or Metacode statements using and select a statement template from the list box. Selecting a statement template displays a Statement tab in the New Document Template dialog box for enabling native and/or IS cataloging, as shown in the following figure. For information about this tab, see Completing the Statement Tab on page 132.
Note
Collections of AFP or Metacode statements using option is available if the file specification has the extension .MTA or .AFP (for example, MYDOC*.AFP or Year*.AFP.
April 2009
98
In the Load files as area, choose the appropriate button.
April 2009
99
Loading Options Statements Statement Templates define the document data that will be extracted for indexing statements. After the design is completed and saved, select the Collection of AFP of Metacode statements using option to enable the Statement Template field. You can chose from a list of existing Statement Templates. Statement Template design is described in more detail in Chapter 6, Creating Statement Templates, on page 135. Reports Importing Layouts. Layouts are used in Report Manager Desktop to define the document data to be extracted for indexing reports. Select Import Layout to browse for and select an existing layout (*.lyt) file. This allows you to: Design and test a layout on a development platform and move that layout to a production platform Export and Import a layout between FileNet support and the customer for diagnostic analysis.
For an imported layout to work correctly it must be applied to documents that have locators and fields that are identical to the document originally used to create the layout. If a document is loaded that does not contain the locators specified in the layout, then no locators or fields will be displayed and it will appear that no layout is present. To avoid this, it is useful to test the imported layout using the original layout set up file.
April 2009
Layouts can only be imported when creating a new document template and are described in more detail in Chapter 8, Document Layouts, on page 199. Importing a layout requires the same permission setting as is required for exporting, copying, editing, creating, and deleting a document template. To import a layout: 1 2 Click Import Layout. When the Open dialog displays, select a file containing the layout and click Open. The file is read into memory. If the file format is incorrect, an error message displays. 3 Click the OK button on the Storage property page dialog to insert the imported layout data into the PRM database where it will be associated with the current document template. You can view the layout when the associated report is loaded. If an error occurs when adding the layout to the PRM database an error message displays. The Import Layout button is disabled when you select Collection of Statements and when you edit an existing document template. ANSI Carriage Control If the document template will be associated with text files that use ANSI carriage control channel mapping, particularly documents that have embedded form feed (FF) characters, enable ANSI Carriage Control using option.
Note
April 2009
Note
ANSI carriage control only applies if the first character of every text line begins with a carriage control character. Defining Channel Mapping Parameters. Channel mapping refers to print streams that control paper advance. Channel mapping parameters tell a line printer that one or more lines or pages should be skipped during processing, without requiring actual blank lines or pages to be inserted into the actual data stream. Special control characters inserted in the data stream specify the channel mapping parameters. Channel mapping can be used to place spaces in between data lines for forms that may be pre-printed on the paper and/or to separate data such as customer bills so that each bill is printed on a separate page. A channel mapping template lets you configure Report Manager to map channels for an electronic document the same as a line printer maps channels for a hard copy document.
April 2009
To associate a channel mapping template with the document template, Click next to Channel Map on the New Document Template dialog and enter the channel mapping template name.
April 2009
This dialog box lets you create, edit, and delete channel mapping templates. All ANSI carriage control characters display as the first character of each line. The following table lists standard ANSI carriage control characters, that are included in Report Managers channel mapping facility.
Standard ANSI Carriage Control Characters
Function
+ SPACE 0 -
Print (no space) Space 1 line Space 2 lines Space 3 lines
The following table lists IBM line printer channel codes that can be customized. These codes will be stored in the Report Manager SQL database table.
Customizable ANSI Carriage Control Characters
Function
1 2 3 4 5 6 7 8
Goto Line n Goto Line n Goto Line n Goto Line n Goto Line n Goto Line n Goto Line n Goto Line n
April 2009
Customizable ANSI Carriage Control Characters
Function
9 A B C
Goto Line n Goto Line n Goto Line n Goto Line n
Report Manager provides you with a default character mapping template. To edit it, change the channel mapping values for each channel in the Channel Mapping section of the Channel Mapping Template Management dialog box. Alternatively, you can create new channel mapping templates (refer to page 106). In the Channel Mapping section, Channel 1 corresponds to the top of a page and Channel 2 to the bottom of a page. For example, to tell Report Manager that all lines beginning with the number 5 start a page, change the value for Channel 5 to 1. You can then complete the remaining Channel fields as required. Note The value you type for each channel must be greater than the previous channel value. For example, if you type 5 for Channel 1, the value for Channel 2 must be greater than 5. Otherwise, Report Manager assumes you are referring to a channel on the next page of the document. You can click the Clear button to remove all values, except the channel mapping templates that have been defined.
Tip
April 2009
Adding Channel Mapping Templates. To add new channel mapping templates, use the following procedures. 1 In the Channel Mapping Template Management dialog box, type a unique channel mapping template name under Channel Mapping Template Name. Under Channel Mapping, type the channel mapping values for channel 1, channel 2, and so on. Click Add. The channel mapping template is added, in alphabetical order, below Channel Mapping Template(s). To create additional channel mapping templates, repeat steps 1 through 3. If you created more than one channel mapping template, click the one you want to use under Channel Mapping template(s). Click OK. The Channel Mapping Template Management dialog box closes. The channel mapping template you selected in step 5 displays next to Channel Map in the New Document Template dialog box. Modifying Channel Mapping Templates. If you need to modify one or more channel mapping templates, use the following procedure to edit the templates. 1 Under Channel Mapping Template(s) in the Channel Mapping Template Management dialog box, click the channel mapping template you want to modify. The template name displays below Channel Mapping Template Name and the corresponding values display in the Channel section.
2 3 4 5 6
April 2009
2 3 4 5
Change the values as necessary. For more information, refer to page 106. Click Modify. The new values are applied to the selected channel mapping template. To edit additional channel mapping templates, repeat steps 1 through 3. When you finish, click OK. Deleting Channel Mapping Templates. If you no longer need a channel mapping template, use the following procedure to delete it.
CAUTION
No precautionary message displays before you delete a channel mapping template. In addition, clicking Cancel after deleting a template does not restore the template. Therefore, be sure you no longer need a channel mapping template before you delete it. Under Channel Mapping Template(s) in the Channel Mapping Template Management dialog box, click the channel mapping template you want to delete. The template name displays below Channel Mapping Template Name and the corresponding values display in the Channel section. Click Delete. The selected channel mapping template is deleted from Channel Mapping Template(s). To delete additional channel mapping templates, repeat steps 1 and 2. When you finish, click OK.
2 3 4
April 2009
5 Working with Document Templates Modifying Document Templates
Storage Profiles The Manage documents over time using area has a Storage Profile list box. From this list, select a document storage profile for the document template. A profile determines how the selected documents associated with the document template are managed over time. For more information on specifying Storage Profile parameters, see Configuring Document Storage Profiles on page 112.
Modifying Document Templates

If you need to change document template parameters, use the following procedure to modify document templates. 1 2 Display the Document Template Management dialog box (see Using the Document Template Management Dialog Box on page 90). Under Folder(s), click the folder that contains the document template you want to edit. The document templates in the selected folder display under Document Template(s). Select the document template you want to edit. The Edit Document Template dialog box displays. This dialog box is similar to the New Document Template dialog box. Change the document template as required. For more information, refer to Creating a New Document Template on page 94.
April 2009
5 Working with Document Templates Deleting Document Templates
Deleting Document Templates

If you no longer need a document template, you can delete it from the Document Template Management dialog box. CAUTION If you select a document template that has one or more loaded documents associated with it, the behavior varies, depending on whether the template is a statement template. If the template is a statement template, you cannot delete it if there are any documents using the template. If the template is associated with line data documents or reports, a message asks whether you want any documents associated with that template to be reassigned to the Undefined Document template. From the Document Template Management dialog box, in the Folder(s) area, select the folder that contains the document template you want to delete. The document templates in the selected folder display under Document Template(s). Under Document Template(s), select the document template you want to delete. Click Delete. A warning screen asks whether you are sure you want to delete the selected document template. Click Yes to delete the selected document template. Click OK
2 3 4 5
April 2009
5 Working with Document Templates Copying Document Templates
Copying Document Templates

The Document Template Management dialog box lets you copy document template profiles from one folder to another. You can use this feature as a shortcut to creating document templates. For example, assume you need to create a document template for a folder called COLOMBIA. Also, assume that this document template will use similar parameters to those defined for a document template you created in a folder called CHICAGO. Instead of creating from scratch the document template for the COLOMBIA folder, you can copy the document template from the CHICAGO folder to the COLUMBIA folder. Then you can use the procedure under Modifying Document Templates on page 108 to modify the document template in the COLOMBIA folder as necessary. To copy document templates, use the following procedure. 1 From the Document Template Management dialog box, in the Folder(s) area, select the folder that contains the document template you want to copy. The document templates in the selected folder display under Document Template(s). Under Document Template(s), select the document template you want to copy. When you copy a document template to a new folder, internally a new DocDescrID is assigned to the copied template. This will impact the Rollover process, by adding another global archive file to your daily global archive files.
Note
April 2009
5 Working with Document Templates Copying Document Templates
Click Copy. A Copy Document Template dialog box similar to the following displays, with a list of destination folders.
Select a destination folder and click OK. The selected document template is copied to the specified destination folder and the Copy Document Template dialog box closes. Click OK. When you copy a document template to a new folder, a new DocDescrID is assigned to the copied template. This will affect your Rollover process by adding another global archive file to your daily global archive files.
5 Note
April 2009
5 Working with Document Templates Exporting a Layout
Exporting a Layout
Layouts are used in Report Manager Desktop to define the document data to be extracted for indexing reports. Select Export Layout to browse for and select an existing layout (*.lyt) file. This allows you to: Design and test a layout on a development platform and move that layout to a production platform Export a layout between FileNet support and the customer for diagnostic analysis.
Exporting a layout requires the same permission setting as is required for importing, copying, editing, creating, and deleting a document template. To export a layout: 1 2 Open the Document Template Management. Select the Export Layout button, specify a name and location for the layout in the Save As dialog. Click Save.
Configuring Document Storage Profiles

The Manage documents over time using area has a Storage Profile list box. From this list, select a document storage profile for the document template. A profile determines how the selected documents associated with the document template are managed over time. A document storage profile is used to manage optical archive, magnetic purge, document fiche, and IS document class parameters. Initially, Report Manager uses a default profile whose parameters are shown in the following Document Storage Profiles dialog box (This dialog box displays when you click the Profile Maintenance button in the New Document Template dialog box). You can also use the Add button in the Document Storage Profiles dialog box to create new proApril 2009 Report Manager System Administrators Handbook, Release 5.0a 112
5 Working with Document Templates Configuring Document Storage Profiles
files. After you define new profiles, you can select them from the Storage Profile List box in the New Document Template and Edit Document Template dialog boxes (see Creating New Document Storage Profiles on page 114).
When you define document storage profiles, you can specify one as the default. Report Manager automatically applies the default document storage profile to newly created document templates, unless you select a different default profile. See Changing the Default Document Storage Profile on page 122.
April 2009
The Document Storage Profiles dialog box also has a Where Used button that lets you see the folders and documents associated with a selected storage profile. See Identifying Where Profiles are Used on page 123.
Creating New Document Storage Profiles

To create new document storage profiles, use the following procedure: 1 2 In the Document Storage Profiles dialog box, click Add. The Add Document Storage Profile dialog box displays. Type a unique name for the document storage profile you are creating in the Profile Name field.
April 2009
Note
If you type a profile name that already exists, Report Manager appends (2) to the second profile name, (3) to the third, and so on. In this example, Archive to Optical is enabled. The Days before Archiving editable field has a value of 5 so documents associated with this document storage profile are archived (or committed) to optical
April 2009
storage five days after they load into the Report Manager system. The following additional fields are enabled: Purge from Magnetic Cache is enabled. Documents associated with this profile are automatically purged from magnetic cache (the servers hard drive) a specific number of days after they load into the Report Manager system. The number of days is specified in the editable field, Days before Purging. if you do not want documents associated with this profile to be purged from magnetic cache, disable the Purge from Magnetic Cache option. Disabling this option creates two copies of each document, one on magnetic cache and the other on optical storage. Document Record Removal. This option permanently removes the document from the Report Manager system regardless of whether Report Archival has been run. Document Record Removal lets you set the number of days that will transpire before the document is removed, starting from the day that the document was last updated. For more information see, Document Record Removal on page 118. CAUTION If a document has been migrated to optical and later the same document is removed from the Report Manager system through document record removal, you will no longer be able to retrieve the document from optical by the Report Manager or IDM desktop. IS Document Class. If you have FileNet Image Services installed, select an IS document class from the list box. If Archive to Optical is disabled the Add Document Storage Profile dialog box appears as displayed:
April 2009
Document Delete. This option removes the document from the Report Manager system. You first have to run Reports Archival. Otherwise the document will never be deleted. The value in the Days before Deleting field starts the day following the last Reports Archival. See Chapter 14, Archiving and Rollover, on page 349 for more information. For more information, see Document Delete on page 121.
April 2009
If you want Report Manager to keep documents associated with this profile in magnetic cache (hard drive) permanently, disable the Delete Document option. CAUTION Report Manager permanently deletes documents associated with the profile if they are older than the number of days specified. Therefore, use this option carefully. Document Record Removal. This option removes the document from the Report Manager system regardless of whether Reports Archival has been run. Document Record Removal lets you set the number of days that will transpire before the document is removed, starting from the day that the document was last updated. For more information see, Document Record Removal on page 118. Note If you prefer, you can use Document Purge in the Storage Service Options menu to manually delete documents whose profiles specify that the documents are to be purged (see Storage Service Options on page 387). Use care when selecting both Delete Document AND Document Record Removal features. Documents could be deleted sooner than anticipated if these are configured improperly.
Caution
Document Record Removal

Document Record Removal is similar to Document Delete, but with some significant differences. Document Record Removal counts down from the documents last updated date. If a document has been opened, it is still considered active and will not be deleted. Document Record Removal can be used simultaneously with Archive to Optical.
April 2009
After the lifetime of the document has been exceeded, Report Manager will take the appropriate steps to remove the document from the system. For example, if a document was loaded on 1/1/2005 and was updated on 1/20/2005 and the days to be kept is set to 30 days, then the document will be removed 30 days after the 1/20/2005 date. Caution Report Manager permanently removes documents associated with the profile if they are older than the number of days specified. Therefore, use this option carefully. Document Record Removal will not remove the document from an optical drive but will remove the document from the rest of the Report Manager system and the document will no longer be retrievable by the Report Manager desktop or by the IDM desktop. Frequent backups should be done to prevent accidental data loss. The following steps describe how to use the Report Manager Document Removal feature: 1 Document Record Removal lets you set the number of days that will transpire before the document is removed, starting from the day that the document was last updated. Select the option and enter the number of days that the document should be kept from its last update. The number of days must be from 0 to 999998 days. Please note that 0 days means that this document can be deleted immediately. The number of days must be greater than the days to Archive. An error message will appear if the above conditions are not met. Note If Document Record Removal is not selected, the document will never be permanently removed.
April 2009
2 3 4
Click OK to save the changes. Optionally associate this document profile with a document template. Optionally associate or load the document(s) that uses this document template
April 2009
Caution
Use care when selecting both Delete Document AND Document Record Removal features. Documents could be deleted sooner than anticipated if these are configured improperly.
Document Delete
Document Delete allows you to determine how long a document can exist on the Report Manager system. This value is specified in the Document Storage Profile. For more information on setting Document Storage Profile values, see Configuring Document Storage Profiles on page 112. When the lifetime of the document has been exceeded, Report Manager will take the appropriate steps to remove the document from the system during the next Full Rollover or manual Document Delete Rollover step. For example, a document is loaded on 1/1/2004 with Delete Document selected and Days Before Deleting set to 30. This document will be deleted automatically during the regularly Rollover 30 days after it was loaded into the Report Manager system. Caution Report Manager permanently deletes documents associated with the profile if they are older than the number of days specified. Programmatically, the Document Delete Rollover function will run both the Document Delete function and the Document Record Removal function.
Modifying a Document Storage Profile

As your requirements change, you might need to change the settings for document storage profiles. The following procedure describes how to change profile settings.
April 2009
Note
When you change profile settings, all documents associated with that profile are affected. Therefore, should determine which documents use a profile before you change the profile (see Identifying Where Profiles are Used on page 123). You can also display the Document Storage Profiles dialog box by clicking Document Storage Profiles on the Administration menu. In the Document Storage Profiles dialog box under Profiles Available, select the profile you want to modify. The Edit Document Storage Profile dialog box displays with the settings for the selected profile. Change the settings as required. For information on completing this dialog box, refer to Creating New Document Storage Profiles on page 114. When you finish changing profile settings, click OK.
Note
Changing the Default Document Storage Profile

Report Manager automatically assigns the default document storage profile to each new document template that is subsequently created. Initially, the default profile is the Default Document Profile, as shown below Current Default Profile in the Document Storage Profiles dialog box. If you will be loading files that require a different default profile, the following procedures describe how to change the default document storage profile.
April 2009
Note
If you change the default profile, the new default profile applies to new documents that load into the Report Manager system. Documents that have already loaded into the system are not affected. You can also display the Document Storage Profiles dialog box by clicking Document Storage Profiles on the Administration menu. In the Document Storage Profiles dialog box under Profiles Available, select the profile you want for the default profile. To see the parameters associated with a profile, click a profile under Profiles Available. The document storage parameters associated with each profile display in the fields to the right of the Profiles Available list. Click Make Default. The selected document storage profile displays below Current Default Profile. Click OK to exit the Document Storage Profiles dialog box.
Note
Tip
2 3
Identifying Where Profiles are Used

The Document Storage Profiles dialog box contains a Where Used button that lets you see the documents associated with various document template profiles. Note You can also display the Document Storage Profiles dialog box by clicking Document Storage Profiles on the Administration menu. In the Document Storage Profiles dialog box under Profiles Available, select a profile.
April 2009
Click Where Used. A Documents Using This Profile dialog box similar to the following displays, with the names of the folders and templates that use the selected profile. Folder names appear in upper-case characters, and a slash separates the folder and template names.
Deleting a Document Storage Profile

If you no longer require a document storage profile, use the following procedures to delete it. Note Before you delete a profile, you should check which documents use the profile (see Identifying Where Profiles are Used on
April 2009
page 123). Any documents still associated with a profile that has been deleted will be assigned the default storage profile. If the Document Storage Profiles dialog box is displayed, skip to the next step. Otherwise, click Storage Profile Maintenance in the Storage tab of the New Document Template dialog box. Note You can also display the Document Storage Profiles dialog box by clicking Document Storage Profiles on the Administration menu. Under Profiles Available, click the profile you want to delete. Click Delete. A message box warns you that any documents associated with the profile you will be deleting will automatically inherit the default document storage profile. Confirm to remove the profile from the Profiles Available list.
3 4
Completing the Display Tab

The Display tab in the New Document Template dialog box lets you define a document template name and document type for the document template.
April 2009
Note
Do not use reserved Windows characters such as \, /, *, |, @, etc. in the fields.
April 2009
To complete the Display tab in the New Document Template dialog box, use the following procedure. 1 Initially, Document Name contains the File Specification name you typed in the Storage tab. In the Display tab, type a unique name for the new document template you are creating. By default, both the document filename and document template name display in the Open Document dialog box. If you do not want to include the filename with the document template name, click Include file name with Document Name. Next to Document Type, select whether you want this document template to associate a report or statement document icon to the document.
Selecting This Option Associates This Icon with the Document
Report Manager Reports
Statement document
Note
Document Type does not determine whether documents load into the Report Manager system as reports or statement documents. It only determines which icon is associated with documents. The Storage tab determines whether documents load into Report Manager as reports or statement documents (see Completing the Statement Tab on page 132). Document names cannot be duplicated in the same folder.
Note
April 2009
Completing the IDM Tab

Using the IDM tab in the New Document Template dialog box, you can enable IDM Desktop and Web Services, including Open Client, to search the Image Services repository for reports and statements stored on the Report Manager server. This process is called cross-cataloging, and is further described in Chapter 11, Cross-Cataloging, on page 282.
April 2009
To enable IDM Desktop access, select Report Catalog (Enable IDM Desktop access of documents).The field below this option becomes available.
April 2009
Select the IS Document Class name from the list or click Browse. The IDMIS Document Classes dialog appears. Select from the DocClasses Available list and click OK.
April 2009
To cross-catalog using additional Index fields, you can select from Catalog by Document Title, Catalog by Fixed Value or Catalog by Folder Name options. Select an appropriate Property from the drop-down list.
April 2009
Note
For more details on the cataloging options, refer to Cross-Cataloging by Statement on page 294 Click OK.
Completing the Statement Tab

If you specified a statement template on the Storage tab, the Statement tab displays behind the IDM tab. Use this tab to enable statement index querying for Report Manager clients only, IDM clients only, or both Report Manager and IDM clients. Statement indexes are defined when you use the Statement Administrator to create statement templates. Statement indexes are automatically created after Index Service runs. For more information about using the Statement Administrator to create statement templates, see Chapter 6, Creating Statement Templates, on page 135
April 2009
Use the following procedure to complete the Statement tab in the New Document Template dialog box:
April 2009
Under Enable/Disable Catalog, specify whether you want to enable a statement index query for Report Manager (native) clients only, IDM clients only, or both Report Manager and IDM clients. If you selected Enable IDMIS Catalog Only or Enable Both in the previous step, the IDMIS Catalog section becomes available, where you can identify a document class for the template.
If statement indexes are to be cross-cataloged, create a corresponding IS document class with user-defined fields. Then specify the document class under IDMIS Catalog on the Statement tab. The case and type of IS fields must match those of the Report Manager statement template fields. We recommend that the name of the IS document class match the name of the Report Manager document template to make the doc class meaningful to Report Manager users. When cross-cataloging, these fields can be searched using the IDM client. Create stored search templates for the IDM Web client, so that these fields can be searched. To increase performance when searching, make the field a SQL index. For more information, refer IS documentation.
Note
April 2009
6 Creating Statement Templates Statement Administrator
6
6Creating Statement Templates
The Statement Administrator application creates and manages all statement templates. It allows you to define how print streams will be separated into individual statements. It also defines the information to be extracted. The Statement Administrator is installed as an optional component of the Report Manager services package. This chapter describes how to use the Statement Administrator to create Statement Templates for Statement Processing.
Statement Administrator
The Statement Administrator gives you the ability to create statement templates for processing AFP and Metacode statement documents. Unlike the Report Manager Desktop, which is used to define layouts using a flat-text view, within the Statement Administrator you define a layout using the PDF representation of the AFP or Metacode statement document. With a statement template, only locator and field data can be extracted during statement processing. Later, Report Manager users can retrieve the PDF version of a document based on a query of the field data. Further data mining, however, is not possible.
April 2009
6 Creating Statement Templates Statement vs. Report Comparison
Statement vs. Report Comparison

Statement processing offers several benefits in addition to statement separation (as opposed to report processing). Statements are loaded in parallel and Reports are loaded serially. Statement documents offer: Better scalability for indexing speed --- each statement is represented by only one IDM record. Better scalability for loading speed --- index and flat text file generation are not required for Statements. They are however, required for Reports.
Statement vs. Page Security

Statement security guarantees that each statement will be in a separate file. It has no connection to the granularity of the group or user security applied in the Report Manager Desktop. Page security is more efficient with respect to network traffic, but individual statements are less secure. This is because the data is divided up into files of equal size. Each of these files might contain two or more statements or it might contain part of one statement depending on the size of the segments and the size of the statements. By default, the number of pages stored in a segment is set at 25. You can modify this by changing the Pages_Per_Segment in the [PDF] section of the prm_ss.ini file.
April 2009
Tip
When viewing a statement document from Report Manager or IDM, a segment of the document page is transferred across the network and cached on the client. This segment can have either a variable number of pages based on statement boundaries or a fixed number of pages as specified in the Prm_ss.ini file (see Prm_ss.ini File Contents on page 461). The Security parameter lets you determine how much data in the segment is transferred to the client, based on the security concerns within your organization. The Security selections do not affect statement viewing with the Report Manager Desktop. Also, note that IDM view displays only the statement, regardless of the Security selection in effect. For example, assume you select Page Security and keep the Pages Per Segment value set to 25. If an IDM client user wants to view a two-page statement, 25 pages are transferred to the IDM client but the user sees only the two-page statement that he or she requested. The diagram that follows illustrates the differences between Statement and Page Security.
Note
April 2009
Page Security
Each PDF may contain one or more or part of one statement. Each PDF has a fixed number of pages.
1 2 3
Statement Security
Print Stream
Jones Page 1 Jones Page 2 Jones Page 3 Smith Page 1 Smith 5 6 Page 2 Taylor Page 1 Statement 2 2 pages
Each PDF contains only one statement. Each PDF has a variable number of pages.
Statement 1 3 pages
Segment 1
Statement 3 n pages
25 1
...
Thompson Page 3 Thompson Page 4
Statement x m pages
Segment 2 y
...
Zelder Page ~
April 2009
...
6 Creating Statement Templates Creating New Templates Statement vs. Page Security
Creating New Templates

The Report Manager software does not include any predefined statement templates. Therefore, you must create one for each AFP and Metacode statement document that has its own unique layout. The following steps summarize this procedure. 1 2 3 Start the Statement Administrator. See Starting the Statement Administrator on page 140. Create your first statement template. See Displaying the Statement Template Window on page 141. Load the AFP or Metacode statement for which the template will be created. See Loading the AFP or Metacode Statement on page 143. Specify a page name and type. See Specifying a Page Name and Page Type on page 152. Define the locators in the statement. See Defining Locators on page 159. Define the fields in the statement. See Defining Fields on page 167. Test the locators and fields you defined in the statement. See Testing Your Layout on page 172.
4 5 6 7
April 2009
6 Creating Statement Templates Creating New Templates
Starting the Statement Administrator

Use the following procedures to start the Statement Administrator. 1 If Traffic Service is not running, click the Start button on the Microsoft Windows taskbar, click Programs > FileNet Report Manager Services > Report Manager Services Controller and select Traffic Service. The Statement Administrator is only available if Report Manager services are installed. Perform one of the following steps: From the Administration menu in the Report Manager Desktop, click Statement Administrator. OR Click the Start button on the Microsoft Windows taskbar, click Programs > FileNet Report Manager Services > FileNet Report Manager Statement Administrator.
Note
April 2009
The Report Manager Statement Administrator window displays.
Displaying the Statement Template Window

After you start the Statement Administrator, use the following procedure to display the Statement Template window and specify the appropriate parameters. 1 On the File menu, select New. The Statement Template window displays. The left side of this window contains a tree view of the statement template you will be laying out. The names of the statement template, statement pages, locators and fields display in the tree view, along with a plus or minus sign. A plus sign next to a folder indicates it can be expanded to show more entries. A minus sign indicates the folder can be collapsed.
April 2009
The right side of this window lets you specify statement parameters.
2 3
In the Name text box, type a name for the statement template you are defining. The name can contain up to 16 characters, including spaces. Define security using one of the following options (see Statement vs. Page Security on page 136): Statement security. With this option, when the input file is processed, Report Manager stores statements in segments of a fixed number of pages in the archive file. As a result, each segment may contain several statements.
April 2009
Page security. With this option, Report Manager stores each statement as an individual segment in the archive file. This guarantees that when a statement is viewed by a client, no other statements are sent over the network in the segment. For more information, see Statement vs. Page Security on page 136.
Report Manager Index data can be maintained in three modes: Native - Stored in the Report Manager database only IDMIS - Stored in Image Services only Both - Stored in both the Report Manager database and in the Image Services Database
Storage profiles determine the retention of statement indexes defined in the statement template. If you defined a storage profile using the procedure under Defining Index Storage Profiles on page 192, click the desired profile in the Storage Profile list. Otherwise, the default index profile will be used. Last Updated refers to the date the Storage Profile was last updated. Click Apply. The name you typed displays in the title bar of the Report Manager Statement Administrator window.
6 7
Loading the AFP or Metacode Statement After you specify your selections in the Statement Template window, use the following procedure to load the AFP or Metacode statement for which the template will be created. 1
April 2009
On the Statement menu, select Load Statement.

The Load Statement dialog box displays. Tip If you load AFP and/or Metacode statements from a single directory, you can specify the directory in the Statement Administrator preferences (see Changing Statement Preferences on page 181). Then each subsequent time the Load Statement dialog box displays, the contents of the specified directory will appear.
April 2009
Use the Files of type list to view AFP files with a .AFP extension, Metacode with an *.MTA extension, or all files (for any type of file). If you select AFP or Metacode, the option under Data Type reflects your selection. To select a file type manually, click AFP or Metacode under Data Type. Move to the directory that contains the AFP or Metacode file you want to load and either: Double-click the file to open the statement if the parameter file and font table are specified in the Load Statement dialog box. Skip the remaining steps and go to Specifying a Page Name and Page Type on page 152.
Tip 3
Note
Do not select the files to be opened if the parameter file or the font table file has not been specified otherwise the following error will occur.
Tip
If you will load all or most of your AFP and/or Metacode documents from the directory you select in step 3, click Default Dir to have this directory appear each time the Load Statement dialog box displays.
April 2009
Under Page Range, select whether you want to load all pages in the AFP or Metacode statement, or just a range of pages. By default, the Statement Administrator can load up to 200 pages. To load files larger than 200 pages, either separate them into several smaller files or change the Maximum Number of Pages Allow to View parameter in the Preferences dialog box (see Changing Statement Preferences on page 181). To view pages that exceed the maximum you may specify a page range using the From and To option. If there is no parameter file specified, or if you want to use a parameter file other than the one shown: a Click next to Parameter. The Choose Parameter File dialog box displays.
Tip
April 2009
b c
Move to the directory that contains the parameter file you want to use. Click the parameter file and click Open. The parameter file you selected displays next to Parameter in the Load Statement dialog box.
April 2009
To modify the parameter file, click the Edit button next to in the Parameter row to load Notepad with the selected parameter file.
Tip
If you use the same parameter file for all or most of your statements, you can specify the file in the Statement Administrator preferences (see Changing Statement Preferences on page 181). Each subsequent time the Load Statement dialog box displays, the selected parameter file will appear. If there is no font table specified, or if you want to use a different font table: a Click next to Font Table. The Choose Font Table File dialog box displays.
April 2009
b c
Move to the directory that contains the font table you want to use. Click the font table and click Open. The font table you selected displays next to Font Table in the Load Statement dialog box. To modify the font table, click the Edit button next to in the Font Table row to load Notepad with the selected font table file.
April 2009
Tip
If you use the same font table for all or most of your statements, you can specify the font table in the Statement Administrator preferences (see Changing Statement Preferences on page 181). Each subsequent time the Load Statement dialog box displays, the selected font table will appear. If you use all or some of the Load Statement dialog box parameters with future statements, click Default Param to have the parameters appear the next time the Load Statement dialog box displays. Click Open. A Statement window displays, with the selected AFP or Metacode statement. The status bar at the bottom of the Report Manager Statement Administrator window shows the current statement page displayed, the total number of pages in the statement, and the viewing percentage (default is 100%). The following figure shows an example of a Metacode statement displayed in the Statement window.
Note
It may take several seconds for the statement to display, depending on its size. To speed up the display, specify a smaller page range. Proceed to Specifying a Page Name and Page Type on page 152.
April 2009
April 2009
Specifying a Page Name and Page Type After you open the AFP or Metacode statement you want to use as a template, use the following procedure to specify a page name and page type for the page displayed in the Statement window. 1 Resize and drag the Statement Template and Statement windows so you can see them both on your desktop. The following figure shows one way to arrange the windows.
April 2009
April 2009
With the Statement template active, on the Statement menu, click Create and Page. The tree view in the Statement Template window shows Page 1, along with icons for Locators and Fields as shown in the following figure.
With Page 1 in the tree view highlighted and the blinking cursor in the Name text box, replace Page 1 with a name you want to assign to the first page of the statement you will be laying out. In our example, we type the name Statement First Page.
April 2009
The Page Type field whether this page is the start of a new document or a page in the document currently being loaded. There are three choices: Conditional Statement Start - When locators in the page template are found, they indicate the beginning of a new statement unless the last processed page was an unconditional statement start page. If the previous page processed was an unconditional statement start page, the Report Manager software treats this page as a page in the current statement and will not begin a new statement. Unconditional Statement Start - Locators in the page template indicate the beginning of a statement. If Statement security is selected, Report Manager produces a new file starting with this page and ending when the next statement start has been found. Page - When locators in the page template are found, the Report Manager software treats the page as another page in the currently processed statement.
April 2009
April 2009
Conditional vs. Unconditional Statement Start Sometimes a page will be the start of a statement except under certain conditions. For example companies sometimes send out statements which contain a check, as the first part of the statement, followed by the statement itself. Page Type
Jones Page 1 Jones Page 2 Jones Page 3 Smith Smith Page 2 Taylor Statement 3 n pages Page 1
Conditional Statement Start Page Page Unconditional Statement Start Conditional Statement Start
Statement 1 3 pages
Statement 2 2 pages
Check Page 1
Conditional vs. Unconditional Statement Page Types
Consider a file, such as shown above, that contains multiple statements some of which contain checks as the first page in the statement. When designing the Report Manager Statement Template a page such as the one containing the check (e.g. Statement 2, page 1) is designated as an Unconditional Statement Start because when encountered in a file it is always the first page of a statement. A page containing the actual statement (e.g. Statement 1, page 1) is desigApril 2009 Report Manager System Administrators Handbook, Release 5.0a 157
...
nated as a Conditional Statement Start because it is the start of a statement under the condition that the previous page was NOT an Unconditional Statement Start. During file processing, when Report Manager encounters a page designated as a Conditional Statement Start it looks to see if the previous page was an Unconditional Statement Start. If the previous page was an Unconditional Statement Start then the current page is treated as the second page of the statement. If the previous page was not an Unconditional Statement Start then the page is treated as the first page of a new statement. Page Statement pages that never occur at the start of the statement should be designated as type Page. During processing, when Report Manager encounters a Page it is treated as a page in the current document that began with the previous statement start.
April 2009
Click Apply. The name you typed replaces Page 1 in the tree.
Defining Locators
Locators represent specific physical locations on the statement page. Report Manager can identify a page based on the values found in the locators. You define locators in the Statement window using a patternmasking technique consisting of literals, alphabetic wildcards, and numeric wildcards. Note If you do not define any locators in the statement template, Storage Services does not recognize statement pages.
April 2009
Maximize the Statement window. Then magnify the statement to a comfortable viewing level for defining locators. The view should be large enough to view the complete area where you will be drawing locator zones. a b Click the Statement window to make it active. On the View menu, click Zoom and select a viewing percentage. If you magnify the statement too much, click the Zoom Out button to shrink it.
The status bar shows the magnification percentage you select. 2 To define the first locator, on the Statement menu, click Create > and select Locator. In the status bar at the bottom of the Report Manager Statement Administrator window, Locator displays to show that you are in Locator mode. 3 Hold down the left mouse button (the pointer changes from an arrow to a crosshair pointer). Drag around the text where you want to define the first locator, then release the left mouse button. By default, a red locator zone defines the location where you dragged (to change this default color, see Changing Statement Preferences on page 181).
April 2009
In our example, a highlighted locator zone defines the Policy Number as our first locator.
Observe the following guidelines when defining locator zones: W and H in the status bar show the width and height locations of the pointer in the Statement window. Use these measurements as aids when specifying locator zones. Define locator zones on one line at a time. If you define more than one locator on a line, the locators are anded together. Therefore, if you want a locator to span two or more lines, create a separate locator on each line.
April 2009
Locators should comprise complete sentences or words, not partial sentences or words. For example, a valid locator might be Statement Administrator while an invalid locator might be ment Admin. The locators you define must exist on all pages of the document. Otherwise, Report Manager ignores the page. For accuracy, place the border line of the zone as close to the locator text as possible. Include as little white space as possible in the locator.
Note
The zone locator perimeter is fairly sensitive. Be careful to include just the area you need within the zone locator. Covering too large an area may pick up extraneous unwanted information while covering too little may not pick up enough. If you make a mistake, click the locator you drew; then either press the right mouse button and click Delete Page/Locator/Field or press the Delete button on the toolbar:
When the message asks whether you are sure you want to delete the locator, click Yes. Then repeat steps 2 and 3. Locators are numbered sequentially. If you delete the last locator you define without clicking Apply in the Statement Template dialog box, the locator is removed but the Report Manager software remembers the locator number. As a result the next locator you define is incremented from the previous one.
To define additional locators on the page, repeat steps 2 and 3.
April 2009
Note
Each new locator you define displays under Locators in the tree view of the Statement Template window. By default, the new locator is red in the Statement window, with previously defined locators in magenta. To change these default colors, see Changing Statement Preferences on page 181. To save the template, click File and Save. The Save Statement Template dialog box displays, with the statement template name shown next to Statement Template. If you previously saved statement templates, their names display in alphabetical order in this dialog box.
6 7
Either accept the statement template name shown or type a new, unique name in the Statement Template field. Click Save. The statement template name displays in the title bar in the Report Manager Statement Administrator window.
April 2009
In the Statement Template window, click the name of the first locator you defined. The parameters associated with the locator display to the right of the tree view. In our example, the parameters associated with Locator 1 display, as shown in the following figure. In the Statement window, the selected locator displays in the default zone locator color (red), with the other locators displayed in the default unselected zone locator color (magenta).
April 2009
9 10
In the Name field, replace the Locator 1 name with one that is meaningful. In our example, Statement of Value. The Pattern field lets you type a locator based on an exact pattern of alphabetic characters or sequential numbers that you want matched. For example, to match the locator Page, type Page as the pattern. You can match against a limitless number of items by using the following wildcards.
Wildcard
Description
Designates a numeric digit. Type one # for each digit you want matched. Example: If a statement has Page 1 on the first page, Page 2 on the second page, and so on, and you want to match each Page instance, type Page # as the pattern. However, if the number following Page consists of more than one digit, type # for each digit to be matched. For example, if a statement starts with Page 1 and ends with Page 120, specify the pattern as Page ### to make sure that all three digits are matched. Designates an alphabetic character. Type one @ for each alphabetic character you want matched. @ Example: If you type the pattern F@ST you get patterns that include FAST and FIST. If you type the pattern F@@ST you get patterns such as FIRST and FROST. Designates any character, except null. Type one ? for each character you want matched. ? Example: If a seven-page statement uses numbers and words to denote page numbers (for example, Page 1 and Page Two), type Page ????? to match both the numbering schemes. In this example, 5 question marks are used to make sure that the word Seven (for Page Seven) is matched if it appears as a word.
April 2009
Note
You can include a slash (/) in a pattern if you want the Statement Administrator to consider the next character literally. You might use an additional slash if you want to match on a string that contains one of the wildcard characters shown in the above table. For example, to match Account #, type Account /#. If you omit the slash, matching occurs only if a number is found in place of the # sign. By default, the Statement Administrator differentiates between uppercase and lower-case characters. If you do not want the utility to make this differentiation, click the No radio button next to Case Sensitive. In-Line% specifies the maximum distance between adjacent words in a locator zone. This option is particularly useful when a zone contains multiple words in different fonts. In most instances, the default value of 20 is satisfactory. Setting In-Line% to a smaller value can have the Statement Utility return only one word, even if there are two or more words in the locator zone. Upper Left X and Upper Left Y show, in inches, the top left and right coordinates of the locator-defined area. To change these areas on the locator, type your changes in these text boxes. Lower Right X and Lower Right Y show, in inches, the lower left and right coordinates of the locator-defined area. To change these areas on the locator, type your changes in these text boxes. Click Apply. The name you assigned to the locator replaces its default name in the tree view of the Statement Template window. Click each remaining locator in the tree of the Statement Template window and repeat steps 9 through 15. For easy identification, each locator you click in the Statement Template window turns red in the Statement window.
11
12
13
14
15 16
April 2009
Note
If you click the next locator without first clicking Apply, a message prompts you to apply your changes. To define locators on other pages in the statement, click the Statement window to make it the active window. Then press the Page Down key, or use Page Down or Goto Page on the View menu to display another page in the Statement Template window. The locators you defined on the first page display at the same positions of the other pages you go to.
17
Note
Defining Fields
Within a Statement template, fields define the location of actual data to be indexed (recall that APA documents cannot be mined for data). Unlike line mode document fields whose positions rely on finding text characters within a section, statement fields are defined as zones of a page that contain information to index. After you define the locators in the statement, use the following procedure to define the fields. 1 With the Statement window maximized and the statement in the window magnified for optimum viewing, perform one of the following steps to define the first field: On the Statement menu, click Create and Field. In the status bar at the bottom of the Report Manager Statement Administrator window, the word Field displays to show that you are defining a field. 2 Hold down the left mouse button (the pointer changes from an arrow to a crosshair pointer). Drag and select the text where you want to define
April 2009
the first field. By default, a cyan field zone defines the selected field location. To change this default color, see Changing Statement Preferences on page 181. In our example, the customers policy number is the first field.
April 2009
Tip
The same tips used to define locators also apply to fields. For more information, see the tips under Defining Locators on page 159. To define additional fields on the page, repeat steps 1 and 2. In our example, we defined two fields on the page: the customers policy number and name. Each new field you define displays under Fields in the tree view of the Statement Template window. By default, the new field is cyan in the Statement window, with previously defined fields in blue-green. To change these default colors, see Changing Statement Preferences on page 181. Click Save. In the Statement Template window, click the name of the first field you defined. The parameters associated with the field display to the right of the tree view. In our example, the parameters associated with Field 1 display, as shown in the following figure.
Note
4 5
April 2009
For Name, replace the name shown with one that is meaningful. If you type spaces in the name, the spaces convert to underscores. If you will cross-catalog this statement index to IDMIS, the field names you specify here must match the field names of the IDMIS DocClass. Select Type from the list.
Note
April 2009
In the Width field, type the maximum width of the field in digits. For example, if you define a numeric field whose contents can range from 5 to 10 digits, type 10 in the Width field. In the SQL Index Field, accept the No default if you do not want to use SQL Server indexing with this field. Otherwise, click Yes. For the remaining parameters, see steps 11 through 14 under Defining Locators on page 159. Click Apply. The name you assigned to the field replaces the fields default name in the tree view of the Statement Template window. Click each remaining field in the tree of the Statement Template window and repeat steps 6 through 11. For easy identification, each field you click in the Statement Template window turns blue-green in the Statement window. If you click the next field without first clicking Apply, a message prompts you to apply your changes. To define fields on other pages in the statement, click the Statement window to make it the active window. Then press the Page Down key, or use Page Down or Goto Page on the View menu to display another page in the Statement Template window and repeat steps 2 through 12. The fields you defined on the first page display at the same positions of the other pages you go to.
9 10 11 12
Note
13
Note
April 2009
Testing Your Layout After you define fields and locators in the statement, use the following procedure to test your layout. 1 On the Statement menu, click Test Template.The Statement Testing dialog box displays.
By default, all the pages in the statement are tested. To test the current page only, click Current Page, To test a range of pages, click Pages and type the page range (for example, 3-8 or 6,7). 2 Under Perform Testing, click either Locate Statement Pages or Display Text in Zones.
April 2009
Locate Statement Pages locates each page to be tested and displays a 1 (one) if the Statement Administrator can recognize the page. Pages that cannot be recognized are ignored. For more information, see Locate Statement Pages Results on page 173. Display Text in Zones extracts data from all locators and fields on the tested pages. Unlike Locate Statement Pages, Display Text in Zones does not ignore pages it cannot recognize. For more information, see Display Text in Zones Results on page 174.
Click OK. The Statement Administrator tests the page and displays the results in the Statement Template Testing window. Locate Statement Pages Results The following figure shows an example of the results when Locate Statement Pages is used to test statement pages. The L designation in the column headers denote locators, while the F designation denotes fields.
April 2009
As this example shows, the Statement Administrator recognized the pages shown in the Document Page # column (pages 7, 9, 11, 13 and so on). Pages not shown in this column could not be recognized and were ignored. Display Text in Zones Results The following figure shows an example of the results when Display Text in Zones is used to test statement pages.
April 2009
As this example shows, the Statement Administrator returns every page tested. The L designation in the column headers denote locators, while the F designation denotes fields. White-colored rows represent the current fields and locators for the page. If a field or locator could not be recognized, the corresponding row is gray.
April 2009
Completing Statement Administrator Activities

When you finish defining statements, click Close on the File menu. A message asks whether you want to save your changes. Click Yes to save them, No to discard them, or Cancel to keep the statement displayed. You can then use the Report Manager Desktop to associate the templates to your files.
Editing Fields and Locators

To modify the parameters for a field or locator in a statement, use the following procedures. 1 In the Statement window, click the locator or field you want to edit. The selected locator or field displays in the default zone color. The parameters associated with the selected locator or field display in the Statement Template window. Change the appropriate parameters in the Statement Template window.
Deleting Fields and Locators

If you no longer need a field or locator, use the following procedure to delete it. 1 In the Statement window, click the locator or field you want to delete. The selected locator or field displays in the default zone color. The parameters associated with the selected locator or field display in the Statement Template window. Click the right mouse button and select Delete Page/Locator/Field.
April 2009
Confirm the deletion.
Deleting Pages
If you no longer need a page in a statement, use the following procedures to delete it. 1 2 3 In the Statement Template window, click the page you want to delete. In the Statement window, click the right mouse button and select Delete Page/Locator/Field. Confirm the deletion.
Editing Statement Templates

To modify a statement template you created, use the following procedure. 1 On the File menu, click Open. An Open Statement Template dialog box displays, with an alphabetical list of statement template names and the date when the templates were last updated.
April 2009
Either double-click the name of the statement template you want to open, or click the statement template name and click Open. The statement displays in the Statement Template window.
Renaming a Statement Template

The following procedure describes how to rename a statement template. If Storage Services processes a statement associated with a statement template, use the Report Manager Desktop to delete the corresponding statements before you rename the statement template. 1 On the File menu, click Open. The Open Statement Template dialog box displays, with an alphabetical list of statement template names and the date when the templates were last updated.
April 2009
2 3
Click the name of the statement template you want to rename. All of the buttons at the right side of the dialog box become available. Click Rename. The Rename Statement Template Name dialog box displays, with the name of the statement template you want to rename. In the following example, a statement template called Statement_1 has been selected for renaming.
April 2009
Type a new name for the statement template and click OK. The new statement template displays in the Open Statement Template dialog box. When you finish renaming statement templates, click Cancel to exit the Open Statement Template dialog box.
Deleting Statement Templates

The following procedures describe how to delete a statement template. If Storage Services processes a statement associated with a statement template, use the Report Manager Desktop to delete the corresponding statements before you delete the statement template. 1 On the File menu, click Open. The Open Statement Template dialog box displays, with an alphabetical list of statement template names
April 2009
and the date when the templates were last updated.
2 3 4
To delete a single statement template, click its name. You can delete more than one at a time. Click Delete and confirm. Click Cancel to exit the Open Statement Template dialog box.
Changing Statement Preferences

Using the Preference dialog box, you can change Traffic Service (TS), APA file, and zone color parameters related to the Report Manager Statement Administrator. To display the Preference dialog box, click Preference on the View menu.
April 2009
The Preference dialog box has three tabs: The Traffic Service tab lets you define remote procedure call (RPC) parameters. See Specifying Traffic Service RPC Parameters on page 183. The APA Files tab lets you lets you specify APA file parameters. See Specifying APA File Parameters on page 184. The Zone Color tab lets you change the colors for the zones you define in the statement templates. See Specifying Zone Colors on page 185.
April 2009
Specifying Traffic Service RPC Parameters The Traffic Service tab in the Preference dialog box contains the following RPC parameters.
Protocol shows the RPC protocol being used. To specify a different protocol, select one from the list. Endpoint shows the RPC endpoint. This is a read-only text box. Network Address shows the RPC network address of the computer on which TS is running. To specify a different network address, type it in this text box.
April 2009
Specifying APA File Parameters The Traffic Service tab in the Preference dialog box contains the following parameters. Maximum Number of Pages Allow to View shows the maximum number of pages that can be viewed in an AFP or Metacode statement. By default, this value is 200. To load statements larger than 200 pages, increase the default value. If you will be loading AFP and/or Metacode documents from a single directory, use APA File Directory to specify that directory. Click , and click a font table file in the Choose Font Table dialog box, and click Open. Each time you load a statement, the Load Statement dialog box opens with this directory specified. If you will be using the same parameter file with AFP and Metacode statement documents, Click .
Click the parameter file in the Choose Parameter File dialog box, and click Open.
Each time you load a statement, the Load Statement dialog box will open with this parameter file specified. If you will be using the same font table file with your AFP and Metacode statement documents: Click .
April 2009
Click a font table file in the Choose Font Table dialog box and click Open.
Each time you load a statement, the Load Statement dialog box opens with this font table file specified. Specifying Zone Colors The Zone Color tab in the Preference dialog box contains the following parameters.
Locator Zone shows the colors associated with selected and unselected locators. To change these colors, click the arrow button to the right of the appropriate color, select a different color from the Color dialog box, and click OK. Field Zone shows the colors associated with selected and unselected fields. To change these colors, click the arrow button to the
April 2009
right of the appropriate color, select a different color from the Color dialog box, and click OK.
What to do After Creating Statement Templates

Before loading files into the Report Manager system, you must also define a document template in order to associate the file specification with the appropriate statement template. (See Creating a New Document Template on page 94).
April 2009
7 Statement Indexes The Indexing Process
7
7Statement Indexes
An index is a collection of index fields which allow Report Manager users to locate and extract information by content. You create definitions for the indexes of a specific statement type using the Statement Administrator. Afterwards, statement documents having a matching statement type are automatically indexed at load time.
The Indexing Process

The Report Manager Index Service (IS) generates SQL tables based on indexes that the system administrator defines. These table entries are used to query specific reports. Index Services connects to the SQL database directly through ODBC drivers to insert indexes. This direct connection accelerates the indexing process. If Index Services encounters a problem indexing a file, it reports the problem and skips to the next file in the indexing queue. Traffic Services stores problem file IDs in memory and Index Services bypasses them in subsequent runs. To clear memory and process these documents, click Index Status on the Options menu in Traffic Service. If Index Services shuts down while indexing, check the size of your database and log files. If the files are full, you will not be able to index documents. In this case, back up the log file, and then delete the file. Index Queue (PRMIdxQueue) entries are generated either by Storage Service during the load process or by Traffic Service through Report
Manager Desktop functions. The queue entries can specify one of the following indexing operations: Add adds records to a corresponding monthly index table for a specific document. Replace deletes any occurrence of a document in the table and re-indexes the document. Remove removes all occurrences of the document from the table for each of the indexing operations.
The nature of the indexing is further specified as a combination of the following: Native: Indexing a document into the Report Manager native database. The document is indexed as a report or statement. Monthly tables holding transaction records are named GVI_ <name of index>_yyyy_mm (where yyyy is a four-digit year and mm is a two-character month). Similarly, monthly tables holding statement values are named: PRMS_<statement template name>_yyyy_mm. Documents to Image Services: Indexing the specified document into an Image Services catalog. Transaction to Image Services: Indexing the transaction records within the specified document into an Image Services Catalog. Statement to Image Services: Indexing statements within a specified document into an Image Services Catalog.
Typically, Storage Services inserts an add record, while the Report Manager Desktop inserts a replace or remove record.
April 2009
Traffic Service keeps track of the indexing jobs allocated to each Index Service. Each Index Service, in turn, periodically requests queued items from Traffic Service once the SleepTime duration has elapsed. If Index Service finds a valid record, it processes the record. After Index Service successfully processes the record, it deletes the request and informs Traffic Service that processing was successful. Traffic Service then removes the item from its tracking list. However, if processing was not successful, Traffic Service marks the ID as a bad record to prevent the same document from being reprocessed by any other Index Service. You can click Index Status on the Options menu in Traffic Service, then double-click the document that encountered errors to clear the item (see Appendix B Traffic Service on page 367. After Index Service completes the index process, you can perform queries on your documents.
Tip : W hen Index S ervice requests Traffic S ervice for the index queue record, T raffic S ervice fetches the batch of records from the P R M IdxQ ueue table. B y default, this batch size is 1000. For altering this batch size, the user can create and define its value under D E FA U LT section in P rm _ts.ini file. T he configurable batch option has been provided for im proving the Index S ervice perform ance of R eport M anager 5.0a. D epending on the num ber of records in the P R M IdxQ ueue table B atchS ize variable under the D E F A U LT section in P rm _ts.ini file can be configured anywhere in range of 1 10,000. For e.g. if user has large num ber of records within the database, user should opt for the higher B atch size else use sm aller B atch size values.
April 2009
Tip: For improving the performance of Index Service, user can configure Sleep Time. This is the duration after which Index Service polls the PRMIdxQueue table to fetch records for indexing. By default this value is 300 seconds. The user can alter this duration to any time between 60 seconds 300 seconds.
April 2009
7 Statement Indexes Generating Indexes for Statement Documents
Generating Indexes for Statement Documents

At load time, Report Manager automatically creates indexes for statement documents. The statement template you create with the Statement Administrator defines the layout of the fields and the name of the index is the same as the name of the statement template. The following steps describe how to generate indexes for statement documents. 1 2 Create a statement template. See Creating Statement Templates on page 135. Create a document template (see Creating a New Document Template on page 94). When creating the template, select the appropriate option: Statement template on the Storage tab (see Completing the Storage Tab on page 95). This is the template you defined using the Statement Administrator. Indexing options on the Statement tab (see Completing the Statement Tab on page 132).
3 4
Define an index storage profile for the index. See Defining Index Storage Profiles on page 192. Load the documents into the Report Manager system (see Appendix C Storage Service on page 383).
April 2009

Do not define multiple indexes when a single index will suffice. Multiple indexes increases the size of the database unnecessarily and can affect performance. For example, assume that a bank has a headquarters location and five branch offices and assume that each branch office indexes the customer names and account balances for each days transactions. In addition, the headquarters location generates a daily master index for all customer transactions at the five branches. This multiple indexing results in the same data being indexed by the headquarters location and the five branch offices. A better alternative is to have a master index generated at the headquarters location only or to have the branch offices index information different from that which will be indexed by the headquarters location.
Defining Index Storage Profiles

The following procedures describe how to define index storage profiles for statement documents. An index storage profile determines how an index is to be managed over time. Initially, Report Manager uses a default profile that contains the parameters shown in the Index Storage Profiles dialog box. You can, however, create new profiles to suit your requirements when you define the layout of Statement documents. After you create one or more index storage profiles, you specify one as the default profile. Report Manager automatically attaches the current default profile to newly created indexes. See Changing the Default Index Storage Profile on page 197.
April 2009
The Index Storage Profiles dialog box also has a Where Used button that displays what indexes use which index profiles. See Identifying Where Profiles are Used on page 198. After you select an index storage profile, proceed to Completing the Filter Tab on page 269. Creating New Index Storage Profiles Use the following procedures to create new index storage profiles for statement documents. 1 On the Administration menu, select Index Storage Profiles. The Index Storage Profiles dialog box displays.
April 2009
Click Add. The Add Index Storage Profiles dialog box displays.
April 2009
Under Profile Name, type a unique name for the index storage profile you are creating. If you type a profile name that already exists, Report Manager appends a (2) to the second profile name, a (3) to the third, and so on. By default, indexes associated with this profile will not be purged. To purge indexes associated with this profile, click Purge Index. In the text
Note
April 2009
box, type the number of days that must pass before Report Manager automatically purges the indexes associated with this index profile. 5 If you installed the IDM Desktop, you can have indexes purged from the IDMIS catalog. Click Purge from IDMIS Catalog. In the text box, type the number of days that must pass before Report Manager automatically purges the indexes associated with this index profile from the IDMIS Catalog. If you did not install Image Services, Purge from IDMIS Catalog is unavailable. Click OK. The Index Storage Profiles dialog box displays. The name of the index storage profile you added displays under Profiles Available.
Note
Modifying an Index Storage Profile As your requirements change, you might need to change the settings for index storage profiles. Use the following procedure to change profile settings. Note When you change profile settings, all indexes associated with that profile will be affected. Therefore, you might want to see which indexes use a profile before you change the profile (see Identifying Where Profiles are Used on page 198). In the Index Storage Profiles dialog box under Profiles Available, select the profile you want to modify and click Edit. The Edit Index Storage Profiles dialog box displays, with the settings for the selected profile. Change the settings as required. When you finish changing profile settings, click OK.
2 3
April 2009
Changing the Default Index Storage Profile Report Manager automatically applies the default index storage profile to each new index you create. Initially, the default profile is the Default Index Profile, as shown in the Current Default Profile field of the Index Storage Profiles dialog box. If you are creating indexes that require a different default profile, you can use the following procedure to specify a different index storage profile as the default. Note If you change the default profile, the new default profile applies to new indexes you create. Indexes that have already been created are not assigned the new profile. In the Index Storage Profiles dialog box under Profiles Available, select the profile you want to make the default profile. To see the parameters associated with a profile, click a profile in Profiles Available. The index storage parameters associated with each profile display in the fields to the right of the Profiles Available list. Click Make Default. The selected index storage profile displays below Current Default Profile.
Tip
Deleting an Index Storage Profile If you no longer require an index storage profile, use the following procedure to delete it. Note Before you delete a profile, we recommend you check which indexes use the profile (see Identifying Where Profiles are Used on page 198).
April 2009
1 2
In the Index Storage Profiles dialog box under Profiles Available, click the profile you want to delete. Click Delete. A message box warns you that any indexes associated with the profile you are deleting will automatically inherit the default index storage profile. Confirm to delete the profile.
Identifying Where Profiles are Used The Index Storage Profiles dialog box contains a Where Used button that lets you see the indexes associated with various index profiles. 1 2 In the Index Storage Profiles dialog box under Profiles Available, click a profile. Click Where Used. The Indexes Using This Profile dialog box displays containing a list of the indexes that use the selected profile.
April 2009
8 Document Layouts
8
8Document Layouts
A document layout is a definitions template showing where information is located in the line data for a report. You can define a document layout for line data, AFP, and Metacode Reports.The layout determines how Report Manager queries and indexes reports and statements. It also determines how Report Manager performs report mining to extract information from reports. The following table compares the two layout methods available in Report Manager. By comparing the advantages of each layout method, you can determine which method is better suited to your requirements.
Defining a Layout Using the Report Manager Desktop Defining a Statement Template Using the Statement Administrator
Criteria
Laying Out Definition Indexing Documents Data Mining Load Time Table of contents IDM Desktop/Web
Defined in text view (line data mode) Defined in PDF view Supported Supported Slower than statement processing None Finds a report based on line-item information Supported Not supported Significantly faster than when the Report Layout method is used Appended to the end of the file Allows one statement document to be viewed in the IDM Desktop/Web client (Allows Statement Security to be implemented.)
April 2009
8 Document Layouts Understanding Layouts
Understanding Layouts
The following sections describe how to use Report Manager Desktop to create a layout for Line Data documents and AFP and Metacode reports.
Planning a Layout
The following paragraphs provide guidelines for defining a layout for Line Data documents and AFP and Metacode reports. Note You cannot apply a layout until you attach a document template to a loaded document.
Identifying Document Characteristics

You should become familiar with the characteristics of the report. When laying out the document, pay particular attention to unique headers, footers, and words that can be used as headers, literals, and fields. You should also speak with the people who will be viewing the information to find out what fields are necessary for them to perform their tasks.
Understanding Layout Components

Report Manager relies on the fact that data in a report appears in consistent locations. You define layout using sections, locators and fields so that Report Manager can identify the correct placement of data in the report.
April 2009
Layout Sections
Report Manager identifies sections in a document positionally, according to the number of lines from the top and bottom of the page. A specific layout section alerts Report Manager to an area on a page that contains data you want to query, index, or extract. A layout section is a recurring region of one or more contiguous lines in a report. For reports, this region contains the information that can be queried, indexed, and data mined. Specific pieces of information to be extracted are represented by section fields. The section occurrence is identified by one or more section locators. In the following sample report, the lines starting with As of and ending with Account # can identify a section. As of is always in the upper left corner of the document at the same coordinates, with Detail Daily Balance Sheet and Account # lines below. This pattern appears at the beginning of every report, and its identified as a Pager Header.
April 2009
The only difference between the headers of each report is the actual values (As of: 01-AUG-95). However, these values are always in the same location. In the following example, Assets and Total have been identified as section header and footer respectively. The line following the Eurodollar has been identified as a detail section.
April 2009
April 2009
That works for the first page. However, paging down, you see the following:
Sections are defined in relation to positions on the page, so on the next page, where the words Asset and Total do not appear in the exact same positions, the highlighted information is different. This problem is remedied through the use of locators.
Locators tell Report Manager to look for specific or wildcard characters within a field before identifying the line as having relevant data. Section Types When you define a section, you assign it one of the following section types. Document header or footer Page header or footer Group header 1 through 5 Group footer 1 through 5 Detail In this list, Document Header represents the rows that contain information at the highest level, while Detail represents rows that contain the most detailed or finest granularity of information to be extracted from the report. An example of a Document Header is a document number that appears on the first page of the document only. An example of a Detail are the customer names, addresses, and telephone numbers that appear on the same contiguous lines in every page of a document. The following sections provide more information about section types. An example of using section types appears under Section Type Examples on page 207. Detail Sections Although you can define any of the section types in any order, it usually is best to identify the Detail sections first, because a database record is generated for each Detail section you define.
By defining Detail sections first, you can ascertain the number of database rows that will be generated. A good rule of thumb to follow is to mark as Detail sections those fields that will be of interest within a section. After you define all the Detail sections, you can switch to Layout view to obtain a visual indication of all the defined Detail sections and all other fields in the report. Groups Groups define contiguous rows that surround one or more Detail sections and contain information that should be associated with Detail sections. A Group consists of a header that starts the group and a footer that ends the group. Groups are indicated as Group Header/ Footer 1 through Group Header/Footer 5. Information from Groups is extracted by defining fields within the header and footer sections. Note You can omit footers, in which case another Group of equal or higher level automatically ends the Group whose footer is missing. Defining more than one group allows a hierarchy of groups to be defined, which can be surrounded by higher level groups. For example, multiple Group 5 groups can be defined within a Group 4. Report Manager treats all Group fields as though they are part of each contained Detail section. A database record does not correspond to a Group Header or Group Footer unless a Detail section has not been defined; in this case, Report Manager treats the lowest level Group Header as a Detail section. Page Headers and Page Footers You use Page Headers and Page Footers to define fields that should be associated with Detail sections, independent of Groups. Fields in
Page Headers and Page Footers are applied to all Groups and Detail sections that reside between the Page Header and Page Footer (or next Page Header, if the Page Footer is not defined). We recommend that you use Page Headers and Page Footers to identify information that is page dependent. Document Header and Document Footer Document Headers and Document Footers are intended to encapsulate all the information in a document. Document Header and Document Footer take document-specific information and associate it with every Detail section of the document. Tip An outermost group terminates all innermost groups; however document headers and footers do not terminate innermost groups. Section Type Examples The following example is one page from a report that indicates sales accounts. Each page lists the sales for another agent employed by company ABC. Within each page, the sales activities for the agent are divided by territory. The following example shows the sales for Paul Smith. Following this example are descriptions of how section types can be used to mark fields of information that are to be retrieved from the report.
Page Header Group Header 1 Group Header 2 Detail
Paul Smith East Coast Territory A Sales 1 $15,575
April 2009
Detail Detail Group Footer 2 Detail Group Header 2 Detail Detail Detail Group Footer 2 Detail
Sales 2 $4050 Sales 3 $18256 Totals Territory B Sales 1 $12,750 Sales 2 $16100 Sales 3 $2148 Totals $30998 $23881
To access all of the information for Paul Smith and other agents in this report, define the first line (Paul Smith) as a Page Header and define the last line on this page (not shown in the example) as Page Footer 1. To access information that is on the same hierarchical level as East Coast, define East Coast as a Group Header 1 and the last line on this page that is on the same hierarchical level as East Coast as a Group Footer 1. To access the territory sales information separately from the information defined as Group Header/Footer 1, define Territory A as Group Header 2 and define Totals as Group Footer 2. Note If you fail to mark a Group Header 2 in our example, a Group equal to, or higher than, Group Header 2 that follows Group Header 2 automatically ends that Group Header 2 section. To obtain only the totals for the agents, define Totals as a Detail section. To include the individual sales amounts that make up the Totals, you can mark Sales amounts as Detail sections, too.
April 2009
Section Locators
Although layout sections are convenient for identifying sections that appear at the same row location on every page in a report, there may be instances when the information you want to extract does not appear at the same absolute location on each page in a report. For these cases, you can use section locators to identify sections that contain information you want to query, index, or extract. Report Manager provides two types of section locators, literal and pattern, that let you match text using a literal or pattern mask starting at a specific column location in a document. A literal locator identifies one or more unique characters that appear at a specific column location. For example, to identify a section that has the text Account Numbers at a specific column position on every page in a report, you can define Account Numbers as a literal locator. A pattern locator identifies a numeric or text pattern that appears at a specific column location. For example you can define the longest account number in a document as a pattern locator and have Report Manager find all instances of that pattern at the same column location on each page in the document.
April 2009
Using our same example, refine your section selection by defining a section locator where any line containing a character literal in the same position as the A in Asset is to be considered as a Group Header 1 section. In addition, define a section locator for the literal **TOTAL** in the Footer Header 1. Finally, define a 14 character section locator in the positions identified within the detail section. Report Manager finds all of the lines in the report matching the criteria and highlights the line and assigns the label GH1, GF1 or D.
April 2009
Section Locators
April 2009
The next page of the report looks like this:
April 2009
Section Fields
Report Manager uses the sections and locators you specify to determine where to locate data. Now you can use fields to identify the specific information that you want to extract from these locations. Fields in a section are identified by a column and row location relative to the start of the section. Data that appears within each field can be extracted at a later time for indexing or data mining.
Fields
April 2009
Tip
Fields must be long enough to hold the values you want to query, index, and extract. For example, if you select a 16-digit account number as a field, but some account numbers exceed 16 digits, account numbers that exceed 16 digits are truncated when data is queried, indexed, or extracted.
Layout Tips
When defining a document layout, observe the following guidelines to avoid layout problems. Do not define a pattern locator in one section that matches a pattern in another section. For example, if you define a pattern locator to retrieve nine-digit account numbers from a report, make sure that locator will not also identify other data that matches the same pattern, such as nine-digit social security numbers. Do not overlap definition differences. For example, if you define a pattern locator for 16-digit account numbers and another pattern locator for 12-digit customer ID numbers, the 16-digit pattern locator will also pick up the 12-digit customer ID numbers, because the 12-digit pattern locator is a subset of the 16-digit pattern locator. Do not define a literal and a numeric locator that appear on the same row of a page. When you define a pattern locator, make sure you specify the appropriate locator text. When defining a pattern locator for account numbers, for example, check whether the account numbers all start with a number, or whether some start with an alphabetical character. If your pattern locator is incorrect, your queried, indexed, and extracted data will not be accurate.
April 2009
AFP and Metacode Issues

If you use the Report Manager Desktop to layout an AFP or Metacode report, observe the following additional considerations: Words can become separated by an inconsistent number of spaces. You can specify Strip Spaces= 1 in the Prm_is.ini file to remove leading, trailing, and multiple spaces between groups of characters in a field when data mining or indexing. For more information, see Prm_is.ini File Contents on page 464. The location of locators in a document must not vary or indexing and data mining tasks will fail. For example, when locators and fields in AFP and Metacode reports may appear in different columns from one page of a document to the next, this shifting of locators results in unsuccessful indexing and data mining. Fields might appear in varying rows relative to the first row of the section.
Note
For additional AFP and Metacode information, see the FileNet Report Manager APA Technical Reference Guide.
April 2009
8 Document Layouts Defining a Document Layout
Defining a Document Layout

The following steps describe how to use Report Manager Desktop to define layouts for a document: 1 Define the sections in a document, such as the document header, page header, and group headers. See Defining Sections in a Document on page 216. Identify the characters that can be used as literal or pattern locators. See Defining Section Locators on page 224. Define the fields that can be used to perform queries. See Defining Fields in a Document on page 234. Save the sections, locators, and fields you defined. See Saving a Document Layout on page 242.
2 3 4
Defining Sections in a Document

The following describes how to define the sections in a document. You define document sections once time in a document, during the document set up procedure. Accessing Layout View Define document sections using the Report Manager Desktop layout view. Tip If an individual other than the system administrator will define the document layout, that persons security rights should include function access to layouts. For more information, see Security on page 304.
April 2009
To access the layout view: 1 2 3 From the File menu, select Open Document. The Open Document dialog box displays. Under Folder(s), click the folder that contains the document whose structure you want to define. Under Document(s), click the document whose structure you want to define. If Document(s) does not display the desired document, the document might reside in another folder, the Type list might be set to display only certain types of documents (for example, Statement Documents only), or you might need to specify a wider filing date range in the Open Document dialog box. If the document is an Undefined Document, define or copy a document template for it (see Chapter 5, Working with Document Templates, on page 84). 4 5 Click the OK button. The document displays. On the View menu, click Layout. The document displays in layout view. The following figure shows a document in layout view. AFP and Metacode documents that contain large fonts might not display as expected; for example, words might be spaced far apart.
Tip
Note
April 2009
6 7
On the View menu, verify that a checkmark displays next to Locator Mode. If no checkmark displays, click Layout View. Hold down the left mouse button and drag the pointer vertically across the document area where you want the locator defined, then release the left mouse button. A highlight displays over the selected area and a Section Definition dialog box displays.
April 2009
By default, the section name matches the section type you define. For instance, when you define the first section type in a document, Document Header displays next to Section Name, as in the above example. To specify a different name for the section you are defining, type the name next to Section Name.
April 2009
To specify a different section type, select one of the following types from the Section Type list.
Section Type Description
Document Header Distinct pattern, usually on the first page only. Page Header Group Header 1 Group Header 2 Group Header 3 Group Header 4 Group Header 5 Detail Group Footer 1 Group Footer 2 Group Footer 3 Group Footer 4 Group Footer 5 Page Footer Document Footer Distinct pattern, usually at the top of all pages. Highest level of details in a document (for example, Countries). Second level of details (for example, States). Third level of details (for example, Counties). Fourth level of details (for example, Towns). Fifth level of details (for example, Neighborhoods). Lowest level of details (for example, Addresses). Related to Group Header 1. Related to Group Header 2. Related to Group Header 3. Related to Group Header 4. Related to Group Header 5. Distinct pattern, usually at the bottom of all pages. Distinct pattern, usually on the last page.
When you select a section type, it is automatically removed from the list to prevent it from being used more than once in the same document. 9 Identified By shows the number of lines between the area you defined in step 2 and the top and bottom of the page. You can change these values to expand or reduce the section area.
April 2009
10
Each section type has a default color associated with it. This color displays under Color in the Section Definition dialog box. To apply a different color to the section, click next to Color, click a different color from the Color dialog box or define your own custom color, and click OK. The new color displays under Color.
11
Click OK. The following conventions denote the section you defined on the current page (and automatically display at the same position on all other pages in the document): The section color marks the section you defined. A section abbreviation displays to the left of the section. In our example, DH displays next to the Document Header section we defined. If the section covers two or more vertical lines, a bracket to the right of the section abbreviation shows all of the lines in the section.
April 2009
Brackets Denote the Lines Defined as the Document Header Section Abbreviation (DH denotes Document Header) 12 To define additional sections in the document, repeat steps 10 through 15. Each section you define on the current page also displays at the same location on all other pages in the document.
Note
April 2009
Editing Document Sections To modify a document section, use the following procedures. Note The Report Manager software lets you change any section parameter except the section type. To change the section type, delete the section (see Deleting Document Sections on page 223), then define a new one with the desired section type (see Defining Sections in a Document on page 216). Double-click the section you want to edit. The Section Definition dialog box displays. Change the appropriate section definitions. For more information, see Defining Sections in a Document on page 216. When you finish changing section definitions, click OK.
1 2 3
Deleting Document Sections If you no longer need a document section, use the following procedures to delete it. Double-click the section to display the Section Definition dialog box and click the Delete button. The following message asks whether you are sure you want to delete the section. Confirm at the prompt to delete the section.
April 2009
Defining Section Locators

The Report Manager software identifies document sections positionally, according to the number of lines from the top and bottom of the page. There might be times when the sections in a document do not reside at the same position on each page. In these cases, you can use section locators to identify sections by content, based on literal or pattern locators within the sections. The following section describes literal locators. For information about pattern locators, see Pattern Locators on page 229. Literal Locators A literal locator is a word, date, or symbol such as an underline that the Report Manager software can use to identify a section in a document. To illustrate the use of literal locators, look at page 1 of the document in the following figure. This document has a Group Header 1 (GH1) section called CHARGES. By default, the Report Manager software references this section positionally on the page. Therefore, if CHARGES in Group Header 1 does not appear at the same position on every page in the document, the Report Manager software cannot rely on position to find this information. As an alternative, you can use a literal locator to find the CHARGES location in the Group Header 1 section on every page where it displays. For this case, the double underline below CHARGES is unique to this section on every page in the document and, therefore, makes an ideal literal locator.
April 2009
The following procedure describes how to specify literal locators. As part of this procedure, all five double-underlines in the example above will be identified as a literal locator. 1 With the pointer in a section, hold down the left mouse button and drag the pointer horizontally across the section item you want to specify as a literal locator. In our example, we drag over the five double-underlines in the GH1 section.
April 2009
Release the left mouse button. The Locator Definition dialog box displays.
3 4
Locator Name shows the default name for the locator you are defining. You can change this name, if desired. Match On lets you select either a literal or a pattern locator. In this example, Literal is selected. An example of a pattern match is provided under Pattern Locators on page 229. Locator Text and Report Text show the item you dragged over in step 1. You cannot change the item displayed in these boxes.
Note
April 2009
Location/Size shows the column, row, and width of the area you selected in step 2. If desired, you can increase or decrease the column value. You cannot change the row and width values. Click OK to define the locator. Once a locator is defined, the Report Manager software only identifies sections that contain the locator. The following layout view shows an example where a literal locator has been defined.
April 2009
Literal Locator
To specify additional literal locators, repeat steps 1 through 8.
April 2009
Tip
After defining your locators, page through the document to see the defined locators effects. If regions on other pages are not marked as expected, either the locator is not in the same horizontal position as on other pages or the literal does not match exactly (in which case you should define a pattern that would work better).
Pattern Locators Unlike literal locators, which define a section according to specific characters, pattern locators define a section based on a pattern of alphabetic characters or sequential numbers in a document. The following figure demonstrates the use of pattern locators. The document in this figure contains a list of 10-digit INTERNAL REG numbers, which the company uses for internal purposes. The row that shows the INTERNAL REG number has been defined as a Group Header 3 (GH3) section. Because each INTERNAL REG number is unique, a literal locator cannot be used to identify all the INTERNAL REG numbers in the document. Instead, a pattern locator can be used to identify the unique 10-digit INTERNAL REG numbers.
April 2009
You define pattern locators the same way you do literal locators, by dragging the pointer over the text in a document section. 1 With the pointer in a section, hold down the left mouse button and drag the pointer horizontally across the section item you want to specify as a pattern locator. In our example, we drag over the 10-digit INTERNAL REG number in the GH3 section.
April 2009
Release the left mouse button. A Locator Definition dialog box displays.
The Match On option defaults to Literal. Select Pattern to change the dialog box values as shown.
April 2009
Next to Locator Text, the symbol @ displays for each character or number in your selection and # displays for each digit in your selection. In our example, there are 10 # symbols, one for each digit in the selected INTERNAL REG number. Report Text shows the actual item you dragged over in step 1 (in our example, this is the INTERNAL REG number 9278999334). 4 5 Locator Name shows the default name for the locator you are defining. You can change this name, if desired. Location/Size shows the column, row, and width of the area you selected in step 2. If desired, you can increase or decrease the column value. You cannot change the row and width values. Click OK to define the locator. All instances where the selected pattern displays in the document are marked. In our example, all 10-digit IN-
April 2009
TERNAL REG numbers are identified as pattern locators and the rows in which they display are automatically marked as GH3 sections. 7 To specify additional pattern locators, repeat steps 1 through 6.
April 2009
Editing Locators To modify a locator, use the following procedure. 1 2 Double-click the locator you want to edit. The Locator Definition dialog box displays. Change the appropriate locator definitions. For more information, see Literal Locators on page 224 and Pattern Locators on page 229. When you finish changing locator definitions, click OK.
Deleting Locators If you no longer need a locator, use the following procedure to delete it. 1 2 Double-click the locator to display the Locator Definition dialog box and click the Delete button. At the prompt, click OK to confirm.
Defining Fields in a Document

After you define document sections and section locators, switch to Field Mode and identify each field in the document. Fields let you define indexes, using the procedure described in the next chapter. Indexes let users search for information using the Report Manager Desktops search facility, as described in the FileNet Report Manager Desktop Users Guide. When you define fields, choose those most likely to be queried.
April 2009
Tip
When defining fields, we recommend you choose a superset of the fields you intend to index and data mine. Be sure the document whose sections and section locators you defined displays in the Report Manager Desktop. Then click Field Mode on the View menu. The sections you defined remain displayed, but all locators you defined are no longer displayed. Hold down the left mouse button and drag the pointer horizontally across the field you want to define. The following example shows a number in the CREDIT CARD # column being defined as a field.
April 2009
Sample Field Being Defined
Release the left mouse button. The Field Definition dialog box displays.
April 2009
Name shows the default field name. We recommend you replace this default name with one that is more meaningful. In our example, we change the default name to Credit Card Numbers.
Tip
For simplicity, field names should be consistent among document layouts. For example, if you assign the field name Credit Card Numbers to a field in one document that shows customer credit card numbers, we recommend that you assign the name Credit Card Numbers to the fields in your other documents that also show customer credit card numbers. Next to Description, type an optional field description. In our example, we type Customer credit card numbers.
April 2009
Use the Data Type list to select the type of data contents in the field. The available selections are: Text Integer Amount Date. If you select this option, use the Date Format list to select a date format (for example, year-month-day format). Integer (European) Amount (European)
In our example, we select Integer. 7 To continue a field that is associated with a previous field, but not explicitly defined, click Copy Forward Value to Null Descendants. For more information, see Copy Forward Value to Null Descendants on page 239. From and To show the length of the field based on your selection. If you desire, you can increase or reduce the selected field using these text boxes. The following figure shows our field definition selections for the first field we defined.
April 2009
9 10
Click OK to define the field. To define additional fields, repeat steps 2 through 9.
Copy Forward Value to Null Descendants The Copy Forward Value to Null Descendants option in the Field Definition dialog box copies the field value to succeeding rows of a data extract when the row is a null or blank. Copying continues until the Report Manager software encounters a value other than a null or blank. For example, assume the following values are in a trading report:
Sample Trading Report
Currency USD Deals (in USD):
4,500,000.00
April 2009
1,000,000.00 Currency DEM: 6,000,000.00
In this example: The first two rows 4,500,000.00 and 1,000,000.00 refer to currency in US dollars (USD). The third row 6,000,000.00 refers to Deutsche Marks. The second row does not have Currency USD explicitly defined.
Because the second row does not have Currency USD explicitly defined, the extracted data displays as follows:
Currency Amount
USD DEM
4,500,000.00 1,000,000.00 6,000,000.00
This output might not make it obvious that the value 1,000,000.00 refers to USD. To make it obvious, enable Copy Forward Value to Null Descendants. Then, when the Report Manager software extracts the data, the output displays as follows:
Currency Amount
USD USD DEM
4,500,000.00 1,000,000.00 6,000,000.00
April 2009
There are situations when you do not want to enable Copy Forward Value to Null Descendants. For example, in the following example, if Copy Forward Value to Null Descendants is enabled for the Check #, Debit, or Credit field, a null value in these fields can cause erroneous data extraction. F
ATM Sample Report Description Check # Debit Credit Balance
Deposit Check Withdrawal 105 1,000.00 500.00
3,000.00
3,000.00 2,000.00 1,500.00
Enabling Copy Forward Value to Null Descendants for the Credit field causes the extracted data to display as follows:
ATM Sample Report Description Check # Debit Credit Balance
Deposit Check Withdrawal 105 1,000.00 500.00
3,000.00 3,000.00 3,000.00
3,000.00 2,000.00 1,500.00
In this example, a credit of 3,000.00 carried over from the Deposit row to the Check and Withdrawal rows, which had been blank. As a result, this extraction is reporting an erroneous 3,000.00 credit for the Check and Withdrawal rows.
Editing Document Fields

To modify a document field, use the following procedure.
8 Document Layouts Creating Statement Templates
1 2 3
Double-click the document field you want to edit. The Field Definition dialog box displays. Change the appropriate field definitions. For more information, see Defining Fields in a Document on page 234. When you finish changing document field definitions, click OK.
Deleting Document Fields

If you no longer need a document field, use the following procedure to delete it. 1 2 Double-click the document field to display the Field Definition dialog box and click the Delete button. Confirm to delete the document.
Saving a Document Layout

After you define the sections and fields in a documents layout view, save the layout by clicking Save on the File menu.
Creating Statement Templates

The Statement Administrator lets you create statement templates for processing AFP and Metacode statement documents. Unlike the Report Manager Desktop, which lets you define layouts using a flattext view, the Statement Administrator lets you define a layout using a PDF representation of the AFP or Metacode statement document. With a statement template, only locator and field data can be extracted during statement processing. Report Manager users can retrieve the
8 Document Layouts Creating Statement Templates
PDF version of a document based on a query of the field data. However, further data mining is not possible. For details on working with Statement Templates refer to Creating Statement Templates on page 135.
April 2009
9 Document Form Overlays Graphic Formats
9
9Document Form Overlays
A form overlay is a graphical image that resembles a pre-printed form that is superimposed on line data documents so the documents onscreen resemble a printed form. Line data documents can also be printed or faxed with a form overlay. Note Form overlays apply to line data documents only, and can only be configured after a document template has been attached to a document that has been loaded into Report Manager.
Graphic Formats
Form overlays can be scanned images, or can be developed from scratch using various drawing and graphic software programs, such as Paintbrush, Visio or PaintShop Pro. Tip If your form overlay will contain text, choose a large font size, such as 12-point Terminal, to enhance readability; avoid using italics. Save your completed image as one of the following formats: Windows Bitmap (.BMP extension) JPEG Bitmap (.JPG extension) TIFF Bitmap (.TIF extension) Paintbrush (.PCX extension)
April 2009
9 Document Form Overlays Using a Print File Text as a Guide
Some graphic formats, such as JPG, generate files that occupy less hard disk space than other file formats. Files saved in these formats provide a better response time and occupy less bandwidth on local and wide area networks. These file formats, however, might not support the level of detail provided by other formats, such as TIF or BMP.
Using a Print File Text as a Guide

To ensure that a form overlay is proportionally sized, you may want to draw it directly over the text in the Report Manager document. We recommend using a graphics program that supports multiple layers. This allows you to place your text in the background layer while drawing your form. You can later discard the background layer when you save the overlay.
Importing a Form Overlay

After a form overlay is created, import the overlay using the following procedure. 1 From the Report Manager Desktop, display a document that will be associated with the form display.
April 2009
9 Document Form Overlays Importing a Form Overlay
On the View menu, click Background and choose Import Form Overlay. The Open dialog box appears.
Note
If Import Form Overlay is unavailable, it means you have not assigned a document template to the document. Use the procedure under Using the Open Document Dialog Box on page 92 to assign a document template to the document, then repeat these procedures to import a form overlay for the document. Locate the graphic file you want to use as the overlay, select it and click Open. The selected form overlay displays on the document. The following example shows how a form overlay called statemnt.bmp displays when superimposed over a document.
April 2009
9 Document Form Overlays Matching a Form Overlay with a Document
If you click the View menu and click Background, a checkmark displays next to Form Overlay to show that a form overlay has been applied to the document.
Matching a Form Overlay with a Document

Sometimes a form overlay does not display correctly over the Report Manager document. For example, a form overlay might not be the same size as the Report Manager document, or objects on the form overlay might not appear over the intended areas in the document. Using the Configure Background option in the View menu, you can enlarge or reduce the overlay, or offset it, to achieve the desired results. The Configure Background option also lets you manipulate the overlay by flipping it horizontally or vertically, or inverting the overlay colors.
9 Document Form Overlays Matching a Form Overlay with a Document
With the overlay displayed, choose Background from the View menu, and choose Configure Background. The Configure Form Overlay dialog box displays.
2 3
Under Overlay Size, use the controls to adjust, in pixels, the width and height of the overlay. Under Overlay Offset, use the controls to adjust the overlay distance, in pixels, from the top-left corner off the document (position 0,0). X Direction offsets the overlay horizontally and Y Direction offsets it vertically.
April 2009
9 Document Form Overlays Deleting a Form Overlay
Under Overlay Actions, there are controls for flipping the overlay horizontally and vertically and inverting overlay colors. You can use these controls individually or together. When you finish selecting overlay parameters, click OK. Your selections are applied to the overlay. If the results are not what you desire, repeat this procedure to achieve the desired results.
Deleting a Form Overlay

If you no longer want a form overlay to appear behind a document: From the View menu, click Background and choose Delete Form Overlay. A message will appear to confirm your request.
April 2009
10 Document Indexes The Report Manager Index
10
10Document Indexes
A Report Manager index is a collection of index fields that you define for a document template which allow Report Manager users to locate and extract information by content. Indexes are defined using the Report Manager Desktop or Statement Administrator. After an index is defined for a document template, other documents associated with the template load into the Report Manager system and are automatically indexed. This chapter describes Report Manager document indexes and shows you how to define them.
The Report Manager Index

Index Types
Report Manager Index Service generates two types of indexes. The type of index depends on whether the document is a Report or Statement. Transaction Indexes are applied to entire Report documents, while Statement Indexes are applied to Statement documents and are used to retrieve individual statements. This section primarily discusses Transaction indexes and their tables; Statements Indexes are described in Chapter 7, Statement Indexes, on page 187.
April 2009
Index Structure
A Document Index extracts data from a document based on the fields that were defined in a document layout. While the document layout is primarily used for data mining, its fields serve a dual purpose since an index contains its own set of fields that link to the fields in a document layout. It is possible for more than One index and related index fields to be associated with fields in a document layout.
Index Properties
Each index has several components: Index Name (identifies the index - maximum 55 character string) Index Storage Profile (index retention settings) Index Type (Native, Image Services cross-catalog, or Both) Index Fields (to be associated with document layout fields) Document Template (manages document layout fields) Image Services Document Class (for Image Services cross-cataloging)
Image Services cross-cataloging is described in Chapter 11, CrossCataloging, on page 282. Index properties are discussed below. Index Storage Profile An Index Storage Profile is similar in purpose to a Document Storage Profile. The Index Storage Profile is created via the Report Manager
April 2009
Desktop administration tools and manages retention properties for the index(es) assigned to the profile. The Index Storage Profile controls Transaction and Statement index retention and purging from both the native Report Manager Index tables and the Image Services index database (when cross-cataloging to Image Services is configured). Index Type The Index Type property indicates to which database(s) the index fields will be recorded. This includes the native Report Manager index tables, Image Services index database, or Both. Note You must select the Both option if your site uses both IDM Desktop and Report Manager Desktop for searches.
Index Fields After you create the index, define the fields within that index. Then link the index fields to document layout fields for data extraction. The index field type (text, integer, date, and amount) must match that of the document layout field.
Data Types
Index Service supports the following data types of fields for indexing into both the native Report Manager catalogs and the Image Services catalog. Text - Standard textual data string.
April 2009
Integer - For Integers; Maximum value 2,147,483,647. Commas are optional. Date - Refer to the table below for supported date formats.
Month format Day format Year format Delimiter Order
1 or 2 digits 1 or 2 digits Abbreviated with no period (e.g. JAN)
1 or 2 digits 1 or 2 digits 1 or 2 digits
2 or 4 digits 2 or 4 digits 2 or 4 digits
/,.space or none space
Any Any Except month, day, year Except month, day, year Except month, day, year Not applicable to any ending in day
Abbreviated 1 or 2 digits with period (e.g. JAN.) Full month name (e.g. JANUARY) Abbreviated with period or full month name 1 or 2 digits 1 or 2 digits
2 or 4 digits
space
2 or 4 digits
space
2 or 4 digits
space with comma after day
Amount Floating numbers to two decimal places for currency amounts. Values are interpreted as follows: Any alphabetic character except C, c, D, or d is ignored. For example, $, , are ignored Spaces immediately preceding or following the amount value are ignored
April 2009
10 Document Indexes Native Indexing
A D or d encountered in the value, either leading or trailing, will cause the amount value to be negative A number enclosed in parentheses will be considered a negative value The minus symbol - will be considered a negative value The , character is assumed to be the Thousands delimiter The . character is assumed to be the decimal delimiter
European Integer - The period is assumed to be the Thousands delimiter, rather than the comma. European Amount - The period and the comma are swapped for the Thousands delimiter and the decimal point. Otherwise, this follows the same principles as Amount.
Native Indexing
The Indexing Process
Index Service connects directly to the Report Manager database, which allows for intensive indexing database access without interrupting other system processes. Storage Service inserts a record into the PRMIdxQueue database table for each document indexed upon loading. Each record contains the document ID and the indexing action to be performed. Index Service then periodically checks the contents of PRMIdxQueue; if a record is found, Index Service will index the document and then delete the request when indexing successfully completes. If there are multiple records in the queue, Image Services will process them in a first-in
first-out (FIFO) order. If errors are encountered during indexing, the request is skipped, and an error is generated to the Event Log. You can clear Indexing errors manually using the Traffic Service interface. In addition, errors will be automatically cleared when a new indexing request is processed on the same document.
Cross Cataloging (Indexing to Image Services)

Cross-cataloging refers to the transfer of Report Manager document properties (metadata) or index information to Image Services. By having the document metadata in Image Services, the documents can be accessed and used as if they were stored in Image Services. This includes access by the IDM Desktop and Web Services as well as custom applications built with either of those technologies. For example, in a typical customer services example, you may have scanned images of a new account application, statements and reports that are generated for that account. The customer service representative has all the information at his fingertips to respond to questions from customers. All of this content can be built into a customer self-service portal and many of the calls to customer service representatives could be eliminated. When you enable cross-cataloging for Report Manager, the metadata describing a document is transferred to the Image Services server and stored in the primary Image Services database table, DOCTABA. DOCTABA holds a record for every document referenced by Image Services. After a document is cross-cataloged, users can access Report Manager documents from clients that are connected to the Image Services server.
April 2009
Cross-Catalog Types
There are three types of cross-cataloging used to transfer Report Manager information to a Image Services system. Cross-Catalog by Index This method allows line data index field values to be migrated to Image Services. This allows users who are accessing Report Manager documents from non-Report Manager clients to perform both property and content-based queries. In order to accomplish this, the Report Manager transaction index is associated with an Image Services Document Class and the fields in Report Manager are mapped to the fields of the Image Services Document Class. Cross-Catalog by Statement This method applies to Statements and is configured in the Statement Administrator utility. A Report Manager Statements index values are extracted during loading by Storage Service. The extracted values are appended to the end of the document in the Table of Contents segment. During the indexing process the document properties and index field values from the Table of Contents are then inserted into the native Report Manager database and the Image Services DOCTABA database.
April 2009
10 Document Indexes Managing Document Indexes
Cross-Catalog by Report This method transfers only document system properties to an Image Services server. So, only document property-based queries are available through non-Report Manager clients. These include: document properties date entered (F_EntryDate) document type (F_DocType the value is always 5 for Report Manager documents) location (F_DocLocation) document format (F_DocFormat).
Unlike Index or Statement cross-catalog actions, which may populate several rows in DOCTABA, the Report Manager server inserts the document properties into a single row in DOCTABA. Additionally, you can specify Index fileds like Catalog by Document Title, Field Value and Folder Name. For more details on these options, refer to Cross-Cataloging by Statement on page 294.
Managing Document Indexes

From the Administration menu, click Transaction Indexes. The List of Indexes dialog box appears. This dialog box shows all the Transaction indexes you have defined. Initially, no indexes are defined, as shown in the following figure.
April 2009
10 Document Indexes Avoiding Multiple Indexing

Do not define multiple indexes when a single index will suffice. Multiple indexes increases the size of the database unnecessarily and can affect performance. For example, assume that a bank has a headquarters location and five branch offices and assume that each branch office indexes the customer names and account balances for each days transactions. In addition, the headquarters location generates a daily master index for all customer transactions at the five branches. This multiple indexing results in the same data being indexed by the headquarters location and the five branch offices. A better alternative is to have a master index generated at the headquarters location only, or to have the
April 2009
10 Document Indexes Adding a New Index
branch offices index information different from that which will be indexed by the headquarters location.
Adding a New Index

On the List of Document Indexes dialog box, click Add. The New Index Properties dialog box appears.
April 2009
Use the New Index Properties Dialog box to define new indexes or to edit existing ones for line data and reports.
April 2009
Completing the General Tab The General tab lets you name the index you are creating, enable or disable cross-cataloging, and specify the fields and field types associated with the index. Naming the Index In the Index Name field, type a name for the index. The name can contain up to 17 characters, including spaces. In our example, we will define an index called ACCNUM. Enabling or Disabling the Catalog Enable Catalog lets you enable or disable cross-cataloging between Report Manager and the IDM Desktop. For Enable Catalog, select one of the following options: Enable Native Catalog Only - this is the default setting. This option stores indexing information in the Report Manager database only. Select this option to limit index queries to Report Manager Desktop users. Enable IDMIS Catalog Only - stores indexing information on Image Services only. Select this option to limit index queries to IDM Desktop users. Enable Both - stores indexing information both in the Report Manager database and in Image Services. Select this option to permit index queries to be performed by Report Manager Desktop users and IDM Desktop users.
April 2009
Selecting the Image Services Doc Class for Cross-Cataloging If you clicked Enable IDMIS or Enable Both earlier, select the document class from the IDMIS Doc Class list. IDMIS document class is case-sensitive. When you specify a document class in the IDMIS Doc Class text box, adhere to the case specified for that document class in Image Services. The Browse button allows you to select from a list of Image Services Doc Classes.
Transaction index fields must be identical in name, case, and type to the IDMIS document class fields. This means that the index and document class fields must have identical names, upper-case and lower-case characters, and like (or compatible) types between Report Manager and Image Services. For example, integer and amount types in Report Manager map to
April 2009
numeric in Image Services, text in Report Manager maps to string type in Image Services, and date in Report Manager maps to date in Image Services). Document classes can be supersets of index fields, but not subsets. For example, if you define index fields called Name and Address, the Image Services document class must also have Name and Address defined in the document class, with identical case and compatible type for both. If only Name is defined, the index will not be cross-cataloged. However, if the document class contains Name, Address, and City, this superset includes the Name and Address index fields and, as a result will be successfully cross-cataloged.
Note
Chose index fields carefully. You can remove index fields during the creation of the Transaction index, but you cannot remove index fields after the Transaction index has been saved. See Index Field Requirements on page 284.
April 2009
Adding Index Fields 1 In the General tab of the Index Properties dialog box, click the Add button. The Field Properties dialog box displays.
In the Name text box you can do one of the following: Click to select from the list of Image Services fields. The following dialog box appears:
April 2009
If you select a document class and click OK, the Type and Size fields will be pre-selected. You can also type a name, but this name should be the same as the document field to which it will be linked.
Note
If you type the name of an index field already in use, a message displays. Click OK and type a unique name for the index field.
April 2009
In the Type list, select the data type of the field: Text, Integer, Amount, or Date as follows.
In the Size text box, type the number of text characters allocated for the field. This value can be from 1 to 255, and should be at least as large as the actual fields that it relates to in one or more documents. This field is not available for integer, amount, and date types. 3 To create an index key on this field in the native Report Manager index table of the SQL database, select SQL Index Field (Native Mode Only). This feature provides for faster searches on this field. Adding SQL indexes slows the Image Services indexing process. Therefore, care should be taken when specifying SQL indexes. To create a retrieval key for Indexes on the Image Services server refer to the Image Services System Administrators Handbook. Note While you may add the SQL Index later, you cannot remove it once you have saved the Transaction Index.
Tip
April 2009
The field you added displays under the General tab. In our example, the General tab shows that a 20-character Text data type has been defined. If you checked SQL Index Field, the SQL Index checkbox is selected. Two asterisks (**) will display next to the index field name in the Index Field column if the Image Services field is a required field. Note Index Services will fail if your report has null data for an Image Services required Index.
Completing the Retention Tab The Retention tab lets you associate a storage profile with the index to determine how the index is managed over time. Select a Storage Profile from the list. For more information on Storage Profiles, see Configuring Document Storage Profiles on page 112.
April 2009
April 2009
Completing the Filter Tab The Filter tab lets you specify the frequency that Report Manager writes information to the database.
April 2009
The options on the filter tab allow you to control how information is entered into and retrieved from the database. A carefully selected filter configuration setting can keep index performance high and reduce the number of records that need to be stored, while a poor configuration setting can significantly slow user index searches and add unnecessary records to your database. Every Occurrence Every Occurrence causes Report Manager to look through every document associated with this index, extract the data in every occurrence of the field on every page, and place the data into the Report Manager database. Caution The Every Occurrence filter option can negatively impact system performance. First Occurrence on Every n Pages First Occurrence on Every n Pages tells Report Manager to extract data from the first occurrence of a field in a document, skip n pages, search for and extract data from the next occurrence of the field, skip n pages, and so on until Report Manager reaches the end of the document. This selection is especially useful for report data that is sorted in ascending or descending order, and results in reduced disk usage and greater indexing performance. For example, a certain report has an occurrence of the account number field on every page of the document. In this example, a document has 5 pages. Using the Every Occurrence on Every n Pages option you may want to pick up the account number information just once for the entire report.
10 Document Indexes Linking the Index to Document Templates
To index the first occurrence of the account number field on every fifth page of the report, type 5 in the text box. In this scenario, if Report Manager finds the first occurrence on page 1 of the document, it inserts the data into the database, skips 5 pages, and searches for the first occurrence on page 6. If it finds the next occurrence on page 6, it inserts the data into the database and skips 5 pages to page 11. In a slight variation of the example used above, if Report Manager does not find the first occurrence until page 7, it inserts the data into the database and skips 5 pages to page 12. This sequence continues until Report Manager reaches the end of the document. Similarly, if Report Manager finds the first occurrence on page 3 of the report, it inserts the data into the database and skips 5 pages to page 8. Complete the Index Properties Dialog Box After you complete the General, Retention and Filter tabs in the Index Properties dialog box, click OK. Finish Adding the New Index If you are adding a new index, click Documents on the List of Indexes dialog box. Continue with Linking the Index to Document Templates on page 271
Linking the Index to Document Templates

To link the index to one or more document templates. 1 In the List of Document Indexes dialog box, click the index to which you want to link a document. In our example, we click the index named ACCNUM.
April 2009
April 2009
Click the Link... button. The Documents in Index dialog box displays.
Click the Add button. The Select Document Template dialog box displays.
April 2009
Under Folder(s), click the folder that contains the document template(s) you want to link to the index. Then click one or more documents under Document(s). In our example, we click Linx in the TXT folder.
April 2009
Click OK. The Index-Document Properties dialog box displays. In this dialog box: The Index Field column shows the fields that have been added to the index. These are the index fields you defined under Adding Index Fields on page 264. In our example, we have only one index field: acctnum. The Document Field column shows the document field linked to each index field. Initially, <none> displays because the index field(s) is not associated with a document field. You link the index field to a document field in the next step.
April 2009
Linking the Index and Document Fields

Link the index field Company to a document field called CardNo. 1 In the Index-Document Properties dialog box, click the index field you want to link to a document field. In our example, we click the index field Conpany. 2 Click Edit. The Index/Document Field Relation dialog box displays.
April 2009
Note
Only document fields that are of a compatible type are displayed. In the Index/Document Field Relation dialog box: Index Field shows the index field to be linked. In our example, the index field to be linked is Company. Document Fields shows the document fields that match the data type (for example, text, integer, amount, or date) of the index field being linked. You defined these names when you used Field Mode to identify each field in the document (see Defining Fields in a Document on page 234).
In our example, there are four document fields that match ACCNUM: Account Number, Currency, Date, and Statement Number. 3 4 Select a document field. In our example, we select Account Number. Click OK. The Index-Document Properties dialog box displays, with the index field and the selected document field linked to it. In our example, the index field Company is linked to the document field CardNo.
April 2009
Note
If you decide to link a different document field to the index field, click Edit and repeat steps 3 and 4. To link additional index fields to document fields, repeat steps 1 through 4. Click OK to save the index definition. A message asks whether you want to start the indexing of existing documents associated with the index. Click OK to start indexing. The Documents in Index dialog box displays, with the name of the folder and document that correspond to the index shown.
5 6
April 2009
In our example, the index called ACCNUM is linked to the document Linx in the TXT folder. Note You can have one or more documents associated with an index. Multiple indexes linked to a single document cause the document to be processed multiple times during indexing. This increases the time required to process other documents, impacting indexing throughput and system performance.
April 2009
10 Document Indexes Modifying or Removing an Existing Index
Modifying or Removing an Existing Index

1 From the Administration menu, click Transaction Indexes. The List of Indexes dialog box appears. This dialog box shows all the Transaction indexes you have defined. Select the index you want to modify or remove.
April 2009
10 Document Indexes Modifying or Removing an Existing Index
Do one of the following: a To modify the index, click Edit.... The Edit Index Properties dialog box appears. See Adding a New Index on page 259 for information on filling out the Index Properties. After you complete the General, Retention and Filter tabs in the Index Properties dialog box, click OK. You will see a reinitiate message. Click OK. b To remove the index, click Remove and confirm.
April 2009
11 Cross-Cataloging Overview
11
11Cross-Cataloging
This chapter describes the process of cross-cataloging Report Manager data to an Image Services server. When you enable cross-cataloging for a Report Manager document stored on the Report Manager server, the index data describing the document is transferred to the Image Services server and stored in the primary Image Services database table, doctaba. Doctaba holds a record for every document referenced to Image Services. Cross-cataloging enables IDM Desktop and Web Services, including Open Client, to search the Image Services repository for reports and statements stored on the Report Manager server.
Overview
Report Manager Index data can be maintained in three modes: Native Only - Stored in the Report Manager database only IDM Only - Stored in Image Services only Both - Stored in both the Report Manager database and in the Image Services Database
Cross-cataloging transfers Report Manager index data to the Image Services database (doctaba). Report Manager document index information stored on Image Services allows users with proper security rights to access Report Manager documents from the Web and Windows-based clients.
April 2009
Note
Only the index data is transferred. The physical document still resides on the Report Manager server. Cross-cataloging is NOT the same as Rollover. The following diagram provides an overview of the cross-cataloging document query and retrieval process for web clients.
Web Services Server
Caution
Web Client
IDM Desktop

The solid red arrows are the Query steps The green hashed arrows are the Retrieval steps
April 2009
For full details on each process step, see Cross-cataloging with Image Services on page 29. There are three ways that you can cross-catalog Report Manager documents: Cross-cataloging by Report Cross-cataloging by Transaction Index Cross-cataloging by Statement
Each of these are described in the section Cross-Cataloging Types on page 287. An important cross-cataloging consideration involves the relationship between the Report Manager Index fields and Image Services indexes.
Index Field Requirements

For a Report Manager document to successfully cross-catalog to Image Services: Report Manager index field names must match Image Services index names. Names are case-sensitive. Report Manager index field data types must match Image Services index data types. An Image Services index must be large enough to accommodate the Report Manager index field contents. If the Image Services index field is marked as required, Report Manager must provide data for cross-cataloging.
April 2009
Note
Although all Report Manager index fields must have a corresponding Image Services index, the Image Services document class can contain indexes that do not exist on the Report Manager server. If the data type does not match, an error will be generated in the Windows Application log on the Report Manager Server. Similarly, if the Report Manager index field does not have a corresponding Image Services index, an error will be generated. In either case, the file will be skipped and flagged for errors.
Report Manager Index Field Data Type Image Services Index Data Type
Text Integer Amount Date
String Numeric Numeric Date
April 2009
The diagram below illustrates the Report Manager index to Image Services document class mappings. Report Manager
Transaction Index:GenLedMaster AcctName AcctNum AcctDate AcctBal BalLastMo
Image Services
DocClass:GenLedMaster AcctName AcctNum AcctDate AcctBal BalLastMo AcctId
Transaction Index:Statements AcctName AcctNum
DocClass:Statements AcctName AcctNum SSN
April 2009
11 Cross-Cataloging Cross-Cataloging Types
Cross-Cataloging Types
There are three types of cross-cataloging mechanisms that are used to transfer Report Manager information to Image Services. These are: Cross-catalog by Report Cross-catalog by Transaction Index Cross-catalog by Statement
Cross-cataloging by Report can be combined with cross-cataloging by Transaction index or cross-cataloging by Statement. However, crosscataloging by Transaction index and cross-cataloging by Statement cannot be configured on the same print stream.
April 2009
Image Services document classes provide specific cross-cataloging properties for Report Manager documents.
Report IDMDT
Transaction Index
Image Services
Statements
Web
Cross-Cataloging by Report
Cross-cataloging by Report transfers the Report Manager document properties to an Image Services server. This method does not transfer any user-defined index fields to the Image Services server, only system properties such as document identifier, document location, etc. For this reason, queries based on report content values are not possible. In cross-cataloging by Report, each report is assigned a single document identifier.
April 2009
Cross-cataloging by Report can be done using any of the three available options: By Document Title: to search for Report Manager documents using the DocTemplate name. Use the Catalog by Document Title option to indicate the document to be retrieved from the Report Manager Server through Image Services server. By Fixed Value: to search for Report Manager documents using a fixed value. For example, Assign a DocTemplate; DocClass - RPTMGR and set the Fixed value to MyNewDocs to indicate the report to be retrieved from the Image Services server. By Folder Name: to search for Report Manager documents using the folder name. For example, if the document is in a folder \docs\2005\March, use the IDM Find Folder property to retrieve all documents within that folder - \docs\2005\March.
April 2009
In the example below, cross-cataloging by Report extracts system properties from transaction listings and monthly statements and stores them in the Image Services database.
T ra n s a c tio n L is tin g
Im a ge S e rvic e s
(D o c T a b A )
M o n th ly S ta te m e n ts
Need graphic here.
00 0 10 00 1 00 0 10 00 2
R M :D o c N o 8 6:P ag e1 R M :D o c N o 8 7:P a g e 1
S ys te m P ro p e rtie s O n ly
A Report Manager report is assigned to an Image Services class through the Document Template properties dialog. Unlike Transaction index or Statement cross-cataloging actions, which may populate several rows in doctaba, the Report Manager server inserts the document properties into a single row in doctaba. This provides for a one-to-one mapping between Report Manager documents and Image Services documents.
April 2009
Cross-cataloging by Report can be used with all Report Manager documents. This includes print streams loaded as reports or statements.
April 2009
Cross-cataloging by Transaction Indexes

Cross-cataloging by Transaction Index transfers system properties as well as user-defined index fields to an Image Services server. This allows users to perform both system property and content-based queries. Cross-cataloging by Transaction Index only transfers filtered indexes if Index Filtering is enabled in your layout. For additional information on Index Filtering, see Completing the Filter Tab on page 269. To control database growth, you should consider indexing every nth occurrence of an index field. In the illustration below, cross-cataloging by Transaction Index extracts system properties from transaction listings and stores them in the Image Services database.
Im age Services (DOCTABA)
00010003 00010004 ... 00010098 00010099 00010100
R M:DocNo87:Page1 R M:DocNo87:Page2 .... R M:DocNo87:Page2 R M:DocNo87:Page3 R M:DocNo87:Page3
G 303293233 G 969545945 .... G 701202391 G 303293233 G 701202391
R obert Redford T om C ruse .... Bette Midler R obert Redford Bette Midler
Buy 100 FILE at $23 Payroll Auto Contribution: $123,323.00 .... Interest on Money Market: $0.07 Sell 100 FILE at $45 G rowth O ppertunities
System Properties
User Defined Index Fields
Cross-cataloging by Transaction Index is used for exposing the details of Report Manager reports as documents in Image Services. This provides for a one-to-many relationship between Report Manager documents and Image Services documents.
April 2009
For cross-cataloging by Transaction Index, there is a single document id for each Report Manager transaction index entry in doctaba.
Cross-cataloging by Transaction Index can be used for all Report Manager print streams that are loaded as reports. This includes ASCII and APA print streams.
April 2009
Cross-Cataloging by Statement
Cross-cataloging by Statement, like cross-cataloging by Transaction Index, refers to transferring both system properties and user-defined index values of a Report Manager document to Image Services. However, this method applies to APA Statements rather than line mode data. Recall that APA documents are defined either as reports or statements via the Statement Administrator utility. Cross-cataloging by Statement enables IDM and Web server clients to view individual statements within a larger APA document. For example, if a customer service representative needs to find consumer account information that is located within a document that contains 20,000 separate billing statements, a user can retrieve a single statement that pertains to a specific customer. Note When defining a Statement, you first define document classes and indexes on Image Services, and then you create the document template by using the Statement Administrator. As a final step you load the documents. Report Manager statement index values are extracted during loading by Storage Service, according to the Statement Templates definition. This extraction method results in better indexing performance than the run-time extraction method used by cross-cataloging by Transaction Index. The extracted values are appended to the end of the document in the Table of Contents segment. The document properties and field values from the Table of Contents are then inserted into doctaba. When Index Service processes the document, it is important that field names defined in the statement template match the indexes assigned to the Image Services document class. For more information, see Index Field Requirements on page 284. The administrator uses
the Statement Administrator to assign an Image Services document class and index fields to the statement template. The Image Services document class must contain index fields identical (one-to-one relationship) to those defined within the Statement Template.
April 2009
Cross-cataloging by Statement apples to APA print streams loaded as Statements only.
April 2009
11 Cross-Cataloging Cross-Cataloging Effects on Image Services
Cross-Cataloging Effects on Image Services

The primary Image Services Index database table is doctaba. It contains one or more records for each document and image stored in Image Services, including: Standard System Properties Unique document ID (F_DOCNUMBER) Document class (F_DOCCLASSNUMBER) Date entered (F_ENTRYDATE) Document Type (F_DOCTYPE) Always 5 for Report Manager documents Location (F_DOCLOCATION)
Report Manager cross-catalog values By Report No Index Fields (Property based report) By Index User-defined Indexes Image Services user-defined properties
F_doclocation values The values in the f_doclocation property string is as follows:

Name ID Version RMServerName RMDocId Description The value that contains FileNETPRM. Indicates that the document is a Report Manager document. The version number. The name of the Report Manager server. The Report Manager ID (ID value in the PRMDocument table).
April 2009
Name TotalPages StartViewPage NumViewPages IdxPageNumber IdxLineNumber
Description The total number of pages in the Report Manager document. The page number that indicates the first page of a statement to be viewed by an end user. The total number of viewable pages in the Report Manager statement. The page number of the corresponding transaction index field. The line number in the page that contains the index.
F_doclocation examples: Cross-cataloging by Index F_location=FileNETPRM:0:OPAL:24:6:1:6:2:2 Indicates: Report Manager DocID=24 Total number of pages in document=6 Viewable pages are from page 1, with 6 total viewable pages Index value resides on Line 2 of Page 2
Cross-cataloging by Statement F_location=FileNETPRM:0:OPAL:25:103:31:2:0:0 Indicates: April 2009
Report Manager DocID=25 Total number of pages in document=103

Viewable pages are from page 31 for 2 total viewable pages for the statement Index value resides on Line 2 of Page 2
Cross-cataloging by Report F_location=FileNETPRM:0:OPAL:18:103:1:103:0:0 Indicates: Report Manager DocID=18 Total number of pages in document=103 Viewable pages are from page 1 for 103 total viewable pages (entire report is viewable)
The following sections provide examples of the impact on doctaba for each type of cross-catalog.
Effects of Cross-cataloging by Report

A document that is cross-cataloged by report populates a single row of data in the doctaba database. This data includes the standard properties for all documents residing on Image Services, including image documents. Recall that documents that are cross-cataloged by Report cannot be searched for content (since there are no index fields extracted) and are thus considered property-based reports.
April 2009
Effects of Cross-Cataloging by Transaction Index or by Statement

Documents that are cross-cataloged by Index or cross-cataloged by Statement populate multiple rows of data in the doctaba database, depending on the number of fields extracted from the Report Manager documents. These documents are indexed for content-based searches, and the resulting entries in doctaba contain data that relates to Report Manager fields, as well as Image Services properties.
Additional Considerations
The following applies to all three methods of cross-cataloging to Image Services. When a document is deleted (Document Delete or Index Purge), its record is removed from the doctaba table after Index Services has been executed. When documents are re-indexed to Image Services, the original Document ID is deleted, and a new ID is generated by the Image Services scalar_numbers table. The original Document ID cannot be reclaimed. Field values from a single Report Manager document can populate multiple rows in the doctaba table. As a result, administrators must take into consideration the amount of available space in the database and the number of Images Services doc IDs available. Overpopulating the database affects both space and performance.
Note
The current release of Report Manager supports IS Doc IDs greater than 2 Billion and upto 4 Billion.
April 2009
11 Cross-Cataloging Indexer Queue Entries
Indexer Queue Entries

Indexing cross-cataloged documents involves two steps: 1 2 An index queue entry is generated by Storage Services when appropriate. Each entry in the Indexer Queue is processed by Index Service asynchronously. The Indexer Queue is managed through Traffic Service. When a request is initiated, it must pass through Traffic Service. Index Service processes the request on a first-in, first-out (FIFO) basis.The indexer Queues request may be for native indexing, cross-cataloging or both.
Cross-Cataloging Events
There are three events that trigger cross-cataloging. Automatic cataloging during loading. Manual cataloging or de-cataloging of existing documents. Automatic de-cataloging based on the Index Storage Profile settings.
For existing Report Manager documents that have not previously been cross-cataloged, users have the option to apply the cross-cataloging setting to catalog them. Moreover, documents may be automatically de-cataloged based on retention settings specified in the Index Storage Profile.
April 2009
Loading The cross-cataloging events that are initiated during loading are first processed by Storage Service and then by Index Service. Administration of Existing Documents The cross-cataloging events that are initiated during the administration of existing documents are handled through the Report Manager Desktop and then by Index Services. Cross-cataloging by Statement De-Cataloging by Index Storage Profile Retention settings in the Index Storage Profile are managed by Storage Services which creates entries in the Indexer Queue.
April 2009
Indexer Queue Relationships

Manual cataloging or de-cataloging will generate Indexer Queue entries.
When loading, Storage Services inserts an entry into the Indexer Queue for documents that require indexing.
Traffic Services
Traffic Services monitors the Indexer Queue, assigns work to Indexing Services and tracks indexing errors.
Storage Services
Storage Services is responsible for Automatic De-cataloging via the Index Profiles.
Indexer Queue
RPC
Index Service
GVI_<sample>_<year>_<month> (monthly index tables)
PRMCatalogedDocs
Doctaba
April 2009
12 Security Setting Up Security
12
12Security
This chapter describes to use the Report Manager security feature to establish rights as well as folder and document relationships for groups and users.
Setting Up Security
To set up Report Manager security, you need to use Windows and/or Image Services security tools in conjunction with Report Manager security tools to define the privileges of Report Manager users. The following topics describe how to set up Report Manager security. IDM Integrated Security: The user ID defined in IDM must match the Report Manager login name or the single logon access configuration in the Report Manager server. See Setting Up Security on page 304. Windows: Define Windows users. Report Manager: Set up groups. See Working with Groups on page 311. Report Manager: Set up users. See Working with Users on page 319. Report Manager: Set up superusers. See Working with Superusers on page 332.
April 2009
12 Security IDM Integrated Security
IDM Integrated Security

Report Manager security relies on IDM authentication method. A user can be configured as an IDM Thick or Thin client. This allows access to Report Manager documents as long as the user exists in the Report Manager database as a single-user logon such as IDM User Group. Users can also be configured with a generic user ID that has full IDM access, as is the case with SysAdmin. Note You must create the User Group or generic userid as a local user on the Report Manager server first. In IDM, a users security settings override whatever security has been defined for the same user within Report Manager.
Single Logon Account for Multiple IDM Users

To set up a single logon account for multiple IDM users 1 2 Click the IDM Users button to display the IDM Users dialog box. Select a pre-existing Report Manager user account as the single-user logon account for all IDM access. If you delete this Report Manager user account, a message displays to tell you that this account is used to support IDM users and lets you cancel the operation. If you do delete this account then the next time that an IDM client connects to the Report Manager server, it finds that there is no single-user account selected for logon and uses the IDM logon name. If that logon name is not a valid Report Manager user, the access fails.
April 2009
12 Security Report Manager Security
Report Manager Security

Report Manager Desktop access is controlled at the network level. For a Report Manager Desktop user to successfully log on to the Report Manager server, two accounts must exist: Report Manager Logon Account Windows User Account
Report Manager Security Hierarchy

The following hierarchy show the levels and priorities for determining security rights: 1 2 3 4 User Document Rights Group Document Rights User Folder Rights Group Folder Rights In this hierarchy, user document rights precede group document rights, and user folder rights precede group folder rights. You many want to note that Report Manager folder security is now enhanced to support 32-bit folder numbers. The following flowchart shows how Report Manager determines whether to grant or deny access to users and groups.
April 2009
Has the user been denied access to the document? No Has the user been granted access to the document? No Has the group been denied access to the document? No Has the group been granted access to the document? No Has the user been denied access to the folder? No Has the user been granted access to the folder? No Has the group been denied access to the folder? No Has the group been granted access to the folder? No Deny access to the document.
Yes
Deny access to the document.
Yes
Grant access to the document.
Yes
Yes
Yes
Yes
Yes
Yes
April 2009
As the flowchart shows, when a user requests a document: 1 Report Manager determines whether the user has been denied or granted permission to the document. First, Report Manager determines whether a user is denied access to the document. If not, Report Manager determines whether the user is granted access. In this way, the deny permission has priority over the grant permission. If neither of the conditions in step 1 is met, Report Manager determines whether the group to which the user belongs is denied or granted access to the document. If neither of these conditions is met, Report Manager determines whether the user is denied or granted access to the folder containing the requested document. If neither of these conditions is met, Report Manager determines whether the group to which the user belongs is denied or granted access to the folder containing the requested document. If neither of these conditions is met, Report Manager denies the user access to the requested document. Users that have been denied access to documents will not be able to see them in the Open Document dialog box.
Note
April 2009
Security Hierarchy Example

The following example illustrates how Report Manager enforces grant and deny permissions. Assume that the following two groups have been set up: Group 1 grants access to the companys Accounts Payable folder. Group 2 denies access to the companys Accounts Payable folder.
If a user named Alana belongs to both Group 1 and Group 2, she is denied access to the Accounts Payable folder, because a denial takes priority over a grant. However, if an administrator explicitly grants Alana access rights to the Accounts Payable folder under her user name, Alana can access the folder, because a grant defined for a user takes priority over a deny granted for a group.
Setting Up Report Manager Security

You define Report Manager security by adding users, groups, and superusers to the Security - User List dialog box. 1 From the Administration menu of the Report Manager desktop, click Security. The Security - User List dialog box displays. This dialog box displays all the Report Manager users, groups, and superusers that have been defined. Initially, only Report Manager Administrator displays.
April 2009
Use the Add button to add: Groups see Adding Groups to Report Manager Security on page 312. Users see Adding Users to Report Manager Security on page 319. Superusers see Adding Superusers to Report Manager Security on page 333.
Use the Remove button to delete:
April 2009
Groups see Removing Groups from Report Manager Security on page 318. Users see Removing Users from Report Manager Security on page 331. Superusers see Removing Superusers from Report Manager Security on page 336.
Use the Properties button to view and modify properties for: Groups see Viewing and Modifying Group Properties on page 317. Users see Viewing and Modifying User Properties on page 330. Superusers see Viewing and Modifying Superuser Properties on page 335.
Working with Groups

Frequently, users within an organization require the same security properties. For example, the users in the Marketing department might share the same security properties, while the users in the Human Resources department might share a different set of security properties. To simplify this task, Report Manager lets you define security groups for users who require the same security requirements. When you define security groups, you can select the folder(s) and document(s) that you want the group to be able to access.
April 2009
Note
You can grant group access to folders and documents, while denying the same folders and documents to individual users. Similarly, you can deny group access to folders and documents, while providing individual users with access to the same folders and documents. For more information on users, groups and supergroups, see Report Manager Security Hierarchy on page 306.
Adding Groups to Report Manager Security The following sections describe how to add groups to Report Manager security. When you add groups to Report Manager security you: Specify the user type as group and assign a group name. Select the documents and folders that the group can and cannot access.
Defining User Type and Group Name The first step in defining Report Manager security for a group is specifying the user type and group name. 1 From the Security - User List dialog box, click the Add button. The User/Group Properties dialog box displays.
April 2009
Next to User Type, select Group. The lists in the Function Access area disappear and the options in the User Stamps area become unavailable, because these options are not applicable to groups.
April 2009
Next to User Name, type a name for the group you are adding. For example, if you are defining the security properties for the employees in the Marketing department, you might name the group Marketing. This is the group name that displays in the User/Group list in the Security User List dialog box.
April 2009
Granting and Denying Document Access After you specify the user type and group name, you specify the folders and documents that this group can and cannot access. 4 From the User/Group Properties dialog box, click Document Access. The Security - Document Access dialog box displays.
The Folder(s) list on the left shows the folder hierarchy of the Report Manager input directory. When you double-click a folder in this column, the documents in that folder display under the Document(s). The Document(s) list on the right refers to Document Templates. Denying or granting access to a document template denies or grants
April 2009
access to all documents attached to that document template for all dates. 5 By default, group access is denied to all folders. To make a folder available to this group, click the folder under Folder(s) and select Granted under Folder: Default Document Access. By default, a group is denied access to all documents in a folder. To make documents available to the group, click the document(s) under Document(s) and select Granted under Document Access. Click OK to exit the Security - Document Access dialog box. You can select multiple documents by holding down the Shift key while selecting each file. After you define the properties for the group, click OK to exit the User/ Group Properties dialog box. The Security - User List dialog box appears, with the name of the group you added in a box (the box is only temporary). Groups appear as double-headed icons. In the following example, the Security - User List dialog box shows the group named Marketing, which we added. Note The group, user, and superuser names under User/Group List display in alphabetical order.
Tip
April 2009
Viewing and Modifying Group Properties As your group requirements change, you might need to change the security properties for your groups. To view or change group properties, use the following procedure. 1 2 From the Security - User List dialog box, under User/Group List, select the group whose properties you want to view or change. Click Properties. The User/Group Properties dialog box displays, with the properties of the selected group.
April 2009
3 4
Change the group properties as necessary. For more information, see Adding Groups to Report Manager Security on page 312. Click OK.
Removing Groups from Report Manager Security To remove groups from Report Manager security, use the following procedure. Note 1 2 You can only delete groups that do not have any users. From the Security - User List dialog box, under User/Group List, select the group you want to delete from Report Manager security. Click Remove. A Verify User/Group Deletion box similar to the following displays, with the name of the group you selected (Marketing, in the following example).
Click OK.
April 2009
Working with Users

The following sections describe how to add, modify properties, and remove users. Adding Users to Report Manager Security The following sections describe how to add users to Report Manager security. When you add users to Report Manager security you: Specify the user type as user and assign a user name. Define the document and administration permissions they will have. Specify a default or personalized user stamp. Select the documents and folders that they can and cannot access. Make them members of one or more groups.
Defining User Type, Login Name, and User Name The first step in defining Report Manager security for a user is specifying the user type, login name, and user name for the user. 1 From the Security - User List dialog box, click the Add button. The User/Group Properties dialog box displays.
April 2009
2 3
By default, User Type is User. Accept this default setting. Next to Login Name, type the name this user uses to log in to Report Manager. The login name you type displays in upper-case characters in this dialog box. The login name also displays as the user name in the Report Manager Desktop Logon dialog box.
April 2009
Next to User Name, type the complete name of the user you are adding. The user name can be up to 60 characters long. This is the user name that displays in the User/Group list in the Security - User List dialog box.
Defining Report Manager Function Access After you specify the user type, login name, and user name, you define the function access you want to grant the user. You define this information in the Function Access area of the User/Group Properties dialog box. The Function Access area has two columns. Document Access The column on the left lets you define a users ability to view and/or change the following document functions: Comments Layouts Database views Overlays Administrative Functions The column on the right lets you define a users ability to view and/or change the following administrative functions: Folders Templates Security maintenance
April 2009
Index maintenance Document management Folder management Template management By default, the Documents and Administration lists are set to Full Access. This means a user can view and change the document and administrator settings shown in the Function Access area. If you do not want to grant such extensive permissions to the user, do the following: 1 2 Next to Documents, select Secured Access. The lists under Document become available and are set to a default of Modify/View. Choose the appropriate document rights for the user by selecting one of the following options from the lists below Documents: 3 4 None user has no access. Modify/View user has complete access. View Only user has viewing access only.
Next to Administration, select Secured Access. The Administration list becomes available and are set to a default of None. Choose the appropriate administrator rights for the user: None user has no access. Modify/View user has complete access.
April 2009
View Only user has viewing access only.
Selecting a User Stamp A user stamp is the stamp that a user can apply to documents. Report Manager provides a default user stamp that users can employ. If you prefer, you can assign a personalized image that has already been created. This image can be in one of the following formats: Windows Bitmap (*.bmp) JPEG File Interchange Format (*.jpg) PC Paintbrush (*.pcx) Tagged Image File Format (*.tif)
To specify a personalized user stamp for the user, use the following procedure. 1 Under User Stamps, click Use Personalized. The Open dialog box displays.
April 2009
2 3
Locate the image of the personalized user stamp. When you find the image, double-click it. The User/Group Properties dialog box redisplays, with the name of the personalized user stamp displayed to the left of the Document Access button. In the following example, nov1.bmp is the personalized user stamp assigned to the user Alana Shuster.
April 2009
April 2009
Granting and Denying Document Access After you specify the user stamp, you specify the folders and documents that this user can and cannot access. 1 From the User/Group Properties dialog box, click Document Access. The Security - Document Access dialog box displays.
The Folder(s) list on the left shows the folder hierarchy of the Report Manager input directory. When you double-click a folder in this column, the documents in that folder display under the Document(s).
April 2009
By default, group access is denied to all folders. However, you can make a folder available or unavailable to individual users. To make a folder available to the user, select the folder under Folder(s) and select Granted under Folder: Default Document Access. To make a folder unavailable to the user, select the folder under Folder(s) and select Denied under Folder: Default Document Access.
Select the appropriate option under Document Access: To deny a user access to all documents in a folder, select Folder Access Denied. To make one or more documents available to the user, click the document(s) you want to make available and select Granted under Document Access. To make one or more documents unavailable to the user, click the document(s) you want to make available and select Denied under Document Access.
Tip
You can select multiple documents by holding down the Shift key while selecting each file.
April 2009
Adding Users to Groups The following procedures describe how to add a user to one or more pre-existing groups. 1 Click the Group Access button. The Security - Group Access dialog box displays.
In this dialog box: The name of the user displays next to Username and cannot be changed. The Member of list shows the groups to which the user belongs. Initially, this list will contain no entries because, by default, the user is not a member of any group. The Not Member of list shows the groups to which the user does not belong. Initially, this list shows all the groups that have been defined.
April 2009
To make the user a member in a group, double-click the group under Not Member of. Repeat this step to make the user a member in additional groups. In the following example, the user Alana Shuster has been made a member of the Human Resources group.
If you change your mind and want to remove the user from a group, double-click the group under Member of. The selected group returns to the Not Member of list.
April 2009
Viewing and Modifying User Properties

As your user requirements change, you may need to change the security properties for your users. To view and or change user properties, use the following procedures. 1 2 3 4 From the Security - User List dialog box, under User/Group List, select the user whose properties you want to view and/or change. Click Properties. The User/Group Properties dialog box displays, with the properties of the selected user. Change the user properties as necessary. For more information, see Adding Users to Report Manager Security on page 319. When you finish, click OK to accept your changes.
April 2009
Removing Users from Report Manager Security

If you want to remove users from Report Manager security, use the following procedures. 1 From the Security - User List dialog box, under User/Group List, select the user whose properties you want to delete from Report Manager security. Click Remove. A Verify User/Group Deletion box similar to the following displays, with the name of the user you selected (Alana Shuster, in the following example).
Click OK to remove the user.
April 2009
12 Security Working with Superusers
Working with Superusers

Except for private comments or comments that are limited to a group of which the superuser is not a member, a superuser has complete access to all folders and documents. This means a superuser can view and modify the following administrative and document privileges:
Administrative Privileges Document Privileges
Folders Document templates Security maintenance Index maintenance Document refile Folder refile Template refile
Comments Layouts Database views Overlays
Initially, there is only one superuser, called the Report Manager Administrator. This superuser can add other superusers. However, only a superuser can delete himself or herself from Report Manager security. When you add superusers to Report Manager security you: Specify the user type as superuser and assign a user name. Specify a default or personalized user stamp. Can make them members of one or more groups.
April 2009
Adding Superusers to Report Manager Security

The following procedures describe how to add superusers. 1 From the Security - User List dialog box, click the Add button. The User/Group Properties dialog box displays.
April 2009
Next to User Type, select Super User. The lists in the Function Access area disappear, because, by default, superusers have access to all functions.
Next to Login Name, type the name this user uses to log in to Report Manager. The login name you type displays in upper-case characters.
April 2009
4 5
Next to User Name, type a name for the superuser you are adding. In our example, we will add a superuser called Charles Bigman. Under User Stamps, specify whether you want the superuser to have the default user stamp or a personalized one. For more information, see Selecting a User Stamp on page 323. To add the superuser to one or more groups, click the Group Access button and select the groups(s) to which the superuser will belong. For more information, see Adding Users to Groups on page 328. When you finish, click OK.
Viewing and Modifying Superuser Properties

If the properties for a superuser need to be changed, the superuser is the only individual permitted to change his or her security properties. Note Only a superuser can change their Report Manager security properties. The properties cannot be changed by a different user or superuser. From the Security - User List dialog box, under User/Group List, select the superuser whose properties you want to view or change. Click Properties. The User/Group Properties dialog box displays, with the properties of the selected superuser. Change the superuser properties as necessary. For more information, see Adding Superusers to Report Manager Security on page 333.
1 2 3
April 2009
Note
If the properties display but cannot be changed, it means you are not the superuser. When you finish, click OK.
Removing Superusers from Report Manager Security

If a superuser is no longer required in Report Manager security, the superuser can use the following procedures to remove himself or herself from Report Manager security. Note Only a superuser can remove himself or herself from Report Manager security. Neither a different user nor another superuser can remove a superuser from Report Manager security. From the Security - User List dialog box, under User/Group List, select the superuser whose properties you want to delete from Report Manager security. Click Remove. A Verify User/Group Deletion dialog box similar to the following displays, with the name of the superuser you selected (Charles Bigman, in the following example).
3
April 2009
Click OK to remove the superuser.

Note
If one superuser tries to remove another superuser, the following message displays because superusers can delete themselves only.
April 2009
13 Managing Documents Moving Documents
13
13Managing Documents
The Report Manager Desktop provides options in the Administration menu for managing documents. This chapter describes how to use these options to move documents, delete documents and folders, and copy and delete templates. Caution Managing documents in Report Manager is not the same as managing files in Windows. Please review this chapter before moving or deleting files on your hard disk. All the procedures in this chapter require you to start the Report Manager Desktop.
Moving Documents
The following procedures describe how to move documents from one folder to another. Note Moving documents requires you to update any indexes generated for that document. From the Report Manager Desktop Administration menu, click Documents and Move. The Document Refile dialog box displays.
April 2009
In the Move From section, click Browse. A Select Document box similar to the following displays.
April 2009
Under Folder(s), click the folder that contains the document you want to move. The documents in the selected folder display under Document(s). Under Document(s), click the document you want to move. If Document(s) does not display the desired document, you might need to specify a wider filing date range, the document might reside in another folder, or the Type list may be set to display only certain types of documents (for example, Statement Documents only).
4 Note
April 2009
Click OK. The Document Refile dialog box redisplays, with the Move From fields completed automatically. Except for Filing Date, the Move To boxes are updated with the same values as the Move From boxes. In the following example, the Customer Bills document in the CHICAGO folder has been selected.This document has a filing date of 7/ 16/99.
To move all documents in the folder shown in the Folder field under Move From instead of just the selected document, click All Documents in Folder. This replaces the name of the currently selected document next to the Document field.
April 2009
Note
Selecting the All Documents in Folder checkbox will move all documents for all templates in the folder. To move a document that is available across several dates, click All Dates Available. This option replaces the filing date of the currently selected document next to the Filing Date fields. In the Move To section, click the Browse button. The Select Document Template dialog box displays.
8.
Note
Statement document templates do not display in the Select Document Template dialog box if the from template you selected in step 4 was associated with line data documents or AFP/Metacode reports. Moreover, if the from template was associated with a statement document,
April 2009
13 Managing Documents Deleting Documents
only those document templates that use the same statement template display in the Select Document Template dialog box. 9 Under Folder(s), click the folder where the document is to be moved and click OK. The name of the selected folder displays next to Document in the Move To section. Next to Filing Date in the Move To section, enter a filing date for the document you want to move. Type the date in MM/DD/YY format (for example 05/09/99). Click OK to move the document(s). (Or click Clear All to clear your selections and start again.) A message asks you to confirm the move and informs you when it is complete. If you return to the Open Document dialog box, click Refresh to see your changes. Run Index Services to reindex the documents in the new folder.
10
11
Note
12
Deleting Documents
If you no longer need a document, you can use the following procedures to delete the document. Note If the document you want to delete has one or more annotations, only superusers will be able to delete the document. From the Report Manager Desktop Administration menu, click Documents and Delete. The Document Refile dialog box displays.
April 2009
In the Delete From section, click Browse. A Select Document box similar to the following displays.
April 2009
Under Folder(s), click the folder that contains the document you want to delete. The documents in the selected folder display under Document(s). If Document(s) does not display the desired document, you might need to specify a wider filing date range, the document might reside in another folder, or the Type list may be set to display only certain types of documents (for example, Statement Documents only).
Note
April 2009
Under Document(s), click the document you want to delete and click OK. The Document Refile dialog box redisplays, with the Folder, Document, and Filing Date fields completed automatically. In the following example, the charge cards document in the NEW YORK folder has been selected. This document has a filing date of 7/16/99.
To delete all documents in the folder shown next to Folder under Delete From instead of just the selected document, click All Documents in Folder. This replaces the name of the currently selected document next to the Document field. Selecting the All Documents in Folder checkbox will move all documents for all templates in the folder.
Note
April 2009
13 Managing Documents Deleting Folders
To delete a document that is available across several dates, click All Dates Available. This replaces the filing date of the currently selected document next to the Filing Date fields. Click OK to delete the document(s). (Or click Clear All to clear your selections and start again.) A message asks you to confirm the deletion and informs you when it is complete. If you return to the Open Document dialog box, click Refresh to see your changes. Run Index Services to reindex the documents in the folder.
Note
Deleting Folders
The following procedures describe how to delete a folder. Before you delete a folder, be sure the folder does not contain any documents or subfolders. If it does, delete or move all of the documents and subfolders in the folder before trying to delete the folder (refer to Deleting Documents on page 343). For example, to delete the FINANCE folder in the following figure, you must first delete the Statements and Trust Reports subfolders. To delete folders: 1 From the Report Manager Desktop Administration menu, click Delete Folder. A Select Folder dialog box similar to the following displays.
April 2009
13 Managing Documents Deleting Folders
2 3 4 Note
Click the folder you want to delete. Click Delete. A message asks you to confirm the folder you want to delete, and reminds you to delete the folder from the load area as well. Click Yes to delete the folder or No to retain in. The folder is deleted. After deleting folders, use Windows to delete the directory from the load area (default load area is PRMLoad). Otherwise, the folder will be automatically recreated when you use the Storage Service to process data from the load directory.
April 2009
14 Archiving and Rollover
14
14Archiving and Rollover
This chapter introduces the Rollover process. Rollover is used to combine Report Manager documents into archive files and optionally migrate those files to Image Services permanent storage. Utilizing the option to migrate to Image Services allows the Report Manager system to free up hard drive space by purging the magnetic cache. The Rollover process consists of several phases and is processed from a single Storage Service server. You specify the Rollover parameters via the Storage Profile dialog box and execute Rollovers using Storage Services. For more information on working with the Storage Profile, see Working with Document Templates on page 84.
Defining Terms
Rollover. Rollover refers to the process of compressing and optionally combining numerous document files into a single file or group of related files, transferring these activities to optical storage, and maintaining records that accurately represent these document and archive files and their locations. Report Manager compresses raw data into document files. Rollover transfers each document file into a larger archive file. Next, these archive files are migrated to an optical medium. These documents are then deleted from the system and removed from magnetic cache. The index records are also removed to maintain consistency.
14 Archiving and Rollover Defining Terms
Reports Archival (Archive Generation) Reports Archival refers to the conversion of document files into archive files. If the Combine into Fiche option is set, then multiple document files that share the same document template will be combined into a single larger archive file. If it is not set, then a single document file is converted into an archive file. Combining can be useful and save some disk space if there are many small documents. Each document and archive file is associated with a document template and that is in turn associated with a document storage profile. Document storage profiles control many aspects of rollover, such as the setting of the Combine into Fiche file flag. Optical Transfer. Optical Transfer refers to the process of copying archive to either an Image Services server or to a third party system. The location and time of the migration is dictated by the parameters that are set in the archives associated Document Storage Profile. Document Delete. Document delete refers to the removal of documents that are no longer needed, as well as all associated native and cross-catalog index values from the Report Manager system. This is controlled by settings in the Document Storage Profile. The profile must have the Archive to Optical option unchecked and the Delete Document option checked. Documents that have previously been migrated to optical cannot be deleted in this phase of rollover. Magnetic Cache Purge. Index purge refers to deleting documents from magnetic cache after they are copied to optical storage. These documents are deleted according to the Document Storage Profile configuration. The Document Storage Profile should be configured for these documents to remain on magnetic cache until retrieval patterns significantly drop. Index Purge. Index Purge refers to the removal of searchable index records pertaining to those associated with the Index Storage
April 2009
14 Archiving and Rollover Defining Terms
Profile. Index records removed could be in the Report Manager database or could be part of the cataloging information on an Image Services system. OSAR. OSAR is an acronym for FileNets proprietary Optical Storage and Retrieval unit. See storage library server for a definition of OSAR server functions. Storage Library server. A storage library is a storage media jukebox, a unit that has a number of slots for containing storage media and a robotic arm that moves the media between slots, drives, and the input/output slot. In a multi-system, the storage library server manages the storage libraries and includes cache storage as well as the related databases. A storage library server is sometimes referred to as an OSAR server. A system can have multiple storage library servers, each of which can manage up to eight libraries. In a system with multiple storage library servers, one serves as the document locator server that keeps track of the contents of all storage libraries. MSAR. Magnetic Storage and Retrieval (MSAR) media provides high speed and high capacity storage libraries on magnetic disk media. Jukebox. A jukebox is a device, also know as a storage library, that holds multiple optical discs and one or more disc drives. A jukebox can swap discs in and out of the drive as needed.
April 2009
14 Archiving and Rollover Process Flow
Process Flow
This section describes how Rollover works and how to verify that archive files have been transferred to optical. Rollover parameters are set via the Document Storage Profile within the Document Template.
April 2009
Refer to the flowchart in this section for a visual representation of the process flow.
Report Archival (Archive Generation)
Multiple Documents sharing the same Document Template are combined into one or more Archive files
Combine into Fiche File?
Yes
No
Convert individual documents into archive files
Optical Transfer
Transfer to Optical
Yes
Copy archive files to Permanent Storage
No Document Delete
Delete Documents and associated Index Values
Yes
Delete documents and associated index values
No Magnetic Cache Purge

Check Dates to see if this document should be deleted
Yes
Delete documents that have been copied to Image Services Permanent Storage
No Index Purge
Check Dates to see if Indexes should be purged
Yes
Purge Indexes
April 2009
Reports Archival (Archive Generation)

In the archive generation step you have the option of selecting the Combine to Fiche feature. This feature is useful for conserving storage system resources. This feature combines multiple archived documents into a single global file. These files have an uppercase G prefix and are placed by the system into the root directory of PRMStore. Combine to Fiche is very effective for systems that are loading a large number of small files. The value of this option is reduced as the number of files is reduced or the size of the files increases. If this option is not selected, the files are individually archived into their own *.lzh file. Combine to Fiche
D:\PRMStore\GL\South\0000.lzh D:\PRMStore\DDA\West\0011.lzh D:\PRMStore\DDA\East\0002.lzh
Combine to Fiche option NOT set
g0000.lzh G0000.lzh
Combine to Fiche option set
In both cases, before the file can be transferred to optical, the PRMArchive table will display the following: id of the global .lzh file (G-file name converted to decimal) folder path where the global file resides (NULL indicates the root directory of PRMStore) StorageID (1 indicates the file resides on the Report Manager server, 0 indicates it doesn't) PlatterID (0 indicates it hasn't transferred to optical, a non-zero number is the IS Document ID, not the surface ID) other system information.
April 2009
Optical Transfer
Optical Transfer is the process of copying archives to Image Services permanent storage. Image Services permanent storage can be optical, MSAR or any supported third party storage devices. The archived object selected is transferred to Image Services. The archived object is then broken into segments that become pages of an Image Services document. The size of the page segments is configured by the page size (in KB) setting in the prm_sdm.ini file. The maximum number of pages that can be stored in an Image Services document is configured by the pages per document setting in the prm_ sdm.ini file. After the archive file has transferred to optical, the StorageID within the PRMArchive table will change from 1 to 0 and the PlatterID will change from 0 to the Image Services Document ID. To confirm that your transfer was properly configured, from Image Services, verify that the document is located on optical by querying the Image Server using the IDMFind application and searching for the IMS Document ID (platterid from the PRMArchive table). You can query for the document but will not be able to view the document. By querying the Image Services database, you can verify that it has the optical location of the archived global file. When a user requests to view the document, it will be copied into Page Cache and displayed on the client's desktop (Report Manager desktop or IDM desktop - depending how the document was requested).
April 2009
Document Record Removal

The Document Record Removal feature is similar to Document Delete, but with some significant differences. Document Record Removal counts down from the documents last updated date. If a document has been opened, it is still considered active and will not be deleted. Document Record Removal can be used simultaneously with Archive to Optical. After the lifetime of the document has been exceeded, Report Manager will take the appropriate steps to remove the document from the system. For example, if a document was loaded on 1/1/2005 and was updated on 1/20/2005 and the days to be kept is set to 30 days, then the document will be removed 30 days after the 1/20/2005 date. For more information, see Document Record Removal on page 118. Caution Report Manager permanently removes documents associated with the profile if they are older than the number of days specified. Therefore, use this option carefully. Document Record Removal will not remove the document from an optical drive but will remove the document from the rest of the Report Manager system and the document will no longer be retrievable by the Report Manager desktop or by the IDM desktop. Frequent backups should be done to prevent accidental data loss.
Document Delete
Document Delete allows you to determine how long a document can exist on the Report Manager system. This values is specified in the Document Storage Profile. For more information on setting Document Storage Profile values, see Configuring Document Storage Profiles on page 112. When the lifetime of the document has been exceeded, Report Manager will take the appropriate steps to remove
April 2009
the document from the system during the next Full Rollover or manual Document Delete Rollover step. For example, a document is loaded on 1/1/2004 with Delete Document selected and Days Before Deleting set to 30. This document will be deleted automatically during the regularly Rollover 30 days after it was loaded into the Report Manager system. Caution Report Manager permanently deletes documents associated with the profile if they are older than the number of days specified. Programmatically, the Document Delete Rollover function will run both the Document Delete function and the Document Record Removal function.
Magnetic Cache Purge

This step deletes documents from magnetic cache after they have been successfully copied to Image Services permanent storage. This value is specified in the Document Storage Profile. For more information on setting Document Storage Profile values, see Configuring Document Storage Profiles on page 112.
Index Purge
The index purge process in Storage Services reviews the Storage Profiles to determine what documents are eligible for index purging. The index purge process then populates the index queue with records that must be purged from the catalogs of both Report Manager and Image Services. You must then run Index Services to remove the indexes from the Report Manager system and complete the index purge process.
April 2009
Appendix A - Service Controller Service Controller Connections
Appendix A - Service Controller

The Report Manager Service Controller is a standalone executable that can run on any Windows 2000/2003/XP operating system and connect to various Report Manager services across the network. You no longer need to go to a specific workstation in order to control the Report Manager service running on it.
Service Controller Connections

The Service Controller controls each Report manager service through two types of connections Service Control Manager (SCM) connections and Remote Procedure Calls (RPC).
SCM Connections
Each Report Manager service is integrated with Windows SCM and makes a connection with the specified workstations SCM verifies that a specified Report Manager service is installed on that workstation. If the Report Manager Service is installed, the Service Controller can be used to : Start the service Stop the service Display the service status
The Service Controller polls the connection once each second and refreshes the display data.
April 2009
Note
Do not run multiple instances of the same service on a single machine.
April 2009
RPC Connections
Once the Report Manager Service is running, the Service Controller, acting as an RPC client, connects to Traffic Service and Index Service. The Report manager Services act as RPC server to the Service Controller. Through this mechanism, the administrator can view and control: Trafic Service connections Index Service index queue Storage Service configuration, processing and status.
Report Manager supports three types of RPC connections: TCP/IP, Named Pipes and IPX/SPX. Both the Report Manager Server and the Service Controller must be configured with identical protocols and protocol endpoints for a connection to be successful. RPC Connection Protocols The Report Manager Storage Service and Traffic Service are configured during installation to support all three protocols. For Storage Service, this configuration information is stored in the prm_ss.ini file of the corresponding WINNT directory as follows:
prm_ss.ini [Server Config] Endpoint1=\pipe\ss,ncacn_np Endpoint2=1000,ncacn_ip_tcp Endpoint3=1000,ncacn_spx
April 2009
Appendix A - Service Controller Adding Connections
prm_ts.ini [Server Config] Endpoint1=\pipe\gv,ncacn_np Endpoint2=1500,ncacn_ip_tcp Endpoint3=1000,ncacn_spx
If you want to change the specified protocol endpoints, edit these files manually. The prm_ss.ini file contains configuration informationfor a connection between the Storage Service and the Traffic Service. In this case the Storage Service acts as the RPC client. Each RPC connection must use different endpoints and both connections must be present for the Storage Service to operate correctly.
Adding Connections
After you install the Report Manager Service Controller, you must create and define connections to the various Report Manager Services. The Service Controller is the RPC client and must use the same protocol and endpoint as the corresponding Report Manager Service.
Security and Administrative Rights

You must have identical administrative accounts on all servers that you are going to talk to with the Service Controller. The Service Controller runs under the account that was used to log onto the workstation on which it is running. That account, with administratoe privileges, must be authenticated by the Report Manager servers before access and control of those services is possible.
April 2009
Running the Service Controller for the First Time

After installation, you start the Service Controller and the following split window is displayed. The tree structure in the left pane contains the three root nodes. Each root node manages connections to the corresponding Report Manager service. Initially, no connections are present. You must create new connections using the Connections menu.
April 2009
Creating a New Traffic Service or Storage Service Connection Select Connection > New > Traffic Service or Storage Service to display the Connections Properties dialog box.
Note
Do not connect a single instance of Traffic service to more than one Service Controller.
April 2009
Connection Name Network Address
Any name, although normally it is expected to be the name of the server where Report Manager Traffic Service is running. The name of the server running the Report Manager Traffic Service. The name entered in the Connection Name field will appear in this field by default. You may modify it. This is a list of protocols with a default value of TCP/IP. The other options are Named Pipes and IPX/SPX. You must specify the same protocol being used by the Report Manager Traffic Service to which a connection is being made. As with the Protocol, the user must enter the same endpoint as is being used by the Report Manager Traffic Service to which a connection is being made. The defaults are:
Traffic Service Storage Service
Protocol
Endpoint
TCP/IP IPX/SPX NAMED PIPES Test
1500 1000 \pipe\gv
1000 1200 \pipe\ss
Use this button to test the connection. If you click OK and the connection is not successful, the following displays:
Click OK. The service is displayed in the appropriate node of the tree structure.
April 2009
Note
You can add a connection to the tree structure even though a successful connection was not established. This can be useful if the service is not running when the connection is created, but you still want to make the connection between the Service Controller and the SCM controlling the device.
Creating a New Index Service The control of the Report manager Index Service requires only a connection to the SCM on the platform hosting the Index Service. No RPC connection is required as no data needs to be exchanged between the Service Controller and the Index Service. Selecting Connection > New > Index Service displays the following Connection Properties dialog box.
April 2009
Refer to Creating a New Traffic Service or Storage Service Connection on page 363 for information on filling in the Connection Name and Network Address fields. Click OK. The service is displayed in the Index node of the tree structure. Note You can add a connection to the tree structure even though a successful connection was not established. This can be useful if the service is not running when the connection is created, but you still want to make the connection between the Service Controller and the SCM controlling the device.
Saving the Connections To save the connections defined in the connections tree, select Connections > Save. The connection information is saved in default.sc in the same directory as the Service Controller executable, and is not designed to be edited manually by the user. Note There is no limit to the number of connection setups you can save.
April 2009
Appendix B Traffic Service Accessing Traffic Service
Appendix B Traffic Service

This appendix describes the Report Manager Traffic Service (TS). TS is the nerve center of the Report Manager application. All access and updates to the Report Manager index and archive data are processed through TS. This provides a single point of control for maintaining data integrity and control. Note Do not connect a single instance of Traffic service to more than one Service Controller.
Accessing Traffic Service

Starting with Report Manager 5.0a, Traffic Service is available as Windows service. To access Traffic Service, you have to connect to it through the Service Controller. For more information, see Adding Connections on page 361. The Service Controller polls the Traffic Service once every second, refreshing the data displayed within the SCM. TS works as a traffic cop for other services that run on either the same computer or other computers on the network. However, TS does not control what events take place, just their order and execution. Therefore, there are no TS options that you need to set. After creating one or more Traffic Service connections the Traffic Service root node displays a + to the left of the node indicating the node
April 2009
can now be expanded. Clicking on the + expands the tree to show the Traffic Service functions that are available.
In this example the Service Controller is connected to a single instance of Traffic Service . To control it, click on the + corresponding to the specific Traffic Service connection, RMDEV2.
April 2009
The tree expands to display the nodes associated with the Traffic Service functions and the selected Traffic Service status is displayed in the right window pane.
Active Users Selecting the Active Users node displays the current list of users connected to that Traffic Service. The right pane displays the login name of all users who are accessing the Report Manager system, along with their domain, computer name of the client, and the total time they have been using the Report Manager system. This information is configured to refresh every second.
April 2009
Note
Users who log in to the Report Manager system using the same login name are numbered sequentially, with that number displayed under the # column. If there is only one user with a login name, this column is blank. Two asterisks (**) display in the # column for those who use a Report Manager Desktop earlier than 4.0.
Open Documents Selecting the Open Documents node displays the current documents opened by users of this Traffic Service. Documents Being Indexed This node displays the current list of documents in the Report Manager Indexer Queue. This list will be empty if Report Manager Index Service is not running and connected to the specified Traffic Service or if there are no documents to be indexed.
April 2009
Indexing Errors Clicking Indexing Errors node displays errors (if any) occurred while indexing documents. The list in the right pane will be empty if the Report Manager Index Service connected to the specific Traffic Service is not running or there is no document to be indexed. In case of an error while indexing a document, the right pane displays the DocID, Folder Name and the name of the Documents with Indexing Errors. Right-click the Indexing Error node to Clear Selected Errors or Clear All Errors. Alternatively, you can also select the errors you wish to delete and press the Delete on your keyboard. Storage Options The Storage Options node allows you to specify magnetic and optical storage options. When you click this option, a list of Magnetic storage area and Optical storage area appears on the right pane of the window. You can use UNC (Universal Naming Convention) path names as a storage path or network drives to connect with TS (Traffic Service). For more details, refer to Configuring Storage Options on page 395
April 2009
Appendix B Traffic Service Configuring Storage Options
Configuring Storage Options

Using the Storage Options node, you can specify magnetic and, for non-IDM Image Services users, optical storage options. 1 On the TS node, click Storage Options to display the Magnetic Storage and Optiocal Storage frames.
Refer to the appropriate section for information on each of the two storage options:
April 2009
For information about the Magnetic Storage Area tab, see Magnetic Storage on page 373. For information about the Optical Storage Area tab, see Optical Storage on page 377.
Magnetic Storage
The Magnetic Storage Area tab displays the characteristics of the magnetic storage areas used as a cache area.
April 2009
You can add new drives and/or directories to the list for storing archives. This makes it possible for the magnetic cache area to span multiple logical and/or physical disk drives. To add a new magnetic drive and/or path: 1 Click New. A Browse to Folder dialog box similar to the following displays.
2 3
Select a directory, or use the Network button to browse network drives and directories and select the desired directory. Click OK. The Add Magnetic Drive dialog box displays, with the selected drive and directory (C:\IMAGES, in our example).
April 2009
the Add Magnetic Drive dialog box settings: Magnetic Drive Path Name The drive and directory you are adding. This information is displayed for informational purposes only and cannot be changed from this dialog box. Minimum Free Space Req Type the minimum free space required on the drive/directory being added and select one of the following values: KB for kilobytes MB for megabytes The value you specify will be the fixed amount of free space that remains after a new file has been added.
April 2009
Tip
When specifying the minimum free space required, take into account drive space required for a swap file and temporary files that might reside on the drive, as well as files deleted from the drive. Available Free Space The amount of available storage space in the directory. This setting is for informational purposes only and cannot be changed.
Click OK. The Storage Service dialog box appears, with the selected drive and directory shown in the Magnetic Storage Area tab.
April 2009
In this example, the \\RMDEV2\C$\ directory was added to the magnetic storage list. Note To change a drive from the Magnetic Storage Area, click a drive under Full Path and click the Edit button. To remove the selected storage area, click a drive under Full Path and click the Delete button; however, you cannot remove storage areas that contain documents.
Optical Storage
The Optical Storage pane displays the characteristics of the optical storage areas used for the Report Manager database. Note The New, Edit and Delete buttons on the Optical Storage frame appears enabled only if the following parameter is in the Prm_sdm.ini file: [OpticalDevices] DefaultOutputDevice=File System These buttons appear disabled on the Optical Storage frame if the following parameter is in the Prm_sdm.ini file: [OpticalDevices] DefaultOutputDevice=FileNet IMS For more information about the Prm_sdm.ini file, see Appendix H Report Manager Initialization Files on page 459
April 2009
To add optical devices: 1 Click New. A Browse for Folder window similar to the following displays.
April 2009
Select the network drive and directories associated with the optical device, as shown in the following example.
April 2009
In our example, we will add the drive and directory C:\PRMLoad. 3 Click OK. The Add Optical Drive dialog box displays with the selected drive and directory.
April 2009
Review the Add Optical Drive dialog box settings: Optical Drive Path Name The drive and directory you are adding. This information is displayed for informational purposes only and cannot be changed from this dialog box. Minimum Free Space Req Type the minimum free space required on the drive/directory being added. use the drop-down box to select one of the following values: KB for kilobytes MB for megabytes Available Free Space The amount of available storage space in the directory. This setting is for informational purposes only and cannot be changed.
April 2009
Click OK. The Optical Storage frame displays the selected drive and directory.
In our example, the C:\PRMLoad directory was added to the optical storage list. Note To change a drive from the Optical Storage Area, click a drive under Full Path and click the Edit button. To remove the selected storage area, click a drive under Full Path and click the Delete button; however, you cannot remove optical areas containing stored documents that have been deleted from magnetic storage.
April 2009

This appendix describes the Report Manager Storage Service (SS). Note Do not run multiple instances of Storage Service on a single machine. SS is responsible for: Periodically searching load directories for documents ready to be loaded into the Report Manager system. Combining documents into archive files. Migrating archived documents from magnetic to optical storage. Updating the Report Manager database to reflect the location of documents.
When SS scans a load directory (PRMLoad, for example) and discovers new files to be loaded into the Report Manager software, it compresses the files and stores them in the storage directory (PRMStore, for example). In this way, the storage directory reflects the same file hierarchy in the load directory. At some point, you might need to combine and store the files from the magnetic cache to an optical disk (this is called rollover). SS compresses and stores files in an LHA archive file format. In addition, the archive file formats in which these documents are permanently stored is a standard LHA format. This lets the user access Report Manager archives from other applications.
April 2009
Appendix C Storage Service Accessing Storage Service
For each new document that SS finds, it locates the administratordefined file specification that matches the new document. Then SS applies the document template parameters (such as ANSI carriage control, channel mapping, and profile storage settings) that the administrator has defined for files that match the file specification. For more information about document templates, refer to Chapter 5, Working with Document Templates, on page 84.
Accessing Storage Service

Starting with Report Manager 5.0a, Storage Service is available as a Windows service. To access Storage Service, you have to connect to it through the Service Controller. For more information, see Adding Connections on page 361. The Service Controller polls the Storage Service once every second, refreshing the data displayed within the SCM. Select the Options node in the appropriate service in the tree view to display the Storage Service pane.
April 2009
The Report Manager Storage Service pane contains the following information: Status This area reflects the current status of Storage Service.
Current Settings Specifies what file is being used for the Storage Service settings. Current State Storage Service state. Process Started At The date and time (hh:mm:ss) when the current processing operation began. If processing has not started, SS displays the word Stopped. Next Rollover The day, date, and time that the next rollover will occur. Configuration This area describes the SS configuration. Traffic Service Server The name of the computer supporting the Traffic Service. Load Directory The name of the input directory from which SS is loading documents. You can change the load directory before loading documents by using Select Input Directory on the Options menu (see Changing File and Rollover Settings on page 390). Filing Date The date selected to indicate when reports are generated on the host system. To change the Filing Date, choose Select Filing Date from the Options menu. Load Files Button Click on this button to start loading files.
Appendix C Storage Service Storage Service Options
Note
If you receive an error message that tells you there is not sufficient space to load the data from the input (load) directory, click Storage Options on the Traffic Service menu and verify that there is sufficient free space to accommodate the data you want to load. If not, make space available or define a new magnetic storage area (see Magnetic Storage on page 373).
Storage Service Options

The following section describes the SS nodes and related commands. Options Right-clicking the Options node allows you the following actions: New allows you to create a new settings file. Open loads an existing settings file. See Loading Settings on page 402. Save saves changes (if any) to the current settings file. Save As saves SS settings in a file with a user-defined name. This file can be loaded using the Open option. Configuration displays configuration information associated with the currently loaded configuration settings file. See Configuration Settings on page 412 Settings displays file scan, rollover, and special file parameters. See Changing File and Rollover Settings on page 381.
April 2009
Appendix C Storage Service Configuration Settings
Scheduler allows scheduling the SS instance to pick up different configuration settings based on the time and frequency specified. See Scheduler Settings on page 401. Rollover Reports Archival converts document files into archive files. Optical Transfer migrates archive data to optical storage, without performing other functions. Index Purge lets you manually purge indexes whose index profiles specify that they are to be purged from magnetic cache (see Defining Index Storage Profiles on page 192). Document Delete allows you to manually delete documents with storage profiles specify that the documents are to be purged from magnetic cache (see Configuring Document Storage Profiles on page 112). Magnetic Purge deletes the appropriate archive data from magnetic storage, without performing other functions. Note IDM Services for Report Manager users should also refer to the rollover configuration settings in the Prm_ss.ini file. For more information, see Appendix H Report Manager Initialization Files on page 459.
Configuration Settings
Traffic Service Server The name of the computer supporting the Traffic Service.
April 2009
Appendix C Storage Service Configuration Settings
Load Directory The name of the input directory from which SS will load the documents Filing Date Filing date specifies the date when files load and get filed in the Report Manager database. The default date is one day before the date when the files loaded. For example, if today is April 7 and SS loads data today, the filing date will be April 6. This will be the default setting until rollover occurs. Note To use a specific filing date instead of the default filing date, insert a dash and the date you want to use (in DDMMMYYYY format) after the file name in Explorer. For example, report.spl-20mar2005 assigns the date March 20, 2005 to the file report.spl. System Date When System Clock Last Struck Use this option to specify when you want SS to start the next filing date. You can increase or decrease each time segment by clicking on the hour, minute, second, and the AM/PM and using the Arrow buttons. If you have specified a filing date minus one day and the Advance Filing Date At option is set to 6:30 PM, files loaded at 4:00 PM have todays date minus two days as a filing date. File creation date minus This option specifies the file creation date minus the number of days as defined by the user. Skip Weekend Filing Dates
April 2009
Appendix C Storage Service Changing File and Rollover Settings
By default, the Skip Weekend Filing Dates option is checked. This setting tells SS to use Fridays date as the default filing date when loading documents on weekends and Mondays. Create Folder The Create Folder button allows you to create Report Manager Folder to load statement files.
Changing File and Rollover Settings

Use the following procedure to view and change file and rollover parameters. 1 Click Settings under the Options node of the SS. The Settings dialog box displays. This dialog box contains three user-configurable areas File Scan Options, Rollover Options, and Special Files which resemble index cards.
April 2009
Refer to the appropriate section for information on the options in the property sheet: For information about the File Scan Options, see File Scan Options on page 392.
April 2009
For information about the Rollover Options, see Rollover Options on page 394. For information about the Special Files, see Special Files on page 396.
File Scan Options

File Scan Options define the file scan, scanning flag, scan interval, and busy file settings. The following figure shows the File Scan Options.
April 2009
The File Scan Options allows you to configure the following options:
Option Description
File Scan
Specifies how frequently SS scans the input directory for loadable documents. Selecting Scan Between or Scan Continuous enables the Scan Interval option. Specifies how often SS scans the input directory. This option is available if File Scan is set to Scan Between or Scan Continuous.
Scan Interval
April 2009
Option
Description
Busy File Scanning Flags
Specifies how long and how often the Report Manager software tries to load a file that is busy (such as when it is being used by another process). Contains the following flag options:
Include New Directories Specifies whether SS creates new file folders and documents from load directories. Delete Input File after Loaded Specifies whether SS deletes the original document file from PRMLoad after the file loads. Note:Under this setting, if a file has read-only attributes, the file is not loaded and a warning message is added to the event log. Stop for Exceptions Indicates whether SS pauses if it encounters an exception.
Rollover Options
The Rollover Options is where you specify when SS should check for documents to be removed from pre-defined files and stored. This is called rollover. The following figure shows the configurable Rollover Options.
April 2009
Overview of the Rollover Process Typically the Report Manager software loads documents in batches. A batch load might occur, for example, when an accounting system finishes its overnight run and creates a batch of documents to be loaded into the Report Manager database. The Report Manager software compresses these documents into one archive file. As other systems create new batches, SS creates new archive files from them. Then, at a specific time, the Report Manager software performs a rollover by taking these archive files and
April 2009
applying the storage profile already defined. This archived file can be stored on an optical disk for long-term or permanent storage. Rollover should occur when all or most documents for that day have been created. The File Scan Options allows you to configure the following options:
Option
Description
Automatic Rollover
Report manager supports automatic rollover of documents. Click the Automatically Rollover At checkbox for automatic rollover of documents every day at the designated time.
Note: To prevent accidental scheduling or unscheduling of the rollover option, it is recommend that you select Automatic Rollover in each SS settings file.
Dont Retry Missing Files Maximum Number of Documents to be Archived Enable Additional Archival File Checking
If you keep it checked, the rollover process will ignore tracking missing documents during the scheduled rollover. Allows you to specify the maximum number of files to be archived. The default limit is 100000. If you keep this option checked, it allows to choose between Prompt Before Cleanup and Always Fix Without Prompt options.
Special Files
Special Files define how SS handles document that require special processing. The following figure shows the Special Files.
April 2009
The Special Files allows you to configure the following options:

Option Description
Add Remove Do not Scan Scan at Priority Store only One Version Do Not Archive to Optical
Allows you to add file or pathname to be exempted while scanning. Allows you to delete files from those you added to the exceptions list. Specifies whether or not the exception file is processed. Determines whether SS processes the selected file first during each scan. Stores only the current version of the chosen document(s). Keeping it checked will prevent migration of the document to the optical drive.
Adding Files to the Exceptions Path/Filename List You can give each file in the Path/Filename List unique exception processing.
April 2009
To add files to this list: 1 Click Add. The Add Exceptions dialog box displays.
Type the full path of the file to be given special processing, or click the Browse button to browse files and directories. In the example, the C:/1.txt file gets exception processing: .
April 2009
Click OK. The Special Files configuration area displays with the selected file.
April 2009
Appendix C Storage Service Creating Report Manager Folders
Note
SS permits different settings for each path and/or file listed in the Path/ Filename list. The Exception Flags settings depend on which Path/ Filename in the list is selected.
Creating Report Manager Folders

The Create Folder button on the Configuration pane under the SS node allows you to create a folder below the load directory. The folder must already exist in the load directory. Use Windows Explorer to create the folder under the load directory folder, before using Create Folder to select it. Create Folder is useful to users who will use the Statement Administrator to define statement templates. The Report Manager software cannot load a file as a statement unless there is a folder for that file in the Report Manager database. Using Create Folder, you can specify a folder for statements. 1 The new folders you specify must reside below the current load directory. Therefore, if you want to change load directories, use the procedure under Changing File and Rollover Settings on page 390 to do so. If the folder you want to specify does not already exist, create it below the current load directory. On Storage Service, click Create Folder button in the Configuration pane. A Create Report Manager Folder dialog box similar to the following displays. The currently selected folder (Chicago, in the following figure) is denoted by an open folder.
2 3
April 2009
Appendix C Storage Service Scheduler Settings
4 5 6
Click the desired folder. The name you select displays next to Report Manager Folder Name. Click OK. A message displays, indicating the folder was added successfully to the Report Manager database. Click OK to remove the message.
Scheduler Settings
The Storage Service Scheduler allows you to schedule Report Manager settings file and load the settings according to the scheduled day and time. You can schedule multiple setting files. To load the settings file at the scheduled time, you need to add the file in the scheduler and specify the required day and time. According to the specified day and
Appendix C Storage Service Loading Settings
time scheduler picks up the setting file and loads it automatically, even if the Storage Service is not performing any task. You can configure the following Scheduler options:
Option Description
Schedule
Enable: allows you to schedule a particular settings file that you loaded by clicking the Add button. Run Once: lets you mark a particular file to run or load only once (at the specified date and time). Start at: lets you specify the time when you want the SS to pick up the settings file and load the settings. Days to run: lets you select the days (of the week) that you want the SS to load teh selected settings file. Load Directory:
Add Update Delete
Allows you to add new storage settings file for the SS to pick up and load settings from. Allows you to reflect the latest changes to the storage settings currently loaded. Allows you to delete the selected settings file.
Loading Settings
SS settings are saved in a settings file. This is useful because it lets you store multiple versions of these settings.
Add New Scheduler Setting

You can then use the following procedure to load a scheduler settings file:
April 2009
Right-click the Options node under SS on the left pane of the Service Controller and click Add. Alternatively, you can click the Add button on the Scheduler pane of the SS. An Add Setting File dialog box similar to the following displays: .
April 2009
Click the ... button next to the Configuration File and browse to the location of your SS settings file.
3 4
Click Open after selecting your settings file from those available. Click OK on the Add Setting File dialog box. Once you are done choosing your settings file, select it on the scheduler configuration pane, Enable and specify the Days to Run and Start Time.
April 2009
Click Update to display the newly configured scheduler settings file.
April 2009
6 7
Repeat step 1 through 5 to add more than one scheduler settings file. You must restart the Storage Service to allow the new scheduler settings to take effect.
April 2009
Note
For details on loading scheduler settings, refer to Loading
April 2009
Appendix C Storage Service Redistributing Files
Loading Settings Example

The following example illustrates how the SS loads scheduler settings based on the defined criteria. Assume that the following scheduler settings files are available and enabled.
Settings File Start Time Days to Run Enabled
Monday.ss Tuesday.ss Wednesday.ss Thursday.ss
11:00 a.m. 1:00 p.m. 5:30 a.m. 9:00 p.m.
Mon Tue Wed Thurs
Yes Yes Yes Yes
If you started the SS on Monday, at or after 11:00 a.m., the Monday.ss settings will be picked up. Else, SS will pick up Thursday.ss. Also, in case you start the scheduler service on Friday/Saturday/Sunday, the SS will continue to run the Thursday.ss settings till 11:00 a.m. on a Monday.
Redistributing Files
There may be times when you have to transfer a file from its source location to a destination directory other than the load directory on the Report Manager server. For example, a mainframe with limited capabilities might force files to download to a directory other than the Report Manager load directory. In these cases, you can create the file SS_COPY.INI file in your WINNT folder to tell Report Manager how to redistribute files. 1 Use a word processor or text editor to create the file SS_COPY.INI in the WINNT folder.
April 2009
2 3 4 5
Edit the SS_COPY.INI file as described under Editing the SS_ COPY.INI File on page 410. Start the Report Manager Index Service. Start the Report Manager Storage Service. Then specify the input directory (see Changing File and Rollover Settings on page 390). Click on Load Files in the Storage Service window to start loading. Report Manager then: Checks the ACTIVE entry in the SS_COPY.INI file to ensure that file redistribution is activated. Obtains the name of the input directory from where all the files are to be transferred, if file redistribution is activated. This information is specified in the PATH= statement under the [OPTIONS] section in the SS_COPY.INI file. Obtains the load directory from the default.Storage Service file, which stores the load path you specified. Creates a list of the files in the input directory. Loops through the files performing the following processing for each file. Looks in the SS_COPY.INI file for a section name that is the same as the name of the file to be redistributed. (The filename in the SS_ COPY.INI file has no extension.) If it finds the section, it obtains the specified line and column numbers specified in the SS_COPY.INI file, opens the specified file, and reads the file lines until it arrives at the one specified.
April 2009
Grabs the file line starting at the column specified. Loops through the count specified in the SS_COPY.INI file, comparing each identifier against the CONTENTS0001 = line in the SS_COPY.INI file to see whether a match can be found. When a match is found, it ascertains the transfer location (directory and filename) from the SS_COPY.INI file and transfers the file to that location and filename.
Note
If any of these steps fail, the Report Manager moves the file into the <input directory>\NOTFOUND directory.
Editing the SS_COPY.INI File

The following lines show the sample contents of an SS_COPY.INI file. [OPTIONS] ACTIVE = ON PATH = C:\RMCOMMON In this file: ACTIVE = ON activates file redistribution. ACTIVE = OFF disables file redistribution. PATH = shows the input directory where the files are to be transferred. This path must already exist on the Report Manager server.
Following the [OPTIONS] section, create a new section that provides information about the file that is to be redistributed. The following example, for instance, provides information about a file called DDATOMT.
April 2009
[DDATOMT] COUNT = 2 LINE = 9 COLUMN = 13 CONTENTS001 = CORPORATE COPYT0001 = c:\rmload\marc\ddatomt.spl In this section: The section name, typed in brackets, is the name of the file to be redistributed. Do not include any file extension. In our example, [DDATOMT] is the name of the file that will be redistributed. COUNT= indicates the number of loops that Report Manager performs when looking for the identifier specified by the CONTENTS0001= parameter (described below). LINE = is the line number where Report Manager starts looking for an identifier. Report Manager counts lines starting at the top of the page. COLUMN = is the column number where Report Manager starts looking for an identifier. Report Manager counts columns starting with the leftmost column (column one) on the page. CONTENTS0001 = is the identifier that Report Manager looks for in the document. COPYT0001 = is the output file where Report Manager redistributes the file. This path must already exist.
April 2009
Appendix D Index Service Starting Index Service
Appendix D Index Service

This appendix describes the Report Manager Index Service (IS). IS maintains the Report Manager index database and manages the addition of new entries. Note Do not run multiple instances of Index Service on a single machine.
Starting Index Service

Starting with Report Manager 5.0a, Index Service is available as Windows service. To start the Index Service: 1 2 Start the Report Manager Traffic Service if it is not currently running . From the Microsoft Windows Start button on the taskbar, click Programs > FileNet Report Manager Services > Report Manager Services Controller. Click Index Service on the left pane. The Report Manager Index Service frame displays on the right pane.
April 2009
Appendix D Index Service Understanding the Index Service Window
Understanding the Index Service Window

The following figure shows the Report Manager Index Service window.
The Index Service does not offer any UI functionalities. However, users can double-click or right-click Index Service node to Start or Stop the service.
April 2009

This appendix describes the Report Manager Burst Service (BS). BS separates (or bursts) a large report file into smaller reports before loading the report into the Report Manager database. BS lets you define a set of unique criteria (such as account name, account number, or broker name) found in a report. BS looks for this criteria in the report, separates the file that contains it, then places this file in a userselected output directory. BS repeats this process each time a new set of criteria is encountered. BS is particularly suited for: Various types of reports that are generated as one by the same application. A single multi-branch report that needs to be separated by branches. A report that must be secured, in sections, by users. A typical example is a broker commission report that must be separated by broker, so each broker can have access to only his or her portion of the report.
BS also allows you to add an extra level of security to many kinds of reports. Security can literally be brought to the page level. However, bursting into too many files can degrade performance when accessing reports through the Open dialog box. This appendix describes how to use BS to burst report files. This appendix assumes that BS has been installed.
April 2009
Appendix E Burst Service Starting Burst Service
Note
Burst Service cannot process files larger than 2 GB.
Starting Burst Service

1 2 Start the Report Manager Traffic Service if it is not currently running From the Microsoft Windows Start button on the taskbar, click Programs > FileNet Report Manager Services > Report Manager Burst Service. If you are using BS for the first time, proceed to Using the Report Manager Burst Service for the First Time on page 415. Otherwise, the Report Manager Burst Service window displays and you should proceed to Understanding the Burst Service Window on page 417.
Using the Report Manager Burst Service for the First Time
The first time you start BS, you have to specify the path where the files to be burst will reside. This path is specified in the Prm_bs.ini file. If this file is not located on the server, the following message displays when you start BS.
April 2009
Appendix E Burst Service Starting Burst Service
Click Yes to create the file Prm_bs.ini in the path shown. The Select Input Path dialog box displays.
2 3
Either accept the path shown in the Select Input Path dialog box, or choose a different path. Click OK. A Report Manager Burst Service window similar to the following figure displays.
April 2009
Appendix E Burst Service Understanding the Burst Service Window
Proceed to Understanding the Burst Service Window on page 417.
Understanding the Burst Service Window

The following figure shows the Report Manager Burst Service window.
April 2009
Appendix E Burst Service Understanding the Burst Service Window
The Report Manager Burst Service window has two sections: Files in Queue displays the files that are currently residing in the input directory and ready to be burst. The path specified above the files is the path specified in the Prm_bs.ini file. Current File displays the status, by percent completed, of the file being burst.
April 2009
Appendix E Burst Service Starting the Bursting Process
Starting the Bursting Process

There are two ways to start the bursting process from the Report Manager Burst Service window: Clicking the Start button. The Start button changes to Stop, which you can click to stop the bursting process. Clicking Start on the Process menu. You can then use the Process menu options to pause or stop the bursting process.
When you start the bursting process, BS: Note Picks up each file from the queue. Performs the bursting process, based on the user-defined criteria. Deletes the original file if the bursting was successful.
If you did not select an input file (the file to be burst), or if none of the criteria in the settings file matches the input file, BS moves the file into a folder called NotFound. The file(s) remains there for as long as BS operates. When you exit and reopen BS, all files in NotFound are deleted automatically. After completing the bursting process, the Files in Queue list refreshes and the next file in the list is selected. Once all the files in the queue are burst, the process pauses for 50,000 milliseconds (approximately one minute), wakes up, and repeats the process.
Before you commence the bursting process, see Setting Up the Bursting Process on page 420 for prerequisite information.
April 2009
Appendix E Burst Service Setting Up the Bursting Process
Setting Up the Bursting Process

The following sections provide guidelines to consider when using BS.
Settings File
Bursting is a process that separates reports at page level according to the settings file defined for BS. A settings file contains the names of one or more report files that are to be burst. Each report file can have one or more criteria that are either fixed or tagged. Using this criteria, BS determines name of the file(s) to be burst and the way to burst the file(s). The settings file is a text file that can be easily maintained and edited using a text editor. By default, BS uses the settings file Prm_bs.ini (shown in the following figure).
April 2009
If you prefer, you can create a custom settings file. The following figure shows an example of a custom settings file.
April 2009
Note
BS does not automatically create the path or directory shown for Input Path. If the path or directory does not already exist, create it before using the procedures below to start BS. After you create a custom settings file, use the following procedures to have BS use the custom settings file in place of the default file.
1 2
From the Microsoft Windows Start button on the taskbar, click Run. The Run dialog box displays. Type <drive>\Program Files\FileNet\RM Services\bin\ PRM_BS.EXE, where <drive> is the letter of the hard drive where BS resides. For example: C:\Program Files\FileNet\RM Services\Bin\PRM_BS.EXE
After PRM_BS.EXE, press the space bar and type the path for the settings file you want to use. To use a settings file named PRM_BS2.TXT, for example, the Run dialog box would look as follows:
Click OK to start BS with the specified settings file.
April 2009
Criteria
Criteria is a definition of a section in a report. The criteria is responsible for generating the separated or burst reports (referred to collectively as output files). Output files can have either a fixed file name or a name based on pickup information (see Pickup Information on page 424). You can specify a duplicate output file to criteria where you have defined a fixed filename. This is helpful when a report that is to be burst must have one of its sections burst. Criteria comprise two parts: locator information and output information. These parts are shown in the sample settings file on the preceding page and are described in the following sections. Locator A locator is information that uniquely identifies each report in a file. It identifies each criteria by specifying what text BS is to look for on each page and where to look for it (this is similar to the locator used in Report Manager document layouts). Locators are designated as either fixed or tag. A fixed locator is identified by a consistent or fixed line and column position on every page that contains the criteria. A tag locator can be set anywhere on a page.
Although specifying a tag works for every criteria, we recommend you use a fixed locator.
April 2009
Output Information BS uses output information to determine the location of the output file and the output filename. The output filename can be a fixed filename with a path such as C:\PRMLoad\DDA\REPORT1.SPL or a generated filename based on pickup information. Note If a page does not meet any criteria, but an earlier page has criteria set and an output file open, the page that lacks criteria goes to the same output file where the earlier page was sent. This is useful when reports separated by cover pages do not have a specific common text on all report pages. You can specify a unique text on the cover pages and once the cover page criteria is hit, output generates in a single file until the next cover page criteria is hit.
Pickup Information
Pickup information is a user-defined parameter that is picked-up from the page containing the criteria. BS uses this parameter to determine the name of each output file. For example, if a broker commission report is to be separated by brokers, and there are 500 brokers, it is not feasible to define 500 sets of criteria and specify 500 fixed output file names. Instead, you can define just one criteria and define the output filename as a pickup name from the report (in this case, the brokers name). When BS finds a brokers name in the report, it generates an output file named after that broker. When the pickup information (such as a trader name) changes, BS generates a new output file.
April 2009
Defining Criteria
Criteria must be defined to create a Settings file. Criteria is made up of locator information and output information. To add, delete, or modify the locator and output information: 1 On the BS File menu, click Settings. A Settings dialog box similar to the following displays.
Note
The Settings dialog box provides a Modify File button for editing file criteria and a Remove File button for deleting a file and its criteria.
April 2009
Click Add File to add criteria. The Select File dialog box displays.
Select a file that needs to be burst, or type the name of a file that is not currently in the burst directory. It is recommended that you have the file in the burst directory while modifying settings. This allows the file to be loaded, making it helpful to set up the criteria. Click Ok. The Settings dialog box and File Settings dialog box display side by side. The Settings dialog box shows the name of the file to be burst. In the following example, the file called NHAB2810.TXT has been selected for bursting.
Note
April 2009
To add criteria, click Add Criteria in the File Settings dialog box. The Criteria dialog box displays.
April 2009
To select or modify a locator, click Select. The Preview File dialog box displays.
April 2009
The Preview File dialog box provides a preview of the file to be burst, along with page and line views and page and line numbers. The page view displays each page of the report; from this section, you can determine the locator. 7 Use the up and down arrow keys to select the page and line number where the locator text is found. The Line View window displays the whole line containing the locator.
April 2009
8 9
Delete any unnecessary text from the Line View. The information that remains will be designated the locator. After you select the locator, click Copy Back. The Criteria dialog box redisplays with the newly selected locator text.
10
Select whether the locator text is fixed or tagged: Fixed Position BS looks for the locator text at the specified line and column position on every page. Tag BS looks for the locator text at any location on every page.
April 2009
11
Select a fixed output or pick-up filename: To select a fixed output filename, see Selecting a Fixed Output Filename on page 431. To select a pick-up file name, see Selecting a Pick-up Filename on page 433.
Selecting a Fixed Output Filename To select a fixed output filename: 1 2 From the Criteria dialog box, click Fixed File Name. Click Set. The Output Information dialog box displays.
April 2009
In the Output File Name field, type the path and filename of the burst report. A fixed output name is best for those reports that are to be separated into one additional report. Use the Duplicate File Name field to place the pre-burst report into a different path. Click OK to remove the Output Information dialog box. Click OK again to remove the Criteria dialog box. In the File Settings dialog box, click OK to start the bursting process.
4 5 6 7
April 2009
Selecting a Pick-up Filename To select a filename that is determined by pick-up information: 1 2 From the Criteria dialog box, click Pick-Up File Name From Report. Click Set. The Output Information dialog box displays.
Type a directory path, line number, column position, and filename size. You can also type an optional three-character file extension.
April 2009
Note
The Pickup file syntax is: Drive:\Full Path \ ([+,-]Line Number, [+,-]Column Number, FileName Size) .Extension In this line: The information in brackets is the pickup information and the extension is optional. Line Number and Column number can be absolute on a page (starting from 1) or relative to the locator Line and Column positions. If selecting a relative locator position, type + or sign in front of it. For example, if line 3 specifies Trading Report of William, locator text can be Trading Report on line 3 and column 1 and pickup can be C:\PRMLoad\(+0,+18,10).SPL, which generates C:\PRMLoad\ WILLIAM.SPL.
The pickup filename is trimmed for spaces and an underscore replaces any unusual characters. If the pickup filename is blank, it is considered invalid, no new file is generated, and the page is output to the file opened previously. 4 5 6 Click OK to remove the Output Information dialog box. Click OK again to remove the Criteria dialog box. Click OK to start the bursting process.
April 2009

For the Report Manager software to successfully load viewable documents, input files must have: An ASCII carriage return <CR> or line feed <LF> at the end of each line. An ASCII form feed <FF> at the end of each page.
Some files, particularly those downloaded from IBM mainframe computers, do not contain ASCII carriage return/line feed control characters. To make these documents Report Manager-compatible, a Conversion Utility is provided with the Report Manager software. This utility removes IBM print characters and adds the necessary ASCII carriage control characters for these files to load into the Report Manager system. This appendix describes how to use the Report Manager Conversion Utility to convert files. This appendix assumes that the Report Manager Conversion Utility has been installed. Note When loading documents with ANSI control-encoded text into the Report Manager software, use the Report Manager Storage Service (SS). SS provides complete ANSI carriage control capabilities, while the Conversion Utility provides only a subset of these features. For more information, refer to Appendix C Storage Service on page 383.
April 2009
Appendix F Conversion Utility Overview
Overview
You can run the Report Manager Conversion Utility as either a foreground or background procedure. As a foreground procedure, the Utility processes one file at a time. See Foreground Operation on page 436. As a background procedure, the Utility processes multiple files in the background while the Report Manager services perform foreground activities. See Background Operation on page 439.
Input and Output Directories

The Report Manager Conversion Utility requires input and output directories. The input directory is where the files to be converted reside. The output directory is where the Report Manager Conversion Utility places the converted files.
The input and output directories can be directories that reside on the Report Manager services or new directories you create. Your only restriction is that the input directory cannot be the Report Manager input directory (typically \PRMLoad). For more information, see Changing File and Rollover Settings on page 390.
Foreground Operation
To run the Report Manager Conversion Utility in the foreground: 1 From the Microsoft Windows Start button on the taskbar, click Programs > FileNet Report Manager Services > Report Manager Ser-
April 2009
Appendix F Conversion Utility Foreground Operation
vices Conversion Utility. The Report Manager Convert Utility screen displays.
On the File menu, click Convert File. An Open dialog box similar to the following displays.
April 2009
Appendix F Conversion Utility Foreground Operation
Either click an input file or type the name of an input file in File name. If you want to click the input file but do not see it, use the Open dialog box to navigate to the subdirectory where the file resides. Click Open. A Save As dialog box similar to the following displays.
April 2009
Appendix F Conversion Utility Background Operation
5 6 7
Select the drive and directory where the converted output file will be saved. Type the output filename in File name and click Save. The input file is converted and placed in the location you specified. To exit the Report Manager Conversion Utility, click Exit on the File menu.
Background Operation
Background operation allows the Report Manager Conversion Utility to automatically convert multiple files in the background while the Report Manager services perform activities in the foreground. With background operation, the Report Manager Conversion Utility converts IBM print control characters in a specified directory to ASCII format, and
April 2009
writes the new file to a specified directory. The output files will have the same name as the input files. To run the Report Manager Conversion Utility in the background, either create a batch file or type a command line entry using the following format: Path to executable\convert.exe /i /o /s In this command line: Path to executable is the path to the Report Manager Conversion Utility. /i is the input path. /o is the output path. /s is an optional sleep timer. If you omit this parameter, the Report Manager Conversion Utility searches every 30 minutes for a file to convert.
The following example shows a sample command line: C:\Program Files\FileNet\RM Services\Bin\convert.exe /i C:\input_area /o C:\PRMLoad\reports /s 10 In this example: The Report Manager Conversion Utility is located in the path C:\Program Files\FileNet\RM Services\Bin. The input directory is C:\input_area. The output directory is C:\PRMLoad\reports.
April 2009
The Report Manager Conversion Utility awakes every 10 minutes and searches for new files in the directory C:\input_area.
When operating the Report Manager Conversion Utility from the command line, the Utility deletes a file from the input directory after converting the file. If the Utility cannot convert a file, it moves the file to the subdirectory \NotFound automatically.
April 2009
Appendix G Troubleshooting Before You Contact Technical Support
Appendix G Troubleshooting
This appendix describes suggestions to follow in the unlikely event you encounter a problem with Report Manager. This appendix also includes technical support information.
Before You Contact Technical Support

Before you contact FileNet technical support with a Report Manager question or problem, please answer the questionbs in the following sections so we can handle your call as efficiently and effectively as possible.
Report Manager Version

1 2 3 What Report Manager server version and patch number are you using? What Report Manager client version patch number are you using? Are you experiencing problems with a new Report Manager installation or an upgrade from a previous version? If an upgrade, what version of Report Manager client and server software did you upgrade from?
Identifying Problems
1 2 What task were you performing when you encountered the problem? Were you ever able to perform this task without problems? Is so, when?
April 2009
Appendix G Troubleshooting Before You Contact Technical Support
3 4 5 6 7 8
Did you encounter the problem on the client, server, or both? Is the problem unique to a single computer, subset of computers, or all computers? Is the problem unique to a particular Windows OS version? When did the problem start? Can you reproduce the problem? If so, what are the steps for reproducing the problem. Are there other applications installed and/or configured on the Report Manager Server? The Report Manager Server is a stand-alone product that might not work properly if other applications are installed on the Report Manager Sever. Are any error tuples occurring? If so, are they occurring on the client and server, or on only on the client or server? Do you receive the message Traffic Services Unavailable message on the client? If so, make sure Traffic Service is running on the Report Manager server.
Note
9 10
SQL and Issues

1 2 Is Microsoft SQL 2000 SP3 installed? Is Windows 4.0 Service Pack 4 installed? Service Pack 4 is required for Report Manager.
April 2009
Appendix G Troubleshooting Solving Problems
Are there any errors shown in the Windows Event Viewer Application Log?
Hardware and Operating System Information

Please provide information about the hardware and operating system on which the Report Manager client and server are running.
Client Server
Operating system version
Windows 2000 Professional with SP4, Windows 2000 Standard and Advanced Server SP4, Windows XP Professional SP2, Windows 2003 Enterprise and Standard Edition Recommended: 256 MB Minimum: 128 MB Recommended: Pentium 233 Mhz Minimum: 166 Mhz
Windows 2000 Standard and Advanced Server SP4, Windows XP Professional SP2, Windows 2003 Enterprise and Standard Edition Recommended: 1GB Minimum: 512 MB Recommended: Pentium 1Ghz Minimum: Pentium 550 Mhz
Amount of memory (RAM) Size of Hard Drive
Solving Problems
The following sections provide suggestions for identifying and resolving Report Manager problems.
Enabling Debugging Tools

The Report Manager PRM_TS.INI, PRM_SS.INI, and PRM_IS.INI configuration files provide debugging tools for displaying Traffic Service, Storage Service, and Index Service problems in the Windows Event Viewer Application Log. To enable these tools, set the Monitor and Debug options under [Events] in each of these configuration files.
April 2009
Please see Appendix H Report Manager Initialization Files on page 459 for a complete list of settings.
Cannot Start Storage or Index Service

Problem: You are unable to start Storage Service or Index Service on the server or the Report Manager Desktop on the client. The Traffic Service is not running.
Open the Service Controller and setup a connection to the Traffic Service. Right-click on stop and click start. You will now be able to connect to the Traffic Service.
Possible Cause: Solution:
Click the Start button in the Windows Taskbar and click Programs > FileNet Report Manager Services > Report Manager Service Controller. Click Traffic Service on the left pane. After Traffic Service starts, you can start the Storage Service or Index Service on the server or the Report Manager Desktop on the client.
Note
You can run the Burst Service, APA Utility, and Conversion utility on the server without having to start Traffic Service first.
April 2009
Storage Service Does Not Process Data

Problem: When you instruct the Storage Service to process data, nothing happens. The data you want to process resides in a location other than the input directory defined in the Storage Service. Either copy the data to the input directory defined in the Storage Service, or click Select Input Directory on the Options menu and specify the directory where the data you want to process resides (see Changing File and Rollover Settings on page 390). Then click the Start button in the Report Manager Storage Service window or click Start Process on the Options menu to process the data.
Possible Cause:
Solution:
April 2009
Possible Cause:
You selected the folder that contains the data you want processed instead of selecting the folder above it. Select the folder above the one that contains the data you want to process. For example, assume you want to load documents in a folder called Chicago that resides under another folder called Charges on drive C. To load the files under Chicago, specify C:\Charges as the input directory. Do not click the Chicago folder within the Records folder; otherwise, Report Manager Storage Service will not load the files in the Charges folder.
Solution:
Note
Also check the system event log for Storage Service errors.
April 2009
Error Message Displays when Storage Services Tries to Load Data

Problem: When you try to load data, an error message displays, telling you there is not sufficient available disk space to process data from the load directory. There is not sufficient available disk space to process data from the load directory. Make sufficient disk space available. If you suspect that your Report Manager configuration might need to be customized, check the settings in the [Configuration] section of your Prm_ss.ini file. For details, see Appendix H Report Manager Initialization Files on page 459.
Possible Cause:
Solution:
Cannot See Documents in the Desktop

Problem: You used Storage Service to load documents, but the documents do not appear in the Desktop. You might not have the correct file date range specified. When documents load, Report Manager assigns a loading date that is one day prior to the day when the documents actually load. For example, if you load documents on May 20, the date range will be May 19. Open the Desktop and use the From control under File Date to specify a day that is at least one day prior to the actual loading date.
Possible Cause:
Solution:
April 2009
Possible Cause:
You might be trying to open a Report, but Statement Documents displays below Type; or you might be trying to open a Statement Documents, but Report Manager Report displays below Type. Under type, select (All Document Types) to view both Reports and Statement Documents.
Solution:
Class Errors
Problem: When using the IDM Services for Report Manager, Report Manager generates the error message 90,0,17 specified class does not exist. A Report Manager class does not exist on IDM Services. On IDM Services, create the proper Report Manager class that matches the class currently defined in the Report Manager configuration files.
April 2009
Rollover Errors
Problem: The Report Manager Rollover function fails and displays the following error message in the Windows Event Viewer Application Log: Function TransferDocumentToWal(could not create WalSegmentList for file E:\PRMStore\g00000nn.lzh) has failed at location 2. E:\PRMStore\g00000nn.lzh: Unable to Write(Add) In the Services file, a line is missing after the nch 32770/udp entry. Enter a carriage return at the end of the line where this entry appears.
Note
These entries are automatically entered when you install Report Manager.
April 2009
Insufficient Hard Drive Space

Problem: You received the error message 3.64 gig minimum space not available on any local magnetic storage. There is not sufficient hard drive space for the combine process to occur. Make drive space available on the drive where the .LZH files reside. Typically, this is the drive where the \PRMStore is located.
Possible Cause:
Solution:
Metacode Troubleshooting
Problem: The error message Line 10 Unknown statement/option MAXFLATRO ignored displays in the REPORT.OUT file when Report Manager tries to load Metacode data. The Flat Text parameter MAXLFLATROWS is improperly spelled in the 0000000.mpd file. Use a text editor, such as WordPad, to open the 0000000.mpd file and correct the parameter name to MAXLFLATROWS. Use Storage Service to reload the Metacode files and verify that the error message no longer appears in the REPORT.OUT.
Possible Cause:
Solution:
Note
Also check the report.out file for AFP and Metacode errors.
April 2009
Error: Invalid input directory: \\<machine name>\PRMLoad while loading documents.

Problem: Solution: When using UNC path name for load directory, it shows error Invalid input directory: \\<machine name>\PRMLoad while loading documents This error can be prevented by sharing the parent drive of load directory and give the path for load directory as \\<machine name >\C$\PRMLoad instead of \\<machine name>\PRMLoad
Error: Unable to connect to the Services Control Manager cannot access <machine name>. Error: Overlapped I/O operation is in progress.
Problem: Solution: Unable to connect to the Services Control Manager cannot access <machine name>. Error: Overlapped I/O operation is in progress This error generally occurs when the password for the services user account has been wrong or changed but not updated. 1. Go to Services Control Manager 2. Select FileNet Report Manager Traffic Service and select properties by right clicking on it. 3. On the properties window, go to the Log On tab and change the password of the services user and click on Apply and then OK. 4. Select FileNet Report Manager Traffic Service again and right-click to bring up the context menu. Click on Start to start the service from the context menu. Follow the same procedure for Storage and Index service also.
April 2009
Blank page adds to busted document

Problem: Solution: After loading a busted document, a blank page gets added to the last document busted. To prevent the blank page addition, perform the following:
While converting the document to be busted, run convert using /C (make sure that it is a capital "C") in command line.
E.g. convert.exe /i C:\<I/P directory1>\convert/o C:\<O/P directory>/s 20<time in minutes> /C
Before loading the busted document, add the following line to PRM_SS.ini config setting:
[Configuration] Delete Blank Page=1
Error: Report loading failed, unexpected exception.

Problem: Solution: Report loading may fail when the system is unable to allocate the required memory to the task. To resolve this you can add "Segment Size" option under Configuration in the prm_ss.ini file, where the upper limit of the Segment Size value is 250,000 Bytes. You can set this according to the available system resources. For more details, refer to Prm_ss.ini File Contents on page 461.
For example: [Configuration] Strip Spaces=1 Segment Size=50000
April 2009
Report Manager Services fail to start when system is rebooted

Problem: When Report Manager server is rebooted, Report Manager services fail to start. The following errors are seen in the event viewer:
Information 10/24/2008 9:54:00 AM MSSQLSERVER SQL Server is now ready for client connections. This is an informational message; no user action is required. Information 10/24/2008 9:54:01 AM ing up database 'tempdb'. MSSQLSERVER Start-
Error 10/24/2008 9:54:03 AM Report Manager Traffic Service Cannot open database "RptMgrDB" requested by the login. The login failed. Error 10/24/2008 9:54:03 AM Service Report Manager Traffic
ODBC Connection Failed Ensure SQL Server is running. Also Check DataSource, UserName, and Password. Information 10/24/2008 9:54:31 AM MSSQLSERVER ing up database 'msdb'. Information 10/24/2008 9:54:31 AM ing up database 'RptMgrDB'. MSSQLSERVER
StartStart-
Information 10/24/2008 9:54:32 AM MSSQLSERVER Recovery is complete. This is an informational message only. No user action is required.
April 2009
Cause:
From the event logs, it is clear that SQL Server 2008 is taking a long time to recover the user defined databases when SQL Server is restarted. Report Manager Traffic service tries to connect to SQL Server and it fails because the database (RptMgrDB) has not yet recovered. Microsoft confirms on behavior of SQL Server 2008 that there is a change in how SQL server 2008 starts in earlier cases (SQL Server 2000/2005) the SQL Server databases used to come online much before the tempdb used to come online. Hence, users could start connecting, however, if they fired any command that needed to use tempdb, those operations failed. Hence, the recovery procedure has been intentionally changed in SQL Server 2008, so that the user databases are brought online only after tempdb is online.
Solution:
As a workaround, users have to manually restart the Report Manager services when system is rebooted. To tackle this issue in Report Manager, RM services should not try to access SQL Server until the recovery process is complete when SQL server is restarted. The APAR PJ35159 is opened for this issue and is being addressed in Report Manager 50a Fix pack 3.
April 2009
Logon failure error for Report Manager services using SQL Server 2008
Problem: Cause: Report Manager services fail to start due to logon failure with RM_USER user. This is due to the security changes in SQL Server 2008. In SQL Server 2000 and SQL Server 2005, any user, who is a member of the Administrative group on the machine hosting SQL Server, used to get access to the SQL Server through the BUILTIN\Administrators group. In SQL Server 2000 and SQL Server 2005, BUILTIN\Administrators, by default, had sysadmin privileges and hence had unrestricted server access. In SQL Server 2008, since the BUILTIN\Administrators group has been removed by default, local administrators cannot gain access to the SQL Server unless BUILTIN\Administrators is manually added, or, the individual users are manually added to the SQL Server. Solution: Before or after installing RM, RM_USER is to be manually added to the SQL Server with sysadmin privileges using SQL Server Management Studio OR The group BUILTIN\Administrators is manually added so that all the local administrators gain the access to SQL server by default
April 2009
RM Services fail to start on a Server with IE7 installed

Problem: Cause: Solution: RM Services fail to start when RM Server is installed on a host where Internet Explorer version 7 (IE7) is installed. This issue occurs because IE7 installation overwrites Report Managers shared memory addresses. There is a mechanism built into SysV to circumvent this issue by changing the starting shared memory address through a registry entry. Please follow the steps below: 1. Close all Report Manager applications and open the windows registry editor by entering "regedit.exe" in the Run dialog box 2. Locate the HKEY_LOCAL_MACHINE\SOFTWARE\FileNet\WAL\CurrentVersion path 3. Right click on Current version and choose New > DWORD Value 4. Change the name of this DWORD value to "StartShmAddress" and doubleclick it to enter a value 5. Click Hexadecimal in the Base area and set Value data to "23000000" 6. Click OK and restart the system.
Note
Report Manager Desktop functionality remains intact with IE7 and the above procedure is not required on a host where RM Desktop is installed.
April 2009
Appendix G Troubleshooting Technical Support
Technical Support
FileNet support agreements let users get the most out of their Report Manager product. Users that have a support agreement with FileNet can obtain on-demand answers to their Report Manager questions and problems by visiting FileNets 24-hour Web site at: www.css.filenet.com The Web site contains the most current information available about Report Manager, as well as information about other FileNet products, and is updated frequently. FileNet support agreements also entitle users to toll-free telephone support, from 5:00 am to 5:00 pm Pacific Time, by calling: 800 624-4877 Extended and after-hours support are also available for customers who require additional assistance. Users who do not have a FileNet support agreement are also encouraged to visit the FileNet Web site to learn about the benefits that are available by purchasing a support agreement. However, technical support and other benefits will not be available until a FileNet support agreement is obtained.
April 2009
Appendix H Report Manager Initialization Files Report Manager Server Files
Appendix H Report Manager Initialization Files

This appendix describes the administrator-configurable entries in the Report Manager server and client initialization files. These files end in the extension.ini. CAUTION The information in this appendix is provided for reference purposes only. Do not change the contents of your Report Manager initialization files unless a FileNet representative instructs you to do so. Moreover, do not change any initialization file parameters not documented in this appendix.
Report Manager Server Files

This section describes the contents of the following Report Manager server files: Prm_ts.ini the Report Manager Traffic Service initialization file. See page Prm_ts.ini File Contents on page 460. Prm_ss.ini the Report Manager Storage Service initialization file. See page Prm_ss.ini File Contents on page 461. Prm_is.ini the Report Manager Index Service initialization file. See page Prm_is.ini File Contents on page 464. Prm_sdm.ini the Report Manager IDM initialization file. See page **Note on page 465.
These files reside in the WINNT directory.

Prm_ts.ini File Contents

The following table describes the user-configurable entries in the Prm_ ts.ini file.
Parameter Description
[Server Config] MaxThreads Indicates the maximum number of concurrent ODBC connections that can be handled. This is directly related to the established SQL server licences. Ten users can share one license (or thread). The default is 8. If present, Traffic Service uses the named pipes protocol to communicate. The default is \pipe\gv,ncacn_np. If present, Traffic Service uses the TCP/IP protocol to communicate. The default is 1500,ncacn_ip_tcp. If present, Traffic Service uses the SPX protocol to communicate. The default is 1000,ncacn_spx. Indicates the number of PRMIdxQueue records collected by Index Service for indexing at any particular time.The valid range of BatchSize is 1 - 10000. For BatchSize <1 or >10000, the BatchSize value would remain 10000 only. The default BatchSize is set to 1000 if key is not created or if the user creates a key and sets any character value. [Events] Monitor Debug RPC Call Indicates whether to turn the Event Viewer processing messages on or off. Turn on these parameters when troubleshooting system problems. 0 = Disables detailed reporting. 1 = Enables detailed reporting. 0 = Do not report debugging events. 1 = Report debugging events. 0 = Disables reporting of RPC call events. 1 = Enables reporting of RPC call events.
Endpoint1 Endpoint2 Endpoint3 BatchSize**
April 2009
Prm_ss.ini File Contents

The following table describes the user-configurable entries in the Prm_ ss.ini file.
[System] RPC_Protocol Indicates the RPC protocol Storage Service uses to communicate with Traffic Service. The sample Prm_ss.ini file contains the following three sets of RPC statements: ncacn_np - for named pipes. ncacn_ip_tcp for TCP/IP (Default setting). ncacn_spx for SPX. Only one RPC protocol, endpoint, and network address statement can be used at a time. If the Prm_ss.ini contains more than one of these statements, the RPC statements not being used must be preceded by a semicolon (;). In the sample Prm_ss.ini file, the statements corresponding to the named pipes and SPX protocols are preceded with a semicolon. RPC_Endpoint Indicates the RPC endpoint. The options are: 1500 (Default setting) \pipe\gv 1000 RPC_DisplayErrors Indicates whether to turn the Event Viewer RPC error messages on or off. 0 = Do not report RPC errors. 1 = Report Metacode errors. [Events] Indicates whether to turn the Event Viewer processing messages on or off. Turn on these parameters when troubleshooting system problems. Zero (0) is the default. 0 = Do not report Storage Service (SS) events. 1 = Report SS events.
Monitor
April 2009
Parameter
Description
Debug AFP Metacode Flat Text [PDF]
0 = Do not report debugging events. 1 = Report debugging events. 0 = Do not report detailed AFP information. 1 = Report detailed AFP information. 0 = Do not report detailed Metacode information. 1 = Report detailed Metacode information. 0 = Do not report flat text events. 1 = Report flat text events. Displays if you install the AFP and/or Metacode services.
Pages Per Segment When AFP and Metacode documents convert to a Report Manager-compatible format, they convert to PDF. This value specifies the maximum number of pages that each PDF segment will contain. These segments are transmitted in their entirety across the network. As a result, a value that is too large (such as one exceeding 250,000 bytes) can affect network traffic adversely. The default is 25. When processing statement documents, you can select statement- or pagelevel security when defining a statement template. If you select statementlevel security, each segment produced contains one entire statement, regardless of the number of pages per segment specified here. If you select page-level security, Report Manager uses this number to determine the number of pages per segment. Work Directory Shows the location of the Report Manager work directory. This is the directory where temporary files are placed as files loaded into the Report Manager system are converted to PDF files. The default is: <drive>:\Program Files\FileNet\RM Services\TMP. Report File Indicates the file where errors are written during APA processing. Specifying an exclamation point in front of this filename overwrites the file contents; otherwise, each converted file appends to any file previously converted. The default is <drive>:\Program Files\FileNet\RM Services\APALogs\Report.out.
April 2009
Parameter
Description
APA Parameter and Shows the location where the APA parameters and font table reside. These Font Table Directory components are used when AFP and Metacode documents convert to a Report Manager-compatible format. The default is: <drive>:\Program Files\FileNet\RM Services\APAParams. Max Chars Per Line The maximum number of characters per line. The default is 1,024. If Report Manager does not find a line feed/carriage return (LF/CR) combination by the time it reaches the number of characters per line specified here, it automatically inserts one. Determines the maximum number of threads used to process files that load into the Report Manager system. The default is 2. Determines the uncompressed segment size (in bytes) for transmitting line data in order to display a single page. The upper limit (and the default) is 250,000 bytes. Any amount greater than this sets the segment size to 250,000 bytes.
[SERVER CONFIG] Max_Threads [CONFIGURATION] Segment Size
April 2009
Prm_is.ini File Contents

The following table describes the user-configurable entries in the Prm_ is.ini file.
[System] RPC_Protocol Indicates the RPC protocol. The sample Prm_ss.ini file contains the following three sets of RPC statements: ncacn_np - for named pipes. ncacn_ip_tcp for TCP/IP (Default setting). ncacn_spx for SPX. Only one RPC protocol, endpoint, and network address statement can be used at a time. If the Prm_ss.ini contains more than one of these statements, the RPC statements not being used must be preceded by a semicolon (;). In the sample Prm_ss.ini file, the statements corresponding to the named pipes and SPX protocols are preceded with a semicolon. RPC_Endpoint Indicates the RPC endpoint. The options are: 1500 (Default setting) \pipe\gv 1000 RPC_DisplayErrors Indicates whether to turn the Event Viewer RPC error messages on or off. 0 = Do not report RPC errors. 1 = Report Metacode errors. [Configuration] [Events] Monitor 0 = Do not report Index Service (IS) events. 1 = Report IS events.
April 2009
Parameter
Description
Debug SleepTime**
0 = Do not report debugging events. 1 = Report debugging events. User can define duration after which Index Service will poll PRMIdxQueue table once it goes to sleep. By default, this duration is set to 300 seconds. The minimum SleepTime accepted by the system is 60 seconds and the maximum, 300 seconds.
**Note
The user will have to manually create this key.
Prm_sdm.ini File Contents

The following table describes the user-configurable entries in the Prm_ sdm.ini file.
[Events] Monitor Debug [OpticalDevices] DefaultOutputDevice Specifies the default optical device. If the default optical device is the IDMIS, this line reads: DefaultOutputDevice=FileNET IMS Otherwise, this line reads: DefaultOutputDevice=File System [FileNET IMS] This section only displays if the IDM Services for Report Manager option has been installed 0 = Report SDM component events. 1 = Do not report SDM components events. 0 = Do not report debugging events. 1 = Report debugging events.
April 2009
Parameter
Description
Enabled
0 = documents will reside on the Windows server only or on an optical drive connected to the Windows server. 1 = documents can be stored on the IDM servers optical drive following rollover and can be cross-cataloged.
Domain Organization Number of Log files Log file path
Specifies the IDM server name. The default is ReportMgr. Specifies the organization name on the IDM server. The default is FileNET. Indicates how many Report Manager log files you want. The default is 10. Specifies the path where the Report Manager log file resides. This file is linked to, and contains Report Manager-specific information from the Windows Application Log. The default is: <drive>:\Program Files\FileNet\RM Services\TMP Indicates the login name used to log in to the IDM server. The default is SysAdmin. Indicates the password used to log in to the IDM server. The default is SysAdmin, which will appear encrypted.
Name Password
April 2009
Parameter
Description
Page Size
Indicates the maximum number of bytes that an IDM page can contain. The default is 100. To ascertain the minimum value you should use for Page Size, divide the size of the archive file (the compressed file that starts with G followed by seven digits) by 9,980. The quotient corresponds to the minimum allowable page size for an IDM page. Your Page Size value should be greater than this quotient.
Note: If the size of an IDM page exceeds the Page Size value mentioned in the prm_sdm.ini file, it is suggested that you re-calculate the Page Size value and set the value in the prm_sdm.ini file. The following technique can be used as a guideline to re-calculate the Page Size for Text and PDF files:
For Text file: Page Size = (G file size * 6)/Pages Per Document For PDF file: Page Size = (G file size * 4)/Pages Per Document where G file size is the maximum size among all the compressed archive files and Pages Per Document is the attribute set in the prm_sdm.ini file. Note that the above is not an absolute formula and is just a guideline. It also does not take IS performance into account. However, if the Page Size still continues to exceed the calculated value then you can increase the multiplier for 'G file size' (beyond 6 for Text file and 4 for PDF file) and re-calculate the Page Size. Pages Per Document Timeout [SYSTEM] Query Timeout Indicates the timeout period for database access for Storage Service and Index Service. Indicates the number of pages that will be contained in an IDMIS document. The range is from 1 to 999. The default is 995. Indicates the default query timeout, in seconds. The default is 60.
*Note
April 2009
The user can modify this value according to preference.

Appendix H Report Manager Initialization Files Report Manager Client File
Report Manager Client File

This section describes the contents of the Report Manager client file, Prmdsk32.ini. This file resides in one of the following subdirectories: WINNT for Windows systems. WINDOWS for Windows 2003 systems. The following table describes the user-configurable entries in the Prmdsk32.ini file.
[PDF] Max Chars Per Line
Displays if you install the optional AFP and/or Metacode Services. The maximum number of characters per line. The default is 1,024. If you want to shorten line lengths in your line data documents, you can decrease this value. Similarly, if you want to increase line lengths (for example, if lines in columnar data are too short), you can increase this value. However, we recommend that you do not set this parameter below 256 or above 1,024. Shows the location of the Report Manager Desktop cache directory. The default is: <drive>:\Program Files\FileNet\RM\PDFCache. The maximum number of PDF documents stored in cache. If this number is exceeded, the first document is overwritten. The default is 20. Modified or default font attributes are used to display documents in desktop based on the value of Savefont. 0 = Default font attributes are used for document display. 1 = Modified font attributes are used for document display. Default value of SaveFont is 1.
Cache Directory Cache Maximum [Defaults] SaveFont***
[Security]
Appendix H Report Manager Initialization Files Report Manager Client File
Parameter
Description
ForceLogon
Determines whether the Report Manager software can log on without displaying the Enter Security Credentials dialog box. This parameter corresponds to the Always Prompt for Logon checkbox in the Configure Logon dialog box. If ForceLogon=1, if the user fails to logon, the Report Manager software closes. If ForceLogon=0 (Default setting), the Report Manager software tries to retrieve user information from the Prmdsk32.ini file. If the Report Manager software cannot log on with the network-supplied information, an Enter Security Credentials dialog box displays with all of the user information the network previously provided. The user must then complete any missing information and click OK. If the Report Manager software fails to log on, it closes.
UseWindowsLogon
This parameter corresponds to the Use Current Windows Logon checkbox in the Configure Logon dialog box and the Report Manager Desktop Logon window. 0 = Do not use Windows logon to log on to Report Manager. 1 = Use Windows logon to log on to Report Manager.
CurrentConnection
0 = Logon to the default Traffic Service. All other numbers let you log on to another Traffic Service connection defined using the Configure Logon dialog box or the Report Manager Desktop Logon window. Each Traffic Service connection you define creates a corresponding section in the Prmdsk32.ini file. For example, creating a second connection creates a [SYSTEM2] section. Therefore, if CurrentConnection=2, Report Manager logs on to the Traffic Service connection defined in the [SYSTEM2] section of the Prmdsk32.ini file.
Show ConnectionBox
This parameter corresponds to the Connection button in the Configure Logon dialog box and the Report Manager Desktop Logon window. 0 = Do not show the connections in the Report Manager Desktop Logon window. 1 = Show the connections in the Report Manager Desktop Logon window.
April 2009
Appendix H Report Manager Initialization Files Report Manager APA Utility File
Parameter
Description
[System] RPC_Protocol Indicates the RPC protocol. The sample Prm_is.ini file contains the following three sets of RPC statements: ncacn_np - for named pipes. ncacn_ip_tcp for TCP/IP (default setting). ncacn_spx for SPX. Only one RPC protocol, endpoint, and network address statement can be used at a time. If the Prm_is.ini contains more than one of these statements, the RPC statements not being used must be preceded by a semicolon (;). In the sample Prm_is.ini file, the statements corresponding to the named pipes and SPX protocols are preceded with a semicolon. RPC_Endpoint Indicates the RPC endpoint. The options are: 1500 (Default setting) \pipe\gv 1000 RPC_Network Address [PDF] Indicates the RPC Report Manager server name in the format: \\<computername>. Displays if you install the AFP and/or Metacode options.
***Note
The user will have to manually create this key. If SaveFont key does not exist, the system will display documents using modified font attributes.
Report Manager APA Utility File

This section describes the contents of the Report Manager APA Utility file, Prm_apa.ini. The parameters in the PDF section are set when you configure the Report Manager APA utility.
April 2009
Appendix H Report Manager Initialization Files Report Manager APA Utility File
Note
Do not modify the GENTEXT section parameters. This file resides in one of the following subdirectories: WINNT for Windows systems. WINDOWS for Windows 2003 systems. The following table describes the entries in the Prm_apa.ini file.
Parameter
Description
[PDF] WorkDirectory Shows the location of the APA utility work directory. The default is: <install path>\\Work. (<install path> is the Report Manager path established at installation.) Pages Per Segment Indicates the number of pages in a segment. Report Manager divides a large document into smaller, more manageable sections or segments.
April 2009

Procedure to be followed by Report Manager Users while migrating IS data
Problem: While attempting to retrieve reports via RM (Report Manager) thick client, it fails with "Page number out of range of pages in a document given to DOC" error message after migrating IS data. While migrating IS data, if a foreign surface is imported then new document IDs are assigned in IS in a sequential order as a result the RM data base and IS data base will not be in sync and users will not be able to view those documents from RM thick client. Since Report Manager relies on the document IDs from IS, the original document ID must be retained when importing RM documents from an IS surface. In order to keep RM and IS in sync while migrating the IS data, user must import the surface that contains the same SSN as the IS server or, the surface must be from a peer system. The user of RM system should not continue rolling over the documents while the IS data migration is in progress, otherwise document ID confliction may occur.
Cause:
Solution:
April 2009
Appendix J Compressed Archive Information
Appendix J Compressed Archive Information

This appendix provides technical information about Report Managers compressed archive structure. Each compressed segment for text files and PDF files contain the following header information: Version File name Pages the page range in the segment (for example, 1-50) Lines a range of report lines in the segment (for example, 1-300)
The Report Manager software uses the information found in the header for quick access to page numbers. When a query is made, the Report Manager software decompresses the header information for each segment, finds the requested page number in the header information, and accesses the appropriate page. After the Report Manager software compresses the last segment of the document, it writes a terminating section to the archive. Note You can decompress the compressed document using a third-party utility such as WinZip.
April 2009
Appendix K IPv6 Support Known Issues and workarounds
Appendix K IPv6 Support

Report Manager is IPv6 complaint from RM5.0a Fix Pack 2 onwards with the issues and workarounds mentioned below. There are some guidelines you should follow when using Report Manager in IPv6 environment, follows:
1 Image Services 4.1.2 FP1 is required for using Report Manager in IPv6 environment. A corresponding ISTK 4.1.2 FP1 should be used with Report Manger which is compatible with IS 4.1.2 FP1 and IPv6 compliant. Earlier versions of ISTK cannot be used. 2 In order to make connections to RM Services, you can use either Link-local IPv6 address or host name. 3 We should always mention Link-local address in local host files of Image Services server and RM Servers. The IP address in the host file of RM Server is as shown below:
fe80::20c:29ff:fe43:3298 v6host3 v6host3-IBM-nch-server
Where fe80::20c:29ff:fe43:3298 is the IPv6 address of the IS Server. v6host3 is the hostname of IS Server.
4 We can verify the successful IPv6 connection to IS by checking the Interface cache file generated at following location in RM server - /fnsw/client/ config/ipv6_if.dat. This file contains Link-local IPv6 address of IS and its interface index.
Known Issues and workarounds

The known issues while using Report Manager in IPv6 environment follow:
April 2009
Cannot add new RM connections using IPv6 address in Windows 2003

Problem:
From Report Manager Service controller, new connection of TS/SS/IS can be added by specifying either the host name or IP address of the machine where these services reside. But in IPv6 environment with windows 2003 server OS, new connections of TS/SS/IS cannot be added by specifying the IPv6 address. The following error occurs when we try to add a connection using the IPv6 address.
Cause
Solution
In Windows 2003 server OS, some components are not made compliant with IPv6 which were causing this issue. Microsoft has confirmed the same. To add new connections in Windows 2003 OS, only host name of the target machine needs to be used rather than the IP address. Note: Adding new connections work fine with both the host name and IP address in Windows 2008 Server OS.
April 2009
Report Manager fails to connect to Image Services Server.

Problem:
Report Manager fails to connect to image services server, resulting in following errors in the windows event viewer:
Logon: SysAdmin has failed to logon to IMS domain (golconda1). Error = 9c00001a: Unable to locate a NCH server for the specified domain. Failed to get the number of connections requested. StorageDeviceMgr failed to connect to Wal. Status returned from system: 80004005.
Cause:
Currently, RM is integrated with ISTK 4.0.0 SP5. When RM is installed, it also installs ISTK 4.0.0 SP5 at RM Installation path. For ex: If RM is installed at C:\Program Files\FileNet\Report Manager\RM Services\Bin, it installs ISTK at. C:\Program Files\FileNet\FNSW. But it writes wrong value to the WAL_ROOT registry key as C:\Program Files\FileNet\FNSW\CLIENTFNSW. Hence, while ISTK is further upgraded, its upgrades at the path C:\Program Files\FileNet\CLIENTFNSW. But while we make connection to IS using ISTK APIs, it is referring to the old path C:\Program Files\FileNet\FNSW instead of the upgraded path C:\Program Files\FileNet\FNSW\CLIENTFNSW. Hence the IS connection is failing.
April 2009
Solution:
As a workaround you need to follow the below steps:

1 Verify if ISTK version is already 4.1.2 FP1. If so, proceed to step 3. If ISTK version installed is lower than 4.1.2 FP1, then proceed to step 2. 2 Upgrade the ISTK to 4.1.2 FP1 which is IPv6 complaint. Now the latest ISTK 4.1.2 FP1 binaries will be available at { WAL_ROOT }\client which is C:\Program Files\FileNet\FNSW\CLIENTFNSW\Client 3 Rename the client folder at default ISTK location i.e C:\Program Files\FileNet\FNSW as client_old 4 Copy the client folder from {WAL_ROOT} i.e C:\Program Files\FileNet\ FNSW\CLIENTFNSW\ to default ISTK installation folder C:\Program Files\FileNet\FNSW\ 5 Edit the {WAL_ROOT} registry key value and correct it to C:\Program Files\FileNet\FNSW. 6 Restart the Traffic Service
The APAR PJ35725 is opened for this issue and is planned to be addressed in upcoming Report Manager major or mod release.
April 2009

FileNet Notice to End User - A Software License is Required Prior to Use. BEFORE COMPLETING INSTALLATION OR USING THIS SOFTWARE, CAREFULLY READ THIS NOTICE. THIS SOFTWARE IS THE PROPRIETARY INTELLECTUAL PROPERTY OF FILENET CORPORATION (OR ITS SOFTWARE SUPPLIERS) AND USE OF ANY PORTION OF THE SOFTWARE IS ONLY PERMITTED IF YOU HAVE A VALID WRITTEN LICENSE AGREEMENT WITH FILENET. You may have a valid FileNet software license agreement if: 1. Your EMPLOYER and FileNet have entered into a written license agreement; or 2. Your EMPLOYER and an authorized FileNet partner have entered into a written license agreement. If you do not have a valid license agreement to use the software, then terminate the installation of this software, promptly delete any FileNet software files from your computer, and return the software media and all other related items to: FileNet Corporation, 3565 Harbor Blvd., Costa Mesa, CA 92626-1420, USA. FileNet only licenses use of Software to end user. Nothing in this Notice or any written license agreement constitutes a sale of the software. FileNet reserves all rights.
April 2009
Notice to U.S. Government of Restricted Rights. The software and documentation are "Commercial Items," as that term is defined at 48 C.F.R. 2.101 (October 1995), consisting of "Commercial Computer Software" and "Commercial Computer Software Documentation," as such terms are used in 48 C.F.R. 12.212 (September 1995) or 48 C.F.R. 227.7202-1 through 72024(June 1995) as applicable. Consistent with 48 C.F.R. 12.212 or 48 C.F.R. 227.7202-1 through 7202-4, as applicable, the Commercial Computer Software and Commercial Computer Software Documentation are being licensed to U.S. Government end users (a) only as Commercial Items, and (b) with only those rights as are granted to all other end users pursuant to the terms and conditions of the applicable software license agreement. Contractor/manufacturer is: FileNet Corporation, 3565 Harbor Blvd., Costa Mesa, California 92626-1420, USA. Unpublished-rights reserved under the copyright laws of the United States.
April 2009

RM 50a SysAdmin Guide

Загружено:

Сведения о документе

Исходное описание:

Авторское право

Доступные форматы

Поделиться этим документом

Поделиться или встроить документ

Параметры публикации

Этот документ был вам полезен?

Это неприемлемый материал?

Авторское право:

Доступные форматы

RM 50a SysAdmin Guide

Загружено:

Авторское право:

Доступные форматы

u

Report Manager System Administrators Handbook

Cross-cataloging with Image Services 29 System Administrator Responsibilities 41

Data Format Requirements Line Printer ASCII Data

Report Manager System Administrators Handbook, Release 5.0a 3

Xerox Metacode Data

Choosing a File Transfer Method Metacode

To load documents 65 Storage Service Processing 66

Report Manager System Administrators Handbook, Release 5.0a 4

Processing ASCII line data

Processing AFP and Metacode Statements

Compressed Archive Structure

Working with Document Templates

Document Storage Profile Report Cataloging Using Document Templates

Using the Document Template Management Dialog Box 92 94

Report Manager System Administrators Handbook, Release 5.0a 5

Completing the Storage Tab Loading Options Reports 100 100

Defining a File Specification Statements 100

Changing the Default Document Storage Profile 123 124

Completing the Statement Tab

Creating Statement Templates

Report Manager System Administrators Handbook, Release 5.0a 6

Creating New Templates

Conditional vs. Unconditional Statement Start Defining Locators Defining Fields

Testing Your Layout

Renaming a Statement Template Changing Statement Preferences

Statement Indexes 187

Report Manager System Administrators Handbook, Release 5.0a 7

Avoiding Multiple Indexing

192 192 196 197 197 198

Defining Index Storage Profiles

AFP and Metacode Issues

Defining a Document Layout Defining Sections in a Document Accessing Layout View

Editing Document Sections

Report Manager System Administrators Handbook, Release 5.0a 8

Copy Forward Value to Null Descendants

Saving a Document Layout 242 Creating Statement Templates 242

Document Form Overlays

Using a Print File Text as a Guide Importing a Form Overlay 245

Matching a Form Overlay with a Document Deleting a Form Overlay 249

The Report Manager Index Index Structure Index Properties

Index Storage Profile

Report Manager System Administrators Handbook, Release 5.0a 9

Index Type Index Fields Data Types

The Indexing Process Cross-Catalog Types

Cross Cataloging (Indexing to Image Services) Cross-Catalog by Index Cross-Catalog by Report

Cross-Catalog by Statement Managing Document Indexes

Report Manager System Administrators Handbook, Release 5.0a

Index Field Requirements Cross-Cataloging Types Cross-Cataloging by Report

Cross-cataloging by Transaction Indexes Cross-Cataloging by Statement

IDM Integrated Security

Report Manager Security Hierarchy

Report Manager System Administrators Handbook, Release 5.0a

Setting Up Report Manager Security Working with Groups 311

Adding Groups to Report Manager Security

Removing Superusers from Report Manager Security

Report Manager System Administrators Handbook, Release 5.0a

Archiving and Rollover

Appendix A - Service Controller

Service Controller Connections

RPC Connection Protocols Adding Connections 361

360 361 362 363

Security and Administrative Rights