Nobix ElectroPage Report Management Utility Administrator's Reference Guide
Below you will find brief information for ElectroPage. This software utility offers maximum flexibility in report management, providing online viewing, on-demand print distribution, and automatic banner pages. It includes features like job verification before printing, electronic delivery via email, and management of IBM job listings. ElectroPage allows users to view and search report listings from any terminal or PC, locally or remotely, at any time, reducing the need for manual printing and distribution.
Advertisement
Advertisement
ElectroPage™ Administrator’s Reference Guide
MPE/iX
Version 6.1f
ElectroPage™ Administrator’s Reference Guide
(MPE/iX)
Version 6.1f
June, 2005
The information contained in this document is subject to change without notice.
Nobix, Inc. makes no warranty of any kind with regard to this material, including but not limited to the implied warranties of merchantability and fitness for a particular purpose.
Nobix, Inc. shall not be liable for errors contained herein or for incidental or consequential damages in connection with the furnishing, performance or use of this material.
This document contains proprietary information that is protected by copyright. All rights are reserved. No part of this document may be photocopied, reproduced or translated in any form, or into any other language, without the prior written consent of Nobix, Inc.
© Copyright 1990, 1991, 1993, 1996-1999, 2000-2003 by Nobix, Inc.,
San Ramon, California, Phone 800.538.3818 or 925.659.3500, Fax 925.659.3599.
e3000 and MPE/iX are trademarks, registered trademarks, trade names, and/or products of
Hewlett-Packard Company. JobQue and JobRescue, are trademarks and/or products of
Nobix, Inc. All other trademarks are the property of their respective holders.
Table of Contents
Table of Contents
Nobix ElectroPage Administrator’s Reference Guide 1
Table of Contents
Nobix ElectroPage Administrator’s Reference Guide 2
Table of Contents
Nobix ElectroPage Administrator’s Reference Guide 3
Preface
This document provides operation, administration and configuration guidelines for the
ElectroPage software product from Nobix, Inc.
ElectroPage is a report management software utility that provides on-line viewing of reports, and flexible configuration options to organize, distribute, search, and print reports.
JobPak and Installation
ElectroPage is one of the three Nobix data center productivity tools bundled under the name
JobPak. The JobPak tools consist of the following:
• JobQue
• JobRescue™
• ElectroPage™
Together these products offer information technology managers and staff the production class, system management capabilities needed to keep a single or networked HP e3000 systems running at peak efficiency. The JobPak tools are used as a standard by Hewlett-
Packard IT centers and by HP customers worldwide to provide productive and efficient operations on the e3000.
Although the JobPak products can be purchased and used individually, they all run in the background under the JobPak batch job. The Installation of ElectroPage, and/or any of the other JobPak products, is described in the JobPak Installation and Update Guide. Review this document before attempting to install or upgrade ElectroPage or any of the other JobPak software tools.
ElectroPage training classes are also available to provide training that will aid in administering ElectroPage. Please check with Nobix regarding training schedules and cost.
Nobix ElectroPage Administrator’s Reference Guide 4
Preface
How this document is organized
Chapter 1, “Using ElectroPage,”
provides an overview of the ElectroPage product and offers basic descriptions of its main features.
describes how to start and stop the ElectroPage program.
Chapter 3, “The CONFIGX Program,”
provides detailed information on how to modify the basic ElectroPage configuration without stopping the program.
Chapter 4, “The STATUS Program,” provides detailed information on how to run and use
the ElectroPage STATUS program.
Chapter 5, “The JPAKCOM Program,” provides detailed information on how the
JPAKCOM program commands that control the operation of ElectroPage.
Chapter 6, “Deferring Reports,” describes the
EPXEQ.PUB.NSD MPE command file that controls the priority state of reports.
Chapter 7, “MPE :XEQ scripts,” describes the formatting of variables in the
PARM header line.
Appendix A, “The AutoDial Program,” provides information on running and using the
AutoDial program.
Appendix B, “Banner Page Definition,”
provides complete reference information for defining banner pages.
Appendix C, “The UNLOAD Program,”
discusses the UNLOAD.JKPAK.NSD
program which allows system administrators to make global changes to the configuration files contained within the CONFIGIX program.
Assumptions
This document assumes that the reader is familiar with e3000 computer systems and the
MPE operating system. It is intended to be used by system administrators, managers and any other users of the ElectroPage software utility.
Readers should also be familiar with the e3000 manuals published by the Hewlett-Packard
Company.
Related documents
• JobPak Installation and Update Guide
• JobPak Release Notes
• JobQue Administrator’s Reference Guide
• JobRescue Administrator’s Reference Guide
• Nobix Web site www.nobix.com
Technical support
Nobix provides 24x7 technical support (including weekends and holidays) for customers with current maintenance agreements.
The ElectroPage software uses the latest operating system technology and requires an e3000 system running MPE/iX version 5.0 or later.
Nobix strives for efficient and reliable software; however, if you encounter any problems that this manual does not address, or find an error, contact Nobix technical support:
Nobix ElectroPage Administrator’s Reference Guide 5
Preface
Nobix, Inc.
3180 Crow Canyon Place, Suite 255
San Ramon, CA 94583
925.659.3500
800.538.3818
925.659.3599 fax
If you fax your question, include your name, phone number, and fax number on the cover sheet. Usually, we call you as soon as we receive your fax.
If you report a limitation or problem, we will either fix it or provide a workaround as soon as possible.
If you will allow us dial-up access to your machine, please have the dial-up number and passwords available. We do not sign on to every machine; however, sometimes it is easier to solve a problem when we can see it happen.
If you cannot find an answer in this manual, contact us!
Nobix ElectroPage Administrator’s Reference Guide 6
Chapter 1
Using ElectroPage
This chapter provides an overview of the Nobix ElectroPage software for the e3000.
Introduction
The ElectroPage software utility provides maximum flexibility in report management. You have access to reports online, as well as on-demand print distribution capability. Features include:
• Online access to reports
• Automatic banner pages with distribution information
• Job verification before printing reports
• Electronic delivery of reports through e-mail distribution
• IBM job listing management
ElectroPage provides electronic report distribution directly to the end user. This relieves the data center of the burden of needless printing and manual distribution. Report listings can be viewed and searched from any terminal or PC, local or remote, at any time.
Report management
Management of reports in ElectroPage consists of the following:
• Defining reports—reports can be defined with the configuration menus, using a formsbased interface, as described in
Chapter 3, “The CONFIGX Program.” This includes
specifications to process spoolfiles globally, and for specific reports. The menus also incorporate other spoolfile management tasks.
Nobix ElectroPage Administrator’s Reference Guide 7
Chapter 1 Using ElectroPage
• Saving reports—ElectroPage can be configured to save reports for a specified number of iterations or days. Reports can be saved and printed, saved and deleted from the spool system, deleted and not saved, or printed without saving them. Reports must be saved before they can be accessed online. These options are described in
• Deleting reports—ElectroPage can be configured to delete reports after processing or as scheduled in the retention management cycle. These options are described in
• Output priorities—ElectroPage can be configured to define output priority globally for all spoolfiles. Optionally, the output priority, the printing device, and the number of copies to print for specific reports can also be designated. These options are described in
Chapter 3, “The CONFIGX Program.”
• Banner pages—ElectroPage can be configured to automatically attach a banner page to a report. Banner pages become part of the original spoolfile. After a banner is defined, up to 48 user names or bin locations can be assigned to the distribution list.
These options are described in Chapter 3, “The CONFIGX Program.” A detailed description
of banner page definition commands appears in
Appendix B, “Banner Page Definition.”
.
Note:
When ElectroPage saves a report for online access, it does not include the banner page.
Online access
The STATUS program provides interactive viewing, searching and printing of spoolfiles that have been examined and saved by ElectroPage. The advantages of on-line electronic report distribution include:
• Reports are accessible to users as soon as they have been created.
• Security levels can be assigned by the ElectroPage administrator to specify who has access to any particular report or group of reports.
• Viewing preferences can be configured and saved for individual users.
• Indexes can be assigned to reports to facilitate searching.
• All or part of a report being viewed can be printed. Users can print only those portions of a report that they need a hardcopy of, thereby saving time and paper.
For details, refer to Chapter 4, “The STATUS Program.”
Job verification
Before allowing ElectroPage to process and then print reports created by a specific job,
JobRescue can be used to verify that the job ran successfully. Reports that contain invalid data or other errors can be caught prior to printing, thereby saving a potentially large quantity of paper.
Note:
JobRescue must also be licensed to use this feature.
If JobRescue has been licensed, verification can be performed at the job level to prevent the printing of reports that have resulted from failed jobs. To check the job that created the
Nobix ElectroPage Administrator’s Reference Guide 8
Chapter 1 Using ElectroPage report, configure the Report processing options, Wait or Verify mode as described in the
“Configuring report-specific values” section of
Chapter 3, “The CONFIGX Program.”
Report delivery
The e-mail distribution configuration file can be used to integrate reports with internet mail or HPDesk. When you send the text of a report through e-mail, ElectroPage always sends the file as the original spoolfile (of variable length), with the original carriage control in the first byte.
ElectroPage can be given an internet mail ID as well as an HP DeskManager ID. This identifies ElectroPage when a report is submitted to e-mail, which allows the receiving user to see who sent the report. For details, refer to the “Miscellaneous system values” section of
Chapter 3, “The CONFIGX Program.”
Error handling
If ElectroPage finds an error in a spoolfile, it sends a message to the console. ElectroPage can be directed whether it should generate automatic copies of the report, and whether it should retain a permanent file. The original spoolfile can either be deleted automatically or left in the spool system to be printed or disposed of by the operator.
IBM job listings
ElectroPage considers IBM job listings to be reports that should be treated as $STDLISTs.
When an IBM job listing is saved on disc, it is grouped with the MPE $STDLISTs and accessed like a $STDLIST. However, when ElectroPage examines it in the spool system, it is treated as a report. This dual standard is an important concept.
In order for the NRJE shop to handle IBM jobs on the e3000, the IBM job listings need to be configured so that ElectroPage manages them using the same logic as $STDLISTs.
$STDLISTs are generated by MPE and they all look very similar. For instance, they all have a :JOB command at the beginning and they usually contain logon/logoff information. On the other hand, ElectroPage knows nothing about the format of a foreign job listing. To configure an IBM job listing, refer to “Configuring IBM sysout values” in
Report viewing
Any examined report can be viewed online at any time, using Report mode in the STATUS program. The STATUS program enables viewing of the current and previous days' reports, as well as archived job statistics for each report. Programmers and system managers can use
STATUS to check on the completion of any job. STATUS can be used whenever examination of batch history is necessary.
STATUS can display a one-line summary of each report examined, showing job number, logon ID, error status, number of pages, and the time the report was examined.
The STATUS program can be used to search reports individually or collectively for text online, using only a few simple keystrokes. Using a menu-driven user interface referred to as the Viewer, portions of text can be viewed and copies made.
Since security of job listings and reports are important, ElectroPage allows security to be set at the user, account and operator capability levels. By default, any user can view any job listing.
Nobix ElectroPage Administrator’s Reference Guide 9
Chapter 2
Getting Started
This chapter describes how to start, run and stop the Nobix ElectroPage software for the e3000.
Introduction
ElectroPage is designed to allow quick installation of the software from tape and immediate use of it. After installation, the JobPak job can be streamed and ElectroPage begins processing.
To install the software, refer to the JobPak Installation and Update Guide.
Startup
Nobix supplies a job control file named JOBPAK.JPAK.NSD
that starts ElectroPage. If you have also licensed JobQue or JobRescue, this file also starts these programs.
To start ElectroPage (as well as JobPak), enter the MPE command:
:STREAM JOBPAK.JPAK.NSD
When ElectroPage begins execution, it displays a logon banner on the system console.
ElectroPage proceeds to examine all READY state reports that have been configured in the
CONFIGX program.
Running ElectroPage
ElectroPage runs in the background under the JobPak batch job. If ElectroPage is inadvertently terminated, just stream the job again. ElectroPage should pick up where it left off without loss of data.
Nobix ElectroPage Administrator’s Reference Guide 10
Chapter 2 Getting Started
Spoolfile priorities
Reports are automatically enabled to be deferred when a user signs on. ElectroPage uses procedure exits to allow the MPE/iX operating system to notify it when a non-$STDLIST spoolfile goes from a CREATE state to a READY state. When this occurs, the report's priority is set to zero, and a message is sent to the ElectroPage process running in the JobPak job, indicating that the report has become ready and what the original priority is. Using this method, it is not necessary to ensure that reports are at, or below, the outfence for their destination device (which would have kept them from printing before ElectroPage could capture them). For more information, refer to
Chapter 6, “Deferring Reports.”
Error handling
ElectroPage is not initially configured to look for error messages in reports. The error messages originally supplied in the Configuration file are meant to be used with JobRescue; however, both global and report-specific messages can be added to the Configuration file.
ElectroPage will search any or all reports for these messages. For details, refer to the “Global error string text” section in
Chapter 3, “The CONFIGX Program.”
When ElectroPage finds an error message or other job exception within a report, it notifies the operator and other users by sending a series of messages to the console and to other user’s sessions.
There are many things ElectroPage can be directed to do when it finds an error; this can include execution of a predefined set of MPE commands specific to a report. For example,
ElectroPage can be directed to run the AutoDial program to notify system operators of an error, by calling their pager. ElectroPage can do all this automatically. To configure AutoDial, refer to
Appendix A, “The AutoDial Program.”
JobPak logs all its console messages to a message history file. If JobRescue is also used, this file can be accessed with the MESSAGES command in the STATUS program, as described in the JobRescue Administrator’s Reference Guide. The message history file is a circular type of file and stores a preset number of messages. The STATUS program allows searching of the messages forward or backward.
The CONFIGIX program
The CONFIGIX program maintains all of ElectroPage’s configurable options. JobQue and
JobRescue also use this file.
To access the configuration program and menus, sign on as the NSD account manager:
HELLO MGR.NSD
At the MPE prompt, type:
CONFIGIX.JPAK
CONFIGIX uses a forms-based menu interface to issue commands. Most of the commands are self-explanatory and easy to understand.
The types of configurable entries available include:
• Access
• Retention
• User exits
• Message checking
Nobix ElectroPage Administrator’s Reference Guide 11
Chapter 2 Getting Started
• Error handling
• Indexing
For detailed descriptions of configuration commands, refer to Chapter 3, “The CONFIGX
Note:
Only one user at a time can make changes within the CONFIGIX program. Other users remain in a read-only status.
The STATUS program
All viewing and searching of saved spoolfiles, $STDLISTs and reports is done using the
STATUS program.
To access the STATUS program, at the MPE prompt, type:
STATUS.JPAK.NSD
All $STDLIST activity and ElectroPage information is available online via this program. For details, refer to
Chapter 4, “The STATUS Program.”
Passwords and security
Most environments require the NSD account to be password protected or have some other adequate security protection. To provide this protection, modify the job control file
JOBPAK.JPAK.NSD
.
Caution:
Do NOT alter the access parameters of the NSD account or the JPAK or PUB groups.
Stopping ElectroPage
To stop ElectroPage (as well as JobPak), enter the MPE command:
:JPAKCOM.JPAK.NSD STOP
Note:
Only users who have OP or SM (administrator) capabilities can use this command.
ElectroPage will log off shortly afterward, as soon as all processing has been completed.
Note:
If either JobRescue or JobQue are licensed for use, they will also log off.
Nobix ElectroPage Administrator’s Reference Guide 12
Chapter 3
The CONFIGX Program
This chapter describes how to use the menu-driven Nobix JobPak software configuration program.
Introduction
ElectroPage provides the menu-driven program CONFIGIX to specify configuration options. The fully qualified program name is CONFIGIX.JPAK.NSD
.
Use the CONFIGIX user interface to customize ElectroPage to meet specific site and application needs.
Operators can make changes to the CONFIGIX program even while ElectroPage is running.
The JobPak job does not need to be stopped first. ElectroPage becomes aware of the changes that is made and immediately loads them.
Note:
Only one user at a time can make changes within the CONFIGIX program. Other users remain in a read-only status.
Configuration menus
When the configuration program opens, the Main Configuration menu appears:
Nobix ElectroPage Administrator’s Reference Guide 13
Chapter 3 The CONFIGX Program
Nobix
This is the Main Configuration menu used to access the submenus and commands. Function buttons appear at the bottom of the window, providing a shortcut method to execute commands. These buttons correspond to the F1—F8 function keys on your keyboard. (Some of these buttons remain undefined.)
The Main Configuration menu contains the following menu items:
•
Configure GLOBAL Values —configuration information and default values applying to all reports.
•
Configure REPORT Specific Values —configuration information specifically identifying reports by logon ID.
•
Configure IBM Sysout Values —configuration information specifically identifying reports to be handled as $STDLISTs. (Appears only if you have JobRescue.)
•
Configure FOLDER Organization —configuration setup for organization of report files for viewing purposes.
•
Configure RETENTION Management —configuration time check, determining which files need to be deleted, based on length of save and when this program is to run.
Use the UP and DOWN arrow keys to move through the menu. To choose a menu item, highlight the selection and press ENTER . (Menu selections with trailing dots indicate a path to another menu.) After a command is selected, a forms-based interface is displayed that prompts the user for any required input.
ElectroPage Administrator’s Reference Guide 14
Chapter 3 The CONFIGX Program
Certain CONFIGIX commands are report-specific, while others are global, as follows:
• Global commands apply to all reports and IBM listings.
• Report-specific commands apply to all reports or to a particular report (or IBM listing specified by a particular entry into the configuration).
To configure spoolfiles globally or for specific jobs, refer to “Configuring global values” and
“Configuring report-specific values” in this chapter.
Saving configurations
After configuring spoolfiles, or making changes to the configuration, press F8-PREV SCREEN to save changes and exit the program. When the Main Configuration menu is displayed, press F8-EXIT PROGRAM and respond to the following screen prompt:
Nobix
To save changes, tab to OKAY and press ENTER .
To exit without saving changes, tab to CANCEL and press ENTER . The program will return to the Main Configuration menu.
When a message such as “ Config Modified ” dynamically appears at the top of the menu or interface during a session, it is a reminder that modifications have been made to the configuration. See the following example:
ElectroPage Administrator’s Reference Guide 15
Chapter 3 The CONFIGX Program
Configuring global values
To configure global values, from the Main Configuration menu, select Configure GLOBAL
Values. The Configure Global Values submenu appears:
Nobix
The Configure Global Values menu offers the following options:
•
Processing options —configures values that modify the logic used to determine where an error occurs.
•
Global error string text —searches for specified character strings in every report examined.
•
Post-processing options —determines how spoolfiles are to be treated after examination.
ElectroPage Administrator’s Reference Guide 16
Chapter 3 The CONFIGX Program
•
Messaging configuration —determines the types of messages routed and their destinations.
•
MPE :XEQ scripts—command files set up to process spoolfiles after a report is examined; executes up to six command files at a time.
•
Security level —determines one of four levels of security for spoolfile access.
•
Miscellaneous system values —system ID, location variables, and compression ON/OFF.
Global commands apply to all reports. Detailed instructions for each item follow.
Processing options
To specify processing inputs for all jobs, from the Configure Global Values menu select
Processing options (described above). The Processing Options dialog box appears:
Nobix
To modify the logic that determines how errors are processed in spoolfiles, enter values in each field as indicated below:
•
Allow foreign spoolfiles —enter a Y here to have the current system recognize reports from jobs on other systems or from a previous run (owned by reports that have an apostrophe in job ID). An N instructs ElectroPage to ignore such spoolfiles.
•
Lowest output priority to process —enter a positive integer between 0 and 14 in this field to set the minimum output priority to which a report can be queued and still be considered for examination by ElectroPage.
ElectroPage Administrator’s Reference Guide 17
Chapter 3 The CONFIGX Program
•
Highest output priority to process —enter a positive number between 0 and 14 in this field to set the maximum output priority to which a report can be queued and still be considered for examination by ElectroPage.
•
Maximum number of $STDLIST lines to process —this entry pertains to JobRescue only.
For more information, refer to processing options in the JobRescue Administrator’s
Reference Guide.
•
Follow Mpe IF/THEN/ELSE logic —this entry pertains to JobRescue only and should be ignored.
•
Check for :EOJ in every $STDLIST —this entry pertains to JobRescue only. (To check for
:EOJ globally or for specific jobs, refer to the JobRescue Administrator’s Reference Guide).
•
Follow MPE :CONTINUE logic —this entry pertains to JobRescue only and should be ignored.
•
Empty spoolfiles (Ignore/Process/Delete) —enter a P to process any empty spoolfiles to be kept; enter an I for empty spoolfiles to be ignored; and enter a D to delete the spoolfile.
If an application generates a spoolfile that is important to log, processing this file is necessary, even though the spoolfile is empty.
•
Suppress banner on EXCPTLST —this entry pertains to JobRescue only and should be ignored.
•
Suppress banner on STDCOPY —this entry pertains to JobRescue only and should be ignored.
Global error string text
Although ElectroPage is not normally configured to look for error messages in reports, it can be configured to search for certain character strings in all reports. To do this, from the
Configure Global Values menu, select Global error string text. The Global Error String Text dialog box appears:
Nobix ElectroPage Administrator’s Reference Guide 18
Chapter 3 The CONFIGX Program
Nobix
The error messages originally supplied in this Configuration file are meant to be used with
JobRescue; however, if global or report-specific messages are added, ElectroPage will search any or all reports for these messages.
To add an error text string to the list, press F1-Add Item and enter text into the displayed field at the bottom of the screen. Press ENTER to add the specified text to the list.
ElectroPage handles the string of text as an exception when encountered in a report, and searches every report for any global error phrase as follows:
• If any non-displayable characters (ASCII value less than 32) are entered, ElectroPage translates them into spaces.
• The entire text line to be searched for does not need to be defined; the phrase only needs to contain a portion of the text. For instance, the phrase “JOB FLUSHED” will actually capture the error string “REMAINDER OF JOB FLUSHED.” It can be defined without worrying about character spacing or case in the file being searched since all spaces are removed and the phrase is converted to uppercase.
To delete an error text string from the list, highlight the entry and press F3-DELETE ITEM .
Tab to OKAY to complete.
To save your configuration changes, press F8-PREV SCREEN to return to the previous screen.
Press F8-PREV SCREEN again to return to the Main Configuration menu. Press F8-EXIT
PROGRAM and respond to the SAVE screen.
For job specific error strings, refer to “Configuring report-specific values” in this chapter.
ElectroPage Administrator’s Reference Guide 19
Chapter 3 The CONFIGX Program
Post-processing options
Post-processing options can be used to keep files online a certain amount of time after they have been examined, to purge (or not purge) reports after examination, and to set the printing priority to which reports will be adjusted after ElectroPage examines them.
From the Configure Global Values menu, select Post-processing. The Post Processing
Options dialog box appears:
Nobix
Enter values in each field, as described below.
It is necessary for ElectroPage to be able to remove old reports from permanent storage on disc. This maintenance action is important because without it, disc space would continue to fill up with reports, beginning with the date of installation of ElectroPage. Using postprocessing options, the configuration can be determined, as follows:
•
Default number of days to save $STDLIST s—this entry pertains to JobRescue only and should be ignored. For more information refer to the JobRescue Administrator’s Reference
Guide.
•
Purge $STDLISTs after exam —the default N prevents also pertains to JobRescue only and should be ignored.
•
Default output priority for reports —enter a number between -1 and 14 in this field; this sets the print priority to which ElectroPage will adjust the priority of reports after examining them. Entering a -1 ensures that the original priority will be restored.
ElectroPage Administrator’s Reference Guide 20
Chapter 3 The CONFIGX Program
•
Compress all saved spoolfiles —the default N prevents ElectroPage from performing
LZ77 compression on all newly saved spoolfiles. Enter Y in this field to perform LZ77 compression.
When there are existing uncompressed spoolfiles,
– Y causes ElectroPage to compress those previously uncompressed spoolfiles during idle periods.
– N does not cause ElectroPage to uncompress existing compressed spoolfiles. They remain compressed. To uncompress these files, manually run the decompression program against each compressed file.
After ElectroPage examines a report, it adjusts the report’s priority to the value specified, allowing files to print. This becomes the default for all files, unless a report-specific value is assigned to them. For more information, refer to
in this chapter.
Messaging configuration
After ElectroPage has examined a report, it sends a message to the system console, and other users, indicating the name of the report examined.
To control the message output to the console or to users, from the Configure Global Values menu, select Messaging configuration. The Messaging Configuration dialog box appears:
Nobix
Enter a value in each of the fields, as described below:
•
Disable examination messages —enter a Y in this field to prevent ElectroPage from sending messages to other users indicating the name of the report examined.
ElectroPage Administrator’s Reference Guide 21
Chapter 3 The CONFIGX Program
This setup does not prevent ElectroPage from sending error messages to the console and other users.
•
Disable console messages —enter a Y in this field to prevent all ElectroPage messages from being output to the system console.
•
Send messages to report creators —enter a Y in this field to have console messages simultaneously sent to users.
Any user whose logon user ID and account matches that of an examined report is notified of that examination.
Users can invoke the MPE command :SETMSG OFF , if they do not want to receive messages.
The default is :SETMSG ON .
To allow additional users on the system to receive the same messages ElectroPage sends to the console, add a list of these user names to the MPE file TELLUSER.JPAK
. This file uses the same syntax as the MPE :TELL command. The names should consist of the logon ID in the form of < jobname >,< user >.< account >, entered on one line. Add multiple names on one line, with the names separated by a semicolon, or add multiple lines.
MPE :XEQ scripts
To globally execute a set of MPE commands after a report or IBM job listing has been examined, from the Configure Global Values menu, select MPE :XEQ scripts. The MPE
:XEQ Scripts dialog box appears:
Nobix
Up to six global commands can be configured with this menu.
ElectroPage Administrator’s Reference Guide 22
Chapter 3 The CONFIGX Program
Enter the filenames into the fields provided. Use only valid MPE filenames that are available for read access to the MGR.NSD user. For more information, refer to the
:XEQ scripts” section in Chapter 7, “MPE :XEQ scripts.”
The MPE commands are performed by ElectroPage in the NSD account. ElectroPage always executes the MPE commands after examining reports and other IBM job listings. Files are executed in the order they appear, globally and then locally. See the “Executing specific
:XEQ files” section in this chapter.
Note:
To specify that no global MPE commands are to be performed for a specific report or
IBM job listing, refer to “Report-processing options” in this chapter.
Security level
Typically, all reports and IBM job listings examined by ElectroPage are accessible by any user of the computer system. Security is controlled through the use of the STATUS program.
To assign security restrictions to saved $reports, from the Configure Global Values menu, select Security level. The Security Level dialog box appears:
Nobix
At Default security level for all spoolfiles , enter one of the four levels of standard security restrictions, defined as:
•
0—No security —any user can access any file.
•
1—Low security —users can access any files created in their own accounts.
•
2—High security —users can access only files they created. AM users can access any file in their account.
ElectroPage Administrator’s Reference Guide 23
Chapter 3 The CONFIGX Program
•
3—Check Access —users have no access unless specifically allowed. For details, refer to
“Modifying file access” in this chapter.
Miscellaneous system values
To add the necessary system identifiers within one form, from the Configure Global Values menu, select Miscellaneous system values. The Miscellaneous System Values dialog box appears:
Nobix
Enter a value in each of the fields, as described below:
•
Company, Site, or Machine Name —enter a phrase containing up to 32 characters, including spaces, in the field provided.
For multiple computer systems, each system can be given a different designation; this can assist in identifying which report belongs with each system.
•
Internet Mail ID —assigns a name to the JobPak software to use as the sender address for e-mail. Use a valid, standard internet mail format, such as:
This e-mail address also receives return mail when the address mail is sent to is incorrect or unavailable.
•
SMTP Mail Server Hostname —enter the hostname of the network mail server.
ElectroPage Administrator’s Reference Guide 24
Chapter 3 The CONFIGX Program
•
HPDeskManager ID —enter a valid user identifier, including a location and sub-location, to specify the public distribution list name. The user name should be followed by an at sign (@), and the location and sub-location separated by a forward slash. For example:
“ElectroPage”@[DP/XX]
This field entry specifies ElectroPage’s HPDeskManager identifier, enabling ElectroPage to mail messages and deliver reports with the designated From address.
•
Do at Startup —enter the name of the MPE EXECUTE command file to be executed every time ElectroPage starts up.
This entry allows ElectroPage to execute a set of MPE commands when the program initializes. ElectroPage executes the commands defined when it begins execution. If
ElectroPage is stopped and restreamed, the commands are executed again.
• Number of Exam Processes—sets the maximum number of concurrent examination processes. The default is five. The value must be in the range 1 to 100.
Configuring report-specific values
This section describes how to adjust the configuration to search for specific messages and to perform particular operations in certain reports.
To configure job specific values, from the Main Configuration menu, select Configure
REPORT Specific Values. The Configure REPORT Specific Values submenu appears:
Nobix ElectroPage Administrator’s Reference Guide 25
Chapter 3 The CONFIGX Program
To add a report to be modified to the list, press F1–ADD ITEM and enter information into the fields, as follows:
•
FileDes —the file designator
•
JobName —the name of the job
•
UserName —the name of the user who created the report
•
AcctName —the account in which the job logs on.
•
Device —the device on which the report was created.
This setup uses standard MPE formatting. If any portions of the logon ID are blank or missing, they default to the wildcard character “@”. For instance, if you specify only the User
Name and Account Name, ElectroPage assumes the Job Name is “@”.
Since job logon IDs can be wildcarded, you can specify processing for a large set of reports using wildcards, and then define the exceptions without using wildcards. If a logon in a report matches more than one wildcarded entry, ElectroPage uses the first one on the list.
Alternately, select an existing file in the report listing to be modified, highlight it and press
ENTER . The Modify Configuration menu appears:
Nobix
The name of the selected report appears at the top of the menu, as shown in the example.
The Modify Configuration menu contains the following items:
•
Error string text —configures text to be handled as an error
•
Non-error string text —configures text that turns off an error line
ElectroPage Administrator’s Reference Guide 26
Chapter 3 The CONFIGX Program
•
Missing error string text —configures text that, if missing, causes an error condition
•
Report save options —sets number of days the specified file stays on the system after examination
•
Report processing options —configures values that modify the logic used to determine where an error occurs
•
MPE:XEQ scripts —defines MPE execution exceptions for a particular job
•
Email distribution: sends a message to a particular user after examining a particular file
•
View access —configures security access for a particular file
•
Pattern indexing —configures pattern index values
•
Banner Pages & Distribution —assigns a banner page for a particular file
Procedures for each of these menu items are described below.
Customizing error detection
ElectroPage searches for global error string text in all reports and will find most job-related exceptions. In addition, individual reports can be searched for additional errors, specific to those reports.
These error text strings are defined for individual reports using one of the following modification options:
•
Error string text —enter a string of characters for ElectroPage to handle as an exception or error when encountered in a specific report. There is no limit to the number of error commands that can be assigned to a report.
•
Non-error string text —enter a string of characters for ElectroPage to find, but not to be found as an error.
•
Missing error string text —specify a string of characters in this field that must appear in a report. If the specified phrase is not found, that report is treated as an exception.
To modify error string text, highlight one of the above options on the Modify Configuration menu, and press ENTER . The appropriate dialog box appears similar to the example below.
Nobix ElectroPage Administrator’s Reference Guide 27
Chapter 3 The CONFIGX Program
Press F1–Add Item and enter text in the corresponding field that appears at the bottom of the form. Press F8–PREV SCREEN to save changes and return to the Modify Configuration screen. Continue to press F8 until you can respond to the Save & Exit screen prompt.
Note:
When searching for report-specific errors, ElectroPage removes spaces and changes text to upper-case before the comparison.
Report save options
ElectroPage globally saves reports after they have been examined according to the number of days specified in Post-processing options as described in the
section of this chapter. The number of versions, or generations, to be kept can also be specified. Reports are always kept online for at least one day.
To modify the length of time a particular report is kept online, from the Modify
Configuration menu, select Report Save options. The Report Save Options dialog box appears:
Nobix ElectroPage Administrator’s Reference Guide 28
Chapter 3 The CONFIGX Program
Nobix
Enter values in the fields in the displayed form, as described below:
•
Number of days to save this —enter a positive number (up to 9,999) which will keep this report online for the indicated number of days.
There are no global values for reports. You must specify the number of days or generations to keep reports. If you do not enter a number of days or generations, the system does not retain or save the report.
•
Number of generations to save —enter a number to indicate how many generations
(versions) of a report must be kept.
This field may be used in conjunction with the previous field. For instance, specify three generations of a report to be kept no longer than ten days. If the generation field contains a zero or is blank, save by number of generations is disabled.
•
Description of report (optional) —enter a brief description of the report to aid in identification when listed.
ElectroPage Administrator’s Reference Guide 29
Chapter 3 The CONFIGX Program
Report-processing options
When you select Job processing options from the Modify Configuration menu, the Job
Processing Options dialog box appears:
Nobix
The global equivalents of these options are described in “Processing options” on page 17
They include:
•
Delete report after processing — N is the default. When a Y is entered, the following three fields are ignored.
•
Set to this OUTPRI after processing —enter a value from 1 to 14. Entering a -1 in this field ensures that the original output priority is restored.
•
Set to this DEVICE after processing —specify the device on which to print the report.
•
Set to this number of copies —enter the number of copies wanted to override the original value on the spoolfile.
•
Disable global error checking —enter a Y in this field to only look for local error messages.
•
Disable global XEQ’s —enter a Y in this field to execute only report-specific MPE command files.
•
Wait or Verify mode —enter W to cause ElectroPage to wait until the job that created the report is processed. This enables reports to be printed together.
Enter V to indicate that the creating job must be verified and its reports should not be processed to when there are errors in the job that created it.
ElectroPage Administrator’s Reference Guide 30
Chapter 3 The CONFIGX Program
If specification is not wanted for either Wait or Verify mode, enter an N .
Executing specific :XEQ files
To define MPE execution exceptions for a particular report, from the Modify Configuration menu, select MPE :XEQ Scripts. The MPE :XEQ Scripts dialog box appears:
Nobix
Up to six job-specific commands can be configured with this menu. Enter the particular
MPE script(s) to be added to the specified job in the fields provided. Then, tab to
OKAY
and press ENTER .
If both global and job-specific MPE commands are configured, ElectroPage always executes
the global execution files first. Refer to “MPE :XEQ scripts” in this chapter for more
inormation.
E-mail distribution
ElectroPage can be configured to send a message to a particular user after examining a particular file. The complete text of a file can also be sent. When a message is delivered, it is easy for the recipient to see that it originated with ElectroPage.
From the Modify Configuration menu, select Email distribution . The following dialog box appears:
ElectroPage Administrator’s Reference Guide 31
Chapter 3 The CONFIGX Program
Press F1–ADD ITEM and enter values in the three fields at the bottom of the screen, as follows:
•
Note or List
—enter an
L
or
N
to designate a complete listing or note, indicating that the complete text of a job should be sent, or just a message showing the job status.
•
Error —enter an E to indicate sending as an error condition, or leave the field blank to indicate sending as a non-error condition.
•
Address —enter the user’s Internet Email address or HPDeskManager address. Use the following format for the HPDeskManager address:
“username”@[location no./sublocation no.]
Use the following format for internet mail: [email protected]
Modifying view access
Report access is controlled at the global level by the security level configuration. For details
on global access setup, refer to “Security level” on page 23. In addition, it is possible to
extend additional access privileges to a user for a particular report. Prior to modifying report access, verify whether a user already has the access privileges they require. From the Modify
Configuration menu, select View Access. The name of the report to be modified appears at the top of the dialog box that appears.
Nobix ElectroPage Administrator’s Reference Guide 32
Chapter 3 The CONFIGX Program
Press F1–Add Item to assign view access to a user. Three fields appear at the bottom of the screen, as shown above. Enter the user’s logon ID as follows:
•
Job/Sess —the job name or session.
•
User —the name of the user who created the spoolfile.
•
Account —the account in which the spoolfile was stored.
The following wildcards may be used to allow pattern matching: the at symbol (@), the pound sign (#), and the question mark (?).
Pattern indexing
Pattern indexing uses MPE pattern matching expressions to provide a means of delineating index values. In ElectroPage, the pattern definition is treated as the index value.
Pattern matching expressions provide an extremely powerful yet flexible language for pattern indexing. This provides maximum versatility in using virtually any character sequence or pattern to denote index entries, using MPE pattern matching characters and any literal characters, within a column or row range, as detailed below.
From the Modify Configuration menu, select Pattern indexing. A dialog box similar to the following appears:
Nobix ElectroPage Administrator’s Reference Guide 33
Chapter 3 The CONFIGX Program
Nobix
Press F1–Add Item to enter a new pattern index. Nine entry fields appear at the bottom of the screen, corresponding to the six parameters described below (the pages, rows and columns entries each have a beginning and ending field). The numbers entered here must be relative to 1; a 0 indicates that the information in a field is not to be used.
•
Pages —enter the beginning page number and the ending page number in the first and second fields, respectively.
•
Rows —enter the beginning row number and the ending row number in the third and fourth fields, respectively.
•
Cols —enter the beginning column number and the ending column number in the fifth and sixth fields, respectively.
•
Length —enter the number pertaining to maximum length of the index value.
•
Pattern —enter the pattern, using standard MPE pattern matching characters: the at sign
(@) matches any single or multiple character sequence; the pound sign (#) matches any single digit; the question mark (?) matches any single character. All other characters correspond to themselves.
•
Description —enter a description of the index value; for example, account number .
The Pattern and Description fields can contain a maximum of 30 characters. When an entry is completed in the other fields, a dash is automatically added as a separator between one number and another, as in 0–999.
ElectroPage Administrator’s Reference Guide 34
Chapter 3 The CONFIGX Program
To reconfigure existing index values already assigned to a saved spoolfile, refer to the
Chapter 5, “The JPAKCOM Program.”
The STATUS program can be used to view available reports with indexes, and to display
index values. Refer to the “Indexing F5” section in
Chapter 4, “The STATUS Program.”
Using banner pages and distribution
ElectroPage can be configured to automatically attach a banner page to a report. The banner appears as large, easy-to-read block letters.
A banner page definition file defines the design of the banner/trailer page. It consists of a header that precedes the report, a trailer that ends it, and a distribution list that defines distribution and maintains user recipient information for a report or reports. Each definition file contains commands that describe the page size, text placement and text size. The banner page definition file is a standard editor file. For details on constructing custom definition files, refer to
Appendix B, “Banner Page Definition.”
To assign a banner definition filename and a distribution list to a spoolfile, from the Modify
Configuration menu, select Banner Pages & Distribution. The Banner Pages & Distribution dialog box appears:
Nobix
To modify the banner definition file, select Banner Options. The Banner Options dialog box appears:
ElectroPage Administrator’s Reference Guide 35
Chapter 3 The CONFIGX Program
Nobix
Enter values in the fields displayed, as described below:
•
Banner control value (0,1,2) —enter 0 to not have a banner appear on the printout. Enter
1 if all of the distribution names listed (using Distribution List Names, described below) are to be on every copy of the report. Option 1 extracts only the names from the
Distribution List and always uses the same default definition file, DEFBAN.JPAK.NSD
.
Enter 2 if a custom banner definition file is being used, which specifies that only the specified user has their name on their copy of the report.
•
Option 2 banner definition file —enter the name of the banner definition file that has been constructed, as described in
Appendix B, “Banner Page Definition.”
After specifying the banner definition file, the distribution list can be created. In this mode, users can be added and deleted from the distribution list. Up to 48 users can be specified for an individual report.
Note:
If reports have not been defined with distribution list names, a banner will not be added to the report
The Distribution List Names selection displays the following fields:
ElectroPage Administrator’s Reference Guide 36
Chapter 3 The CONFIGX Program
Select F1-ADD ITEM and enter a value in each field, as described below:
•
Name —enter the name of the user, up to 16 characters. When you choose Option 1 , this is the only needed entry. For more information, refer to Device and Priority .
•
Description —enter a description of the user, such as title or department, up to 28 characters.
•
Phone —enter the number to be displayed on the banner, up to 16 characters.
•
Device —enter the destination device where the copy will be printed, no longer than 8 characters (defaults to the original value if field is left blank).
•
Priority —enter a number from 1 to 13, to establish a printing priority (leave this field blank to use the original spoolfile’s output priority).
Each user specified can have an output device and priority. If a device or priority is not specified for a particular user, the device and priority assigned is the same assigned to the original copy. If
Option 1
has been chosen, the Device and Priority fields are ignored, since these values are controlled by Report processing options for report-specific values as described in Configuring report-specific values in this chapter.
To delete an entry, highlight it and select F3–DELETE ITEM .
Configuring IBM sysout values
To access this option, you must license and install both ElectroPage and JobRescue.
Nobix ElectroPage Administrator’s Reference Guide 37
Chapter 3 The CONFIGX Program
The capability to manage IBM listings is provided for sites that use one of the NRJE links to
IBM host machines. ElectroPage considers IBM job listings to be reports that should be handled like $STDLISTs; therefore, to enable the NRJE shop to handle IBM jobs on the e3000, the IBM job listings need to be configured so that ElectroPage manages them using the same logic that $STDLISTs use.
From the Main Configuration menu, select Configure IBM Sysout Values. The following job listing form appears:
Nobix
To enter the MPE job/session logon ID of a particular report to be processed as a
$STDLIST, press F1-ADD ITEM and enter values into the available fields, as described below:
•
FileDes —the file designator.
•
JobName —the name of the job or session.
•
UserName —the name of the user who created the spoolfile.
•
AcctName —the account in which the spoolfile was stored.
•
Device —the device on which the $STDLIST was created.
This setup uses standard MPE formatting. If any portions of the logon ID are missing, they default to the wildcard character “@”. For instance, if the User Name and Account Name are not specified, ElectroPage assumes the Job Name is “@”.
Processing can be configured for a large set of reports using wildcards, and the exceptions can be specified with specific entries.
ElectroPage Administrator’s Reference Guide 38
Chapter 3 The CONFIGX Program
Note:
If a logon in a report matches more than one wildcarded entry, ElectroPage uses the first one on the list.
To modify an existing job listing, highlight it and press ENTER . The following Modify menu appears:
The name of the selected job appears at the top of the menu, as shown above.
Note:
This Modify menu is identical to the Configure Report Specific Values Modify menu except for the $STDLIST SAVE options and Job processing options commands, which are described in the following sections.
Defining IBM MustMatch text
After selecting the job to be processed as an IBM sysout, from the Modify menu, select
Defining IBM MustMatch Text. The following dialog box appears:
Nobix ElectroPage Administrator’s Reference Guide 39
Chapter 3 The CONFIGX Program
Press F1–ADD ITEM and enter a message in the highlighted field, as shown above. More than one message can be entered. Tab to OKAY . When ElectroPage examines the spoolfile that matches the message(s), it will process it as an IBM sysout file.
$STDLIST save options
In ElectroPage, an IBM job listing is always kept online for at least one day. To modify the length of time a particular IBM listing is kept online, from the Modify menu, select
$STDLIST Save options. The $STDLIST Save Options dialog box appears:
Nobix ElectroPage Administrator’s Reference Guide 40
Chapter 3 The CONFIGX Program
Enter a value in each of the available fields, as described below.
•
Number of days to save this $STDLIS T—enter a positive number (up to 9999) which will keep this $STDLIST online for the indicated number of days.
Since the system will keep a $STDLIST for a minimum of one day, the default is to use the global value if a zero or blank is in this field.
•
Number of generations to save of this $STDLIST —enter a number to indicate how many generations (versions) of a job to be kept.
Use this field in conjunction with the previous field. For instance, specifying saving three generations of a job for no longer than ten days. If a zero or blank is in the generation field, the save by number of generations is disabled.
Job processing options
From the Modify menu, select Job processing options. The following dialog box appears:
Nobix ElectroPage Administrator’s Reference Guide 41
Chapter 3 The CONFIGX Program
Nobix
Enter a value in each of the available fields, as described below:
•
How to proceed —enter a number from 0 to 3, to specify:
0 —process normally and always save the $STDLIST.
1 —bypass; do not process; no other options apply.
2 —if errors are not found, do not save.
3 —delete the $STDLIST and do not process.
•
Delete $STDLIST after processing —entering Y in this field causes the OUTPRI and DEVICE fields to have no effect (see below). The $STDLIST is deleted from the spool system.
•
Set to this OUTPRI after processing —enter a value from 1 to 14. Entering -1 in this field ensures that the original output priority is restored.
•
Set to this device after processing —specify the device on which to print the spoolfile.
•
Follow MPE :IF commands in $STDLISTs —enter Y here if you want ElectroPage to recognize IF logic in a $STDLIST. ElectroPage will skip false conditions.
This means that when ElectroPage detects the line of text: “ EXPRESSION FALSE:
COMMANDS IGNORED...
” error checking is turned off. When a line containing
“ EXPRESSION TRUE ” or “ RESUME EXECUTION OF COMMANDS ” is found, error checking resumes. The primary use of this command is to prevent ElectroPage from detecting errors caused by the MPE :TELL command within job streams.
ElectroPage Administrator’s Reference Guide 42
Chapter 3 The CONFIGX Program
•
Check for :EOJ in $STDLIST —enter Y to ensure ElectroPage checks any $STDLIST for an
:EOJ . If an :EOJ is not found, an Exceptions List is printed and the $STDLIST is treated as though an error occurred.
An :EOJ can be missing from a $STDLIST because the job control used to stream the job did not contain an :EOJ ; because the job never completed; or, because the job was executing at the time the system crashed.
•
Ignore errors after :CONTINUE —enter Y in this field to direct ElectroPage to stop
$STDLIST examination for exception (or error) phrases at the line that contains the
:CONTINUE .
This command enables suspension of error examination in a job for short periods where anticipated errors occur. Examination for phrases begins again when the second colon (:) following the :CONTINUE is encountered. ElectroPage ignores any error messages or other phrases between those two points.
•
Disable global error checking —enter Y here to look for only local error messages.
•
Disable global XEQ’s —enter Y here to execute only job-specific MPE command files.
•
Copy :FILE Command —enter the MPE :FILE command that is to receive the copy of the
$STDLIST. The copy is directed to the specified destination.
•
EXCPTLST :FILE Command —enter the MPE :FILE command that is to receive a copy of the $STDLIST, if it contains some type of exception. The job is then printed to this file command. For information on Exceptions Lists, refer to the JobRescue Administrator’s
Reference Guide. The default file command for EXCPTLST is in the JOBPAK.JPAK JCL file.
Configuring folder organization
ElectroPage can be configured to create an on-line folder tree to store reports inside folders.
The STATUS program can then be used to view the reports (described in Chapter 4, “The
STATUS Program.” ).
To access this feature, from the Main Configuration menu select Configure FOLDER
Organization. The Configure Folder Organization dialog box appears.
Nobix ElectroPage Administrator’s Reference Guide 43
Chapter 3 The CONFIGX Program
Nobix
The JOBPAK FOLDER acts as an anchor for the folder organizational system. Like a file cabinet, it holds all the other folders in the system.
The folder system is hierarchical with successive levels of folders that contain other folders.
The first level of folders are referred to as top-level folders. The next level is indented by a leading period. Each subsequent level is indented by an additional leading period. For instance, one leading period is equivalent to the first level down from the top level; two leading periods is equal to the second level, and so on.
There is no limit to the number of hierarchical levels that can be created. Ten levels are visible on the screen at one time. Folders within each level are sorted alphabetically and numerically.
In the example above:
• There are three visible top-level folders:
ALL-REPORTS, BATCHNET_REPORTS , and
BKP_REPORTS .
• In the
BATCHNET_REPORTS folder, there is one first-level folder: batchnet_subfolder .
Folders might or might not contain reports. Viewing access must be designated for each folder, as described in “Configuring report access” in this chapter.
Note:
ElectroPage allows multiple folder paths to be created to locate a folder (and its contents).
ElectroPage Administrator’s Reference Guide 44
Chapter 3 The CONFIGX Program
Adding folders
To add folders to a folder tree:
1
Position the cursor on the folder within which the new folder is to be added (it is not necessary to position the cursor on the JobPak folder when adding top-level folders). Use the UP and DOWN arrow keys to scroll through the folder list.
2
Press F1–ADD FOLDER . Several fields appear at the bottom of the screen. Enter a Y in the
Toplvl field to create a top-level folder. Enter an N to add lower-level folders. Lower-level folders are the default if this field is left empty.
3
Tab to the Name field. Enter a name for the new folder. A name can be up to 32 characters long. Your entry will default to upper-case letters. Tab to OKAY and press
ENTER . If you change your mind, select CANCEL .
4
To save the configuration, press F8 until the Save/Exit screen prompt appears. Tab to
OKAY and press ENTER before exiting.
Deleting folders
To delete a folder:
1
Position the cursor to highlight the unwanted folder, and press to the screen prompt to complete or cancel the action.
F3-Delete Entry . Respond
2
Tab to OKAY and press folder are deleted.
ENTER . The folder and the report specifications inside of the
Adding reports to folders
To add a report to a folder:
1
Position the cursor to highlight the folder in which to enter a report and press
Report . Five fields appear at the bottom of the screen.
F2-Add
Nobix ElectroPage Administrator’s Reference Guide 45
Chapter 3 The CONFIGX Program
Nobix
2
Enter values into the five fields as described below:
•
File designator —spoolfile name.
For $STDLISTs from JobRescue to appear in a folder, enter the value $STDLIST.
The single “@” only matches reports on this screen.
•
Job/Sess name —user session or job name.
•
User name —the name of the user who created the file.
•
Account name —the account in which the spoolfile was stored.
•
Device name —device from which the spoolfile originates.
Each field is limited to eight characters.
Reports can be viewed using the STATUS program as described in the “Report mode”
section of Chapter 4, “The STATUS Program.”
Configuring report access
By default, any user can view any folder. To restrict user access to a specific folder, highlight the folder and press F4–SPECIFY ACCESS . A dialog box similar to the following appears:
ElectroPage Administrator’s Reference Guide 46
Chapter 3 The CONFIGX Program
The selected folder is listed at the top of the screen. Press F1–ADD ITEM to assign access to a particular user. Three fields appear at the bottom of the screen. Enter the user's logon ID as follows:
•
Job/Sess —the job name or session.
•
User
—the name of the user who created the spoolfile.
•
Account —the account in which the spoolfile was stored.
Users not included in this list will be restricted from viewing the folder. Wildcarding can be used with three types of pattern matching: the at sign (@), the pound sign (#), and the question mark (?).
If a view access list is not specified for a folder, view access is determined by the global security level configuration and any access configuration at the file or report level.
Note:
Lower-level folders inherit access configuration from their upper-level folder.
Configuring retention management
The Retention Management cycle consists of the deletion of files that have aged beyond their life span, as determined by the configuration of report Save options.
Nobix ElectroPage Administrator’s Reference Guide 47
Chapter 3 The CONFIGX Program
The Configure RETENTION Management setup command within the CONFIGIX program can be used to schedule predetermined days and times to initiate the retention management cycle using the following configuration screen:
Nobix
Enter the day and time a Retention Management cycle is to be scheduled, as follows:
1
Mark an X in one or more of the day-of-the-week fields.
2
Enter the hours and minutes in 24-hour time. The cycle will take place on the day(s) of the week marked with an X .
The scheduled retention management cycle operates as follows:
• The Retention Management program loads the configuration information that is maintained with the CONFIGX program.
• All files are scanned and the files that have aged beyond what is allowed by the specified configuration are deleted.
• A new log is created, and the log information is updated to show Log 1 as being the period of time since the previous Log 1 to the current date and time. The previous Log 1 and other Logs are then incremented by 1.
Use the SHOWLOG command in the STATUS program’s Line mode to see the updated times.
Deleted files are logged to the delete log file and this log may be displayed using the
SHOWDELETELOG command in STATUS.
For more information, refer to “Report save options” and
in this chapter.
ElectroPage Administrator’s Reference Guide 48
Chapter 4
The STATUS Program
The STATUS program allows users to interactively view and search saved spoolfiles. After
ElectroPage has examined and saved a spoolfile, the report or IBM job listing will be available online via the STATUS program. The STATUS program allows access to saved reports with a user interface called the Viwer.
The STATUS program provides:
• Index selection and search
• User-defined function keys
• Forward/backward search
• Streamlined folder configuration
• Suppression of PCL data, for easier report viewing
• Support of vertical single line and page scrolling
• Support of horizontal single line and multiple-column scrolling.
• Ability to save user preferences.
Command reference
The STATUS program has two modes: Line mode and Report mode. The Line mode commands are:
Commands
SHOWFOLDER
Description
Displays the folder structure.
Nobix ElectroPage Administrator’s Reference Guide 49
Commands
SHOWREPORT
Chapter 4 The STATUS Program
Description
Displays the reports within a folder structure.
Nobix ElectroPage Administrator’s Reference Guide 50
Chapter 4 The STATUS Program
SHOWFOLDER
This command displays the folder structure for a given tree or branch.
Syntax
>>SHOWFOLDER [<folder-name> | @]
Operation
This command tells ElectroPage to display the folder structure, starting with < foldername > and all folders beneath it. This command shows how folders relate to others within the same branch structure. It displays the number of spoolfiles in each folder and the time the folder was last updated with a new spoolfile.
The < folder-name > parameter is optional. Use the name of the folder in quotes. If foldername is omitted, the system displays all top level folders. Wildcards are not allowed, however using @ for the folder name displays the entire nested structure.
Example
>>SHOWFOLDER.
FolderName---------*
ALL-REPORTS
M.I.S. REPORTS
MANUFACTURING
SALES
Count
735
129
538
68
Example
>>SHOWFOLDER “SALES”.
FolderName---------*
SALES
..SALES ORDER
Count
33
35
Latest----------*
2005/09/04 09:54:20
2005/09/04 03:27:53
2005/09/04 18:37:12
2005/09/04 09:54:20
Latest----------*
2005/09/04 09:54:20
2005/09/03 23:33:09
See Also
SHOWREPORT
Nobix ElectroPage Administrator’s Reference Guide 51
Chapter 4 The STATUS Program
SHOWREPORT
This command displays the reports associated with a folder.
Syntax
>>SHOWREPORT [<folder–name>]
Operation
This command tells ElectroPage to display the reports and spoolfiles contained within a folder as specified by <folder–name>.
Example
>>SHOWREPORT “all reports”
5
4
3
>>
File FileDes
1 STATUS
2 TEST
7
6
24 TEST
8 TEST
TEST
TEST
TEST
TEST
TEST
Job/Sess UserName
MGR
MGR
TEST
TEST
TEST
TEST
MANAGER
MANAGER
MANAGER
MANAGER
TEST
TEST
TEST
MANAGER
MANAGER
MANAGER
See also
SHOWFOLDER
AcctName OrigDev
ALTAO 00000307
#Pages Created-----#J/S
4 20050722 0953 S13
NSD LP 3 20050727 1707 S398
SYS
SYS
SYS
SYS
LP
LP
LP
LP
11
11
11
11
20050819 0946 J12
20050819 0946 J12
20050819 0944 J11
20050819 0943 J10
SYS
SYS
SYS
LP
LP
LP
11
11
11
20050819 0941 J9
20050819 0926 J8
20050819 0903 J7
Nobix ElectroPage Administrator’s Reference Guide 52
Chapter 4 The STATUS Program
Report mode
Reports cannot be viewed from within the CONFIGX program, so first exit the configuration program. At the e3000 prompt, enter the STATUS program Report mode by typing: status.jpak.nsd report
Optionally, enter Report mode on the MPE command line by typing:
STATUS.JPAK.NSD -R
To quit Report mode, press F8-EXIT VIEWER .
Viewer—folder tree
When the Viewer initially opens, the JobPak folder tree appears:
Nobix
The folder tree contains a hierarchical listing of all of the folders containing the reports
currently in the system. Refer to the “Configuring folder organization” section in Chapter 3,
Function buttons appear at the bottom of the Viewer screens, providing a shortcut method to execute commands. These buttons correspond to the F1-F8 function keys on the keyboard.
(Some of these buttons remain undefined.)
If the folder tree is very large, press F1-FIND FOLDER to quickly locate a particular folder.
ElectroPage Administrator’s Reference Guide 53
Chapter 4 The STATUS Program
To display just the top-level folders, select F4-COLLAPSE ALL . The total number of reports stored in the JobPak folders appears on the right-hand side of each top-level folder.
To re-display all of the folders in the JobPak folder tree, select F2-EXPAND ALL .
To expand one section or branch of the folder tree, highlight a folder as shown below and press F3-EXPAND BRANCH .
Nobix
To view the subfolders in any particular folder, highlight the parent folder and press ENTER .
Updating the folder tree
If you have been in Report mode for some time, there may have been changes to the configuration that have not been recorded. To update the folder tree and create a current list of folders and reports, press F6-REFRESH DISPLAY .
Viewer configuration options
In Report mode, the screen configuration can be changed for individual viewing. At the
Viewer folder tree screen, select F5-CHANGE CONFIG . The Screen Configuration Options dialog box appears:
ElectroPage Administrator’s Reference Guide 54
Chapter 4 The STATUS Program
Nobix
Note:
To access the Screen Configuration Options screen when viewing a report, press F6-
Misc Keys .
To change the screen configuration, supply variables for the following:
•
Vertical scroll increment (#lines) —enter a number to specify how many lines to scroll through the report when using the UP and DOWN arrow keys.
•
Horizontal scroll increment (#columns) —enter a number to specify how many columns of the report appear when using LEFT and RIGHT arrow keys.
•
Maximum scroll to right edge (#columns) —enter a number from 80 to 264 to change the defined right-hand column scroll destination (defaults to 132).
•
Automatic switch to HP 132-column mode —using Reflection or an HP terminal emulator, you can enter a Y to reconfigure to a 132-column screen width.
Screens will automatically switch between 80-column and 132-column mode. Rows do not change.
•
Automatic screen dimension detection —enter Y to automatically calculate the rows and columns of the display and apply fit-to-window dimensions.
ElectroPage Administrator’s Reference Guide 55
Chapter 4 The STATUS Program
This feature automatically detects how many columns and rows the display has, and will then attempt to fit the information into the screen area, as opposed to the default 80column x 24-row display.
•
Initially explode all folder trees —enter Y to configure the folder tree to display all of the subfolders in the hierarchy.
•
F4-user function key :XEQ filename —Reflection users can define the F4-User Key with an
MPE file name.
Enter the name of the MPE :XEQ file to be executed via this user-defined function.
The first eight characters of the filename will appear as the label on the screen button for your unique user configuration, according to the individual logon ID and sign-on.
Report printing
The STATUSI.PUB.NSD
file sets up the STATUS program’s default printing environment.This governs the Print by Page command when viewing a report. For more information, refer to the
“Miscellaneous keys F6” section in this chapter. This configuration
controls the following:
• Slave printer initialization sequence
• PC initialization sequences
• Additional initialization variables
When the STATUS program is loaded, it searches for the STATUSI file in the logon group of the logon account. If the STATUSI file is not there, STATUS searches the PUB group of the logon account. If it does not find a STATUSI file there, STATUS uses the STATUSI file in the
PUB group of the NSD account.
The following commands reside in the default STATUSI file, which can be changed:
Command
LOCALRESET = “char–sequence”
LOCALCOMPRESS = “char–sequence”
LOCALPORTRAIT = “char–sequence”
Description
STATUS reads this command when it prints to a slave printer on a terminal or PC. The value of char-sequence is sent to the printing device when printing is initiated; it is also the last character sequence sent when printing is finished.
STATUS reads this command when it prints to a slave printer on a terminal or PC. If compressed print is selected, STATUS sends the character sequence to the printing device after it sends the
LOCALRESET sequence but before sending any data.
STATUS reads this command when it prints to a slave printer on a terminal or PC. If a Portrait orientation is selected, STATUS sends the character sequence to the printing device after the LOCALRESET sequence but before any data is sent.
Nobix ElectroPage Administrator’s Reference Guide 56
Chapter 4 The STATUS Program
Command
LOCALLANDSCAPE = “char–sequence”
TERMINIT = “char–sequence”
LOCALMAXPAGES = “numeric value”
Description
STATUS reads this command when it prints to a slave printer on a terminal or PC. If a Landscape orientation is selected, STATUS sends the character sequence to the printing device after the LOCALRESET sequence, but before any data is sent.
When the STATUS program enters report mode, it clears the terminal screen by using an ESC–H,
ESC–J sequence; however, sometimes this is not sufficient.
When entering TERMINIT in the STATUSI file,
STATUS will send the character sequence to the terminal every time Report mode is entered. This allows some additional initialization to be performed, if necessary.
This command limits the number of pages that can be printed on the slave device of a terminal or PC. By default, there is no limit.If the report being printed does not contain carriage controls,
STATUS assumes a page break after every 60 lines.
Character strings
A string of characters surrounded by quotes is used for the parameter value in the above commands. Control characters (non-displayable ASCII) are indicated by a leading caret ( ^ ).
For example, a CNRL-N or ASCII shift-out is represented by ^N . A null is ^@ ; an ESC is ^[ .
A caret is represented by two carets in a row ( ^^ ).
Report viewing
To access a report, highlight the folder where the report resides and press ENTER . A listing of the reports in the selected folder is displayed, as shown below.
Nobix ElectroPage Administrator’s Reference Guide 57
Chapter 4 The STATUS Program
Nobix
For more information, refer to “Viewing report generations” in this chapter.
Report sorting occurs based on File designator, Account name, User name, Job/Session, and date/time sequence (in descending order).
The following information is displayed for each listed report: the generation (version) count, the most recent generation (latest creation time), and the device on which the spoolfile originated.
Locating reports
If a folder displays an extensive list of reports, press F1-FIND REPORT to quickly locate a specific report.
Enter the file designator, job name, user name, account name and originating device, in that order, into the five fields that are displayed at the bottom of the list, as shown in the following example.
ElectroPage Administrator’s Reference Guide 58
Chapter 4 The STATUS Program
To list all the generations of a particular report, including page count and time of creation, highlight the report and press F3-EXPAND REPORT . The report generations are listed in descending time sequence, as in this example:
Nobix ElectroPage Administrator’s Reference Guide 59
Chapter 4 The STATUS Program
Nobix
To re-display the original report listing, showing all of the report generations in the folder and the page count, press F2-EXPAND ALL . To display only the most recent generations (and the generation count), press F4-COLLAPSE ALL .
A tilde appearing next to an individual report listing indicates that page numbering within the report is approximate (no tilde indicates there is carriage control in those files), as explained below.
Viewing report generations
To view a particular report, highlight the report listing and press ENTER . If the file has carriage control, demarcation lines will be displayed within the report indicating the beginning and ending of each new page. The example below shows a report with carriage control; however, sometimes a report without carriage control may also display an initial page indicator at the top, resulting from a form-feed command.
ElectroPage Administrator’s Reference Guide 60
Chapter 4 The STATUS Program
The status line, highlighted at the bottom of the Viewer screen, indicates the pages and lines relative to one. Line number one, indicating the top line, changes while scrolling up or down, using the keyboard arrow keys.
There are a total of 132 columns, with 80 columns for full-screen viewing. A circumflex (^) flags the left and right column numbers. While scrolling to the right or left, using the RIGHT and
LEFT
arrow keys, these column numbers will change.
Report navigation
The following table describes the function buttons at the bottom of the Viewer screen.
Detailed procedures follow the table.
Name
MaxLeft
LinePage Controls
String Search
MaxRight
Head/Col Freeze
F3
F4
Key
F1
F2
F5
Description
Aligns Viewer flush left to column 1 of report.
Accesses line navigation functions.
Accesses text searching functions.
Moves to the value configured for max. scroll to right
(refer to “Viewer configuration options”).
Locks heading and columns on display.
Nobix ElectroPage Administrator’s Reference Guide 61
Nobix
Chapter 4 The STATUS Program
Name
Misc Keys
HELP
EXIT Report
Key
F6
F7
F8
Description
Accesses miscellaneous configuration functions.
Displays on-line help.
Returns the display to the report list.
To navigate within a report, use the Page Up and Page Down keys on the keyboard to move in full-screen views (as opposed to complete pages), or use the UP and DOWN arrow keys, to move one line at a time.
Line page controls F2
Press F2-Line Page Controls to access line navigation functions when viewing a report. The function button display toggles to the following selections:
F1-GoTo Line —enter a line number to view. The specified line displays at the top of the screen when you press ENTER .
F2-ShowLine Numbers —displays line numbers along the left-hand side of the page (offsets the text by eight positions). Toggle this function again to deactivate the line numbers.
F3-GoTo Page —enter a page number at the prompt to access a page of the report. If ENTER is pressed without entering a page number, the prompt disappears.
F4-Show Columns —displays column numbers, in increments of ten, at the bottom of the screen. Toggle this function again to deactivate the column numbers.
F6-Exit LinePage —exits the line page control functions and goes back to the basic Viewer functions.
F5 is undefined for the Line Page Controls.
String search F3
Press F3-String Search to find text in a report. The function button display toggles to the following selections:
F1-Enter FindText —at the prompt enter text to be found. Enter f or b to search forward or backward from the current location.
F2-Find Next —find the next occurrence of text that has been specified by Enter FindText .
F3-Find Options —enter search parameters. The Search Configuration Options dialog box appears:
ElectroPage Administrator’s Reference Guide 62
Chapter 4 The STATUS Program
Nobix
Supply values in the fields as described below:
•
Remove spaces during search —enter Y to remove spaces from a text string specified with
Enter FindText , thereby speeding up the search.
•
Match case during search —enter Y to specify the text search as case-sensitive to the specified text string.
•
Search frozen heading area —enter Y to search the locked lines at the top of the screen.
These are established with the Header/Col Freeze command. For more information, refer to
“Heading and column freeze F5” in this chapter.
•
Left-most column to search —enter the number of the leftmost column to define where the search begins.
•
Right-most column to search —enter the number of the rightmost column to define where the search ends.
To save the search configuration, tab to OKAY and press ENTER .
Press F6-Exit Search to toggle back to basic Report mode functions.
ElectroPage Administrator’s Reference Guide 63
Nobix
Chapter 4 The STATUS Program
Heading and column freeze F5
When scrolling through long reports, it may be helpful to keep column headers in view at the top of the screen. To lock or freeze a heading or column in place, press F5-Head/Col
Freeze . The function button display toggles to the following selections:
Key
F1–Heading Freeze
F1–Increase HeadLock
F2–ShowLine Numbers
F3–Remove Last Lock
F4–Show Columns
F5–Lock a Line
F6–Exit HeadFreeze
F3–Column Freeze
F1–Add Segment
F2 ShowLine Numbers
F3 Remove Last Segment
Description
Locks the report heading at the top of the Viewer screen, and toggles the function button display to the following:
Incrementally adds horizontal heading freezes from the top down. One or more rows can be added to the beginning of the page/column orientation, and the heading configuration can be viewed separately when exiting Heading Freeze.
Shows line numbers along left-hand side of page and offsets the text by eight positions. Toggle again to deactivate.
Incrementally removes a headlock, starting with the last freeze applied.
Displays numbers in increments of ten, at the bottom of the screen, indicating the column numbers.
Freezes text in a line. At the prompt, enter a line number to freeze, and press ENTER . The line appears at the top of the screen.
Toggles back to the Heading/Col Freeze functions.
Locks columns vertically, rather than horizontally, and toggles the display to the following function buttons:
Concatenates selected columns and automatically creates a separate view of the selection, which can be viewed by exiting
Column Freeze . When this function is selected, the column numbers (read vertically, beginning with the numeral 10) are automatically displayed at the bottom of the report, as shown below:
1111111111222222222233333333344444444555555555566666
123456789012345678901234567890123456789012345678901234567890123
--------------------------------------------------------------
At the prompt, enter a beginning column number and a delimiter (space or comma) and an ending column number.
The delineated columns are highlighted when ENTER is pressed. Exit Column Freeze to see the specified segment displayed.
Shows line numbers along the left-hand side of the page, offsetting the text by eight positions. Toggle F2 again to deactivate.
Removes highlighted columns from the report display that was added with Add Segment.
ElectroPage Administrator’s Reference Guide 64
Nobix
Chapter 4 The STATUS Program
Key
F4 Show Columns
F6 Exit Column Freeze
F6 Exit Freeze
Description
Displays numbers in increments of ten, at the bottom of the screen, indicating the column numbers.
Toggles the buttons back to the Head/Col Freeze functions.
Toggles back to the report viewing screen functions.
Miscellaneous keys F6
When viewing a report, press F6-Misc Keys , to toggle the function button display to the following selections:
Name
Change Config
CopyTo PC FIle
Print by Page
User Key
Indexing
Prev Keys
Key
F1
F2
F3
F4
F5
F6
Description
Displays options for changing the report viewing configuration, as described previously in Viewer configuration options.
Saves a portion of a report to a PC file. HP e3000 files can be downloaded to
SheetMate or Monarch software packages
(or Notepad).
Paints screen dialog directly from the e3000 environment data
Can be configured as a user-defined key if you are using Reflection. Use the template
F4KEYXEQ.EXAMPLE
. The function button displays the label you specify.
Finds the index values that were defined by the Pattern indexing configuration, as
described in Chapter 3, “The CONFIGX
Toggles the display back to the basic
Viewer functions
Copy to PC file F2
To use this feature, you must be in a Reflection environment. To save a portion of a report to a PC file, press F2-Copy to PC File . The Copy to PC File dialog box appears:
ElectroPage Administrator’s Reference Guide 65
Chapter 4 The STATUS Program
Enter the beginning and ending page numbers, select OKAY and press ENTER .
When the Save File dialog box appears, enter a filename and select Save. The file is then copied to your PC environment.
Print by page F3
To print a spoolfile from the e3000, press F3 Print by Page . The Print by Page dialog box appears:
Nobix ElectroPage Administrator’s Reference Guide 66
Chapter 4 The STATUS Program
Nobix
Enter values in each of the available fields for Print by Page as described below:
•
Local printer or system spooler —enter an L to specify a direct printer connection or printing via a network connection; or enter S to send the file back into the e3000 spool system, for printing.
•
Send init escape sequence if system spooler —enter an N if a laser printer is not being used and initialization sequences do not need to be sent.
•
Keep HP2680 ENV file data if system spooler —if the file was originally spooled to an
HP2680 printer, enter a Y to keep the original 2680 commands, or an N to strip them out before printing.
•
Portrait or landscape —enter a P or L to specify either a vertical or horizontal paper orientation, respectively.
When specifying orientation and pitch, there is an option to specify Landscape, Portrait or Compressed (see next item).
•
Compressed or default print pitch —enter a C or D to specify the horizontal measurement of the number of characters per linear inch.
If a compressed font is already configured in the printer, the default and compressed print pitch will produce the same result.
ElectroPage Administrator’s Reference Guide 67
Chapter 4 The STATUS Program
•
:FILE command for system spooler destination —in an e3000 environment, enter the
MPE :FILE command that the file is to be printed to.
•
Add a value range for the beginning and ending pages in the fields provided.
If you are using Reflection, before processing this configuration, activate the print bypass feature to prevent any ESC sequences from being processed. To do this, from the Terminal menu, select Printer. The Print Setup dialog box appears:
Nobix
Check the Bypass Windows Print Driver option and then tab to OK and press ENTER .
Optionally, from the menu at the top of the Reflections window, select File. Select the Print
Setup command. Highlight or mark the Bypass Windows Print Driver option. Also, highlight or mark the Disable Printer Translation option. Deselect (uncheck) the Auto Form Feed option.
In the Print by Page form, tab to OK , and press ENTER to process the printing configuration for the current job.
Indexing F5
To find a previously defined index value, press F5 Indexing . A list appears that shows the word, line, and column entries of any index values in the report currently being viewed.
ElectroPage Administrator’s Reference Guide 68
Chapter 4 The STATUS Program
Nobix
The indexes will be numbered (at the top of the list box), in relation to how many indexes a particular report has. The index name, next to the index number, has been previously defined in the in the Description field of the Pattern Indexing configuration, as detailed in
Chapter 3, “The CONFIGX Program.”
To find a value in the report, highlight the index entry in the list and press ENTER . The cursor locates that column and line in the report.
If a report has more than one configured index, press F1-Switch Index to toggle the display to the other index lists (i.e., Index #1, Index #2, etc.).
If an index list is particularly long, press F3-Go To Value , which prompts for a value range and quickly accesses the specified range, as shown below using the example Index #1 Account
Number :
ElectroPage Administrator’s Reference Guide 69
Chapter 4 The STATUS Program
At the bottom of the index list, in the Enter Search Value field, type the desired word, line and column (with a space between each entry) and press ENTER ; the specified value range is highlighted.
Select F8-Exit Index to return to the Miscellaneous Keys function buttons.
Note:
To re-index a report that has been previously indexed, use the JPAKCOM command,
REINDEX.
(Go to Chapter 5, “The JPAKCOM Program,” for more information.)
Nobix ElectroPage Administrator’s Reference Guide 70
Chapter 5
The JPAKCOM Program
JPAKCOM is an interactive program to assist in managing the operation of ElectroPage.
JPAKCOM commands instruct the ElectroPage batch job to perform certain functions. For example, JPAKCOM can be configured to terminate ElectroPage and allow it to log off.
Note:
You must have SM or OP MPE (administrator) capabilities to use JPAKCOM.
Running JPAKCOM
JPAKCOM can be run from any account on the system.
Enter the following command syntax, to access the JobPak prompt:
:JPAKCOM.JPAK.NSD
The following JobPak prompt appears:
JobPak Comm 6.1 (c) 1998 Nobix
TUE, MAY 31, 2005, 3:16 PM
JobPak:
Nobix ElectroPage Administrator’s Reference Guide 71
Chapter 5 The JPAKCOM Program
JPAKCOM Commands
Command
EXIT
MPE
PROCESS
REINDEX
RESUME
STOP
SUSPEND
Function
Exits from JPAKCOM
Directs the JobPak batch job to execute an MPE command.
Directs ElectroPage to reprocess an examined spoolfile.
Reconfigures existing index values in a report.
Resumes ElectroPage examination after suspension.
Directs ElectroPage to stop running and log off.
Directs ElectroPage to suspend examination.
This chapter describes the function and syntax for each of these commands.
Nobix ElectroPage Administrator’s Reference Guide 72
Chapter 5 The JPAKCOM Program
EXIT
This command closes the JPAKCOM program.
Syntax
EXIT
Operation
When this command is entered at the JobPak: prompt, the JPAKCOM program is terminated and you are returned to MPE.
Example
>> EXIT
END OF PROGRAM.
MPE:
Nobix ElectroPage Administrator’s Reference Guide 73
Chapter 5 The JPAKCOM Program
MPE
This command directs JobPak to execute an MPE command from within the JobPak job.
Syntax
MPE: <command>
Parameters
Any valid executable MPE command. It must be separated from the MPE keyword by a colon (:).
Operation
This command allows you to instruct JobPak to execute the command from within its running job; as a result JobPak does not have to be stopped and restreamed.
Example
Jobpak: MPE: FILE EXCPTLST;DEV=LASER
FROM/JOBPAK,MGR.NSD/MPE COMMAND HAS BEEN EXECUTED
Note:
This command requires SM capability. OP users may not execute the :MPE command.
Nobix ElectroPage Administrator’s Reference Guide 74
Chapter 5 The JPAKCOM Program
PROCESS
This command directs ElectroPage to process a spoolfile.
Syntax
PROCESS <spoolfile–number>
Parameters
The < spoolfile-number > of a spoolfile in the spool system is the #0nnn number assigned by MPE when the spoolfile was created. This parameter is required.
Operation
ElectroPage typically examines all READY spoolfiles.
The error message
“REPORT #0nnn, FileDes FROM JOB #Jnnn NOT PROCESSED” indicates that ElectroPage found an error in the job that created the indicated spoolfile and ElectroPage is not going to examine it. You must determine whether the spoolfile is okay to print.
The PROCESS command can be used to process spoolfiles that have this disposition with
ElectroPage. This forces ElectroPage to examine the report.
Example
JobPak: PROCESS 123
FROM/JOBPAK,MGR.NSD/ OKAY, REPROCESS 123
Nobix ElectroPage Administrator’s Reference Guide 75
Chapter 5 The JPAKCOM Program
REINDEX
This command allows a previously indexed spoolfile to be re-indexed.
Syntax
REINDEX <filename>
Parameters
< filename > is the name of a saved spoolfile in the NSD account. Use the FINFO option in the STATUS program’s SHOW command to display the filename of the files stored in the
NSD account. This parameter is required.
Operation
Any previously generated index values are deleted and new index values are developed, based on the current configuration.
Example
JobPak: REINDEX /NSD/files1/R.1234.567890
FROM/JOBPAK,MGR.NSD/ OKAY, REINDEX
Nobix ElectroPage Administrator’s Reference Guide 76
Chapter 5 The JPAKCOM Program
RESUME
This command resumes spoolfile examination that has been suspended.
Syntax
RESUME
Operation
The RESUME command instructs ElectroPage to begin examining spoolfiles again.
RESUME will have no effect unless ElectroPage is currently suspended.
Example
JobPak: RESUME
FROM/.../SPOOLFILE EXAMINATION HAS RESUMED.
See also:
SUSPEND command
Nobix ElectroPage Administrator’s Reference Guide 77
Chapter 5 The JPAKCOM Program
STOP
This command stops the JobPak batch job and causes it to log off.
Syntax
STOP
Operation
To stop JobPak, issue the STOP command.
Once the STOP command is given, JobPak ignores any other commands. This is the orderly way to stop JobPak.
If possible, do not use the MPE command ABORTJOB .
Example
JobPak: STOP
FROM/../STOP COMMAND RECEIVED, WAIT FOR TERMINATION MESSAGE.
Nobix ElectroPage Administrator’s Reference Guide 78
Chapter 5 The JPAKCOM Program
SUSPEND
This command directs ElectroPage to suspend spoolfile examination.
Syntax
SUSPEND
Operation
Use the SUSPEND command to direct ElectroPage to continue running, but not perform any spoolfile management (such as the examination of reports).
The suspension remains in effect until the RESUME command is entered.
Example
JobPak: SUSPEND
FROM/.../SPOOLFILE EXAMINATION IS SUSPENDED.
See also:
RESUME command
Nobix ElectroPage Administrator’s Reference Guide 79
Chapter 6
Deferring Reports
Reports that are closed and immediately printed cannot be managed or examined by
ElectroPage. To ensure that reports do not print, they must be deferred before they are closed by the system. ElectroPage defers reports automatically; this capability is made possible through the use of the EPXEQ.PUB.NSD
command file, which is executed for all jobs and sessions in a logon UDC.
It is not necessary to manually defer reports in ElectroPage, since the program automatically does this by setting a priority of zero when the spoolfile closes.
The JPENABLE command syntax activates the deferral process, ensuring that ElectroPage will continually be able to examine spoolfiles. ElectroPage uses procedure exits to allow the
MPE/iX operating system to notify it when a non-$STDLIST spoolfile goes from a
CREATE state to a READY state. When this occurs, the report's priority is set to zero, and a message is sent to the ElectroPage process running in the JobPak job, indicating that the report has become ready and what the value of the original priority is. Using this method, it is not necessary to ensure that reports are at or below the outfence for their destination device (which would have kept them from printing before ElectroPage could capture them).
The action of arming a job or session to use procedure exits occurs when the job/session logs on via a logon UDC. This logon UDC executes a MPE command file named
EPXEQ.PUB.NSD
, which arms the job/session for use with procedure exits. To prevent its arming function, modify EPXEQ by entering a :RETURN command as its first line.
Because the priority might have been changed from the default priority of eight, it is important to note that a spoolfile will initially exhibit whatever priority it was set to, which then changes to 0 at logoff or file close. ElectroPage remembers the original priority. After examining a file, ElectroPage automatically restores the original priority, or deletes the spoolfile, depending on the ElectroPage configuration.
Nobix ElectroPage Administrator’s Reference Guide 80
Chapter 6 Deferring Reports
If priority does not change to 0 when reports close, verify that EPXEQ.PUB.NSD
is being executed from a system-wide logon UDC.
For example:
***
LOGONCOMMANDS
OPTION LOGON
XEQ EPXEQ.PUB.NSD
***
OR
Include the XEQ EPXEQ.PUB.NSD
line in an existing logon UDC.
Nobix ElectroPage Administrator’s Reference Guide 81
Chapter 7
MPE :XEQ scripts
This chapter contains information for advanced handling of reports and :XEQ scripts,
Contents of MPE :XEQ scripts
To facilitate parameter passing and substitution, a common PARM header line must be used in all :XEQ files initiated by ElectroPage.
It is important to note that there may now be multiple spoolfiles processed at the same time, which can require some coordination of variable name usage. This is due to a single job
(JobPak) performing all the spoolfile processing, and MPE’s feature of sharing variable names between multiple processes running in the same session. Be aware that once variables have been assigned, they are not deleted at the conclusion of the :XEQ file being run, and they may tend to remain on the system until the termination of the JobPak job.
It is recommended that any variable names that may be assigned during the execution of a script have the DFID number of the spoolfile being processed incorporated into their name, thus making them unique. Also, the :DELETEVAR command should be executed referencing any names assigned during the operation of the script.
The required PARM header line is in a file named PARMLINE.JPAK
and can be copied into any :XEQ file of your design. The PARM line appears as:
PARM Dfid ExCnt MissingCnt JobPreFix JobNo FileDes=“”JobName=“” &
UserName=“” AcctName=“” ElapMin CpuSec DateLogon=“” &
TimeLogon=“” DateLogoff=“” TimeLogoff=“” JobPakFname=“”
Nobix ElectroPage Administrator’s Reference Guide 82
Chapter 7 MPE :XEQ scripts
The formats are as follows:
Format
DFID
ExCnt
MissingCnt
JobPrefix
JobNo
FileDes
JobName
UserName
AcctName
ElapMin
CpuSec
DateLogon
TimeLogon
DateLogoff
TimeLogoff
JobPakFname
Description
Number portion only, no leading “#O”
Number of exception messages found. Zero if no exceptions
Number of missing messages expected. Zero if no missing messages
One of "#S"', "#S", "#J" or "#J"'
Job/Session number of the spoolfile’s creator. No leading "#S" or
"#J"
File designator (spoolfile name) of the file being processed.
Job or session name of the spoolfile’s creator
User name of the spoolfile’s creator.
Account name of the spoolfile’s creator
Elapsed minutes that a $STDLIST job ran; zero for a Report
CPU seconds accumulated during a $STDLIST job; zero for a
Report
Date that the job (if $STDLIST) logged on; format YYMMDD
Time that the job logged on; format HHMMSS
Date that the job logged off; format YYMMDD
Time the job logged off; format HHMMSS
The name of the file as saved in the NSD account
Delay report examination
MPE procedure exits notify ElectroPage when a new READY state spoolfile arrives in the queue. These programs immediately examine new spoolfiles for processing. To delay when
ElectroPage examines spoolfiles, place the DELAYEXAMSECS variable in the JOBPAK.JPAK file.
Syntax—
!SETVAR DELAYEXAMSECS #####
Where ##### is a number between 1 and 10,000 representing seconds for delay.
In the JOBPAK.JPAK file, place this line with other SETVARs prior to the command line
JP02SXL.JPAK
.
Nobix ElectroPage Administrator’s Reference Guide 83
Appendix A
The AutoDial Program
The AutoDial program provides ElectroPage with access to an auto-dialing modem.
AutoDial can tell the modem (or other automatic calling unit) to dial a pager number to alert computer personnel that a particular job has an error. AutoDial can dial different numbers for different jobs; this can be helpful when different people are responsible for these jobs and/or systems.
AutoDial must be run from a ElectroPage script file. These are specified as MPE :XEQ files, described in Chapter 3, “The CONFIGX Program,” and
Chapter 7, “MPE :XEQ scripts.” .
Most commonly, AutoDial would be run from the script file designated to be performed when an exception is detected.
Before AutoDial can be used, a job and dialing sequence cross-reference file must be defined.
This file should be named PHONE.PUB.NSD
. This file is a simple ASCII file which can be built with any suitable text editor. The file must be unnumbered and no longer than eighty
(80) characters in record length. The PHONE file contains a list of job names and the associated phone numbers which should be called if there is an error. Wildcards may be used to match job names.
When AutoDial is run from a command file during spoolfile examination, it is supplied with the job's logon ID. AutoDial uses this to match an entry in the PHONE cross-reference file.
Once it has made a match between the job ID of a failed job and an entry in PHONE ,
AutoDial opens the logical device of the modem or calling unit and writes the appropriate character sequence to this device. A coded numeric message can also be included that could be displayed on a pager, with the character sequence to be sent to the modem.
Many different types of modems are available, and their command sets may differ.
Therefore, the correct character sequence must be defined in PHONE to initiate and complete
Nobix ElectroPage Administrator’s Reference Guide 84
Appendix A The AutoDial Program the call for your modem. The defined character sequence must match the command set of the autodialing modem or calling unit.
Nobix has supplied a PHONE file with ElectroPage called PHONE.PUB.NSD
. This file can be used as a template to build on.
Pager networks
Since AutoDial is intended primarily for use in a pager network or environment, you should be familiar with the equipment to be used. This applies not only to the modem equipment at the site, but also to the equipment that the modem will be calling.
There are many different types of pager networks. AutoDial may be used with non-display pagers, or with more sophisticated numeric display pagers. Make sure that the pager network to be accessed is compatible with AutoDial.
Note:
AutoDial is not recommended for use with audible voice or text pagers. Although it can access them, there is currently no mechanism to allow AutoDial to speak or to send text through a modem or autodialer.
Using AutoDial
There are many reasons why you might want ElectroPage to contact a pager number when it detects a job error. For example, using AutoDial can reduce the time that data processing personnel need to be at or near the system console during normal production processing.
If ElectroPage is being used in conjunction with a job scheduling system (such as the JobPak product JobQue), it may even be possible to have an unmanned computer room. This can be beneficial at night, or at other times when personnel are not available in the computer room.
Since AutoDial can call different numbers for different jobs, simply have AutoDial contact the person responsible for a particular batch job or system and alert them to the presence of a batch error.
System setup
There is a sample MPE :XEQ file named ADXEQ.JPAK.NSD
that can be used as a template
(refer to “Enabling AutoDial” in this chapter). Modify the :FILE command that is in this file and reference the appropriate logical device number and the filename.
AutoDial accesses a modem through the MPE file system by opening the logical device that connects the modem to the computer system; therefore, you must enter a :FILE command to tell AutoDial the logical device number ( LDN ) of the modem that is to be used. The filename that AutoDial expects is PORT .
The command line should appear as:
:FILE PORT;DEV= LDN where LDN is the logical device number of the modem.
PHONE file
The PHONE file PHONE.PUB.NSD
is a cross-reference of job names and dialing sequences.
Any suitable text editor can be used to create this file. The PHONE file must be unnumbered and no longer than eighty (80) characters in record length.
Each record in PHONE defines a job ID. Each record is composed of two parts:
• The first part is the job identification delimited by a semicolon (;).
Nobix ElectroPage Administrator’s Reference Guide 85
Appendix A The AutoDial Program
• The second part is the dialing sequence used for a matching job.
Wildcards can be used to match more than one job per line in the PHONE file.
PHONE record format
The format of each record is free-form. The job ID must appear to the left of the first semicolon delimiter. The dialing sequence begins immediately after the first semicolon on each record. Spaces in the first position after the semicolon become part of the dialing sequence. The record looks like this: job–id ; dialing–sequence
For example:
PAYROLL,MGR.FINANCE ;ATDT5551212,,,,1234567890^M
As shown above, the job identification begins in column one, and there is a semicolon after the account name.
Job identification
The job ID is the logon ID of a job. It includes the job name, user name, and account name.
The job ID uses standard MPE formatting, as in UPDATE,MGR.FINANCE
and must start with the first non-blank character on each record.
The job ID can be entered in upper- or lower-case. Only ASCII letters and numbers and the
MPE wildcard-matching characters can be used.
For example:
MYJOB,MGR.FINANCE;
The wildcard character “@” may be used. If any portions of the logon ID are missing, they default to the wildcard character “@”. For example, a job ID that matches all jobs would be specified as:
@,@.@ ;
AutoDial selects the first PHONE record that matches. If a matching job ID has not been defined in the PHONE file, then AutoDial will take no action for that particular job.
Dialing sequence
Enter the dialing sequence immediately after the first semicolon following the job ID. The dialing sequence may contain any valid ASCII characters. Upper- and lower-case are preserved in this portion of the PHONE record.
Caution:
The complete dialing sequence must be on the same line as its corresponding job
ID. Continuation lines are not supported.
Control characters in the dialing sequence
Some modems and autodialers require control characters to be sent to them to perform some type of action. Control characters can be defined by placing a caret (^) in front of the character. For example, if a carriage return is specified as a CTRL–M , this would be represented as
^M . A CTRL–B would be defined as ^B . To define the actual caret character itself, use two carets next to each other, as in ^^ .
Nobix ElectroPage Administrator’s Reference Guide 86
Nobix
Appendix A The AutoDial Program
To instruct AutoDial to pause for a half-second, enter a dollar sign ( $ ) into the dialing sequence. Dollar signs are not transmitted to the modem; therefore, they only cause
AutoDial to pause. Additional dollar signs can be entered and placed next to each other.
They may appear anywhere in the dialing sequence.
A sample dialing sequence might appear as: job–id ;^M$$$ATDT555–1234,,,1234567890#^M
The above sequence performs the following tasks:
• The
CTRL–M (^M) sends a carriage return to the modem.
• The dollar signs each initiate a half-second pause.
• The
ATDT is the Hayes-compatible dialing command.
• The telephone number
555–1234 is sent to the modem.
(Remember to add a 9 if the system requires it to dial out.)
• Three commas are sent to the modem. Since the Hayes default delay is two seconds per comma, the commas give the pager enough time to answer the ringing line.
• The number
1234567890# is sent to the modem. This number would be displayed on the pager.
• A
CTRL–M (^M) or carriage-return is sent to the modem; this terminates the command.
Note:
This sequence may not be applicable to your equipment. It is intended only as an example. Please check the modem manual to verify.
How the dialing sequence is sent
AutoDial sends the dialing sequence character by character, beginning with the first character after the semicolon. AutoDial uses a separate FWRITE for each character.
AutoDial delays for a half-second after writing each character to the modem port. The delay is used because some modems cannot handle a faster rate. AutoDial is trying to act like a person typing through a terminal connected to the modem.
Note:
AutoDial opens the modem logical device as a file. The line speed is not changed from the device’s MPE configured value. The modem port is set to the equivalent of term type 18.
The port is opened for read/write access.
The dialing sequence should contain not only everything required to connect the modem t to the pager network, but also the information that must be sent to the pager equipment. In other words, the dialing sequence must contain the pager phone number and the number (if any) to be displayed on the pager itself.
If the modem requires a confirming carriage return before it will dial a number, be sure to include an extra CTRL–M (^M) in the dialing sequence.
Pager networks usually require a certain amount of time to answer an incoming call from the modem. Some networks answer on or before the first ring, while others answer on the third or fourth ring. Time must be allowed for the network to answer before sending a number that is to be displayed on the pager. Most autodialing modems allow a pause or delay character to be included in the dialing sequence. On some modems, the comma (,) or letter K tells the modem to pause for a predetermined amount of time. These pause characters should
ElectroPage Administrator’s Reference Guide 87
Appendix A The AutoDial Program be entered between the pager network phone number and the number that is to be displayed on the pager.
Note:
Although most telephone networks allow pulse dialing, most display pager networks require tone dialing.
After the sequence is sent, AutoDial pauses for thirty seconds before it closes the logical device for the modem. This prevents the possibility of a premature hang-up on the modem, if control signals from MPE are dropped when the device is closed.
Enabling AutoDial
The ADXEQ template file appears as follows:
PARM Dfid ExCnt MissingCnt JobPreFix JobNo FileDes="" JobName="" &
UserName="" AcctName="" ElapMin CpuSec DateLogon="" &
TimeLogon="" DateLogoff="" TimeLogoff="" JobPakFname=""
COMMENT This is the execute file used for running the AUTODIAL
COMMENT program. Modify the command line "setvar PORTLDN 21"
COMMENT to the port you will use for your modem.
if !ExCnt = 0 and !MissingCnt = 0 then return endif echo AUTODIAL.XEQ !JobPreFix!JobNo BEG !HPDATEF !HPTIMEF
setvar cnt!Dfid 0 setvar stayinloop!Dfid true while stayinloop!Dfid
setjcw cierror 0 continue build autolock>$null if cierror = 0 then setvar stayinloop!Dfid false else pause 20 setvar cnt!Dfid cnt!Dfid + 1 if cnt!Dfid > 15 then setvar Atime finfo("autolock",20) setvar Adate finfo("autolock",21) echo !HPTIMEF In AutoDial loop > 5 Mins. Autolock was made !Adate !Atime
setvar stayinloop!Dfid false endif endif endwhile setvar PORTLDN 21 file port;dev=!PORTLDN
continue abortio !PORTLDN > $null continue autodial.jpak;info="!JobName !UserName !AcctName" continue abortio !PORTLDN > $null purge autolock deletevar stayinloop!Dfid
deletevar cnt!Dfid
Nobix ElectroPage Administrator’s Reference Guide 88
Appendix A The AutoDial Program echo AUTODIAL.XEQ !JobPreFix!JobNo END !HPDATEF !HPTIMEF
setjcw cierror 0
Modify this script file appropriately, as described in the System setup in this chapter, and then name it.
In the MPE :XEQ scripts configuration, list the filename as one of the :XEQ files that will be executed when spoolfiles are examined, as discussed in Chapter 3, “The CONFIGX
Program.” It can be referenced for either all files examined as a global XEQ , or for job-specific or report specific spoolfiles as a local XEQ in the configuration.
Ensure that PHONE.PUB.NSD
has been defined. This file should only refer to jobs that require someone to be paged.
Selecting a modem
AutoDial may not be compatible with every modem. For example, there can be problems if the modem must have certain control signals supplied before it will go online with the computer system.
In some cases, the modem will not do anything until it is manually placed into terminal mode. This will not work with AutoDial, since no one will be present to do this.
Other modems will dial numbers; however, then they may wait for a second dial tone or carrier signal. If the proper signal is not received in time, the modem may hang up the phone line. Therefore, only pick a modem that can be controlled with characters placed in the dialing sequence.
Most Hayes-compatible modems will work well with AutoDial. These types of modems are easiest to use because they have the simplest dialing syntax.
The original HP Support Link modem is difficult to enable. The later release of the HP
Support Link is a Hayes-compatible modem.
When accessed, most display pagers require tones to be sent to them, similar to the ones created by a push-button phone.
Note:
To achieve the best results with AutoDial, Nobix recommends use of an HP modem cable, Part # 92219Q or equivalent.
AutoDial in test mode
There is a special TEST entry point included in AUTODIAL.JPAK.NSD
that allows testing of
AutoDial in a non-production mode.
In test mode, AutoDial does the following:
• Prompts you for a job name, user and account.
• Searches
PHONE.PUB.NSD
for a matching entry.
• If it finds a match, it will try to initiate a modem transmission.
• Echoes to your terminal exactly what it is sending to the modem.
This should help to enable AutoDial in your working environment.
Before trying AutoDial online, enter the appropriate :FILE command for the modem logical device. Type this on the terminal; enter the same information entered in the MPE :XEQ file.
To run AutoDial in test mode, sign on as MGR.NSD,PUB and enter the following:
Nobix ElectroPage Administrator’s Reference Guide 89
Appendix A The AutoDial Program
FILE PORT;DEV=LDN
AUTODIAL.JPAK.NSD –test
Note:
The word test must be entered in lower-case letters.
AutoDial terminates automatically after dialing.
Error messages
The following messages appear on the system console.
Message
AUTODIAL: CANNOT OPEN PHONE FILE
AUTODIAL: CANNOT OPEN *PORT
AUTODIAL: NO SPECIFIC RECORD
FOUND IN PHONE
CANNOT OPEN PORT: DSR NOT
AVAILABLE
Description
AutoDial cannot open the PHONE.PUB.NSD
file.
This file contains job IDs and dialing sequences.
Check to see that this file exists and that no lockwords or other security exists for this file.
AutoDial cannot open the PORT file as defined by the
:FILE PORT;DEV= LDN
command line. Make sure you have specified the correct device and that the device is not in use by another process. Check that the modem is sending DataSet Ready to the e3000 logical device.
When executing AutoDial, it could not find a matching record in the PHONE.PUB
file, which means AutoDial cannot perform its function for this spoolfile.
Data Set Ready signal is not available from the modem; therefore, AutoDial cannot open communication to the modem. Check to ensure that DSR is always enabled on the modem or that the modem is connected to a non-modem control type LDN .
Nobix ElectroPage Administrator’s Reference Guide 90
Appendix B
Banner Page Definition
The banner page definition file is a standard editor file. You can assign it any name you choose. The number of banner page definition files is unlimited, allowing specific banner files for each type of report. Below is a partial example of a banner page definition file,
BANNERX.PUB.NSD
, followed by descriptions of the commands used in the file.
Example
Size 55,132 at 4,9 put “SPOOLFILE NAME:” at 5,9 put “$FILEDES, LARGE at 16,9 put “JOB/SESSION NAME’ at 17,9 put “$JOBNAME”, LARGE at 28,9 put “U S E R + ACCOUNT” at 28,9 put “UAERNAME[1:x].$ACCTNAME[1:x]”,MEDIUM at 37,10 put “U S E R” at 38,10 put “ AND” at 39,10 put “D E P T” at 37,20 put “$USERID[1:x] BIN $USERDEPT[1:x]”,MEDUIM
Each file must be unnumbered and can be up to 255 characters in record length. Commands cannot be continued onto a second line. The following commands are used to create a banner page definition:
•
SIZE <rows> , <columns>
•
AT <row> , <column> PUT <string> [, NORMAL|MEDIUM|LARGE]
•
CAT <string>
Nobix ElectroPage Administrator’s Reference Guide 91
Appendix B Banner Page Definition
•
REPLCHAR <replchar>
•
HEADER [ BENV | AENV ] <envfile>
•
TRAILER [ BENV | AENV ] <envfile>
The following sections describe these commands.
SIZE
The SIZE command tells ElectroPage how large the banner page should be.
< rows > indicates the total number of vertical (depth) print positions of the page and can be a value from 1 through 87. The default value is 66.
< columns > indicates the total number of horizontal (width) print positions. The value ranges from 1 through 263. The default value is 132.
AT
The AT command puts character strings at the locations you specify.
< row > indicates a single vertical location on one of the rows defined on the SIZE command line. For example, row one is the first row on the page.
< columns > is a horizontal position on the page as defined in the <columns> variable of the
SIZE command line. For example, a value of 10 refers to the tenth column from the left.
<string> is any group of ASCII characters. It must be delimited on the left and right side by the same character. There is no pre-set delimiter character. The quotation mark, percent sign or any other character can be used; however, the left-most delimiter must match the rightmost delimiter. If these do not match, a parsing error will occur.
For example, the string:
%this is a character string% is properly delimited by the percent sign; however, the following string:
(this is not right) is not properly delimited, because the right and left parentheses do not match.
CAT
The CAT command can also be used to specify a string of text that is to be appended to the
end of the banner page.
The syntax is:
CAT <string> where < string > is a quote delimited character sequence.
Non-displayable characters should be coded as their respective control character, as in., a
CTRL-L (form feed) would appear as a caret (^) followed by an uppercase letter L . For example, to reset a LaserJet printer, the sequence is usually an ESC followed by the letter Z , followed by an ESC , and then the letter E . This would appear in the banner definition file as:
CAT "^[Z^[E"
Nobix ElectroPage Administrator’s Reference Guide 92
Appendix B Banner Page Definition
$FILEDES
$JOBNAME
$JOBNUM
$PAGES
$PRIORITY
$RECS
$SPOOLID
$USERADDR
$USERBIN
$USERDEPT
$USERDESC
$USERID
$USERNAME
$USERPHONE
$YEAR
Variable names
If variables in < string > are used, they are replaced with actual values before < string > is put on the banner page. This causes the length of < string > to be increased or decreased. For example, the command line:
AT 5 , 15 PUT %Creator: $USERNAME% tells ElectroPage to show the word Creator: followed by the user name that created the spoolfile. This phrase will appear at row five, and it will be indented 15 columns. Text will be truncated at the end of a line.
Any of the variable names shown in the table below can be used, in the <string> parameter.
These variables can be combined with other text.
Name
$ACCTNAME
$CCYYMMDD
$CDATE
$CDATELINE
$COPIES
$DEVICE
16
8
16
4
30
16
16
30
10
10
10
12
8
8
12
7
27
10
16
Length Description
8 Account name that created the spoolfile
8 8-digit date the spoolfile was created, as in 20050331
Date the spoolfile was created (ddmmmyy)
Spoolfile creation date and time in :SHOWTIME format
Number of copies as reported by spool system
Assigned device as reported by spool system or as overridden by ElectroPage
Spoolfile name
Job name that created the spoolfile
Job/session number that created the spoolfile
Number of pages as reported by spool system
Priority as reported by spool system
Number of records in the spoolfile
Spoolfile number in format Onnnnn
The distribution list user's address
The distribution list user's bin identifier
The distribution list user's department name
The distribution list user's description
The distribution list user's ID
User name that created the spoolfile
The distribution list user's phone number
4-digit year the spoolfile was created, as in 2001
Nobix ElectroPage Administrator’s Reference Guide 93
Appendix B Banner Page Definition
Parsing variable names
Variable names can be parsed to retrieve only parts of their value. This is done by appending the following syntax to the variable name:
[ <variable> [ <start>:<length> ]
< start > represents the starting position of the information to be included (relative to the first position of the variable contents).
< length > specifies how many characters should be retained.
Note:
Do not enter any spaces between <variable> and the parsing information.
For example, the $CDATE variable contains the date the spoolfile was created, formatted as
MM/DD/YY. The following AT command syntax would parse $CDATE to retrieve MM/DD and enter it on line 20, column 20 of the banner page:
AT 20,20 PUT “$CDATE[1:5]”
The following statement will display $CDATE in a European-style (DD,MM,19YY) date format:
AT 20,20 PUT “ $CDATE[4:2],$CDATE[1:2],19 $CDATE[7:2]”
Note:
If the letter X is entered for < length >, ElectroPage will truncate all trailing spaces from the variable contents when replacement is performed.
Type size
Selection can be made from three text commands:
•
NORMAL (the default) indicates the printer's standard line printer font.
•
MEDIUM is a matrix character in a cell six characters wide by six high.
•
LARGE
is a matrix character in a cell 13 wide by 10 high.
If the selection made is NORMAL , (the default), non-displayable ASCII characters can be included in the banner page. Use a caret (^) to indicate a non-displayable (CTRL) character; for example, a carriage return is ^M .
REPLCHAR
By default, ElectroPage uses the at sign (@) to create the medium and large block letters used to form the words of the header and trailer on the banner page. The REPLCHAR command can be used to specify a different replacement character, such as a pound sign (#), as depicted in this H example:.
#
#
#
#
#
#
########
#
#
The syntax is:
REPLCHAR <char> where < char > is a single character of your choosing.
Nobix ElectroPage Administrator’s Reference Guide 94
Appendix B Banner Page Definition
Note:
Do not enter any quotation marks around < char >.
HEADER
The HEADER command tells ElectroPage which environment file to use if the banner is printed as a header. Its syntax is:
HEADER AENV <envfile>
OR
HEADER BENV <envfile>
The HEADER command can be positioned anywhere in the banner definition file. The
< envfile
> variable represents the specified environment file.
Up to two
HEADER
commands can be entered in a single banner file; however, if two of these commands are entered, one HEADER must use AENV and the other must use BENV , as follows:
•
AENV tells ElectroPage to append <envfile> to the banner page. It allows changing of the look of the report, if it is desired for the report environment to differ from the banner's environment.
•
BENV tells ElectroPage to precede the banner with < envfile >. This allows changing of the look of the banner, if a different look than that of the printer's default font is desired.
Either BENV or AENV must be used with the HEADER command, but both cannot be used on the same command line.
Note:
If an environment is already embedded in an actual report (for example, if it contains a :FILE ...;ENV=...
), then HEADER will not alter it. This is because the header always precedes the embedded environment data.
IFHEADER
The
IFHEADER
command indicates that the banner commands that follow this command in the definition file apply only to the banner, when the header is being printed.
IFHEADER is terminated by an command. Banner commands reside between the IFHEADER and the ENDIF . Commands not within an IFHEADER / ENDIF or IFTRAILER / ENDIF pair are global commands and apply to both the header and trailer.
HEADERONLY
The HEADERONLY command directs that the banner only be used as a header page, and that a trailer page (see below) not be printed.
TRAILER
The
TRAILER
command tells ElectroPage which environment file to use if the banner is being used for a trailer. The syntax is:
TRAILER AENV <envfile>
OR
TRAILER BENV <envfile>
Nobix ElectroPage Administrator’s Reference Guide 95
Appendix B Banner Page Definition
TRAILER can be placed anywhere in the banner definition file. The <envfile> variable represents the specified environment file.
Up to two TRAILER commands can be entered in a single banner file; however, if this is done, one must use BENV and the other must use AENV .
AENV tells ElectroPage to append < envfile > to the banner page. This allows changing of the look of the report, if it is desired for the report environment to differ from the banner's environment.
BENV tells ElectroPage to precede the banner with <envfile>. This allows changing of the look of the banner, if a different look than that of the printer's default font is desired.
Note:
Normally, there is no report data after the trailer page; therefore, only use the
TRAILER ENV < envfile > syntax to reset the environment or to print a subsequent trailer that requires no data fill-in.
Either BENV or AENV must be used with the TRAILER command, and both of them cannot be used on the same command line.
Both the HEADER and the TRAILER commands can be used in the same banner definition file, and can be entered anywhere in the file.
IFTRAILER
The IFTRAILER command indicates that the banner commands that follow this command in the definition file apply only to the banner, when the trailer is being printed.
IFTRAILER is terminated by an ENDIF command. Banner commands reside between the
IFTRAILER and the ENDIF . Commands not within an IFHEADER / ENDIF or IFTRAILER / ENDIF pair are global commands and apply to both the header and trailer.
TRAILERONLY
The TRAILERONLY command directs that the banner only be used as a trailer page, and that a header page not be printed.
ENDIF
ENDIF terminates an IFHEADER or IFTRAILER command.
Previewing the banner
A program named BANTSTXL.JPAK.NSD can be run to preview your banner definition file.
Nobix ElectroPage Administrator’s Reference Guide 96
Appendix C
The UNLOAD Program
The UNLOAD.JPAK.NSD program allows system administrators to make global changes to the configuration files contained within the CONFIGIX program. It performs the following tasks:
• Output an editable ASCII version of the configuration files.
• Backup the following five configuration files found in the JPAK group:
CONFIG
FOLDERA
FOLDERF
FOLDERR
FDISPLY
• Use the edited ASCII file as input to populate the five configuration files with data.
Any text editor that works with the e3000 can view or edit the ASCII file.
You must be very familiar with entries and syntax contained in CONFIGIX to edit this
ASCII file. Refer to Chapter 3, The CONFIGIX program for information about
CONFIGIX entries and syntax.
Create an ASCII configuration file
1
Logon to the system as MGR.NSD,PUB.
2
Enter the :FILE command specifying the name for the ASCII configuration file.
:FILE TEXTCNFG;SAVE;DISC=50000
Nobix ElectroPage Administrator’s Reference Guide 97
Appendix C The UNLOAD Program
3
Run the UNLOAD program using the ASCII configuration file name.
:UNLOAD.JPAK > *TEXTCNFG
UNLOAD creates an ASCII file named TEXTCNFG in the JPAK group.
Example—.
6
7
4
5
8
1
2
3
0:GLOBAL:$GLOBAL:::::HEADER:NUM:0
0:GLOBAL:$GLOBAL:::::CHECKIF:NUM:1
0:GLOBAL:$GLOBAL:::::CHECKIF:NUM:0
0:GLOBAL:$GLOBAL:::::CHECKEOJ:NUM:1
0:GLOBAL:$GLOBAL:::::CHECKEOJ:NUM:0
0:GLOBAL:$GLOBAL:::::CONTOK:NUM:0
0:GLOBAL:$GLOBAL:::::STARTXEQ:TEXT:” “
0:GLOBAL:$GLOBAL:::::ERROR:TEXT:”(CIERR”
Edit the ASCII configuration file
1
Use any text editor to view or edit the ASCII configuration file.
:EDITOR
/T TEXTCNFG
2
When the edits are complete, keep the file.
/K TEXTCNFG,UNN
/EXIT
The text editor saves the changes to the ASCII configuration file.
3
7
1
2
Rules for editing the ASCII file
• The ASCII file is structured into records and fields.
• Fields are delineated by colons (:).
• The first field, named Category, groups lines together that have the same category number. Category numbers range from 1 to 10.
• Category number definitions and descriptions are as follows:
Cat. # Contains
0 Global definitions
8
Job Specific definitions
IBM report definitions
Report Specific definitions
FOLDERF definitions
(Top-level and Sub-folder)
FOLDERR definitions
(Report folders)
Non-editable fields
Fields 2 through 9
Fields 2, 3, 8, or 9
Fields 2, 8, and 9
Fields 2, 8, and 9
Field 2, or a field with the value
$FOLDERHEADER
(Toplevel)
Field 2
Editable fields
Field 10, which follows
TEXT: or NUM:
Fields 4, 5, 6, 7, and 10
Fields 3, 4, 5, 6, and 10
Fields 3, 4, 5, 6, and 10
Fields 3 and 4 except if they have the value
$FOLDERHEADER
Fields 3 through 8
Nobix ElectroPage Administrator’s Reference Guide 98
Appendix C The UNLOAD Program
Cat. # Contains
9 FOLDERA definitions
(Access security)
10 FDISPLY definitions (Rarely occurs)
Non-editable fields
Field 2
Do not modify
Editable fields
Fields 3 through 6
• Data in the fields following the
:TEXT : field are surrounded by double quotes (“) in the
ASCII file. Changes to these fields must be within the double quotes.
• Changes to the ASCII file must meet the criteria stated in this guide for valid data in that specific field.
Backup the current configuration and load the edited ASCII file
1
Logon to the system as MGR.NSD,PUB.
2
Run the UNLOAD program using the output file name.
:UNLOAD.JPAK –LOAD < TEXTCNFG
The backup file name is CFGnnn.JPAK, where nnn is a 3-digit number that is automatically incremented.
The UNLOAD program creates a backup of the current configuration and loads the changes from the ASCII configuration file. The changes take effect immediately, even if JobPak is running.
Warning:
UNLOAD does very little syntax error checking. If you load an ASCII file that has syntax errors, you might cause damage to the configuration files. If this occurs, refer to the
Restore the backup configuration section.
Restore the backup configuration
1
Logon to the system as MGR.NSD,PUB.
2
Enter CHGROUP JPAK .
3
Enter LISTF CFG@,2 .
4
6
Write down the number of the CFGnnn file with the highest number.
5 PURGE
the files FOLDERA, FOLDERF, FOLDERR, FDISPLY, and CONFIG.
At the colon prompt, type UHAUL.PUB
7
8
This runs a script to access the backup configuration.
To the question " DO YOU WANT TO LOAD, UNLOAD OR LIST FILES?
" enter UNLOAD.
To the question " ENTER THE NAME OF YOUR TRUCK ," enter CFGnnn (where nnn is the number from step 4).
This is the file that contains the most recent configuration backup.
The system restores the backup to the configuration files.
Nobix ElectroPage Administrator’s Reference Guide 99
Appendix C The UNLOAD Program
Print a configuration report
1
Logon to the system as MGR.NSD,PUB.
2
Enter the :FILE command specifying the name for the ASCII configuration file.
:FILE TEXTCNFG;SAVE;DISC=50000
3
Run the UNLOAD program using the ASCII configuration file name.
:UNLOAD.JPAK > *TEXTCNFG
4
Enter the :FILE command specifying the name of the output file and device.
:FILE lp;dev=lp
5
Run the POSIX shell and the UNLOAD program specifying the name of the ASCII configuration file and output file command.
:SH.HPBIN.SYS /NSD/EXAMPLE/UNLOAD < TEXTCNFG > *lp
The system sends the report of the configuration to the specified file command.
Example—
UNLOAD.JPAK
@ Wed Nov 18 14:30:37 PST 2005
JobPak configuration
Type
GLOBAL
GLOBAL
GLOBAL
GLOBAL
GLOBAL
GLOBAL
GLOBAL
FileDes.
Job/Ses User Account.Device
Command
CHECKIF
CHECKIF
CHECKEOJ
CHECKEOJ
CONTOK
STARTXEQ
ERROR
Value
NUM
NUM
NUM
NUM
NUM
TEXT
TEXT
1
0
1
0
0
“ ”
“(CIERR”
Nobix ElectroPage Administrator’s Reference Guide 100
Index
A
Access
Addresses
receiving messages 21 sending messages 21
B
Bypass
C
Nobix
report-specific configuration 25
Console messages 21 disable 21
Copy
D
Define
Device specification
Display
length, screen configuration 55
ElectroPage Administrator’s Reference Guide 101
E
Email address
disable global checking
Exception List
F
Folders
G
H
Help
I
J
Nobix
Jobs
L
Logon ID
Logs
M
Mail messages
public distribution list name 25
MPE commands
O
P
PHONE file
dialing sequence 86 job identification 86 record format 86
ElectroPage Administrator’s Reference Guide 102
R
Report
Report mode
Reports
changing screen configurations 55
report-specific configuration 27
Retention management
S
Save options
Search
Security
Spoolfile priorities 20, 42, 80
Spoolfiles
Nobix
STDLISTs
STDLOG report
error text strings 27 non-error text strings 27
T
Text strings
Customizing error detection 27 exceptions 27 missing 27
U
V
Variable name usage, XEQ files 82
X
XEQ scripts
execute 22, 31 global execution 22
ElectroPage Administrator’s Reference Guide 103
Download
Public link updated
The public link to your chat has been updated. You may view and manage your chat links after registration here.
Document public link
Advertisement
Key features
Online access to examined and saved reports
Automatic banner page attachment with distribution information
Job verification integrated with JobRescue for error prevention
Electronic report delivery through email (Internet mail or HPDesk)
Configurable retention management for reports
Search and print capabilities for all or part of a report
Detailed configuration options via CONFIGIX program
Automatic spoolfile priority handling for efficient processing
Customizable error detection and automated error response (e.g., AutoDial)
Management of IBM job listings as $STDLISTs
Frequently asked questions
To start ElectroPage, you need to stream the job control file named JOBPAK.JPAK.NSD by entering the MPE command: :STREAM JOBPAK.JPAK.NSD.
To stop ElectroPage, enter the MPE command: :JPAKCOM.JPAK.NSD STOP. This command can only be used by users with OP or SM (administrator) capabilities.
All configurable options for ElectroPage are maintained in the CONFIGIX program. You can access it by signing on as the NSD account manager (HELLO MGR.NSD) and typing CONFIGIX.JPAK at the MPE prompt.
When ElectroPage finds an error, it sends messages to the console and other user sessions. It can also be configured to generate automatic copies of the report, retain a permanent file, and even execute predefined MPE commands, such as running the AutoDial program to notify operators.
ElectroPage uses procedure exits to be notified when a non-$STDLIST spoolfile changes from a CREATE to a READY state. When this occurs, the report's priority is set to zero, and the ElectroPage process is notified, ensuring reports are examined before printing based on their original priority settings.
