Professional Documents
Culture Documents
Reports Management
6.5
Administrators Guide
300-010-538
REV A01
EMC Corporation
Corporate Headquarters:
Hopkinton, MA 01748-9103
1-508-435-1000
www.EMC.com
Contents
Preface.............................................................................................................................. 9
Chapter 1
Introduction
AppXtender Reports Mgmt.............................................................
AppXtender Reports Mgmt Architecture......................................
AppXtender Reports Mgmt Print Stream Processor ............
AppXtender Reports Mgmt Report Processor ......................
AppXtender Reports Mgmt Report Configuration
Administrator.............................................................................
AppXtender Reports Mgmt Report Configuration
Administrator (Reports Only) .................................................
What are Report Files and Print Stream Files? .............................
What are Report Files? ..............................................................
What are Print Stream Files? ....................................................
Processing Different File Types.......................................................
Chapter 2
18
19
20
20
20
21
Chapter 3
14
15
16
17
24
25
26
35
42
Contents
Chapter 4
50
50
51
56
59
60
61
61
63
63
64
65
71
Chapter 5
Contents
Chapter 6
Contents
Chapter 7
Chapter 8
194
196
196
211
214
216
217
218
219
220
223
223
225
226
228
228
235
236
237
239
241
242
243
248
252
254
256
257
257
258
259
260
262
264
264
265
266
267
275
Contents
Chapter 9
Chapter 10
Contents
Preface
Related
Documentation
Preface
CAUTION
A caution contains information essential to avoid data loss or
damage to the system or equipment. The caution may apply to
hardware or software.
IMPORTANT
An important notice contains information essential to operation of
the software. The important notice applies only to software.
10
Preface
11
Preface
12
1
Introduction
Introduction
14
15
20
21
13
Introduction
14
Introduction
15
Introduction
AppXtender Reports
Mgmt Print Stream
Processor
Table 1
Conversion Output
Non-standard ASCII
Standard ASCII
EBCDIC
Standard ASCII
EBCDIK
Standard ASCII
16
Introduction
types. Source specifications indicate the location and file name masks
of print stream files. Print stream types specify necessary parameters
for processing print stream files. At the end of a successful process, a
PDF or standard ASCII file is created and placed into a specified
directory. Following a successful conversion, the source file may be
deleted, renamed, or moved to a new location for archival purposes.
During this conversion process, the AppXtender Reports Mgmt Print
Stream Processor generates one or two logs. For AFP, Metacode, and
PCL print stream file conversions, the processor generates a detailed
conversion log. For all print stream file conversions, including
EBCDIC, EBCDIK, and nonstandard ASCII, the processor generates a
message log, to indicate a success or failure. In addition, the
AppXtender Reports Mgmt Print Stream Processor creates a
system-level message log.
You may monitor the processing of print stream files by viewing the
generated conversion log, message log, and the system log in the
AppXtender Reports Mgmt Report Configuration Administrator. For
instructions on viewing these logs, see Monitoring the Print Stream
Processor.
AppXtender Reports
Mgmt Report
Processor
17
Introduction
AppXtender Reports
Mgmt Report
Configuration
Administrator
18
Introduction
AppXtender Reports
Mgmt Report
Configuration
Administrator
(Reports Only)
19
Introduction
A print stream file is output that would normally be destined for the
printer but has been diverted to a computer file instead.
You can use the AppXtender Reports Mgmt Print Stream Processor to
convert AFP, Metacode, PCL, EBCDIC, EBCDIK, and non-standard
ASCII print stream files. The AppXtender Reports Mgmt Report
Processor can in turn, process these converted files.
Although the term print stream usually has a broader meaning, this
documentation uses the term to refer to only those files that can be
processed by the AppXtender Reports Mgmt Print Stream Processor.
20
Introduction
Then You
Processor
Input
Output
AppXtender Reports
Mgmt Print Stream
Processor
AppXtender Reports
Mgmt Report Processor
21
Introduction
AFP
Metacode
PCL
Non-standard ASCII
EBCDIC
EBCDIK
AppXtender Reports Mgmt
Print Stream Processor
PDF
Standard ASCII
Indexed Documents
Uploaded to AppXtender
Figure 1
22
Records Exported to
a File for Business
Intelligence Applications
2
Installing
ApplicationXtender
Reports Management
23
Note: To determine the operating system version, service pack, and physical
memory available for Windows, from the Start menu, select Run. In the Open
text box, type winver. Click OK.
24
25
Configuring the
Service Account
3. On the domain, make sure the account that you want to configure
as the AppXtender Reports Mgmt service account has the Log on
as a service advanced right.
For instructions, see Adding Advanced Rights to the
AppXtender Reports Mgmt Service Account.
Note: This step must be performed on the domain because the rights for
a user on the domain override the rights for the same user on the
computer on which AppXtender Reports Mgmt is installed.
26
Creating the
AppXtender Reports
Mgmt Service
Account
Figure 2
5. Expand the System Tools tree item, and then expand Local Users
and Groups.
6. Right-click Users, and select New User. The New User dialog box
appears.
27
Figure 3
28
Adding the
AppXtender Reports
Mgmt Service
Account to
Administrators Group
Figure 4
29
Figure 5
6. Click Advanced and then click Find Now. The advanced view of
the Select Groups dialog box appears.
Figure 6
2. Open the Local Security Settings console. From the Start menu,
select Programs, then Administrative Tools. From the
Administrative Tools program group, choose Local Security
Policy.
The Local Security Settings console appears.
Figure 7
3. Expand the Local Policies folder, and then select User Rights
Assignment. All user rights should appear in the right-side pane
of the Local Security Settings Console.
The AppXtender Reports Mgmt Service Account
31
Figure 8
Figure 9
32
Figure 10
Figure 11
33
9. Click Find Now. The Search results panel appears. Select the
account you created to use as the AppXtender Reports Mgmt
service account and then click OK.
10. Close the Local Security Settings console.
Your Windows service account for the AppXtender Reports
Mgmt services can now be used during AppXtender Reports
Mgmt installation.
34
35
Figure 12
36
Figure 13
37
Figure 14
38
Figure 15
C:\ERMX\PS Working
C:\ERMX\RP Working
39
Figure 16
40
10. Click Next after entering desired account credentials. The Ready
to Install page appears.
Figure 17
Figure 18
41
Figure 19
Uninstalling
AppXtender Reports
Management
42
CAUTION
Restart your computer before installing the latest release of
AppXtender Reports Mgmt.
For more information, see Preparing to Install AppXtender Reports
Mgmt.
43
44
3
Using
ApplicationXtender
Reports Management
46
50
61
63
71
45
What Happens to a
Print Stream File
Table 4
46
The following table describes the sequence of events that begin when
you place a print stream file that matches the specified file name
mask in the source directory.
What Happens to a Print Stream File
Event
Example
Table 4
Event
Example
47
What Happens to a
Report File
Table 5
48
The following table describes the sequence of events that begin when
you place a report file that matches the specified file name mask in
the source directory. This sequence of events includes the upload of
indexed documents to AppXtender.
What Happens to a Report File
Event
Example
Table 5
Event
Example
49
50
Reports Mgmt to extract a set of index values from your reports and
export this data in a format that can be used in business intelligence
applications.
AppXtender Reports Mgmt Report Processor
(extraction procedure
written in XDS)
Report
Report Pages
AppXtender Document
Storage Location
1 2
3 4
1 2
3 4
Index
Record 1
Index
Record 2
Figure 20
AppXtender Database
Understanding
Propagation of
Index Values
51
Forward-propagating Value
Non-propagating Value
Backward-propagating Value
Figure 21
In other words, the index value for the report's header must be
propagated forward until the next report's header occurs. The index
value for each subsection's header must be propagated forward until
the next subsection header occurs. The index value for each
subsection's total must be propagated backward until the previous
subsection total occurs. The unique values are not propagated at all.
52
Report
F1
F2
Index Record 1
F1 F2 N1 N2 B1 B2
N1 N2
N3 N4
B1
B2
Figure 22
Using Propagation
Levels
F1 F2 N3 N4 B1 B2
Index Record 2
53
Forward-propagating
SHOULD be Forward-propagated
Invoice #
13579
Page#
1
Customer#
111
Invoice #
14703
Page#
(blank)
Customer#
222
Invoice #
24680
Page#
2
Customer#
333
Address
88 Byte St. 20817
Address
(blank)
Total
Total
Total
Backward-propagating
Non-propagating
Figure 23
In this example, you would want to use no level setting (default) for
Page #, level 1 for Invoice #, and level 2 for Customer # and Address.
54
Index Field
Example 1
Example 2
Example 3
Page #
Invoice #
13579
14703
24680
Customer #
111
222
333
Address
55
Using Different
Indexing Options
Associate with each index record only the page of the report that
contains the non-propagated index values. For information, see
Minimizing the Pages Associated with each Document.
If you disable both the Group pages by index option and the
Combine pages by forward propagated values option, AppXtender
Reports Mgmt associates with each index record only the pages of the
report that contain the non-propagated index values.
In the following figure, the Account # field and the Amount field are
the non-propagated index fields. The page from which the account
number and amount were extracted for each record is associated with
that record.
56
The Date field is forward propagated, and the date value was
extracted from a separate page, so that page is not associated with the
index records.
Index Records
Account#
Date
Amount
123456
2000/01/01
$41.50
123456
2000/01/01
$41.50
Report
Report
Page 2
Page 5
111113
$20.00
111116
$20.00
123456
$41.50
123456
$41.50
111114
$20.00
111117
$20.00
111115
$40.00
111118
$40.00
Figure 24
57
extracted from a separate page, so that page is not associated with the
index record.
Index Record
Account#
123456
Date
2000/01/01
Amount
$41.50
Report
Report
Page 2
Page 5
111113
$20.00
111116
$20.00
123456
$41.50
123456
$41.50
111114
$20.00
111117
$20.00
111115
$40.00
111118
$40.00
Figure 25
58
Index Record
Account#
123456
Date
2000/01/01
Amount
$41.50
Report
Report
Page 1
Figure 26
Page 2
2000/01/01
111116
$20.00
111113
$20.00
123456
$41.50
111114
$20.00
111117
$20.00
111115
$40.00
111118
$40.00
Compressing Report
Files for Storage
59
Important
Information about
Extracting Dates
Table 7
Example
MM-YY-DD
05-9206
MMM-YY-DD
MAY-9206
YY-MM-DD
92-0506
YY-DD-MMM
92-06MAY
CAUTION
If, while processing a report file, AppXtender Reports Mgmt
extracts a date that does not set apart the year (for example,
059206) and attempts to upload the indexed report to an
AppXtender application that has one of these date formats, the date
field will not be populated.
60
HIPAA Compliance
Support
61
62
Configuring
AppXtender Reports
Mgmt for Print
Stream Files
63
4. Create a report type for the set of report files that you want to
process. For instructions, see Creating a New Report Type.
5. Make sure the propagation of index fields is appropriate for the
structure of the report files.
For instructions, see Changing Index Field Propagation.
6. Create extraction procedures.
For instructions, see Creating a New Procedure.
7. You can use XDS Visual Tester to test these procedures.
For instructions, see Using XDS Visual Tester.
8. Create at least one source specification for the report type. For
instructions, see Specifying a Source for a Report Type.
9. Create at least one source specification for the print stream type.
You can specify the source directory for the report type as the
output directory for the print stream type.
For instructions, see Specifying a Source for a Print Stream
Type.
10. Place the files that you want to convert in the print stream source
directory.
The AppXtender Reports Mgmt Print Stream Processor processes
the files according to the current print stream type configuration
and source specifications for the print stream type.
If you have specified the source directory for the report type as
the output directory for the print stream type, then the
AppXtender Reports Mgmt Report Processor immediately
processes the files according to the current report type
configuration, procedures, index field propagation settings, and
source specifications for the report type.
Configuring
AppXtender Reports
Mgmt for Report
Files
64
3. Create a report type for the set of report files that you want to
process. For instructions, see Creating a New Report Type.
4. Make sure the propagation of index fields is appropriate for the
structure of the report files. For instructions, see Changing Index
Field Propagation.
5. Create extraction procedures. For instructions, see Creating a
New Procedure.
6. You can use XDS Visual Tester to test these procedures. For
instructions, see Using XDS Visual Tester.
7. Create at least one source specification for the report type. For
instructions, see Specifying a Source for a Report Type.
8. Place the files that you want to process in the report source
directory.
The AppXtender Reports Mgmt Report Processor processes the
files according to the current report type configuration,
procedures, index field propagation settings, and source
specifications.
Configuring
AppXtender Reports
Mgmt for Business
Intelligence
Applications
65
66
Figure 27
Original Reports
Original Reports
Indexed Documents
in AppXtender
Indexed Documents
in AppXtender
Indexed Documents
in AppXtender and Exported File
(both simultaneously)
67
In each case, consider using XDS Visual Tester to test each report type
before using it in a production environment. For instructions, see
Recommended Method of Testing Procedures and Using XDS
Visual Tester.
Uploading Indexed
Documents to
AppXtender and
Exporting a File for
Business Intelligence
Analysis from Original
Reports
68
69
70
71
72
4
ApplicationXtender
Reports Management
Configuration Admin
Introduction ........................................................................................
Opening the AppXtender Reports Mgmt Configuration Admin
Using the AppXtender Reports Mgmt Configuration Admin ....
Transferring AppXtender Reports Mgmt Configuration Data....
Using Help ..........................................................................................
AppXtender Reports Mgmt Configuration Properties.................
74
75
76
84
87
88
73
Introduction
The AppXtender Reports Mgmt Configuration Admin allows you to
configure all aspects of your AppXtender Reports Mgmt system.
With it, you can manage the AppXtender Reports Mgmt Print Stream
Processor, the AppXtender Reports Mgmt Report Processor,
AppXtender data sources, print stream types, report types, index
fields, data fields, and procedures.
The configuration procedures you perform with the AppXtender
Reports Mgmt Configuration Admin determine how AppXtender
Reports Mgmt processes reports, extracts index records, uploads
indexed documents to AppXtender, and exports data for use in
business intelligence applications.
This chapter helps you to start using the AppXtender Reports Mgmt
Configuration Admin.
74
Figure 28
75
Report Types
Content Repositories
Report Processors
Figure 29
76
AppXtender Reports
Mgmt Configuration
Admin Application
Setup for Web
Access
Application
Using a Web browser, you can access the AppXtender Reports Mgmt
Configuration Admin from a computer on which this utility is not
installed.
The following sections describe how to prepare for and then use the
ApplicationXtender Reports Management Configuration Admin
remotely:
Terminal Services
77
78
Figure 30
2. Enter the host machine name and then click Connect. You see a
Windows login window.
3. Enter your user name and password just as you would on the
host computer.
4. Open the AppXtender Reports Mgmt Configuration Admin. If
another instance is already running, a message box appears. You
must close the original instance of the utility before attempting to
open another one remotely.
CAUTION
You can only access one instance of the AppXtender Reports
Mgmt Configuration Admin from the same host computer.
Make sure you close the instance on the host computer before
attempting to open another instance remotely.
79
Navigating the
AppXtender Reports
Mgmt Configuration
Admin Application
Expanding and
Collapsing Nodes
Displaying the
Contents of a Node
You can display the contents of each node in the tree structure.
To display the contents of a node, click the node or press the up or
down arrow key until the node is highlighted.
The contents of the selected node appear in the right pane.
Navigating up One
Level
Figure 31
Figure 32
80
The AppXtender
Reports Mgmt
Configuration
Admin Toolbar
Figure 33
CAUTION
Not all of the toolbar buttons appear at all times. The buttons that
appear depend on the node that is selected.
The following table describes each button on the AppXtender
Reports Mgmt Configuration Admin toolbar:
Table 8
Button
Description
Back
Forward
Allows you to retrace your steps forward. This button is available only when
you have already used the Back button to retrace your steps backward.
Up One Level
Selects the node up one level from the currently selected node. This button
is not available when the AppXtender Reports Mgmt Configuration node
(the root node of the AppXtender Reports Mgmt Configuration Admin tree
structure) is selected.
Show/ Hide
Tree
Refresh
Refreshes the selected list of print stream type, report type, or processor
logs. For more information, see Monitoring the Report Processor and
Monitoring the Print Stream Processor.
Delete
Deletes the selected print stream type, report type, procedure, or source
specification. This button is available only when one of those items is
selected.
81
Table 8
Button
Customizing the
Application
Table 9
82
Description
Properties
Displays the Properties dialog box for the selected print stream type, report
type, procedure, index field, data field, source specification, or one of many
other configuration items. The Properties dialog box allows you to view or
modify properties for the selected item. This button is available only when
one of those items is selected.
Export List
Displays the Save As dialog box for the selected item. The Save As dialog
box allows you to export information about the selected item.
Help
Customization
Instructions
Table 9
Customization
Instructions
83
CAUTION
The AppXtender Reports Mgmt Configuration Transfer utility does
not also install AppXtender Reports Mgmt. AppXtender Reports
Mgmt must already be installed on the destination server before
you import it there.
For more information, see:
84
Exporting
Configuration Data
Figure 34
85
Importing
Configuration Data
Figure 35
3. In the File Path box, enter or select the file path where you placed
AppXtenderReportsMgmtConfig.zip when you exported it. The
default paths of each component of the AppXtender Reports
Mgmt configuration data appear in the dialog box.
4. Click Start. When the import is complete,
AppXtenderReportsMgmtConfig.zip is created in the specified
directory and you see a message box indicating that the import
was successful.
5. Click Exit to end the import process.
86
Using Help
You can view AppXtender Reports Mgmt Online Help from within
the AppXtender Reports Mgmt Configuration Admin or from the
Windows Start menu.
When you access Help from within AppXtender Reports Mgmt
Configuration Admin, the topic that appears is context-sensitive.
That is, the topic should be relevant to the node that you have
selected or the dialog box that you have displayed.
To view AppXtender Reports Mgmt Online Help from within the
AppXtender Reports Mgmt Configuration Admin, right-click a node
you need more information on and select Help.
To view AppXtender Reports Mgmt Online Help from the Windows
Start menu:
1. From the Windows Start menu, select Programs > AppXtender
Reports Mgmt.
2. You have the following choices:
If you want to view Online Help for the AppXtender Reports
Mgmt Configuration Admin, select AppXtender Reports
Mgmt Help from the AppXtender Reports Mgmt program
group.
If you want to view Online Help for the XDS scripting
language, select XDS Reference from the AppXtender Reports
Mgmt program group.
Using Help
87
Viewing Information
about AppXtender
Reports Mgmt
Configuring
AppXtender Reports
Mgmt Licensing
88
Figure 36
89
Figure 37
Feature
Description
Servers
AFP Options
METACODE Options
PCL Options
PDF Options
90
Changing the
AppXtender Reports
Mgmt Configuration
Data Directory
CAUTION
Changing the AppXtender Reports Mgmt Configuration Data
directory changes settings in the AppXtender Reports Mgmt
Configuration Admin.
To change the AppXtender Reports Mgmt Configuration Data
directory:
1. In the AppXtender Reports Mgmt Configuration Admin, open
the AppXtender Reports Mgmt Configuration Properties dialog
box by right-clicking the AppXtender Reports Mgmt
Configuration node and selecting Properties. The AppXtender
Reports Mgmt Configuration Properties dialog box appears.
Note: If the Configuration Data Directory text box is unavailable
(read-only), you must close the Properties dialog box, collapse all
nodes in the tree, close the AppXtender Reports Mgmt
Configuration Admin, and reopen the AppXtender Reports Mgmt
Configuration Admin. When you open the Properties dialog box
again, you can edit the value in the Configuration Data Directory
text box.
2. Click the Configuration Server tab.
91
Figure 38
3. In the Configuration Data Directory text box, type the path to and
the name of the directory that you want to use as the AppXtender
Reports Mgmt Configuration Data directory.
4. Click OK. The contents of the AppXtender Reports Mgmt
Configuration Admin change to reflect the configuration
information present in the new directory.
Note: If you want to continue using the configuration information that
was stored in the old Configuration Data directory, you must copy or
move the contents of the old directory (all subdirectories and files) to the
new Configuration Data directory.
92
5
Managing AppXtender
Data Sources
Introduction ........................................................................................ 94
About Content Repositories ............................................................. 96
Viewing Existing AppXtender Data Sources ................................. 98
Preparing AppXtender Reports Mgmt Servers as AppXtender
Database Clients................................................................................. 99
Linking to AppXtender Data Sources ........................................... 117
Modifying an Existing Data Source............................................... 131
Removing an AppXtender Data Source........................................ 133
Support for AppXtender Data Features........................................ 134
93
Introduction
When the AppXtender Reports Mgmt Report Processor processes a
report, it uploads documents to AppXtender according to the
AppXtender information specified in the report type, such as the data
source.
If you are not familiar with data source concepts, see About Content
Repositories.
The following sections describe how to manage AppXtender data
sources in the AppXtender Reports Mgmt Configuration Admin:
This chapter assumes that the AppXtender database has already been
created. (For best performance, make sure the AppXtender database
is on a computer other than the one where AppXtender Reports
Mgmt is installed.)
94
Introduction
95
96
IBM DB2
Oracle
97
Figure 39
98
99
Preparing
AppXtender Reports
Mgmt Servers as
IBM DB2 Database
Clients
CAUTION
DB FixPack 3 is required to connect to an IBM DB2 v.8.2
database.
You must install the IBM DB2 Client on each AppXtender Reports
Mgmt server computer that you need to register with the
AppXtender database.
On the client workstation where you plan to locate an IBM DB2 data
source, install the IBM DB2 Administrative Client according to the
instructions provided in the IBM DB2 documentation. The default
installation settings are sufficient for use with AppXtender.
CAUTION
If you install your IBM DB2 client files outside the program files
directory, you must use global credentials for your data source
resource authentication credentials in AppXtender Admin.
100
To locate an IBM DB2 data source for a client workstation, you must
first use the IBM DB2 Administrative Client you installed to create a
connection to the IBM DB2 database on the IBM DB2 server.
To configure a connection to the IBM DB2 database:
1. On the client workstation where you plan to locate an IBM DB2
data source, select Start > Programs > IBM DB2 > Set-up Tools >
Configuration Assistant to start the IBM DB2 Configuration
assistant. The Configuration Assistant dialog box appears.
Figure 40
101
Figure 41
IBM DB2 Add Database Wizard - Select How You Want to Set Up a
Connection Page
3. Enable the Search the network option and click Next. The Select a
database from the network search result page appears.
Figure 42
102
IBM DB2 Add Database Wizard - Select a Database from the Network
Search Result Page
4. Under the appropriate folder, expand the node for the IBM DB2
Server where the AppXtender database is located. Expand the
DB2 node for that server (where DB2 is the instance under which
the database was created), then expand the Local databases node
under the DB2 node. Select the appropriate database and click
Next. The Specify a nickname for the database page appears.
Figure 43
IBM DB2 Add Database Wizard - Specify a Nickname for the Database
Page
5. Click Next to accept the default as the Database alias for the
database. The Register this database as a data source page
appears.
103
Figure 44
6. Enable the Register this database for ODBC check box. Verify that
As system data source is enabled and that the correct database
name is displayed in the Data Source Name text box.
7. Click Finish. An ODBC data source is created for IBM DB2 on the
client workstation.
Preparing
AppXtender Reports
Mgmt Servers as
Oracle Database
Clients
CAUTION
If you install your Oracle client files outside the program files
directory, you must use global credentials for your data source
resource authentication credentials in AppXtender Admin.
104
If you install your Oracle client files outside the program files
directory, you must use global credentials for your data source
resource authentication credentials.
Configuring Oracle
Clients
Each version of Oracle has two network interfaces that allow Oracle
tools running on network workstations and servers to access, modify,
share, and store data on other servers. Both components guide you
through the configuration of the network environment.
To set up AppXtender data sources for Oracle databases, you must
install one of these components on each client workstation and use it
to configure the client workstation. For more information, see the
following sections:
105
7. Type a service name. (This is the server name that you will specify
when you create an AppXtender data source.)
106
Preparing
AppXtender Reports
Mgmt Servers as
Sybase SQL
Anywhere
Database Clients
Installing Sybase
Clients
Figure 45
For all AppXtender Reports Mgmt server computers that you register
with the AppXtender database, the Sybase Network Client software
must be installed. This comes with the Sybase SQL Anywhere
product CD; ensure the Network Database Client is selected during
installation.
107
Creating an ODBC
Data Source for
Sybase SQL Anywhere
Figure 46
108
Figure 47
4. On the ODBC tab, enter a data source name. You can also enter a
description. Click the Login tab.
Figure 48
109
5. On the Login tab, select the Supply user ID and password option.
In the User ID and Password text boxes, type the sysop user
name and password. (This is the user account that you created in
Sybase Central for the AppXtender database. The first time you
start an AppXtender component, the password for the user name
sysop is xscm.)
6. Click the Database tab.
Figure 49
7. In the Server name text box, type the server name you specified
when you started your Sybase network database server (the
server name that you specified using the n option).
8. In the Database name text box, specify the database name (the
database name that you specified using the n option).
Note: If you have only one database started in your server, you can leave
the Database name field empty. If you have more than one database
started in the database server, you must specify the database name.
110
9. Click the Network tab. On the Network tab, choose the network
protocols that are supported by your Sybase network database
server (the network protocols that you specified using the -x
option).
Figure 50
10. Click the ODBC tab. On the ODBC tab, you can perform a test
connection by clicking Test Connection. Click OK. The data
source is created. In the ODBC Data Source Administrator, click
OK.
111
Preparing
AppXtender Reports
Mgmt Servers as
MySQL Database
Clients
Creating an ODBC
Data Source for
MySQL
Figure 51
112
Figure 52
113
5. On the Connect Options tab, either leave the Port text box blank
(so that 3306 will be used) or specify 3306.
Figure 53
Preparing
AppXtender Servers
as Microsoft Access
Database Clients
114
115
Figure 54
4. In the Data Source Name text box, enter a name for the data
source. In the Description text box, you can enter a description for
the data source.
5. Click Select. The Select Database dialog box appears. Navigate to
the Microsoft Access database file (MDB) that you want to use.
Click OK. The database file that you specified is indicated next to
Database.
6. Click OK. The ODBC Microsoft Access Setup dialog box closes.
The new Microsoft Access ODBC data source is listed under User
Data Sources in the ODBC Data Source Administrator.
7. Click OK. The ODBC Data Source Administrator closes.
116
Note: You can only add AppXtender data sources in AppXtender Admin.
Once you add them, you can connect to them and configure them from
within AppXtender Reports Mgmt Configuration Admin.
117
Linking to an SQL
Server Database
Figure 55
118
Figure 56
5. From the Server Name list, select the server on which you placed
your SQL Server database. In the User Name and Password text
boxes, type the sysop user name and password. (These are the
administrator login values that you created in SQL Server for the
AppXtender database. The first time you start AppXtender, the
password for the user name sysop is xscm.) Select the
AppXtender database name from the Select Database list.
Note: If you do not check the Allow saving password option, you must
use a database schema.
119
Linking to an IBM
DB2 Database
Figure 57
120
Figure 58
121
Linking to an Oracle
Database
Figure 59
122
Figure 60
5. In the Server Name text box, enter the Net Service Name that you
configured in Net Manager or Net Configuration Assistant. In the
User Name and Password text boxes, type the sysop user name
and password. (These are the administrator login values that you
created for the AppXtender table space. The first time you start an
AppXtender component, the password for the user name sysop is
xscm.)
6. You can test the connection between AppXtender and the
database by clicking Test Connection.
7. Click OK.
After you have created the connection to the database, the data
source appears in the AppXtender Reports Mgmt Configuration
Admin data source list.
123
Linking to a Sybase
Database
Figure 61
124
Figure 62
5. From the Use data source name list, select the Sybase data source
that you created in ODBC Administrator. In the User Name and
Password text boxes, type the sysop user name and password.
(The first time you start AppXtender, the password for the user
name sysop is xscm.)
6. You can test the connection between AppXtender and the
database by clicking Test Connection.
7. Click OK.
After you have created the connection to the database, the data
source appears in the AppXtender Reports Mgmt Configuration
Admin data source list.
125
Linking to a MySQL
Database
Figure 63
126
Figure 64
5. From the Use data source name list, select the MySQL data source
that you created in ODBC Administrator.
6. In the User Name and Password text boxes, type the sysop user
name and password. (These are the administrator login values
that you created for the AppXtender table space. The first time
you start an AppXtender component, the password for the user
name sysop is xscm.)
7. You can test the connection between AppXtender and the
database by clicking Test Connection.
8. Click OK.
After you have created the connection to the database, the data
source appears in the AppXtender Reports Mgmt Configuration
Admin data source list.
127
Linking to a
Microsoft Access
Database
Figure 65
128
Figure 66
129
Figure 67
130
OLE DB Provider
131
Table 12
OLE DB Provider
Note: If you are using a database schema, do not check the Allow saving
password option or the Blank password option. (Schema is supported
only for SQL Server, IBM DB2, and Oracle databases.)
132
CAUTION
If you remove a data source from the list in the AppXtender
Reports Mgmt Configuration Admin, it is completely removed
from the computer on which AppXtender Reports Mgmt is
installed. If you have AppXtender installed on the same computer,
a removed data source is no longer listed in the AppXtender Data
Source Selector dialog box. Also, removal or renaming of an
AppXtender data source may cause malfunction during report
processing if a report type is referring to that data source.
133
Configuring Volume
Label Search
Drive(s)
134
Configuring Max
Future Years
135
136
6
Configuring Print Stream
Types
Introduction ......................................................................................
Print Stream Type Configuration Glossary ..................................
Creating a New Print Stream Type................................................
Modifying Print Stream Type Properties......................................
Deleting a Print Stream Type..........................................................
138
139
140
189
192
137
Introduction
This section describes how to use the AppXtender Reports Mgmt
Configuration Admin to manage print stream types. A print stream
type is a set of parameters that define how AppXtender Reports
Mgmt processes a set of print stream files of a particular type.
The AppXtender Reports Mgmt Print Stream Processor converts
these print stream files into PDF or standard ASCII report files. You
can then use the AppXtender Reports Mgmt Report Processor to
extract index information from the report files.
Note: AppXtender Reports Mgmt has two view options, AppXtender
Reports Mgmt Configuration Admin and AppXtender Reports Mgmt Report
Configuration. Both options allow access to the Report Processor, but only
AppXtender Reports Mgmt Configuration Admin allows access to the Print
Stream Processor. This section applies to the AppXtender Reports Mgmt
Configuration Admin view.
If the report files from which you want to extract index information
are in AFP, Metacode, PCL, EBCDIC, EBCDIK, or non-standard
ASCII format, you must create print stream types. Later, you may
need to change the properties of a print stream type, rename a print
stream type, or even delete a print stream type. The following
sections describe these print stream type management procedures.
138
Term
Definition
CRLF
Form definition
Form definition resources define the size of the page, the initial fonts being used, and
the overlays that are automatically included on the page.
Line data
Line data is input data that consists only of text and CRLF characters.
Page definition
Page definition resources define how the line data will be placed on the page.
PSF
Standard ASCII
The AppXtender Reports Mgmt Report Processor can extract index information from
ASCII files that use carriage return line feed for each line break and use form feed
carriage return line feed for each page break.
Although the term standard ASCII has other meanings in other programs, this
documentation uses the term to refer to only to those ASCII files that can be
processed by the AppXtender Reports Mgmt Report Processor.
139
Note: Before you can use the AppXtender Reports Mgmt Print Stream
Processor to process the set of print stream files represented by the new print
stream type, you must create at least one source specification for the print
stream type. For instructions, see Specifying a Source for a Print Stream
Type.
140
The print stream type creation wizard allows you to create new print
stream types.
To start the print stream type creation wizard:
1. In the AppXtender Reports Mgmt Configuration Admin,
right-click the Print Stream Types node and select New Print
Stream Type. The New Print Stream Type dialog box appears.
Figure 68
2. From the Source Format drop-down list, select the format of the
print streams that you want to process. The following table lists
your choices.
Table 14
If the Print Streams That You Want to Process Are This Format
Select This
IBM AFP
Note: Line data and mixed mode files that print on AFP printers through PSF are
supported, as well as fully composed MO:DCA-P files. The AFP parser does not support
the output of PSF (IPDS).
AFP
Non-standard ASCII
ASCII
EBCDIC
EBCDIC
EBCDIK
EBCDIK
Metacode
PCL
141
3. Click OK. The print stream type creation wizard appears. The
first page of the wizard is always the Main page, but the wizard
varies depending on the source format that you chose. The
following table refers you to the appropriate section for
instructions on each format.
Table 15
Format
See
AFP
ASCII
EBCDIC
EBCDIK
Metacode
PCL
Figure 69
142
The AFP print stream type creation wizard allows you to create new
print stream types for IBM AFP format print streams that you want to
process.
The Main page of the AFP print stream wizard allows you to
configure the general parameters of the print stream type.
143
Note: Even if you disable the Delete Temporary Files option, CFG files
will be deleted along with LOG files when the amount of time you
specify in the Purge Log Files after text box has elapsed.
4. In the Start Page text box, specify the page number on which you
want the conversion to start. The default value for this text box is
0 (zero), which causes the AppXtender Reports Mgmt Print
Stream Processor to start converting the file at page 1.
5. In the End Page text box, specify the page number of the last page
you want to convert. The default value for this text box is 0 (zero),
which causes the AppXtender Reports Mgmt Print Stream
Processor to finish converting the file at the last page.
Note: If you want to process the entire file, accept the default value of 0
(zero) in both the Start Page text box and the End Page text box.
6. In the Purge Log Files after text box, specify the amount of time
that you want to elapse before AppXtender Reports Mgmt can
delete the LOG and CFG files related to a process, to save space.
7. Specify whether you want fonts to be rasterized. You have the
following choices.
If you are testing the parameters for a print stream type and
you want to create the closest output to the original print
stream file, enable the Rasterize Fonts option. The
AppXtender Reports Mgmt Print Stream Processor creates a
bitmap image of the file being converted, from which the
AppXtender Reports Mgmt Report Processor cannot extract
index information. Use this option only for testing.
If you want the AppXtender Reports Mgmt Report Processor
to be able to extract index information from the AppXtender
Reports Mgmt Print Stream Processor output, disable the
Rasterize Fonts option.
144
Position
Description
Word
The AppXtender Reports Mgmt Print Stream Processor sets each blank-delimited text string
(word) absolutely on the page. This position is recommended because each word becomes
a field from which index information can be extracted later. However, this position requires
more resources to execute and produces slightly less efficient output. Access to the AFP font
files is required for this option.
Relative
The AppXtender Reports Mgmt Print Stream Processor uses relative positioning by setting
the first character in the line or phrase at the absolute position and then use relative moves
across the line. Each line or phrase becomes a field from which index information can be
extracted later.
This position converts the AFP as written but can produce undesirable output if the font
metrics of the original AFP font and the corresponding output font do not exactly match. This
works well for AFP documents using Core Interchange Fonts.
9. Take note of the value in the Resource Path text box. The Resource
Path for a print stream type is the directory in which the
AppXtender Reports Mgmt Print Stream Processor finds
information it needs to convert the print stream files into PDF
files.
The Resource Path for a print stream type is based on the
AppXtender Reports Mgmt Configuration data directory and the
name of the print stream type.
10. Click Next. The Input Parameters page appears. For instructions,
see Configuring the AFP Wizard Input Parameters Page.
145
Figure 70
The Input Parameters page of the AFP print stream wizard allows
you to specify the input parameters of the AFP print stream files that
you want to process.
146
147
Figure 71
Most AFP print stream files use the same file formats. If necessary,
you can use the File Formats page of the AFP print stream wizard to
specify different file format parameters for the AFP print stream files
that you want to process.
148
Figure 72
2. Under Record Formats, select the format of the print stream file.
The following table describes each format.
Table 17
Format
Description
BDW
File contains IBM Block Descriptor Words. This is equivalent to MVS Variable Block
datasets (recfm=VB).
RDW
File contains Record Descriptor Words. This is equivalent to MVS Variable datasets
(recfm=V).
MVS FTP
CRLF
File contains hex 0D0A carriage return/line feed bytes at the end of each record. (This
option is recommended for line data.)
LF
File contains Length Fields in front of each record. If you select LF (length field), the Length
Field Options become active.
149
CAUTION
If the AFP files that you want to process contain Length Fields in
front of each record, consider enabling the Use Default Format
option instead of the LF option. Length fields in AFP files are
considered to be always 2-byte inclusive, which is the setting used
when you enable the Use Default Format option. The Length Field
Options are provided only for the rare occurrence of AFP files that
do not have 2-byte inclusive length fields. Use caution when
selecting these options.
3. If you have selected F (Fixed length), specify the length in the text
box next to the F (Fixed length) option.
4. If you have selected LF (length field), you have the following
choices.
You must specify whether your length field is Inclusive or
Exclusive.
You must specify whether your length field is MSB/LSB,
LSB/MSB, ASCII decimal, or EBCDIC decimal.
You must specify whether your length field is 2 bytes or 4
bytes long.
5. Under Coding Format, select the encoding scheme of your input
data if needed due to translation during file transfer. The
recommended setting is None.
6. Click Next. The Resource Paths page appears. For instructions,
see Viewing the AFP Wizard Resource Paths Page.
150
Figure 73
The Resource Paths page of the AFP print stream wizard allows you
to view the resource paths for the print stream type that you are
creating. The AppXtender Reports Mgmt Print Stream Processor
searches in the resources directory for particular files while
processing the print stream files.
151
152
Resource
Description
If the AppXtender Reports Mgmt Print Stream Processor detects a file with
the PDE extension in the resources directory, the processor uses it as a
page definition file.
If the AppXtender Reports Mgmt Print Stream Processor detects a file with
the FDE extension in the resources directory, the processor uses it as a
form definition file.
If the AppXtender Reports Mgmt Print Stream Processor detects a file with
the PSG extension in the resources directory, the processor uses it as a
page segment file.
If the AppXtender Reports Mgmt Print Stream Processor detects a file with
the OVR extension in the resources directory, the processor uses it as a
page overlay file.
If the AppXtender Reports Mgmt Print Stream Processor detects a file with
the FNT extension in the resources directory, the processor uses it as an
actual font file.
CP to ISO (CP2ISO.TAB)
Table 18
Resource
Description
ACIF (ACIF.FIL)
153
Figure 74
The Output Parameters page of the AFP print stream wizard allows
you to configure the PDF output of the AppXtender Reports Mgmt
Print Stream Processor for the print stream type that you are creating.
Option
Description
Auto
The page is rotated so the majority of words on the page reads from left-to-right. Auto is
recommended.
Portrait
The page is rotated so the height of the image is greater than the width.
Landscape
The page is rotated so the width of the image is greater than the height.
Inverse
The page is flipped upside down along the Y axis. The Inverse check box is available if
you select Portrait or Landscape.
2. Under Scale By, specify the scale. This setting determines the size
of the resulting page. A scale percentage of 100 is standard. To
reduce the image size of each page by half use 50. The default is
100.
154
3. Under Image DPI, specify the size of your output image in dots
per inch (DPI). The default is 0 (zero).
If you specify the default setting of 0 (zero), the DPI of the
image will be the same as in the input.
If you specify a lower value than 0 (zero), the image in the PDF
file is a smaller byte size but looks the same if viewed on the
page, at 100%. The image in the PDF file has lower resolution
than the input, so lower image quality becomes apparent
when zooming in or printing.
4. Under Offset, specify how many pels (pixels) you want to move
the entire logical page image in relation to the physical page. The
following table indicates how to move the logical page in each
direction (in relation to the physical page).
Table 20
Specify This
To the right
A positive value
X Position
To the left
A negative value
X Position
Up
A positive value
Y Position
Down
A negative value
Y Position
155
7. Take note of the path and file name mask specified in the AFM
File Path text box. This path is where the AFM (Adobe Font
Metrics) files can be found. AFM files contain character widths
information for Type 1 fonts.
8. Take note of the path and file name mask specified in the PFB File
Path text box. This path is where the PFB (Postscript Font Bitmap)
files can be found.
9. Click Finish. The new print stream type is listed in the
AppXtender Reports Mgmt Configuration Admin.
Note: Before you can use the AppXtender Reports Mgmt Print Stream
Processor to process the set of print stream files represented by the new
print stream type, you must create at least one source specification for the
report type. For instructions, see Specifying a Source for a Print Stream
Type.
Figure 75
156
The ASCII print stream type creation wizard allows you to create new
print stream types for ASCII format print streams that you want to
process.
The Main page of the ASCII print stream wizard allows you to
configure the general parameters of the print stream type.
157
Note: Even if you disable the Delete Temporary Files option, CFG
files will be deleted along with LOG files when the amount of time
you specify in the Purge Log Files after text box has elapsed.
4. In the Start Page text box, specify the page number on which you
want the conversion to start. The default value for this text box is
0 (zero), which causes the AppXtender Reports Mgmt Print
Stream Processor to start converting the file at page 1.
5. In the End Page text box, specify the page number of the last page
you want to convert. The default value for this text box is 0 (zero),
which causes the AppXtender Reports Mgmt Print Stream
Processor to finish converting the file at the last page.
Note: If you want to process the entire file, accept the default value of 0
(zero) in both the Start Page text box and the End Page text box.
6. In the Purge Log Files after text box, specify the amount of time
that you want to elapse before AppXtender Reports Mgmt can
delete the LOG and CFG files related to a process, to save space.
7. Click Next. The Input Parameters page appears. For instructions,
see Configuring the ASCII Wizard Input Parameters Page.
Configuring the ASCII
Wizard Input
Parameters Page
Figure 76
158
The Input Parameters page of the ASCII print stream wizard allows
you to specify the input parameters of the ASCII print stream files
that you want to process.
159
Figure 77
The EBCDIC print stream type creation wizard allows you to create
new print stream types for EBCDIC format print streams that you
want to process.
The Main page of the EBCDIC print stream wizard allows you to
configure the general parameters of the print stream type.
160
4. In the Start Page text box, specify the page number on which you
want the conversion to start. The default value for this text box is
0 (zero), which causes the AppXtender Reports Mgmt Print
Stream Processor to start converting the file at page 1.
5. In the End Page text box, specify the page number of the last page
you want to convert. The default value for this text box is 0 (zero),
which causes the AppXtender Reports Mgmt Print Stream
Processor to finish converting the file at the last page.
Note: If you want to process the entire file, accept the default value of 0
(zero) in both the Start Page text box and the End Page text box.
6. In the Purge Log Files after text box, specify the amount of time
that you want to elapse before AppXtender Reports Mgmt can
delete the LOG and CFG files related to a process, to save space.
161
Figure 78
162
Figure 79
The EBCDIK print stream type creation wizard allows you to create
new print stream types for EBCDIK format print streams that you
want to process.
The Main page of the EBCDIK print stream wizard allows you to
configure the general parameters of the print stream type.
163
4. In the Start Page text box, specify the page number on which you
want the conversion to start. The default value for this text box is
0 (zero), which causes the AppXtender Reports Mgmt Print
Stream Processor to start converting the file at page 1.
5. In the End Page text box, specify the page number of the last page
you want to convert. The default value for this text box is 0 (zero),
which causes the AppXtender Reports Mgmt Print Stream
Processor to finish converting the file at the last page.
Note: If you want to process the entire file, accept the default value of 0
(zero) in both the Start Page text box and the End Page text box.
164
6. In the Purge Log Files after text box, specify the amount of time
that you want to elapse before AppXtender Reports Mgmt can
delete the LOG and CFG files related to a process, to save space.
7. Click Next. The Input Parameters page appears. For instructions,
see Configuring the EBCDIK Wizard Input Parameters Page.
Configuring the
EBCDIK Wizard Input
Parameters Page
Figure 80
165
Note: Before you can use the AppXtender Reports Mgmt Print Stream
Processor to process the set of print stream files represented by the new
print stream type, you must create at least one source specification for the
report type. For instructions, see Specifying a Source for a Print Stream
Type.
Metacode Print
Stream Type
Creation Wizard
Configuring the
Metacode Wizard
Main Page
Figure 81
The Metacode print stream type creation wizard allows you to create
new print stream types for Xerox Metacode format print streams that
you want to process.
The Main page of the Metacode print stream wizard allows you to
configure the general parameters of the print stream type.
166
4. In the Start Page text box, specify the page number on which you
want the conversion to start. The default value for this text box is
0 (zero), which causes the AppXtender Reports Mgmt Print
Stream Processor to start converting the file at page 1.
167
5. In the End Page text box, specify the page number of the last page
you want to convert. The default value for this text box is 0 (zero),
which causes the AppXtender Reports Mgmt Print Stream
Processor to finish converting the file at the last page.
Note: If you want to process the entire file, accept the default value of 0
(zero) in both the Start Page text box and the End Page text box.
6. In the Purge Log Files after text box, specify the amount of time
that you want to elapse before AppXtender Reports Mgmt can
delete the LOG and CFG files related to a process, to save space.
7. Specify whether you want fonts to be rasterized. You have the
following choices:
If you are testing the parameters for a print stream type and
you want to create the closest output to the original print
stream file, enable the Rasterize Fonts option. The
AppXtender Reports Mgmt Print Stream Processor creates a
bitmap image of the file being converted, from which the
AppXtender Reports Mgmt Report Processor cannot extract
index information. Use this option only for testing.
If you want the AppXtender Reports Mgmt Report Processor
to be able to extract index information from the AppXtender
Reports Mgmt Print Stream Processor output, disable the
Rasterize Fonts option.
168
Position
Description
Word
The AppXtender Reports Mgmt Print Stream Processor sets each blank-delimited text
string (word) absolutely on the page. This position is recommended because each word
becomes a field from which index information can be extracted later. However, this
position requires more resources to execute and produces slightly less efficient output.
Access to the Xerox font files is required for this option.
Relative
The AppXtender Reports Mgmt Print Stream Processor uses relative positioning by
setting the first character in the line or phrase at the absolute position and then use
relative moves across the line. Each line or phrase becomes a field from which index
information can be extracted later.
This position converts the Metacode as written but can produce undesirable output if the
font metrics of the original Xerox font and the corresponding output font do not exactly
match.
9. Take note of the value in the Resource Path text box. The Resource
Path for a print stream type is the directory in which the
AppXtender Reports Mgmt Print Stream Processor finds
information it needs to convert the print stream files into PDF
files. The Resource Path for a print stream type is based on the
AppXtender Reports Mgmt Configuration data directory and the
name of the print stream type.
10. Click Next. The Input Parameters page appears. For instructions,
see Configuring the Metacode Wizard Input Parameters Page.
169
Configuring the
Metacode Wizard
Input Parameters
Page
Figure 82
170
Note: The IDEN string can be specified for true Metacode files when
JDL/JDE resources are not available, but this option is not
recommended. For truest output, use Start via JDE/JDL so that the
JSL options are invoked.
Shading Options
Shading Options
Description
Light
This level is the default. (Xerox printers tend to print lighter than other brands.)
Normal
This level duplicates the Xerox shade percentages. This level can be too dark,
depending on the printer used.
Unshaded
This level removes shading from the output file. This level can speed processing
and reduce the size of the output file.
3. If you need to adjust the page offset, enable the Override Default
Origin option. In the X Origin and Y Origin text boxes, set the X
and Y coordinates of your selected origin to be used instead of the
default. This can effect how line data aligns with forms.
4. From the LD Method drop-down list, select Previous. This is the
standard method for line data spacing.
5. From the CC Tran drop-down list, select the method for
translating carriage controls. The following table describes each
of your choices:
Table 23
Method
Description
Best
None
No translation occurs.
A2E
E2A
JSL
171
Figure 83
172
Most Metacode print stream files use the same file formats. If
necessary, you can use the File Formats page of the Metacode print
stream wizard to specify different file format parameters for the
Metacode print stream files that you want to process.
Figure 84
173
4. Under Record Formats, select the format of the print stream file.
The following table describes each format:
Table 24
Format
Description
BDW
File contains IBM Block Descriptor Words. This is equivalent to MVS Variable Block
datasets (recfm=VB).
RDW
File contains Record Descriptor Words. This is equivalent to MVS Variable datasets
(recfm=V).
MVS FTP
CRLF
File contains hex 0D0A carriage return/line feed bytes at the end of each record. (This
option is recommended for line data.)
All records in file are the same length. If you select F (Fixed length), a text box next to
this option becomes available.
LF
File contains Length Fields in front of each record. If you select LF (length field), the
Length Field Options become available.
Metabar
Select this option to recognize data normally routed through a BARR protocol converter
to a Xerox printer.
5. If you have selected F (Fixed length), specify the length in the text
box next to the F (Fixed length) option.
6. If you have selected LF (length field), you have the following
choices.
You must specify whether your length field is Inclusive or
Exclusive.
You must specify whether your length field is MSB/LSB,
LSB/MSB, ASCII decimal, or EBCDIC decimal.
You must specify whether your length field is 2 bytes or 4
bytes long.
7. Click Next. The Resources Paths page appears. For instructions,
see Viewing the Metacode Wizard Resource Paths Page.
174
Viewing the
Metacode Wizard
Resource Paths Page
Figure 85
The Resource Paths page of the Metacode print stream wizard allows
you to view the resource paths for the print stream type that you are
creating. The AppXtender Reports Mgmt Print Stream Processor will
search in these locations for particular files while processing the print
stream files.
Resource
Description
175
Table 25
Resource
Description
176
Configuring the
Metacode Wizard
Output Parameters
Page
Figure 86
Option
Description
Auto
The page is rotated so the majority of words on the page reads from left-to-right. Auto is
recommended.
Portrait
The page is rotated so the height of the image is greater than the width.
Landscape
The page is rotated so the width of the image is greater than the height.
Inverse
The page is flipped upside down along the Y axis. The Inverse check box is available if you
select Portrait or Landscape.
2. Under Scale By, specify the scale. This setting determines the size
of the resulting page. A scale percentage of 100 is standard. To
reduce the image size of each page by half use 50. The default is
100.
177
3. Under Image DPI, specify the size of your output image in dots
per inch (DPI). The default is 0 (zero).
If you specify the default setting of 0 (zero), the DPI of the
image will be the same as in the input.
If you specify a lower value than 0 (zero), the image in the PDF
file is a smaller byte size but looks the same if viewed on the
page, at 100%. The image in the PDF file has lower resolution
than the input, so lower image quality becomes apparent
when zooming in or printing.
4. Under Offset, specify how many pels (pixels) you want to move
the entire logical page image in relation to the physical page. The
following table indicates how to move the logical page in each
direction (in relation to the physical page):
Table 27
Specify This
To the right
A positive value
X Position
To the left
A negative value
X Position
Up
A positive value
Y Position
Down
A negative value
Y Position
178
7. Take note of the path and file name mask specified in the AFM
File Path text box. This path is where the AFM (Adobe Font
Metrics) files can be found. AFM files contain character widths
information for Type 1 fonts.
8. Take note of the path and file name mask specified in the PFB File
Path text box. This path is where the PFB (Postscript Font Bitmap)
files can be found.
9. Click Finish. The new print stream type is listed in the
AppXtender Reports Mgmt Configuration Admin.
Note: Before you can use the AppXtender Reports Mgmt Print Stream
Processor to process the set of print stream files represented by the new
print stream type, you must create at least one source specification for the
report type. For instructions, see Specifying a Source for a Print Stream
Type.
Figure 87
The PCL print stream type creation wizard allows you to create new
print stream types for HP PCL format print streams that you want to
process.
The Main page of the PCL print stream wizard allows you to
configure the general parameters of the print stream type.
179
180
Note: Even if you disable the Delete Temporary Files option, CFG files
will be deleted along with LOG files when the amount of time you
specify in the Purge Log Files after text box has elapsed.
4. In the Start Page text box, specify the page number on which you
want the conversion to start. The default value for this text box is
0 (zero), which causes the AppXtender Reports Mgmt Print
Stream Processor to start converting the file at page 1.
5. In the End Page text box, specify the page number of the last page
you want to convert. The default value for this text box is 0 (zero),
which causes the AppXtender Reports Mgmt Print Stream
Processor to finish converting the file at the last page.
Note: If you want to process the entire file, accept the default value of 0
(zero) in both the Start Page text box and the End Page text box.
6. In the Purge Log Files after text box, specify the amount of time
that you want to elapse before AppXtender Reports Mgmt can
delete the LOG and CFG files related to a process, to save space.
7. Next to Position, specify how you want words to be set in the
output PDF file. The recommended position is Word. The
following table describes each of your choices:
Table 28
Position
Description
Word
The AppXtender Reports Mgmt Print Stream Processor sets each blank-delimited text
string (word) absolutely on the page. This position is recommended because each word
becomes a field from which index information can be extracted later. However, this position
requires more resources to execute and produces slightly less efficient output. Access to
the PCL font metrics files is required for this option.
Relative
The AppXtender Reports Mgmt Print Stream Processor uses relative positioning by setting
the first character in the line or phrase at the absolute position and then use relative moves
across the line. Each line or phrase becomes a field from which index information can be
extracted later.
This position converts the PCL as written but can produce undesirable output if the font
metrics of the original PCL font and the corresponding output font do not exactly match.
Native
The AppXtender Reports Mgmt Print Stream Processor creates a bitmap image of the file
being converted, from which the AppXtender Reports Mgmt Report Processor cannot
extract index information. This option creates the closest output to the original print stream
file. Use this option only for testing.
181
8. Take note of the value in the Resource Path text box. The Resource
Path for a print stream type is the directory in which the
AppXtender Reports Mgmt Print Stream Processor finds
information it needs to convert the print stream files into PDF
files. The Resource Path for a print stream type is based on the
AppXtender Reports Mgmt Configuration data directory and the
name of the print stream type.
9. Click Next. The Input Parameters page appears. For instructions,
see Configuring the PCL Wizard Input Parameters Page..
Configuring the PCL
Wizard Input
Parameters Page
Figure 88
The Input Parameters page of the PCL print stream wizard allows
you to specify the input parameters of the PCL print stream files that
you want to process.
182
183
Figure 89
The Resource Paths page of the PCL print stream wizard allows you
to view the resource paths for the print stream type that you are
creating. The AppXtender Reports Mgmt Print Stream Processor will
search in these locations for particular files while processing the print
stream files.
184
Resource
Description
If the AppXtender Reports Mgmt Print Stream Processor detects a file with
the FNT extension in the resources directory, the processor uses it as an
external PCL fonts file.
If the AppXtender Reports Mgmt Print Stream Processor detects a file with
the DAT extension in the resources directory, the processor uses it as a
typeface metrics data file.
If the AppXtender Reports Mgmt Print Stream Processor detects a file with
the TFM extension in the resources directory, the processor uses it as a
typeface metrics fonts file.
Table 29
Resource
Description
The AppXtender Reports Mgmt Print Stream Processor provides the binary
typeface metrics file, TFMBIN.DAT, in the 8
installation directory. By default, this directory is C:\PROGRAM
FILES\XTENDERSOLUTIONS\CONTENT MANAGEMENT. You
must copy this file to the resources directory.
Figure 90
The Output Parameters page of the PCL print stream wizard allows
you to configure the PDF output of the AppXtender Reports Mgmt
Print Stream Processor for the print stream type that you are creating.
185
Option
Description
Auto
The page is rotated so the majority of words on the page reads from left-to-right. Auto is
recommended.
Portrait
The page is rotated so the height of the image is greater than the width.
Landscape
The page is rotated so the width of the image is greater than the height.
Inverse
The page is flipped upside down along the Y axis. The Inverse check box is available if you
select Portrait or Landscape.
2. Under Scale By, specify the scale. This setting determines the size
of the resulting page. A scale percentage of 100 is standard. To
reduce the image size of each page by half use 50. The default is
100.
3. Under Image DPI, specify the size of your output image in dots
per inch (DPI). The default is 0 (zero).
If you specify the default setting of 0 (zero), the DPI of the
image will be the same as in the input.
If you specify a lower value than 0 (zero), the image in the PDF
file is a smaller byte size but looks the same if viewed on the
page, at 100%. The image in the PDF file has lower resolution
than the input, so lower image quality becomes apparent
when zooming in or printing.
186
4. Under Offset, specify how many pels (pixels) you want to move
the entire logical page image in relation to the physical page. The
following table indicates how to move the logical page in each
direction (in relation to the physical page):
Table 31
Specify This
To the right
A positive value
X Position
To the left
A negative value
X Position
Up
A positive value
Y Position
Down
A negative value
Y Position
7. Take note of the path and file name mask specified in the AFM
File Path text box. This path is where the AFM (Adobe Font
Metrics) files can be found. AFM files contain character widths
information for Type 1 fonts.
8. Take note of the path and file name mask specified in the PFB File
Path text box. This path is where the PFB (Postscript Font Bitmap)
files can be found.
187
188
The print stream type Properties dialog box allows you to view or
change all of the parameters of an existing print stream type except
the source format and the print stream type name. For instructions on
renaming a print stream type, see Renaming a Print Stream Type.
To open the Properties dialog box for a print stream type:
1. In the AppXtender Reports Mgmt Configuration Admin, select
the Print Stream Types node. Configured print stream types are
listed in the right pane.
2. Right-click the print stream type for which you want to modify
properties and select Properties. The Properties dialog box
appears for the selected print stream type. The Main tab is active
by default. Each tab of the properties dialog box corresponds to a
page of the print stream type creation wizard.
189
Figure 91
190
Renaming a Print
Stream Type
Once a print stream type has been created, you can rename it.
To change the name of a print stream types:
1. In the AppXtender Reports Mgmt Configuration Admin, select
the Print Stream Types node. Configured print stream types are
listed in the right pane.
2. Right-click the print stream type that you want to rename and
select Rename.
3. Type the new name. Press <ENTER>. The name is changed.
191
CAUTION
When a print stream type is deleted, all of the parameters that have
been specified for that print stream type are permanently lost. The
set of print stream files represented by a deleted print stream type
cannot be processed until you use the print stream type creation
wizard to create another print stream type for that set of print
stream files.
To delete a print stream type:
1. In the AppXtender Reports Mgmt Configuration Admin, select
the Print Stream Types node. Configured print stream types are
listed in the right pane.
2. Right-click the print stream type that you want to delete and
select Delete. A message appears confirming whether you would
like to delete the print stream type.
3. Click Yes. The print stream type is deleted.
192
7
Configuring Report
Types
Introduction ......................................................................................
Managing Report Types ..................................................................
Managing Index Fields....................................................................
Managing Data Fields .....................................................................
Managing Procedures......................................................................
Using XDS Visual Tester..................................................................
194
196
217
223
228
241
193
Introduction
A report type is a set of parameters and scripts that define how
AppXtender Reports Mgmt processes a set of report files. This
chapter describes how to use the AppXtender Reports Mgmt
Configuration Admin to configure and manage report types, index
fields, data fields, and procedures. This configuration determines
how AppXtender Reports Mgmt processes reports, extracts index
records, uploads indexed documents to AppXtender, and exports
data for business intelligence purposes.
Note: AppXtender Reports Mgmt has two view options, AppXtender
Reports Mgmt Configuration and AppXtender Reports Mgmt Report
Configuration. Both views allow access to the Report Processor, but only
AppXtender Reports Mgmt Configuration Admin allows access to the Print
Stream Processor. Since this section involves only the report processor, it
applies to either view.
194
Introduction
195
Creating a New
Report Type
The report type creation wizard allows you to create a new report
type.
For more information, see:
196
The report type creation wizard allows you to create new report
types.
Note: Before you start the report type creation wizard, make sure the
AppXtender application to which you intend to upload documents has been
created. For information on creating an AppXtender application, see the
ApplicationXtender Core Components Administrators Guide.
The Main page of the report type creation wizard allows you to name
the report type, provide a description for the report type, specify the
format of the report type, and specify a sample file.
197
Figure 92
198
3. From the Format list, select the format of the set of reports that
you want to process as the new report type. You have the
following choices:
From the Format list, select ASCII.
From the Format list, select PDF.
In the Report Sample File text box, you can enter the name of a
sample file. Keep in mind that the sample file you specify is the
file on which you will base the procedures that extract index
information from your reports. You can browse for a file by
clicking the Browse button.
Figure 93
Browse Button
The Database page of the report type creation wizard allows you to
specify the AppXtender data source to which you want index
information to be uploaded and the account information that
AppXtender Reports Mgmt must use to access the AppXtender data
source.
199
Figure 94
200
The Upload page of the report type creation wizard allows you to
specify the AppXtender application to which you want index
information to be uploaded. On this page, you can also configure
how you want the indexed documents to be added to the
AppXtender application and specify the number of errors that you
want AppXtender Reports Mgmt to tolerate.
Figure 95
201
Table 32
202
Indexing Options
Option
Description
During each session, this option groups together pages with exactly
the same index information. If this option is enabled, all pages that
share all of their index values will be grouped together as one
document in AppXtender. Pages need not be consecutive to be
grouped together.
The Group pages by index option and the Combine pages by forward
propagated values option are mutually exclusive. For more
information about this option, see Using Different Indexing Options.
Uploading Options
Option
Description
Transaction rollback
203
Configuring the
Storage Page
Figure 96
The Storage page of the report type creation wizard allows you to
configure how you want AppXtender Reports Mgmt to store indexed
documents in the AppXtender application.
204
Compression Method
Compression Method
Description
Speed
No Compression
Largest
Fastest
Speed
Second Largest
Second Fastest
Size
Smallest
Slowest
Second Smallest
Second Slowest
205
Figure 97
The Processing page of the report type creation wizard allows you to
specify processing time limits and launch a custom script if the report
processing fails.
206
207
Where:
ReportType = String with report type name
InstanceID = String with report instance identifier
MessageLogText = String that contains the Message Log text
(restricted to 4K)
For more information about scripting in AppXtender Reports
Mgmt, see the ApplicationXtender Reports Management Scripting
Users Guide.
5. Click Next. The B.I. Gateway tab appears. For instructions, see
Configuring the B.I. Gateway Page.
Configuring the B.I.
Gateway Page
The B.I. Gateway page of the report type creation wizard allows you
to configure the B.I. gateway feature, which allows you to export data
to a business intelligence application. The settings on this page do not
affect the upload of indexed documents to AppXtender.
For an overview of the configurations necessary to export files for use
in business intelligence applications, see Configuring AppXtender
Reports Mgmt for Business Intelligence Applications.
Figure 98
208
209
Figure 99
After you have used the report type creation wizard, the new report
type is listed in the AppXtender Reports Mgmt Configuration
Admin.
210
Note: Before you can use the AppXtender Reports Mgmt Report Processor
to process the set of report files represented by the new report type, you must
create extraction procedures, make sure the propagation of index fields is
appropriate for the structure of the report files, and create at least one source
specification for the report type. For instructions, see Creating a New
Procedure, Changing Index Field Propagation and Specifying a Source
for a Report Type.
Modifying Report
Type Properties
Once a report type has been created, you can view or change any of
its properties. For instructions, see the following section:
The Report Type Properties dialog box allows you to view or change
all of the parameters of an existing report type except the report type
name. (For instructions on renaming a report type, see Renaming a
Report Type.)
1. In the AppXtender Reports Mgmt Configuration Admin, expand
the Report Types node.
2. Right-click the report type for which you want to modify
properties and select Start update. The report type's icon changes
from blue to red to indicate that the corresponding configuration
file has been locked against the AppXtender Reports Mgmt
Report Processor and unlocked for editing.
3. Right-click the report type for which you want to modify
properties and select Properties. The Properties dialog box
appears for the selected report type. The Main tab is forward by
default. Each tab of the properties dialog box corresponds to a
page of the report type creation wizard.
211
Figure 100
212
213
If you have specified a sample report for a report type, you can view
this report in the AppXtender Reports Mgmt Configuration Admin.
Note: In order to view PDF reports in Report View, you must install Adobe
Acrobat Reader on the same computer as AppXtender Reports Mgmt.
The following sections describe the features that you can use in
Report View:
Viewing an ASCII
Sample Report
214
To Navigate
Do the Following
Toolbar Buttons
To a particular page
Note: You can use the keyboard to navigate the Report View for an ASCII
sample report. Press the <TAB> key until the First Page, Previous Page, Next
Page, or Last Page button is selected and then press the <SPACEBAR>.
215
Deleting a Report
Type
If necessary, you can delete a report type that you no longer need.
CAUTION
When a report type is deleted, all of the parameters, extraction
procedures, and index field propagation settings that have been
configured for that report type are permanently lost. The set of
report files represented by a deleted report type cannot be
processed until you create another report type, create the extraction
procedures, and configure the index field propagation settings for
that set of report files.
To delete a report type:
1. In the AppXtender Reports Mgmt Configuration Admin, expand
the Report Types node.
2. Right-click the report type that you want to delete and select Start
update. The report type's icon changes from blue to red to
indicate that the corresponding configuration file has been locked
against the AppXtender Reports Mgmt Report Processor and
unlocked for editing.
3. Right-click the report type that you want to delete and select
Delete. A message appears confirming whether you want to
delete the report type.
4. Click Yes. The report type is deleted.
216
Checking the Index Field List describes how to make sure the
list of index fields in the AppXtender Reports Mgmt
Configuration and AppXtender Reports Mgmt Report
Configuration utilities for a report type is accurate.
217
If you want to make sure the list of index fields in the AppXtender
Reports Mgmt Configuration Admin for a report type is accurate,
you can check it against the index field definitions in the AppXtender
application.
Also, if the Format and Required columns are empty for any of the
listed index fields, you can display this information by checking the
list of index fields in AppXtender Reports Mgmt against the index
field definitions in the AppXtender application. However, displaying
this information in not required to allow the AppXtender Reports
Mgmt Report Processor to process reports.
To check the index fields with the database:
1. In the AppXtender Reports Mgmt Configuration Admin, expand
the Report Types node.
2. Expand the node for the report type in which you want to check
the index field list.
3. Right-click Data Fields and select Check Fields With Database.
AppXtender Reports Mgmt checks if the index fields currently
listed in the AppXtender Reports Mgmt Configuration Admin
match the index field definitions in the AppXtender application.
The fields that do not match are marked by a question mark.
Figure 101
If question marks do appear and you know that the list is correct,
consider each of the following:
218
If question marks do appear and you suspect that the list may be
wrong (or in the wrong order), consider synchronizing the index
fields with the database. For information, see Synchronizing Index
Fields with the Database.
Synchronizing Index
Fields with the
Database
Figure 102
5. Make sure the new fields have the propagation settings that you
want to use. For instructions on changing the propagation of an
index field, see Changing Index Field Propagation.
6. Right-click the report type for which you have synchronized
databases and select Accept changes. The report type's icon
changes from red to blue to indicate that the corresponding
configuration file has been locked against editing and unlocked
for the AppXtender Reports Mgmt Report Processor.
219
Changing Index
Field Propagation
220
4. From the list of index fields on the right, right-click the index field
that you want to modify and select Properties. The Properties
dialog box for the selected index field appears.
Note: If the Propagation list is unavailable (read-only), the corresponding
configuration file has been locked against editing. To unlock the file for
editing, close the Properties dialog box, select the report type for which
you want to modify index field propagation, and then select Start update
from the Action menu. You can now modify index field propagation in
the index field Properties dialog box.
Figure 103
Propagation Types
Propagation Type
Description
NONPROPAG
The index value in the current index field is not propagated. That is, each
index value represents only one index record.
FRWDPROPAG
The index value in the current index field is repeated for all following index
records until the next value for the index field occurs.
BACKPROPAG
The index value in the current index field is repeated for all previous index
records until the previous value for the index field occurs.
221
6. If you have selected forward propagation for the index field, you
can specify a level of propagation.
7. In the level text box, type a number to indicate the level that you
want to use for the index field. The levels are defined by descent
order, with level 1 as the highest forward-propagation level. For
more information, see Using Propagation Levels.
8. Click OK. The change is reflected in the AppXtender Reports
Mgmt Configuration Admin.
9. Right-click the report type for which you have modified index
field propagation and select Accept changes. The report type's
icon changes from red to blue to indicate that the corresponding
configuration file has been locked against editing and unlocked
for the AppXtender Reports Mgmt Report Processor.
222
If you have specified a data export path for the AppXtender Reports
Mgmt Report Processor, and have configured a report type to export
report data to a file, the file that AppXtender Reports Mgmt exports
will automatically contain values for all of the index fields listed for
that report type. However, you can add fields to a report type so that
additional information will be exported to a file for use in a business
intelligence application.
To create a field for export to a business intelligence file:
1. In the ApplicationXtender Reports Management Configuration
Admin, expand the Report Types node.
2. Right-click the report type for which you want to create a field
and select Start update. The report type's icon changes from blue
to red to indicate that the corresponding configuration file has
been locked against the AppXtender Reports Mgmt Report
Processor and unlocked for editing.
223
3. Expand the report type's node. Select the Data Fields node. The
index fields for the selected report type are listed on the right.
4. Right-click Data Fields and select New Data Field. The data field
creation wizard appears.
Figure 104
5. In the Field Name text box, type a name for the new field.
6. From the Propagation drop-down list, select the type of
propagation that you want to use for the new field. For a
description of each choice, see Table 36, Propagation Types. For
more information about field propagation, see Understanding
Propagation of Index Values.
7. If you have selected forward propagation for the data field, you
can specify a level of propagation. In the level text box, type a
number to indicate the level that you want to use for the index
field. The levels are defined by descent order, with level 1 as the
highest forward-propagation level. For more information, see
Using Propagation Levels.
8. In the Length text box, type the number of characters that you
want AppXtender Reports Mgmt to extract for the new field.
9. Click Finish. The new data field appears in the list of index and
data fields in the AppXtender Reports Mgmt Configuration
Admin.
10. Right-click the report type for which you have created a new field
and select Accept changes. The report type's icon changes from
red to blue to indicate that the corresponding configuration file
has been locked against editing and unlocked for the AppXtender
Reports Mgmt Report Processor.
224
Changing Data
Field Properties
If you have created data fields for business intelligence purposes, you
can modify the fields name, propagation, propagation level, or
length at any time.
To change the properties of a data field:
1. In the AppXtender Reports Mgmt Configuration Admin, expand
the Report Types node.
2. Right-click the report type for which you want to modify a data
field and select Start update. The report type's icon changes from
blue to red to indicate that the corresponding configuration file
has been locked against the AppXtender Reports Mgmt Report
Processor and unlocked for editing.
3. Expand the report type's node. Select the Data Fields node. The
index and data fields for the selected report type are listed on the
right.
4. From the list of fields on the right, right-click the data field that
you want to modify and select Properties. The Properties dialog
box for the selected data field appears.
Note: If the Field Name text box, Propagation list, and Length text box
are unavailable (read-only), the corresponding configuration file has
been locked against editing. To unlock the file for editing, close the
Properties dialog box, select the report type for which you want to
modify data field properties, and then select Start update from the Action
menu. You can now modify data field properties in the data field
Properties dialog box.
Figure 105
225
5. In the Field Name text box, you can type a new name.
6. In the Propagation drop-down list, you can select a new type of
propagation for the selected data field. For a description of each
choice, see Table 36, Propagation Types. For more information
about field propagation, see Understanding Propagation of
Index Values.
7. If you have selected forward propagation for the data field, you
can specify a level of propagation. In the level text box, type a
number to indicate the level that you want to use for the index
field. The levels are defined by descent order, with level 1 as the
highest forward-propagation level. For more information, see
Using Propagation Levels.
8. In the Length text box, you can type a new length for the data
field.
9. Click OK. The changes are reflected in the AppXtender Reports
Mgmt Configuration Admin.
10. Right-click the report type for which you have modified a data
field and select Accept changes. The report type's icon changes
from red to blue to indicate that the corresponding configuration
file has been locked against editing and unlocked for the
AppXtender Reports Mgmt Report Processor.
Deleting a Data
Field
If necessary, you can delete a data field that you no longer need.
To delete a data field:
1. In the AppXtender Reports Mgmt Configuration Admin, expand
the Report Types node.
2. Right-click the report type that contains the data field you want to
delete and select Start update. The report type's icon changes
from blue to red to indicate that the corresponding configuration
file has been locked against the AppXtender Reports Mgmt
Report Processor and unlocked for editing.
3. Expand the report type's node. Select the Data Fields node. The
index and data fields for the selected report type are listed on the
right.
4. Right-click the data field that you want to delete and select Delete
Data Field. A message appears confirming whether you want to
delete the data field.
226
227
Managing Procedures
Procedures provide AppXtender Reports Mgmt with instructions for
extracting index information from reports. This section describes how
to create, modify, and change the order of procedures. This section
also describes how to delete a procedure that you no longer need. For
more information, see the following sections:
Editing Procedures
Deleting a Procedure
Creating a New
Procedure
To create a procedure:
1. In the AppXtender Reports Mgmt Configuration Admin, expand
the Report Types node.
2. Right-click the report type for which you want to create a
procedure and select Start update. The report type's icon changes
from blue to red to indicate that the corresponding configuration
file has been locked against the AppXtender Reports Mgmt
Report Processor and unlocked for editing.
3. Expand the report type's node.
228
Figure 106
The text area of a new procedure is blank. You can type or paste
an XDS script directly in the text area or you can use the features
of the wizard to construct the procedure.
5. From the Instruction drop-down list, select PAGEPROC,
LINEPROC, or SUBPROC.
Note: When you select an instruction from the Instruction drop-down
list, more text boxes and options appear to the right. You can view the
syntax of the selected instruction, by clicking Show syntax. To display the
text boxes and options for the selected instruction again, click Show
syntax again.
6. In the Procedure Name text box, type a name for the procedure.
Configure the instruction further, if necessary. Click
Insert/Replace. The selected instruction and the information that
you entered with it (in this case, the procedure name) are entered
in the text area of the wizard.
7. Click Text Image. The Text Image dialog box appears, displaying
a representation of the text layout in the sample report file.
Managing Procedures
229
Note: If you need to hide the Text Image dialog box temporarily, you can
click Hide. When you click Text Image again to display the Text Image
dialog box again, all of the values in the text boxes are the same as they
were when you hid the dialog box. (However, if you click Close, all
values on the Text Image dialog box are lost.)
Figure 107
When you display a sample report file in the Text Image dialog
box, AppXtender Reports Mgmt always displays the first page.
The following table describes how to move from one page to
another in the sample report file.
8. If the Text View Algorithm settings (View 1, View 2, and View 3)
are available, try each one and examine the text image that results
from each, to determine which one is more appropriate for the
reports that you want to process. (If the reports that you want to
process were generated by the AppXtender Reports Mgmt Print
Stream Processor, the View 1 setting is suggested.)
9. If the Line Scale text box is available, adjust the line scale so that
none of the text overlaps. For a detailed explanation of the line
scale feature, see Line Scale in PDF Report Files.
Note: Do not adjust the Text View Algorithm setting or the line scale after
creating extract definitions described in the following step. When the
Text View Algorithm setting or line scale is adjusted, column locations
change accordingly.
230
10. Using the New Indexing Procedure wizard and the Text Image
dialog box, create an extract definition for each index field. Each
extract definition contains the following elements:
Directions to inform AppXtender Reports Mgmt where to find
an index value on the text image. These directions can be
based on coordinates (LINE and COL instructions) or fields
(FIELD instruction).
An instruction to extract the index value (EXTRACT) and save
the value to a particular variable.
An instruction to save the value of a particular variable to a
particular index field (STORE).
Note: The EXTRACT instruction must immediately follow the directions
to inform AppXtender Reports Mgmt where to find an index value on
the text image.
11. If you want to test the syntax of the procedure, click Check
syntax. A message appears next to the Instruction drop-down list
indicating whether the current procedure has correct syntax. For
example, if the procedure is missing an END instruction, the
message, Unexpected end of procedure appears.
12. When you have completed the procedure, click Close in the Text
Image dialog box. In the New Indexing Procedure wizard, click
Next. The new procedure is listed in the AppXtender Reports
Mgmt Configuration Admin.
13. Right-click the report type to which the new procedure belongs
and select Accept changes. The report type's icon changes from
red to blue to indicate that the corresponding configuration file
has been locked against editing and unlocked for the AppXtender
Reports Mgmt Report Processor.
Consider using XDS Visual Tester to test the new procedure
against the report types sample report. For instructions, see
Recommended Method of Testing Procedures and Using XDS
Visual Tester.
Managing Procedures
231
Figure 108
232
Figure 109
You must specify a line scale for each report type carefully before
defining any extract definitions for that report type. Consider the
following points:
When line scale is set too low for a report file, black rectangular
characters appear where text is overlapping. When text overlaps
in the AppXtender Reports Mgmt text version of a PDF report
file, it might be difficult for you to create an accurate extraction
procedure, because you need to see the values that would be
extracted from the sample report file.
Note: AppXtender Reports Mgmt can extract text from a field even when
it overlaps with another field. However, if your procedure uses a COL
instruction that indicates a column in an overlapping area, AppXtender
Reports Mgmt might extract from a field other than the one you
intended.
Managing Procedures
233
Figure 110
When line scale is set too high for a report file, there is wasted
space and AppXtender Reports Mgmt performance suffers.
Also, notice that as line scale increases, the column location of each
character increases. The following table compares the line scale and
the column position of the selected text in each of the three preceding
figures:
Table 38
234
Figure
Line Scale
Column Position
100
20
50
10
150
30
CAUTION
Do not change the line scale for a report type after any extract
definitions have been written for that report type. Doing so
causes inaccurate extractions to occur. For example, if one
person writes an extract definition that extracts a value from
column 20, and then another person changes the line scale, the
value that is extracted from column 20 is not the value that the
first person intended to extract.
Recommended
Method of Testing
Procedures
Managing Procedures
235
5. When you locate the problems during testing, edit the procedures
or reconfigure the report type to solve these problems, set the
report to be processed again, and repeat step 4. For instructions
on setting a report to be processed again, see Allowing a Report
to be Processed Again.
6. When you are satisfied that the report types procedures cause the
appropriate AppXtender documents to be generated from the
selected reports, you can begin to use that report type in a
production environment.
7. Monitor the logs for the report type while it is being used in a
production environment. If problems occur that cause a report to
fail in the production environment, use XDS Visual Tester to
perform troubleshooting on that failed report.
8. When you locate the problems during troubleshooting, edit the
procedures or reconfigure the report type to solve these problems,
set the report to be processed again, and repeat step 7.
236
5. For each additional procedure that you want to move up, repeat
step 4.
6. When all of the page procedures are in the order that you want
and all of the line procedures are in the order that you want, save
your changes.
Right-click the report type to which the changed procedure
belongs and select Accept changes. The report type's icon
changes from red to blue to indicate that the corresponding
configuration file has been locked against editing and
unlocked for the AppXtender Reports Mgmt Report Processor.
Consider using XDS Visual Tester to test the new order of
procedures against the report types sample report. For
instructions, see Recommended Method of Testing Procedures
and Displaying XDS Visual Tester for a Processed Report.
Editing Procedures
To edit a procedure:
1. In the AppXtender Reports Mgmt Configuration Admin, expand
the Report Types node.
2. Right-click the report type for which you want to edit a procedure
and select Start update. The report type's icon changes from blue
to red to indicate that the corresponding configuration file has
been locked against the AppXtender Reports Mgmt Report
Processor and unlocked for editing.
3. Expand the report type's node. Select the Procedures node. The
procedures for the selected report type are listed on the right.
Managing Procedures
237
Figure 111
5. You can type or paste an XDS script directly in the text area or you
can use the features of the Properties dialog box to continue
constructing the procedure.
For example, if you want to change the name of a procedure,
select the PAGEPROC or LINEPROC line and click Take
instruction.
The PAGEPROC or LINEPROC instruction appears in the
Instruction drop-down list, and the corresponding text boxes and
options appear to the right.
In the Procedure Name text box, type a name for the procedure.
Configure the instruction further, if necessary.
Click Insert/Replace. The changes that you entered are reflected
in the text area of the Properties dialog box.
Note: Do not adjust the line scale after creating extract definitions. When
line scale is adjusted, column locations change accordingly.
238
6. When you have made all of the changes that you wanted to make
in the procedure, click OK. The changes are saved and the
Properties dialog box closes.
7. Right-click the report type to which the changed procedure
belongs and select Accept changes.
The report type's icon changes from red to blue to indicate that
the corresponding configuration file has been locked against
editing and unlocked for the AppXtender Reports Mgmt Report
Processor.
Consider using XDS Visual Tester to test the modified procedure
against the report types sample report. For instructions, see
Recommended Method of Testing Procedures and Using XDS
Visual Tester.
Deleting a
Procedure
CAUTION
When a procedure is deleted, all of the extraction information in
that procedure is permanently lost. The index values that would
have been extracted by the deleted procedure cannot be extracted
until you create another extraction procedure to extract those index
values.
To delete a procedure:
1. In the AppXtender Reports Mgmt Configuration Admin, expand
the Report Types node.
2. Right-click the report type for which you want to delete a
procedure and select Start update.
The report type's icon changes from blue to red to indicate that
the corresponding configuration file has been locked against the
AppXtender Reports Mgmt Report Processor and unlocked for
editing.
3. Expand the node for the report type.
4. Select the Procedures node. The procedures for the selected report
type are listed on the right.
Managing Procedures
239
240
241
Displaying XDS
Visual Tester for a
Sample Report
242
View has no position indicator; the Procedure Script View and the
Report Text View are both blank; and no values are listed in the
other views.
For details on each view and toolbar, see the following sections:
The XDS Visual Tester Views
The XDS Visual Tester Toolbar
The Report Text View Toolbar
When you have displayed XDS Visual Tester for the sample
report, you can begin to test the procedures against that report.
For instructions, see Using XDS Visual Tester to Test a Report.
Displaying XDS
Visual Tester for a
Processed Report
243
When you have displayed XDS Visual Tester for the processed report,
you can begin to test the procedures against that report. For
instructions, see Using XDS Visual Tester to Test a Report.
The XDS Visual Tester
Views
Figure 112
244
View
Description
Procedures View
This view contains a list of the procedures in the selected report type.
Procedures are listed in the order that they will be performed. (For
information, see Changing the Order of Procedures.) After you click the
Start toolbar button, a yellow arrow appears in the Procedures View to
indicate which procedure is currently being interpreted.
This view contains the text of the extraction procedure that is currently
being interpreted. After you click the Start toolbar button, a yellow arrow
appears in the Procedure Script View to indicate which instruction is
currently being interpreted.
This view contains the text of the report specified for the selected report
type. After you click the Start toolbar button, XDS Visual Testers current
position in the Report Text View is indicated. For line procedures, an
underline indicates the current line. For line and page procedures, if the
current line and column contains a character, this character is displayed
red. Otherwise, a red underscore indicates the current line and column.
The Report Text View has its own toolbar that indicates the current page,
line, and column number and allows you to navigate to any page of the
report.
Table 39
View
Description
Variables View
This view contains a list of the variables in the current extraction procedure
and the current values for each variable. When XDS Visual Tester
interprets an EXTRACT instruction, a value is copied from the report to this
view.
This view contains a list of the index fields for the application that is
specified for the report type and the current values for each index field.
When XDS Visual Tester interprets a STORE instruction, a value is copied
from the Variables View to this view.
This view contains a list of the index records that have been generated
from the procedures and report by XDS Visual Testers interpretation, up to
the current position. When you click the Indexing, Extract Page, Run to
End, or Run to Page toolbar button, values are copied from the Application
Fields View to this view. The index records in this view represent the index
records that AppXtender Reports Mgmt would have generated from the
current procedures and the current report. (Some processing actions that
are normally applied to index records just before they are uploaded to
AppXtender or just before they are exported for use in a business
intelligence application, such as the action of combining duplicate records,
are not applied to the records in the Index Table View.) The first column of
this view indicates the page of the report from which the record was
extracted.
Figure 113
The XDS Visual Tester toolbar allows you to control XDS Visual
Tester.
245
The following table describes each of the buttons on the XDS Visual
Tester toolbar:
Table 40
Button
246
Table 40
Button
Figure 114
The Report Text View toolbar in XDS Visual Tester allows you to
navigate the Report Text view and displays the current position of
XDS Visual Tester.
The following table describes each of the buttons on the Report Text
view toolbar:
Table 41
Button
247
When you first display XDS Visual Tester, the various XDS Visual
Tester views are in their initial state. That is, the Procedures View has
no position indicator, the Procedure Script View and the Report Text
View are both blank, and no values are listed in the other views.
To test the processing of a report:
1. Click the Start toolbar button. The views change to indicate that
XDS Visual Tester is ready to begin interpreting the effect of the
procedures on the report.
A position indicator (a yellow arrow) appears in the
Procedures View next to the first procedure.
Script text from the first procedure appears in the Procedure
Script View with a position indicator (a yellow arrow) next to
the first instruction.
Text appears in the Report Text View with a position indicator
(an underline, a red character, or a red underscore) in the first
line and column of the first page.
2. Click the Run to End toolbar button. The Index Table View is
populated with index records composed of values that have been
extracted from the report.
3. Scroll through the index records in the Index Table View and
examine the results. If you find a problem with a record in the
Index Table View, take note of the page number from which the
record was extracted. Also, if the following icon appears next to a
record, double-click the icon to display a message and take note
of that message.
Figure 115
4. Click the Stop toolbar button. The XDS Visual Tester views return
to their initial state.
5. Click the Start toolbar button. XDS Visual Tester is again ready to
interpret the procedures.
6. In the Run to Page text box, type the page number. Click the Run
to Page toolbar button.
248
7. Click the Next Step toolbar button and examine the results in the
various views.
As each instruction moves the current position of XDS Visual
Tester within the report, the position indicator (an underline, a
red character, or a red underscore) moves in the Report Text
View.
As each value is extracted from the report, the extracted value
is highlighted in yellow in the Report Text View and appears
in the Variables View.
As each value is stored, the stored value changes to blue in the
Report Text View and appears in the Application Fields View.
8. Repeat step 7 until the problem reoccurs. From XDS Visual
Testers demonstration of how the instructions extract and store
values from the report, you should be able to determine where
corrections need to be made in the extraction procedure or in the
report types configuration.
Note: If you attempt to display XDS Visual Tester after making changes
in the extraction procedure or in the report types configuration, a
message appears indicating that XDS Visual Tester must be restarted.
249
250
8
Managing the Print
Stream Processor
Introduction ......................................................................................
The Print Stream Processor Glossary ............................................
Configuring the Print Stream Processor .......................................
Monitoring the Print Stream Processor.........................................
252
254
262
287
251
Introduction
The AppXtender Reports Mgmt Print Stream Processor detects print
stream files from other sources and converts them into a PDF or
standard ASCII format. Converted report files can then be output to
the AppXtender Reports Mgmt Report Processor for extracting and
indexing the specified data.
This chapter describes how to use the AppXtender Reports Mgmt
Configuration Admin to manage the AppXtender Reports Mgmt
Print Stream Processor.
For more information, see the following sections:
252
Once converted, you can then use the AppXtender Reports Mgmt
Report Processor to extract index information from the resulting PDF
or ASCII report files. For more information on using the AppXtender
Reports Mgmt Report Processor, see Managing the Report
Processor.
Introduction
253
254
Term
Definition
Conversion
This directory contains system log files for your AppXtender Reports Mgmt
Print Stream Processor system. This directory is created as a subdirectory
of the Print Stream Processor working directory when the processor
creates the first system log file. For an example, see The Print Stream
Processor Working Directory. For instructions on monitoring the system
logs, see Viewing Print Stream Processor System Logs.
The path to the AppXtender Reports Mgmt Print Stream Processor working
directory.
Table 42
Term
Definition
A print stream file is output that would normally be destined for the printer
but has been diverted to a computer file instead.
Process
This directory is where you must provide the resources for processing AFP,
Metacode, or PCL print stream files. This directory is created when the print
stream type is created. For an example, see Resources Directory for a
Print Stream Type.
Source specification
The directory into which the print stream files that you want to process
should be placed for processing. When you specify a directory as the
source directory for a print stream type, AppXtender Reports Mgmt creates
this directory (if it does not already exist). This directory may be the same
as the working subdirectory for that print stream type, or it may be different.
For an example and more information, see The Source Directory for each
Print Stream Type.
This directory contains a message log file, a conversion log file, and a
temporary configuration file for each processing attempt of a print stream
associated with that print stream type. The length of time for which these
files are kept depends on the Delete Temporary Files setting and the Purge
Log Files after setting for the print stream type and on the Purging Timeout
setting of the AppXtender Reports Mgmt Print Stream Processor. For an
example, see The Working Subdirectory for a Print Stream Type. For
instructions on monitoring the message and conversion logs, see Viewing
Logs for Each Processed Print Stream.
255
The Configuration
Data Directory
Figure 116
256
Figure 117
The Working
Subdirectory for a
Print Stream Type
257
The length of time for which these files are kept depends on the
Delete Temporary Files setting and the Purge Log Files after setting
for the print stream type and on the Purging Timeout setting of the
AppXtender Reports Mgmt Print Stream Processor.
Figure 118
Resources Directory
for a Print Stream
Type
258
The resources directory for a print stream type is created when the
print stream type is created. This directory is where you must provide
the resources for processing AFP, Metacode, or PCL print stream files.
Figure 119
259
Figure 120
The Source
Directory for each
Print Stream Type
The source directory for each print stream type is the directory into
which the print stream files that you want to process should be
placed for processing.
When you specify a directory as the source directory for a print
stream type, AppXtender Reports Mgmt creates this directory (if it
does not already exist). This directory may be the same as the
working subdirectory for that print stream type, or it may be
different.
In the following figure, the source directory is MY-PCL-PS. A source
specification has been configured so that AppXtender Reports Mgmt
detects source print streams in this directory and archives the source
files by year, month, and day.
You can configure source specifications so that AppXtender Reports
Mgmt keeps the source files (renamed) in the original directory, or
you can configure them so that AppXtender Reports Mgmt deletes
the source files after processing.
260
Figure 121
261
Figure 122
262
263
Print Stream
Processor Paths
264
The Log View displays information for each of the following log
types:
The system log lists each event that applies to the AppXtender
Reports Mgmt Print Stream Processor. Examples of recorded
events include licensing issues or other system problems that
prevent the processing of a print stream.
Note: If you want to view the most current information, click Refresh or
press <F5>.
All available log records appear in the Log View. You can navigate
through log pages by right-clicking a log node and selecting First
Page, Prev Page, Next Page, and Last Page.
Changing the
Working Directory
265
Changing the
System Log
Directory
CAUTION
Changing the AppXtender Reports Mgmt Print Stream Processor
System Log directory changes the log files listed in the AppXtender
Reports Mgmt Configuration Admin.
To change the AppXtender Reports Mgmt Print Stream Processor
System Log directory:
1. Expand the Local Computer node and the Configuration node.
Select the Paths node.
2. In the right pane of the AppXtender Reports Mgmt Configuration
Admin, double-click System Log Directory. The System Log
Directory Properties dialog box appears. In the Value text box,
specify the name of the subdirectory in which you want the
AppXtender Reports Mgmt Print Stream Processor to place
processor system logs. Keep in mind that the directory you
specify is a subdirectory of the AppXtender Reports Mgmt Print
Stream Processor working directory. AppXtender Reports Mgmt
creates this directory the next time that the AppXtender Reports
Mgmt Print Stream Processor generates an error message. Click
OK.
Note: If the Value text box in the Properties dialog box is unavailable
(read-only), the AppXtender Reports Mgmt Print Stream Processor is still
running. To suspend the processor, close the Properties dialog box, select
the Local Computer node, and then select Suspend from the Action
menu. You can now edit the value in the Properties dialog box.
266
Configuring Print
Stream Processor
Performance
Table 43
Timeout Setting
Description
Background Process
The interval (in seconds) at which the AppXtender Reports Mgmt Print
Stream Processor checks the other two timeout values (File Pick-up and
Purging).
267
Table 43
268
Timeout Setting
Description
File Pick-up
The interval (in seconds) at which the AppXtender Reports Mgmt Print
Stream Processor looks for source print stream files to process.
Purging
The interval (in seconds) at which the AppXtender Reports Mgmt Print
Stream Processor checks the Files Keeping settings for each print stream
type. When time has expired for the Purge Log Files after setting,
AppXtender Reports Mgmt deletes the CFG file and LOG file associated
with a processing attempt of a particular print stream file. (If the source
directory is the same as the working subdirectory for the associated print
stream type and if the source specification is configured to leave the
source file renamed in the original directory, AppXtender Reports Mgmt
also deletes the renamed source print stream file.)
00:00
00:00
Purging Timeout
(default = 6000 sec)
00:00
3
File Pick-up Timeout
(default = 10 sec)
Figure 123
If 6000 seconds have passed since the processor has looked for
files that need to be deleted, the processor looks again.
269
Figure 124
3. Click OK.
270
If you have a large number of print streams to monitor, you may find
it more practical to access print stream log data through Windows
Management Instrumentation (WMI). Using a custom application or
script, you can use this data to automate your restart, recovery, and
maintenance tasks. WMI is a component of the Microsoft Windows
operating system.
Before you can access AppXtender Reports Mgmt print stream data
in WMI, you must configure AppXtender Reports Mgmt to provide
WMI data during processing.
CAUTION
To monitor AppXtender Reports Mgmt print streams in
AppXtender Admin, you must select the Set value to yes
checkbox in the Provide WMI Data Properties dialog box. For more
information about monitoring data in AppXtender Admin, refer to
the ApplicationXtender Core Components Administrators Guide.
271
Figure 125
3. Select the Set value to yes check box and then click OK.
Once this parameter value is set to yes, AppXtender Reports
Mgmt sends log data for the AppXtender Reports Mgmt Print
Stream Processor and individual print streams to WMI in the
following format:
Table 44
272
Property
Description
INSTANCEID
Unique ID associated with the current instance of the Print Stream Processor.
MESSAGE
PSTYPE
Name of the print stream that is currently being handled by the Print Stream
Processor.
Table 44
Property
Description
STATUS
TIMESTAMP
The date and time the Print Stream Processor started processing.
Table 45
Property
Description
ENDTIME
INSTANCEID
PROCESSLENGT
H
Length of time, in seconds, that it took the current print stream to process.
PSTYPE
SOURCE
SOURCELEN
STARTTIME
STATUS
Figure 126
273
Figure 127
274
4. Accept all defaults and click OK. The WMI CIM Studio appears.
Figure 128
5. Click the plus sign to the left of the AppXtender Reports Mgmt
class to see the four subclasses: ReportProcessor,
PrintStreamProcessor, ReportInstance, and PrintStreamInstance.
Click any of these subclasses to see their properties. The
properties of the print stream subclasses are also listed in
Table 44, WMI AppXtender Reports Mgmt Print Stream
Processor Class Format, and Table 45, WMI AppXtender
Reports Mgmt Print Stream Instance Class Format.
Managing Source
Specifications for
Print Stream Types
275
Specifying a Source
for a Print Stream Type
For each print stream type that you want to process, use the new
print stream source wizard to specify a new print stream source. (If
you want to specify more than one source for each print stream type,
use the wizard for each source.)
Starting the New Print Stream Source Wizard
The new print stream source wizard allows you to specify a source
for a print stream type.
To start the new print stream source wizard:
1. Expand the Local Computer node and the Configuration node.
2. Right-click the Print Stream Sources node and select New Source.
The new print stream source wizard appears, starting with the
Input page.
Note: If a message appears, the AppXtender Reports Mgmt Print Stream
Processor is still running. To suspend the processor, select the Local
Computer node, and then select Suspend from the Action menu. You can
now create a new print stream source.
276
Figure 129
277
5. In the Excluded text box, you can specify a file name mask to
protect files from being recognized as source files. If you want to
specify more than one mask, use semicolons to separate them.
Note: If the source directory is a subdirectory of the AppXtender Reports
Mgmt Print Stream Processor working directory (C:\ERMXDATA by
default), AppXtender Reports Mgmt automatically and transparently
excludes LOG, CFG, DBF, and INI files, to preserve data integrity.
278
279
Figure 130
280
Once a source has been specified for a print stream type, you can use
the print stream source Properties dialog box to modify it.
To modify a print stream type's source specification:
1. Expand the Local Computer node and the Configuration node.
Select the Print Stream Sources node. The existing source
specifications are listed in the right pane of the AppXtender
Reports Mgmt Configuration Admin.
2. Right-click the source specification that you want to modify and
select Properties. The print stream source Properties dialog box
appears. The Input tab is forward by default.
Configuring the Print Stream Processor
281
Figure 131
3. From the Source Type drop-down list, you can select a different
print stream type. Select the print stream type that you want
AppXtender Reports Mgmt to associate with the specified source
directory and file name mask.
4. In the Priority text box, you can change the priority that has been
given to the source. The priority can be 0 or greater. This setting is
useful if you specify more than one source for a print stream type.
For each print stream type, the AppXtender Reports Mgmt Print
Stream Processor processes sources with priority of 0 first, the
sources with a priority of 1 next, and so on.
5. In the Source Directory text box, you can change the path to and
the name of the directory in which you want the AppXtender
Reports Mgmt Print Stream Processor to find print streams for
processing. (You can browse for a directory by clicking the
Browse button.)
282
6. Under File Recognition, in the Included text box, you can change
the file name mask. This mask allows the AppXtender Reports
Mgmt Print Stream Processor to recognize each print stream file
that you want to convert, when it appears in the source directory.
If you want to specify more than one mask, use semicolons to
separate them. Specify this file name mask using any combination
of the following:
Characters that are normally allowed as file name characters
Wildcard characters, such as the question mark (?) to represent
a single character, and the asterisk (*) to represent any number
of characters
For example, to process all files with the TXT extension, specify
*.TXT.
Note: The AppXtender Reports Mgmt Print Stream Processor can process
only the following file formats: AFP, Metacode, PCL, EBCDIC, EBCDIK,
and non-standard ASCII. The file name mask that you specify must
match one of these file types.
7. In the Excluded text box, you can specify a file name mask to
protect files from being recognized as source files. If you want to
specify more than one mask, use semicolons to separate them.
Note: If the source directory is a subdirectory of the AppXtender Reports
Mgmt Print Stream Processor working directory (C:\ERMXDATA by
default), AppXtender Reports Mgmt automatically and transparently
excludes LOG, CFG, DBF, and INI files, to preserve data integrity.
283
Figure 132
284
CAUTION
When a source specification is deleted, all of the parameters that
have been specified for that source specification are permanently
lost. The set of print stream source files specified by a deleted
source specification cannot be processed until you use the new
print stream source wizard to create another source specification
for that set of print stream source files.
To delete a source specification for a print stream types:
1. Expand the Local Computer node and the Configuration node.
Select the Print Stream Sources node. The existing source
specifications are listed in the right pane of the AppXtender
Reports Mgmt Configuration Admin.
2. Right-click the source specification that you want to delete and
select Delete.
Note: If the AppXtender Reports Mgmt Print Stream Processor is still
running, a message appears indicating that the processor must be
suspended. To suspend the processor, select the Local Computer node,
and then select Suspend from the Action menu. You can now delete the
print stream source.
285
286
Using Logs to
Monitor the Print
Stream Processor
287
Figure 133
288
Figure 134
5. Right-click the log record that you want to view and select
Properties. The Properties dialog box for that AppXtender
Reports Mgmt Print Stream Processor system log appears.
289
Figure 135
290
The length of time during which these logs are available for you to
monitor depends on the print stream type configuration and the Print
Stream Processor configuration. The Purge Log Files after setting for
the print stream type and the Purging Timeout setting control how
long each log file is kept.
To view logs for each processed print stream:
1. In the AppXtender Reports Mgmt Configuration Admin, expand
the Print Stream Processors node.
2. Expand the Local Computer node.
3. Expand the Logs node.
4. Expand the Print Stream Logs node.
5. Select the node for the print stream type for which you want to
view logs. In the right pane of the AppXtender Reports Mgmt
Configuration Admin, log records are listed, one for each print
stream file that AppXtender Reports Mgmt attempted to process
with the selected print stream type. For each log record, the
AppXtender Reports Mgmt Configuration Admin displays a log
identification string and the date and time the log was created.
6. If there are more than 50 logs for the print stream type, right-click
the print stream type node and navigate between the log pages by
selecting First Page, Prev Page, Next Page, and Last Page.
291
Figure 136
8. If you want to view the Conversion Log, click the Conversion Log
tab. The Conversion Log appears.
292
Figure 137
293
You can view information about the failed print stream process in the
columns of the AppXtender Reports Mgmt Configuration Admin.
You can also view the message log and conversion log for each failed
print stream process.
The length of time during which these logs are available for you to
monitor depends on the print stream type configuration and the Print
Stream Processor configuration. The Purge Log Files after setting for
the print stream type and the Purging Timeout setting control how
long each log file is kept.
To view the logs for each failed print stream process:
1. In the AppXtender Reports Mgmt Configuration Admin, expand
the Print Stream Processors node, the Local Computer node, and
the Logs node.
2. Select the Failed Print Streams node. In the right pane of the
AppXtender Reports Mgmt Configuration Admin, log records are
listed, one for each print stream that AppXtender Reports Mgmt
was unable to process.
3. If there are more than 50 log records, right-click the Failed Print
Streams node and navigate between the log pages by selecting
First Page, Prev Page, Next Page, and Last Page.
Note: If you want to view the most current information, click the Refresh
toolbar button.
Information Displayed for Each Failed Print Stream Process Log Record
Column
Description
Log ID
Type
The print stream type that AppXtender Reports Mgmt used to attempt the processing of
the print stream.
Log Date/Time
The date and time the log was created. This value also indicates the time at which
AppXtender Reports Mgmt started to process a print stream.
Note: If you want to view the most current information, click Refresh or
press <F5>.
5. If you want to view the Conversion Log, click the Conversion Log
tab. The Conversion Log appears.
6. From these logs, you should be able to determine how the print
stream types configuration or procedures are causing the
AppXtender Reports Mgmt Print Stream Processor to fail when
processing this print stream.
7. After you have corrected the print stream types configuration or
procedures, you can resubmit the print stream to the AppXtender
Reports Mgmt Print Stream Processor for processing. For
instructions, see the Allowing a Print Stream to be Processed
Again.
For more information, see:
Modifying Print Stream Type Properties
Configuring Print Stream Processor Performance
Allowing a Print
Stream to be
Processed Again
295
3. Right-click the log for the print stream that you want to process
again and select Set for Rerun. AppXtender Reports Mgmt
renames the print stream file so that the AppXtender Reports
Mgmt Print Stream Processor will recognize it as a new print
stream and process it.
296
9
Managing the Report
Processor
Introduction ......................................................................................
The Report Processor Glossary ......................................................
Configuring the Report Processor .................................................
Monitoring the Report Processor...................................................
298
299
308
336
297
Introduction
The AppXtender Reports Mgmt Report Processor is a service that
detects report files, extracts index values from the report files, and
stores the resulting index record with the report pages in an
AppXtender database as an indexed document. You can then use the
index record to retrieve the report file through an AppXtender
application. This chapter describes how to use the AppXtender
Reports Mgmt Configuration Admin to manage the AppXtender
Reports Mgmt Report Processor.
Note: AppXtender Reports Mgmt has two view options, AppXtender
Reports Mgmt Configuration and AppXtender Reports Mgmt Report
Configuration. Both views allow access to the Report Processor, but only
AppXtender Reports Mgmt Configuration allows access to the Print Stream
Processor.
298
Term
Definition
Business intelligence
The data export path is the path in which AppXtender Reports Mgmt
exports files for use in business intelligence applications, if you configure
report types to allow the export of data to this directory. This path is
necessary only if you want AppXtender Reports Mgmt to export files for use
in business intelligence applications.
299
Table 47
300
Term
Definition
This directory contains system log files for your AppXtender Reports Mgmt
Report Processor system. This directory is created as a subdirectory of the
AppXtender Reports Mgmt Report Processor working directory when the
processor creates the first log file. For an example, see The Report
Processor System Log Directory. For instructions on monitoring the system
logs, see Viewing Report Processor System Logs.
This directory contains a working subdirectory for each report type that you
configure. This directory may be the same as the AppXtender Reports
Mgmt Configuration Data directory, or it may be different. This directory
also contains the AppXtender Reports Mgmt Report Processor System Log
directory. For an example, see The Report Processor Working Directory.
Extraction
The creation of index records from PDF or standard ASCII report files.
Process
Report file
Report type
Source specification
Table 47
Term
Definition
The directory into which the report files that you want to process should be
placed for processing. When you specify a directory as the source directory
for a report type, AppXtender Reports Mgmt creates the directory (if it does
not already exist). This directory may be the same as the working
subdirectory for that report type, or it may be different. For an example and
more information, see The Source Directory for a Report Type..
This directory contains a message log file, a history log file, a temporary
index record file, and a temporary configuration file for each processing
attempt of a report associated with that report type. The length of time for
which these files are kept depends on the Files Keeping settings for the
report type and on the Purging Timeout setting of the AppXtender Reports
Mgmt Report Processor. For an example, see The Working Subdirectory
for a Report Type. For instructions on monitoring the message and history
logs, see Viewing Logs for Each Processed Report.
The Configuration
Data Directory
301
Figure 138
Report Processor
Paths
302
The Log View displays information for each of the following log
types:
The system log lists each event that applies to the AppXtender
Reports Mgmt Report Processor. Examples of recorded events
include licensing issues or other system problems that prevent the
processing of a report.
All available log records appear in the Log View. You can navigate
through log pages by right-clicking a log node and selecting First
Page, Prev Page, Next Page, and Last Page.
303
The Report
Processor Working
Directory
Figure 139
The Working
Subdirectory for a
Report Type
304
Figure 140
The Report
Processor System
Log Directory
305
Figure 141
The Source
Directory for a
Report Type
The source directory for a report type is the directory into which the
report files that you want to process should be placed for processing.
When you specify a directory as the source directory for a report
type, AppXtender Reports Mgmt creates the directory (if it does not
already exist). This directory may be the same as the working
subdirectory for that report type, or it may be different.
In the following figure, the source directory is MY-PDF-RPT. A source
specification has been configured so that AppXtender Reports Mgmt
detects source reports in this directory and archives the source files
by year, month, and day. You can configure source specifications so
that AppXtender Reports Mgmt keeps the source files (renamed) in
the original directory, or you can configure them so that AppXtender
Reports Mgmt deletes the source files after processing. For more
information, see Specifying a Source for a Report Type.
306
Figure 142
307
Figure 143
308
309
Changing the
Report Processor
Working Directory
Figure 144
3. Click OK.
310
3. Click OK.
4. When you have performed all AppXtender Reports Mgmt Report
Processor configuration that you want to perform, resume the
AppXtender Reports Mgmt Report Processor service by
right-clicking the Local Computer node and selecting Resume.
311
312
3. Click OK.
4. When you have performed all AppXtender Reports Mgmt Report
Processor configuration that you want to perform, resume the
AppXtender Reports Mgmt Report Processor service by
right-clicking the Local Computer node and selecting Resume.
The Local Computer node's icon changes from red to green to
indicate that the AppXtender Reports Mgmt Report Processor
service has resumed running and the changes that you have made
are saved.
Changing the
Report Processor
System Log
Directory
CAUTION
Changing the AppXtender Reports Mgmt Report Processor System
Log directory changes the log records listed in the AppXtender
Reports Mgmt Configuration Admin.
To change the AppXtender Reports Mgmt Report Processor System
Log directory:
1. Expand the Local Computer node and the Configuration node.
Select the Paths node.
2. In the right pane of the AppXtender Reports Mgmt Configuration
Admin, double-click System Log Directory. The System Log
Directory Properties dialog box appears. In the Value text box,
specify the name of the subdirectory in which you want the
AppXtender Reports Mgmt Report Processor to place processor
system logs. Keep in mind that the directory you specify is a
subdirectory of the AppXtender Reports Mgmt Report Processor
working directory. AppXtender Reports Mgmt creates this
directory the next time that the AppXtender Reports Mgmt
Report Processor generates an error message.
313
Note: If the Value text box in the Properties dialog box is unavailable
(read-only), the AppXtender Reports Mgmt Report Processor is still
running. To suspend the processor, close the Properties dialog box, select
the Local Computer node, and then select Suspend from the Action
menu. You can now edit the value in the Properties dialog box.
3. Click OK.
4. When you have performed all AppXtender Reports Mgmt Report
Processor configuration that you want to perform, resume the
AppXtender Reports Mgmt Report Processor service by
right-clicking the Local Computer node and selecting Resume.
The Local Computer node's icon changes from red to green to
indicate that the AppXtender Reports Mgmt Report Processor
service has resumed running and the changes that you have made
are saved.
Configuring Report
Processor
Performance
314
Timeout Setting
Description
Background Process
The interval (in seconds) at which the AppXtender Reports Mgmt Report
Processor checks the other three timeout values (File Pick-up, Recovery, and
Purging).
File Pick-up
The interval (in seconds) at which the AppXtender Reports Mgmt Report
Processor looks for source report files to process.
Recovery
The interval (in seconds) at which the AppXtender Reports Mgmt Report
Processor checks the Retry Interval setting for each report type. If time has
expired for the Retry Interval setting, AppXtender Reports Mgmt attempts to
retry processes that have a status of retry. The status of a report being
processed changes to retry when each of the following occurs:
AppXtender Reports Mgmt cannot connect to the AppXtender database
during upload.
The application to which AppXtender Reports Mgmt is attempting to upload
documents is being used by another process or user.
AppXtender Reports Mgmt is not finished processing a report and the
process has not failed during recovery.
Purging
The interval (in seconds) at which the AppXtender Reports Mgmt Report
Processor checks the Files Keeping settings for each report type. When time
has expired for either of the Files Keeping settings, AppXtender Reports Mgmt
deletes the CFG file and LOG file associated with a processing attempt of a
particular report file. (If the source directory is the same as the working
subdirectory for the associated report type and if the source specification is
configured to leave the source file renamed in the original directory,
AppXtender Reports Mgmt also deletes the renamed source report file.)
315
Related Report
Type Setting
00:00
Recovery Timeout
(default = 60 sec)
00:00
Background Process
Timeout
(default = 1 sec)
00:00
Purging Timeout
(default = 6000 sec)
Files Keeping
After Failure
(default = 24 hr)
00:00
00:00
316
Retry Interval
(default = 5 min)
00:00
Figure 145
00:00
If 6000 seconds have passed since the processor has looked for
files that need to be deleted, the processor looks again.
317
Note: If the Value text box in the Properties dialog box is unavailable
(read-only), the AppXtender Reports Mgmt Report Processor is still
running. To suspend the processor, close the Properties dialog box, select
the Local Computer node, and then select Suspend from the Action
menu. You can now edit the value in the Properties dialog box.
Figure 146
3. Click OK.
4. In the right pane of the AppXtender Reports Mgmt Configuration
Admin, double-click Purging Timeout. The Purging Timeout
Properties dialog box appears. In the Value text box, specify the
interval (in seconds) at which you want the AppXtender Reports
Mgmt Report Processor to check for files in the AppXtender
Reports Mgmt Report Processor working directory that need to
be purged (deleted). Click OK.
5. In the right pane of the AppXtender Reports Mgmt Configuration
Admin, double-click File Pick-up Timeout. The File Pick-up
Timeout Properties dialog box appears. In the Value text box,
specify the frequency in seconds at which you want the
AppXtender Reports Mgmt Report Processor to look for source
report files to process. Click OK.
6. In the right pane of the AppXtender Reports Mgmt Configuration
Admin, double-click Background Process Timeout. The
Background Process Timeout Properties dialog box appears. In
the Value text box, specify the interval (in seconds) at which you
want the AppXtender Reports Mgmt Report Processor to check
the other three timeout values (Recovery Timeout, Purging
Timeout, and File Pick-up Timeout).
318
Make sure the value for Background Process Timeout is less than
or equal to each of the values for Recovery Timeout, Purging
Timeout, and File Pick-up Timeout. Click OK.
7. In the right pane of the AppXtender Reports Mgmt Configuration
Admin, double-click Provide WMI data. The Provide WMI data
Properties dialog box appears. Select the Value box if you want to
be able to track AppXtender Reports Mgmt Report Processor and
individual report log data from within Windows Management
Instrumentation (WMI) for use in custom applications and
scripts. Selecting this value is also the only way to monitor
AppXtender Reports Mgmt report data inApplicationXtender
Administrator (AppXtender Admin). For more information about
using WMI to monitor the AppXtender Reports Mgmt Report
Processor, see Accessing Report Data in WMI.
8. When you have performed all AppXtender Reports Mgmt Report
Processor configuration that you want to perform, resume the
AppXtender Reports Mgmt Report Processor service. Right-click
the Local Computer node and select Resume.
The Local Computer node's icon changes from red to green to
indicate that the AppXtender Reports Mgmt Report Processor
service has resumed running and the changes that you have made
are saved.
Accessing Report
Data in WMI
319
CAUTION
To monitor AppXtender Reports Mgmt report data in AppXtender
Admin, you must select the Set value to yes checkbox in the
Provide WMI Data Properties dialog box. For more information
about monitoring data in AppXtender Admin, refer to the
ApplicationXtender Core Components Administrators Guide.
To configure AppXtender Reports Mgmt to provide WMI data:
1. In AppXtender Reports Mgmt Configuration, expand the Local
Computer node and the Configuration node. Select the
Performance node.
2. In the right pane of the AppXtender Reports Mgmt Configuration
Admin, click Provide WMI data. The Provide WMI Data
Properties dialog box appears.
Figure 147
3. Select the Set value to yes check box and then click OK.
Once this parameter value is set to yes, AppXtender Reports
Mgmt sends log data for the AppXtender Reports Mgmt Report
Processor and individual reports to WMI in the following format:
320
Table 49
Property
Description
STATUS
MESSAGE
REPORTTYPE
INSTANCEID
TIMESTAMP
Table 50
Property
Description
INSTANCEID
REPORTTYPE
Name of the report that is currently being handled by the Report Processor.
STATUS
STEP
PAGES
INDEXRECS
UPLOADRECS
SOURCE
SOURCELEN
RESTARTS
STARTTIME
ENDTIME
STEPTIME
STEPERRORS
ERRORS
PROCESSLENGTH
321
Figure 148
4. Click OK. The WMI CIM Studio Login dialog box appears.
Figure 149
5. Accept all defaults and click OK. The WMI CIM Studio appears.
322
Figure 150
6. Click the plus sign to the left of the AppXtender Reports Mgmt
class to see the four subclasses: ReportProcessor,
PrintStreamProcessor, ReportInstance, and PrintStreamInstance.
Click any of these subclasses to see their properties. The
properties of the print stream subclasses are also listed in
Table 49, WMI AppXtender Reports Mgmt ReportProcessor
Class Data, and Table 50, WMI AppXtender Reports Mgmt
ReportInstance Class Data.
Managing Source
Specifications for
Report Types
323
Understanding the
Methods of Source
File Recognition
324
If your report files have unique file names, and if you can place
the report files in different source directories according to which
report types you want AppXtender Reports Mgmt to use when
processing them, use *.* as a file name mask.
Method
Description
Example
By INI File
325
but does not use these extracted values to upload indexed documents
to AppXtender.
Note: If you configure AppXtender Reports Mgmt and AppXtender so that
AppXtender users can send documents back to AppXtender Reports Mgmt,
AppXtender automatically provides INI files with the line Upload=No. For
an overview of this configuration, see Exporting a File for Business
Intelligence Analysis from Indexed Documents.
3. Complete the Type= line with the name of the report type for
which the report source was created.
4. Save the INI file.
5. Each time you place a report file in the source directory, place the
corresponding INI file in the source directory with the report file.
Specifying a Source
for a Report Type
For each report type that you want to process, use the new report
source wizard to specify a new report source. (If you want to specify
more than one source for each report type, use the wizard for each
source.)
Starting the New Report Source Wizard
The new report source wizard allows you to specify a source for a
report type.
To start the new report source wizard:
1. Expand the Local Computer node and the Configuration node.
2. Right-click the Report Sources node and select New Source.
Note: If a message appears, the AppXtender Reports Mgmt Report
Processor is still running. To suspend the processor, right-click the Local
Computer node and select Suspend. You can now create a new report
source.
326
The new report source wizard appears, starting with the Input
page.
Figure 151
3. From the Source Type drop-down list, select the name of the
report type for which you want to specify a source.
4. In the Priority text box, specify the priority that you want to give
to the source, as 0 or greater. This setting is useful if you specify
more than one source for a report type. For each report type, the
AppXtender Reports Mgmt Report Processor processes sources
with priority of 0 first, the sources with a priority of 1 next, and so
on.
5. In the Source Directory text box, enter the path to and the name of
the directory in which you want the AppXtender Reports Mgmt
Report Processor to find reports for processing. (You can browse
for a directory by clicking the Browse button.)
327
Figure 152
The default included mask depends on the type of report type that
you select for the report source:
328
2. In the Excluded text box, you can specify a file name mask to
protect files from being recognized as source files. If you want to
specify more than one mask, use semicolons to separate them.
Note: If the source directory is a subdirectory of the AppXtender Reports
Mgmt Report Processor working directory (C:\ERMXDATA by default),
AppXtender Reports Mgmt automatically and transparently excludes
LOG, CFG, DBF, and INI files, to preserve data integrity.
Figure 153
329
Note: If you have selected the By INI File option for a report source, if the INI
file contains the line Upload=No, and if the processing of a report is
successful, the report and its corresponding INI file are immediately deleted
regardless of the After processing options in the report source.
330
Once a source has been specified for a report type, you can use the
report source Properties dialog box to modify it.
To modify a report type's source specification:
1. Expand the Local Computer node and the Configuration node.
2. Select the Report Sources node. The existing source specifications
are listed in the right pane of the AppXtender Reports Mgmt
Configuration utilities.
3. Right-click the source specification that you want to modify and
select Properties.
Configuring the Report Processor
331
Figure 154
4. From the Source Type drop-down list, you can select a different
report type. Select the report type that you want AppXtender
Reports Mgmt to associate with the specified source directory and
file name masks.
5. In the Priority text box, you can change the priority that has been
given to the source. The priority can be 0 or greater. This setting is
useful if you specify more than one source for a report type. For
each report type, the AppXtender Reports Mgmt Report
Processor processes sources with priority of 0 first, the sources
with a priority of 1 next, etc.
6. In the Source Directory text box, you can change the path to and
the name of the directory in which you want the AppXtender
Reports Mgmt Report Processor to find reports for processing.
(You can browse for a directory by clicking the Browse button.)
7. Under File Recognition, you have the following choices:
332
8. In the Included text box, you can change the file name mask. This
mask allows the AppXtender Reports Mgmt Report Processor to
recognize each report file from which you want to extract index
information, when it appears in the source directory. If you want
to specify more than one mask, use semicolons to separate them.
Specify this file name mask using any combination of the
following:
Characters that are normally allowed as file name characters
Wildcard characters, such as the question mark (?) to represent
a single character, and the asterisk (*) to represent any number
of characters
For example, to process all files with the TXT extension, specify
*.TXT.
Note: The AppXtender Reports Mgmt Report Processor can process only
the following file formats: PDF and ASCII. The file name mask that you
specify must match one of these file types.
9. In the Excluded text box, you can specify a file name mask to
protect files from being recognized as source files. If you want to
specify more than one mask, use semicolons to separate them.
Note: If the source directory is a subdirectory of the AppXtender Reports
Mgmt Report Processor working directory (C:\ERMXDATA by default),
AppXtender Reports Mgmt automatically and transparently excludes
LOG, CFG, DBF, and INI files, to preserve data integrity.
333
10. Under After processing, you can change what the AppXtender
Reports Mgmt Report Processor does with the report files after
processing. You have the following choices:
If you want the AppXtender Reports Mgmt Report Processor
to delete the source report files immediately after processing,
select Delete.
If you want the AppXtender Reports Mgmt Report Processor
to rename the source report files and keep them in the original
source directory after processing, select Leave Renamed File
In Original Directory. If the source directory is the same as the
working directory for the associated report type, AppXtender
Reports Mgmt deletes the renamed source report files after the
amount of time specified on the Processing tab of the
Properties dialog box for the report type. For more
information, see Configuring the Processing Page.
If you want the AppXtender Reports Mgmt Report Processor
to move the source report files to another directory after
processing, select Move Into Archive. In the Archive Root Path
text box, enter the path to the directory in which you want the
AppXtender Reports Mgmt Report Processor to move the
files. You can browse for a directory by clicking the Browse
button. Specify whether you want the archive directory to
have subdirectories in which the source report files are
organized by year, month, or day.
11. Click OK.
12. Resume the AppXtender Reports Mgmt Report Processor service
by right-clicking the Local Computer node and selecting Resume.
The Local Computer node's icon changes from red to green to
indicate that the AppXtender Reports Mgmt Report Processor
service has resumed running and the changes that you have made
are saved.
334
Deleting a Report
Source Specification
If you no longer need a source specification for a report type, you can
delete it.
CAUTION
When a source specification is deleted, all of the parameters that
have been specified for that source specification are permanently
lost. The set of report source files specified by a deleted source
specification cannot be processed until you use the new report
source wizard to create another source specification for that set of
report source files.
To delete a source specification for a report type:
1. Expand the Local Computer node and the Configuration node.
Select the Report Sources node. The existing source specifications
are listed in the right pane of the AppXtender Reports Mgmt
Configuration Admin. Right-click the source specification that
you want to delete and select Delete.
Note: If the AppXtender Reports Mgmt Report Processor is still running,
a message appears indicating that the processor must be suspended. To
suspend the processor, select the Local Computer node, and then select
Suspend from the Action menu. You can now delete the report source.
335
Using Logs to
Monitor the Report
Processor
336
Viewing Report
Processor System Logs
Figure 155
337
Figure 156
Figure 157
338
The length of time during which these logs are available for you to
monitor depends on the report type configuration and the Report
Processor configuration. The Files Keeping settings for the report
type and the Purging Timeout setting control how long each log file is
kept. For information, see Configuring the Processing Page and
Configuring Report Processor Performance.
To view the logs for each processed report:
1. In the AppXtender Reports Mgmt Configuration Admin, expand
the Report Processors node, the Local Computer node, the Logs
node, and then the Report Logs node.
2. Select the node for the report type for which you want to view
logs. In the right pane of the AppXtender Reports Mgmt
Configuration Admin, log records are listed, one for each report
file that AppXtender Reports Mgmt attempted to process with the
selected report type.
3. If there are more than 50 logs for the report type, right-click the
report type node and navigate between the log pages by selecting
First Page, Prev Page, Next Page, and Last Page.
Note: If you want to view the most current information, click the Refresh
toolbar button.
339
Column
Description
Log ID
Log Date/Time
The date and time the log was created. This value also indicates the time at which
AppXtender Reports Mgmt started to process a report.
Step
Status
Step Date/Time
The date and time at which AppXtender Reports Mgmt started the current step.
Errors
The number of errors that have occurred during the current extraction attempt.
Pages
The number of AppXtender pages generated from the current extraction. For
example, if AppXtender Reports Mgmt extracts 20 index records from three pages
of a four-page ASCII report, this column displays the number 3.
Extract Indexes
Upload Indexes
The number of index records uploaded to AppXtender from the current extraction. If
the number for Upload Indexes is lower than the number of Extract Indexes,
consider each of the following:
Some of the extracted index records may have failed to upload.
Some of the extracted index records may have been duplicates and, depending on
configuration for the report type, duplicates may have been combined. For
information, see Configuring the Upload Page.
Source Size
Restarts
The number of times that AppXtender Reports Mgmt has attempted to extract index
information from the report.
4. To view the message and history logs, right-click the log record
and select Properties. The Properties dialog box for that log
record appears. The Message Log tab is activated by default.
340
Figure 158
5. If you want to view the History Log, click the History Log tab.
The History Log appears. This log provides a history of the
information displayed as the log record in the right pane of the
AppXtender Reports Mgmt Configuration Admin. For each
change of Step or Status while processing a report, AppXtender
Reports Mgmt records a line in this log.
341
Figure 159
342
Column
Description
Log ID
Type
The report type that AppXtender Reports Mgmt used to attempt the processing of the
report.
Log Date/Time
The date and time the log was created. This value also indicates the time at which
AppXtender Reports Mgmt started to process a report.
4. To view the message and history logs, right-click the log record
and select Properties. The Properties dialog box for that log
record appears. The Message Log tab is activated by default.
Note: If you want to view the most current information, click Refresh or
press <F5>.
343
5. If you want to view the History Log, click the History Log tab.
The History Log appears. This log provides a history of the
information displayed as the log record in the right pane of the
AppXtender Reports Mgmt Configuration Admin. For each
change of Step or Status while processing a report, AppXtender
Reports Mgmt records a line in this log.
6. Consider using XDS Visual Tester to determine what happened
during the processing of the report. For instructions on
displaying XDS Visual Tester for a processed report, see
Displaying XDS Visual Tester for a Processed Report. You
should be able to determine how the report types configuration
or procedures are causing the AppXtender Reports Mgmt Report
Processor to fail when processing this report.
7. After you have corrected the report types configuration or
procedures, you can resubmit the report to the AppXtender
Reports Mgmt Report Processor for processing. For instructions,
see Allowing a Report to be Processed Again.
Displaying XDS Visual
Tester for a Processed
Report
344
345
3. Right-click the log for the report that you want to process again
and select Set for Rerun. AppXtender Reports Mgmt renames the
report file (and the corresponding INI file, if there is one) so that
the AppXtender Reports Mgmt Report Processor will recognize it
as a new report and process it.
Deleting the Logs for a
Processed Report
346
10
Using Form Overlay
Introduction ......................................................................................
Creating the _FORMS Application................................................
Adding Forms to the _FORMS Application.................................
Enabling Form Display ...................................................................
Modifying the Document Position in Relation to Form .............
348
350
353
355
356
347
Introduction
In addition to converting print stream files and extracting index
records from report files, AppXtender Reports Mgmt provides an
efficient means of viewing report pages in a finished format.
Extracted report data can be displayed along with corresponding
forms. A blank copy of the form is scanned or imported into
AppXtender, and the report data is superimposed upon the form.
This overlay replicates the original, formatted report printout from
any platform without consuming unmanageable amounts of paper
and time.
Note: You cannot use form overlay when your source report format is PDF.
For example, a bank prints its monthly statements onto special blank
form paper. Using AppXtender Reports Mgmt, the system
administrator extracts index records from the report data. The data is
compressed and imported automatically into the selected
AppXtender application with the extracted index records.
A blank copy of the banks standard statement form is stored in
another AppXtender application which is exclusively designated
for forms and contains display information in its index.
Both the report data and the form (from the two separate
applications) are displayed simultaneously in AppXtender, achieving
the form overlay. You can then display, print, or fax the statement in
the merged format.
AppXtender Reports Mgmt provides considerable flexibility in using
forms with report data:
348
Introduction
349
CAUTION
Do not edit the text in the Application Name text box. When
creating the _FORMS application, the application must be
named _FORMS.
4. Enable (or disable) the Multiple indexes referencing the single
document option and click Next. The applications Paths page
appears.
350
CAUTION
Do not change any of the default field values entered for the
application. Do not add, insert, modify, or delete any of the
pre-configured fields. If you accidentally change any of these
values, you must correct them. For details, see Index Fields for
_FORMS Application.
6. Click Next. If you have the Audit Trail turned on, the Audit Trail
page appears.
7. Click Next. The application's Index Image File Setup page
appears.
8. Click Finish. The _FORMS application is saved and displayed in
the application tree view.
Once created, you can view the configuration of the _FORMS
application the same way you would view the configuration of
any other application.
Table 54
Field Name
Data Type
Length
Special Consideration
FORM NAME
Text
None
FORM TYPE
User-defined List
N/A
UNITS
User-defined List
N/A
TOP OFFSET
Decimal/Numeric
351
Table 54
352
Field Name
Data Type
Length
Special Consideration
LEFT OFFSET
Decimal/Numeric
CPI
Decimal/Numeric
LPI
Decimal/Numeric
ORIENTATION
User-defined List
N/A
RESIZE RATIO X
Decimal/Numeric
RESIZE RATIO Y
Decimal/Numeric
353
Figure 160
Field Name
Field Explanation
FORM NAME
Enter the name of the form to be added; the name should match the name of the form as
it was specified in the AppXtender Reports Mgmt extraction procedure. For an example,
see Figure 161, AppXtender Configuration Dialog Box - COLD Tab.
FORM TYPE
From the drop-down list, select the type of the form that you have added:
IMAGE
ASCII
UNITS
From the drop-down list, select the unit of measurement that you want to use in the top
and left offset fields:
If you want to use inches, select IN.
If you want to use millimeters, select MM.
If you want to use lines for TOP OFFSET and characters for LEFT OFFSET, select LI.
TOP OFFSET
Enter the distance from the top of the page where you want the report data to start.
LEFT OFFSET
Enter the distance from the left of the page where you want the report data to start.
CPI
Enter the number of characters per inch on the report page. This value applies only to
image forms. For ASCII forms, specify zero (0).
LPI
Enter the number of lines per inch on the report page. This value applies only to image
forms. For ASCII forms, specify zero (0).
ORIENTATION
From the drop-down list, select the orientation that you want to use:
PORTRAIT
LANDSCAPE
RESIZE RATIO X This index field is provided for legacy data purposes.
RESIZE RATIO Y This index field is provided for legacy data purposes.
354
Figure 161
355
Figure 162
Field Name
Field Explanation
TOP
Enter the distance from the top of the page where you want the report data to start.
LEFT
Enter the distance from the left of the page where you want the report data to start.
CPI
Enter the number of characters per inch on the report page. (This value applies only
to image forms.)
LPI
Enter the number of lines per inch on the report page. (This value applies only to
image forms.)
Glossary
A
accessible security
Accessible security grants access to users in the group for only those
documents with index field values that match the secured value list.
(See also Document Level Security.)
annotation
annotation group
application
application security
profile
357
Glossary
Audit Trail is a feature that allows you to track user activity within
the AppXtender system. System-wide activities such as creating,
modifying, and deleting applications, users, and groups can be
tracked. You can also track user activity in applications by tracking
items such as creating and deleting documents, adding pages, and
modifying index information for documents. By default, AppXtender
logs audit trail events to a table in the AppXtender database. You can
configure audit trails to log to this table, to a log file, or to both
locations.
authentication
authorization
A feature within AppXtender that allows the use of the <F7> key to
import index values from a text file, so users adding documents can
automatically populate indexes using the imported data.
AppXtender Auto Index Import is ideal for the import of index
records that are applicable to only one document. In an Auto Index
Import table, once a record (or a group of index values) has been used
to index a document, the record is deleted.
C
check in/check out
mode
classification
358
Glossary
COLD
collection
D
data source
database
document
Document Level
Security
359
Glossary
E
ERM
extended
applications
F
full-text
G
global security profile
grab bar
I
impersonation
account
360
Glossary
import specification
inaccessible security
index
Index Server
J
JDBC
K
key reference import
361
Glossary
N
node
O
OCR
ODMA
OLE DB
P
page
privileges
R
record
362
Glossary
records management
records manager
redaction
retention
administration
S
security
security mapping
security provider
363
Glossary
W
write paths
364
Index
Numerics
2 byte length field, specifying for
AFP print stream type 150
Metacode print stream type 174
4 byte length field, specifying for
AFP print stream type 150
Metacode print stream type 174
A
account
AppXtender Reports Mgmt service account
25
used to install AppXtender Reports Mgmt 35
ACIF resource file, for AFP 153
adding
advanced rights 31
data fields 223
forms to _FORMS application 353
print stream types 140
procedures 228
report types 196
sources for print stream types 276
sources for report types 326
adjustment, character value, for PCL 183
advanced rights
adding 31
Log on as a service 31
AFM file, specifying for
AFP print stream type 156
Metacode print stream type 179
PCL print stream type 187
AFP print stream resources
ACIF resource file 153
365
Index
service account 25
services 252
setup wizard 35
AppXtender Reports Mgmt Configuration Server
assigning AppXtender Reports Mgmtservice
account 40
AppXtender Reports Mgmt Print Stream
Processor 16, 252
assigning AppXtender Reports Mgmt service
account 40
configuring performance 267
deleting source specifications 285
directories 254
modifying source specifications 281
monitoring logs 287
resuming service 266, 267, 271
specifying a System Log directory 266
specifying a working directory 265
specifying source directories 276
suspending service 263
System Log directory 259
working directory 257
AppXtender Reports Mgmt Report Processor 17,
298
assigning AppXtender Reports Mgmtservice
account 40
configuring performance 314
deleting source specifications 335
directories 299
modifying source specifications 331
monitoring logs 336
specifying a data export path 311
specifying a System Log directory 313
specifying a working directory 310
specifying B.I. gateway path 312
specifying source directories 326
System Log directory 305
working directory 304
AppXtender Reports Mgmt service account 25
adding advanced rights to 31
adding to Administrators group 29
assigning 40
configuring 25
create 27
specifying during AppXtender Reports
Mgmtinstallation 40
AppXtender Reports Mgmt services
Index
B
back, retracing your steps 80
backward-propagating index values 51, 221
BDW, specifying for
AFP print stream type 149
Metacode print stream type 174
Binary TFM, for PCL 185
business intelligence
changing data field for 225
configuring report source for 325
configuring report type for 208
creating data field for 223
definition of the term 65
deleting data field for 226
exporting data for 66
INI file for 325
licensing of B.I. gateway feature 90
specifying B.I. gateway path 312
specifying export path 311
writing scripts 209
buttons, toolbar 81
C
carriage control, specifying for
AFP print stream type 147
Metacode print stream type 172
changing name of
extraction procedure 238
print stream type 191
report type 213
changing order of procedures 236
character value adjustment, for PCL 183
characters per inch
changing for form overlay 356
specifying for form overlay 354
checking
index field list 218
procedure syntax 231
chunk size, specifying for a report type 205
clients
IBM DB2, configuring 101
IBM DB2, installing 100
Oracle, configuring 105
Oracle, installing 105
367
Index
CRLF
AFP print stream type 149
ASCII print stream type 159
definition of the term 139
EBCDIC print stream type 162
EBCDIK print stream type 165
Metacode print stream type 174
D
dashed lines, for Metacode 172
Data Access Components
See Microsoft Data Access Components 96
data export
configuring launch of script after 209
path 299
data fields
creating 223
deleting 226
modifying properties 225
specifying name 224
specifying propagation type 226
Data providers, OLE DB 96
data sources
definition of the term 96
modifying 131
refreshing list of 98
removing 133
viewing list of 98
database
definition of the term 96
specifying for a report type 200
dates
extracting 60
Y2K compliance 135
default file format, specifying for
AFP print stream type 148
Metacode print stream type 173
default origin, override (Metacode) 171
definition of terms
AppXtender Reports Mgmt Configuration
Data directory 256, 301
business intelligence 65
conversion, print stream file 138
CRLF 139
data source 96
database 96
Index
extraction 194
form definition 139
line data 139
MDAC 96
Microsoft Data Access Components 96
MMC 76
OLE DB 96
page definition 139
print stream 20
print stream type 138
procedure 228
PSF 139
report 20
report type 194
resources directory 258
service account 25
Snap-ins 76
source directory 275, 323
source specification 275, 323
system log directory 259, 305
working directory 257, 304
working subdirectory 257, 304
XDS 50
delete after processing, specifying for
print stream source 279, 283
report source 330, 334
delete temporary files, specifying for
AFP print stream type 143
ASCII print stream type 157
EBCDIC print stream type 161
EBCDIK print stream type 164
Metacode print stream type 167
PCL print stream type 180
deleting
AppXtender data sources 133
data fields 226
logs for processed print stream 296
logs for processed report 346
print stream source specifications 285
print stream types 192
procedures 239
report source specifications 335
report types 216
description, specifying for
AFP print stream type 143
ASCII print stream type 157
EBCDIC print stream type 160
E
EBCDIC decimal length field, specifying for
AFP print stream type 150
Metacode print stream type 174
EBCDIC print stream types, creating 160
EBCDIC print stream types, specifying
CRLF 162
369
Index
F
failed process
print stream log for 293
report log for 342
failure, time report files kept after 207
file format for data export, specifying 209
file name mask
print stream source 278, 283
report source 328, 333
files, delete temporary, specifying for
AFP print stream type 143
ASCII print stream type 157
EBCDIC print stream type 161
EBCDIK print stream type 164
Metacode print stream type 167
PCL print stream type 180
first page, ASCII report view 215
fixed line length
ASCII print stream type 159
EBCDIC print stream type 162
Index
G
glossary
I
IBM control characters
ASCII print stream type 159
EBCDIC print stream type 162
EBCDIK print stream type 165
IBM DB2
configuring clients 101
installing clients 100
IDEN string (Metacode) 170
importing AppXtender Reports Mgmt
configuration data 86
Inclusive length field, specifying for
AFP print stream type 150
Metacode print stream type 174
index fields 217
_FORMS application 353
checking the list 218
displaying format and required columns 218
modifying propagation 220
specifying propagation type 221
synchronizing with the database 219
indexing options, for a report type 51, 201
INI file for report source 325
inline fonts (PCL) 183
input
print stream source 277, 281
report source 327, 332
installing
AppXtender Reports Mgmt 35
IBM DB2 Client 100
Oracle Client 105
Sybase SQL Anywhere clients 107
instruction, XDS 229
internal form definition, override (AFP) 147
invalid index records 248
Inverse orientation, specifying for
AFP print stream type 154
Metacode print stream type 177
371
Index
J
JDL/JDE, start via (Metacode) 170
L
Landscape orientation, specifying for
AFP print stream type 154
Metacode print stream type 177
PCL print stream type 186
last page, ASCII report view 215
launching
AppXtender Reports Mgmt Configuration
utility 75
print stream source wizard 276
print stream type creation wizard 141
report source wizard 326
report type creation wizard 197
script after data export 209
XDS Visual Tester for processed report 344
XDS Visual Tester for sample report 242, 243
left offset
changing for form overlay 356
specifying for form overlay 354
length field, specifying for
AFP print stream type 149
Metacode print stream type 174
levels
navigating 80
propagation 53
propagation, specifying for data field 226
propagation, specifying for index field 222
license agreement
AppXtender Desktop installation 36
license agreement page 37
License Server 88
License Check 89
Network Address 89
line break, specifying for
ASCII print stream type 159
EBCDIC print stream type 162
372
M
maintenance 71
managing
AppXtender Reports Mgmt Print Stream
Processor 252
AppXtender Reports Mgmt Report Processor
298
data sources 96
print stream types 138
report types 196
mask, specifying for
print stream source 278, 283
Index
373
Index
N
name mask, specifying for
print stream source 278, 283
report source 328, 333
name, changing for existing
extraction procedure 238
print stream type 191
report type 213
name, specifying for new
AFP print stream type 143
ASCII print stream type 157
data field 224
EBCDIC print stream type 160
EBCDIK print stream type 163
extraction procedure 229
form overlay in AppXtender 354
Metacode print stream type 166
PCL print stream type 180
report type 198
navigating
AppXtender Reports Mgmt Configuration
utility 80
ASCII report view 215
up one level 80
Net Configuration Assistant, Oracle client
configuration 106
Net Manager, Oracle client configuration 105
Network Address
License Server 89
next page, ASCII report view 215
non printable spacing characters, Metacode 172
non-propagating index values 51, 221
O
ODBC data source, creating for
MySQL 112
Sybase SQL Anywhere 108
offset, specifying for
AFP print stream type 147, 155
form overlay, left 354, 356
form overlay, top 354, 356
Metacode print stream type 178
PCL print stream type 187
OLE 96
OLE DB
data providers installed with MDAC 97
374
P
page break, specifying for
ASCII print stream type 159
EBCDIC print stream type 162
EBCDIK print stream type 165
page definition
definition of the term 139
file, specifying for AFP 146
page orientation, specifying for
AFP print stream type 154
Metacode print stream type 177
PCL print stream type 186
page, resources for AFP print stream type
page definition 152
page overlays 152
page segments 152
pages, for each processed report 340
paper tray, specifying for PCL 183
Index
375
Index
creating 276
deleting 285
modifying 281
print stream source wizard 276
input 277
output 280
print stream types
AFP 142
ASCII 156
configuration glossary 139
creating 140
creating source specifications for 276
definition of the term 138
deleting 192
deleting source specifications for 285
EBCDIC 160
EBCDIK 163
editing 189
Metacode 166
modifying 189
modifying source specifications for 281
PCL 179
renaming 191
print stream types, creating
AFP 142
ASCII 156
EBCDIC 160
EBCDIK 163
Metacode 166
PCL 179
print stream types, resources
AFP 145, 151
Metacode 169, 175
PCL 182, 184
priority, specifying for
print stream source 277, 282
report source 327, 332
procedures 228
creating 228
definition of the term 228
deleting 239
editing 237
modifying order of 236
report type with multiple 228
specifying name 229, 238
testing syntax 231
processing
376
Q
question mark, in index field icon 218
R
rasterize fonts, specifying for
AFP print stream type 144
Metacode print stream type 168
RDW, specifying for
AFP print stream type 149
Metacode print stream type 174
Records Manager for ApplicationXtender,
classifying and transferring AppXtender
Reports Mgmt documents 205
red check mark, in index field icon 219
Index
refreshing
list of AppXtender data sources 98
list of failed logs 294, 343
list of logs 288, 292, 337, 339
log view 290, 292, 295, 338, 341, 343
remote components, security 25
remote use of AppXtender Reports Mgmt
Configuration utility 77
removing
AppXtender data sources 133
data fields 226
print stream source specifications 285
print stream types 192
procedures 239
report source specifications 335
report types 216
rename after processing, specifying for
print stream source 279, 283
report source 330, 334
renaming
print stream type 191
report type 213
reordering procedures 236
report
definition of the term 20
files, processing 64
log 339
log for failed process 342
logs, deleting 346
reprocessing file 345
Report Processor system log 337
report source
after processing, specifying 330, 334
archive after processing, specifying 330, 334
delete after processing, specifying 330, 334
directory, specifying 327, 332
path, specifying 327, 332
priority, specifying 327, 332
properties 331
properties input 332
rename after processing, specifying 330, 334
wizard 326
wizard input 327
report source specifications
creating 326
deleting 335
modifying 331
377
Index
S
sample
file, specifying for a report type 199
reports, viewing 214
scale, specifying for
AFP print stream type 154
form overlay 354, 356
Metacode print stream type 177
PCL print stream type 186
scripts
launching 209
writing 209
Search Drives 134
security
account used to install AppXtender Reports
Mgmt 35
AppXtender Reports Mgmt service account
25
selecting
AppXtender data sources 94
service account
definition of the term 25
specifying 40
setup wizard
installing AppXtender Reports Mgmt 35
378
Index
T
templates, form 349
temporary files, delete, specifying for
AFP print stream type 143
ASCII print stream type 157
EBCDIC print stream type 161
EBCDIK print stream type 164
Metacode print stream type 167
PCL print stream type 180
testing procedures
recommended method 235
syntax 231
XDS Visual Tester 241, 248
testing report types
recommended method 235
XDS Visual Tester 241, 248
text image of report 229
U
uninstalling ApplicationXtender 42
units of measurement, for form overlay 354
up, navigating AppXtender Reports Mgmt
Configuration utility 80
upgrading
from previous versions of AppXtender
Reports Mgmt 24
upload indexes, for each processed report 340
uploading options
key reference update, for a report type 203
launch full text indexing to queue 203
merge index with existing document 203
transaction rollback, for a report type 203
unique index key validation 203
V
viewing
ASCII sample reports 214
list of AppXtender data sources 98
PDF sample reports 216
sample reports 214
Volume Label Search Drives 134
W
wizard
form overlay application creation 350
installing AppXtender Reports Mgmt 35
ApplicationXtender Reports Management Administrators Guide
379
Index
X
XDS
definition of the term 50
instruction 229
XDS Visual Tester
displaying for processed report 344
displaying for sample report 242, 243
introduction 241
panes 244
Report Text view toolbar 247
testing 248
toolbar 245
Xerox, Metacode print stream type
Font Widths 176
Fonts 176
Forms 175
Images 175
Logos 176
Y
Y2K compliance, date index values 135
year 2000, date index values 135
380