XPAF - Xerox Support and Drivers

Version 6.0
February 2013
®
Xerox Printer Access Facility (XPAF)
User Guide
©2012 Xerox Corporation. All Rights Reserved. Unpublished rights reserved under the copyright laws of the United States. Contents
of this publication may not be reproduced in any form without permission of Xerox Corporation.
XEROX® and XEROX and Design® are trademarks of Xerox Corporation in the United States and/or other countries.
Changes are periodically made to this document. Changes, technical inaccuracies, and typographic errors will be corrected in
subsequent editions.
Document version 6.0: December2012
Table of Contents
Table of Contents
Section One:
Introduction to XPAF
1. Getting started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
XPAF User Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
Conventions used. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
Supported printers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7
XPAF subsystems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-9
Supported data streams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-12
Parameter and keyword processing hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-16
Section Two:
Installing and Customizing XPAF
2. Installation requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
Installation materials. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
SMP/E level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
Hardware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
Printer support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5
IBM host requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-8
Installation service macro worksheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-10
3. SMP/E installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
Installing the base product . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
Installing maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-28
Installing usermods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-41
Installing user exits. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-44
4. Installing resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1
Checklist for installing resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2
Step 1 – Set up stage 1 job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
Step 2 – Generate stage 2 jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-13
Step 3 – Submit resource installation jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-14
5. Customizing your system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
XPAF User Guide
i
Table of Contents
Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4
Preparing the operating system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6
Tuning your system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-15
Installing XPAF extended JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-18
Defining XPAF to JES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-23
Selecting initialization parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-29
Preparing the printer PDL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-30
Create/Modify paper-related tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-34
Setting up your printers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-34
Setting up printer profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-35
Installing multiple copies of XOSF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-37
Verifying the installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-39
6. Setting up system-level features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1
Enabling banner page processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1
Using SMF recording . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-13
Printing to disk and/or file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-17
Tailoring the DCF/SCRIPT environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-19
7. Coding the XPAF user exits. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1
Coding the XOAF user exit (XOAFUSEC) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1
Coding the XOSF user exits. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4
User exit descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-14
XPAF, PSF, and JES user exit cross-reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-38
8. Message logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1
z/OS system logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1
XPAF system logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-3
9. Setting up multiple CPUs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1
Checklist for setting up multiple CPUs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1
Step 1 – Copy files to file from host CPU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2
Step 2 – Offload files from file to remote CPU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-3
Step 3 – Install the extended JCL keywords on the remote CPU . . . . . . . . . . . . . . . . . . . . . . . . 9-5
Step 4 – Submit the print job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-5
10. XPAF printer support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1
Centralized printer models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1
Decentralized printer models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1
PCL-capable printer models. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-2
VIPP-enabled printers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-2
XPAF User Guide
ii
Table of Contents
11. Setting up LCDS-capable printers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-1
Connections to host and communication protocols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-1
Running Network-attached LCDS-capable printers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-1
Running in channel attached ONLINE mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-2
Using BARR/SNA RJE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-3
Loading LCDS resources from a FreeFlow Print Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-11
12. Setting up decentralized printers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-1
13. Setting up PCL-capable printers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-1
Preparing resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-1
Printing to PCL-capable printers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-3
Modifying document processing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-5
14. Overview of the PDF Transform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-1
Configuring XPAF. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-2
PDF Font Substitution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-3
Encrypting PDF Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-6
Points to note . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-7
Known issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-8
15. Printing via TCP/IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-1
TCP/IP printing methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-1
Sending print jobs via TCP/IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-3
16. Additional features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-1
Enabling XJCF simulation processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-7
Setting up XDS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-18
Connection to FTP servers/websites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-25
Support for Emtex V-Services print servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-28
17. Performing an installation verification procedure. . . . . . . . . . . . . . . . . . . . 17-1
Running the XPAF IVP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-1
Running the CMA-SPOOL or CA-SPOOL IVP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-1
Running the XDS IVP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-1
What does the IVP test?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-2
Setup requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-3
Executing the XPAF IVP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-5
Executing the CMA-SPOOL or CA-SPOOL IVP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-10
Executing the XDS IVP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-15
Verifying your output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-20
Line-mode processing IVP sample output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-20
DJDE processing IVP sample output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-22
XPAF User Guide
iii
Table of Contents
XES processing IVP sample output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-24
Page Format processing IVP sample output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-26
AFP processing IVP sample output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-29
Pass-through processing IVP sample output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-32
Section Three:
Managing Resources with XPAF
18. Accessing XOAF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-1
Using ISPF panels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-1
Using TSO/batch commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-13
19. XPAF resources. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-1
Fonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-2
Forms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-8
Images . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-11
Logos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-18
Printer-resident resource lists. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-20
Print description language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-28
Page formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-33
20. XPAF tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-1
Paper-related tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-2
Font tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-15
Color cross-reference tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-33
Color conversion table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-34
21. Loading resources to a native library. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-1
Loading centralized fonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-2
Loading centralized forms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-5
Loading centralized images . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-7
Loading centralized logos. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-9
Loading decentralized fonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-11
Loading decentralized forms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-13
Loading decentralized images . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-15
Loading PDL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-17
22. Converting resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-1
Converting centralized fonts to decentralized fonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-1
Converting centralized logos to decentralized fonts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-25
Converting Xerox fonts to IBM format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-28
Converting IBM AFP page segments to Xerox .IMG and/or RES format . . . . . . . . . . . . . . . . . 22-32
XPAF User Guide
iv
Table of Contents
23. Managing resource lists. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-1
Managing resident font lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-1
Managing a PCL font list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-7
Managing resident form lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-8
Managing resident image lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-14
Managing resident logo lists. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-20
24. Managing XPAF tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-1
Maintaining paper-related tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-1
Maintaining font tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-15
Updating IBM font characteristics information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-40
Deleting a font table or table entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-45
Maintaining color cross-reference tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-48
Maintaining the color conversion table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-52
25. Managing custom fonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-1
Using custom Xerox fonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-1
Using custom replica fonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-2
26. Displaying printer status information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26-1
Displaying the status of printers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26-1
27. Managing XPAF libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27-1
Displaying a directory of library members . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27-1
Browsing a copy of a member . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27-4
Deleting a member . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27-6
Reloading a member to a native library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27-7
28. Supported IBM character sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28-1
Proportionally spaced character sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28-1
Uniformly spaced character sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28-3
29. Character mapping tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29-1
Table naming conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29-1
Xerox code page tables (XCP1 through XCP19) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29-2
Centralized-to-decentralized font conversion character mapping tables . . . . . . . . . . . . . . . . . . 29-3
30. XRFBATCH utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30-1
Setting up XRFBATCH. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30-1
Executing XRFBATCH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30-6
Sample JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30-6
XPAF User Guide
v
Table of Contents
Section Four:
Printing Documents with XPAF
31. General information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31-1
How does XPAF select the document processing mode? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31-1
Printing pass-through documents to PCL-capable printers . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31-5
Downloading resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31-9
Using system-level features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31-10
32. Printing line-mode documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32-1
Data stream definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32-1
XPAF support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32-1
Preparing resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32-1
Using resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32-2
Modifying document processing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32-2
Using advanced features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32-2
Printing documents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32-2
Processing line-mode documents as DJDE or AFP documents . . . . . . . . . . . . . . . . . . . . . . . . 32-3
Troubleshooting problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32-4
33. Printing DJDE documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33-1
Data stream definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33-1
XPAF support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33-2
Preparing resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33-3
Using resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33-7
Modifying document processing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33-10
Using advanced features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33-11
Printing documents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33-17
Converting DJDE documents to XES documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33-18
Troubleshooting problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33-25
34. Printing XES documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34-1
Data stream definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34-1
XPAF support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34-2
Preparing resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34-3
Using resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34-6
Modifying document processing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34-7
Using advanced features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34-8
Verifying your print environment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34-10
Printing documents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34-10
Converting XES documents to PCL or PDF documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34-11
XPAF User Guide
vi
Table of Contents
35. Printing page-formatted documents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35-1
Data stream definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35-1
XPAF support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35-1
Preparing resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35-2
Using resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35-6
Modifying document processing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35-9
Using advanced features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35-10
Verifying your print environment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35-12
Printing documents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35-12
Converting page-formatted documents to other formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35-13
Troubleshooting problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35-13
36. Printing AFP documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36-1
Data stream definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36-1
XPAF support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36-2
Preparing resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36-2
Using resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36-7
Modifying document processing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36-13
AFP structured fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36-14
Using advanced features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36-18
Verifying your print environment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36-30
Printing documents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36-30
Converting AFP documents to Metacode or XES documents . . . . . . . . . . . . . . . . . . . . . . . . . 36-31
Troubleshooting problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36-37
37. Printing VIPP documents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37-1
Data stream definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37-1
XPAF support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37-1
Preparing resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37-1
Using resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37-2
Modifying document processing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37-2
Using advanced features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37-2
Printing documents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37-2
Verifying your print environment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37-3
Creating a VIPP command file member . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37-4
38. Using XPAF extended features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38-1
Using XJCF simulation processing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38-1
Printing documents through XDS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38-4
Redirecting XOSF-converted datasets to other printers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38-15
39. Using XRCBATCH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39-1
Processing performed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39-1
XPAF User Guide
vii
Table of Contents
Specifying file attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39-2
Section Five:
XPAF Parameter and Keyword Reference
40. Initialization parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40-1
Specifying initialization parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40-1
Coding initialization parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40-2
Overriding specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40-3
Parameter definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40-4
41. Printer profile parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41-1
Specifying printer profile parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41-1
Coding printer profile parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41-2
Parameter definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41-3
42. Standard IBM JCL keywords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42-1
Specifying IBM JCL keywords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42-1
Coding IBM JCL keywords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42-1
Standard IBM JCL support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42-1
43. XPAF extended JCL keywords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43-1
Specifying XPAF extended JCL keywords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43-1
Coding XPAF extended JCL keywords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43-1
XPAF extended JCL support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43-2
44. Parameter and keyword summary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44-1
Summary table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44-1
Section Six:
XPAF Messages
45. Message overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-1
ISPF messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-1
XPAF system messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-3
Message format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-6
How to interpret XPAF messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-8
Message conventions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-9
LDM messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-10
MSF messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-23
THM messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-30
XPAF User Guide
viii
Table of Contents
UFL messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-32
UFT messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-36
UIL messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-46
UIX messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-48
UJL messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-50
ULL messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-54
ULR messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-57
UPL messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-59
UTB messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-65
XAE messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-71
XAM messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-73
XAU messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-86
XCC messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-99
XCD messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-103
XCN messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-108
XDI messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-112
XDS messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-148
XEI messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-163
XFC messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-174
XFS messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-182
XFU messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-187
XIN messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-191
XIS messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-199
XJC messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-203
XJD messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-205
XJS messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-207
XLC messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-209
XLD messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-214
XLW messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-216
XOA messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-219
XOAF messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-234
XPA messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-248
XPC messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-249
XPD messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-253
XPFE messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-280
XPL messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-303
XRC messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-305
XRD messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-319
XRF messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-331
XSJ messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-342
XSL messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-343
XSV messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-349
XTB messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-350
XPAF User Guide
ix
Table of Contents
XTC messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-352
XTD messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-361
XTW messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-365
XUC messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-368
XUX messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-374
XVW messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-376
XWR messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-382
XXQ messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45-387
Section Seven:
XPAF Operator Guide
46. JES2 printer commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46-1
Starting a printer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46-1
Halting a printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46-2
Stopping or draining a printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46-2
Restarting a printer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46-2
Displaying a printer’s status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46-3
Setting printer characteristics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46-3
Interrupting a document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46-4
Restarting a document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46-4
Backspacing a document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46-4
Forward spacing a document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46-5
Retransmitting a document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46-5
Releasing a print job from the JES queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46-5
Canceling a document being transmitted from JES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46-6
47. JES3 printer commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47-1
Starting an XPAF FSS for JES3. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47-1
Starting a printer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47-2
Terminating a printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47-2
Interrupting and retransmitting a document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47-3
Backspacing or forward spacing a document. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47-4
Canceling output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47-4
Querying JES3 for job information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47-5
48. XPAF-exclusive operator commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48-1
Displaying the subsystem name for an XOSF started task . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48-1
Displaying the status of active print jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48-2
Displaying the status of active tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48-3
Terminating an individual task on the printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48-4
Terminating the XPAF FSS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48-5
XPAF User Guide
x
Table of Contents
Forcing the XOSF address space to terminate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48-6
Turning SMF recording on and off . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48-7
Turning z/OS system logging on and off . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48-7
Turning XOSF logging on and off. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48-8
Refreshing the XLOG dataset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48-8
Switching the XLOG to an alternate dataset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48-9
Displaying the active XLOG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48-9
Turning intensive logging on and off . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48-10
Enabling messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48-10
Suppressing messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48-11
49. XDS-exclusive operator commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49-1
Defining an optional subsystem command character. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49-1
Displaying XDS control blocks in use. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49-2
Interrupting a printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49-3
Restarting a printer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49-3
Terminating XDS with XOSF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49-3
Section Eight:
Xerox Page Format Editor
User Guide
50. Page format overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50-1
What is a page format? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50-1
Concepts and terms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50-2
Page format uses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50-6
Components of a page format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50-9
Creating and generating a page format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50-15
Invoking a page format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50-15
51. Introduction to the page format editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51-1
Panel conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51-1
System Services menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51-5
Xerox Page Format Editor menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51-6
52. Allocating page format datasets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52-1
Setting up your configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52-2
Maintaining your configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52-5
53. Selecting a page format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53-1
Specifying a page format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53-1
XPAF User Guide
xi
Table of Contents
54. Using copy modification options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54-1
Selecting a copy modification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54-1
Specifying copy modification parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54-3
55. Using page layout options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55-1
Selecting a page layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55-1
Selecting page layout parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55-4
Specifying global parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55-4
Specifying line data parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55-6
Specifying font list parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55-22
56. Generating a page format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56-1
Generation procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56-1
57. Copying page format source members . . . . . . . . . . . . . . . . . . . . . . . . . . . 57-1
Specifying the copy source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57-1
58. Updating Xerox font characteristics information . . . . . . . . . . . . . . . . . . . . 58-1
Specifying font characteristics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58-1
59. Page format examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59-1
List report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59-1
Statement report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59-6
Mail merge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59-15
Section Nine:
Appendices
A. Defining and initializing native libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1
Executing an LDMUTIL function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A-1
Initializing a native library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A-4
Offloading data from a native library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A-5
Reloading data that has been offloaded. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A-6
Verifying the space bitmap in a library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A-7
Listing directory entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A-8
Listing library statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A-9
Expanding the size of a native library. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A-10
B. Uploading resources from file to host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1
Sample JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .B-1
XPAF User Guide
xii
Table of Contents
C. Resource management parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-1
Parameters related to font resource management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-2
Parameters related to form resource management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-4
Parameters related to image resource management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-6
Parameters related to logo resource management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-8
Parameters related to list resource management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-9
Parameters related to PDL resource management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-10
Parameters related to page format resource management . . . . . . . . . . . . . . . . . . . . . . . . . . . C-10
Parameters related to paper-related tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-11
Parameters related to color cross-reference tables and color conversion table . . . . . . . . . . . C-12
Section Ten: Glossary
Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-1
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .I-1
XPAF User Guide
xiii
Table of Contents
XPAF User Guide
xiv
Section One:
Introduction to XPAF
Xerox Printer Access Facility (XPAF) software is a host-resident software
product that enhances the capabilities and use of Xerox printers in the
IBM z/OS environment. XPAF retrieves data streams from JES, a
third-party spool, or Xerox Direct Print Services (XDS) and prepares them
for printing on a Xerox printer.
Xerox only supports the XPAF features and functions described in the
user documentation that accompanies the software. Do not assume
support is provided if it is not explicitly documented.
This document provides the information you need to install, manage, and
print documents with XPAF. Additional sections found in the
documentation include a complete list of the parameters and keywords
used, error messages generated by XPAF, guides for operators and page
format editor users, a glossary, and an index.
XPAF documentation is delivered in PDF format. It is designed to be
viewed online; however, page layouts have been maintained so that you
can duplex print all or part of the documentation as necessary.
Section One: Introduction to XPAF
Section One: Introduction to XPAF
Getting started
1.
1
Getting started
This chapter provides a brief description of the documentation and the
conventions used.
XPAF User Documentation
When you use this document online you will find that cross references (in
light blue text) within the document are active links to the referenced
areas of the documentation, and that the index and table of contents also
provide active links directly to the subject matter.
This document is divided into the following sections:
•
Section One: Introduction to XPAF provides an overview of this
document and XPAF.
•
Section Two: Installing and Customizing XPAF describes how to
install the XPAF software on your system and tailor it to meet your
site’s specific requirements. It also describes how to set up your
printers and perform an installation verification. This section is
designed for the systems programmer responsible for installing and
customizing the XPAF software.
•
Section Three: Managing Resources with XPAF describes how to
load, create, convert, and update XPAF resources. This section is
intended for the system administrator who will be responsible for
managing and maintaining XPAF system resources.
•
Section Four: Printing Documents with XPAF describes how to print
line-mode, DJDE, XES, page-formatted, AFP, pass-through, and
VIPP documents. This section is intended for the systems
programmer, application programmer, or anyone who needs to print
documents with XPAF.
•
Section Five: XPAF Parameter and Keyword Reference describes
the initialization parameters, printer profile parameters, and JCL
keywords available to tailor an XPAF system, printer, or job to your
specific needs. This section is intended for the systems programmer,
application programmer, or anyone who needs to print documents
with XPAF.
Section One: Introduction to XPAF
1-1
Getting started
•
Section Six: XPAF Messages explains the informational, warning,
and error messages that XPAF issues. This section is intended for
systems programmers or application programmers who must
reference messages sent to the XOAF or XOSF log files.
•
Section Seven: XPAF Operator Guide describes the JES2, JES3,
XPAF-exclusive, and XDS-exclusive commands available to a host
console operator when printing with XPAF. This section is intended
for console operators, system administrators, systems programmers,
and any other personnel interested in the operator commands for
XPAF.
•
Section Eight: Xerox Page Format Editor User Guide describes how
to create and maintain page formats using XPAF facilities. This
section is intended for anyone who wants to format line-mode data
streams that are printed through XPAF.
•
Section Nine: Appendices provides instructions on using the
LDMUTIL utility to define and initialize your native resource libraries
and sample JCL to use for uploading resources from a file to the
host system. It also identifies the initialization and printer profile
parameters related to managing resources.
•
Section Ten: Glossary provides a glossary of the terms used within
the documentation as they relate to XPAF.
•
Index contains indexed information to help you locate specific topics.
Section One: Introduction to XPAF
1-2
Getting started
Conventions used
General conventions are used for these elements:
•
•
•
•
•
•
•
•
Notes
Cautions
Messages
JCL
Screen panels
Parameters, keywords, and commands
Library, dataset, and DD names
Sample data
Each element is described below.
Notes
A note is a hint that assists you in performing a task or understanding the
text.
NOTE: For greater emphasis, notes appear in blue text.
Cautions
A caution notifies you that an action or omission may result in damage to
your equipment, software, or data.
CAUTION: For greater emphasis, cautions appear in red text.
Messages
Messages displayed on the console are presented in uppercase,
nine-point Monotype.com font. For example:
XDI3514I
XOSF SYSTEM SMF RECORDING TURNED OFF
JCL
JCL listings and console displays longer than five lines are enclosed in
shaded frames similar to this example:
Section One: Introduction to XPAF
1-3
Getting started
//job-name JOB job-information
//LDMINIT
EXEC PGM=LDMUTIL,REGION=2048K
//STEPLIB
DD
DSN=library-name,DISP=SHR
//SYSPRINT
DD
SYSOUT=A
//LDMPRINT
DD
SYSOUT=A
//LDMPARM
DD
*
INITIALIZE
library-name
These conventions are used in JCL definitions:
•
Constant data is shown in uppercase type. You must code constant
data exactly as shown.
•
Variable data is shown in lowercase, italicized type. Replace the
italicized variables with your site’s values.
Screen panels
Information displayed on an ISPF panel is enclosed in a frame similar to
this example:
Xerox Output Administrative Facility
Load Centralized Forms to a Native Library
COMMAND ===>
INPUT
Dataset Name:
Member Name:
OUTPUT
Dataset Name:
Member Name:
Partial panels that show sample field entries appear between double lines
similar to this example:
Unit Measure: IN
LPI: 6
INPUT
OPTION START
_
1___ 6___
_
1___ 6___
_
9___ 29__
_
9___ 29__
OUTPUT
PRINT
LENGTH ACROSS DOWN
.3_____ 1.1____ A ______
.7_____ 8.92___ A ______
1.0____ 1.1____ A ______
1.8____ 8.4____ A ______
Section One: Introduction to XPAF
DIR FONT
DEF N
DEF N
DEF N
DEF N
COLOR CONSTANT
1-4
Getting started
Parameters, keywords, and commands
These conventions are used in the syntax definitions for initialization
parameters, printer profile parameters, IBM JCL keywords, XPAF
extended JCL keywords, TSO/batch commands, and operator
commands.
NOTE: Commas and parentheses are part of a statement’s definition
and must be included exactly as indicated.
Table 1-1.
Syntax conventions
Convention
Description
Example
Required text
Uppercase indicates text that must be
entered exactly as shown.
FONTLIB=CFONTLIB
Variable text
Lowercase italics represent an entry for
which you must supply a value.
OPHLQ=prefix
Numeric variable
A lowercase italicized “n” indicates a
numeric variable. The number of n’s shown
represents the maximum positional value of
the numeric variable.
CONROUTE=nnn
Abbreviation
Characters in small capital letters are
optional and can be abbreviated. In this
example, the value EBCDIC can be
abbreviated as E.
MODE=E BCDIC
No entry needed
The word “blank” indicates that a blank (that
is, no value) is an acceptable value.
IMAGEOUTIMP=blank
Select an entry from a list
Braces { } indicate that one of the enclosed
vertically-stacked items is required.
 LINE 

DEFLINE= DJDE 

 PAGE 
Optional entry
Square brackets [ ] indicate that the
enclosed text is optional.
OPWRITER=(DISK[,ONLY])
Multiple values
An ellipses (...) indicates that the preceding
item can be repeated. In this example, as
many as eight colors can be specified.
COLORIMG=(color1[,...,color8])
Section One: Introduction to XPAF
1-5
Getting started
Library, dataset, and DD names
Library names are referenced by their low level qualifier only, not their full
dataset name (for example, XPFSAMP). Add the high level qualifier used
at your site to determine the full dataset name of a library reference.
Dataset names can be 1- to 44-characters long. Unless otherwise noted,
dataset names and member names must follow standard z/OS naming
conventions.
XPAF uses several initialization and printer profile parameters that name
DD statements in your XOSF start-up proc. These parameters’ default
values match the low level qualifier names for the datasets to which they
point. For example, by default the PAPTBLDD initialization parameter
names the TABLELIB DD statement that points to the prefix.TABLELIB
dataset.
You may change any of the supplied DD names and dataset names in
your XOSF start-up proc. However, when describing a native library, the
XPAF documentation references the default name. So, if you have
changed the default dataset name, substitute your library name for the
library name in the XPAF documentation. Refer to Section Five: XPAF
Parameter and Keyword Reference for detailed description of these
parameters.
Sample data
Sample JCL, messages, reports, and IVPs shown within this document
reference a fictional company, Rainbow Office Supplies, its employees,
and its customers. Rainbow Office Supplies, its logo, the names of its
employees and customers, and any data used in the examples are
fictitious. Any similarity to actual companies or persons is purely
coincidental.
Section One: Introduction to XPAF
1-6
Getting started
Supported printers
XPAF supports these printer types:
•
Centralized printers are high-volume printers, which are either
channel-attached or remotely attached to the host. Channel-attached
printers are directly attached to a host computer by input/output
channels. Remotely-attached printers are physically connected to a
host computer via TCP/IP or a telecommunications line.Centralized
printers also are referred to as LCDS, DJDE, or Metacode printers.
PCL-capable printers are mid-volume printers, which are generally
remotely-attached to the host via TCP/IP.
VIPP-enabled printers are print devices on which VIPP software
resides. VIPP documents must be sent to a VIPP-enabled print
device.
•
•
Table 1-2.
XPAF-supported Xerox printers
Printer Model
DP
DP
DP
DP
DP
DP
DP
DP
DP
DP
DP
DP
Centralized
PCL-capable
4890 LPS
4850 LPS
4650 LPS
4635 LPS
4635MX LPS
4135 LPS
4090 LPS
4050 LPS
180 EPS
180 LPS
96 LPS
92C LPS
DocuSP or FreeFlow
Print Server family of
products
Phaser Family
WorkCenter Family
DT
DT
DT
DT
DT
6180
6155
6135
6115
6100
DocuSP Family with
the LCDS
Decomposer
Free Flow Print
Server with the
LCDS Decomposer
Creating PDF Documents
XPAF can also convert Linemode, LCDS, XES and AFP documents into
PDF files which can then be e-mailed to a recipient, stored on a server or
sent to a printer.
Section One: Introduction to XPAF
1-7
Getting started
Limitations of support
XPAF supports up to 64 printers per functional subsystem (FSS). The
capabilities of XPAF are limited to the functional abilities of the printer. For
example, if a printer does not support duplex printing, XPAF cannot
duplex a document sent to that printer.
Section One: Introduction to XPAF
1-8
Getting started
XPAF subsystems
XPAF is composed of two subsystems:
•
•
Xerox Output Administrative Facility (XOAF)
Xerox Output Services Facility (XOSF)
Figure 1-1 provides an overview of the relationship of the two
subsystems.
Figure 1-1. XPAF subsystems
Section One: Introduction to XPAF
1-9
Getting started
Xerox Output Administrative Facility
XOAF contains the functions and utilities that you use to prepare the
resources and supporting lists and tables needed during the printing
operation. Resources are fonts, forms, images, or logos that are required,
in addition to data, to print a document. A resource can be stored either
on the printer, in a library on the host, or inline in the data stream.
For more information about using XOAF utilities, refer to Section Three:
Managing Resources with XPAF.
Xerox Output Services Facility
XOSF interfaces with z/OS to accept documents from JES, convert them
into a format suitable for the intended printer, and transmit them to the
printer.
XOSF provides these functions:
•
•
•
Host system interface
Document processing
Document transmission and printing
Host system interface
XOSF interfaces with the host-resident z/OS operating system to accept
documents from JES. XOSF operates as an z/OS-based functional
subsystem (FSS) to obtain a data stream from the JES spool and maintain
control of the printer. Additionally, you can install XDS to invoke XOSF
directly without JES or any other spooling subsystem.
For the host console operator, the interface to Xerox printers through
XOSF remains the same as JES-controlled printers. For example, an
operator can start, stop, and interrupt a printer. The operator also can use
operator commands unique to XPAF to make inquiries to the system for
status, state, and activity levels. For more information refer to Section
Seven: XPAF Operator Guide.
Document processing
XOSF document processing is governed by the type of data stream and
the type of printer selected for printing. The supported data streams are
discussed later in this chapter. The supported printers are discussed in
Section Two: Installing and Customizing XPAF.
In most cases, XOSF performs a process called resource conditioning.
This process ensures that all resources required to print the document are
available before sending the data stream to the printer.
During XOSF processing, some data streams may require a conversion of
the print commands to a format recognized by the Xerox printer.
Depending on the data stream type being processed and the printer being
used, a data stream may be converted into one of the following kinds of
Xerox data streams:
•
Metacode data streams for printing on centralized printers. A
Metacode data stream consists of ASCII print records that include
carriage control commands, along with special codes known as
Section One: Introduction to XPAF
1-10
Getting started
metacodes, to define absolute positioning, orientation, and font
indexing.
•
XES data streams for printing on decentralized printers. XES control
codes are prefixed by a user-defined key which signals the printer to
recognize the character or characters that follow it as an escape
sequence.
•
PCL data streams for printing on PCL-capable printers. PCL data
streams contain characters called escape sequences which signal
the printer to recognize the character or characters that follow it as a
print command.
•
PDF data streams for printing on PDF printers or sending via e-mail.
PDF is a portable document open standard that contains a complete
description of the document that includes text, fonts, and images.
If a document already is formatted for the data stream type required by
the printer, conversion is not required. XPAF can send this type of data
stream directly to the printer after resource conditioning is complete. This
is known as native mode processing.
Other data streams can be sent to the printer without conditioning or
conversion. This is called pass-through processing. For example, a PCL
document can be sent directly to a PCL-capable printer without XPAF
altering the data stream.
For more information about document processing, refer to Section Four:
Printing Documents with XPAF.
Document transmission
After XOSF performs any necessary conversions and resource
conditioning, XOSF sends the document and tailored printer instructions
to the printer.
Section One: Introduction to XPAF
1-11
Getting started
Supported data streams
XPAF accepts these types of data streams:
•
•
•
•
•
•
•
Line-mode
DJDE
XES
Page-formatted
AFP
VIPP
Other (in pass-through mode)
XPAF’s data stream support is summarized by printer type in the table
below and discussed on the pages that follow. Refer to Section Four:
Printing Documents with XPAF for detailed information about how XPAF
processes each data stream type.
Centralized
printers
Decentralized
printers
PCL-capable
printers
PDF
printers
Line-mode
YES
YES
YES
YES
DJDE
YES
YES 1
YES 1
YES1
XES
NO
YES
YES 1
YES1
Page-formatted
YES 1
YES 1
YES 1
YES1
AFP
YES 1
YES 1
YES 1
YES1
VIPP
NO
NO
YES 2
NO
Other (in
pass-through
mode)
NO
YES 3
YES 3
YES3
Data stream type
1
2
3
Requires conversion.
Requires a VIPP-enabled printer.
Pass-through data streams are neither converted nor conditioned.
NOTE: You can enhance the look of your data streams by using
XPAF extended JCL to add print formatting commands and selecting
XPAF options at the time that your print job executes. XPAF provides
extended JCL keywords for use with most of the supported data
streams. For detailed information about the extended JCL keywords
available, refer to Section Five: XPAF Parameter and Keyword
Reference.
Section One: Introduction to XPAF
1-12
Getting started
Line-mode data streams
Line-mode (or 3211) data streams consist only of carriage control
commands and data. You can send line-mode data streams through
XPAF to any supported centralized, PCL-capable or PDF printer.
If you enhance the look of your line-mode data streams by using extended
JCL keywords, XPAF no longer considers the data stream as a line-mode
data stream. XPAF will process it as the relevant data stream type.
DJDE data streams
DJDEs are control statements that specify how a document should be
printed on a centralized printer. DJDE processing enables certain printer
parameters to be changed from one job, page, or record boundary to the
next. For example, you can use the COPIES DJDE to specify the number
of copies of a report to be printed.
You can generate DJDE data streams in one of two ways:
•
Format a line-mode data stream using standard IBM and XPAF
extended JCL.
•
Code DJDEs directly in a data stream or use an application to
produce a data stream containing DJDEs. In addition, you can
modify the initial DJDE packet using standard IBM and XPAF
extended JCL.
You can print DJDE documents on centralized, decentralized,
PCL-capable, and PDF printers. During document processing, XPAF uses
extended JCL keywords to insert DJDEs. The document is then
conditioned and processed as follows:
•
If the document is sent to a centralized printer, no further processing
is required.
•
If the document is sent to a PCL-capable printer, XPAF converts the
DJDE commands to XES commands, then converts the XES
commands to PCL commands.
•
If the document is sent to a PDF printer, XPAF converts the DJDE
commands to XES commands, then converts the XES commands to
PDF commands.
Section One: Introduction to XPAF
1-13
Getting started
XES data streams
XES data streams contain printer commands prefixed with user-defined
keys which dynamically change parameters for decentralized printers.
You can print XES documents on PCL-capable and PDF printers.
•
If the document is sent to a PCL-capable printer, XPAF converts the
XES commands to PCL commands before sending the document to
the printer.
•
If the document is sent to a PDF printer, XPAF converts the XES
commands to PDF commands before sending the document to the
printer.
Page-formatted data streams
Page-formatted data streams are line-mode data streams that have been
formatted using a Xerox page format. You can print page-formatted
documents on centralized, decentralized, PCL-capable or PDF printers.
•
If the document is sent to a centralized printer, XPAF converts the
page format settings to Metacode commands.
•
If the document is sent to a PCL-capable printer, XPAF converts the
page format settings to XES commands, then converts the XES
commands to PCL commands.
•
If the document is sent to a PDF printer, XPAF converts the page
format settings to XES commands, then converts the XES
commands to PDFcommands.
AFP data streams
AFP data streams can consist of:
•
Sequences of variable-length records called structured fields
•
Fixed- or variable-length records that contain both line-mode data
and structured fields
•
Line-mode data formatted using AFP JCL keywords
You can print AFP documents on centralized, decentralized, PCL-capable
or PDF printers.
•
If the document is sent to a centralized printer, XPAF converts the
AFP commands to Metacode commands.
•
If the document is sent to a PCL-capable printer, XPAF converts the
AFP commands to XES commands, then converts the XES
commands to PCL commands.
•
If the document is sent to a PDF printer, XPAF converts the DJDE
commands to XES commands, then converts the XES commands to
PDF commands.
Section One: Introduction to XPAF
1-14
Getting started
VIPP data streams
Variable Intelligent PostScript Printware (VIPP) data streams are
line-mode data streams that have VIPP commands inserted at the
beginning of the application. VIPP applications are sent to a
VIPP-enabled printer for processing.
Data streams in pass-through mode
You can send a data stream specifying pass-through mode to any
XPAF-supported decentralized, PCL-capable or PDF printer if the printer
supports the printer command language of the data stream. For example,
the data stream for a PCL document does not require a print command
conversion by XPAF before being sent to a PCL-capable printer.
XPAF does not perform any conversion, conditioning, or validation on
resources included in a pass-through document. All of the information
required to print the document must be contained within the data stream
because the data stream is sent directly to the printer without being
altered.
CAUTION: Unpredictable results may occur when:
•
printing a pass-through document through XPAF to a non-Xerox
printer
•
a pass-through data stream contains commands that are not
supported by the target printer.
Section One: Introduction to XPAF
1-15
Getting started
Parameter and keyword processing hierarchy
XPAF allows you to tailor your printing environment by providing control
at three levels: system, printer, and job.
Level
Description
System
XPAF provides control at the system level through the use
of required initialization parameters. Initialization
parameters specify z\OS and JES information, DD
statement names, DJDE formats and defaults, and other
processing options.
Printer
XPAF provides control at the individual printer level
through the use of printer profile parameters.
XPAF provides control at the job level through the use of
two types of keywords:
Job
•
Standard IBM JCL keywords that are supported by
XPAF
•
Extended JCL keywords that are unique to XPAF and
establish job- and output-specific values
During XPAF processing, printer profile parameters override initialization
parameters, and extended JCL keywords override initialization and/or
printer parameters.
Processing also can be affected by printer settings, specified JDL, and
settings in the JES parameters or XOSF start-up proc. For more
information refer to Section Five: XPAF Parameter and Keyword
Reference.
Section One: Introduction to XPAF
1-16
Section Two:
Installing and Customizing XPAF
This section is a programming guide for installing XPAF in an IBM z/OS
environment. Written for systems programmers, it provides step-by-step
instructions for installing and customizing the XPAF system.
XPAF installation procedures are described in sequential order. Whether
you are installing XPAF for the first time or reinstalling XPAF, you should
start at the beginning and proceed sequentially.
As the systems programmer responsible for installing and customizing the
XPAF system software, you should have experience installing host
software products. You also should have experience using Xerox printers.
Section Two: Installing and Customizing XPAF
Installation requirements
2.
2
Installation requirements
This chapter describes the hardware and software required to install and
use XPAF successfully. It addresses these topics:
•
•
•
•
•
Installation materials
SMP/E level
Hardware
Printer support
IBM host requirements
Installation materials
The XPAF installation materials include an installation file in TSO
Transmit format.
Refer to “Checklist for installing resources” in chapter 4, “Installing
resources” for a list of the resource files and their contents.
Media
The XPAF 6.0 software is downloadable from the Xerox corporate
website,
http://www.support.xerox.com/support/xpaf/software/enus.html
Content
The installation file is TSO Transmit output dataset of a single PDS,
referred to as the XMTPDS. The XMTPDS contains all the necessary files
to install the base product, latest maintenance and all resources.
SMP/E level
You must install XPAF using SMP/E Release 5 or higher.
Hardware
XPAF operates on any processor capable of running z/OS.
Section Two: Installing and Customizing XPAF
2-1
Installation requirements
Disk allocation
If you load both the centralized and decentralized libraries onto your
system, XPAF needs approximately 640 cylinders on single density 3380
disk drives. XPAF uses the storage as follows:
XOAF/XOSF
1220
SMP/E files
621
Resources
7759
(AFP and native mode)
Total tracks
9600
(640 cylinders)
Tables 2-1 through 2-3 show the approximate minimum space
requirements for all of the files created and used during XPAF installation.
The space figures shown in these tables reflect installation on single
density 3380 disks and may vary according to your DASD type. You may
increase any of these values based on your site’s installation and
environment.
Table 2-1.
XPAF SMP/E installation library requirements
Dataset name
DSORG
Tracks
(approx.)
RECFM
CSI
VSAM
63
V
SMPLOG
PS
60
SMPLOGA
PS
SMPMTS
LRECL
BLKSIZE
24 – 143
22528 (CISZ)
VB
510
3200
20
VB
510
3200
PO
26
FB
80
27920
SMPPTS
PO
402
FB
80
27920
SMPSCDS
PO
60
FB
80
27920
SMPSTS
PO
20
FB
80
27920
Table 2-2.
XPAF target, distribution, and operational library requirements
Dataset name
DSORG
Tracks
(approx.)
RECFM
LRECL
BLKSIZE
AXPFCLIB
PO
28
FB
80
27920
AXPFLOAD
PO
377
U
—
6144
AXPFMAC
PO
60
FB
80
27920
AXPFMLIB
PO
8
FB
80
27920
Section Two: Installing and Customizing XPAF
2-2
Installation requirements
Table 2-2.
XPAF target, distribution, and operational library requirements
Dataset name
DSORG
Tracks
(approx.)
RECFM
LRECL
BLKSIZE
AXPFPLIB
PO
64
FB
80
27920
AXPFSAMP
PO
132
FB
80
27920
AXPFSLIB
PO
8
FB
80
27920
INSTLIB
PO
45
FB
80
27920
STAGE2
PO
30
FB
80
27920
XINPARM
PO
4
FB
80
27920
XOAFLOG
PS
3
VB
256
27998
XOSFLOG
PS
5
VB
256
27998
XPFCLIB
PO
28
FB
80
27920
XPFLOAD
PO
221
U
—
23200
XPFLPA
PO
14
U
—
23200
XPFMAC
PO
15
FB
80
27920
XPFMLIB
PO
8
FB
80
27920
XPFPLIB
PO
64
FB
80
27920
XPFSAMP
PO
132
FB
80
27920
XPFSLIB
PO
8
FB
80
27920
XPFTOOLS
PO
11
FB
80
27920
Table 2-3.
XPAF resource file requirements
Dataset name
DSORG
AFPFONTS
PO
CFONTLIB
VSAM1
CFORMLIB
Tracks
(approx.)
RECFM
BLKSIZE
VBM
8205
27998
2925
N/A
4089
4096 (CISZ)
VSAM
30
N/A
4089
4096 (CISZ)
CIMGLIB
VSAM
135
N/A
4089
4096 (CISZ)
CLOGOLIB
VSAM
7
N/A
4089
4096 (CISZ)
DFONTLIB
VSAM
2925
N/A
4089
4096 (CISZ)
Section Two: Installing and Customizing XPAF
78
LRECL
2-3
Installation requirements
Table 2-3.
XPAF resource file requirements (Continued)
Dataset name
1
DSORG
Tracks
(approx.)
RECFM
LRECL
BLKSIZE
DFORMLIB
VSAM
28
N/A
4089
4096 (CISZ)
DIMGLIB
VSAM
120
N/A
4089
4096 (CISZ)
FFONTLIB
VSAM
1260
N/A
4089
4096(CISZ)
FIMGLIB
VSAM
30
N/A
4089
4096(CISZ)
IVPDATA
PO
10
FBA
172
27864
IVPRESC
PO
7
VBM
8205
27998
IVPXOAF
PO
3
FB
128
27904
PAGEFORM
PO
14
VBM
8205
27998
PDLLIB
VSAM
13
N/A
2041
2048 (CISZ)
PFONTLIB
VSAM
1260
N/A
4089
4096 (CISZ)
PFORMLIB
VSAM
4
N/A
4089
4096 (CISZ)
PIMGLIB
VSAM
30
N/A
4089
4096 (CISZ)
TABLELIB
VSAM
255
N/A
4089
4096 (CISZ)
XWRLIB
VSAM
6
N/A
2041
2048 (CISZ)
IDCAMS allocation for native VSAM files, used to store native resources, must meet these requirements:
VSAM files must be allocated in records.
The maximum number of records allowed in a VSAM file is 524,280.
VSAM files may span multiple volumes and extents.
Once a VSAM file is initialized, no secondary extents or additional candidate volumes can be acquired.
The CISZ must be one of these values: 512, 1024, 2048, or 4096.
The RECSIZ must be 7 less than the CISZ: 505, 1017, 2041, or 4089.
A sample IDCAMS allocation statement is shown in figure 2-1. For additional information concerning IDCAMS,
refer to your IBM DFP product guides.
Section Two: Installing and Customizing XPAF
2-4
Installation requirements
Printer support
XPAF supports centralized, decentralized, and PCL-capable printers. The
tables in this section provide the minimum supported software release
levels for centralized printers, decentralized printers, PCL-capable
printers, and interface devices.
The capabilities of XPAF are limited to the functional abilities of the
printer. For example, if a printer does not print duplex, XPAF cannot
duplex a document sent to that printer.
Centralized printers
This table lists the minimum supported release levels for centralized
printers.
NOTE: Throughout this document, references made to highlight color
printers refer to the 4890 and 4850 printers. Note that the 4890 NPS
and 4850 NPS printers do not support highlight color when printing
from XPAF.
Printer
Minimum software levels
4890/4850
V3.7/V4.0
4650/4090/4050
V2.1
(with the HIP52.TSK file and required XPAF patches)
V3.5
(latest patch level) plus any XPAF-specific patches
V3.0
(without XNS support)
4635
V3A
4635MX
V3A
4135
V3.6
180 EPS
V1.10
180 LPS
V3C2 Release 1.4
96 LPS
V3A
92C LPS
V5.4
DocuSP with the LCDS
decomposer
Any supported release
Free Flow Print Server
with the LCDS
decomposer
Any supported release
Section Two: Installing and Customizing XPAF
2-5
Installation requirements
Image requirements for centralized printers
To print images such as line art and photographs, centralized printers
must be equipped with the Xerox Graphics Handling Option subsystem or
Graphics Video Generator.
To print AFP and Xerox images such as page segments, overlays with
shading, and .IMG resources, all centralized printers must be equipped
with additional graphics processing memory. Depending on printer model
and operating system, centralized printers must be equipped with one of
three Xerox graphics processing memory options:
•
•
•
Graphics Handling Option (GHO)
Graphics Video Generator (GVG)
Graphics Video Generator II (GVGII)
The extra graphics memory is required because of the way XPAF
processes and transforms data streams that contain AFP and Xerox
images.
GHO, GVG, and GVGII consist of hardware, accompanying firmware, and
software. These options enable centralized printers to store, merge, and
print AFP and Xerox images in a text document at 300 dpi. Different
memory options are available, depending on your printer model:
•
Two GHO memory options are available for the 9790, 9700, 8790,
8700, 4090, and 4050: either 2 or 8 megabits.
•
Two GVG memory options are available for the 4650, 4135, and
4090: either 32 (option package 38P) or 256 megabits (option
package 39P).
•
Two levels of GVGII memory are available for the 4850: either 32 or
256 megabits.
The larger memory options are recommended for printing documents that
contain complex images or large numbers of images per page.
The printer’s operating system provides support for the various graphics
memory options. For detailed information about graphics memory options
for a specific printer, contact your local Xerox representative.
If your printer is equipped with any of the three graphics memory options,
you must specify GHO in the FEATURE printer profile parameter to
indicate that the printer has additional graphics memory. For information
about the FEATURE printer profile parameter defaults, refer to Section
Five: XPAF Parameter and Keyword Reference.
PCL-capable printers
This table lists the minimum supported release levels for PCL-capable
printers.
Printer
Minimum software levels
6100
V1.3
6115
V1.3
Section Two: Installing and Customizing XPAF
2-6
Installation requirements
Printer
Minimum software levels
6135
V1.3
6155
V1.3
6180
V1.3
4900
V2013.115
4050 NPS
V1.4
4090 NPS
V1.4
4635 NPS
V1.4
4850 NPS
V1.4
4890 NPS
V1.4
180 EPS
V1.10
180 NPS
V1.4
155 NPS
V1.7
115 NPS
V1.7
100 NPS
V1.7
96 NPS
V1.5
92C NPS
V5.4
DocuSP enabled printer
Any supported level
Free Flow Print Server enabled
printer
Any supported level
Software emulation modes
For all PCL-capable printers, XPAF supports PCL emulation mode. For
PCL-capable printers that also support HPGL, PostScript, and XES,
XPAF supports those emulation modes only when printing pass-through
documents.
For more information on the various printer command languages
supported by each printer, refer to chapter 10, “XPAF printer support.”
Section Two: Installing and Customizing XPAF
2-7
Installation requirements
IBM host requirements
To install and run XPAF, your host operating environment must include
specific software products at supported release levels.
Operating environments and JES levels
XPAF operates in all IBM-supported z/OS JES2 and JES3 environments.
When new host operating environments are released, XPAF will be
updated to ensure compatibility. Conversely, when IBM withdraws
support for a software release level, Xerox also will withdraw support for
that release level. Contact your local Xerox representative or review the
bulletin accompanying your latest maintenance file to verify specific
supported release levels.
IBM host products
These IBM host software products may be installed on your system.
Printer application products
XPAF can print applications created by these products at the specified
minimum release levels:
•
•
•
•
DCF Version 1.3.1
GDDM Version 2.1
PMF Version 1.1.0
PPFA Version 1.1.0
Section Two: Installing and Customizing XPAF
2-8
Installation requirements
System application products
XPAF can coexist with these products at the specified minimum release
levels:
•
DFP Version 2.3.0
•
ISPF Version 2.3
•
NCP Version 2
•
NTO BSC 3780 Version
(required to use XPAF with VTAM bisynchronous printers)
•
TCP/IP Version 3.2.0
•
TSO/E Version 1.4
•
VTAM:
—
Version 2.1:
PTF — UZ71704 (APAR OZ77159)
PTF — UZ75791 (APAR OZ80058)
PTF — UZ79846 (APAR OZ83529)
—
Version 2.2:
PTF — UZ71705 (APAR OZ77159)
—
Version 3.3
Resource protection
If your site uses multiple operating systems with global resource sharing
(such as shared DASD), you should provide some type of resource
protection such as IBM’s Global Resource Serialization (GRS) when
using XPAF.
Section Two: Installing and Customizing XPAF
2-9
Installation requirements
Installation service macro worksheets
Use these worksheets to build your installation service macro (ISM)
definitions. ISMs are used to install the XPAF base product, XPAF
resources, user exits, and XPAF maintenance software. All applicable
parameters are required unless identified as optional.
Before you begin installing XPAF, record your site-specific values in these
worksheets.
#GENDFLT worksheet
The #GENDFLT macro allows you to specify default values and other
information that is used for various parameters of other installation
service macros. The values you enter for the parameters in this macro
become the default values when you leave those same parameters blank
in other macros.
Macro
#GENDFLT
Parameter
Description
DUNIT
Default UNIT value for installation
DVOLSER
Default VOLSER of DASD device
EIHLQ
High level qualifier for the installation
XMTPDS
HLQ
Optional. Default high-level qualifier
for other ISM macros
LOADSIZE
Block size of execution libraries
OCLASS
Stage 2 print output class for
statements sent to the printer
OPTIONS
Specify default options to use for
installing XPAF
SMS
Optional. Default SMS Storage
and/or Management Class for
non-VSAM datasets
SMSVSAM
Optional. SMS Storage and/or
Management Class for non-VSAM
cluster definitions
SRCLIB
Optional. Dataset name of
user-modifiable source
Section Two: Installing and Customizing XPAF
Site values
2-10
Installation requirements
#GENJBCD worksheet
The #GENJBCD macro specifies job card values and optionally a JES2
JOBPARM card on all stage 2 jobs generated. This macro is optional and,
if not included, the @JOBCARD member is used to generate job cards at
the beginning of each stage 2 job.
All JOBCD and JOBPARM entries must begin and end with a single quote.
If a quote is required within the text, it must be entered as two single
quotes.
Macro
#GENJBCD
Parameter
Description
JOBCD1
Optional. Job card parameters for first
job card
JOBCD2
Optional. Continued job card
parameters from JOBCD1
JOBCD3
Optional. Continued job card
parameters from JOBCD2
JOBNAME
Optional. JOB name for all job cards
generated during stage 1
JOBOPT
Optional. Stage 1 macro options for
generating JCL on stage 2 jobs
JOBPARM
Optional. JOBPARM card parameters
for installation /*JOBPARM card
JOBVARY
Optional. Use a variable JOBNAME
on each job of generated stage 2
JCL?
Section Two: Installing and Customizing XPAF
Site values
2-11
Installation requirements
#GENJES worksheet
The #GENJES macro generates the JES values (if applicable) used to
create JES-specific samples and allocate installation SMP/E datasets.
Macro
#GENJES
Parameter
Description
JESFSSID
Optional. JES functional subsystem
ID
JESMAC
Optional. Name of the IBM-supplied
macro library name for JES
JESPROD
JES product used to install XPAF
JESUMAC
Optional. Library used to assemble
JES source or exits
JESLVL
JES level being run on host operating
systems
Section Two: Installing and Customizing XPAF
Site values
2-12
Installation requirements
#GENPROD worksheet
The #GENPROD macro assigns values to required parameters to install
XPAF. The values you enter for this macro are used to generate SMP/E
jobs, XPAF sample parameters, and sample JCL.
Macro
#GENPROD
Parameter
Description
DUNIT
UNIT value for non-VSAM datasets
DVOLSER
VOLSER of DASD device
HLQ
Optional. Prefix for non-VSAM
datasets
HLQLPA
Optional. XPFLPA high-level qualifier
in Master Catalog
HLQMST
Optional. XPFLOAD and XPFLPA
high-level qualifier in Master Catalog
OPTIONS
Specify installation options for XPAF
PRODUCT
Name of product being installed
PRODVRM
Version, release, and modification
level for this product
SMS
Optional. Default SMS Storage
and/or Management Class for
non-VSAM datasets
SMSVSAM
Optional. SMS Storage and/or
Management Class for non-VSAM
cluster definitions
UMODJOFT
Optional. SMP/E name used to install
JES offset table
Section Two: Installing and Customizing XPAF
Site values
2-13
Installation requirements
#GENSMP worksheet
The #GENSMP macro supplies the stage 1 SMP/E processing with
user-specified values. These values help define and initialize the SMP/E
structure and are used to maintain XPAF and its associated function.
Macro
Parameter
#GENSMP
Description
DUNIT
UNIT value for non-VSAM datasets
DVOLSER
VOLSER of DASD device
DWORK
UNIT value used for DWORK file
allocation during SMP/E execution
HLQ
Prefix for non-VSAM datasets
HLQVSAM
Prefix for VSAM datasets
MTS
Include SYSTEM MTS in all MTS DD
concatenations?
RELEASE
Current SMP/E release version
SMS
Optional. Default SMS Storage and/or
Management Class for non-VSAM
datasets
SMSVSAM
Optional. SMS Storage and/or
Management Class for non-VSAM
cluster definitions
USERHLQ
Prefix used for generation of SMP
dataset names of USEROPT option 2
or 3 is selected
USEROPT
Level of allocation for required SMP/E
datasets
VSMVOL
Use specified volume serial number
for generated VSAM file definitions
Site values
#GENUXIT and #UEXIT worksheets
The #GENUXIT and #UEXIT macros create stage 2 jobs that use SMP/E
to assemble and link your user-exit source code into the load library you
specify that is accessible by XPAF. All information pertaining to your exits
is entered in parameters of these macros.
Section Two: Installing and Customizing XPAF
2-14
Installation requirements
Macro
#GENUXIT
Parameter
Description
UMPFX
Default SYSMOD ID prefix
USEC
Optional. Generate stage 2 for this
exit?
USECLNKLB
Optional. Load library name linked by
SMP/E to user security module
USECSMID
Optional. SYSMOD ID
UXLNKLB
Optional. Load library linked by
SMP/E to exit modules
UXMAC
Optional. Defines user macro library
UXPFX
Optional. Default source member and
load module name prefix
UXSRCLB
PDS library for exit source code
#UEXIT
Site values
(01,)
(02,)
(03,)
(04,)
(05,)
(06,)
(07,)
(08,)
(09,)
(10,)
(11,)
(12,)
(30,)
(31,)
(32,)
Section Two: Installing and Customizing XPAF
2-15
Installation requirements
#GENEND worksheet
The #GENEND macro specifies generation variables for XPAF, resource
installation, and maintenance.
Macro
Parameter
#GENEND
Description
STAGE2
Optional. Place stage 2 jobs and
control statements in INSTLIB?
TYPE
Type of stage 2 jobs to generate
Site values
#GENRSC worksheet
The #GENRSC macro supplies the stage 1 processing with values
needed to define, initialize, and load the XPAF resource files.
Macro
#GENRSC
Parameter
Description
DUNIT
UNIT value for non-VSAM datasets
during resource allocation
DVOLSER
VOLSER of DASD device used to
allocate XPAF resource files
HLQ
Prefix for all XPAF resource datasets
during file allocation
HLQfile
Prefix for dataset names from
resource files
HLQVSAM
Prefix used for all VSAM resource
datasets during resource file
allocation
IVP
Offload IVP datasets with other
resource datasets
OPTIONS
Identify resource installation options
SIZCFONT
Specify the size of the CFONTLIB
allocated by the resource allocation
job
SIZCFORM
Specify the size of the CFORMLIB
allocated by the resource allocation
job
SIZCIMG
Specify the size of the CIMGLIB
allocated by the resource allocation
job
Section Two: Installing and Customizing XPAF
Site values
2-16
Installation requirements
Macro
#GENRSC
(continued)
Parameter
Description
SIZDFONT
Specify the size of the DFONTLIB
allocated by the resource allocation
job
SIZDFORM
Specify the size of the DFORMLIB
allocated by the resource allocation
job
SIZDIMG
Specify the size of the DIMGLIB
allocated by the resource allocation
job
SIZFFONT
Specify the size of the FFONTLIB
allocated by the resource allocation
job
SIZFIMG
Specify the size of the FIMGLIB
allocated by the resource allocation
job
SIZLOGO
Specify the size of the CLOGOLIB
allocated by the resource allocation
job
SIZPDL
Specify the size of the PDLLIB
allocated by the resource allocation
job.
SIZPFONT
Specify the size of the PFONTLIB
allocated by the resource allocation
job
SIZPFORM
Specify the size of the PFORMLIB
allocated by the resource allocation
job
SIZPIMG
Specify the size of the PIMGLIB
allocated by the resource allocation
job
SMS
Optional. Default SMS Storage
and/or Management Class for
non-VSAM datasets
SMSVSAM
Optional. SMS Storage and/or
Management Class for non-VSAM
cluster definitions
VSMVOL
Use specified volume serial number
for generated VSAM resource file
definitions
VSMVOLCF
Optional (if SMSVSAM or DVOLSER
specified). VOLSER of the DASD
volume used to allocated native
centralized font library
Section Two: Installing and Customizing XPAF
Site values
2-17
Installation requirements
#GENMNT worksheet
The #GENMNT macro generates SMP/E jobs to install product
maintenance, which is performed only when you receive a preventive or
corrective maintenance file. Information from other macros also is used
for installing maintenance software.
Macro
#GENMNT
Parameter
Description
HOLDFILE
Optional. Generate SMPHOLD
controls in the stage 2 RECEIVE job?
SMPSRCID
Optional. Specify the SMP/E
SOURCEID assigned to all PTFs and
APARs received
EIHLQ
Highlevel qualifier of the downloaded
SMPPTFIN data set
Section Two: Installing and Customizing XPAF
Site values
2-18
SMP/E installation
3.
3
SMP/E installation
This chapter lists the different SMP/E installation procedures required for
installing XPAF, including steps for installing:
•
•
•
•
The base product
Product maintenance
User modifications
User exits
Use the checklists supplied to record your progress as you perform each
step.
Installing the base product
The procedure for installing the base product file for XPAF 6.0 is listed
here. These steps explain how to:
•
•
•
•
•
•
Complete the pre-installation worksheets
Perform a system backup of all XPAF related libraries
Unload the installation library
Set up and execute the stage 1 job
Generate and execute stage 2 jobs
Perform the SMP/E installation
Perform these steps in sequential order.
Before you begin
Before you begin the XPAF installation, review these items.
Experience level
To install XPAF you should have systems programming experience and a
working knowledge of z/OS, JES2 and/or JES3, SMP/E, VSAM, and
ISPF/PDF. If you encounter any unfamiliar terms, refer to the appropriate
IBM reference manual for more information. If you need further help
installing this product, contact your local Xerox service representative.
Section Two: Installing and Customizing XPAF
3-1
SMP/E installation
Required security access levels
These security levels are required:
•
Have either update access to the LPA library or authority to create
new libraries in the Master Catalog.
•
Have alter access to LDM files based on how your security system
handles VSAM control interval processing. For example, RACF
security requires CONTROL authority to access files managed by
control interval processing.
•
Have update access to SYS1.PARMLIB, SYS1.PROCLIB, the
VTAMLST dataset, and the XOSF log datasets.
•
Have update access to the JES2 and/or JES3 parameters library.
•
Have read access to any datasets required by XPAF.
You must also be able to issue z/OS and JES operator commands.
System modifications
Ensure that no local usermods are applied that alter z/OS or JES control
blocks and/or JES processing flow. JES control blocks can have
user-added fields without affecting the operation of the system. However,
if you remove fields in JES control blocks or alter their field lengths, XPAF
may not function properly.
Checklist for installing the base product
As you complete each step, enter the completion date in the checklist
table to track and record your progress. Each step is explained later in this
chapter.
NOTE: Review the maintenance bulletin accompanying the most
current maintenance file to determine if you need to run any special
procedures before installing the base product.
Section Two: Installing and Customizing XPAF
3-2
SMP/E installation
Step
Action
1
Complete the pre-installation worksheets
2
Perform a system backup
3
Download and restore the installation PDS
4
Allocate stage 2 library
5
Set up stage 1 job
Date
completed
A Edit the #GENDFLT parameters in GENINST
B Edit the #GENJBCD parameters in GENINST
C Edit the #GENJES parameters in GENINST
D Edit the #GENPROD parameters in GENINST
E Edit the #GENSMP parameters in GENINST
F
Edit the #GENEND parameters in GENINST
6
Print installation service macros (optional)
7
Generate stage 2 jobs
8
Submit SMP/E installation jobs
A Submit IJOB101
B Submit IJOB102
C Submit IJOB103
D Submit IJOB104
E Submit IJOB105
F
Submit IJOB106
G Submit IJOB107
H Submit IJOB108
9
Perform post-installation steps
A Convert CLIST files (optional)
B Refresh LLA address space for XDS (optional)
Section Two: Installing and Customizing XPAF
3-3
SMP/E installation
Step 1 – Complete the pre-installation worksheets
Before you begin the installation process, you and your Xerox service
representative or systems analyst will participate in a site-planning visit.
During this visit, you will help the service representative complete the
pre-installation worksheets for the installation service macros, which help
define your site’s environment to XPAF. These worksheets and a
description of the parameters associated with the installation service
macros can be found at the end of this chapter.
Step 2 – Perform a system backup
Before you unload the installation library, you should perform normal
backup procedures for:
•
Any previous versions of XPAF
•
System libraries such as PARMLIBs, PROCLIBs, LPALST libraries,
and ISPF libraries
Step 3 – Download and restore the installation PDS
Step 1.Download the file XPAF60EI.FULL.XMTPDS.XMT from the Xerox
website at http://www.support.xerox.com/support/xpaf/software/enus.html
Step 2.Allocate a dataset, referred to in the following steps as 'xmit.in', to
receive the XPAF60EI.FULL.XMTPDS.XMT file using the following
specification:
RECFM=FB LRECL=80 SPACE= (CYL, 350, 35)
Step 3.Binary transfer the XPAF60EI.FULL.XMTPDS.XMT file into the
'xmit.in' dataset created in step 1
Step 4.Issue the 'TSO RECEIVE' command on the 'xmit.in' dataset to
restore the XMTPDS PDS. Due to the large file size, this step may take
several minutes to complete.
Section Two: Installing and Customizing XPAF
3-4
SMP/E installation
TSO RECEIVE INDA(xmit.in)
INMR901I Dataset XEROX.XPAF60.XMTPDS from MKEAN on NJEXE01
INMR906A Enter restore parameters or 'DELETE' or 'END' +
da('yourhlq.XPAF60.XMTPDS')
IEBCOPY MESSAGES AND CONTROL
IEB1135I IEBCOPY FMID HDZ1A10 SERVICE LEVEL UA46465 DATED 20090319
IEB1035I MKEAN
$$$X40
$$$X40
07:59:51 FRI 12 MAR 2010 PARM='WO
COPY INDD=((SYS00100,R)),OUTDD=SYS00098
IEB1013I COPYING FROM PDSU INDD=SYS00100 VOL=DATA02 DSN=SYS10071.T07
IEB1014I
TO PDS OUTDD=SYS00098 VOL=DATA01 DSN=yourhlq.XPAF60
IEB167I FOLLOWING MEMBER(S) LOADED FROM INPUT DATA SET REFERENCED BY
IEB154I @RESTORE HAS BEEN SUCCESSFULLY LOADED
IEB154I AFPFONTS HAS BEEN SUCCESSFULLY LOADED
IEB154I BASEPTFI HAS BEEN SUCCESSFULLY LOADED
IEB154I CFONTLIB HAS BEEN SUCCESSFULLY LOADED
...
IEB154I XPDLMSG HAS BEEN SUCCESSFULLY LOADED
IEB1098I 27 OF 27 MEMBERS LOADED FROM INPUT DATA SET REFERENCED BY
IEB144I THERE ARE 390 UNUSED TRACKS IN OUTPUT DATA SET REFERENCED BY
IEB149I THERE ARE 18 UNUSED DIRECTORY BLOCKS IN OUTPUT DIRECTORY
IEB147I END OF JOB - 0 WAS HIGHEST SEVERITY CODE
INMR001I Restore successful to dataset 'yourhlq.XPAF60.XMTPDS'
***
Step 5.Edit XMTPDS(@RESTORE), to insert a valid job card and specify
the correct names and high level qualifiers, then submit the job
//MYJOB JOB <INSERT A VALID JOB CARD>
//*
//* JCL TO RUN THE REXX EXEC TO RESTORE THE XPAF 6.0 INSTALLATION FILES
//*
//* THE RESTORE REXX TAKES TWO PARAMETERS
//*
- THE FULLY QUALIFIED DSN OF THE XMTPDS
//*
- THE HIGH LEVEL QUALIFIER FOR THE XPAF INSTALATION
//*
//*
//INFO
EXEC PGM=IKJEFT01,DYNAMNBR=25
//ISPPROF DD DUMMY
//ISPPLIB DD DUMMY
//ISPMLIB DD DUMMY
//ISPTLIB DD DUMMY
//ISPSLIB DD DUMMY
//SYSPRINT DD SYSOUT=Z
//SYSPROC DD DISP=SHR,DSN=YOURHLQ.XMTPDS
<== THIS DATASET
//SYSTSPRT DD SYSOUT=*
//SYSTSIN DD *
RESTORE YOUR.HLQ.XMTPDS YOUR.HLQ
//
Section Two: Installing and Customizing XPAF
3-5
SMP/E installation
Step 4 – Allocate stage 2 library
All output from stage 1 is considered the stage 2 library. Xerox
recommends using a separate stage 2 library instead of INSTLIB because
it offers these advantages:
•
The names of installation macros are not displayed when you view
the directory during stage 2 processing.
•
The INSTLIB member has fewer members.
Allocate the stage 2 library using either TSO or the $STG2ALO member
in INSTLIB. The library must have the same high-level qualifier(s) as the
INSTLIB.
•
•
If you use TSO, allocate the stage 2 library with these attributes:
RECFM
FB
LRECL
80 bytes
BLKSIZE
any multiple of 80
Directory blocks
30
Space
40 tracks of 3380 space or equivalent
If you use the $STG2ALO member to allocate the stage 2 library,
make these changes:
—
Add a valid job card to the start of the job.
—
Go to the end of the job and change the HLQ parameter to
reflect your site's dataset high-level qualifier for INSTLIB.
For further information on allocating your stage 2 library, refer to “Step 7
– Generate stage 2 jobs” later in this chapter.
Section Two: Installing and Customizing XPAF
3-6
SMP/E installation
Step 5 – Set up stage 1 job
Stage 1 consists of setting up the installation service macros (ISMs) to
reflect your site’s dataset naming conventions, operating system
specifics, and dataset placements for generating stage 2 jobs.
The $GENINST member of the INSTLIB dataset contains the macro call
for each ISM used to install the base product. Edit this member to specify
your site-specific values for the parameters in each macro call.
NOTE: Each parameter in $GENINST is in Assembly Language
Macro format. You must include continuation characters in column 72
and commas between parameters. If the value you specify contains
commas, periods, equal signs, or other special characters, you must
enclose the string in single quotation marks. If you need to code a
single quotation mark within a string, they must be coded as two
single quotation marks.
CAUTION: Do not edit the actual macro members in the INSTLIB
dataset. Edit only the $GENINST member in INSTLIB.
GENINST contains the specifications used by the various ISMs when
generating the stage 2 jobs via ASMUPD. This job then generates the
stage 2 jobs, which you submit to install the base product.
Step 5A – Edit the #GENDFLT parameters in $GENINST
In the $GENINST member of INSTLIB, locate the parameters used in
calling the #GENDFLT macro. Enter your site’s values for each
parameter.
The #GENDFLT macro allows you to specify default values and other
nonspecific values required for installation. Throughout this installation
process, you have the option to fill in a parameter or leave it blank, in
which case the default value is used. This macro sets the default values
for the parameters that you leave blank in other macros.
Example:
#GENDFLT
DUNIT=,
DVOLSER=,
EIHLQ=prefix,
HLQ=prefix,
LOADSIZE=23200,
OCLASS=,
OPTIONS=,
SMS=,
SMSVSAM=,
SRCLIB=prefix.SOURCE
Section Two: Installing and Customizing XPAF
X
X
X
X
X
X
X
X
X
3-7
SMP/E installation
#GENDFLT parameter definitions
This table provides a description for each parameter in the #GENDFLT
macro.
Parameter
DUNIT
Description
Specifies the default UNIT value for allocating non-VSAM datasets during
installation.
Default: None
DVOLSER
Specifies the default volume serial ID of the DASD device on which product
datasets will be allocated.
Default: None
EIHLQ
The high level qualifier of the XMTPDS installation file
Default: None
HLQ (optional)
Identifies the default high-level qualifier used by other installation macros which
require a high-level qualifier. For example, if you leave the HLQ parameter
blank in the #GENPROD macro, it defaults to the high-level qualifier you specify
here.
Default: None
LOADSIZE
Specifies the user-designated block size of the installation-generated execution
libraries (XPFLOAD and XPFLPA).
Defaults:
XPFLOAD
XPFLPA
Uses DCB attributes of SYS1.LINKLIB
Uses DCB attributes of SYS1.LPALIB
If you specify ABLK in the OPTIONS parameter, these defaults are overridden
by the user-specified system defaults.
OCLASS
Specifies the print output class that is generated on all stage 2 SYSOUT DD
statements.
Section Two: Installing and Customizing XPAF
3-8
SMP/E installation
Parameter
OPTIONS
Description
Identifies which default options to use when installing XPAF.
Valid values:
ABLK
Specifies whether to use the Automatic Blocking feature available
with DFP V3 and higher. This feature allows you to allocate
non-VSAM datasets without specifying a block size. When a
dataset is allocated, a default block size will be assigned based on
its record format. The default is set by the technical staff at your
site.
ASUB
Indicates whether installation jobs are submitted automatically or
manually. For example, if you specify this option, XPAF
automatically submits the next job in a series of jobs when the
current job has completed with a successful return code.
This option applies to installation jobs (IJOBnnn), maintenance
jobs (MPJOBnnn), resource jobs (RJOBnnn), and user
modification jobs (UMJOBnnn) generated by the installation
process.
PQ
Generates the product qualifier in dataset names during the
installation process. This qualifier consists of the values found in
the PRODUCT and PRODVRM parameters in the #GENPROD
macro.
Example:
OPTIONS=(ABLK,ASUB,PQ)
SMS
(optional)
Specifies the default SMS Storage and/or Management Class used for all
non-VSAM allocated datasets generated by the installation process. Using this
parameter signals the generation of SMS keywords in the DD statements. This
allows your system to place the datasets in user-defined storage areas
controlled by the operating system.
The default class assignments can be overridden by specifying the SMS
parameter in the macro responsible for the dataset generation (#GENSMP or
#GENPROD).
Valid values:
YES
SMS uses the system ACS routines for allocation of datasets.
storclass
SMS uses the user-defined storage class for allocation of
datasets.
mgmtclass SMS uses the user-defined management class for allocation
of datasets.
Default: None
Examples:
SMS=storclass
SMS=(storclass,mgmtclass)
SMS=(,mgmtclass)
Section Two: Installing and Customizing XPAF
3-9
SMP/E installation
Parameter
SMSVSAM
(optional)
Description
Specifies the SMS Storage and/or Management Class used for all SMP VSAM
cluster definitions generated by the installation process. Using this parameter
signals the generation of SMS keywords in the DEFINE statements. This allows
your system to place the datasets in user-defined storage areas controlled by
the operating system.
The default class assignments can be overridden by specifying the SMS
parameter in the #GENSMP macro.
Valid values:
YES
SMS uses the system ACS routines for allocation of datasets.
storclass
SMS uses the user-defined storage class for allocation of
datasets.
mgmtclass SMS uses the user-defined management class for allocation
of datasets.
Default: None
Examples:
SMSVSAM=storclass
SMSVSAM=(storclass,mgmtclass)
SMSVSAM=(,mgmtclass)
SRCLIB
(optional)
Specifies the fully qualified dataset name of the PDS used for user-modifiable
source supplied with XPAF. If this parameter is specified, all
installation-supplied sample members that you must edit and change are copied
into this library by the installation process. Using this optional library eliminates
the risk of overlaying a user-modified source member with product
maintenance.
Default: None
Section Two: Installing and Customizing XPAF
3-10
SMP/E installation
Step 5B – Edit the #GENJBCD parameters in $GENINST
In the $GENINST member of INSTLIB, locate the parameters used in
calling the #GENJBCD macro. Enter your site’s values for each
parameter.
The #GENJBCD macro allows you to specify either a job card name and
parameters that will be generated on the stage 2 job cards or an alternate
method of supplying this information. Use either of these options:
•
To generate job cards on each stage 2 job with your site-specific
information, enter the data in the parameters contained in the
$GENINST member.
•
To supply JCL to be generated at the beginning of all stage 2 jobs,
edit the @JOBCARD macro in INSTLIB, and create the prototype
JCL exactly as it is required with a REPRO statement ahead of each
JCL card (refer to the @JOBCARD macro in INSTLIB for an
example). To invoke this action, specify JOBOPT=REPRO in the
#GENJBCD section of the $GENINST member of INSTLIB. All other
parameters for this macro are then ignored.
You also can specify that no job card JCL is generated on stage 2
jobs. To invoke this action, specify JOBOPT=NOJBCD in the
#GENJBCD section of the $GENINST member in INSTLIB. All other
parameters for this macro are then ignored.
NOTE: If you do not specify values for any of the #GENJBCD
parameters, no job card will be generated.
Example:
#GENJBCD
JOBCD1='(E475,9901),''INSTALL'',CLASS=X,',
JOBCD2='MSGCLASS=X,NOTIFY=BRODR',
JOBCD3=,
JOBNAME=USERJB,
JOBOPT=,
JOBPARM='LINECT=50',
JOBVARY=
X
X
X
X
X
X
Result:
//USERJB JOB (E475,9901),'INSTALL',CLASS=X,MSGCLASS=X,
//
NOTIFY=BRODR
/*JOBPARM LINECT=50
To include a single quote for the job card output, you must code two single
quotes.
Section Two: Installing and Customizing XPAF
3-11
SMP/E installation
#GENJBCD parameter definitions
This table provides a description for each parameter in the #GENJBCD
macro.
Parameter
JOBCD1
(optional)
Description
Specifies the job card parameters you supply to be placed on the first job card.
If the job parameters are continued on another card, a comma must be placed
at the end of the last parameter on the card. The // and JOB statement are
supplied by installation macros.
Default: None
JOBCD2
(optional)
Specifies continued job card parameters from JOBCD1. The
// and JOB statement are supplied by installation macros.
Default: None
JOBCD3
(optional)
Specifies continued job card parameters from JOBCD2. The
// and JOB statement are supplied by installation macros.
Default: None
JOBNAME
(optional)
Specifies the JOB name that is placed on all job cards generated during stage
1. The maximum parameter length is eight characters and, if the JOBVARY
option is used, the name must be less than eight characters.
Default: None
JOBOPT
(optional)
Specifies options to the stage 1 macros that control the generation of the JCL
on stage 2 jobs.
Valid values:
NOJBCD
Suppresses all job card JCL generation on stage 2 jobs.
REPRO
Instructs stage 1 processing to use the @JOBCARD facility
described in the installation procedure to generate the stage 2
job card JCL.
Default: None (A job card will be generated using the values specified on the
other #GENJBCD options)
JOBPARM
(optional)
Specifies JOBPARM card parameters you supply to be placed on the
installation /*JOBPARM card. If you omit this parameter or leave it blank, no
/*JOBPARM is generated. The /*JOBPARM is supplied by installation macros.
Default: None
JOBVARY
(optional)
Varies the JOBNAME on each job of the stage 2 JCL generated by the stage 1
macros.
Valid values:
YES
Each JOBNAME will have a unique suffix in the stage 2 JCL. If the
job name supplied by the JOBNAME parameter is eight characters,
no name variance occurs.
NO
The job name you supply in the JOBNAME parameter is used as
is for all stage 2 jobs.
Default: NO
Section Two: Installing and Customizing XPAF
3-12
SMP/E installation
Step 5C – Edit the #GENJES parameters in $GENINST
In the $GENINST member of INSTLIB, locate the parameters used in
calling the #GENJES macro. Enter your site’s values for each parameter.
The #GENJES macro supplies stage 2 jobs and sample members with
information about your JES environment. Some information in this macro
is also used in conjunction with the #GENSMP macro in setting up the
SMP/E installation jobs.
Example:
#GENJES
JESFSSID=XOSF,
JESMAC=,
JESPROD=JES2,
JESUMAC=,
JESLVL=
X
X
X
X
#GENJES parameter definitions
This table provides a description for each parameter in the #GENJES
macro.
Parameter
JESFSSID
(optional)
Description
Specifies the JES functional subsystem ID. You should allow this parameter to
use its default value.
Default: XOSF
JESMAC
(optional)
Allows you to override the IBM-supplied macro library name for the version of
JES you are using. Enter the name you want to use.
Default: SYS1.SHASMAC (JES2)
SYS1.SIATMAC (JES3)
JESPROD
Identifies the JES product under which you are installing XPAF. Refer to
“Defining XPAF to JES” in chapter 5, “Customizing your system” for instructions
concerning activating XPAF with JES.
Valid values:
JES2
JES3
JES2 support is generated.
JES3 support is generated.
Default: None
Section Two: Installing and Customizing XPAF
3-13
SMP/E installation
Parameter
JESUMAC
(optional)
Description
Defines the library used when you assemble your JES source or exits. If you are
using a modified version of the JES macro library, enter that library’s dataset
name as the value for this parameter.
Default: None
JESLVL
Indicates the JES level being used for systems running the z/OS host operating
system. If specified, this value will be used as the mid-level qualifier for the JES
macro names generated by #GENJES.
Valid values:
A 1 to 8-character value indicating the version, release, and
modification level of the JES software.
Default: None
Example: JESLVL=V1R1M0
Step 5D – Edit the #GENPROD parameters in $GENINST
In the $GENINST member of INSTLIB, locate the parameters used in
calling the #GENPROD macro. Enter your site’s values for each
parameter.
This macro assigns values to installation parameters used to generate
SMP/E installation jobs.
Example:
#GENPROD
DUNIT=,
DVOLSER=,
HLQ=prefix,
HLQLPA=master-prefix,
HLQMST=,
OPTIONS=,
PRODUCT=XPAF,
PRODVRM=600
SMS=,
SMSVSAM=,
UMODJOFT=XUM0001
Section Two: Installing and Customizing XPAF
X
X
X
X
X
X
X
X
X
X
3-14
SMP/E installation
#GENPROD parameter definitions
This table provides a description for each parameter in the #GENPROD
macro.
Parameter
DUNIT
Description
Specifies the UNIT value for allocating non-VSAM XPAF datasets during
installation. This parameter is required unless SMS is used for allocating
product datasets or you specify the DUNIT parameter in the #GENDFLT macro.
Default: None
DVOLSER
Specifies the volume serial ID of the DASD device used for allocating XPAF
target and distribution libraries. This parameter is required unless you use SMS
for allocation or you specify the DVOLSER parameter in the #GENDFLT macro.
Default: None
HLQ
(optional)
Specifies the high-level qualifier for all non-VSAM XPAF datasets allocated
during installation. These libraries consist of target and distribution libraries for
executing and maintaining XPAF. The HLQLPA or HLQMST, if specified,
override HLQ for XPFLOAD and XPFLPA.
Default: The value specified for the HLQ parameter in the #GENDFLT macro. If
you do not specify the HLQ parameter in the #GENDFLT or
#GENPROD macros, an error message is issued and the assembly
terminates.
HLQLPA
(optional)
Specifies a high-level qualifier that will be used to catalog the XPFLPA dataset
in the Master Catalog of your system during XPAF installation. This high-level
qualifier is assigned to the XPFLPA to expedite installation and customization.
If you specified HLQMST, this parameter is ignored.
Default: None
HLQMST
(optional)
Specifies a high-level qualifier that will be used to catalog the XPFLPA dataset
in the Master Catalog of your system during XPAF installation. This high-level
qualifier is assigned to the XPFLOAD and XPFLPA to expedite installation and
customization.
Default: None
CAUTION: Both HLQMST and HLQLPA specify high-level qualifiers that
are cataloged in the Master Catalog. If you have multiple systems with
multiple catalogs, these datasets must be cataloged in all Master Catalogs
for all systems on which XPAF or on which jobs containing XPAF extended
JCL are submitted.
Section Two: Installing and Customizing XPAF
3-15
SMP/E installation
Parameter
OPTIONS
Description
Indicates that one or both of these options be used:
•
Install Xerox Direct Print Services (XDS) elements as part of the XPAF
LPA library. If not specified, the XDS FMID will not be installed and XDS
will not be available for use.
•
Bypass running the SMP/E APPLY and ACCEPT CHECK jobs IJOB105
and IJOB107. If you specify this option, you also must specify ASUB in the
#GENDFLT macro.
Valid values:
XDS
Installs the XDS FMID.
NOCHK
Does not submit installation jobs IJOB105 and IJOB107.
Default: None
Examples:
OPTIONS=XDS
OPTIONS=(XDS,NOCHK)
PRODUCT
Identifies the software product you are installing. Enter XPAF to generate XPAF
installation jobs.
Valid values:
XFG
The XPAF Forms Generator.
XPAF
The base XPAF product including the AFP, PCL and PDF
transforms
XPAFLITE
Install XPAF-Lite, a version of XPAF that does not include any
transforms, but will process LCDS and Linemode datastreams
to LCDS capable printers
XPAFLPDF XPAF-Lite with the additional DJDE to PDF transform
XPAFLPCL XPAF-Lite with the additional DJDE to PCL transform
Default: XPAF
PRODVRM
Identifies the version, release, and modification level of the base product. This
field is a maximum of 3 bytes. If the value ends in zeros, they may be omitted.
The file volume serial number of the base file being installed is generated from
this value.
Default: 600
Section Two: Installing and Customizing XPAF
3-16
SMP/E installation
Parameter
SMS
(optional)
Description
Specifies the SMS Storage and/or Management Class used for all SMP
non-VSAM allocated datasets generated by the installation process. Using this
parameter signals the generation of SMS keywords in the DD statements. This
allows your system to place the datasets in user-defined storage areas
controlled by the operating system.
This parameter overrides any default class assignment specified in the
#GENDFLT macro.
Valid values:
YES
SMS uses the system ACS routines for allocation of datasets.
storclass
SMS uses the user-defined storage class for allocation of
datasets.
mgmtclass SMS uses the user-defined management class for allocation
of datasets.
Default: None
Examples:
SMS=storclass
SMS=(storclass,mgmtclass)
SMS=(,mgmtclass)
SMSVSAM
(optional)
Specifies the SMS Storage and/or Management Class used for all SMP VSAM
cluster definitions generated by the installation process. Using this parameter
signals the generation of SMS keywords in the DD statements. This allows your
system to place the datasets in user-defined storage areas controlled by the
operating system.
This parameter overrides any default class assignment specified in the
#GENDFLT macro.
Valid values:
YES
SMS uses the system ACS routines for allocation of datasets.
storclass
SMS uses the user-defined storage class for allocation of
datasets.
mgmtclass SMS uses the user-defined management class for allocation
of datasets.
Default: None
Examples:
SMS=storclass
SMS=(storclass,mgmtclass)
SMS=(,mgmtclass)
UMODJOFT
(optional)
Specifies the name SMP/E uses to install the JES offset table. This usermod
supplies XPAF with the correct JES control block offsets required for JES
communication.
Default: XUM0001
Section Two: Installing and Customizing XPAF
3-17
SMP/E installation
Step 5E – Edit the #GENSMP parameters in $GENINST
In the $GENINST member of INSTLIB, locate the parameters used in
calling the #GENSMP macro. Enter your site’s values for each parameter.
The #GENSMP macro supplies stage 2 SMP/E jobs with all the necessary
information for the successful installation of XPAF.
You have several SMP/E options available for installing XPAF. For more
information on these options, refer to “#GENSMP parameter definitions”
later in this chapter.
Example:
#GENSMP
DUNIT=3380,
DVOLSER=VOL004,
DWORK=SYSDA,
HLQ=prefix,
HLQVSAM=,
MTS=,
RELEASE=5,
SMS=,
SMSVSAM=,
USERHLQ=,
USEROPT=1,
VSMVOL=
X
X
X
X
X
X
X
X
X
X
X
#GENSMP parameter definitions
This table provides a description for each parameter in the #GENSMP
macro.
Parameter
DUNIT
(optional)
Description
Specifies the UNIT value used for allocating non-VSAM SMP/E datasets and
the SMPTLIB during installation. This parameter is required unless the DUNIT
parameter in the #GENDFLT macro is specified. If you omit this parameter, a
value of SYSALLDA is assigned to facilitate allocation of the SMPTLIB.
Default: SYSALLDA
DVOLSER
Specifies the volume serial ID of the DASD device used for allocating the XPAF
SMP/E files. If an SMS or DUNIT value is specified, this value is used for VSAM
file allocation only. This parameter is required unless the DVOLSER parameter
in the #GENDFLT macro is specified.
Default: None
DWORK
(optional)
Specifies the UNIT value used for SMP SYSUTx and SMPWRKx file allocation
during SMP/E execution. This parameter is optional only if you specify a value
for either the #GENDFLT parameter DUNIT or the #GENSMP parameter
DUNIT.
Default: If you omit this parameter, the value you specified for DUNIT is used.
If you leave this parameter blank, it defaults to SYSDA.
Section Two: Installing and Customizing XPAF
3-18
SMP/E installation
Parameter
HLQ
(optional)
Description
Specifies the HLQ for all SMP/E non-VSAM datasets allocated during XPAF
installation.
Default: The value specified for the HLQ parameter in the #GENDFLT macro.
HLQVSAM
(optional)
Specifies the HLQ for all SMP/E VSAM datasets allocated during XPAF
installation.
Default: The value you specified for the HLQ parameter in this macro or its
default if you did not specify one.
MTS
(optional)
Instructs the installation process to include the SYSTEM MTS in all MTS DD
concatenations. Use this parameter if you are installing XPAF on a system that
frequently contains JES changes in an APPLY status.
Valid values:
YES
Concatenates the default name (SYS1.SMPMTS) to MTS
DD statements.
NO
Does not concatenate SYS1.SMPMTS to MTS DD
statements.
dataset-name
Identifies the fully qualified name of the system SMPMTS
dataset to be concatenated to MTS DD statements.
Default: YES
CAUTION: Use caution if XPAF is installed on a test system with JES
changes APPLYd but not ACCEPTed and then moved to a production
system where the changes have not been introduced. If the test system has
introduced a change to the JES control block, you must reassemble
XDIOFTAB before executing the product.
RELEASE
(optional)
Specifies the current release of SMP/E your system is using to install XPAF.
SMP/E release levels 5 and higher are supported by XPAF.
If you change release levels after your initial XPAF installation, this value does
not need to be changed.
Default: 5
Section Two: Installing and Customizing XPAF
3-19
SMP/E installation
Parameter
SMS
(optional)
Description
Specifies the default SMS Storage and/or Management Class used for all
non-VSAM allocated datasets generated by the installation process. Using this
parameter signals the generation of SMS keywords in the DD statements. This
allows your system to place the datasets in user-defined storage areas
controlled by the operating system.
This parameter overrides any default class assignment specified in the
#GENDFLT macro.
Valid values:
YES
SMS uses the system ACS routines for allocation of datasets.
storclass
SMS uses the user-defined storage class for allocation of
datasets.
mgmtclass SMS uses the user-defined management class for allocation
of datasets.
Default: None
Examples:
SMS=storclass
SMS=(storclass,mgmtclass)
SMS=(,mgmtclass)
SMSVSAM
(optional)
Specifies the SMS Storage and/or Management Class used for all SMP VSAM
cluster definitions generated by the installation process. Using this parameter
signals the generation of SMS keywords in the DEFINE statements. This allows
your system to place the datasets in user-defined storage areas controlled by
the operating system.
This parameter overrides any default class assignment specified in the
#GENDFLT macro.
Valid values:
YES
SMS uses the system ACS routines for allocation of datasets.
storclass
SMS uses the user-defined storage class for allocation of
datasets.
mgmtclass SMS uses the user-defined management class for allocation
of datasets.
Default: None
Examples:
SMS=storclass
SMS=(storclass,mgmtclass)
SMS=(,mgmtclass)
USERHLQ
Specifies the HLQ used for the generation of SMP dataset names if USEROPT
option 2 or 3 is selected. This parameter is required only if USEROPT is set to
a value other than 1. This entry is ignored if USEROPT=1. The HLQ specified
is then appended to the standard IBM SMP low level qualifier name where it is
used throughout the installation process.
Default: None
Section Two: Installing and Customizing XPAF
3-20
SMP/E installation
Parameter
USEROPT
(optional)
Description
Specifies the level of allocation for required SMP/E datasets. Depending on the
option specified, all, some, or none of these datasets will be allocated by the
installation process.
Valid values:
1
All SMP datasets required for product installation and maintenance will
be allocated by the installation process.
2
User-specified CSI and SMPPTS datasets will be used and all other
required SMP datasets will be allocated by the installation process.
The HLQ for the CSI and SMPPTS is specified by the USERHLQ
parameter.
3
All SMP required datasets are supplied by the user and will not be
allocated by the installation process. The HLQ for all SMP datasets is
specified by the USERHLQ parameter. All SMP dataset names in the
installation process will be generated with the IBM standard low level
qualifiers (such as SMPLOGA, SMPMTS, and SMPSCDS).
Default: 1
VSMVOL
Indicates whether to use the volume serial number specified here as the
SMPCSI dataset for the VSAM file definitions generated by the #GENSMP
macro. This parameter is required unless you specify the SMSVSAM or
DVOLSER parameters.
Default: None
Step 5F – Edit the #GENEND parameters in $GENINST
In the $GENINST member of INSTLIB, locate the parameters used in
calling the #GENEND macro. Review the default values specified for each
parameter.
The #GENEND macro specifies generation variables. The TYPE
parameter in this macro specifies the type of stage 2 output you want to
generate. Refer to “Step 7 – Generate stage 2 jobs” later in this chapter
for more information on this parameter.
Example:
#GENEND
STAGE2=YES,
TYPE=INSTALL
X
If you need to recreate a portion of the TYPE=INSTALL output, you can
specify the UMOD subset parameter of the INSTALL command. This
parameter recreates the UMJOBxxx jobs for installing usermods.
Section Two: Installing and Customizing XPAF
3-21
SMP/E installation
#GENEND parameter definitions
This table provides a description for each parameter in the #GENEND
macro.
Parameter
STAGE2
(optional)
Description
Specifies whether the stage 2 jobs and control statements will be placed by
stage 1 into a library other than INSTLIB.
Valid values:
YES
The stage 1 processing will place the stage 2 jobs and control
statements into a dataset with the same high-level qualifier as the
XPAF INSTLIB. The low-level qualifier is STAGE2.
NO
All stage 2 jobs and control statements will be placed into the
XPAF INSTLIB by stage 1 processing.
Default: YES
TYPE
Specifies the type of stage 2 jobs that are generated as output from stage 1
installation jobs.
Valid values:
INSTALL
Generates stage 2 jobs to install XPAF. This value is used with
the #GENINST macro.
MNT
Generates stage 2 jobs to install product maintenance using
SMP/E. This value is used with the #GENMNT macro.
RSC
Generates stage 2 jobs to install resources.
UXIT
Generates stage 2 jobs to install user exits you create. This
value is used with the #GENUXIT macro.
Default: None
Step 6 – Print the installation service macros (optional)
After you enter your site-specific values for the ISMs in GENINST, you
can print the file so you have a record of those value(s).
Use the IEBGENER utility to print GENINST, as shown in this sample job:
//job-name
//*
//*
//*
//PRINTMEM
//PRINTMEM
//SYSUT1
//SYSUT2
//SYSPRINT
//SYSIN
//PRINTMEM
//PRDETAL
JOB job-information
PRINT MEMBER FROM PDS
PROC NAME=
EXEC PGM=IEBGENER
DD DISP=SHR,DSN=prefix.INSTLIB(&NAME)
DD SYSOUT=X
DD DUMMY
DD DUMMY
PEND
EXEC PRINTMEM,NAME=$GENINST
Section Two: Installing and Customizing XPAF
3-22
SMP/E installation
Step 7 – Generate stage 2 jobs
Use the $ASMUPD member in INSTLIB to generate the jobs used to
install the base product. When you submit ASMUPD, it generates stage 2
jobs and sample parameters based on your entries in stage 1. You can
direct these jobs and sample parameters into a separate stage 2 library
(the default) or into INSTLIB.
To generate stage 2 jobs, follow the procedure in one of these two
options.
Option 1: Using a separate stage 2 library
1.
Specify STAGE2=YES in the #GENEND macro section of the
$GENINST member in INSTLIB. This indicates you are setting up
the stage 2 jobs to process with a stage 2 library named
prefix.STAGE2.
2.
Edit the $ASMUPD member in INSTLIB:
3.
a.
Add a valid job card to the start of the job.
b.
Go to the end and change the HLQ parameter on the EXEC card
to reflect your site's dataset high-level qualifier for INSTLIB.
c.
Note that the STAGE2 parameter defaults to ‘STAGE2’. This is
the low-level qualifier for the stage 2 library and should not be
changed.
d.
SAVE the member before submitting it as a job.
Submit ASMUPD to generate the stage 2 jobs.
Valid return code:
00
If you receive a return code other than 00, review the MNOTES in the
assembly output listing for further information. A return code of 01
through 04 is considered a warning, which you may review before
continuing. A return code of 08 is considered an error, indicating that
you must perform an action before continuing.
After stage 1 has completed successfully, stage 2 installation jobs and
sample parameters are available in the stage 2 library.
Section Two: Installing and Customizing XPAF
3-23
SMP/E installation
Option 2: Using INSTLIB
1.
Specify STAGE2=NO in the #GENEND macro section of the
$GENINST member in INSTLIB. This indicates you are setting up all
stage 2 jobs to use INSTLIB.
2.
Edit the $ASMUPD member in INSTLIB:
3.
a.
Add a valid job card to the start of the job.
b.
Go to the end of the file and change the HLQ parameter on the
EXEC card to reflect your site's dataset high-level qualifier for
XPAF INSTLIB.
c.
Change the STAGE2 parameter from the default value ‘STAGE2’
to ‘INSTLIB’.
d.
SAVE the member before submitting it as a job.
Submit ASMUPD to generate the stage 2 jobs.
Valid return code:
00
If you receive a return code other than 00, review the MNOTES in the
assembly output listing for further information. Return codes 01
through 04 are warnings; return code 08 indicates an error.
After the ASMUPD job has run and completed successfully, stage 2
installation jobs and sample parameters are available in INSTLIB.
Step 8 – Submit SMP/E installation jobs
You can find the JCL for each job listed below in the stage 2 library after
stage 1 is complete. Submit the SMP/E jobs in the specified order to
ensure XPAF is properly installed. IJOB101 through IJOB108 require no
JCL modifications for proper execution and should be submitted as is.
If you have to reinstall XPAF from the beginning, first use job DJOB101
(supplied in the stage 2 library) to delete all the datasets allocated by the
XPAF installation.
NOTE: Some of these installation jobs can generate more than
10,000 lines of output. Therefore, choose an appropriate SYSOUT
class.
Also, some of these installation jobs have a long run time. Therefore,
choose an appropriate job CLASS.
Section Two: Installing and Customizing XPAF
3-24
SMP/E installation
Step 8A – Submit IJOB101
IJOB101 performs these functions:
•
Allocates non-VSAM SMP/E datasets needed to install and maintain
XPAF and associated functions.
•
Allocates the SMPCSI needed to install and maintain XPAF and
associated functions. This allocation occurs only if the #GENSMP
parameter USEROPT=1.
•
Copies GLOBAL definitions to the stage 1 library when a separate
stage 2 library is used. This step is generated if you specified
STAGE2=YES in the #GENEND parameter.
Valid return code:
00
Step 8B – Submit IJOB102
IJOB102 performs these functions:
•
Generates a dummy job if the #GENSMP parameter USERSOPT
does not equal 1.
•
Initializes the SMPCSI by copying the GIMZPOOL data from your
system macro library.
•
Defines and initializes a target and distribution library zone for XPAF
and associated functions.
•
Adds the OPTION member to the global zone to be used when
installing or maintaining XPAF and associated functions.
•
Adds DD definitions to these zones.
Valid return code:
00
Section Two: Installing and Customizing XPAF
3-25
SMP/E installation
Step 8C – Submit IJOB103
IJOB103 allocates the target and distribution libraries needed to install
and maintain XPAF.
Valid return code:
00
Step 8D – Submit IJOB104
IJOB104 RECEIVEs XPAF functions from the base product distribution
file.
Valid return code:
00
Step 8E – Submit IJOB105
IJOB105 runs an APPLY CHECK on XPAF functions.
Valid return code:
00
Step 8F – Submit IJOB106
IJOB106 APPLYs XPAF functions.
Valid return code:
00
Step 8G – Submit IJOB107
IJOB107 runs an ACCEPT CHECK on XPAF functions.
Valid return code:
00
Step 8H – Submit IJOB108
IJOB108 runs ACCEPTs on XPAF functions.
Valid return code:
04
Section Two: Installing and Customizing XPAF
3-26
SMP/E installation
Step 9 – Perform post-installation steps
After you submit the last installation job, continue with your installation
process:
•
If you received XPAF software maintenance (preventive, level set, or
corrective files) with your base product file, install that software at
this point in the installation procedure. For instructions, refer to
“Installing maintenance” later in this chapter.
•
If you did not receive a maintenance file with the base product file,
install the XPAF usermods. For instructions, refer to “Installing
usermods” later in this chapter.
Also, you may need to perform the steps described here. Review these
steps before continuing with the installation and perform any necessary
tasks.
Step 9A – Convert CLIST files (optional)
When you customize your system, you can convert CLIST files in the
XPFCLIB dataset from FB to VB format. After copying any CLIST
members you must edit and remove line numbers if they are present.
Step 9B – Refresh LLA address space for XDS (optional)
To install XDS elements, you must refresh the z/OS Library Lookaside
address space after the installation is complete. To refresh this address
space, enter this command:
MODI F Y
LLA,REFRESH
This command updates the z/OS lookaside list with the addresses of the
most current XDS modules.
Section Two: Installing and Customizing XPAF
3-27
SMP/E installation
Installing maintenance
Periodically, Xerox distributes XPAF software maintenance in the form of
a preventive or corrective SMPPTFIN file. These files provide
enhancements and/or fixes to problems reported against XPAF between
releases of the product.
This section contains the basic procedures for installing maintenance
software, which you must repeat each time you receive a maintenance
file. The maintenance bulletin that accompanies the maintenance file
describes any procedures you may need to perform before or after
installing the file. You should review the maintenance bulletin before
performing the procedures in this section.
If conflicts exist between the instructions in this section and those in the
maintenance bulletin, use the information in the maintenance bulletin.
The most recent XPAF maintenance can be downloaded from:
http://www.support.xerox.com/support/xpaf/software/enus.html?fileLang
uage=en
Applicability of instructions
When installing software maintenance, you can be categorized as one of
three types of customers:
•
NEW customers are installing the base XPAF software for the first
time.
•
CURRENT customers have previously installed XPAF and have
installed the latest preventive maintenance on their system.
•
NOT CURRENT customers are existing XPAF customers who may
have installed some corrective or preventive maintenance on their
system but have not yet installed the latest preventive maintenance.
The heading for each maintenance installation step indicates to which
type of customer the step applies. When reviewing the maintenance
installation steps, refer to the section heading to determine whether the
step applies to your site.
Section Two: Installing and Customizing XPAF
3-28
SMP/E installation
Scheduling and tracking your installation
This table lists the activities to be performed during the maintenance
process. Perform these procedures in the order shown.
As you complete each step, enter the completion date in the checklist
table to track and record your progress. Each step is explained later in this
chapter.
Step
1
Action
Date
completed
Perform pre-installation steps
A Review maintenance bulletin for special
instructions
B Verify contents of the maintenance package
C Verify software levels
D Perform SMP/E housekeeping
E Install maintenance to modules in the LPA
2
Set up stage 1 job
A Verify previous maintenance
B Update $GENMNT in INSTLIB
3
Generate stage 2 jobs
4
Code the SYSTEM HOLD bypass JCL
5
Execute stage 2 jobs
A Edit and submit MPJOB101
B Edit and submit MPJOB102
C Edit and submit MPJOB103
D Edit and submit MPJOB104 (optional)
E Edit and submit MPJOB105 (optional)
6
Perform post-installation procedures
A Complete applicable post-installation
instructions
B Perform an IPL, if necessary
C Verify the maintenance installation
Section Two: Installing and Customizing XPAF
3-29
SMP/E installation
Step 1 – Perform pre-installation procedures
Perform these steps to prepare your system before installing a corrective
or preventive maintenance.
Step 1A – Review the maintenance bulletin (New, Current,
Not Current)
The maintenance bulletin contains information that relates specifically to
the maintenance you are installing. Before you begin, read through the
bulletin to determine if there are any steps that must be performed before
installing the maintenance.
Step 1B – Verify software levels (New, Current, Not Current)
You must have the XPAF V6R0M00 base product installed on your system
before you apply XPAF 6.0 maintenance.
Section Two: Installing and Customizing XPAF
3-30
SMP/E installation
Step 1C – Perform SMP/E housekeeping (New, Current, Not
Current)
Before you install XPAF maintenance, complete these additional steps.
1.
Back up all XPAF SMP/E, target, and distribution library datasets.
2.
Perform an SMP/E Query with List to determine if the XPAF base
software and any previous XPAF maintenance have been accepted.
•
If you have already accepted the base product and previous
maintenance, skip this step.
•
If you have not accepted previous maintenance, run MPJOB104
and MPJOB105 to accept previously applied PTFs. You must
specify BYPASS(HOLDSYSTEM) on the ACCEPT.
3.
Compress all SMP/E, target, and DLIB partitioned datasets.
4.
Back up all XPAF datasets again.
5.
If you have modified any members within XPFSAMP and are using
the members as source, save that source in a library other than
XPFSAMP.
Step 1D – Install maintenance to modules moved to LPA
(New, Current, Not Current)
If you receive maintenance that updates one or more modules which have
been moved to the LPA, you have two options:
•
Install that maintenance directly to the LPA, as described below.
•
Move the LPA-eligible module(s) to the LPA after you install the
maintenance, as described in “Step 6 – Perform post-installation
procedures” later in this chapter.
Refer to “Tuning your system” in chapter 5, “Customizing your system” for
a list of the modules which can be moved to the LPA.
Section Two: Installing and Customizing XPAF
3-31
SMP/E installation
Change the target library for LPA-eligible modules
Before you RECEIVE and APPLY the maintenance, use the SMP/E
UCLIN facility to inform SMP/E that the modules will be moved to a new
target library. Use the SMP/E control statements provided in this example:
SET BOUNDARY (XPFTLIB) .
UCLIN .
/* REPEAT THE NEXT STATEMENT ONE TIME FOR EACH MODULE MOVED
TO XPFLPA, SUBSTITUTING THE MODULE NAME FOR lmodname */
REP LMOD (lmodname) SYSLIB (XPFLPA) .
ENDUCL .
Ensure that the dataset pointed to by the XPFLPA DD is large enough to
contain all the LPA-eligible modules. If you allocate a dataset the same
size as XPFLOAD, you will have sufficient space.
Step 2 – Set up stage 1 job
You generate the jobs to install XPAF software maintenance and its
associated functions in the same manner you generated the installation
jobs for the base file. The stage 1 procedure requires you to complete the
#GENMNT macro parameters in the $GENMNT member to generate the
stage 2 jobs for software maintenance processing.
Complete these steps to execute the stage 1 job to generate the stage 2
maintenance jobs. Refer to the information in the maintenance bulletin
that accompanies the maintenance for more file-specific instructions.
Step 2A – Verify previous maintenance (Current, Not
Current)
Verify that all previous maintenance except APARs has been ACCEPTED
by SMP/E with MPJOB105.
Section Two: Installing and Customizing XPAF
3-32
SMP/E installation
Step 2B – Edit $GENMNT in INSTLIB (New, Current, Not
Current)
Edit the GENMNT member in the INSTLIB dataset. This member contains
the parameters used in calling two macros: #GENMNT and #GENEND.
The #GENMNT macro parameters supply stage 2 maintenance jobs with
information required for successfully installing maintenance to XPAF and
its associated functions. All members containing stage 2 jobs created by
this macro begin with the prefix MPJOB.
Example:
#GENMNT
HOLDFILE=YES,
SMPSRCID=,
EIHLQ=
X
X
X
In this sample of the #GENMNT macro, replace the volser variable with
the VOLSER of the maintenance file you are installing.
The TYPE parameter in the #GENEND section of $GENMNT specifies
TYPE=MNT to instruct the installation service macros to generate the
stage 2 jobs that will apply maintenance to XPAF. Do not change this
value.
For more information on the #GENEND macro parameters, refer to
“#GENEND parameter definitions” earlier in this chapter.
Section Two: Installing and Customizing XPAF
3-33
SMP/E installation
#GENMNT parameter definitions
This table provides a description for each parameter in the #GENMNT
macro.
Parameter
HOLDFILE
(optional)
Definition
Used when a HOLDDATA file is supplied on the maintenance file. Refer to the
maintenance bulletin that accompanies the maintenance file for instructions on
using this parameter with the file.
Valid values:
YES
Generates an SMPHOLD DD statement and the HOLDDATA
SMP/E keyword in the stage 2 maintenance file RECEIVE job.
NO
Does not generate SMPHOLD controls on the stage 2 RECEIVE
job.
Default: NO
SMPSRCID
(optional)
Specifies the SMP/E SOURCEID to be assigned to all PTFs or APARs received
from the software maintenance file and is used by SMP/E for maintenance
selection.
Default: None (no SOURCEID is generated).
EIHLQ
Defines the dataset high level qualifier for the SMPPTFIN dataset.
Default: None
Section Two: Installing and Customizing XPAF
3-34
SMP/E installation
Step 3 – Execute stage 1 job (New, Current, Not Current)
Edit the $ASMUPD member in INSTLIB as necessary. Then, complete
these steps:
1.
Specify $GENMNT for the INSTYPE parameter.
2.
Submit this job to generate stage 2 jobs. When stage 1 has
completed successfully, all stage 2 installation jobs and sample
parameters have been placed in the stage 2 library.
3.
If you used INSTLIB for stage 2, reedit the library to refresh the
directory and display the new members. If you used a separate
library for stage 2, edit that library to display the member list.
Step 4 – Code the SYSTEM HOLD bypass JCL (New,
Current, Not Current)
When installing software maintenance, you should use the system hold
bypass feature. If you do not use system hold bypass, any fixes that have
a ++HOLD, and any fixes associated with those on hold, will not be
APPLYd. The valid return codes are 08 or less.
To bypass a system hold, perform these steps:
1.
Examine the maintenance bulletin for special instructions relating to
fixes in HOLD status.
2.
Depending on the installation step you are performing, edit the
MPJOB102 (APPLY CHECK) or MPJOB103 (APPLY) member to
remove the /* and */ characters from this line:
/* BYPASS(HOLDSYSTEM) */
3.
Execute the stage 2 jobs to install the software maintenance. The
fixes you removed from system hold bypass will be APPLYd along
with the other fixes.
NOTE: If you do not remove the /* and */ characters in the file, a
return code of 12 is issued to indicate that fixes in SYSTEM HOLD
were bypassed. If you do remove the characters, a return code of 04
is issued to indicate that fixes in SYSTEM HOLD were applied.
Section Two: Installing and Customizing XPAF
3-35
SMP/E installation
Step 5 – Execute stage 2 jobs
After you complete the stage 1 maintenance jobs, the jobs to RECEIVE,
APPLY, and ACCEPT XPAF maintenance are located in the stage 2 JCL
library and can be submitted for execution as is. The jobs are located in
member names MPJOB101 through MPJOB105.
For MPJOB102 through MPJOB105, if you receive a return code of 08,
examine the messages from SMP/E to confirm that the return code was
caused by missing prerequisite maintenance.
NOTE: To ensure the integrity of interrelated fixes, Xerox
recommends that you RECEIVE and APPLY all fixes on a
maintenance file. Ensure that any previous maintenance has been
ACCEPTed before APPLYing a maintenance file.
If you experience a problem with your software, you must APPLY all fixes
on the current maintenance level before reporting the problem to Xerox
Technical Support.
Step 5A – Edit and submit MPJOB101 (New, Current, Not
Current)
This job RECEIVEs PTF maintenance for XPAF functions.
Valid return code:
00
Step 5B – Edit and submit MPJOB102 (New, Current, Not
Current)
This job runs an APPLY CHECK on software maintenance for functions
received in step 1.
Valid return code:
00 and 04. A return code of 04 indicates that a
system hold bypass was encountered.
Step 5C – Edit and submit MPJOB103 (New, Current, Not
Current)
This job APPLYs the software maintenance to the functions for which
maintenance was RECEIVEd in step 1.
Valid return code:
00 and 04. A return code of 04 indicates that a
system hold bypass was encountered.
Step 5D – Edit and submit MPJOB104 (New, Current, Not
Current)
This job runs an ACCEPT CHECK on software maintenance for functions
RECEIVEd in step 1. This job is optional.
Section Two: Installing and Customizing XPAF
3-36
SMP/E installation
Valid return code:
00 and 04. A return code of 04 indicates that a
system hold bypass was encountered.
Step 5E – Edit and submit MPJOB105 (New, Current, Not
Current)
This job ACCEPTs the software maintenance to the functions for which
maintenance was RECEIVEd in step 1. This job is optional.
Valid return code:
00 and 04. A return code of 04 indicates that a
system hold bypass was encountered.
Step 6 – Perform post-installation procedures
After you have installed the maintenance file, review this section to
determine which of the procedures applies to your site.
Step 6A – Complete applicable post-installation instructions
This section contains instructions for special procedures that you may
need to perform, depending on which XPAF options you use. After you
install maintenance, review this information to determine if any of the
procedures apply to your site.
Convert CLIST files (New, Current, Not Current)
When you customize your system after applying a maintenance file, you
may convert CLIST files in the XPFCLIB dataset from FB to VB format.
After copying any CLIST members you must edit and remove line
numbers if they are present
Update sample source code (Current, Not Current)
If you have made changes to any sample source distributed in XPFSAMP,
examine the new samples for changes that affect your source. If there are
differences, you must recustomize, reassemble, and link-edit the sample
source code.
Update sample macros (Current, Not Current)
If the maintenance file includes updates to any of the sample macros,
perform these tasks:
1.
Change the macro you are currently using to match the new sample.
2.
Reassemble and link-edit your user exits.
Also, review any other new macros in the sample macro library for
applicability to your environment.
Section Two: Installing and Customizing XPAF
3-37
SMP/E installation
Update JES offset table (Current, Not Current)
If the maintenance includes updates to the JES offset table (XDIOFTAB),
before you start printers that use XPAF, run UMJOB101 to reassemble
and link-edit XDIOFTAB. If you have applied usermod XUM0001, you
must reapply it.
Update TABLELIB (Current, Not Current)
If the maintenance file includes updates to the TABLELIB, unload the
appropriate file from the file. For customers defaulting to letter size paper,
unload the file that contains the letter size TABLELIB updates. For
customers defaulting to A4 size paper, unload the file that contains the A4
TABLELIB updates.
For complete instructions on unloading these files, refer to the bulletin
accompanying the maintenance file.
Update PROFILES member (Current, Not Current)
If you have made changes to the PROFILES member in XPFSAMP and
have stored those changes in your sample library, perform these steps:
1.
Examine the new sample for changes that affect your system.
2.
Recustomize your printer profiles as required.
3.
Store the profiles in the dataset specified by the PROFDD
initialization parameter.
Update user exits (Current, Not Current)
If you have made changes to any of the user exits and have stored those
changes in XPFSAMP:
1.
Examine the new samples for changes that affect your system.
2.
Recustomize the sample exits in XPFSAMP as required.
3.
Submit the appropriate UXJOBnn to reassemble and link-edit the
user exits.
NOTE: If you are using the JES2 user exits XRXJ2X4 and XRXJ2X6,
you must restart the JES2 MAS system with a WARM START for the
new exits to take effect.
Section Two: Installing and Customizing XPAF
3-38
SMP/E installation
Move modules to the LPA (Current, Not Current)
After you install the maintenance, select the ISPF option to MOVE (not
COPY) LPA-eligible modules from XPFLOAD to an LPALST library that
has been previously defined and authorized for use.
Update JDT modules (Current, Not Current)
The JDT modules in the LPA may have been modified by the
maintenance. After you have dynamically loaded the JDT modules into
the MLPA, implement the changes to the JDTs by specifying the REDO
option on the PARM parameter of the EXEC statement in the extended
JCL proc. Otherwise, you must IPL with a CLPA.
Use XJCF simulation (Current, Not Current)
If you use XJCF simulation processing, be sure to perform the following
step:
•
Reassemble and link-edit the XJCFSIM table into the XPFLOAD
library.
Install maintenance for XDS (New, Current, Not Current)
All software maintenance for XDS is shipped on the maintenance files for
XPAF. After you apply maintenance to XDS modules, you must refresh
the z/OS Library Lookaside address space using this command:
MODI F Y
LLA,REFRESH
This command updates the z/OS lookaside list with the addresses of the
most current XDS modules.
Section Two: Installing and Customizing XPAF
3-39
SMP/E installation
Step 6B – Perform an IPL (New, Current, Not Current)
Once the software maintenance is installed, you may need to perform an
IPL with CLPA on your system. An IPL will:
•
•
•
•
•
•
•
•
Add required modules to the LPA
Authorize required XOSF libraries
Update the z/OS link list
Update the PPT
Update the Subsystem Name Table
Define printers to z/OS
Invoke updated JES parameters
Make extended JCL support available, if requested
If you are familiar with the procedure for restarting JES and/or z/OS
without performing an IPL, you may use that procedure.
Step 6C – Verify the maintenance installation (Current, Not
Current)
If you have applied maintenance to an existing XPAF system, you can
verify the accuracy of your software maintenance installation by executing
an IVP. For more information about performing an IVP, refer to chapter
17, “Performing an installation verification procedure.”
If you are installing a new XPAF system, do not execute the IVPs at this
time. Continue with the remaining installation steps, then perform the IVP
as explained in chapter 17, “Performing an installation verification
procedure.”
Section Two: Installing and Customizing XPAF
3-40
SMP/E installation
Installing usermods
A user modification (usermod) is supplied with XPAF to allow you to
customize the tables used by XPAF; for example, the JES offset table.
You must install the usermod for the JES offset table to make XPAF
operational.
The JCL required to install usermods is generated during stage 1 of the
base XPAF installation. The generated JCL can be submitted without
change. All usermod JCL members in the stage 2 dataset have a prefix of
UMJOB. Each usermod is set up specifying REDO, so you can resubmit
the original SMP/E APPLY JCL to reinstall the usermod.
CAUTION: If you make any modifications to your JES system, such
as installing maintenance to JES, you must resubmit the job to
APPLY with a REDO the JES offset table. Failure to resubmit this job
may cause XOSF to abend or create unpredictable results.
When applying software maintenance to your system, refer to the
accompanying maintenance bulletin to find out whether you need to
resubmit a usermod installation job. Follow any special instructions in the
user instructions.
Checklist for installing usermods
As you complete each step, enter a check in the checklist table to track
and record your progress.
Step
Completed
1
Submit UMJOB100
2
Submit UMJOB101
3
Review and optionally install
usermods XUM0007-XUM0010
Step 1 – Submit UMJOB100
UMJOB100 uses SMP/E to RECEIVE all XPAF-required usermods.
Submit UMJOB100 as is.
Valid return code:
00
Section Two: Installing and Customizing XPAF
3-41
SMP/E installation
Step 2 – Submit UMJOB101
UMJOB101 performs an SMP/E APPLY of the JES offset table. This table
supplies XPAF with the correct JES control block offsets for processing at
your site. Do not make any changes to this table.
Submit UMJOB101 as is.
Valid return code:
00
Any time you upgrade your operating system or apply maintenance to
your system that changes this table, you must submit this job to REDO the
usermod. You must also modify your existing UMJOB101 JCL to include
the correct JES2 or JES3 dataset name. Refer to the bulletin
accompanying the maintenance file for the correct dataset names.
CAUTION: The stage 1 assembly is performed without the SMPMTS
dataset, which is used for JES maintenance, included in the SYSLIB
statement. If JES maintenance has been APPLYd but not
ACCEPTed, the JES offsets in this USERMOD module may be
incorrect. Incorrect JES offsets may cause XPAF to fail or abend
upon initialization or at document print time.
If such a failure occurs, add the SMPMTS dataset that contains the
JES maintenance to the SYSLIB concatenation for the system on
which XPAF is running. Then resubmit UMJOB101.
Changing the default USERMOD name
You can change the default USERMOD name (XUM0001) using the
UMODJOFT parameter of the #GENPROD macro, which you completed
during base product installation. If you change the name of the default
usermod after it has been installed, you must perform these steps:
1.
2.
3.
Regenerate the stage 1 output.
RESTORE and REJECT the default usermod using SMP/E.
Resubmit UMJOB100 and UMJOB101.
Section Two: Installing and Customizing XPAF
3-42
SMP/E installation
Step 3 – Review and optionally install XUM007-XUM0010
Additional usermods are provided to allow customers to disable the IBM
DUPLEX extended JCL keyword and rename the Xerox XDUPLEX
extended JCL keyword to DUPLEX. This is primarily for existing
customers that were using the original Xerox DUPLEX extended JCL
keyword, prior to IBM releasing their DUPLEX extended JCL keyword
(which prompted the rename of the Xerox keyword to XDUPLEX).
Use the following zaps, supplied as usermods, to disable the DUPLEX
IBM JCL keyword and rename the Xerox XDUPLEX keyword to DUPLEX
extended JCL keyword:
XUM0007 - IBM zap
XUM0008 - Xerox zap #1
XUM0009 - Xerox zap #2
XUM0010 - Xerox zap #3
NOTE: The usermods are supplied in the XPFSAMP library and must
be edited to change all occurrences of ‘%%’ to ‘++’.
The installation STAGE2 library contains jobs UMJOB108 to UMJOB110
to receive and apply XPAF usermods XUM0008 to XUM0010.
You must manually modify and apply the IBM zap, XUM0007, before
installing the modified XPAF extended JCL.
Section Two: Installing and Customizing XPAF
3-43
SMP/E installation
Installing user exits
This section lists the available XOAF and XOSF optional user exits and
describes the procedure used for installing them.
•
For XOAF, XPAF uses an administrative security exit.
•
For XOSF, XPAF uses 10 different FSA exits, a message exit, a
command exit, and a refresh security exit.
The procedure for coding these exits is described in chapter 7, “Coding
the XPAF user exits.”
Available user exits
Table 3-1 identifies the available sample user exits and exit installation
jobs. Enter a check in the Installed column for each user exit that you
install successfully.
NOTE: There are multiple versions of the source code for user exits
02, 03, and 05. However, you can only install one version of each exit
on your system.
Table 3-1.
Exit point
Available user exits
Source member
name
Function
Stage 2
member name
01
XUXIT01
FSA initialization
UXJOB01
02
XUXIT02
Dataset begin
UXJOB02
02
XUXIT02A
Dataset begin
UXJOB02
02
XUXIT02C
Dataset begin
UXJOB02
03
XUXIT03
JES record read
UXJOB03
03
XUXIT03A
JES record read
UXJOB03
03
XUXIT03C
JES record read
UXJOB03
03
XUXIT03D
JES record read
UXJOB03
04
XUXIT04
XOSF dataset open
UXJOB04
05
XUXIT05
Separator page
UXJOB05
05
XUXIT05A
Separator page
UXJOB05
05
XUXIT05B
Separator page
UXJOB05
06
XUXIT06
Resource access
UXJOB06
Section Two: Installing and Customizing XPAF
Installed
3-44
SMP/E installation
Table 3-1.
Exit point
Available user exits (Continued)
Source member
name
Function
Stage 2
member name
07
XUXIT07
Resource download begin
UXJOB07
08
XUXIT08
Resource download end
UXJOB08
09
XUXIT09
SMF record
UXJOB09
10
XUXIT10
FSA termination
UXJOB10
11
XUXIT11
XOSF dataset close
UXJOB11
12
XUXIT12
Writer data option
UXJOB12
30
XUXIT30
Message suppression
UXJOB30
31
XUXIT31
Operator command suppression
UXJOB31
32
XUXIT32
Refresh security
UXJOB32
—
XOAFUSEC
XOAF security exit
UXJOBSEC
Installed
User exits for XDS
There are no user exits specific to XDS. All valid XOSF user exits in the
XDS data stream are honored as the data stream passes through XOSF.
Section Two: Installing and Customizing XPAF
3-45
SMP/E installation
Checklist for installing user exits
After you have coded your user exits, you are ready to install them by
following the procedures in this chapter. As you complete each step, enter
the completion date in the checklist table to track and record your
progress.
Step
1
Action
Date
completed
Set up stage 1 job
A Edit $GENUXIT in INSTLIB
B Edit the UEXIT parameters in GENUXIT
2
Generate stage 2 jobs
A Edit ASMUPD
B Submit ASMUPD
3
Execute stage 2 jobs
A Submit UXJOB00
B Submit the user exit APPLY jobs
Step 1 – Set up stage 1 job
Use the #GENUXIT macro parameters in the $GENUXIT member of
INSTLIB to generate stage 2 jobs that use SMP/E to assemble and link
your user exit source code into a load library you specify. This load library
must be accessible to XPAF.
The stage 2 member names are generated with UXJOB as the prefix and
the exit number as the suffix. For example, the name of the stage 2
member that contains the JCL to install user exit 05 is UXJOB05.
Complete the steps in this section to set up and execute stage 1 jobs for
user exits.
Section Two: Installing and Customizing XPAF
3-46
SMP/E installation
Step 1A – Edit $GENUXIT in INSTLIB
Edit the $GENUXIT member in INSTLIB and complete the parameters
used in calling the #GENUXIT macro. Enter the parameter values you
predefined in your pre-installation worksheets.
If you need to access a private macro library that was not defined to
SMP/E during XPAF installation, you must specify the UXMAC parameter
in the #GENUXIT section. This causes a SYSLIB DD statement to be
generated in each stage 2 user exit SMP/E job that contains all the
required macro libraries. It also overrides the standard SYSLIB defined by
the DDDEF statement when you installed XPAF.
Example:
#GENUXIT
UMPFX=,
USEC=,
USECLNKLB=,
USECSMID=,
UXLNKLB=,
UXMAC=,
UXPFX=,
UXSRCLB=
X
X
X
X
X
X
X
X
#GENUXIT parameter definitions
This table provides a description for each parameter in the #GENUXIT
macro.
Parameter
UMPFX
(optional)
Description
Specifies a 5-character name that is used as the default SYSMOD-ID prefix
generated to install user exits. The number of the exit you request is appended
to this character string to create a unique SYSMOD ID for each user exit you
request. The character string XUX00 is generated as a default if you do not
assign a value to this parameter.
Default: XUX00
USEC
(optional)
Specifies whether the XOAF TSO user security exit will be installed. The name
of this exit must be XOAFUSEC. XPFSAMP contains a sample of this exit. You
should copy the sample to the library specified in the UXSRCLB parameter
before you make any changes to it.
Valid values:
YES
The stage 2 JCL is generated to install this user exit. Member
name is UXJOBSEC.
NO
Stage 2 JCL is not generated to install this user exit.
Default: NO
Section Two: Installing and Customizing XPAF
3-47
SMP/E installation
Parameter
USECLNKLB
(optional)
Description
Specifies a fully qualified load library name into which SMP/E links the user
security module after assembly. You may specify any load library, LLA or LPA,
that TSO accesses.
NOTE: For security, Xerox strongly recommends that you use a secured
LNKLST library for this module.
Default: XPAFLIB
USECSMID
(optional)
Specifies the SYSMOD ID to SMP/E for processing. The XOAFUSEC exit will
be RECEIVEd and APPLYd under this SYSMOD ID. If you omit this parameter,
the SYSMOD ID defaults to XUX0100.
Default: XUX0100
UXLNKLB
(optional)
Specifies the load library to which SMP/E links your exit modules after
assembly. You may specify any load library, LLA or LPA, that XPAF is able to
access.
NOTE: If this library is not in the LLA or LPA, it must be authorized and
added to the XPAF start-up proc STEPLIB.
Default: XPFLOAD
UXMAC
(optional)
Defines a user macro library that is required for assembling the user exits. Each
stage 2 job generates a SYSLIB DD statement that contains all macro libraries,
and overrides the DDDEF SYSLIB statement defined to SMP/E during
installation. If you do not specify this parameter, no overriding SYSLIB DD
statement is generated.
Default: None
UXPFX
(optional)
Specifies a 1- to 6-character name that is used as the default source member
and load module name prefix generated to install user exits. The number of the
exit you request is appended to the end of this character string to create a
unique source and load module name for each exit you request.
This parameter is overridden for any user exit generated that has a value
specified for the source name in the #UEXIT macro. The character string XUXIT
is generated as the default if you do not assign a value to this parameter.
Default: XUXIT
UXSRCLB
Specifies a PDS library that contains your exit source code. Source member
names in this library must match source module names as defined by the
UXPFX parameter or the #UEXIT macro. This library is not distributed with
XPAF.
Default: None
Section Two: Installing and Customizing XPAF
3-48
SMP/E installation
Step 1B – Edit the UEXIT parameters in $GENUXIT
Edit the $GENUXIT member in the installation library dataset to complete
the parameters used in calling the #UEXIT macros. This sample member
contains one default #UEXIT entry for every XPAF user exit.
You must code a separate #UEXIT macro within $GENUXIT for each user
exit you install. To install one or more user exits, remove the asterisk ( *
) from the beginning of the line defining the user exit you will install. If
necessary, add any additional #UEXIT statements needed for your site.
#UEXIT parameter definitions
This table provides a description for each parameter in the #UEXIT
macro.
Macro
#UEXIT
Description
Defines the user exit to be generated.
Valid values:
nn
The 2-digit number of the exit for which you want to
generate a stage 2 SMP/E installation job.
mmmmmmm
The 7-character name you want to call the
SMP/E-installed SYSMOD. This value is optional.
ssssssss
The 1- to 8-character name of the source module used to
generate the user exit. This is the name of the member
that SMP/E will assemble and link into a load library. This
value is optional.
When using a source library other than the XPFSAMP
library, the user exit name specified cannot be the same
as any of the sample source members in XPFSAMP.
Default: The numbers for the XOAF user exits.
Examples:
This example generates user exit #01 with default SYSMOD and source names.
#UEXIT 01
This example generates user exit #01 with a SYSMOD ID of UXMOD01 and the
default source name.
#UEXIT (01,UXMOD01)
This example generates user exit #01 with a SYSMOD ID name and a
source/load module name of UXSRCE01.
#UEXIT (01,,UXSRCE01)
This example generates user exit #01 with a SYSMOD ID of UXMOD01 and a
source/load module name of UXSRCE01.
#UEXIT (01,UXMOD01,UXSRCE01)
Section Two: Installing and Customizing XPAF
3-49
SMP/E installation
Step 2 – Generate stage 2 jobs
To generate the stage 2 jobs used for installing user exits, perform these
steps.
Step 2A – Edit $ASMUPD
Edit the $ASMUPD member in INSTLIB. Specify GENUXIT for the
INSTYPE parameter.
Step 2B – Submit $ASMUPD
Submit the $ASMUPD job to generate stage 2 jobs for installing user
exits.
Step 3 – Execute stage 2 jobs
You can find the JCL for each job listed below in the stage 2 library after
stage 1 is complete. Submit the jobs in the specified order to ensure the
user exits are installed properly.
Within each stage 2 member, the job name is generated by the
#GENJBCD macro that you completed during the installation of XPAF.
For instructions on completing the #GENJBCD macro, refer to “Installing
the base product” earlier in this chapter.
Step 3A – Submit UXJOB00
This job RECEIVEs the XPAF user exits generated in stage 1.
Valid return code:
00
Step 3B – Submit the user exit APPLY jobs
An SMP/E APPLY job is generated for each user exit you requested in the
#UEXIT macros. Submit all APPLY jobs and make sure you receive a
condition code of 00 for all jobs. If an assembly error occurs for a
particular exit, correct the code and resubmit the appropriate APPLY job.
Section Two: Installing and Customizing XPAF
3-50
SMP/E installation
User exit installation examples
This section contains examples of completed user exit macros to illustrate
the effects of definitions you apply during exit installation. This section
does not contain any procedures you need to perform; it is for reference
only.
Example 1 of #GENUXIT
This example macro generates stage 2 JCL to install user exits 01, 05,
and 30:
#GENUXIT
UMPFX=USM00,
USEC=YES,
USECLNKLB=,
USECSMID=,
UXLNKLB=,
UXMAC=,
UXPFX=USRMOD,
UXSRCLB=SYS4.USEREXIT.SOURCE
#UEXIT 01
#UEXIT (05,USXIT05,UEXIT5)
#UEXIT (30,UXT0030)
X
X
X
X
X
X
X
X
These are the specifications that will result for each user exit generated
by the above example:
•
Stage 2 JCL is generated to install user exits 01, 05, and 30
(member names UXJOB00, UXJOB01, UXJOB05, and UXJOB30).
•
Source for all exits is contained in SYS4.USEREXIT.SOURCE.
•
Load modules are link-edited into user.XPFLOAD.
•
No user-specific macro library is used.
•
SYSMOD ID for exit 01 is USM0001.
•
SYSMOD ID for exit 05 is USXIT05.
•
SYSMOD ID for exit 30 is UXT0030.
•
Source and load module name for exit 01 is USRMOD01.
•
Source and load module name for exit 05 is UEXIT5.
•
Source and load module name for exit 30 is USRMOD30.
Section Two: Installing and Customizing XPAF
3-51
SMP/E installation
Example 2 of #GENUXIT
This example macro will generate stage 2 JCL to install user exits 03, 09,
10, and 31:
#GENUXIT
UMPFX=USM00,
USEC=,
USECLNKLB=,
USECSMID=,
UXLNKLB=SYS3.USER.LINKLIB,
UXMAC=SYS4.USER.MACLIB,
UXPFX=USRMOD,
UXSRCLB=SYS4.USEREXIT.SOURCE
#UEXIT 03
#UEXIT 09
#UEXIT 10
#UEXIT 31
X
X
X
X
X
X
X
X
These are the specifications that will result for each user exit generated
by the above example:
•
Stage 2 JCL is generated to install user exits 03, 09, 10, and 31
(member names UXJOB00, UXJOB03, UXJOB09, UXJOB10, and
UXJOB31).
•
Source for all exits is contained in SYS4.USEREXIT.SOURCE.
•
Load modules are link-edited into SYS3.USER.LINKLIB.
•
All stage 2 APPLY jobs have a SYSLIB DD statement containing all
macro libraries used for user exit assembly with
SYS4.USER.MACLIB being first in the concatenation.
•
SYSMOD ID for exit 03 is USM000003.
•
SYSMOD ID for exit 09 is USM000009.
•
SYSMOD ID for exit 10 is USM000010..
•
SYSMOD ID for exit 31 is USM000031.
•
Source and load module name for exit 03 is USRMOD03.
•
Source and load module name for exit 09 is USRMOD09.
•
Source and load module name for exit 12 is USRMOD12.
•
Source and load module name for exit 31 is USRMOD31.
Section Two: Installing and Customizing XPAF
3-52
Installing resources
4.
4
Installing resources
XPAF uses a variety of resources for printing depending upon the types
of jobs you print. Resources include fonts, forms, images, and logos.
This chapter provides instructions for installing the XPAF resources. For
instructions on loading or converting resources, refer to Section Three:
Managing Resources with XPAF.
Section Two: Installing and Customizing XPAF
4-1
Installing resources
Checklist for installing resources
Follow the procedures shown in this checklist to install the resources
distributed with XPAF. As you complete each step, enter the completion
date in the checklist table to track and record your progress. The steps for
each procedure are explained later in this chapter.
NOTE: Review the maintenance bulletin accompanying the most
current maintenance file to determine if you need to run any special
procedures before installing the resource file.
Step
1
Action
Date
completed
Set up stage 1 job
A Calculate the size of your resource libraries
B Edit $GENRSC in INSTLIB
2
Generate stage 2 jobs
A Edit $ASMUPD
B Submit $ASMUPD
3
Submit resource installation jobs
A Submit RJOB101
B Submit RJOB102
C Submit RJOB103
D Submit RJOB104
E Edit and submit RJOB105 (optional)
Section Two: Installing and Customizing XPAF
4-2
Installing resources
Step 1 – Set up stage 1 job
Stage 1 consists of setting up the resource installation macro to reflect
your site’s resource library requirements. Before completing the macro
parameters, calculate the size of your resource libraries using the
formulas provided in this section.
Step 1A – Calculate the size of your resource libraries
When setting up your stage 1 job, you must define specific block sizes for
your resource libraries in the #GENRSC macro. Follow these steps to
calculate the size of your form, image, and PDL libraries:
1.
Determine the number of resources you will be storing in each native
resource library.
2.
Multiply the number of resources by the average number of records
required for each resource type:
Resource type
#GENRSC
parameter
Average # of
records
Centralized forms
SIZCFORM
2
Centralized images
SIZCIMG
4
Decentralized forms
SIZDFORM
2
Decentralized images
SIZDIMG
6
PCL fonts
SIZPFONT
6
PCL forms
SIZPFORM
3
PCL images
SIZPIMG
8
PDLLIB
SIZPLIB
2 1/10 2
PDF fonts
SIZFFONT
6
PDF images
SIZFIMG
8
1
2
This value is difficult to calculate since one PDL file will contain many
members. For example, one JSL file may contain several PDEs, and
each PDE will result in a PDLLIB member using an average of 2
records. For a rough calculation, assume that three lines of PDL will
create one member.
Include an additional 10 records for each 3 lines of PDL if you will be
using PDL object management.
NOTE: These averages may vary from site to site.
3.
Add an additional amount for future expansion. For example, you
may add an additional 20%.
Section Two: Installing and Customizing XPAF
4-3
Installing resources
4.
Enter the values into the appropriate #GENRSC parameters.
Example
Rainbow Office Supplies currently has 200 centralized forms and 50
centralized images and 120 lines of PDL. They will not be using the PDL
object management feature. They print their documents on decentralized
and PCL-capable printers as well as converting them to PDF. The
calculations for their native resource libraries would be:
CFORMLIB = 200 x 2 = 400 + 20% = 480
CIMGLIB = 50 x 4 = 200 + 20% = 240
DFORMLIB = 200 x 2 = 400 + 20% = 480
DIMGLIB = 50 x 6 = 300 + 20% = 360
F/PFONTLIB = 100 x 6 = 600 + 20% = 720
F/PIMGLIB = 50 x 8 = 400 + 20% = 480
PDLLIB = 120/3 x 2 = 80 + 20% = 96
PFORMLIB = 200 x 3 = 600 + 20% = 720
Section Two: Installing and Customizing XPAF
4-4
Installing resources
Step 1B – Edit the $GENRSC in INSTLIB
Edit the $GENRSC member in the INSTLIB dataset and complete the
parameters used to call the #GENRSC macro with your site-specific
values.
The parameters in this macro supply:
•
Resource dataset names required by stage 1 installation service
macros for generating XPAF execution samples.
•
Information required by the stage 2 resource download jobs to install
XPAF resources successfully. The TYPE=RSC parameter in the
#GENEND macro instructs the installation service macros to
generate stage 2 jobs that allocate and offload resources from the
installation XMTPDS. Do not change this parameter.
To print a record of the values you specified for the #GENRSC macro
parameters, follow the instructions provided in “Step 6 – Print the
installation service macros (optional)” in chapter 3, “SMP/E installation.”
Substitute $GENRSC for $GENINST.
Example:
#GENRSC
DUNIT=,
DVOLSER=volser,
HLQ=resource-prefix,
HLQfile=,
HLQVSAM=,
IVP=,
OPTIONS=,
SIZCFONT=,
SIZCFORM=,
SIZCIMG=,
SIZDFONT=,
SIZDFORM=,
SIZDIMG=,
SIZFFONT=,
SIZFIMG=,
SIZLOGO=,
SIZPDL=,
SIZPFONT=,
SIZPFORM=,
SIZPIMG=,
SMS=,
SMSVSAM=,
VSMVOL=,
VSMVOLCF=,
VSMVOLDF=
Section Two: Installing and Customizing XPAF
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
4-5
Installing resources
#GENRSC parameter definitions
This table provides a description for each parameter in the #GENRSC
macro.
Parameter
DUNIT
(optional)
Description
Specifies the UNIT value used for non-VSAM resource files during resource file
allocation. This parameter is required unless the DUNIT parameter of the
#GENDFLT macro is specified.
Default: None
DVOLSER
Specifies a specific volume serial number of the DASD device used for
allocation of the XPAF resource files. If you do not specify a value for
DVOLSER, the value specified for DUNIT is used, and no VOLSER DD card
parameter is generated.
Default: None
HLQ
(optional)
Specifies the high-level qualifier used for all XPAF resource datasets during file
allocation.
Default: The value you specified for the HLQ parameter in the #GENDFLT
macro.
HLQVSAM
(optional)
Specifies the high-level qualifier used for all VSAM resource datasets during
resource file allocation
Default: The value you specified for the HLQ parameter in this macro or its
default if you did not specify one.
Section Two: Installing and Customizing XPAF
4-6
Installing resources
Parameter
IVP
(optional)
Description
Specifies whether the IVP datasets are offloaded with the rest of the resource
datasets and IVP jobs are created as batch jobs.
Valid values:
YES
The IVP datasets are offloaded from the resource file onto a
storage unit specified by this macro. IVPJOB01 through
IVPJOB06 are created as batch jobs and placed into the stage
2 library. The IVP output print class defaults to the class
specified for the SYSOUT parameter in the #GENDFLT
macro.
(YES,class) The IVP datasets are offloaded the same as when you specify
YES only. IVPJOB01 through IVPJOB06 are created as batch
jobs and placed into the stage 2 library. The IVP output print
class is specified by class, a one-byte value.
NOTE: If you do not specify a class, the value specified for
OCLASS in the #GENDFLT macro is used.
NO
The IVP datasets are not offloaded from the resource file. No
IVP test jobs are created.
Default: YES
NOTE: To print IVPs on A4 paper, you must specify A4 for the OPTIONS
parameter in this macro, or enter Y in the ‘Using A4 paper?’ field in the
XOAF Installation Verification Procedure option.
Section Two: Installing and Customizing XPAF
4-7
Installing resources
Parameter
OPTIONS
Description
Specifies the options available when you install resources. You may specify
more than one option for this parameter.
Valid values:
A4
Use A4 as the default paper size for IVPs and paper-related tables.
B
Install base resources (forms, images).
C
Install centralized fonts (standard format).
D
Install decentralized fonts (standard format).
T
Install TABLELIB.
CI
Install core interchange fonts.
NOPCL Do not allocate PCL resource libraries (PFONTLIB, PFORMLIB,
PIMAGELIB).
NOPDF Do not allocate PDF resource libraries (FFONTLIB, FIMGLIB).
Default: (B,C,D,T) (install each option).
NOTE: If you specify B, C, D, or T individually, the other default options are
not automatically installed. For example, if you change the value from
(B,C,D,T) to C, only the centralized fonts will be installed.
Examples:
OPTIONS=C
Installs centralized fonts only.
OPTIONS=(D,CI)
Installs decentralized core interchange fonts.
OPTIONS=(B,C,D,T,NOPCL)
Installs base resources, centralized and
decentralized fonts, and TABLELIB, but does not
allocate PCL resource libraries.
OPTIONS=(B,C,T,A4)
Installs base resources, centralized fonts, and
TABLELIB, generates IVPs to print on A4 paper, and
sets the default paper name to A4 for the varying
paper size tables and cluster mapping tables.
SIZCFONT
(optional)
Specifies the size of the CFONTLIB allocated by the resource allocation job.
Use this parameter if your library needs to be a size other than the defaults
generated by this installation.
Default: 35000 records (standard font installation).
100080 records (if you specified OPTIONS=CI).
Section Two: Installing and Customizing XPAF
4-8
Installing resources
Parameter
SIZCFORM
(optional)
Description
Specifies the size of the CFORMLIB allocated by the resource allocation job.
Use this parameter if you need more space than the default size for this dataset.
These options represent minimum recommended values.
Valid values:
1
2
3
value
6000 records.
9000 records.
18000 records.
The actual number of records to allocate.
Default: 1
SIZCIMG
(optional)
Specifies the size of the CIMGLIB allocated by the resource allocation job. Use
this parameter if you need more space than the default size for this dataset.
These options represent minimum recommended values.
Valid values:
1
2
3
value
1500 records.
2000 records.
5000 records.
The actual number of records to allocate.
Default: 1
SIZDFONT
(optional)
Specifies the size of the DFONTLIB allocated by the resource allocation job.
Use this parameter if your library needs to be a size other than the defaults
generated by this installation.
Default: 35000 records (standard font installation).
100160 records (if you specified OPTIONS=CI).
SIZDFORM
(optional)
Specifies the size of the DFORMLIB allocated by the resource allocation job.
Use this parameter if you need more space than the default size for this dataset.
Valid values:
1
2
3
value
3000 records.
6000 records.
9000 records.
The actual number of records to allocate.
Default: 1
SIZDIMG
(optional)
Specifies the size of the DIMGLIB allocated by the resource allocation job. Use
this parameter if you need more space than the default size for this dataset.
These options represent minimum recommended values.
Valid values:
1
2
3
value
1200 records (or 120 3380 tracks).
3600 records (or 360 3380 tracks).
7500 records (or 750 3380 tracks).
The actual number of records to allocate.
Default: 1
Section Two: Installing and Customizing XPAF
4-9
Installing resources
Parameter
SIZLOGO
(optional)
Description
Specifies the size of the CLOGOLIB allocated by the resource allocation job.
Use this parameter if you need more space than the default size for this dataset.
These options represent minimum recommended values.
Valid values:
1
2
3
value
1000 records.
2000 records.
3000 records.
The actual number of records to allocate.
Default: 1
SIZPDL
(optional)
Specifies the size of the PDLLIB allocated by the resource allocation job. Use
this parameter if you need more space than the default size for this dataset.
These options represent minimum recommended values.
Valid values:
1
2
3
value
1000 records.
2000 records.
3000 records.
The actual number of records to allocate.
Default: 1
SIZPFONT
(optional)
Specifies the size of the PFONTLIB allocated by the resource allocation job.
Use this parameter if you need more space than the default size for this dataset.
These options represent minimum recommended values.
Valid values:
1
2
3
value
8000 records.
16000 records.
32000 records.
The actual number of records to allocate.
Default: 1
SIZPFORM
(optional)
Specifies the size of the PFORMLIB allocated by the resource allocation job.
Use this parameter if you need more space than the default size for this dataset.
These options represent minimum recommended values.
Valid values:
1
2
3
value
500 records.
1000 records.
2000 records.
The actual number of records to allocate.
Default: 1
Section Two: Installing and Customizing XPAF
4-10
Installing resources
Parameter
SIZPIMG
(optional)
Description
Specifies the size of the PIMGLIB allocated by the resource allocation job. Use
this parameter if you need more space than the default size for this dataset.
These options represent minimum recommended values.
Valid values:
1
2
3
value
1000 records.
2000 records.
3000 records.
The actual number of records to allocate.
Default: 1
SIZFIMG (optional)
Specifies the size of the FIMGLIB allocated by the resource allocation job. Use
this parameter if you need more space than the default size for this dataset.
These options represent minimum recommended values.
Valid values:
1
2
3
value
1000 records.
2000 records.
3000 records.
The actual number of records to allocate.
Default: 1
SIZFFONT (optional)
Specifies the size of the FFONTLIB allocated by the resource allocation job.
Use this parameter if you need more space than the default size for this dataset.
These options represent minimum recommended values.
Valid values:
1
2
3
value
8000 records (or 667 3380 tracks).
16000 records (or 1334 3380 tracks).
32000 records (or 2667 3380 tracks).
The actual number of records to allocate.
Default: 1
Section Two: Installing and Customizing XPAF
4-11
Installing resources
Parameter
SMS
(optional)
Description
Specifies the default SMS Storage and/or Management Class used for all
non-VSAM allocated datasets generated by the resource installation process.
Using this parameter signals the generation of SMS keywords in the DD
statements. This allows your system to place the datasets in user-defined
storage areas controlled by the operating system.
This parameter overrides any default class assignment specified in the
#GENDFLT macro.
Valid values:
YES
SMS uses the system ACS routines for allocation of datasets.
storclass
SMS uses the user-defined storage class for allocation of
datasets.
mgmtclass SMS uses the user-defined management class for allocation
of datasets.
Default: None
Examples:
SMS=storclass
SMS=(storclass,mgmtclass)
SMS=(,mgmtclass)
SMSVSAM
(optional)
Specifies the SMS Storage and/or Management Class used for all SMP VSAM
cluster definitions generated by the resource installation process. Using this
parameter signals the generation of SMS keywords in the DEFINE statements.
This allows your system to place the datasets in user-defined storage areas
controlled by the operating system.
This parameter overrides any default class assignment specified in the
#GENDFLT macro.
Valid values:
YES
SMS uses the system ACS routines for allocation of datasets.
storclass
SMS uses the user-defined storage class for allocation of
datasets.
mgmtclass SMS uses the user-defined management class for allocation
of datasets.
Default: None
Examples:
SMS=storclass
SMS=(storclass,mgmtclass)
SMS=(,mgmtclass)
VSMVOL
Specifies the volume serial number to use for VSAM resource files. This
parameter is required unless you specify the DVOLSER or SMSVSAM
parameters.
Default: None
Section Two: Installing and Customizing XPAF
4-12
Installing resources
Parameter
VSMVOLCF
(optional)
Description
Specifies the volume serial number of the DASD volume used for allocating the
native centralized font library during resource installation. This parameter is
optional if you have specified a value for SMSVSAM or DVOLSER.
Default: The same value used for VSMVOL.
VSMVOLDF
(optional)
Specifies the volume serial name of the DASD volume used for allocating the
native decentralized font library during resource installation. This parameter is
optional if you have specified a value for SMSVSAM or DVOLSER.
Default: The same value used for VSMVOL.
Step 2 – Generate stage 2 jobs
To generate the stage 2 resource installation jobs, perform these steps.
Step 2A – Edit $ASMUPD
Edit the $ASMUPD member in INSTLIB. Specify $GENRSC for the
INSTYPE parameter.
Step 2B – Submit $ASMUPD
Submit the $ASMUPD job to generate stage 2 jobs.
When stage 1 has completed successfully, all stage 2 installation jobs and
sample parameters have been placed in the stage 2 library. If a separate
library was used for stage 2, edit that library to display the member list. If
INSTLIB was used for stage 2, reedit the library to refresh the directory
and display the new members.
Section Two: Installing and Customizing XPAF
4-13
Installing resources
Step 3 – Submit resource installation jobs
Submit the resource installation jobs for execution as is.
Step 3A – Submit RJOB101
RJOB101 deletes any existing product resource datasets, and on the first
execution results in an internal condition code of 08, reset to 0. The job
then defines and allocates all required resource datasets.
Valid return code:
00
Step 3B – Submit RJOB102
RJOB102 initializes native datasets defined by RJOB101.
Valid return code:
00
Step 3C – Submit RJOB103
RJOB103 loads the XPAF resource libraries with the default set of
resources.
Valid return code:
00
Section Two: Installing and Customizing XPAF
4-14
Installing resources
Step 3D – Submit RJOB104
RJOB104 copies the skeleton XINSXOAF and XINSXOSF members from
the stage 2 library to the XINPARM dataset and initializes the XOAF and
XOSF logging datasets. After this job is complete, you can edit the
members from XINPARM to tailor the parameters to meet your site’s
needs.
Valid return code:
00
Step 3E – Edit and submit RJOB105 (optional)
RJOB105 creates or modifies the XPAF font tables to correspond to AFP
fonts. Edit and submit RJOB105 if you plan on running AFP data streams
through XPAF. You will need to rerun RJOB105 any time changes are
made to the AFP or PSF font libraries.
Edit RJOB105
Edit RJOB105:
•
Change the user ID in the statement PARM=(userid) to your TSO
user ID or a single qualifier prefix for which your ID is authorized to
access a dataset.
•
Using the CONVERT statements under SYSIN as an example, place
a CONVERT statement for each dataset that was defined in the
IBMFONT DD statement found in the XOSF start-up proc. You must
place the CONVERT statements in the reverse order that they
appear in the DD specification of the XOSF start-up proc.
Because this job issues many informational messages, you may want to
set SLOG=N in the XINSXOAF member of XINPARM before submitting
this job. To check for errors during conversion, view the messages in the
XOAFLOG or the SYSLOG, whichever is applicable.
Submit RJOB105
RJOB105 creates or updates the CPGID, FGID, XPAFCFN, XPAFIFW,
XPAFIFW3 tables and updates the XPAFE2A and XPAFEFW tables.
Valid return code:
00 or 04
Section Two: Installing and Customizing XPAF
4-15
Installing resources
Section Two: Installing and Customizing XPAF
4-16
Customizing your system
5.
5
Customizing your system
This chapter describes the steps required for customizing your XPAF
system. The procedure for each step is discussed within a separate
section of this chapter.
Overview
This section provides three diagrams which relate to the various steps
required for customizing your system. Each diagram includes samples of
the members which you must modify to customize XPAF for your site.
Customizing XPAF for use with Xerox printers
The figures shown on the following pages show sample JCL and datasets
used when you customize XPAF for use with your Xerox printers:
•
Figure 5-1 shows how the various JES and z/OS procedures and
definitions relate to XPAF procedures and definitions for centralized
printers. The example shown is based on a JES2 installation.
•
Figure 5-2 shows many of the same elements as the previous figure,
but is tailored for setting up decentralized printers. The elements key
to setting up decentralized printers are highlighted with a bold
border. You must also configure a communications interface/protocol
converter for the specified printer (not shown in this figure).
•
While figure 5-2 looks like figure 5-1, it shows the mapping for PCL
resource libraries instead of decentralized libraries. You also must
configure a communications interface/protocol converter for the
specified printer (not shown in this figure).
NOTE: The letters shown on the figures do not imply processing
order, but provide a reference between the various text boxes and the
item descriptions.
For all figures, the JES and z/OS procedures are shown in white, while
the XPAF procedures and definitions are shaded. For instructions on
setting up your Xerox printers, refer to the relevant printer chapter later in
Section Two.
Section Two: Installing and Customizing XPAF
5-1
Customizing your system
Figure 5-1. XPAF customization for centralized printers
Section Two: Installing and Customizing XPAF
5-2
Customizing your system
Figure 5-2. XPAF customization for PCL-capable printers
Section Two: Installing and Customizing XPAF
5-3
Customizing your system
Procedures
After you have completed all previous installation steps, you must
customize your system to run with XPAF. Before you begin to print
documents, perform the steps shown for the standard customization
procedure. If you are running other software packages with XPAF, you
also may need to perform the optional customization procedures.
Standard customization procedure
To customize your system for use with XPAF, complete these tasks in the
order listed:
1.
Prepare the operating system.
a.
b.
c.
d.
e.
f.
2.
Define local printers to z/OS.
Modify SYS1.PARMLIB members.
Update system procedure library.
Update TSO logon procedure.
Perform an IPL.
Set VTAM definitions.
Perform system tuning.
a.
Define z/OS performance groups and dispatching priorities.
b.
Move module(s) to the LPA.
3.
Install XPAF extended JCL.
4.
Define XPAF to JES as an FSS and associate it with Xerox printers.
5.
Edit initialization parameters (optional).
6.
Code the XPAF user exits (optional, described in chapter 7, “Coding
the XPAF user exits”).
7.
Edit distributed PDL files (optional).
8.
Create/Modify paper-related tables.
9.
Set up printers.
10. Create printer profiles.
11. Install multiple copies of XOSF (optional).
12. Verify the installation (described in Chapter 17, “Performing an
installation verification procedure”).
Section Two: Installing and Customizing XPAF
5-4
Customizing your system
Optional customization procedures
In addition to the standard customization options, you also may perform
these options:
•
Enable TCP batch printing. To support the various third-party TCP
stacks, XPAF uses a batch implementation that allows you to
customize TCP support for your site.
•
Enable Xerox Job Control Facility (XJCF) simulation processing.
This facility uses your XPAF system to simulate XJCF processing.
•
Set up the Xerox Direct Print Services (XDS) subsystem. XDS allows
you to invoke XOSF directly without accessing the JES spool or any
other spooling subsystem.
Instructions for setting up TCP batch printing, XJCF, and XDS are
described in chapter 38, “Using XPAF extended features.”
Section Two: Installing and Customizing XPAF
5-5
Customizing your system
Preparing the operating system
This section addresses the operating system setup of PARMLIB
members, procedures, JES parameters, security, and VTAM.
Checklist for preparing the operating system
When preparing your operating system, perform these steps in the order
that they are listed. As you complete each step, enter the completion date
in the checklist table to track and record your progress. The steps for each
procedure are explained later in this chapter.
Step
Action
1
Define local printers to z/OS (optional)
2
Modify SYS1.PARMLIB members
Date
completed
A Update SCHEDxx in SYS1.PARMLIB
B Update IEFSSNxx in SYS1.PARMLIB
C Authorize the XPFLOAD library
D Update IEASYS in SYS1.PARMLIB
3
Update the system procedure library
4
Update the TSO logon procedure
5
Perform an IPL (optional)
6
Set VTAM definitions (optional)
A Define XPAF as a VTAM application
B Define the VTAM LU definition for
remotely-attached printers
Section Two: Installing and Customizing XPAF
5-6
Customizing your system
Step 1 – Define local printers to z/OS
Use the z/OS I/O configuration program to define each local Xerox printer
to z/OS as a 3211-type device. The 3211 device emulates a connection
protocol used to connect to printers.
Step 2 – Modify SYS1.PARMLIB members
The following sections provide instructions for updating various members
of the SYS1.PARMLIB library. Perform each step in the order listed.
Step 2A – Update SCHEDxx in SYS1.PARMLIB
Copy this XPAF FSS PPT entry from the SCHEDxx member in stage 2 to
the end of your existing SCHEDxx member in SYS1.PARMLIB:
/*********************************/
/*
XPAF SUBSYSTEM (LOCAL)
*/
/*********************************/
PPT
PGMNAME(XINMAIN)
KEY(1)
NOSWAP
SYST
NODSI
/* OPTIONAL */
NOPREF
AFF(NONE)
NOTE: NODSI is an optional parameter that provides the maximum
amount of flexibility for updating resources of active FSSs from a
batch environment. If you experience problems with DFHSM and
NODSI specified, then change NODSI to DSI (which is the z/OS
system default).
When you add this entry to the SCHEDxx, the z/OS PPT is updated with
an entry for the program XINMAIN so that the XPAF FSS can
communicate properly with JES.
Also, you must specify the SCHEDxx member in your start-up IEASYSnn
member. Check for the SCH=xx parameter in IEASYSnn. Ensure the
SCH=xx value matches the suffix for the SCHEDxx member you plan to
use. If the SCH=xx parameter is not listed, add it to IEASYSnn.
To dynamically add the new entry use the SET SCH z/OS command:
SET SCH=nn
For more information about the z/OS PPT, refer to IBM’s System
Programming Library: Initialization and Tuning Reference.
Section Two: Installing and Customizing XPAF
5-7
Customizing your system
Step 2B – Update IEFSSNxx in SYS1.PARMLIB
Update the IEFSSNxx member in SYS1.PARMLIB to define the
subsystem name of the XOSF FSS.
To dynamically add the subsystem name use the SETSSI z/OS command:
SETSSI ADD,S=XOSF
The SUBSYS initialization parameter, found in the XINSXOSF member of
XINPARM, names the FSS. The default value for the parameter is XOSF.
If you want to change this parameter’s value, refer to the SUBSYS
parameter in Section Five: XPAF Parameter and Keyword Reference for
more information. Make sure the SUBSYS value matches the FSS name
in IEFSSNxx.
In a JES3 environment, the XPAF subsystem name you specify in
SYS1.PARMLIB(IEFSSNxx) must not be the same as the procedure name
on the JES FSSDEF parameter. If those names match, the started task is
initialized with the master scheduler subsystem rather than the JES3
subsystem, as it should be. As a result, XPAF will issue a message
indicating that the named subsystem is not supported.
Step 2C – Authorize the XPFLOAD library
Authorize the XPFLOAD library for execution.
NOTE: To authorize other libraries at this time, such as the LPALIB,
you may add the library name(s) to the IEAAPFxx or PROGxx
member while performing any of these options.
SETPROG
APF, ADD, DSNAME=hlq.XPFLOAD,SMS
If you specified the HLQMST parameter in the #GENPROD macro, first
verify that the XPFLOAD library is cataloged in the Master Catalog. Next,
set up your system to run XOSF from a STEPLIB, a LNKLST library, or an
LPALST library. Each of these options is described here.
Option 1: Running XOSF from a STEPLIB
You can use the installation-generated XPFLOAD as a STEPLIB, or you
can create your own STEPLIB:
•
If you use the installation-generated XPFLOAD as a STEPLIB, add
the XPFLOAD library name and VOLSER to the IEAAPFxx member
in SYS1.PARMLIB. If you are running z/OS/ESA version 4.3.0 or
higher or any version of OS/390, you optionally may be using the
PROGxx member.
•
If you create your own STEPLIB:
1.
Allocate a dataset large enough to contain all the modules in
XPFLOAD.
2.
Copy all the modules from XPFLOAD to the new dataset.
3.
Add the new dataset name to the IEAAPFxx or PROGxx
member in SYS1.PARMLIB to authorize the library.
Section Two: Installing and Customizing XPAF
5-8
Customizing your system
4.
Change the dataset name in the STEPLIB statement in the
XOSF00, XOAFBAT, and XJCLPROC sample procedures in the
stage 2 library to the new dataset name.
Option 2: Running XOSF from a LNKLST library
You can use a new LNKLST library or an existing LNKLST library.
•
If you use a new LNKLST library:
1.
Allocate a dataset large enough to contain all the modules in
XPFLOAD. Make sure the dataset has a high-level qualifier that
is cataloged in the Master Catalog.
2.
Copy all modules from XPFLOAD to the new dataset.
3.
Add the new dataset name to the LNKLSTxx member in
SYS1.PARMLIB.
4.
Perform either of these options:
5.
•
•
Set the APF, LNK, and LNKAUTH=LNKLST parameters of
IEASYSxx in SYS1.PARMLIB.
•
Add the new dataset name to the IEAAPFxx member in
SYS1.PARMLIB to authorize the library. If you are at
z/OS/ESA version 4.3.0 or higher or any version of OS/390,
you optionally may be using the PROGxx member.
Remove the STEPLIB from the XOSF00, XOAFBAT, and
XJCLPROC sample procedures in the stage 2 JCL library.
If you use an existing LNKLST library:
1.
Copy all modules from XPFLOAD to an existing LNKLST library.
2.
Verify that the dataset name is in the IEAAPFxx member or that
you have specified LNKAUTH=LNKLIST in IEASYSxx.
3.
Remove the STEPLIB from the XOSF00, XOAFBAT, and
XJCLPROC sample procedures in the stage 2 library.
Section Two: Installing and Customizing XPAF
5-9
Customizing your system
Option 3: Running XOSF from an LPALST library
You can use a new LPALST library or an existing LPALST library.
•
•
If you use a new LPALST library:
1.
Allocate a dataset large enough to contain all the modules in
XPFLOAD. Make sure the dataset has a high-level qualifier that
is cataloged in the Master Catalog.
2.
Add the new dataset name to the LPALSTxx member in
SYS1.PARMLIB.
3.
Add the new dataset name to the IEAAPFxx or PROGxx
member in SYS1.PARMLIB to authorize the library.
If you use an existing LPALST library:
1.
Move all LPA-eligible modules from XPFLOAD to the new
dataset. For a list of the LPA-eligible modules, refer to “Moving
modules to the LPA” later in this chapter.
2.
Verify that the dataset name is in the IEAAPFxx member or that
you have specified LNKAUTH=LNKLIST in IEASYSxx.
Section Two: Installing and Customizing XPAF
5-10
Customizing your system
Step 2D – Update IEASYSxx in SYS1.PARMLIB
Review the parameters MAXUSER, RSVSTRT, and RSVNONR in
SYS1.PARMLIB member IEASYSxx. Then perform these functions:
•
Make sure RSVSTRT is set at a level sufficient to support your site’s
required number of XOSF started tasks to be run concurrently with
all other started tasks.
•
Make sure RSVNONR is set at a level sufficient to support your
site’s required number of XOSF started tasks to be run concurrently
with all running address spaces that use z/OS cross-memory
services.
•
If you are running z/OS versions 1.10 or higher, the IEF352I Address
Space Unavailable message is issued for informational purposes
every time XPAF is terminated. This message indicates normal
operation.
If one or more of the following situations occurs:
—
—
—
No new started tasks can be started
No new batch initiators can be started
No additional users can use their TSO logons
you must IPL the system to clear the unavailable address space
vector table. To circumvent this problem, determine the maximum
number of XPAF starts and stops between IPLs and define at least
twice that number of address spaces in the RSVNONR parameter.
For example, if you start and stop XPAF a maximum of 40 times
between IPLs, you should define at least 40 additional address
spaces, for a total of 80.
For complete information about setting appropriate levels for these
parameters, refer to the applicable IBM publication:
•
z/OS System Programming Library: Initialization and Tuning
Reference
•
z/OS Conversion Notebook
Section Two: Installing and Customizing XPAF
5-11
Customizing your system
Step 3 – Update the system procedure library
Copy the XOSF00 and XOAFBAT procedures from the stage 2 library into
a system procedure library accessible by JES at start-up. The XOSF00
procedure is known as the XOSF start-up proc. Review these actions and
perform any that are necessary for your site:
•
If you are not converting IBM AFP documents, remove the DD
statements that reference PSF dataset names from the XOSF00
procedure. These dataset names are identified in the sample
XOSF00 member in stage 2.
•
If you are converting IBM AFP documents, edit XOSF00 in the
PROCLIB, and make sure that all the IBM resources (FONTLIB,
PSEGLIB, FDEFLIB, and so on) used in your AFP jobs are in the
resource DD name concatenation.
•
If a system security package such as RACF is installed, it may be
necessary to contact your security administrator to authorize the
procedure name for execution.
NOTE: Depending on how your security system handles VSAM
control interval processing, the XOSF started task may require
control access to LDM files.
•
ACF authorizes the XOSF started task for TCP/IP. The XOSF started
task needs ACF authority to use the OMVS segment as well as the
relevant authority to read the resource datasets. Ensure that the
USERID associated with the XOAF Started Task has an OMVS
segment defined to it. You must also be sure that this Started Task is
in the STARTED Class or in ICHRIN03. If you intend to use the
TCP/IP LPR protocol or BATCH facility, XOSF will also need
authority to create datasets using the high level qualifier defined in
the OPHLQ XINSXOSF Initialization parameter.
•
In a JES3 environment, the XPAF subsystem name you specify in
SYS1.PARMLIB(IEFSSNxx) must not be the same as the procedure
name on the JES FSSDEF parameter. If those names match, the
started task is initialized with the master scheduler subsystem rather
than the JES3 subsystem, as it should be. As a result, XPAF will
issue a message indicating that the named subsystem is not
supported.
•
Specify 0M for the region size of your procedure library to maximize
the virtual storage available, especially when running more than one
printer per XOSF task.
Section Two: Installing and Customizing XPAF
5-12
Customizing your system
Step 4 – Update the TSO logon procedure
In the SAMPTSO stage 2 library member, update the TSO logon
procedure with the DD statements. These DD statements instruct the
system to set up the XOAF environment, which includes providing access
to the initialization parameters and TABLELIB.
Update your ISPF primary panel with an option to invoke XOAF:
•
By PGM(XOASPF00) NEWPOOL. Use the XRX@PRIM member in
XPFSAMP as a sample. You may need to increase the size of the
DYNAMNBR parameter of the logon procedure. It must be large
enough to accommodate the number of datasets that XOAF
allocates. The size of this parameter is site dependent.
Do not use the TSO logon procedure until after you have installed the
XPAF resources.
NOTE: When you customize your system after initially installing
XPAF or after applying a maintenance file, you may convert CLIST
files in the XPFCLIB dataset from FB to VB format. After copying any
CLIST members you must edit and remove line numbers if they are
present.
NOTE: Xerox provides CLIST files in the XPAF Custom Library, these
CLIST files can be accessed and loaded from the XOAF Systems
Services Menu. For information on using the XOAF Systems Services
Menu refer to Section Three: Managing Resources with XPAF.
Step 5 – Perform an IPL (optional)
If you have updated the system parameters dynamically, you do not need
to IPL the system. The PARMLIB changes will take effect during your next
scheduled IPL.
Perform an IPL with CLPA to complete XPAF installation. You can
perform this IPL now or at any time before you finish customizing your
system. An IPL will:
•
•
•
•
•
•
•
Add required modules to the LPA.
Authorize required libraries.
Update the PPT.
Update the Subsystem Name Table.
Define printers to z/OS.
Invoke updated JES parameters.
Make extended JCL support available, if requested.
Section Two: Installing and Customizing XPAF
5-13
Customizing your system
Step 6 – Set VTAM definitions
If you do not need to define any VTAM connected printers, you may skip
this section.
Consult with your VTAM administrator before performing these steps to
verify that the necessary VTAM definitions have been added.
Step 6A – Define XPAF as a VTAM application
XPAF uses VTAM services to communicate to remote printers. Therefore,
it must be defined as a VTAM application. Each XPAF started task
requires a separate VTAM application definition. Use this sample
application definition statement as a skeleton:
appldef APPL AUTH=(ACQ)
For more information on running multiple copies of XOSF, refer to
“Installing multiple copies of XOSF” later in this chapter.
The appldef value assigned to the name of the application definition
statement is the value you should use for the ACB initialization parameter
in XINPARM.
XPAF does not need mode tables or USS tables, so you can omit these
APPL definition parameters. Since the VTAM writer must have authority
to acquire printers, the AUTH=(ACQ) parameter is required.
Step 6B – Define the VTAM LU definition for
remotely-attached printers
Each remotely-attached printer must have a corresponding VTAM LU
definition. The definition varies according to the printer’s mode of
attachment. You must know the mode of attachment to make the correct
VTAM LU definition name.
The name specified for the VTAM LU is also specified for the SLU in the
printer profile. Refer to “Setting up printer profiles” later in this chapter for
more information about printer profile parameters.
Section Two: Installing and Customizing XPAF
5-14
Customizing your system
Tuning your system
This section provides suggestions for tuning the performance of your
XPAF system.
Defining z/OS performance groups and dispatching
priorities
For more efficient XPAF performance, you may want to define one or
more separate z/OS performance groups for XOSF. XOSF should run at
a lower dispatching priority than response- intensive online systems such
as IMS, CICS, and TSO but at a higher dispatching priority than batch.
The general guidelines for setting up performance groups and dispatching
priorities are:
•
XPAF should have the same type of performance group as the
subsystem with which it communicates.
•
XPAF should have a dispatching priority that is equal to or slightly
lower than the subsystem with which it communicates.
If you run multiple FSSs on the same system, mean-time-to-wait
dispatching may yield better overall performance than fixed dispatching.
For more information about defining z/OS performance groups, refer to
the IBM publication z/OS System Programming Library: Initialization and
Tuning Reference.
Moving modules to the LPA
As a performance enhancement, if you run multiple FSSs, use a single
copy of XOSF in the LPA. This will reduce the working set size of each
XOSF.
NOTE: You cannot run different versions of XOSF from the LPA. To
override the LPA concatenation, you must use a STEPLIB statement
in the XOSF start-up proc to point to a different version of XOSF.
Section Two: Installing and Customizing XPAF
5-15
Customizing your system
Eligible modules
You may move any or all of the following modules to the LPA to improve
the performance of your system:
LDMDIRBL
XDIOPER
XEIINPUT
XRDIMG
LDMMAIN
XDIPARSE
XEILOAD
XRDOVLAY
MSFDAIR
XDIPINIT
XEIMAIN
XRDPSEG
MSFMAIN
XDIPRINT
XEIOPEN
XRFAEG
MSFPRNT
XDIPTERM
XEIOPER
XRFBUFMG
MSFTBLD
XDIPUTRQ
XEIOTPUT
XRFFDEF
PAL#XPAF
XDIRDATA
XEIPFIX
XRFFREE
THMEXEC
XDIRELRQ
XEIPFREE
XRFIMGDC
UFTIFLEW
XDIRFTSK
XEIPUTMN
XRFPDEF
UFTIFLIW
XDIRSTAT
XEIRSV
XSLBLOCK
XAMFRM
XDIRTIAS
XEIRTM
XSLEXCP
XAMMAIN
XDISBTSK
XEISLOG
XSLMAIN
XAUMAIN
XDISDATA
XEISMFLG
XSLNERT
XBPAM
XDISJF
XEISNAP
XSLSEPR
XCCMAIN
XDISMS
XEITIME
XTBINIT
XCDMAIN
XDISSI
XEITRACE
XTF$HOOK
XCNMAIN
XDITIMER
XEIXLOG
XTFCMDP
XDIAUTO
XDITRMTK
XINKEYS
XTFEVENT
XDICKPNT
XDIVALN
XJCMAIN
XTWMAIN
XDICMPC1
XDIWAKE
XJSLPARS
XUCMAIN
XDICMPC2
XEIALLOC
XJSLPROC
XVWEXITS
XDIESTAE
XEIATCH
XLWTMAIN
XVWMAIN
XDIFSACK
XEICLOSE
XOSFXPAF
XVWRMT
XDIFSAOR
XEIDALLC
XPCLMAIN
XWRMAIN
XDIFSICD
XEIDEQ
XPCLRESC
XWRMAINX
XDIFSIRQ
XEIDIR
XPLMAIN
XXQMAIN
XDIFSS
XEIDTCH
XPSCMAIN
XDIFSSOR
XEIEEXIT
XPSCMSGP
XDIFSTAE
XEIENQ
XRCIMAGE
XDIGETRQ
XEIESTAE
XRCIRAW
XDIHASP
XEIFSNAP
XRCOVLAY
XDINOTE
XEIGETMN
XRCPSEG
Section Two: Installing and Customizing XPAF
5-16
Customizing your system
Procedure
For an explanation of how to run XOSF from an LPALST library, refer to
“Preparing the operating system” earlier in this chapter.
Performance considerations for XDS
The XOSF FSS that will be used by an XDS subsystem must be defined
in the performance group used for batch processing.
Performance optimization
XDS sends data as a block of records. Therefore, when you code the JCL
for XDS print jobs, you should specify as large a block as possible for the
input source to increase performance by XDS and XPAF.
Example:
//SYSUT1
DD DISP=SHR,DSN=input.source,
DCB=(BLKSIZE=32760,LRECL=84,RECFM=FBM)
This example allows 390 records of 84 bytes to be transferred to XOSF in
one I/O session. This method provides optimum performance.
Section Two: Installing and Customizing XPAF
5-17
Customizing your system
Installing XPAF extended JCL
XPAF extended JCL does not modify z/OS or JES and does not affect any
IBM modules or JCL. However, after you install XPAF, the Xerox JDT will
reside in the LPA. If you have an LPA size constraint, you may not want
to use XPAF extended JCL.
CAUTION: Any products that use their own JCL extensions and do
not require extended JCL functions, such as output distribution
packages, may not recognize XPAF extended JCL commands
(Xerox-specific JDTs). Using XPAF on the same system as these
products may cause unexpected print results.
NOTE: Review and set the NOXJCLMSG initialization parameter to
match your usage of XPAF extended JCL.
If you want to install XPAF extended JCL keywords or apply maintenance
to them without performing an IPL, refer to “Using XPAF extended JCL
installation options” later in this chapter.
For information about using a particular XPAF extended JCL keyword,
refer to Section Five: XPAF Parameter and Keyword Reference.
Using XPAF extended JCL installation options
You can install XPAF extended JCL keywords and apply maintenance to
them without performing an IPL. To do so, use these options, which are
specified on the PARM parameter of the EXEC statement in the extended
JCL proc:
•
•
•
•
•
INSTALL
LOAD
REDO
REMOVE
DELETE
These options are mutually exclusive. That is, you can specify only one
option at a time on the proc. Do not include these options in the
COMMNDxx member in SYS1.PARMLIB.
Sample extended JCL proc
The XJCLPROC member in the STAGE2 dataset contains sample JCL for
a procedure to activate the XPAF extended JCL.
Section Two: Installing and Customizing XPAF
5-18
Customizing your system
Figure 5-3. Sample XJCLPROC member
//XFSJCL
//XFSJCL
//STEPLIB
//XJDTLPA
//SYSPRINT
PROC
EXEC
DD
DD
DD
P=
PGM=XFSJCL,PARM=('&P')
DISP=SHR,DSN=prefix.XPFLOAD
DISP=SHR,DSN=prefix.XPFLPA
SYSOUT=*
Available options
NOTE: Ensure that all datasets specified for the XJDTLPA and
STEPLIB DD statements are APF authorized.
To perform any of the installation options, issue the z/OS start command
at the master console. If you renamed the extended JCL proc in your
PROCLIB, substitute that name in place of XJCLPROC when you issue
the command.
INSTALL
Use this option to install XPAF extended JCL for the first time. If no option
is specified on the proc, this option is the default.
At the master console, enter:
S XJCLPROC,P=INSTALL
LOAD
Use this option to load the JDT module into the MLPA from the dataset
specified in the XJDTLPA DD statement in the extended JCL proc.
ALL loads all of the JDT modules that are associated with XPAF. The
XPAF extended JCL keywords are included in the XESJDT00 module.
At the master console, enter:
S XJCLPROC,P='LOAD=ALL'
Enclose the parameter value in single quotes.
REDO
If you have applied maintenance to XESJDT00, use this option to reinstall
the XPAF extended JCL keywords and make new or revised keywords
available for use.
Before you use this option, you must load the updated JDT module into
the LPA or MLPA by performing an IPL or using the LOAD option.
Otherwise, the original JDT module will remain in effect.
Each time you use this option between IPLs, the extended CSA is
enlarged by approximately 20K.
At the master console, enter:
S XJCLPROC,P=REDO
Section Two: Installing and Customizing XPAF
5-19
Customizing your system
REMOVE
This option removes the XPAF extended JCL keywords from your system.
Once the XPAF extended JCL keywords have been removed, they can be
installed again using the INSTALL option.
CAUTION: If users submit jobs using the XPAF extended JCL
keywords at the time you perform a REMOVE, they will receive JCL
errors. Therefore, you should schedule this activity for a time when
jobs using XPAF extended JCL are not run.
Each time you use this option between IPLs, the extended CSA is
enlarged by approximately 20K.
At the master console, enter:
S XJCLPROC,P=REMOVE
DELETE
Use this option to delete XESJDT00 from the MLPA. The JDT module
must have been loaded previously using the LOAD option. This option
does not physically delete a module from the disk load library.
CAUTION: Do not use this option to delete XESJDT00 from the MLPA
if you previously specified the INSTALL or REDO option to activate
the XPAF extended JCL. If you do, jobs will fail with a JCL error, and
you must IPL your system or specify the REMOVE option to remove
the XPAF extended JCL without an IPL.
ALL deletes all of the JDT modules that are associated with XPAF. The
XPAF extended JCL keywords are included in the XESJDT00 module.
At the master console, enter:
S XJCLPROC,P='DELETE=ALL'
Enclose the parameter value in single quotes.
Section Two: Installing and Customizing XPAF
5-20
Customizing your system
Installing XPAF extended JCL for the first time
To install XPAF extended JCL, follow these steps:
Step 1.
Copy the sample procedure XJCLPROC from the stage 2 library to a
system PROCLIB. You can use either the name XJCLPROC or your own
procedure name.
If a security package is installed, contact the security administrator to
authorize the procedure name for execution if necessary.
Step 2.
At the master console, enter S XJCLPROC,P='LOAD=ALL' to load the
XPAF JDT module, XESJDT00, into the MLPA.
Step 3.
At the master console, enter S XJCLPROC,P=INSTALL to install all of the
extended JCL keywords.
To install the extended JCL keywords permanently, you must also
complete steps 4 and 5. Otherwise, you will have to perform steps 2 and
3 each time an IPL is performed.
Step 4.
Add the command COM='S XJCLPROC' to the COMMNDxx member in
SYS1.PARMLIB to ensure the procedure is executed each time an IPL is
performed.
Step 5.
Load the XESJDT00 module from XPFLPA to the system LPA using one
of these procedures:
•
•
•
If you specified the HLQLPA or HLQMST parameter in the
#GENPROD macro:
—
Verify that the XPFLPA library is cataloged in the Master
Catalog.
—
Authorize the XPFLPA library by adding the XPFLPA library
name and VOLSER to IEAAPFxx in SYS1.PARMLIB or
PROG00.
—
Add the XPFLPA library name to the LPALSTxx member in
SYS1.PARMLIB.
If you did not specify the HLQLPA or HLQMST parameters in the
#GENPROD macro and you need to create a new library:
—
Create a new library large enough to hold the module in XPFLPA.
Make sure the library is cataloged in the Master Catalog.
—
Copy the module from the XPFLPA library into the new library.
—
Authorize the library by adding the new library name to
IEAAPFxx in SYS1.PARMLIB.
—
Add the new library name to the LPALSTxx member in
SYS1.PARMLIB.
Load the module dynamically into the LPA using either the S
XJCLPROC,P='LOAD=ALL' command or a software product such as
Resolve or Omegamon.
NOTE: If you chose this option and want the changes to remain
permanent, you must still perform either of the first two options.
Otherwise, when you IPL your system, the changes you made
will be lost.
Section Two: Installing and Customizing XPAF
5-21
Customizing your system
Applying maintenance to the XPAF extended JCL
After you apply maintenance that affects XESJDT00, follow these steps
to make the new or revised XPAF extended JCL keywords available:
Step 1.
At the master console, enter S XJCLPROC,P='LOAD=ALL' to load the
revised XESJDT00 module into the MLPA.
Step 2.
At the master console, enter S XJCLPROC,P=REDO to reinstall all of the
XPAF extended JCL keywords.
Removing XPAF extended JCL
If, after installing the XPAF extended JCL or applying maintenance to it,
you decide that you want to remove it, follow these steps:
Step 1.
At the master console, enter S XJCLPROC,P=REMOVE to remove all of
the XPAF extended JCL keywords from your system.
Step 2.
At the master console, enter S XJCLPROC, P='DELETE=ALL' to delete
XESJDT00 from the MLPA.
If you applied maintenance and want to return to your previous
maintenance level, perform this additional step:
Step 3.
At the master console, enter S XJCLPROC,P=REDO to reinstall all of the
original XPAF extended JCL keywords.
Section Two: Installing and Customizing XPAF
5-22
Customizing your system
Defining XPAF to JES
To enable XPAF to send documents to the printer, it must be defined to
JES as a functional subsystem (FSS) and associated with Xerox printers.
This section introduces you to the JES2 and JES3 initialization
statements for the functional subsystem and printer. For a complete
description of the statements, including default values, refer to the
appropriate z/OS JES2 or JES3 initialization and tuning manual.
The dataset referenced by the //HASPPARM DD in the JES2 start-up proc
or //JES3IN DD in the JES3 start-up proc contains the necessary
statements for defining XPAF to JES. For a detailed description of the
parameters, refer to the SAMPJES member in the STAGE2 library for a
sample of the FSS and PRT definition to JES.
Setting up definitions for non-JES subsystems
You must define XOSF to the spooling subsystem as a functional
subsystem and associate it with Xerox printers.
If you are a CMA-SPOOL or CA-SPOOL user, use the dataset referenced
by the ESFPARM DD statement in the CMA-SPOOL or CA-SPOOL
startup proc. For a description of the non-JES initialization statements for
the FSS and printer, refer to the corresponding documentation for
CMA-SPOOL or CA-SPOOL.
If you are an XDS user, the printer to be used for an XDS batch print job
is specified in the JCL for the job. Refer to chapter 38, “Using XPAF
extended features” for a description of the JCL requirements for XDS.
FSS definitions
This section contains sample JES2 and JES3 functional subsystem
definitions, along with a description of the parameters contained within
those definitions. Use these examples to code your own FSS definitions.
Commas, single quotes, equal signs, and parentheses are part of a
definition’s syntax. When present, you must include them exactly as
indicated.
If a security package such as RACF is installed, you must add XPAF
started task names to the started-task table (ICHRIN03).
Section Two: Installing and Customizing XPAF
5-23
Customizing your system
JES2
Y 
FSS(fss-name) PROC=proc-name,HASPFSSM=HASPFSSM ,AUTOSTOP= 

 N 
 FSSDEF 


FSS


Specifies the name of the XOSF FSS. You must refer to the same
functional subsystem name in all PRTnnnn initialization statements for the
FSS.
PROC
Specifies the name of a procedure for starting the XOSF FSS procedure.
The installation library contains a sample of this procedure named
XOSF00, which is modified during customization. You can refer to the
same start-up procedure in different FSSDEF initialization statements. If
you do not include this parameter, PROC defaults to the name specified
in the FSSNAME parameter.
HASPFSSM
Specifies the name of the load module that is loaded into the FSS address
space. You must code this parameter exactly as shown to specify the
default.
AUTOSTOP
Specifies whether or not the address space is stopped automatically when
the last active printer is drained.
To dynamically define the functional subsystem to JES, use the following
JES command:
$ADD FSS(XOSF),PROC=XOSF00,AUTOSTOP=[NO | YES ]
Section Two: Installing and Customizing XPAF
5-24
Customizing your system
JES3
For all versions:
FSSDEF,TYPE=WTR,FSSNAME=fssname,PNAME=procname
TYPE
FSSNAME
PNAME
Defines the printer to JES3 as an FSS writer. You must code this
parameter exactly as shown to define the printer as a writer.
Specifies the name of the XOSF FSS. You must refer to the same
functional subsystem name in all device initialization statement for the
FSS so it can be recognized by JES.
Specifies the name of a procedure for starting the XOSF FSS procedure.
The installation library contains a sample of this procedure named
XOSF00, which is modified during customization. You can refer to the
same start-up procedure in different FSSDEF initialization statements. If
you do not include this parameter, PNAME defaults to the name specified
in the FSSNAME parameter.
If the XPAF subsystem name specified in SYS1.PARMLIB(IEFSSNxx) is
the same as the procedure name specified on the JES3 FSSDEF
statement, the started task is initialized by the master scheduler
subsystem rather than the JES2 or JES3 subsystem. As a result, XPAF
issues a message indicating that the named subsystem is not supported.
Section Two: Installing and Customizing XPAF
5-25
Customizing your system
Printer definitions
This section contains sample JES2 and JES3 printer definitions and a
description of the parameters contained within the definitions. Use these
examples to code your own printer definitions.
JES2
PRTnnnn FSS=fss-name,MODE=FSS,NPRO=0,UCS=0[,DRAIN][,CLASS=class]
 (LINE) 


 DJDE  
,PRMODE= 
[,FLASH=forms-overlay-frame] ,SEP=  YES  ,SEPDS=  YES 

 NO 
 NO 
  PAGE  
  VIPP  


PRTnnnn
FSS
Names the printer that will operate under the control of an FSS.
Specifies the name of the functional subsystem that will manage the
printer. This name must be the same as the functional subsystem name
defined on an FSSDEF initialization statement.
MODE
Must specify that the printer is managed by a functional subsystem
(MODE=FSS).
NPRO
Specifies the length of time the printer will wait for more data before
forcing out the already-printed pages. It is specified for channel-attached
printers only.
UCS
Specifies the name of the character set mounted on printers that have no
UCS image specified. If you specify 0, JES2 bypasses the UCS loading
procedure until a job is processed that requires a specific UCS image.
DRAIN
Specifies that the printer will be started by operator command. You can
use the START parameter instead of the DRAIN parameter if you want to
bypass the operator and use JES to start the printer automatically.
CLASS
Specifies the assigned output class.
PRMODE
Specifies the types of input accepted by this printer.
FLASH
Specifies a forms overlay frame associated with this printer rather than
letting JES specify a default. If you use this parameter, be sure to specify
the same value in the SYSFLSH initialization parameter. We recommend
that you specify FLASH=NONE.
 SEP 


 NOSEP 
Indicates whether separator pages print between jobs. You must specify
SEP or SEP=YES when using either default or custom banner pages.
 SEPDS 


 NOSEPDS 
Indicates whether separator pages print between datasets. You must
specify SEPDS or SEPDS=YES when using either default or custom
banner pages.
Section Two: Installing and Customizing XPAF
5-26
Customizing your system
To dynamically define the printer to JES2, use the following JES
command:
$ADD
PRT123,W=writer,Q=class,FSS=XOSF,MODE=FSS,PRMODE=(LINE,
DJDE, PAGE)
JES3
For all versions:
DEVICE,DTYPE=PRT3820,JUNIT=(,SY1,UR,OFF),JNAME=device-name,FSSNAME=fss-name
 (LINE) 


 DJDE  
[, MODE=FSS][,NPRO=NO][,WS=(criteria)]
[,FLASH=forms-overlay-frame]
,PM= 


PAGE



  VIPP  


[,CARRIAGE=(forms-control-buffer)][,CHARS=(font-name)] ,HEADER=  YES  ,BURST=  YES 
 NO 
 NO 
DTYPE
Defines the printer device type. Code this parameter exactly as shown.
JUNIT
Defines printer characteristics to JES. Code this parameter exactly as
shown.
JNAME
FSSNAME
Names the printer that will operate under the control of an FSS.
Specifies the name of the functional subsystem that will manage the
printer. This name must be the same as the functional subsystem name
defined on an FSSDEF initialization statement.
MODE
Must specify that the printer is managed by a functional subsystem
(MODE=FSS).
NPRO
Specifies the length of time the printer will wait for more data before
forcing out the already-printed pages. This value is specified for
channel-attached printers only.
WS
Specifies the writer selection criteria. The value of the criteria indicates
the items JES3 output service checks, in order of importance, when
selecting a dataset for output processing on this printer.
You must include CL and U as part of your specification, where:
CL
U
SYSOUT class
Train image UCS
Additional XPAF-acceptable criteria for this printer definition parameter
are:
C
CM
D
F
FL
L
Carriage file or FCB
Copy modification
Dataset destination
Forms requested
Flash
Limit scheduling (line, page, or record)
Section Two: Installing and Customizing XPAF
5-27
Customizing your system
P
PM
SS
T
Dataset priority
Processing mode
Stacker
Specific device type requested
Note these items when using the WS parameter:
•
Do not use the parameters XUNIT or XTYPE for XPAF printers.
•
Vary the XPAF printer UCB offline to each JES3 local and global
processor:
*V,(ucb),OFFLINE,(sy1,sy2)
•
Vary the XPAF printer UCB online to the processor upon which XPAF
is executing:
*V,(ucb),ONLINE,sy1
•
Start the output writer (XPAF):
*X,WTR,OUT=device-name,NAV=R
•
Vary the XPAF printer online:
*V,device-name,ON
•
PM
FLASH
CARRIAGE
If your system’s operating environment is JES3 Version 4 or higher,
you can define a maximum of 16 device statements that reference
the same FSSNAME.
Specifies the types of input accepted by this printer.
Specifies a forms overlay frame associated with this printer rather than
letting JES specify a default. If you use this parameter, be sure to specify
the same value in the SYSFLSH initialization parameter. We recommend
that you specify FLASH=NO.
Specifies the JES default page definition or forms control buffer. If you
use this parameter, be sure to specify the same value in the SYSFCB
initialization parameter. Refer to the appropriate JES3 initialization and
tuning manual for more information about this subparameter.
CHARS
Specifies a default JES3 font. If you use this parameter, be sure to specify
the same value in the SYSFONT initialization parameter. Refer to the
appropriate JES3 initialization and tuning manual for more information
about this subparameter.
HEADER
Indicates that this printer will print header and dataset separator pages for
each job and dataset.
BURST
Indicates that this printer will print trailer separator pages for each job and
dataset.
Section Two: Installing and Customizing XPAF
5-28
Customizing your system
Selecting initialization parameters
XPAF is supplied with initialization parameters in the XINSXOAF and
XINSXOSF members of XINPARM. These parameters:
•
Provide z/OS and JES information to XPAF
•
Name DD statements in the XOSF start-up and the XOAF logon
procedures
•
Describe DJDE formats and defaults
To prepare your system for printing with XPAF, review the default
initialization parameters distributed in the XINSXOAF and XINSXOSF
members of XINPARM. Add or modify any necessary parameters for your
site’s specifications.
Refer to Section Five: XPAF Parameter and Keyword Reference for a
listing of parameters that apply to XOAF and to XOSF and for a
description of each initialization parameter.
Section Two: Installing and Customizing XPAF
5-29
Customizing your system
Preparing the printer PDL
PDL consists of two file types:
•
•
JSL files
Cataloged member files (CMEs and PDEs)
XPAF provides sample PDL members in XPFSAMP, as shown in table
5-1. You can copy and edit any of these members to create your own PDL.
Table 5-1.
Sample PDL members in XPFSAMP
Member name
Description
DFAULT
Contains a JSL you can use to print online jobs or output that was written to file.
GLOBJSL
Contains standard PDE members that can be referenced by multiple JSLs or DJDEs.
XPAF
This is a copy of DFAULT with the JDL name changed to XPAF. This is supplied to give
an example that will not replace a customer’s DFAULT JSL/JDL.
PDL native libraries
XPAF provides a native library for storing PDL called PDLLIB, which
contains the same JSL and cataloged members as the DFAULT, XPAF
and GLOBJSL members in XPFSAMP.
You also can use your own native library by specifying it in the XOSF
start-up proc DD statement named by the PDLLIB initialization or printer
profile parameter. Each printer can use its own PDL native library, or all
printers can share one common PDL native library.
Refer to Section Five: XPAF Parameter and Keyword Reference for more
information about these parameters. Refer to Section Three: Managing
Resources with XPAF for information on defining and initializing native
libraries.
Checklist for preparing the printer PDL
Follow these steps to prepare your printer PDL for use with XPAF. Enter
a check in the Completed column as you finish each step to track and
record your progress.
Step
Procedure
1
Update the PDL source
2
Load the PDL source
3
Update initialization parameters (optional)
4
Compile the PDL source
Section Two: Installing and Customizing XPAF
Completed
5-30
Customizing your system
Step 1 – Update the PDL source
You can update the sample PDL members to include your site-specific
values, or you can use your current printer JSL and modify it to include
XPAF parameters. If you make a change to one of the sample PDL
members, make the corresponding change to the other members.
CAUTION: After you edit any online PDL, you must use the Load PDL
option in XOAF to load the updated version to the appropriate PDL
native library, or your results will be unpredictable.
Option 1: Updating the sample JSL
If you plan to use the JSL distributed with XPAF, you should first save the
JSL currently residing on your printer. If necessary, make a backup or
rename it so that it does not get overwritten when you download the XPAF
version of the JSL. You may want to use your current printer JSL to run
applications other than XPAF or to operate the printer in different
environments.
Compare the sample JSL with the JSL you have been using on your
printer. Edit the sample JSL on the host to add any site-specific values
you require. The parameters you may want to add from your current JSL
include:
•
•
•
•
IDEN PREFIX, OFFSET, and SKIP
RSTACK and RAUX criteria
Banner page criteria
Optional JDEs
Option 2: Updating your current JSL
If you want to continue using your own JSL, refer to Section Three:
Managing Resources with XPAF for instructions on uploading your current
JSL from the printer to the host for editing.
Compare the sample JSL with the JSL you have been using on your
printer. Edit the uploaded JSL on the host to add any XPAF-specific
values you require.
If you want to use the banner page supplied with XPAF, add the test for
banner page from the DFAULT member. Be sure to include the
appropriate TABLEs and CRITERIAs.
If you print page-formatted and/or AFP documents, add the test for
RSTACK from the DFAULT member. Be sure to include the appropriate
TABLEs and CRITERIAs. You must also add the PGMODE JDE or code
your own JDE that includes a VOLUME CODE=NONE statement.
Section Two: Installing and Customizing XPAF
5-31
Customizing your system
Step 2 – Load the PDL source
For online PDL only, in XOAF use the Load PDL option on the Load
Resources menu to load the PDL into the appropriate PDL native library.
For instructions on using the Load PDL option in XOAF, refer to Section
Three: Managing Resources with XPAF.
Step 3 – Update initialization parameters (optional)
The XINSXOSF member distributed with XPAF in XINPARM contains
JSL-related initialization parameters. The default values for these
initialization parameters match the values of the equivalent parameters in
the distributed JSL:
DEFJDE=DFLT
DEFJDL=DFAULT
METAJDE=PGMODE
METAJDL=DFAULT
NOTE: The DJDE IVP uses the identifier value @@@DJDE. If your
system uses a different identifier value, specify IDENnn=@@@DJDE
in your XINSXOSF member (as well as the corresponding DJDEOFnn
and DJDESKnn initialization parameters).
For more information about these parameters, refer to Section Five: XPAF
Parameter and Keyword Reference.
Step 4 – Compile the PDL source
Step 1.
Download the source to your printer.
After you edit the JSL, download it to your printer. There are two jobs in
XPFSAMP you can use to download the JSL: $DJDECPY (refer to figure
5-4) and $HOSTCPY. To use $DJDECPY, your printer must be online and
using V2 OSS or higher. Modify the appropriate JSL download job as
required and submit it to download the JSL.
Step 2.
Compile your JSL on the printer using your printer’s PDL compiler.
CAUTION: You must ensure that the PDL members compiled on the
printer are identical to those loaded to the native PDL libraries, or
your results will be unpredictable.
Section Two: Installing and Customizing XPAF
5-32
Customizing your system
Figure 5-4. $DJDECPY JCL for downloading JSL
//job-name JOB (ACCT,ROOM),'DOWNLOAD DFAULT.JSL',CLASS=A,MSGCLASS=Y
//*
//*
DOWNLOAD DFAULT.JSL TO A CENTRALIZED PRINTER USING FILE= DJDE
//*
//OUTP
OUTPUT PRMODE=DJDE
//*
//DJDECOPY EXEC PGM=IEBGENER
===>Change following @@@DJDE to <===
//SYSIN
DD DUMMY
===>match your IDEN if it is
<===
//SYSPRINT DD SYSOUT=*
===>different (2 places).
<===
//SYSUT1
DD *
@@@DJDE FILE=(DFAULT,JSL,C,P,9999),END;
/*
//
DD DISP=SHR,DSN=prefix.XPFSAMP(DFAULT) <===Your XPFSAMP lib
//
DD *
@@@DJDE FILE=(END,,C),END;
/*
//SYSUT2
DD SYSOUT=X,OUTPUT=*.OUTP
//
Section Two: Installing and Customizing XPAF
5-33
Customizing your system
Create/Modify paper-related tables
The paper-related tables are a set of tables used by XPAF to determine
paper size, AFP bin number, and paper tray processing:
•
The paper name table is used to assign paper sizes to paper names.
XPAF uses these values to determine which paper size to use when
formatting a document.
•
The varying paper size table is used to map AFP bin numbers to
paper names. These paper names are then matched to paper sizes
in the currently active paper name table.
•
The cluster mapping table is used to map centralized paper tray
cluster names to paper trays on decentralized and PCL-capable
printers. Each paper tray is mapped to a tray select character.
Before printing the IVPs or any documents through XPAF, review the
default paper-related tables to determine if you need to create new tables
for your site. If so, use the Maintain Paper Tables option on the Manage
Tables menu in XOAF to create new tables, add entries to existing tables,
or modify entries.
For more information on paper-related tables and instructions on using
the XOAF Maintain Paper Tables option, refer to Section Three: Managing
Resources with XPAF.
Setting up your printers
You must set up your printers to enable them to print documents from
XPAF. The method for setting up printers is different depending on the
type of printer you have:
•
For decentralized and PCL-capable printers, use the printer’s setup
function to set up the printer. Each decentralized and PCL-capable
printer uses a different setup function. For complete instructions,
refer to the documentation distributed with the printer.
For additional information on setting up your printers to run with XPAF,
refer to the relevant printer chapter later in Section Two.
Section Two: Installing and Customizing XPAF
5-34
Customizing your system
Setting up printer profiles
Printer profiles are site-dependent printer definitions that must be created
before you can print documents through XOSF.
Each printer controlled by XPAF requires a printer profile. Profiles are
stored in the library referenced by the PROFDD initialization parameter.
This library is read each time an XPAF-controlled printer is started.
Creating printer profiles
Sample printer profiles for each XPAF-supported printer are provided in
the PROFILES member in XPFSAMP. The samples include prototype
statements which show the profile parameter defaults that are being used.
Follow this procedure to create a printer profile:
Step 1.
Copy the PROFILES member in XPFSAMP to the library that is
referenced by the PROFDD initialization parameter. During the copy,
rename the PROFILES member to match the JES printer name of the
printer for which you are creating a profile.
Example:
JES printer name = PRT7016
Rename PROFILES to PRT7016
NOTE: When naming your printer profiles, non-JES spooling
subsystems allow you to specify alphanumeric printer names that do
not begin with PRT.
•If you are a CMA-SPOOL or CA-SPOOL user, ensure that your
profile names correspond to the companion CMA-SPOOL or
CA-SPOOL printer definitions.
•If you are an XDS user, the printer profiles used for jobs
submitted by XDS are those defined for the XOSF which
processes the job.
Step 2.
Edit the new member. Delete the prototype statements for all printer
models except the model for which you are creating a profile.
Step 3.
Edit the prototype statement for your printer model.
Step 4.
Save the member. The next time you start the printer, XPAF reads the
library referenced by the PROFDD initialization parameter and makes this
printer profile available.
Refer to the PROFILES member in XPFSAMP for sample printer profiles
for all printers supported by XPAF.
Section Two: Installing and Customizing XPAF
5-35
Customizing your system
Sample profile
A sample printer profile is shown below:
DEVICE=DOCUSPL,
FEATURE=NODOWNLOAD, Do not download resources IPADDR=XXX.XXX.XXX.XXX,
Printer IP Address
TCPMODE=TCPLPR, Use the LPR protocol
LPRQNAME=qqqqqq, Queue name on the printer
TCPLPRDSN=DELETE, delete/keep temp dataset after LPR
XTCPJNAM=JESINFO, Display JES information on DocuSP GUI
WRITER=REMOTE
Editing printer profiles
Follow this procedure to edit a printer profile:
Step 1.
Edit the member in the library referenced by the PROFDD initialization
parameter. The member name is the same as the JES printer name. For
a description of the parameters, refer to Section Five: XPAF Parameter
and Keyword Reference.
Step 2.
Save the member.
Step 3.
Start the printer. The revised parameters are read from the library
referenced by the PROFDD initialization parameter.
If the printer that uses the edited profile is already started, you must drain
then restart it before the revised parameters become effective.
Section Two: Installing and Customizing XPAF
5-36
Customizing your system
Installing multiple copies of XOSF
You can install multiple, concurrent copies of XOSF. This may be helpful,
for example, if you want to run separate test and production systems
when you receive a new version of the software. You can then maintain
your current production schedule while you test the new version.
Using with JES
For each unique copy of XOSF, you must complete these steps:
Step 1.
Designate a unique subsystem name and define it in the z/OS subsystem
names list found in the IEFSSNnn member of SYS1.PARMLIB.
Step 2.
Define a unique FSSDEF statement to JES, specifying the newly created
start-up proc. Refer to “Defining XPAF to JES” earlier in this chapter.
Step 3.
Define the unique set of printers to be controlled by this copy of XOSF,
specifying the newly defined FSSDEF statement.
Step 4.
Create a unique procedure in SYS1.PROCLIB.
Step 5.
Create a new XINPARM dataset or share the existing dataset.
If you share the existing dataset, these parameters cannot be shared
among multiple copies of XOSF:
•
•
•
•
ACB (if you are using remotely-attached printers)
ALOGDSN
SUBSYS
XLOGDSN
To override the current XINPARM values for these or any other
initialization parameters you want to override, add the parameters to the
PARM statement in the appropriate XOSF start-up proc. Overriding
initialization parameters is explained in Section Five: XPAF Parameter
and Keyword Reference.
Step 6.
Specify a unique XLOGDSN dataset name for each XOSF session. For
more information on the XLOGDSN parameter, refer to Section Five:
XPAF Parameter and Keyword Reference.
Step 7.
Determine whether you want to share printer profiles among all copies of
XOSF or create separate printer profiles for each XOSF. This may depend
in part on whether you share the XINPARM library among all copies of
XOSF.
Option 1: Share printer profiles among all copies of XOSF
Ensure that printer profiles for all printers controlled by the multiple
copies of XOSF must reside in the dataset identified by the PROFDD
initialization parameter.
Be aware that if you are installing copies of XOSF on different z/OS
systems and want to share printer profiles, a conflict will arise if there
is a printer with the same name but different characteristics on two or
more z/OS systems. Therefore, ensure that two or more printers with
different characteristics do not share the same JES printer name.
Section Two: Installing and Customizing XPAF
5-37
Customizing your system
Option 2: Use separate printer profiles
Create a separate printer profile dataset for each copy of XOSF.
Include in each dataset only the profiles for the printers that are
controlled by the copy of XOSF with which the dataset is associated.
If you are sharing a XINPARM library among all copies of XOSF,
identify the printer profile dataset by including the PROFDD
initialization parameter on the PARM statement in the XOSF start-up
proc. If you are using a separate XINPARM dataset for each copy of
XOSF, identify the printer profile dataset by including the PROFDD
initialization parameter in the XINSXOSF member.
For instructions about setting up printer profiles, refer to “Setting up
printer profiles” earlier in this chapter.
Using multiple copies of XOSF with non-JES subsystems
You may use multiple copies of XOSF with non-JES subsystems.
However, certain restrictions or limitations may apply, as described in this
section.
CMA-SPOOL or CA-SPOOL
For each unique copy of XOSF, you must define a unique FSSDEF
statement to CMA-SPOOL or CA-SPOOL, specifying the newly created
start-up proc.
XDS
If you have multiple copies of XOSF installed and want to use XDS with
more than one copy, you must define a unique copy of XDS for each
XOSF.
To run more than one copy of XDS on one CPU, follow this procedure:
Step 1.
Create a unique XOSF start-up proc for each XDS subsystem you run.
Step 2.
Add the XOSF start-up proc name for each XDS subsystem to the
SYS1.PARMLIB(IEFSSNxx).
Step 3.
Update these members in SYS1.PARMLIB:
•
•
•
COMMNDxx
LNKLSTxx
IEAAPFxx
Step 4.
For each copy of XDS, create XDSSTART and XDSSTOP procs with
unique names.
Step 5.
Uniquely define the required initialization parameters.
Section Two: Installing and Customizing XPAF
5-38
Customizing your system
Verifying the installation
You can verify the accuracy of your software installation by running the
installation verification procedure (IVP). For more information about
performing an IVP, refer to chapter 17, “Performing an installation
verification procedure.”
NOTE: To use a DJDE IDEN that is different from the one used by
XPAF, you should run your IVPs before customizing your system.
Section Two: Installing and Customizing XPAF
5-39
Customizing your system
Section Two: Installing and Customizing XPAF
5-40
Setting up system-level features
6.
6
Setting up system-level features
XPAF provides additional customization features which are set up at the
system level. This section describes these features and provides
instructions on using them with XPAF:
•
•
•
•
Enabling banner page processing
Using SMF recording
Printing output to file and/or disk
Tailoring the DCF/SCRIPT environment
Enabling banner page processing
Banner pages, also known as separator pages, are issued with a print job
and contain certain job information, such as the user ID, job ID, and print
date. A banner page may be issued as a header page before each print
job, as a trailer page after each print job, and as a separator page
between each dataset.
Default banner pages
Unless you specify another format, XPAF uses its default format for
banner pages. The format of banner pages at your site can be changed
through parameters, keywords, or user exits. To use default or custom
banner pages at your site, you must specify the JES printer definition or
operator command to enable banner pages on your system.
The DFAULT member in XPFSAMP contains sample JSL statements for
detecting banner header and trailer pages produced by XPAF. This
member is set up for the default banner page format. If you use a banner
page format other than the default, you may have to modify a copy of
DFAULT and make the corresponding changes to the PDL on your
printers.
Samples for user exit 05, also in XPFSAMP, produce banner pages. You
can use these samples or create your own user exit 05 to customize
banner pages for your site. The following sections explain in more detail
any necessary system modifications for banner pages.
Section Two: Installing and Customizing XPAF
6-1
Setting up system-level features
JES definitions/commands that affect banner pages
When using either default or customized banner pages, you must specify
the JES printer definition or operator command to enable the type of
separator pages you want to use: header, trailer, and/or dataset.
This table lists, by JES release level, the parameters that must be
included in your JES printer definition to enable banner pages:
Product
Header separator
specification
Version
Trailer separator
specification
Dataset separator
specification
JES2
All versions
SEP=YES
SEP=YES
SEPDS=YES
JES3
All versions
HEADER=YES
BURST=YES
HEADER=YES
For example, this printer definition would enable header, trailer, and
dataset separator pages for JES2 for printer PRT1121:
PRT1121 FSS=XPAF,MODE=FSS,NPRO=0,UCS=0,
SEP=YES,SEPDS=YES
This JES2 operator command will turn on header, trailer, and dataset
separator pages:
$TPRTnnnn,S=Y,SEPDS=Y
where
nnnn
The printer ID number.
S
Specifies the header and trailer separator pages.
SEPDS
Specifies the dataset separator page.
This JES3 operator command will turn on header, trailer, and dataset
separator pages:
*R device-name,H=Y,B=Y
where
device-name
The printer name.
H
Specifies the header and dataset separator pages.
B
Specifies the trailer separator page.
Section Two: Installing and Customizing XPAF
6-2
Setting up system-level features
Parameters and keywords that affect banner pages
This selection describes the XPAF and IBM parameters and keywords
that affect banner page processing are described here. For more
information about these parameters and keywords, refer to Section Five:
XPAF Parameter and Keyword Reference.
The BANSTYLE initialization parameter, printer profile parameter, and
extended JCL keyword are used to specify one of the predefined banner
page styles supplied with XPAF or a custom style defined by you in user
exit 05. BANSTYLE=XPAF is the default setting, and BANSTYLE=JES
specifies the JES style banner pages. In addition, if BANSTYLE=NONE is
specified, no banner pages will be produced. To use a customized banner
page style, specify BANSTYLE=xxxx, where xxxx is the name of your
customized banner page style. XPAF passes this value to the XDIBBANS
field in @XDIB in user exits 02 and 05. You must code the format for the
customized banner page style in your user exit 05.
These IBM JCL keywords can be used with your banner pages:
ADDRESS, BUILDING, DEPT, NAME, ROOM, TITLE, and USERDATA.
These keywords can be overridden by fields in @XODB in user exit 02.
The BANSTYLE extended JCL keyword also can be overridden by
modifying the XDIBBANS field in @XDIB in user exit 02. The values
specified in user exit 02 will be available in user exit 05.
DJDE documents
For DJDE data streams, you can use the BANNERJDL initialization
parameter to specify the type of DJDE packet that is used with banner
pages. For DJDE and XES data streams, the BANRESET initialization
parameter is used to specify if any DJDE or XES packets will be
generated by the banner page routine.
AFP documents
For AFP data streams, you can use these initialization and printer profile
parameters to specify AFP resources with banner pages:
•
•
•
•
AFPJOBHDR is used for the job header separator page.
AFPJOBTLR is used for the job trailer separator page.
AFPDSHDR is used for the dataset separator page.
AFPMSGDS is used for the message dataset separator page.
You can specify form definitions and page definitions, as well as which
font is used, with each of these parameters. For example, to use the
AX0001 form definition, the A06460 page definition, and the GT20
character set on the header separator page, you would specify:
AFPJOBHDR=(FDEF=AX0001,PDEF=A06460,
CHARS=GT20)
If banner page detection is used on the trailer pages of AFP documents,
you must specify N, S or O in the RSTACK initialization or printer profile
parameter. Refer to Section Five: XPAF Parameter and Keyword
Reference for more information on these parameters.
Section Two: Installing and Customizing XPAF
6-3
Setting up system-level features
Page-formatted documents
If banner page detection is used on the trailer pages of page formatted
documents, you must specify N, S or O in the RSTACK initialization or
printer profile parameter. Refer to Section Five: XPAF Parameter and
Keyword Reference for more information on these parameters.
Changing the default banner page format
XPAF provides two predefined banner page formats: an XPAF style and
a JES style. The default banner page format is the XPAF style. To use the
JES style of banner page, you must specify BANSTYLE=JES in either
your initialization parameters, printer profile, or extended JCL.
Figure 6-1 shows a sample of the default (BANSTYLE=XPAF) header
banner page style for JES2 systems. Figure 6-2 shows a sample of the
default header banner page style for JES3 systems. Figure 6-3 shows a
sample of the header banner page style if you specify BANSTYLE=JES.
This JES banner page style applies to both JES2 and JES3 systems.
Section Two: Installing and Customizing XPAF
6-4
Setting up system-level features
Figure 6-1. Sample header page using the default XPAF style banner page (JES2)
Section Two: Installing and Customizing XPAF
6-5
Setting up system-level features
Figure 6-2. Sample header page using the default XPAF style banner page (JES3)
Section Two: Installing and Customizing XPAF
6-6
Setting up system-level features
Figure 6-3. Sample header page using the JES style banner page (JES2 and JES3)
Section Two: Installing and Customizing XPAF
6-7
Setting up system-level features
Using the JES style banner page
Figure 6-4 shows a partial listing of the DFAULT member as it is supplied
in XPFSAMP. The BANNER and RAUX statements are shown in the
shaded areas. This member contains two versions of these statements:
one for the XPAF style banner page and one for the JES style banner
page.
DFAULT is initially set up to use the default XPAF style, and the
statements for the JES style banner pages are commented out. If you
specify BANSTYLE=JES, you must modify the PDL. Use one of the
following options to modify the PDL and ensure that the PDL on the printer
matches the PDL on the host:
CAUTION: You must ensure that the PDL members compiled on the
printer are identical to those loaded to the PDL native libraries, or
your results will be unpredictable.
Option 1: Editing PDL on the host
Step 1.
Make a copy of the DFAULT member in XPFSAMP.
Step 2.
In the copied member, remove the existing comments on the BANNER
and RAUX statements for the JES style banner pages, and comment out
the BANNER and RAUX statements for the XPAF style banner pages.
Step 3.
Download the revised PDL member to the printer. You may use the
sample $DJDECPY member in XPFSAMP to do this.
Step 4.
On the printer, use the printer PDL command to compile the member into
object code.
Step 5.
Use one of these options to load the modified host member to the native
PDL library specified in the XOSF start-up proc DD statement named by
the PDLLIB initialization or printer profile parameter:
•
•
XOAF Load PDL option on the Load Resources menu
LOAD PDL TSO/batch command
Refer to Section Three: Managing Resources with XPAF for more
information about the XOAF Load PDL option or LOAD PDL TSO/batch
command.
Section Two: Installing and Customizing XPAF
6-8
Setting up system-level features
Option 2: Editing PDL on the printer
Step 1.
Edit the PDL source member on the printer.
Step 2.
Remove the existing comments on the BANNER and RAUX statements
for the JES style banner pages, and comment out the BANNER and RAUX
statements for the XPAF style banner pages.
Step 3.
On the printer, use the printer PDL command to compile the member into
object code.
Step 4.
Upload the PDL source member to a PDS on the host.
Step 5.
Use one of these options to load the modified host member to the native
PDL library specified in the XOSF start-up proc DD statement named by
the PDLLIB initialization or printer profile parameter:
•
•
XOAF Load PDL option on the Load Resources menu
LOAD PDL TSO/batch command
Refer to Section Three: Managing Resources with XPAF for more
information about the XOAF Load PDL option or LOAD PDL TSO/batch
command.
Section Two: Installing and Customizing XPAF
6-9
Setting up system-level features
Figure 6-4. Partial listing of DFAULT member (Example 1)
/* ****************************************************** */
/* ******** T A B L E S
&
C R I T E R I A S ******** */
/* ****************************************************** */
T1:
TABLE
MASK=('?'), CONSTANT=('*? START JOB',
'*? START STC',
'*? START TSU');
T2:
TABLE
MASK=('?'), CONSTANT=('*? END JOB',
'*? END STC',
'*? END TSU');
T3:
TABLE
CONSTANT=X'1313131313131313';
T5:
TABLE
MASK=(A'?'), CONSTANT=(A'*????START???JOB',
A'*????START???STC',
A'*????START???TSU');
T6:
TABLE
CONSTANT=(A'**START*****');
T7:
TABLE
CONSTANT=('**START*****');
T8:
TABLE
CONSTANT=('**END*******');
C1:
C2:
C3:
C4:
C5:
C6:
C7:
C8:
C1T:
C4T:
C5T:
C6T:
C7T:
C8T:
/* ****************************************************
/* * C1 IDENTIFIES A NON-METACODE JOB HEADER PAGE
*
/* *
USING THE XPAF STYLE BANNER (DEFAULT).
*
/* * C2 IDENTIFIES A NON-METACODE JOB TRAILER PAGE
*
/* *
USING THE XPAF STYLE BANNER (DEFAULT).
*
/* * C3 IDENTIFIES A NON-METACODE JOB HEADER OR
*
/* *
SEPARATOR PAGE USING THE XPAF STYLE BANNER.
*
/* * C4 IDENTIFIES AN RSTACK DELIMITER.
*
/* * C5 IDENTIFIES A METACODE JOB HEADER PAGE
*
/* *
USING THE XPAF STYLE BANNER (DEFAULT).
*
/* * C6 IDENTIFIES A METACODE JOB HEADER PAGE
*
/* *
USING THE JES STYLE BANNER.
*
/* * C7 IDENTIFIES A NON-METACODE JOB HEADER PAGE
*
/* *
USING THE JES STYLE.
*
/* * C8 IDENTIFIES A NON-METACODE JOB TRAILER PAGE
*
/* *
USING THE JES STYLE.
*
/* * C1T, C4T, C5T, C6T, C7T, C8T ARE USED IN THE
*
/* *
OFFLINE file ENVIRONMENT *
/* ****************************************************
CRITERIA CONSTANT=(0,12,EQ,T1),LINENUM=(35,1);
CRITERIA CONSTANT=(0,12,EQ,T2),LINENUM=(35,1);
CRITERIA CONSTANT=(0,12,EQ,T1),LINENUM=(50,1);
CRITERIA CONSTANT=(1,08,EQ,T3);
CRITERIA CONSTANT=(9,16,EQ,T5);
CRITERIA CONSTANT=(9,12,EQ,T6);
CRITERIA CONSTANT=(15,12,EQ,T7),LINENUM=(30,10);
CRITERIA CONSTANT=(15,12,EQ,T8),LINENUM=(30,10);
CRITERIA CONSTANT=(1,12,EQ,T1),LINENUM=(35,1);
CRITERIA CONSTANT=(2,08,EQ,T3);
CRITERIA CONSTANT=(10,16,EQ,T5);
CRITERIA CONSTANT=(10,12,EQ,T6);
CRITERIA CONSTANT=(16,12,EQ,T7),LINENUM=(30,10);
CRITERIA CONSTANT=(16,12,EQ,T8),LINENUM=(30,10);
Section Two: Installing and Customizing XPAF
*/
*/
*/
*/
*/
*/
*/
*/
*/
*/
*/
*/
*/
*/
*/
*/
*/
*/
*/
6-10
Setting up system-level features
Figure 6-5. Partial listing of DFAULT member (Example 2)
/*
/*
/*
/*
/*
*******************************************************
******* T E S T
F O R
B A N N E R
P A G E *******
*******
N O N - M E T A C O D E
*******
*******
X P A F
S T Y L E
*******
*******************************************************
BANNER
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
TEST=(C1 OR C2),
HJOBNO=(12,5),
HRPTNA=(18,8),
HCOUNT=1,
TCOUNT=1;
*******************************************************
******* T E S T
F O R
B A N N E R
P A G E *******
*******
N O N - M E T A C O D E
*******
*******
J E S
S T Y L E
*******
*******************************************************
BANNER
TEST=(C7 OR C8),
HJOBNO=(30,5),
HRPTNA=(35,8),
HCOUNT=1,
TCOUNT=1;
********************************************************
******** TEST TO FEED FROM AUX FOR A JOB HEADER ********
********************************************************
* THIS TEST IS USED TO FEED FROM THE AUX PAPER
*
*
TRAY FOR A JOB HEADER PAGE.
*
*
THIS IS INTENDED TO ALLOW COLORED PAPER TO
*
*
BE USED TO EASILY SEPARATE JOBS. IF THIS
*
*
IS USED, THE PRINTER MUST BE SET TO FEED
*
*
ONLY FROM THE MAIN CLUSTER (FEED MAIN).
*
*
*
* IF THIS IS NOT DESIRED, COMMENT THIS TEST OUT
*
*
OR REMOVE IT.
*
*********************************************************
RAUX
RAUX
*/
*/
*/
*/
*/
*/
*/
*/
*/
*/
*/
*/
*/
*/
*/
*/
*/
*/
*/
*/
*/
*/
*/
TEST=(C1 OR C5);
/*
/*
/*
/*
/*
/*
/*
/*
*/
*/
*/
*/
*/
*
*
*
*
*
* * *
*
FEED HDR FROM AUX TRAY
*
* * * * * METACODE HEADER
FOR XPAF STYLE
* * * * * NON-METACODE HEADER
FOR XPAF STYLE
*/
*/
*/
*/
*/
*/
*/
TEST=(C7 OR C6);
*/
/*
/*
/*
/*
/*
/*
/*
*/
*/
*/
*/
*/
*/
*/
*
*
*
*
*
* * *
*
FEED HDR FROM AUX TRAY
*
* * * * * METACODE HEADER
FOR JES STYLE
* * * * * NON-METACODE HEADER
FOR JES STYLE
Section Two: Installing and Customizing XPAF
6-11
Setting up system-level features
Using a custom banner page
If neither of the supplied styles fits your needs, you can create your own
user exit 05 to customize the banner pages used at your site. Review the
comments in the sample user exit members in XPFSAMP for more
information on how to create your own user exit.
If you change the banner page format so that the banner page detection
CRITERIA statements in the DFAULT member are no longer accurate,
you also must make a copy of the DFAULT member in XPFSAMP, make
the necessary modifications for the customized banner page style, and
make these corresponding changes to the PDL on your printers.
Recompile the PDL on your printers, and reload the modified host
member to your native PDL library.
Refer to your printer’s PDL/DJDE reference manual for a complete
explanation of the banner page detection CRITERIA statement. Refer to
the procedures in “Using the JES style banner page” earlier in this chapter
for a detailed explanation of how to update PDL on both your printers and
the host.
CAUTION: You must ensure that the PDL members compiled on the
printer are identical to those loaded to the native PDL libraries, or
your results will be unpredictable.
Using banner pages on decentralized and PCL-capable
printers
By default, all of the banner page formats described in this section are for
use on centralized printers. To use any of these formats on decentralized
and PCL-capable printers, you must change the SETC statement in
sample user exit XUXIT05B from ‘REMOTE’ to ‘LOCAL’. For more
information on how to modify user exits, refer to chapter 7, “Coding the
XPAF user exits.”
Section Two: Installing and Customizing XPAF
6-12
Setting up system-level features
Using SMF recording
XPAF supports IBM’s SMF recording capability. XPAF writes an
enhanced SMF type 6 PSF record when document processing is
complete. When SMF recording has been activated, these records are
stored in the system SMF dataset.
While XPAF supports SMF recording for printing via TCP or BARR
configurations and other intermediate spooling devices, note that for
these configurations your SMF records will reflect job creation information
instead of actual printing information. Therefore, you may see differences
in your SMF statistics for these types of jobs. For example, the SMF
record will be updated even if the job did not print.
On activating SMF recording, refer to the next section in this chapter.
Activating SMF recording
To generate SMF records for XPAF automatically, specify SMF=Y in
either the XINSXOAF or XINSXOSF member of XINPARM.
For more information about these initialization parameters, refer to
Section Five: XPAF Parameter and Keyword Reference.
You can also use the SET SMF RECORDING ON|OFF command to turn
SMF recording on or off. For more information about this operator
command, refer to Section Seven: XPAF Operator Guide.
Fields updated during SMF recording
Some fields in the record are updated by XPAF processing, while others
are not. Tables 6-1 through 6-3 show all SMF type 6 PSF fields for which
IBM provides documented support and identifies which of these fields are
updated by XPAF. For a thorough description of SMF, refer to the
appropriate z/OS SMF publication.
Table 6-1.
SMF record type 6 PSF fields updated by XPAF (standard data)
Standard data section
Offset
SMF field
Length
Description
Comments
5
SMF6RTY
1
Record type
X'06'
6
SMF6TME
4
Time record moved to SMF buffer
Supplied by z/OS SMF routine
10
SMF6DTE
4
Date record moved to SMF buffer
Supplied by z/OS SMF routine
14
SMF6SID
4
System identification
JES system ID from CVT
18
SMF6JBN
8
Job name
Job name from XDIBJNAM
26
SMF6RST
4
Reader start time
Reader start time from XDIBJTIM
30
SMF6RSD
4
Reader start date
Reader start date from XDIBJTIM
Section Two: Installing and Customizing XPAF
6-13
Setting up system-level features
Table 6-1.
SMF record type 6 PSF fields updated by XPAF (standard data) (Continued)
Standard data section
Offset
SMF field
Length
Description
Comments
34
SMF6UIF
8
User identification
User identification from
XDIBUSER
42
SMF6OWC
1
SYSOUT class
SYSOUT class from XDIBSOCL
43
SMF6WST
4
Writer start time
Time XOSF started printing
47
SMF6WSD
4
Writer start date
Date XOSF started printing
51
SMF6NLR
4
Number of logical records
Number of logical records
processed (including multiple
copies)
55
SMF6IOE
1
I/O status
X'00'
56
SMF6NDS
1
Number of datasets processed
X'01'
57
SMF6FMN
4
Form number
First 4 bytes of XDIBFORM
61
SMF6PAD1
1
Section indicator
X'E0'
62
SMF6SBS
2
Subsystem identification
X'0007'
64
SMF6LN1
2
Length of rest of record
X'001C'
66
SMF6DC1
1
Dataset control indicator
Restart information:
67
SMF6INDC
1
Record level indicator
X'08' X'10' X'20' -
The job was restarted.
The job was interrupted.
The job was cancelled.
X'01' X'03' -
PSF 1.1
Job number greater than
9999
Security support
PSF 2.1
X'04' X'05' 68
SMF6JNM
4
JES-assigned job number
(binary)
Job number from XDIBJNO+4
72
SMF6OUT
8
Output device name
Printer name
80
SMF6FCB
4
FCB ID
Not updated by XPAF
84
SMF6UCS
4
UCS ID
Not updated by XPAF
88
SMF6PGE
4
Approximate physical page count
Number of physical sheets printed
Section Two: Installing and Customizing XPAF
6-14
Setting up system-level features
Table 6-2.
SMF record type 6 PSF fields updated by XPAF (non-impact printing subsystem
data)
Non-impact printing subsystem section
Offset
SMF field
Length
2
SMF6CPS
8
10
SMF6CHR
26
Description
Comments
Number of copies in each copy
group
First copy group equals the
number of copies produced,
including JCL COPIES, XCOPY,
and DJDE COPIES. Copy groups
2 - 8 = 0.
16
CHARS values
Four 4-byte CHARS values, as
specified in the JCL
SMF6MID
4
Copy modification name
Not updated by XPAF
30
SMF6FLI
4
Name of forms overlay
FORM name from XDIBFORM
34
SMF6FLC
1
Number of copies on which the
form is printed
Same value as SMF6CPS
35
SMF6BID
1
Options indicator
X'40' X'20' -
Table 6-3.
OPTCD=J
Cut sheet printer
SMF record type 6 PSF fields updated by XPAF (APA printing subsystem)
All-points-addressable printing subsystem section
Offset
SMF field
Length
Description
4
SMF6FONT
4
Number of fonts used
Number of fonts used
8
SMF6LFNT
4
Number of fonts loaded
Number of fonts downloaded
12
SMF6OVLY
4
Number of overlays used
Number of forms used
16
SMF6LOLY
4
Number of overlays loaded
Number of forms downloaded
20
SMF6PGSG
4
Number of page segments used
Number of images used
24
SMF6LPSG
4
Number of page segments loaded
Number of images downloaded
28
SMF6IMPS
4
Number of sides of paper printed
Number of sides of paper printed
32
SMF6FEET
4
Number of feet of paper printed
Not updated by XPAF
36
SMF6PGDF
4
Number of PAGEDEFs used
Number of PAGEDEFs used
40
SMF6FMDF
4
Number of FORMDEFs used
Number of FORMDEFs used
44
SMF6BIN
1
Bin indicators
Not updated by XPAF
Section Two: Installing and Customizing XPAF
Comments
6-15
Setting up system-level features
Table 6-3.
SMF record type 6 PSF fields updated by XPAF (APA printing subsystem)
(Continued)
45
SMF6PGOP
1
Duplex indicators
Duplex and/or tumble duplex
indicated
46
SMF6FLG3
1
Flags
X'00'
48
SMF6NSOL
4
Number of security overlays used
Not updated by XPAF
52
SMF6NSFO
4
Number of security fonts used
Not updated by XPAF
56
SMF6NSPS
4
Number of security page
segments used
Not updated by XPAF
60
SMF6FDNM
8
FORMDEF name
FORMDEF name
68
SMF6PDNM
8
PAGEDEF name
PAGEDEF name
76
SMF6OCNM
32
Object container names
Not used by XPAF
Section Two: Installing and Customizing XPAF
6-16
Setting up system-level features
Printing to disk and/or file
In addition to printing, you can write to disk and/or file any document that
XPAF has prepared for a centralized printer. This allows you to archive
printable output for later use.
Output selection can be specified for individual documents using
extended JCL keywords or for all documents directed to a printer using
printer profile parameters.
Checklist for printing to disk and/or file
Perform these steps, in the order they appear, to print your documents to
file and/or disk. As you complete each step, enter a check in the checklist
to track and record your progress.
Step
Action
1
Add necessary initialization parameters
2
Specify WRITER printer profile
parameter
3
Specify OPWRITER extended JCL
keyword (optional)
4
Modify printer profile for resource
management
Completed
Step 1 – Add necessary initialization parameters
To support the OPWRITER extended JCL keyword and the WRITER
FILE/DISK printer profile parameter, specify these initialization
parameters in the XINSXOSF member of XINPARM:
•
•
•
•
•
•
•
•
OPDALLOC
OPDALLOS
OPDUNIT
OPHLQ
OPTEXPDT
OPTUNIT
OPTVOLCT
OPVOLSER
These parameters are required for dynamic allocation of file and/or disk
datasets. For a complete description of these parameters, refer to Section
Five: XPAF Parameter and Keyword Reference.
Section Two: Installing and Customizing XPAF
6-17
Setting up system-level features
Step 2 – Specify WRITER printer profile parameter
To direct all documents transmitted to a specific centralized printer to file
and/or disk, you must specify the WRITER parameter in the printer’s
profile. For a complete discussion of this parameter, refer to Section Five:
XPAF Parameter and Keyword Reference.
Step 3 – Specify OPWRITER extended JCL keyword
(optional)
To direct a specific document to any supported combination of printer, file,
and/or disk, you must specify the WRITER printer profile parameter or
OPWRITER extended JCL keyword. For more information about the
WRITER printer profile parameter or the OPWRITER extended JCL
keyword, refer to Section Five: XPAF Parameter and Keyword Reference.
Step 4 – Modify printer profile for resource management
When writing a print job to file only, you can control whether the resources
required to print the job are written to the file. You can use either of these
options:
•
Download all required resources to the file; all resources required to
print any job on the file are downloaded to the file. To set up this
option, you must use these printer profile parameter settings:
LIBRARY=,
XNS=NO,
WRITER=TAPE
•
Do not download any required resources to the file; no resources
referenced by any job on the file are written to the file. To set up this
option, you must use these printer profile parameter settings:
LIBRARY=,
FEATURE=NODOWNLOAD,
XNS=NO,
WRITER=TAPE
If you use this option, the required resources must be available on the
printer when you ultimately print the job. If any required resources are
missing, the job will fail at the printer.
Section Two: Installing and Customizing XPAF
6-18
Setting up system-level features
Tailoring the DCF/SCRIPT environment
If you use DCF/SCRIPT to create documents, XPAF allows you to format
your documents using Xerox fonts. Since Xerox fonts are designed to
print at 300 dpi and IBM fonts at 240 or 300 dpi, you must first update the
necessary tables and profiles, then convert the Xerox fonts. This section
provides instructions for performing these steps.
Checklist for tailoring the DCF/SCRIPT environment
As you complete each step, enter a check in the Completed column to
track and record your progress.
Step
1
Action
Completed
Update the logical device table
A Specify the logical device name (LD)
B Specify the physical device name (PD)
C Specify the default font (DF)
D Define the page formatting parameters (PL)
E Reassemble and link-edit the LDT
2
Update the physical device table
A Specify the physical device name
B Specify the output type
C Indicate the default font library
D Specify the page segment library
E Specify the baseline shift
F
Specify the rotation
G Specify the inter-character spacing
H Specify the horizontal and vertical resolution
I
Reassemble and link-edit the PDT
Section Two: Installing and Customizing XPAF
6-19
Setting up system-level features
Step
Action
3
Update the Generalized Markup Language profile
Completed
A Establish the default PI font
B Establish the 38PP printer default fonts
C Substitute the physical device name
4
Convert the Xerox fonts
NOTE: You only need to perform these steps if you plan to use Xerox
fonts with the DCF/SCRIPT environment.
For additional information about the Logical and physical device tables,
refer to IBM’s Document Composition Facility SCRIPT/VS Text
Programmer’s Guide.
Step 1 – Update the logical device table
The logical device table (LDT) allows you to access and select certain
adjustable print format settings. For example, you can use the LDT to
specify the font, page length, and page width to be used repeatedly for a
particular type of document (such as an internal memo).
Step 1A – Specify the logical device name
Specify the name to be used in the DEVICE option of SCRIPT. This name
must begin with an X and may be followed by up to seven additional
characters. The X prefix informs XPAF that native Xerox fonts are present
in the document and that font mapping and resolution conversion are not
required.
When a document is generated, DCF/SCRIPT inserts a NOP structured
field as the first record in the document. This NOP structured field
contains the specifications entered in the LDT and is examined by XPAF
to determine if Xerox fonts are present.
For example, to use the logical device name XRXSTDPG, enter
LD=XRXSTDPG.
Step 1B – Specify the physical device name
Specify the name of the printer which will be used to print the document.
This name must match the name contained in the appropriate PDT.
For example, to print documents to printer XRX9700F, enter
PD=XRX9700F.
Section Two: Installing and Customizing XPAF
6-20
Setting up system-level features
Step 1C – Specify the default font
Specify the font to be used when none is specified in the document. The
default font must specify the IBM-coded font name for a converted Xerox
font. This name must have a prefix of Xn, where n identifies the IBM
orientation.
Valid values for n are:
1
2
3
4
Portrait
Landscape
Inverse portrait
Inverse landscape
For example, to specify the font UN110E in IBM portrait orientation, enter
DF=X1UN110E.
Step 1D – Specify the page formatting parameters
Define the necessary page formatting values using these parameters:
PL
PW
LL
TM
BM
Page length
Page width
Line length
Top margin
Bottom margin
Table 6-4 shows valid page width and page length values (in dots) for
several different page sizes.
Table 6-4.
Page width and length values
Page width
(dots)
Page length
(dots)
8.5 by 11 inch page (letter)
2550
3300
8.5 by 14 inch page (legal)
2550
4200
11 by 17 inch page (long)
3300
5100
8.27 by 11.69 inch page (A4)
2481
3507
11.69 by 16.54 inch page (A3)
3507
4962
Page size
Step 1E – Reassemble and link-edit the LDT
Once modified, reassemble the LDT and link-edit the results.
Section Two: Installing and Customizing XPAF
6-21
Setting up system-level features
Sample LDT
Using the examples defined above for an 8.5 by 11 inch page with a line
length of 6 inches, a top margin of .5 inch, and a bottom margin of .5 inch,
the code for the LDT might look like this:
DSMLDTLD=XRXSTDPG,
PD=XRX9700F,
DF=X1UN110E,
PL=3300,PW=2550,LL=1800,TM=150,BM=150
Step 2 – Update the physical device table
The physical device table (PDT) allows you to specify the characteristics
of the printer to be used as the output device. For example, you can
specify the horizontal and vertical resolution for a printer. Each printer has
a physical device table entry.
Step 2A – Specify the physical device name
Specify the physical device name referenced in the logical device table.
For example, to print documents to printer XRX9700F, enter
PD=XRX9700F.
Step 2B – Specify the output type
Specify the type of data stream to be generated. Set this value to 38PP
so SCRIPT generates an output stream emulative for an IBM 3800 page
printer.
For example, to generate 38PP type documents, enter OD=38PP.
Step 2C – Specify the default font library
Specify the library where the default font specified in the LDT is stored.
You should use the distributed dataset AFPFONTS.
For example, to use the library that contains the 38PP fonts as the default
font library, enter FL=FONT38PP.
Section Two: Installing and Customizing XPAF
6-22
Setting up system-level features
Step 2D – Specify the page segment library
Specify the library where page segments are stored.
For example, to use the library that contains the 38PP page segments,
enter PSL=PSEG38PP.
Step 2E – Specify the baseline shift
Specify BSS=ALL to indicate that both positive and negative values are
supported.
Step 2F – Specify the rotation
Specify ROT=(0,90,180,270) to indicate that all four rotations are
supported.
Step 2G – Specify inter-character spacing
Specify ICS=ALL to indicate that both positive and negative values are
supported.
Step 2H – Specify the horizontal and vertical resolution
Specify HR=300 and VR=300 for Xerox printer resolution.
Step 2I – Reassemble and link-edit the PDT
Once modified, reassemble the PDT and link-edit the results.
Sample PDT
Using the examples defined above, the code for the PDT might look like
this:
DSMPDTPD=XRX9700F,
OD=38PP,
FL=FONT38PP,PSL=PSEG38PP,
BSS=ALL,ROT=(0,90,180,270),ICS=ALL,
HR=300,VR=300,FSS=512
Section Two: Installing and Customizing XPAF
6-23
Setting up system-level features
Step 3 – Update the Generalized Markup Language profile
The Generalized Markup Language (GML) profile (DSMPROF3 or
DSMPROF4) must be modified so that the execution path for the Xerox
printer is the same as the IBM 3800 page printer. Make these changes to
the GML profiles.
Step 3A – Establish the default PI font
To establish the default PI font for the Xerox printer:
after this line:
.if &$PDEV eq 38PP .df @pi@ul type ('pi sans serif' 8) codepage t1gpi363
enter this line of code:
.if &$PDEV eq XRX9700F .df @pi@ul type ('pi sans serif 8') codepage t1gpi363
Step 3B – Establish the 38PP printer default font
To establish the 38PP printer default fonts for the Xerox printer:
after this line:
.if &$PDEV eq 3800 .or &$PDEV eq 1403 .se @suprstyl = nums
enter this line of code:
.if &$PDEV eq XRX9700F .go 38PP
Step 3C – Substitute the physical device name
Substitute the correct physical device name for the specified Xerox
printer, if different than the 9700 printer.
Step 4 – Convert the Xerox fonts
You must convert the Xerox fonts so that the font’s metrics are made
available to DCF/SCRIPT. For information on converting Xerox font
attributes to IBM font attributes, refer to Section Three: Managing
Resources with XPAF.
Section Two: Installing and Customizing XPAF
6-24
Coding the XPAF user exits
7.
7
Coding the XPAF user exits
This chapter describes the procedures used for coding the XOAF and
XOSF user exits for XPAF.
Coding the XOAF user exit (XOAFUSEC)
You can include an optional user-written routine called XOAFUSEC in
XPFLOAD to provide installation security for XOAF processing.
XPFSAMP contains a sample of this routine, XOAFUSEC, which executes
under TSO. This routine logs user IDs and dataset names involved in
each XOAF request without disturbing XOAF processing.
XOAFUSEC is invoked after the dataset names to be referenced have
been determined but before processing of the XOAF request starts. The
module can communicate with XOAF by setting a return code in register
15 and by passing a message through the parameter list.
Coding requirements
Keep these considerations in mind if you code your own XOAFUSEC:
•
The name of the load module must be XOAFUSEC.
•
XOAFUSEC must be reentrant. Use standard register linkage
conventions, but remember that XPAF modules may be running in
31-bit mode.
•
If it abends, XOAFUSEC is not called again during that execution of
XOAF.
•
The XOAF default is to allow a requested XOAF function. If
XOAFUSEC is absent, abends, or sets a return code other than the
one expected, the requested function is allowed.
•
Do not open a dataset and keep it open across multiple executions
of XOAFUSEC. XOAF cannot close such a dataset, so it will still be
open if you exit and then reenter XOAF.
NOTE: User-coded exits are not serviced or supported under your
Xerox Software License Agreement or Xerox Service Contract. You
may be asked to remove a user-coded exit when requesting software
support.
Section Two: Installing and Customizing XPAF
7-1
Coding the XPAF user exits
Parameter list
On entry to XOAFUSEC, register 1 points to a parameter list containing
pointers to:
•
The working storage for XOAFUSEC. This pointer’s value is zero
unless it is updated by XOAFUSEC. XOAF saves this pointer’s value
and returns it the next time XOAFUSEC is invoked. This process
allows XOAFUSEC to allocate storage until XOAFUSEC is removed
from the system.
•
An area that XOAFUSEC can use to pass a message to XOAF. This
pointer contains the address of a halfword binary value followed by
storage for the passed message. The halfword specifies the
maximum number of bytes provided for the message (at least 200
bytes). Set the halfword to the length of the passed message before
returning.
•
The 8-character user ID of the user making the request.
•
A fullword binary value identifying the requested function in the
XOAF function table.
•
The XOAF function table.
•
The input dataset name, if provided.
•
The output dataset name, if provided.
This figure displays the parameter list passed to XOAFUSEC and the data
fields to which it points.
Figure 7-1. XOAFUSEC parameter list and its data fields
Section Two: Installing and Customizing XPAF
7-2
Coding the XPAF user exits
XOAF function table
The XOAF function table is provided to assist you in coding your own
XOAFUSEC. Before you begin coding, dump the XOAF function table
(module XOAFUNCT in the distribution load library). The table shows the
functions you can request and contains:
•
•
•
A halfword binary value identifying the function
A 20-character function name
An 80-character function description
The last entry in the table has zero in the halfword key.
Return codes in register 15
XOAFUSEC can set these return codes in register 15:
00 Allow the requested function to continue. Do not check for a message
to log.
02 Allow the requested function to continue. Log the passed message if
one is provided.
08 Do not allow the requested function to continue.
12 Invalid parameters received by XOAFUSEC. Allow the requested
function to continue.
14 Invalid parameters received by XOAFUSEC. Do not allow the
requested function to continue.
16 XOAFUSEC internal error. Allow the requested function to continue.
18 XOAFUSEC internal error. Do not allow the requested function to
continue.
All return codes greater than zero cause passed messages to be logged.
The only return codes that prevent a request from processing are 08, 14,
and 18.
Installing the user exit
After you have coded and tested your user exit, you are ready to generate
the SMP/E jobs that will install the user exit as an SMP/E usermod to your
system. Refer to “Installing user exits” in chapter 3, “SMP/E installation”
for a description of the #GENUXIT installation service macro and
instructions on installing the user exit.
Section Two: Installing and Customizing XPAF
7-3
Coding the XPAF user exits
Coding the XOSF user exits
The XOSF user exit facility provides a common interface and a common
routine for calling all XOSF user exits. It includes these features:
•
Provides you with a standard method for accessing information and
issuing instructions to XPAF
•
Uses a standard format for the input parameters to all user exits
•
Uses a standard set of values to interpret the return codes from the
user exits
•
Provides the user exits with a common work area to facilitate
communication between user exits executing in the same subtask
User exits provided
If you need to perform a function not provided by standard XPAF code,
such as customizing your banner page, you should determine if one of the
XPAF-provided user exits suits your intended purpose. Table 7-1
identifies the available XOSF user exits.
Table 7-1.
Exit
point
XOSF-defined user exits
Purpose
Sample(s) provided
Input parameters provided
—
Generic user exit
example
XUXIT00
—
01
FSA initialization
XUXIT01
XXQPPT
02
Dataset begin
XUXIT02, XUXIT02A,
XUXIT02C
IATSRL, IAZCHK, IAZJSPA, $JOE, $JCT,
XDIB, XDJD, XODB, $FQE, $PDDB
03
JES record
XUXIT03, XUXIT03A,
XUXIT03C, XUXIT03D
Logical print record, flags, XDIB
04
XOSF dataset open
XUXIT04
XXQPPT
05
Banner page
XUXIT05, XUXIT05A,
XUXIT05B, XUXIT05C
IATSRL, IAZJSPA, $JOE, $JCT, XDIB, XDJD,
XJOBPRM, XODB, XXQPPT
06
Resource access
XUXIT06
Member name, resource type, library format,
library reference method, library DD name,
library dataset name, name of load module,
access type
07
Resource download
begins
XUXIT07
Member name, resource type, library format,
library reference method, library DD name,
library dataset name, name of load module
08
Resource download
ends
XUXIT08
Member name, resource type, library format,
library reference method, library DD name,
library dataset name, name of load module,
return code from resource download
Section Two: Installing and Customizing XPAF
7-4
Coding the XPAF user exits
Table 7-1.
Exit
point
XOSF-defined user exits (Continued)
Purpose
Sample(s) provided
Input parameters provided
09
SMF record
XUXIT09
SMF type 6 record
10
FSA termination
XUXIT10
—
11
XOSF dataset close
XUXIT11
XDIB
12
Writer data option
XUXIT12
Logical print record, flags, XDIB, XXQPPT
30
Messages
XUXIT30
Message flag, message text
31
Commands
XUXIT31
Command text
32
Refresh security
XUXIT32
Address of XOSF function table, function key,
command value, XOSF function table
Order of invocation
User exits 01 through 10, the FSA exits, are called in sequence at a
predefined time between FSA start and task termination. Some user exits
may be called many times for a single JES document being printed; other
user exits may be called only once.
User exits 30 through 32 depend on the operating environment, so the
order in which they are called cannot be determined.
Figure 7-2 shows the timing of invocation for user exits 01 through 10, and
does not represent the true flow of XOSF. Refer to “User exit descriptions”
later in this chapter for details on how each user exit can affect processing
based on return codes from the user exit.
Section Two: Installing and Customizing XPAF
7-5
Coding the XPAF user exits
Figure 7-2. User exit calling order
Section Two: Installing and Customizing XPAF
7-6
Coding the XPAF user exits
Sample materials
The installation libraries contain the mapping macros, inline code macros,
testing JCL, and source code required to code an XOSF user exit. You
can view the source code online or print it. After you copy it to a library or
member you define, you can modify the source to create your own version
of any of the user exits.
Macros
XPFMAC contains the mapping macros and inline code macros for the
user exit routines. When assembling any of the XOSF user exits for
testing, ensure that XPFMAC and the appropriate z/OS and JES
MACLIBs are included in your SYSLIB concatenation.
JCL
The XUXASM member in XPFSAMP contains JCL you can use to
assemble and link-edit the XOSF user exits.
Source code
XPFSAMP contains the source code for each of the sample user exits.
These user exists are defined in “User exit descriptions” later in this
chapter.
Initialization parameter requirements
For each user exit you code, you must specify the user exit load module
name using the USRXITnn initialization parameter. You should also set
the maximum work area size required by all the user exits using the
USRXITWA initialization parameter. For more information about these
parameters, refer to Section Five: XPAF Parameter and Keyword
Reference.
Coding requirements
When planning to code an XOSF user exit, you need to consider each of
the programming issues described in this section.
NOTE: User-coded exits are not serviced or supported under your
Xerox Software License Agreement or Service Contract. You may be
asked to remove a user-coded exit when requesting software
support.
Section Two: Installing and Customizing XPAF
7-7
Coding the XPAF user exits
Linkage conventions
You must follow standard z/OS linkage conventions.
•
Upon entry, register contents are as follows:
R1
Points to a standard z/OS variable length parameter list
R13
Points to a standard 18 fullword z/OS save area
R14
Contains the XPAF return address
R15
Contains the user exit entry point address
•
All input parameters and work areas passed to the user exit are in
key 8 storage, subpool 230 above the 16M line.
•
The user exit is given control in storage protect key 8 and AMODE
31.
•
The user exit must be written to handle input parameters and a work
area residing in storage above the 16-megabyte line.
•
When returning control to XPAF, you must restore register 13 to its
original contents, set a return code in register 15, and branch to the
address originally passed in register 14.
Common parameters
Upon entry, register 1 points to the input parameter list. This input
parameter list can be mapped by the @UXPL macro included in XPFMAC.
It contains four fullwords that are pointers to other parameter areas. For
any area that does not exist for a specific user exit, the pointer is zero.
The end of the list is indicated by a 1 in the high order bit of the fullword.
The input parameter list follows this format:
DS A(@UXWA)Pointer to exit work area
DS A(@UXPA)Pointer to exit specific parameters
DS A(@UXIN)Pointer to common information area
DS A(@UXMG)Pointer to user message area
ORG*-4Pointer to last parameter in list
DS X'80' Indicates end of list
Section Two: Installing and Customizing XPAF
7-8
Coding the XPAF user exits
User exit work area
The first parameter in the input parameter list is the common work area.
This work area can be mapped by the @UXWA macro included in
XPFMAC.
The size of the work area is specified by the USRXITWA initialization
parameter, and is passed in the XPAF common information area. Check
this work area field at execution time to verify that the work area is large
enough before making any references to it. Use the first 18 fullwords as
your standard z/OS save area, and the remainder as needed by all user
exits.
The area is initialized to binary zeros the first time any user exit is called
in a subtask. Then, each subsequent user exit called in the same task is
passed the same work area.
Since it is passed unchanged between user exits within the same subtask,
the work area can be used to pass information between user exits or
subsequent calls of the same user exit. Be sure to initialize all work areas
properly, and ensure that all user exits are aware of the shared portion of
the work area.
User exit-specific parameter areas
The second parameter in the input parameter list points to an area
containing information specific to the user exit being called. The first
fullword in this area contains the length (in bytes) of the entire user
exit-specific work area, including the length word itself. If the user exit has
no unique parameters, the pointer to this field contains zeros.
The user exit-specific work areas can be mapped by the @UXPM macro
included in XPFMAC. This macro has one required parameter: EXIT=nn,
where nn is the user exit number to be mapped. For example, to map the
parameters to user exit 05, the banner page exit, specify:
@UXPM EXIT=05
The @UXPM macro invokes the XPAF, z/OS, JES, CMA-SPOOL, or
CA-SPOOL macros to map the areas required. You must include the
appropriate MACLIBs in your SYSLIB concatenation when assembling the
user exit. See your OS/390 system administrator for information on your
system and subsystem macro libraries.
@UXPM has the optional parameter SUBSYS=xxx. The valid values are
either JES or CMA. The default is JES if this parameter is not specified.
If you are using XPAF with CMA-SPOOL or CA-SPOOL, SUBSYS=CMA
is required for exits that provide CMA-SPOOL or CA-SPOOL control
blocks. Only user exit 02 uses the CMA-SPOOL and CA-SPOOL control
block $FQE. To map the parameters to user exit 02, the dataset open exit,
for CMA-SPOOL or CA-SPOOL, specify:
@UXPM EXIT=02,SUBSYS=CMA
@UXPM also invokes the @UXEQ macro to generate equates for the user
exit numbers and standard user exit return codes. The DSECT name is
either the tag name you code in the label field of the assembler statement,
or UXPnn (where nn is the 1- or 2-digit user exit number) if you do not
code a tag name.
Common information area
The third parameter in the input parameter list points to an area containing
information common to all XPAF user exits. This area can be mapped by
the @UXIN macro included in XPFMAC.
Section Two: Installing and Customizing XPAF
7-9
Coding the XPAF user exits
Message area
The fourth parameter in the input parameter list points to the XPAF user
exit message area. The message area can be mapped using the @UXMG
macro included in XPFMAC.
This area is initialized to binary zeros each time a user exit is called. If you
place a message length and text in this area, XPAF will issue the message
through the XPAF message facility when the user exit returns control to
XPAF. The return code you specify has no effect on the message facility.
The maximum length of the message is 222 bytes.
Referencing input parameters
Use the macros shown in table 7-2 to map or reference user exit input and
work areas.
NOTE: Most of the mapping macros are invoked dynamically by the
@UXPM macro for the user exit being assembled.
Table 7-2.
User exit macros
Function
Map input parameter areas
Call macros for XPAF
separator exit routines
Map XPAF parameters
Map z/OS parameters
Map JES common parameters
Macro name
Area or routine
@UXPL
Parameter list map
@UXWA
XPAF user exit work area
@UXPM
XPAF user exit-specific parameters for user exits 01–32
@UXIN
XPAF user exit common information
@UXMG
XPAF user exit message area
#UXITBLK
Calls XPAF separator exit block letter routine
#UXITPRT
Calls XPAF separator exit print routine
@XDIB
XPAF document information block
@XJOBPRM
XPAF separator exit parameters
@XOSFTAB
XPAF XOSF function table
@XXQPPT
XPAF printer profile table
IEFJMR
z/OS job management area
IFSAMFR
z/OS SMF record
IAZCHK
JES checkpoint area
IAZJSPA
JES job separator page area
IAZIDX
JES index record flag
Section Two: Installing and Customizing XPAF
7-10
Coding the XPAF user exits
Table 7-2.
User exit macros (Continued)
Function
Macro name
Map JES2 parameters
Area or routine
$JCT
JES2 job control table
$JOE
JES2 job output element
$PDDB
Peripheral data definition block
Map JES3 parameters
IATYSRL
JES3 service request list
Map CMA-SPOOL or
CA-SPOOL parameters
$FQE
File queue element
Map user-modified record
@UXUREC
For user exit 03 only, maps a user record used as an
inserted or replacement record
Equates
@UXEQ
XPAF user exit numbers and return code equates
Return codes
At return to XPAF, all user exits should set R15 to indicate the action
XPAF should take. Return code settings for each valid return code are
defined by assembler EQU statements in the @UXEQ macro included in
XPFMAC. This macro is called by the @UXPM macro, so you need not
specify it if you use the @UXPM macro to map user exit input parameters.
The general return codes are:
Value
Meaning
@UXEQ Field Name
Value
0
Continue.
#CONTINUE
0
1–4
Bypass function.
#BYPASS
4
5–8
Purge the JES dataset.
#PURGE
8
9–16
Requeue the JES dataset.
#REQUEUE
16
17–32
Requeue and hold the JES dataset.
#HOLD
32
33–4095
Terminate the printer subtask.
#ABORT
#MAXRC
4096+
The address of the user-provided data or control block
to be used in place of the one supplied by XPAF. The
next time the user exit is called, the original provided
record will be presented to the user exit.
Section Two: Installing and Customizing XPAF
64
4095
7-11
Coding the XPAF user exits
Control blocks
All control blocks passed to a user exit through the user exit-specific
parameters (mapped by @UXPM) are copies of the XPAF (or JES) control
blocks. Therefore, any modification made to these control blocks by the
user exit will be only for the benefit of that invocation of the user exit. The
control block copies are not copied back to the real control blocks when
the user exit returns to XOSF.
Some user exits allow certain control blocks to be modified. This is
accomplished by making any modifications to the supplied control block
and returning the address of that modified control block in R15. XOSF will
then modify the actual control block from that copy. For an example of this
procedure, refer to XUXIT02A in XPFSAMP.
CAUTION: When modifying the XDIB control block, failure to supply
the address of the XDIB tagname ‘XDIB’ when you update the XDIB
or its extensions will cause unpredictable results.
Assembly requirements
A user exit must be coded in Assembler H or its equivalent. It must be
reentrant and reusable, and written in AMODE 31. We recommend that
you also specify RMODE ANY.
Link-edit requirements
When you link-edit a user exit, you must specify RENT and REUS, and
AMODE 31. We recommend that you also specify RMODE ANY.
Load library
The load library containing the XPAF user exits must be specified in the
UXLNKLB parameter of the #GENUXIT macro and must be in one of these
places:
•
•
•
XPAF procedure STEPLIB
z/OS Link List Concatenation
z/OS Link Pack Area
XPAF uses the standard z/OS search order when searching for user exits
in the load library. The load module name can be any name that conforms
to z/OS naming conventions and can not already exist in XPFLOAD.
Section Two: Installing and Customizing XPAF
7-12
Coding the XPAF user exits
Controlling active user exits
You can activate and deactivate the user exits within a subtask using a
fullword bit mask in the UXITXACT field of the user exit common
information area. This bit mask controls which user exits will be active in
each subtask. There is a unique UXITXACT for each subtask operating
within XPAF. Each bit within the mask corresponds to one of the XPAF
user exits; the low order bit corresponds to user exit 01, and the high order
bit corresponds to user exit 32. A one bit indicates that the user exit is
active, and a 0 (zero) bit indicates the user exit is inactive.
The first time a user exit is called in a subtask, the UXITXACT field is
initialized; each user exit specified by the USRXITnn initialization
parameter is set to 1. At this point, you can turn the bits on or off to control
which user exits are called. If you turn on a bit for a user exit that has not
been specified in the USRXITnn initialization parameter, the user exit is
not called.
Bit map settings for each user exit are defined by assembler EQU
statements in the @UXEQ macro included in XPFMAC. This macro is
invoked by the @UXPM macro, so you need not specify it if you use
@UXPM to map user exit input parameters.
Debugging user exits
When you are debugging an XOSF user exit, perform these actions:
•
Specify ESTAE=Y in the initialization parameters.
•
Add a SYSUDUMP DD statement to the XOSF start-up proc.
•
Be careful using z/OS and JES macros. The MACLIBs used to
assemble user exits must be the same ones used for XDIOFTAB and
must be of a level supported by XPAF.
•
Specify LSQA in the z/OS dump parameters. This allows you to
access user exit parameter areas and work areas in Subpool 230 for
diagnostic purposes. All work and parameter areas are in key 8.
•
Do not exceed the 222 byte maximum when filling the XPAF
message area.
•
To obtain diagnostic information from the XOSF log, code user exit
diagnostics to use the XPAF message facility. Since the messages
also appear at the console, you should use this function sparingly.
Use XUXIT00, the generic user exit, as a prototype since it issues a
message with the user exit number, name, and return code.
•
If you are using user exit 05 for banner pages for JES2 printers,
specify SEP, SEPDS, or both in the JES printer definition.
•
Use care when planning the shared user exit work area. Since the
area is shared by all user exits running in the same subtask,
information can be passed between user exit calls. Ensure that no
intervening calls overlay data intended for a different user exit.
Create a common macro to map the common work area fields.
Remember that XPAF initializes the area to binary zeros the first
time a user exit is called in a subtask, but does not change the work
area from that point on.
Section Two: Installing and Customizing XPAF
7-13
Coding the XPAF user exits
Installing the user exits
After you have coded and tested a user exit, you are ready to generate
the SMP/E jobs that will install the user exit as an SMP/E usermod to your
system. Refer to “Installing user exits” in chapter 3, “SMP/E installation”
for instructions.
User exit descriptions
For each supported user exit, this section describes the purpose, input
parameters, return codes, and sample(s) provided. It also identifies the
point within processing when the user exit is called. For additional
information about any of the user exits, refer to the comments provided
within each sample user exit.
Generic user exit
XUXIT00 is a generic sample user exit which you can use as a model for
creating any XPAF user exit. The sample shows basic initialization,
parameter access, and return functions. It also shows a method for
passing a message back to the system for logging to the SYSLOG and
XOSF log with error message number XUX2626I.
Section Two: Installing and Customizing XPAF
7-14
Coding the XPAF user exits
User exit 01 (FSA start)
This user exit provides the earliest opportunity for initializing fields passed
between user exits. It can be used to initialize work areas, counters, and
other fields for use by subsequent user exits.
When called
This user exit is called when the FSA (printer) is started.
Input parameters
Input
Mapped by
XPAF printer profile table
(also known as XPAF point product table)
@XXQPPT
Return codes
Value
0+
Meaning
Continue.
Sample user exit
XUXIT01 is a sample user exit 01. It performs these functions:
•
•
•
•
Initializes the entire work area to binary zeros
Initializes the work area device type field with dummy data
Saves the beginning date and time
Turns on user exit 04 in the XPAF active user exit bit mask
Section Two: Installing and Customizing XPAF
7-15
Coding the XPAF user exits
User exit 02 (Dataset open)
This user exit can be used to:
•
Determine whether a job should be printed
•
Initialize counters or data fields specific to a single job for use by
later user exits
•
Increment job related counters
•
Alter document information in the XDIB or its extensions to meet
specific requirements, such as changing a form name or distribution
keyword
•
Select the processing mode for a data stream
When called
This user exit is called each time the first copy of a SPOOL dataset is
presented to XOSF by the spooling subsystem.
Input parameters
For CMA-SPOOL or CA-SPOOL:
Input
Mapped by
CMA-SPOOL or CA-SPOOL file queue element
@FQE
FSS common checkpoint area
IAZCHK
XPAF document information block area
@XDIB
XDIB DJDE extension data
@XDJD
XDIB output data block area
@XODB
FSS job separator page area
IAZJSPA
Section Two: Installing and Customizing XPAF
7-16
Coding the XPAF user exits
For JES2:
Input
Mapped by
Address of JES2 job output element
$JOE
Address of JES2 job control table
$JCT
Address of JES2 peripheral data definition block
$PDDB
FSS common checkpoint area
IAZCHK
XPAF document information block data
@XDIB
XDIB DJDE extension data
@XDJD
XDIB output data block data
@XODB
Address of FSS job separator page area
IAZJSPA
For JES3:
Input
Mapped by
Address of JES3 service request list
IATSRL
FSS common checkpoint area
IAZCHK
XPAF document information block data
@XDIB
XDIB DJDE extension data
@XDJD
XDIB output data block data
@XODB
Address of FSS job separator page area
IAZJSPA
Return codes
Value
Meaning
0
Continue.
1–8
Purge the JES dataset.
9–16
Requeue the JES dataset.
17–32
Requeue and hold the JES dataset.
33–4095
Abort the print subtask.
4096+
The address of the modified XDIB and its extensions to be
used in place of the XPAF-supplied XDIB and extensions.
Section Two: Installing and Customizing XPAF
7-17
Coding the XPAF user exits
Sample user exits
XUXIT02, XUXIT02A, and XUXIT02C are samples of user exit 02.
XUXIT02
XUXIT02A
This user exit performs these functions:
•
Initializes fields in the work area for use by subsequent user exits
•
Saves the job name, job number, and user ID of the job that created
this document
•
Initializes a line counter
This user exit contains the same code as XUXIT02, with additional code
to select the processing mode for a data stream. You can use any of the
fields available in the XDIB control block to build your test criteria and
determine the desired document type. For example, you can test the form
name, SYSOUT class, or FCB name to decide if the document should be
printed as native mode or AFP.
You must then code user exit 02 to update the XDIBDFMT field with the
desired type of data stream processing. Valid types of data stream
processing include:
XUXIT02C
blank
XPAF determines what processing mode to use based on the
extended JCL and the data stream.
NM
Forces the job through native mode processing. No extended
JCL processing is provided, and no DJDE processing is provided
for decentralized and PCL-capable printers.
DJDE
Forces the job through DJDE processing; no extended JCL
processing is provided. NM and DJDE processing are equivalent
for centralized printers.
JCL
Forces the job through extended JCL processing. For
decentralized printers, DJDE-to-XES processing also is included.
XES
Forces the job through XES processing to decentralized printers.
PCL5
Forces pass-through processing to PCL-capable printers.
AFPA
Forces AFP processing.
AFPX
Forces page-formatted processing.
This user exit contains the same code as XUXIT02. It also shows how to
access the CMA-SPOOL or CA-SPOOL $FQE data. It copies selected
$FQE fields and the programmer name from the IAZJSPA to the XPAF
XDIB control block.
Since the exit parameter list contains the variable length $FQE, the
corresponding CMA-SPOOL or CA-SPOOL sample offset table,
XUXOF02C, must also be assembled and linked into the user exit load
library.
Section Two: Installing and Customizing XPAF
7-18
Coding the XPAF user exits
User exit 03 (JES record)
This user exit can be used to:
•
Suppress unwanted records
•
Add user-generated records
•
Change the values in records
•
Dynamically limit the size of a dataset to be printed (using a unique
identifier such as a time, date, or user ID)
When called
This user exit is called each time a record from the JES dataset is read,
before XOSF processes it.
Input parameters
Input
Mapped by
XPAF Document Information Block data
@XDIB
JES index record flag from the JES index table
IAZIDX
Logical print record from JES
n/a
Return codes
Value
Meaning
0
Continue.
1–4
Bypass this record.
5–8
Purge the JES dataset.
9–16
Requeue the JES dataset.
17–32
Requeue and hold the JES dataset.
33–4095
Abort the thread.
4096+
The address of the user-provided record is used in place of
the JES-provided record. The next time the user exit is
called, the original JES-provided record will again be input
to the user exit.
Section Two: Installing and Customizing XPAF
7-19
Coding the XPAF user exits
Sample user exits
XUXIT03, XUXIT03A, XUXIT03C, and XUXIT03D are samples of user exit
03.
XUXIT03
This user exit counts spool records and stops printing on decentralized
printers after 1,000 lines. It demonstrates a method of inspecting JES
input records without changing them and terminating the processing of a
single print dataset. If it encounters a dataset with over 1,000 lines, this
user exit also issues an error message.
XUXIT03A
This user exit contains the same code as XUXIT03, with additional code
to insert a user-defined record, then print the JES record. This user exit
cannot be used with AFP data streams.
XUXIT03C
This user exit contains the same code as XUXIT03, with additional code
to replace the JES record with a user-defined record. This user exit can
be used only with datasets that include carriage control.
XUXIT03D
This user exit contains the same code as XUXIT03, with additional code
to delete the JES record before XOSF processes it. This user exit cannot
be used with AFP data streams.
Section Two: Installing and Customizing XPAF
7-20
Coding the XPAF user exits
User exit 04 (XOSF dataset open)
This user exit can be used to dynamically alter printer attributes, such as
XJCF processing mode or download options. This processing may be
based on criteria such as a time, date, or user ID.
When called
This user exit is called when a dataset is retrieved for output and the
XOSF processors are being initialized for the dataset.
Input parameters
Input
Mapped by
XPAF Printer Profile Table
(also known as XPAF point product table)
@XXQPPT
Return codes
Value
Meaning
0
Continue.
1–4095
Abort the thread.
4096+
The address of the modified printer profile table to be used
in place of the XPAF-provided printer profile table.
Sample user exit
XUXIT04 is a sample user exit 04. It saves the printer device type for use
by subsequent user exits. Since the device type will not change, the bit
corresponding to this user exit in the active user exit bit mask is turned off
to prevent subsequent calls to this user exit.
Section Two: Installing and Customizing XPAF
7-21
Coding the XPAF user exits
User exit 05 (Banner page)
This user exit can be used to:
•
•
•
•
Create custom banner pages
Dynamically suppress banner pages
Add DJDEs or XESs before a dataset
Distribute information, much like JES2 news
Standard banner pages for AFP documents use the C1D0GT15 character
set and T1D0BASE code page by default. For instructions on changing
these defaults, refer to “Specifying separator print attributes” later in this
chapter.
You cannot print banner pages in a portrait orientation in an AFP
environment.
For more information on banner page processing, refer to chapter 6,
“Setting up system-level features.”
When called
This user exit is called immediately before the first line and after the last
line of a JES dataset is processed by XOSF, before the default XOSF
banner routine is called.
The user exit is called only if a JES printer definition or operator command
has been issued to enable the type of banner pages this user exit uses:
header, trailer, and/or dataset.
For any JES2 version, you can override the job separator specification by
including SEPPAGE=NONE in the PRINTDEF statement.
For more information on banner page processing, refer to chapter 6,
“Setting up system-level features.” For other information on how JES
handles banner pages, refer to your JES initialization and tuning manuals.
Section Two: Installing and Customizing XPAF
7-22
Coding the XPAF user exits
Input parameters
For JES2:
Input
Mapped by
Address of XPAF print routine
n/a
Address of XPAF block letter routine
n/a
Address of JES Job Output Element
$JOE
Address of JES Job Control Table
$JCT
XPAF separator exit parameters
@XJOBPRM
XPAF Point Product Table data
@XXQPPT
Address of JES Job Separator Page Area
IAZJSPA
XPAF Document Information Block data
@XDIB
XDIB DJDE extension data
@XDJD
XDIB Output Data Block data
@XODB
JES News Data
@XNEWS
For JES3:
Input
Mapped by
Address of XPAF print routine
n/a
Address of XPAF block letter routine
n/a
Address of JES Service Request List
IATSRL
XPAF separator exit parameters
@XJOBPRM
XPAF Point Product Table data
@XXQPPT
Address of JES job separator page area
IAZJSPA
XPAF Document Information Block data
@XDIB
XDIB DJDE extension data
@XDJD
XDIB Output Data Block data
@XODB
JES News Data
@XNEWS
Section Two: Installing and Customizing XPAF
7-23
Coding the XPAF user exits
Return codes
Value
Meaning
0
Continue. XPAF will produce the default banner page either
in place of or in addition to any user-created banner.
1+
Bypass the XPAF default banner. The user has created a
banner or does not want a banner.
Specifying separator print attributes
This section explains how to specify separator print attributes for banner
pages.
DJDE documents
When printing DJDE documents on centralized printers, you can use
DJDEs to specify the print attributes for the banner page; however,
resource conditioning is not performed for the banner page. For example,
if you specify the DJDE FONT=RK1ABP and that font is not loaded on the
printer, XOSF will not download it for you.
When printing DJDE documents on decentralized printers, you cannot use
DJDEs to specify print attributes for a banner page. If you attempt to do
this, the DJDEs are printed as data. For more information, refer to
“Decentralized printers” later in this chapter.
AFP and page-formatted documents
You cannot use DJDEs to specify print attributes for a banner page for an
AFP or page-formatted job. If you attempt to do this, the DJDEs are
printed as data. However, you can specify these print attributes for an
AFP or page-formatted banner as shown at label ASUREC in XUXIT05B:
•
•
•
•
•
•
Use overlay for banner
Paper size (width, length)
Print orientation
Margins (left, top)
Font selection (character set, code page, or coded font)
Line spacing
Decentralized printers
All non-AFP and non-page-formatted documents printed on decentralized
printers have banner pages formatted with XES commands. You may
specify XES commands in user exit 05 to customize the format of these
decentralized banner pages.
Section Two: Installing and Customizing XPAF
7-24
Coding the XPAF user exits
Calling support routines
XPAF provides these macros to call XPAF or IBM routines within user exit
05:
•
•
•
#UXITBLK
#UXITPRT
SJFREQ
#UXITBLK
Use the #UXITBLK macro to call the XPAF block letter routine. The block
letter routine generates 12 lines, each 124 bytes in length, containing
block letters generated from an input string. The input string can be from
1 to 9 bytes long.
To reserve the parameter list and work area that XPAF needs for the block
letter routine, you must specify
#UXITBLK MF=R
in your work area. You also must specify a label on the MF=R format of
the macro.
To call the routine, specify
#UXITBLK MF=(E,label ),TEXT=x[,LENGTH=l ]
where
label
The label specified on the MF=R format.
x
The name of a 1- to 9-character field or register specification (Rn)
of the field to be converted.
l
The length of the field to be converted and can be:
•
An equated length
•
An expression
•
A decimal digit
•
A register specification (Rn), where the length value has
been previously loaded into the register specified
l is optional. If you omit it, the assembler length attribute of x is
used. If register notation is used for x, l must be specified.
The parameter list generated by the MF=R form of the #UXITBLK macro
is as follows:
#XITBLPL
#XITTAD
#XITTLN
#XITBAD
#XITBLN
#XITBNO
#XITBLK
DS OF Banner print routine parm list
DS
AAddress text to be printed
DS
FLength of text to be printed
DC
ABlock letter line address
DC
FLength block letter address area
EQU &NUMLINENumber of block lines
DS
(#XITBNO)CL124Block letter lines
XPAF places the block letter lines in the field #XITBLK when called by the
MF=E form of the #UXITBLK macro. The lines can be printed
subsequently using the #UXITPRT macro.
Section Two: Installing and Customizing XPAF
7-25
Coding the XPAF user exits
#UXITPRT
Use the #UXITPRT macro to call the XPAF print routine. Through the print
routine, the 133 bytes that you point to are written to the printer. The first
character of this print line is the machine code carriage control character.
To reserve the parameter list and work area that XPAF needs for the print
routine, you must specify
#UXITPRT MF=R
in your work area. You must also specify a label on the MF=R format of
the macro.
To call the routine, specify
#UXITPRT MF=(E,label ),LINE=xxx
where
label
The label specified on the MF=R format.
xxx
The label of the 133 byte field to be printed. The LINE value may
also be a register specification (Rn).
For this XPAF routine, the address of the XPAF subtask control block
must be passed as an input parameter. This value is passed to UXITSTCB
in the user exit common information area. To ensure that #UXITPRT has
addressability to the XPAF subtask control block, you must use the
@UXIN macro to map the XPAF common information area.
The parameter list generated by the MF=R form of the #UXITPRT macro
is as follows:
#XITPRPLDSOF
#XITSTCBDSA
#XITLADDSA
Banner print routine parm list
Address subtask control block
Address line to be printed
SJFREQ
Use the SJFREQ macro to call the IBM routine used to retrieve
information for XPAF banner pages that was originally coded on the IBM
OUTPUT JCL statement.
To call the routine, specify
SJFREQ REQUEST=RETRIEVE
The REQUEST command must reference the XDIB output token field
(XDIBOUTK) as a parameter. This parameter retrieves the keyword
values from the IBM OUTPUT JCL statements. The statements may
include the ADDRESS, BUILDING, DEPT, NAME, ROOM, and TITLE
keywords to be printed on banner pages.
For more information on the SJFREQ routine, refer to the z/OS/ESA
Application Development Reference: Services for Authorized Assembler
Language Programs.
Section Two: Installing and Customizing XPAF
7-26
Coding the XPAF user exits
Sample user exits
XUXIT05, XUXIT05A, and XUXIT05B are samples of user exit 05.
XUXIT05
This user exit generates a job header, but no trailer or dataset separator
pages. The header contains the room number and programmer’s name in
block letters. At the bottom of the page, it prints JES-specific information
from either JES2 or JES3 control blocks. This user exit provides examples
of accessing all of the input control blocks (XPAF, z/OS, JES common,
JES2, and JES3), as well as information passed from other user exits.
XUXIT05A
This user exit is an example of a banner page that uses a form and honors
DJDEs. It generates a header for copy one and a trailer after the last copy
of a dataset. It does not print dataset banners and cannot be used for AFP
documents, decentralized printers, or PCL-capable printers.
XUXIT05B
This user exit generates a banner page in the same format as the default
banner page supplied with XPAF.
NOTE: The banner pages for decentralized and centralized printers
use different formats. To print a banner page on a decentralized or
PCL-capable printer in the same format as a banner page printed on
a centralized printer, follow the instructions included at the beginning
of this sample.
XUXIT05C
This user exit generates a banner page that displays updated Job
Separator Page Area (JSPA) user data fields.
Section Two: Installing and Customizing XPAF
7-27
Coding the XPAF user exits
User exit 06 (Resource security)
This user exit can be used to:
•
Ensure that a resource being accessed is authorized for a particular
user ID
•
Restrict resource downloads to noncritical times
When called
This user exit is called when a printer or AFP resource is referenced. This
user exit also is called when a printer resource (that is, font, form, image)
is downloaded.
NOTE: For overlays and page segments that have already been
converted and stored in a native mode library, a call will be made only
for the native mode object.
Input parameters
•
•
•
•
•
•
•
•
Member name
Resource type
Library format
Library reference method
Library DD name
Library dataset name
Name of load module from which user exit is being called
Access type
Return codes
Value
Meaning
0
Continue.
1–4
Bypass the resource download.
5–4095
Fail the resource access and abort the print job.
4096+
The address of the modified resource name to be used in
place of the XPAF-provided resource name (valid for
download only).
Sample user exit
XUXIT06 is a sample user exit 06. It issues a RACF RACHECK to
determine whether the user who submitted the job is authorized to read
the resource. If the user is authorized, the resource is read. If the
RACHECK fails, printing is terminated, and an error message is issued.
Section Two: Installing and Customizing XPAF
7-28
Coding the XPAF user exits
User exit 07 (Begin resource download)
This user exit can be used to:
•
•
Issue an enqueue on a dataset name being downloaded
Issue an enqueue on a member name being downloaded
When called
This user exit is called immediately before a resource is downloaded.
Input parameters
•
•
•
•
•
•
•
Member name
Resource type
Library format
Library reference method
Library DD name
Library dataset name
Name of load module from which user exit is being called
Return codes
Value
Meaning
0
Continue.
1–4
Bypass the resource access.
5+
Bypass the resource access and purge the JES dataset.
Sample user exit
XUXIT07 is a sample user exit 07. It issues an enqueue for the resource
library and member being downloaded.
Section Two: Installing and Customizing XPAF
7-29
Coding the XPAF user exits
User exit 08 (End resource download)
This user exit can be used to issue a dequeue for a resource enqueued in
user exit 07.
When called
This user exit is called immediately after a resource is downloaded.
Input parameters
•
•
•
•
•
•
•
•
Member name
Resource type
Library format
Library reference method
Library DD name
Library dataset name
Name of load module from which user exit is being called
Return code from resource download
Return codes
Value
0+
Meaning
Continue.
Sample user exit
XUXIT08 is a sample user exit 08. It issues a dequeue for the resource
library and member being downloaded.
Section Two: Installing and Customizing XPAF
7-30
Coding the XPAF user exits
User exit 09 (SMF record)
This user exit can be used to:
•
•
•
•
•
•
Consolidate SMF records
Add user-generated fields as SMF record extension fields
Adjust fields generated by XPAF
Select printers, jobs, or users to be accounted for
Change the SMF record type to a user-defined value
Collect and save accumulated JES dataset statistics
When called
This user exit is called immediately before the SMF type-6 record is
written (after printing of a dataset has completed).
Input parameters
•
Standard type 6 SMF record (PSF subtype)
Return codes
Value
Meaning
0
Continue.
1–4095
Bypass writing the SMF record.
4096+
The address of the user-provided SMF record is used in
place of the XPAF-generated SMF record.
Sample user exit
XUXIT09 is a sample user exit 09. It copies the XPAF requestor ID to the
SMF user ID field and indicates that this modified SMF record will be
written in place of the XPAF-generated record.
Section Two: Installing and Customizing XPAF
7-31
Coding the XPAF user exits
User exit 10 (FSA termination)
This user exit can be used to:
•
•
Issue a termination message
Collect and save accumulated subtask-related statistics
When called
This user exit is called immediately before a task is terminated.
Input parameters
None.
Return codes
Value
0+
Meaning
Continue.
Sample user exit
XUXIT10 is a sample user exit 10. It issues a message with the elapsed
time XPAF was active.
Section Two: Installing and Customizing XPAF
7-32
Coding the XPAF user exits
User exit 11 (XOSF dataset close)
This exit can be used to:
•
•
Issue a dataset close message
Collect or save accumulated dataset statistics
When called
This user exit is called after the last record in a dataset has been
processed just before the dataset is logically closed.
Input parameters
Input
Mapped by
XPAF Document Information Block
@XDIB
Return codes
Value
Any
Meaning
Continue
Sample user exits
XUXIT11is a sample user exit 11. This sample exit will generate a
message showing JOBNAME, JOBNUMBER, FCB, FORMS, SYSOUT
CLASS and the count of records sent to the printer (accumulated by
sample exit XUXIT12).
Section Two: Installing and Customizing XPAF
7-33
Coding the XPAF user exits
User exit 12 (Writer data record)
This exit can be used to:
•
•
•
Modify data records before they are sent to printer
Insert data records in printer data stream
Delete data records from printer data stream
When called
This user exit is called for each record presented to the physical writer
(XWRMAIN), before the record is transmitted to the printer. Note that this
exit is before any VTAM or TCP/IP conditioning has been done and the
records will not include any records generated by the VTAM or TCP/IP
conditioning.
Input parameters
Input
Mapped by
XPAF Document Information Block
@XDIB
XPAF printer profile table
@XXQPPT
Flags indicating type of carriage control used
@UXPM
Logical print record from XOSF transform and
conditioning
@UXPM
Return codes
Value
Meaning
0
Continue
1-4
Bypass this record
5-16
Requeue the JES dataset
17-32
Requeue and hold the JES dataset
33-4095
Abort the thread
4096+
The address of the user-provided record is used in place
of the provided record. The next time the user exit is
called, the original provided record will again be
presented to the user exit.
Sample user exits
XUXIT12 is a sample user exit 12. This sample exit will add a DJDE
SIDE=NUFRONT in front of each DJDE dataset and will count the number
of records sent to the printer.
Section Two: Installing and Customizing XPAF
7-34
Coding the XPAF user exits
User exit 30 (Messages)
This user exit can be used to:
•
Extract statistics from messages or information from other user exits
in the task
•
Control message suppression dynamically
•
Translate console messages to meet user requirements via WTO
When called
For all messages issued from the Message Service Facility except MSF
and XUX messages, this user exit is called before a message is issued.
Input parameters
•
Message flag.
•
Message text with all MSF substitutions resolved. The length is
determined from the parm length field.
Return codes
Value
Meaning
0
Continue.
1+
Bypass message processing for this message.
Sample user exit
XUXIT30 is a sample user exit 30. It suppresses all informational XPAF
console messages.
Section Two: Installing and Customizing XPAF
7-35
Coding the XPAF user exits
User exit 31 (Commands)
This user exit can be used to:
•
•
Restrict commands to certain users or time periods
Suppress commands
When called
This user exit is called before a command is parsed. At this point in
processing, syntax checking has not been performed; therefore, the
command may not be valid.
Input parameters
•
Command text. The length is determined from the parm length field.
Return codes
Value
Meaning
0
Continue.
1+
Bypass command processing for this command.
Sample user exit
XUXIT31 is a sample user exit 31. It suppresses operator commands to
turn off SMF or XOSF logging, issues a message when a command is
suppressed, and maintains a counter of suppressed messages.
Section Two: Installing and Customizing XPAF
7-36
Coding the XPAF user exits
User exit 32 (Refresh security)
This user exit can be used to:
•
Restrict access to the PDS refresh function to selected groups or
individuals
•
Restrict access to refresh functions during periods of high usage
•
Dynamically alter the data controlling access defined by the user exit
itself
The PDS refresh function can be accessed in two ways:
•
In XOAF, using the PDS refresh and display services.
•
In XOSF, using these XPAF-exclusive operator commands:
REFRESH ALLPDS
REFRESH FONT240
REFRESH FONT300
REFRESH FORMDEF
REFRESH OVERLAY
REFRESH PAGEDEF
REFRESH PAGESEG
REFRESH PAGEFORM
DISPLAY REFRESH STATS
RESET THRESHOLD
SET REFRESH SECURITY ON
SET REFRESH SECURITY OFF
SET REFRESH SECURITY 'user-text '
When called
This user exit is called before a refresh request from the z/OS operator or
TSO user is executed.
Input parameters
•
•
•
•
Address of XOSF function table
Function key to use with the XOSF function table
Command value
XOSF function table
Return codes
Value
Meaning
0
Continue.
1+
Bypass refresh processing for this refresh request.
Sample user exit
XUXIT32 is a sample user exit 32. It suppresses TSO-initiated refresh
requests during typical morning and afternoon peak processing hours. It
also demonstrates a method of accessing the XOSF function table.
Section Two: Installing and Customizing XPAF
7-37
Coding the XPAF user exits
XPAF, PSF, and JES user exit cross-reference
Table 7-3 identifies the XPAF user exits by user exit ID and function and
lists the corresponding PSF and JES user exits, where applicable.
Table 7-3.
XPAF, PSF, and JES user exit cross-reference
XPAF user exits
ID
Function
PSF user exits
ID
Function
JES user exits
Ver.
ID
Function
01
FSA initialization
7.a
FSA initialization
02
Dataset open
7.b
Begin dataset
03
Read JES logical
record
4.a
JES record line fields
4.b
JES record structured
fields
1
Job header separator
2
1
Print/Punch
separators
2
Job trailer separator
3
20
Job output job header
3
Job dataset separator
3
21
Dataset job header
3
23
Job output job trailer
2
21
SMF record
04
XOAF dataset open
05
Banner pages
06
Resource access
7.c
07
Begin resource
download
7.d.1
Resource load: before
load
08
End resource
download
7.d.2
Resource load: after
load
7.e
09
Write SMF record
10
FSA termination
11
XOSF dataset close
12
Writer data option
30
Messages
31
Commands
32
Security
5
7.f
Resource access
Resource delete
SMF record
FSA termination
Section Two: Installing and Customizing XPAF
7-38
Message logging
8.
8
Message logging
This chapter describes the logs used by XPAF and explains how to set up
logging functions. It also explains how to print the XOAF and XOSF log
datasets using JCL.
For more information about any of the initialization or printer profile
parameters mentioned in the following sections, refer to Section Five:
XPAF Parameter and Keyword Reference.
z/OS system logging
The z/OS system log (SYSLOG) may contain z/OS system messages,
XOAF messages, XOSF messages, and messages from other host
products. For example, messages in the SYSLOG may show the status of
jobs running on the host system, actions taken by users, or information
about XPAF processing.
Setting system logging
The XPAF default is to write all XPAF system messages along with other
system messages to the z/OS system log. However, you may want to
avoid logging duplicate entries in both the z/OS system log and the XOAF
or XOSF log.
If you do not want XPAF system messages written to the z/OS system log,
you can turn system logging off:
•
For XOAF, specify SLOG=N in the XINSXOAF member of XINPARM.
•
For XOSF, specify SLOG=N in one of these locations:
—
The XINSXOSF member of XINPARM.
—
The PARM parameter on the EXEC statement included in the
XOSF start-up proc.
You also can use the SET SYSTEM LOGGING ON|OFF command to
change the current status of XOSF message logging. For more
information about this operator command, refer to Section Seven: XPAF
Operator Guide.
NOTE: It is recommended that the SLOG=N always be specified for
XOAF (XINSXOAF). Otherwise, a flurry of superfluous and annoying
messages will be displayed on the system console whenever XOAF
is run.
Section Two: Installing and Customizing XPAF
8-1
Message logging
Suppressing messages
XPAF messages, except those coded as non-suppressible, can either be
enabled to or suppressed from displaying on the console.
To suppress XPAF system messages directed to the SYSLOG and z/OS
operator console, you must specify a member name in the
MSFSUPPMEM initialization parameter in the XINSXOAF and XINSXOSF
members of XINPARM. The member name identifies which member
contains the suppression text (message number/message type) used to
suppress message numbers or message types at start-up time. All XPAF
system messages will continue to be written to the XOAF and/or XOSF
log.
A sample message suppression member, MSGSUPP, is included in
XPFSAMP. You can use this sample text as a pattern for creating your
own message suppression member.
You also can use the SUPPRESS or ENABLE commands to suppress or
enable XOSF messages. For more information about these operator
commands, refer to Section Seven: XPAF Operator Guide.
Setting a message threshold
You may set a maximum number of messages that can be displayed on
the operator console and written to the SYSLOG while printing a
document. To do this, specify the MSGTHMAX parameter in the
XINSXOSF member of XINPARM. This option is only available for XOSF
messages; it does not apply to XOAF messages.
When the maximum threshold value is reached, XOSF issues a message
to the SYSLOG and the XOSF log. All messages issued after this value is
reached are written only to the XOSF log.
Section Two: Installing and Customizing XPAF
8-2
Message logging
XPAF system logging
XPAF system messages can be written to either the XOAF log dataset or
the XOSF log dataset.
Managing the XOAF log
XOAF logging is similar to z/OS system logging. The difference is that
only XOAF messages are written to the XOAF log. If you have specified
SLOG=Y in the XINSXOAF member of XINPARM to enable both system
logging and XOAF logging, the system writes messages to both the XOAF
log and the operating system log.
Creating an XOAF log
During installation, XPAF allocates an XOAF log dataset called
prefix.XOAFLOG, where prefix is the value specified for the HLQ
(high-level qualifier) parameter in the #GENPROD installation service
macro. You can use this installation-generated dataset to log messages,
or you can specify a different sequential dataset for logging messages.
CAUTION: If you have multiple XOAF users, each XOAF session
should have a unique XOAF log dataset. Sharing an XOAF log
dataset between multiple users may result in data being overwritten
or lost, or in messages for different users being intermingled.
You must allocate each XOAF log dataset as a sequential dataset with
these file specifications:
RECFM=VB
LRECL=256
BLKSIZE=4096
Setting XOAF logging on
If you want all XPAF system messages written to the XOAF log, follow
these steps:
Step 1.
Specify XLOG=Y in the XINSXOAF member of XINPARM.
Step 2.
Specify a dataset name for the XLOGDSN initialization parameter in the
XINSXOAF member of XINPARM. There is no default dataset; XPAF
cannot set logging on unless you specify a dataset name for this
parameter.
Step 3.
After you log on to TSO, enter these commands:
TSO FREE DDN(XINPARM)
TSO ALLOC DDN(XINPARM)
DSN('prefix.xinparm-library-name') SHR
Section Two: Installing and Customizing XPAF
8-3
Message logging
Switching XOAF log datasets
You may define a primary XOAF log dataset via the XLOGDSN
initialization parameter. When this primary dataset becomes full, you must
clear the file contents. While you clear the primary log, messages will be
sent to the alternate XOAF log dataset, as defined by the ALOGDSN
initialization parameter. You must have both a primary and an alternate
log dataset defined for log switching to work properly.
To enable XPAF to switch between primary and alternate log datasets
automatically, follow these steps:
Step 1.
Allocate an alternate dataset with the same attributes as the primary
dataset. The alternate dataset must be empty or contain only one record
before it is switched to. This requirement prevents you from switching to
a dataset that has not been archived or cleared.
If the alternate log is not empty, a message is issued, and XOAF logging
is disabled. You must clear the alternate log before it can be used.
Step 2.
Specify the ALOGDSN initialization parameter and the name of the
alternate log dataset in the XINSXOAF member of XINPARM.
When the switch occurs, XOAF issues an informational message notifying
you of the change in log datasets.
Step 3.
Before logging is switched back to the primary dataset, clear the primary
log dataset. For more information, refer to “Clearing the XOAF log
dataset” later in this chapter.
Setting intensive logging
As a diagnostic aid, you can turn the intensive logging indicator on or off.
•
When the indicator is turned on, the system writes debugging
messages or additional informational messages to the XOAF log.
Therefore, you should turn on intensive logging when diagnosing a
problem.
•
When the indicator is turned off, the system does not write additional
messages to the XOAF log.
To ensure that the intensive logging indicator is turned on before an XOAF
session is initiated, verify that DEFILIND=Y has been specified in the
XINSXOAF member of XINPARM.
Recovering an XOAF log dataset after an I/O error
To allow you to browse the XOAF log dataset while XOAF is still active,
XPAF allocates the log dataset with a disposition of SHARE. This means
that a program (for example, IEBGENER or a user-written program) in
another address space may be able to update the same log dataset as
XPAF, causing the currently active log dataset to become corrupted.
If this happens, XPAF issues a message indicating that an I/O error has
occurred. Logging is disabled.
This error may occur when you are using the ISPF editor or when you are
redefining the log dataset. Use one of these two options to recover the
XOAF log dataset in which the error occurred.
Section Two: Installing and Customizing XPAF
8-4
Message logging
Option 1: Using the ISPF editor
If you are using the ISPF editor, follow these steps:
Step 1.
Edit the named log dataset and add one character to the first line.
Step 2.
Save the dataset.
Step 3.
Reedit the dataset and delete the first record.
Step 4.
Save the dataset again.
Option 2: Redefining the log dataset
If you are redefining the log dataset, perform either of these options:
•
Run a batch job using IEBGENER to delete and define the named
log dataset.
•
Use ISPF option 3.2 to delete and define the named log dataset.
Clearing the XOAF log dataset
If XPAF issues messages indicating that the XOAF log dataset is full, you
must clear the dataset. If you want to keep a record of the messages, print
or archive the dataset before clearing it.
To clear the dataset, follow these steps:
Step 1.
If the XOAF log is allocated to an XOAF session, terminate the session
before performing the next step.
Step 2.
Either edit the dataset and delete all of the lines from it, or delete and
uncatalog the dataset and then reallocate a new one with the same name.
CAUTION: Failure to perform these steps can cause a permanent I/O
error in the log dataset.
Managing the XOSF log
XOSF logging is similar to z/OS system logging. The difference is that
only XOSF messages are written to the XOSF log. If you have enabled
both system logging and XOSF logging and specified SLOG=Y in the
XINSXOSF member of XINPARM, the system writes messages to both
the XOSF log and the operating system log.
Section Two: Installing and Customizing XPAF
8-5
Message logging
Creating an XOSF log
During installation, XPAF allocates an XOSF log dataset called
prefix.XOSFLOG, where prefix is the value you specified for the HLQ
(high-level qualifier) parameter in the #GENPROD installation service
macro. You can use this installation-generated dataset to log messages,
or you can specify a different sequential dataset for logging messages.
If you have multiple XOSF started tasks, each XOSF address space
should have a unique XLOGDSN.
CAUTION: Sharing an XLOGDSN between multiple XOSF printer
address spaces may result in data being overwritten or lost.
You must allocate each XOSF log dataset as a sequential dataset with
these file specifications:
RECFM=VB
LRECL=256
BLKSIZE=4096
Setting XOSF logging on
If you want all XOSF messages to be written to the XOSF log, follow these
steps:
Step 1.
Specify XLOG=Y in one of these locations:
•
The XINSXOSF member of XINPARM
•
The PARM parameter on the EXEC statement included in the XOSF
start-up proc
•
The dataset specified by the PFILE initialization parameter
Step 2.
Specify a dataset name for the XLOGDSN initialization parameter in the
XINSXOSF member of XINPARM. There is no default dataset; XPAF
cannot set logging on unless you specify a dataset name for this
parameter.
Step 3.
Issue the start printer JES command to start your XOSF session and
activate the parameter settings.
After XOSF has been initialized, use the SET XOSF LOGGING ON|OFF
command to turn XOSF logging on or off. For more information about this
operator command, refer to Section Seven: XPAF Operator Guide.
Section Two: Installing and Customizing XPAF
8-6
Message logging
Switching XOSF log datasets
You may define a primary XOSF log dataset via the XLOGDSN
initialization parameter. When this primary dataset becomes full, you must
clear the file contents. To continue logging messages while clearing the
file, activate log switching. While you clear the primary log, messages will
be sent to the alternate XOSF log dataset, as defined by the ALOGDSN
initialization parameter. You must have both a primary and an alternate
log dataset defined for log switching to work properly.
To switch between primary and alternate log datasets automatically,
follow these steps:
Step 1.
Allocate the alternate dataset with the same attributes as the primary
dataset. The alternate dataset must be empty or contain only one record
before it is switched to. This requirement prevents you from switching to
a dataset that has not been archived or cleared.
If the alternate log is not empty, a message is issued, and XOSF logging
is disabled. You must clear the log, then reactivate it by issuing the SET
XOSF LOG ON command.
Step 2.
Add the ALOGDSN initialization parameter and the name of the alternate
log dataset to one of these locations:
•
The XINSXOSF member of XINPARM
•
The PARM parameter on the EXEC statement included in the XOSF
start-up proc
•
The dataset specified by the PFILE initialization parameter
When the switch occurs, XOSF issues an informational message notifying
you of the change in log datasets.
Step 3.
Before logging is switched back to the primary dataset, clear the primary
log dataset. For more information, refer to “Clearing the XOSF log
dataset” later in this chapter.
You can also manually switch between datasets using the SWITCH XLOG
command. For more information about this operator command, refer to
Section Seven: XPAF Operator Guide.
Setting intensive logging
As a diagnostic aid, you can turn the intensive logging indicator on or off:
•
When the indicator is turned on, debugging messages or additional
information messages are written to the XOSF log. Therefore, you
should turn on intensive logging when diagnosing a problem.
•
When the indicator is turned off, additional messages are not written
to the XOSF log.
To ensure that the intensive logging indicator is turned on before XOSF is
started, verify that DEFILIND=Y has been specified in the XINSXOSF
member of XINPARM.
To turn intensive logging on at the operator console, use the SET
INTENSIVE LOGGING ON command. For more information about this
operator command, refer to Section Seven: XPAF Operator Guide.
Section Two: Installing and Customizing XPAF
8-7
Message logging
Recovering an XOSF log dataset after an I/O error
To allow you to browse the XOSF log dataset while XOSF is still active,
XPAF allocates the log dataset with a disposition of SHARE. This means
that a program (for example, IEBGENER or a user-written program) in
another address space may be able to update the same log dataset as
XPAF, causing the currently active log dataset to become corrupted.
If this happens, XPAF issues a message indicating that an I/O error has
occurred. Logging is disabled.
This error may occur when you are using the ISPF editor or when you are
redefining the log dataset. Use one of these two options to recover the
XOSF log dataset in which the error occurred.
Option 1: Using the ISPF editor
If you are using the ISPF editor, follow these steps:
Step 1.
Edit the named log dataset and add one character to the first line.
Step 2.
Save the dataset.
Step 3.
Reedit the dataset and delete the first record.
Step 4.
Save the dataset again.
Step 5.
Issue the SET XOSF LOG ON command.
Option 2: Redefining the log dataset
If you are redefining the log dataset, perform either of these options:
•
Run a batch job using IEBGENER to delete and define the named
log dataset.
•
Use ISPF option 3.2 to delete and define the named log dataset.
Section Two: Installing and Customizing XPAF
8-8
Message logging
Clearing the XOSF log dataset
If XPAF issues messages indicating that the XOSF log dataset is full, you
must clear the dataset. If you want to keep a record of the messages, print
or archive the dataset before clearing it.
To clear the dataset, follow these steps:
Step 1.
If XOSF is active and the log to be cleared is the currently active log, you
must disable it by issuing the SET XOSF LOG OFF command. Or, if the
alternate log is empty, switch the logs.
Step 2.
Either edit the dataset and delete all of the lines from it, or delete and
uncatalog the dataset and then reallocate a new one with the same name.
Step 3.
Issue the SET XOSF LOG ON command.
CAUTION: Failure to perform these steps can cause a permanent I/O
error in the log dataset.
Printing document-related messages
To print the messages that XOSF issued while processing a document,
specify the PRINTMSG parameter in the XINSXOSF member of
XINPARM. If you elect to print the messages, they are printed following
the last page of the document and before the trailer page. You can print
all messages, no messages, or selected message types.
If you elect to print the messages, you must also specify the MSGFEED
parameter in XINSXOSF to identify the tray from which paper is fed when
printing the messages.
For a specific printer, you can override these settings using the
PRINTMSG and MSGFEED printer profile parameters.
Section Two: Installing and Customizing XPAF
8-9
Message logging
Printing the log datasets
You can use the IEBGENER program to print messages written to the
XOAF and XOSF log datasets. This program prints messages in this
format:
yyddd hhmmss issued-by message-text
where
yyddd
The julian date of the message.
hhmmss
The hour, minute, and second when the message was
issued.
issued-by
Either the name of the printer task that issued the
message or the name of the address space. If there is
no entry for this parameter, then XPAF system
components issued the message.
message-text
The text of the message. If the message is 110
characters, it wraps to the next line.
Section Two: Installing and Customizing XPAF
8-10
Setting up multiple CPUs
9.
9
Setting up multiple CPUs
If you plan to submit jobs that contain XPAF extended JCL keywords from
a remote CPU to a host CPU, you must install the XPAF extended JCL on
both the host and remote systems. This chapter explains how to set up
one or more remote CPUs for printing to the host.
NOTE: If your data streams do not include XPAF extended JCL, this
procedure is not required. You can submit jobs directly from the
remote CPU to the host CPU by specifying a printer that is attached
to the host CPU.
Checklist for setting up multiple CPUs
As you complete each step, enter a check in the Completed column to
track and record your progress. Each step is explained later in this
chapter.
Step
1
2
Action
Completed
Copy files to file from host CPU
A
Copy XFSJCL from XPFLOAD
B
Copy XESJDT00 from XPFLPA
C
Copy XJCLPROC from PROCLIB
Offload files from file to remote CPU
A
Copy XFSJCL to a LNKLIST library
B
Copy XESJDT00 to a system LPALIB
C
Copy XJCLPROC to a system PROCLIB
3
Install the extended JCL keywords on the
remote CPU
4
Submit the print job
Section Two: Installing and Customizing XPAF
9-1
Setting up multiple CPUs
Step 1 – Copy files to file from host CPU
After XPAF is installed on your host system, use the sample IEBCOPY
jobs shown below to copy the specified members to file.
Step 1A – Copy XFSJCL from XPFLOAD
From the XPFLOAD library on the host system, copy the XFSJCL member
to a file.
//COPYXJCL EXEC PGM=IEBCOPY
//SYSPRINT DD SYSPRINT=*
//SYSUT1
DD UNIT=SYSDA,SPACE=(CYL,3)
//SYSUT2
DD UNIT=SYSDA,SPACE=(CYL,3)
//INDD
DD DISP=SHR,DSN=prefix.XPFLOAD
//OUTDD
DD DISP=(,PASS,DELETE),DSN=prefix.XPFLOAD.OUT,
// UNIT=3480,VOL=SER=volser,LABEL=(n,SL,EXPDT=98000)
//SYSIN
DD *
COPY OUTDD=OUTDD,INDD=INDD
SELECT MEMBER=XFSJCL
/*
Step 1B – Copy XESJDT00 from XPFLPA
From the XPFLPA library on the host system, copy the XESJDT00
member to a file.
//COPYJDTS EXEC PGM=IEBCOPY
//SYSPRINT DD
SYSPRINT=*
//SYSUT1
DD
UNIT=SYSDA,SPACE=(CYL,3)
//SYSUT2
DD
UNIT=SYSDA,SPACE=(CYL,3)
//INDD
DD
DISP=SHR,DSN=prefix.XPFLPA
//OUTDD
DD
DISP=(,PASS,DELETE),DSN=prefix.XPFLPA.OUT,
// UNIT=3480,VOL=SER=volser,LABEL=(n,SL,EXPDT=98000)
//SYSIN
DD *
COPY
OUTDD=OUTDD,INDD=INDD
SELECT MEMBER=XESJDT00
/*
Section Two: Installing and Customizing XPAF
9-2
Setting up multiple CPUs
Step 1C – Copy XJCLPROC from PROCLIB
From the PROCLIB library on your host system, copy the XJCLPROC
member to a file.
//COPYJDTS EXEC PGM=IEBCOPY
//SYSPRINT DD
SYSPRINT=*
//SYSUT1
DD
UNIT=SYSDA,SPACE=(CYL,3)
//SYSUT2
DD
UNIT=SYSDA,SPACE=(CYL,3)
//INDD
DD
DISP=SHR,DSN=prefix.PROCLIB
//OUTDD
DD
DISP=(,PASS,DELETE),DSN=prefix.PROCLIB.OUT,
// UNIT=3480,VOL=SER=volser,LABEL=(n,SL,EXPDT=98000)
//SYSIN
DD *
COPY
OUTDD=OUTDD,INDD=INDD
SELECT MEMBER=XJCLPROC
/*
Step 2 – Offload files from file to remote CPU
At the remote site, offload the files from the file to the remote CPU. Use
the sample IEBCOPY jobs to copy the specified members from file to the
remote CPU.
Step 2A – Copy XFSJCL to a LNKLIST library
Copy the XFSJCL member into a LNKLIST library or to an authorized
library that will be used as a STEPLIB in the XFSJCL procedure.
//UNLOAD1
EXEC PGM=IEBCOPY
//SYSPRINT DD SYSPRINT=*
//SYSUT1
DD UNIT=SYSDA,SPACE=(CYL,3)
//SYSUT2
DD UNIT=SYSDA,SPACE=(CYL,3)
//INDD
DD DISP=(,PASS,DELETE),DSN=prefix.XPFLOAD.OUT,
// UNIT=3480,VOL=SER=volser,LABEL=(n,SL,EXPDT=98000)
//OUTDD
DD DISP=SHR,DSN=prefix.lnklst-library-name
//SYSIN
DD
*
COPY OUTDD=OUTDD,INDD=INDD
/*
Section Two: Installing and Customizing XPAF
9-3
Setting up multiple CPUs
Step 2B – Copy XESJDT00 to a system LPALIB
Copy the XESJDT00 member into a library that is specified in one of the
LPA lists (IEAFIXxx, IEALPAxx, or LPALSTxx) in prefix.PARMLIB:
//UNLOAD2
EXEC PGM=IEBCOPY
//SYSPRINT DD SYSPRINT=*
//SYSUT1
DD UNIT=SYSDA,SPACE=(CYL,3)
//SYSUT2
DD UNIT=SYSDA,SPACE=(CYL,3)
//INDD
DD DISP=(,PASS,DELETE),DSN=prefix.XPFLPA.OUT,
//
UNIT=3480,VOL=SER=volser,LABEL=(n,SL,EXPDT=98000)
//OUTDD
DD DISP=SHR,DSN=prefix.lpa-library-name
//SYSIN
DD
*
COPY OUTDD=OUTDD,INDD=INDD
/*
Step 2C – Copy XJCLPROC to a system PROCLIB
Copy the XJCLPROC member to a system PROCLIB. You can use either
the name XJCLPROC or your own procedure name.
//UNLOAD1
EXEC PGM=IEBCOPY
//SYSPRINT DD SYSPRINT=*
//SYSUT1
DD UNIT=SYSDA,SPACE=(CYL,3)
//SYSUT2
DD UNIT=SYSDA,SPACE=(CYL,3)
//INDD
DD DISP=(,PASS,DELETE),DSN=prefix.PROCLIB.OUT,
// UNIT=3480,VOL=SER=volser,LABEL=(n,SL,EXPDT=98000)
//OUTDD
DD DISP=SHR,DSN=prefix.proclib-library-name
//SYSIN
DD
*
COPY OUTDD=OUTDD,INDD=INDD
/*
If a security package is installed, contact your security administrator to
authorize the procedure name for execution if necessary.
Section Two: Installing and Customizing XPAF
9-4
Setting up multiple CPUs
Step 3 – Install the extended JCL keywords on the remote
CPU
Use one of these options to install the XPAF extended JCL keywords:
•
To install XPAF extended JCL keywords or apply maintenance to
them without performing an IPL, refer to “Installing XPAF extended
JCL” in chapter 5, “Customizing your system.”
•
To activate the keywords until the next IPL without installing them
permanently, submit the start procedure command (S procname)
from the master console. Procname is the name of the procedure
being started by XOSF, which is usually XJCLPROC.
•
To install the XPAF extended JCL keywords permanently, add the
COM='S procname' command to the COMMNDxx member in
SYS1.PARMLIB. This ensures that the procedure is executed each
time you IPL.
Step 4 – Submit the print job
After you have copied the files to the remote CPU and installed the
extended JCL, you can submit the print job for printing on the host CPU.
For instructions on submitting print jobs, refer to Section Four: Printing
Documents with XPAF.
Section Two: Installing and Customizing XPAF
9-5
Setting up multiple CPUs
Section Two: Installing and Customizing XPAF
9-6
XPAF printer support
10.
10
XPAF printer support
This chapter provides a listing of centralized, decentralized, and
PCL-capable printers which are supported by XPAF. It also lists the
parameter and keyword settings necessary for specific interface devices.
For all printer types, the capabilities of XPAF are limited to the functional
abilities of the printer. For example, if a printer does not print duplex,
XPAF cannot duplex a document sent to that printer.
Centralized printer models
XPAF supports these centralized printers:
•
DocuPrint Family
•
Nuvera Family
•
DocuTech Family
•
4xxx EPS Family
•
Any printer connected via a FreeFlow Print Server or DocuSP
controller with the LCDS Decomposer option
For information on setting up your centralized printers, refer to
chapter 11, “Setting up LCDS-capable printers.”
Decentralized printer models
As Xerox no longer sells or supports XES capable (aka UDK or
Decentralized) devices, they are no longer documented in XPAF 6.0 or
later.
Actual code support has not been removed and these devices will
continue to work with XPAF 6.0. For information on this support please
refer to old versions of the XPAF 4.0 User Documentation.
The new intermediate font format used in XPAF 6.0 is not compatible with
XES devices. To continue to use XES devices with XPAF 6.0, dynamic
font conversion must be disabled via the FNTLGOCON=N XOSF
Initialization parameter
Section Two: Installing and Customizing XPAF
10-1
XPAF printer support
PCL-capable printer models
XPAF supports these PCL-capable printers:
•
All members of the Phaser, ColorQube, FreeFlow Print Server,
WorkCenter, Nuvera, DocuPrint, Docutech families that support PCL
•
For information on setting up your PCL-capable printers, refer to
chapter 13, “Setting up PCL-capable printers.”
VIPP-enabled printers
VIPP-enabled printers are printers that support VIPP, but are otherwise
not supported by XPAF.
Section Two: Installing and Customizing XPAF
10-2
Setting up LCDS-capable printers
11.
11
Setting up LCDS-capable printers
This chapter provides instructions on setting up your LCDS-capable
(centralized) printers to print documents from XPAF.
The capabilities of XPAF are limited to the functional abilities of the
printer. For example, if a printer does not print duplex, XPAF cannot
duplex a document sent to that printer.
Connections to host and communication protocols
You can connect your centralized printer to the host in two ways:
•
Via TCP/IP, using LPR, direct socket or the Batch JCL feature
•
Channel-attached, using the 3211 protocol
•
Via BARR/SNA RJE
Network-attached LCDS-capable printers
You can also attach remotely attached centralized printers to the z/OS
Host via TCP/IP.
Channel-attached LCDS-capable printers
Channel-attached LCDS-Capable printers use the standard IBM 3211
protocol
Running Network-attached LCDS-capable printers
To run LCDS-capable printers via TCP/IP, perform these steps:
Step 1.
Refer to the “Printing via TCPIP” section to determine the TCPIP protocol
to use and how to set up the printer profile
Step 2.
On the printer controller, define a Queue that will be used to process jobs
from XPAF and note the Initial JDE and JDL specified under the LCDS
option of “PDL Settings”.
Specify the same values of the Initial JDE and JDL for the JDE= and JDL=
printer profile parameters
Step 3.
Review the XTCPJNAM parameter and decide on a format for the
“Document Name” appearance on the printer GUI
Section Two: Installing and Customizing XPAF
11-1
Setting up LCDS-capable printers
Running in channel attached ONLINE mode
To run centralized printers in ONLINE mode, perform these steps:
Step 1.
Specify LIBRARY=ddname in the printer’s profile to identify the native
library where lists of resident fonts, forms, images, and logos are
maintained.
If you do not specify LIBRARY=ddname, XPAF will download the same
resources every time the printer is started, which increases processing
time.
Step 2.
At the printer console, start the Online Manager to activate online
processing.
Step 3.
At the printer console, enter START to start your default JSL.
You must perform these steps for each printer you want to run in ONLINE
mode. For more information about ONLINE commands, refer to your
printer’s operator guide or reference manual.
Section Two: Installing and Customizing XPAF
11-2
Setting up LCDS-capable printers
Using BARR/SNA RJE
BARR/SNA RJE is a communication interface that can be used to
remotely attach centralized printers to the host. You can specify two
different modes:
•
•
Standard BARR/SNA RJE support is the most common way a printer
is defined to XPAF. It provides these features:
—
Support for up to six centralized printers on the PRINT370
adapter
—
The ability for you to start printers individually
Extended support is primarily used when a BARR/SNA RJE
workstation is at a remote site and either has no operator support or
no access to an operator console.
Standard support and extended support provide the same communication
functionality. However, with standard support, XPAF initiates the session
to the printer, and with extended support, the BARR/SNA RJE workstation
initiates the session.
BARR/SNA RJE release 90C2.2 or higher is required for use with XPAF.
Refer to the following sections for information about using BARR/SNA
RJE.
Standard BARR/SNA RJE
To use standard BARR/SNA RJE support with XPAF, perform these tasks
using the information that follows in this chapter:
1.
Configure the BARR/SNA RJE workstation. Standard support is
designated to BARR/SNA RJE software by specifying Logon Type as
“Host Initiated” in the RJE Description.
2.
Configure an XPAF printer profile for each printer attached to the
BARR/SNA RJE workstation. Standard support is designated in the
printer profiles by using the SLU parameter to assign LUs statically
to each printer profile. If multiple printers are connected to the
BARR/SNA RJE, use the SELECT parameter to identify the printer
with which each profile is associated.
Configuring the BARR/SNA RJE workstation
For XPAF to communicate with a BARR/SNA RJE-attached printer,
specific RJE Description and S/370 Channel-Attached Printer parameters
must be set during BARR/SNA RJE installation.
Use these procedures to configure a BARR/SNA RJE workstation in
standard support mode.
Section Two: Installing and Customizing XPAF
11-3
Setting up LCDS-capable printers
Setting up the RJE Description
The RJE Description contains the parameters needed by the BARR/SNA
RJE program and the host system.
Follow this procedure to create an RJE Description:
Step 1.
From the BARR/SNA RJE workstation, access the Installation Description
menu by following the procedure described in the BARR/SNA RJE
documentation.
Step 2.
Select RJE Description.
Step 3.
At the RJE Description screen, complete these steps:
a.
Set ‘RJE System?’ to JES2. You must enter JES2 irrespective of your
actual JES system. BARR/SNA RJE generates JES initialization
statements based on this parameter.
b.
For ‘Remote Name,’ enter a unique workstation name in the format
RMTnnnn.
c.
Omit the ‘Password’ parameter.
d.
For ‘Printers,’ enter the number of PRINT370-attached Xerox
printers. BARR/SNA RJE supports up to six PRINT370-attached
printers.
e.
For ‘Punches,’ enter 0.
f.
For ‘Readers,’ enter 0.
g.
For ‘APPLID,’ omit this parameter.
h.
For ‘LOGMODE,’ enter BATCH. This is the BARR/SNA RJE-provided
logmode.
i.
For ‘Logon Type?,’ enter Host Initiated.
Section Two: Installing and Customizing XPAF
11-4
Setting up LCDS-capable printers
Defining S/370 printers
In addition to the RJE Description parameters, you also must specify
PRINT370 parameters. To perform this step, you must have the
PRINT370 package, including adapter, cable, terminators, and software
installed on your system.
Complete this procedure to define an S/370 printer to BARR/SNA RJE.
NOTE: Use the default setting for any parameter displayed on a
screen but not listed in this section.
Step 1.
Access the Installation Description menu by following the procedure
described in the BARR/SNA RJE documentation.
Step 2.
Select S/370 Channel-Attached Printers.
Step 3.
From the list of printers displayed, select the appropriate printer.
Step 4.
At the S/370 Channel-Attached Printer screen, set ‘Printer type?’ to Xerox
laser.
Step 5.
Select Set Printer Options.
Step 6.
At the Printer Options screen, set ‘Modify advanced printer options?’ to
Yes.
Step 7.
At the Advanced Printer Options screen, enter these values:
•
•
Set ‘Pad zero length records’ to No.
Set ‘Pad zero length Skip to channel 1’ to No.
Configuring the printer profile
XPAF uses initialization and/or printer profile parameters to define a
BARR/SNA RJE workstation. Review these printer profile parameters to
determine if you need to change the settings.
•
•
•
•
•
•
•
BUFSIZE
CONVERTER
SDLCRLC
SELECT
SETUP
SLU
WRITER
For more information about these parameters, refer to Section Five: XPAF
Parameter and Keyword Reference.
Section Two: Installing and Customizing XPAF
11-5
Setting up LCDS-capable printers
Sample profile
This figure shows a sample printer profile for standard BARR/SNA RJE
support.
*PRT4050
DEVICE=4050,
BUFSIZE=512,
CONVERTER=BARRSNA,
LUTYPE=LU1,
SDLCRLC=N,
SELECT=PRINT1,
SETUP=PDIR,
SLU=SLU2222,
WRITER=REMOTE
Optimizing performance
For documents sent to BARR/SNA RJE-attached printers, you must use
the CKPTPAGE JES printer parameter to indicate the number of pages in
a chain. XOSF uses only the CKPTPAGE JES printer parameter value for
BARR/SNA RJE-attached printers; it does not use the CKPTPAGE IBM
JCL keyword value.
To obtain the best performance, use the largest possible value for your
site. For example, a 10-page document sent with CKPTPAGE=10 is sent
in one chain with one response. However, the same document sent with
CKPTPAGE=1 is sent in 10 chains with 10 responses.
Defining the BARR/SNA RJE workstation to XPAF
During workstation configuration, BARR/SNA RJE generates RJE System
Definitions based on the settings established in the RJE Description.
Each RJE System Definition consists of two types of statements:
•
A Remote Definition statement in the form RMT(n).
•
One or more Remote Printer statements in the form R(n).PR(m).
There is a Remote Printer statement for each remote printer.
The RMTTBL initialization parameter is used to specify the XINPARM
member containing the RJE System Definition. The RJE System
Definition must be replicated and stored in a member of the XPAF
XINPARM library. The definition in XINPARM is read during initialization
and used to create the run-time data structures that control the
BARR/SNA RJE environment.
Section Two: Installing and Customizing XPAF
11-6
Setting up LCDS-capable printers
Procedure
To define the BARR/SNA RJE workstation to XPAF, follow this procedure:
Step 1.
Create an RJE System Definition in XINPARM:
a.
From the BARR/SNA RJE workstation, complete the RJE Description
to generate the RJE System Definition. For more information, refer to
“Setting up the RJE Description” earlier in this chapter.
b.
From the host, add the RMTTBL initialization parameter to the
XINSXOSF member of XINPARM. This parameter specifies the name
of the member that will contain the RJE System Definition. For more
information about this parameter, refer to Section Five: XPAF
Parameter and Keyword Reference.
c.
In XINPARM, create a member with the name you specified in the
RMTTBL initialization parameter.
d.
Type a copy of the RJE System Definition you created from the
BARR/SNA RJE workstation into the newly created member.
e.
Within the member, edit these parameters included in the Remote
Definition statement, if necessary:
•
•
•
•
•
•
BUFSIZE
COMPRESS
NUMPRT
NUMRDR
SETUP
PASSWORD
For more information, refer to step 2 of this procedure. All other
parameters in the Remote Definition statement are ignored by XPAF.
f.
Within the member, edit these parameters included in the Remote
Printer statements, if necessary:
•
•
DRAIN
SELECT
For more information, refer to step 3 of this procedure. All other
parameters in the Remote Printer statements are ignored by XPAF.
Step 2.
Edit the workstation-specific Remote Definition parameters included in
the RMT(n) statement:
BUFSIZE
Specifies the buffer size to be used for transmitting data
to the BARR/SNA RJE workstation. You can specify a
value from 256 to 3840.
XOSF determines the buffer size according to this
processing hierarchy:
COMPRESS
•
XOSF’s system default buffer size is set to 512.
•
If it is not set to zero, the DLOGMODE (default
logmode table entry) buffer size overrides the
default.
•
If specified, the BUFSIZE value on the RMT(n)
statement overrides all other settings.
Specifies whether compression will be used to increase
line throughput.
Section Two: Installing and Customizing XPAF
11-7
Setting up LCDS-capable printers
NUMPRT
Specifies the number of RJE printers.
NUMRDR
Specifies the number of RJE readers. If this parameter
is assigned a value other than zero, XOSF establishes
one reader.
SETUP
Enables generation of Peripheral Device Information
Record (PDIR). Specify SETUP=PDIR. The PDIR
contains this information: date, time, forms, FCB name,
copies, volume, number of print lines, and job name.
You can use the information in these fields to manage
your output and control job routing.
The copies field passed in the PDIR contains the value
specified for the COPIES IBM JCL keyword. BARR/SNA
RJE uses this value to determine the number of copies
needed. Also, the output must be directed to the
BARR/SNA RJE spool.
For example, if a value of three is passed in the PDIR,
XPAF will transmit the job to the BARR/SNA RJE
workstation once, then the BARR/SNA RJE workstation
will send the job to the printer three times. If the JCL for
a job does not include the COPIES IBM JCL keyword, no
additional copies will be printed.
You can also specify SETUP=(PDIR,NOCOPY) to
generate a PDIR record without any “copies”. This
setting may be used when you want to print the PDIR
information but the jobs are too large to be contained on
the BARR spool.
For the PDIR information to appear on the BARR/SNA
print spool display, you must change the “ending of file
name” option which appears when a device is assigned
to the spool. Refer to the BARR/SNA documentation for
instructions.
PASSWORD
Step 3.
Specifies a logon password. Use this parameter to
restrict use of the remote connections to authorized
users. When a BARR/SNA RJE workstation logs on to
XPAF, the value in this parameter is compared to the
value in the PASSWORD RJE Description parameter. If
they are different, the logon is rejected, and XPAF
issues an error message.
Edit the Remote Printer parameters included in the R(n).PR(m)
statement:
DRAIN
Requires an operator command to begin processing. If
you include this parameter, XOSF does not start the
printer.
SELECT
Specifies the name of the XPAF printer profile member
which is associated with this BARR/SNA RJE-attached
printer. You must change the value generated by
BARR/SNA RJE to the FSA printer name.
Section Two: Installing and Customizing XPAF
11-8
Setting up LCDS-capable printers
Example
Assume that you will be using extended BARR/SNA RJE support with two
centralized printers: PRT123 and PRT456. You want to use a buffer size
of 3840 and enable PDIR support.
Step 1.
From the BARR/SNA RJE workstation, specify this set of parameters in
the RJE Description to support two centralized printers.
RJE System:
Remote Name:
Printers:
Punches:
Readers:
JES2
RMT2
2
0
1
BARR/SNA RJE generates this RJE System Definition for JES:
RMT(2)
DEVTYPE=LUTYPE1,BUFSIZE=512,COMPACT=YES,PASSWORD=ABC123,
COMPRESS=YES,CONS=YES,MFORM=J,NUMPRT=2,
NUMPUN=O,NUMRDR=1
R(2).PR(1) CKPTLINE=66,CKPTPAGE=10,PRWIDTH=255,SELECT=PRINT1
R(2).PR(2) CKPTLINE=66,CKPTPAGE=10,PRWIDTH=255,SELECT=PRINT2
R(2).RD(1)
Step 2.
From the host, specify RMTTBL=REMOTE in the XINSXOSF member of
XINPARM.
Step 3.
In XINPARM, create a member named REMOTE.
Step 4.
Type a copy of the RJE System Definition you created from the
BARR/SNA RJE workstation into the REMOTE member and make these
changes:
•
Update the BUFSIZE parameter in the Remote Definition statement
to specify BUFSIZE=3840.
•
Add SETUP=PDIR to the Remote Definition statement.
•
Update each SELECT parameter in a Remote Printer statement to
identify the appropriate FSA printer.
When completed, REMOTE contains this RJE System Definition:
RMT(2)
DEVTYPE=LUTYPE1,BUFSIZE=3840,COMPACT=YES,PASSWORD=ABC123,
COMPRESS=YES,CONS=YES,MFORM=J,NUMPRT=2,
NUMPUN=O,NUMRDR=1,SETUP=PDIR
R(2).PR(1) CKPTLINE=66,CKPTPAGE=10,PRWIDTH=255,SELECT=PRT123
R(2).PR(2) CKPTLINE=66,CKPTPAGE=10,PRWIDTH=255,SELECT=PRT456
R(2).RD(1)
Section Two: Installing and Customizing XPAF
11-9
Setting up LCDS-capable printers
Configuring the printer profile
XPAF uses initialization and/or printer profile parameters to define a
BARR/SNA RJE workstation. Review these printer profile parameters to
determine if you need to change the settings for printers that are
connected to the host via BARR/SNA RJE communications. For more
information about these parameters, refer to Section Five: XPAF
Parameter and Keyword Reference.
•
•
•
CONVERTER
SELECT
WRITER
Section Two: Installing and Customizing XPAF
11-10
Setting up LCDS-capable printers
Sample profile
This is a sample printer profile for extended BARR/SNA RJE support.
*PRT4050
DEVICE=4050,
CONVERTER=BARRSNA,
LUTYPE=LU1,
SELECT=PRINT1,
WRITER=REMOTE
Optimizing performance
For documents sent to BARR/SNA RJE-attached printers, you must use
the CKPTPAGE JES printer parameter to indicate the number of pages in
a chain. XOSF uses only the CKPTPAGE JES printer parameter value for
BARR/SNA RJE-attached printers; it does not use the CKPTPAGE IBM
JCL keyword value.
To obtain the best performance, use the largest possible value for your
site. For example, a 10-page document sent with CKPTPAGE=10 is sent
in one chain with one response. However, the same document sent with
CKPTPAGE=1 is sent in 10 chains with 10 responses.
Remote job entry
Remote job entry allows JCL stored at the BARR/SNA RJE workstation to
be submitted to z/OS for processing through XPAF. Output from these
jobs can subsequently be routed back to the BARR/SNA RJE workstation
for printing. This option applies to extended BARR/SNA RJE support only.
The procedure for using remote job entry is described in BARR/SNA RJE
Version 90, Edition 1: Remote Communications for IBM PC, PS/2, and
compatible computers.
Section Two: Installing and Customizing XPAF
11-11
Setting up LCDS-capable printers
Loading LCDS resources from a FreeFlow Print Server
As part of the installation process, three jobs have created in the STAGE2
library to assist with the transfer of resources from the FreeFlow Print
Server to the mainframe. In order for this process to work, FTP access
must be enabled ion the FreeFlow Print Server and you must
To load LCDS resources from a FreeFlow Print Server to the mainframe
follow these steps:
Step 1.
Allocate datasets to use in the upload process by submitting
STAGE2(RJOB301)
Review and submit STAGE2 job RJOB301
Step 2.
Transfer resources from the FreeFlow Print Server to the ‘NOHDR’
partitioned datasets created in step 1.
Edit STAGE2 job RJOB302 and change the following:
•
IPADDR to the ip address of the FreeFlow Print Server controller
•
PUID to the userid of the account on the FreeFlow Print Server
controller can read the /var/spool/XRXnps/resources/lcds directory
via FTP.
•
PWD to the password of the userid
Submit RJOB303
Step 3.
Add the header record to resources
The XOAF utilities, used to load resources into the XPAF libraries, identify
and validate each resource by examining the ‘LPS Tape Label Header
Record’ of each font, form, image and logo. The FreeFlow Print Server
removes the header record when resources are loaded onto the
controller, so the header record needs to be added to each resource
before it can be loaded into the XPAF library,
To add the header record, review and submit STAGE2 job RJOB303
Step 4.
Load the resources into your XPAF libraries
After RJOB303 has successfully completed you will have a set of libraries
with all the printer ready to load via XOAF. You can either use the XOAF
ISPF panels or XOAF Batch jobs to load the resources. The STAGE2
library contains customized JCL to run XOAF in batch to load the
resources. Refer to the following STAGE2 members:
RLFNTLD, RLFRMLD, RLIMGLD, RMJSLLD and RLLGOLD
Section Two: Installing and Customizing XPAF
11-12
Setting up decentralized printers
12.
12
Setting up decentralized printers
As Xerox no longer sells or supports XES capable (aka UDK or
Decentralized) devices, they are no longer documented in XPAF 5.0 or
later.
Actual code support has not been removed and these devices will
continue to work with XPAF 6.0. For information on this support please
refer to old versions of the XPAF 4.0 User Documentation.
Section Two: Installing and Customizing XPAF
12-1
Setting up decentralized printers
Section Two: Installing and Customizing XPAF
12-2
Setting up PCL-capable printers
13.
13
Setting up PCL-capable printers
This chapter provides instructions for setting up your PCL-capable
printers to print documents from XPAF.
The capabilities of XPAF are limited to the functional abilities of the
printer. For example, if a printer does not print duplex, XPAF cannot
duplex a document sent to that printer.
Preparing resources
If you require the country-specific variants of the R03 fonts to print on a
decentralized or PCL-capable printer, you must convert them from the
centralized font library using XOAF or batch processing.
The following JCL is similar to the UFTCONV member in XPFSAMP. You
can use this job to assist you in your font conversion. Use your standard
job card information and make any necessary modifications to the JCL as
described in the comments.
//job-name JOB job-information
//*
//*
RUN UFTCONV - GENERATE CONVERT XFONT COMMANDS
//*
//*
This job will compare your CFONTLIB and DFONTLIB and generate
//*
CONVERT XFONT commands for any fonts found in CFONTLIB that are
//*
not also in DFONTLIB. The resulting command file should then be
//*
edited to include only those fonts you want converted. The
//*
resulting file is then used as XOAIN input to XOAF Batch to do
//*
the font conversion.
//*
//* 1. Modify the following DD statements to point to your XPAF
//*
libraries.
//*
//* 2. SYSUT2 should point to an 80-byte LRECL file or PDS member that
//*
will eventually be input to XOAF Batch processing.
//*
//* 3. Submit this job. The SYSUT2 output will be CONVERT commands
//*
for XOAF Batch.
//*
//* 4. Edit the SYSUT2 file and delete any commands for fonts that you
//*
do not want converted.
//*
//* 5. Use your XOAF Batch job to read the edited SYSUT2 file as
//*
XOAIN.
//*
//*
========> EXEC UFTCONV <========
//UFTCONV EXEC PGM=UFTCONV,REGION=6M
//STEPLIB DD DISP=SHR,DSN=prefix.XPFLIB
<==YOUR XPAF LINKLIB
//CFONTLIB DD DISP=SHR,DSN=prefix.CFONTLIB
<==YOUR XPAF CFONTLIB
//DFONTLIB DD DISP=SHR,DSN=prefix.DFONTLIB
<==YOUR XPAF DFONTLIB
//SYSUT2
DD DISP=SHR,DSN=prefix.JCL(XFONT) <==TO BE XOAF BATCH INPUT
//*YSUT2
DD SYSOUT=X
//
Section Two: Installing and Customizing XPAF
13-1
Setting up PCL-capable printers
Section Two: Installing and Customizing XPAF
13-2
Setting up PCL-capable printers
Printing to PCL-capable printers
The following sections provide step-by-step instruction on how to perform
these functions:
•
Set up PCL-capable printers
•
Send documents to PCL-capable printers using TCP/LPR or TCP/IP
protocols
•
Set device-specific features
Setting up PCL-capable printers
To set up PCL-capable printers to accept documents from XPAF, perform
these steps:
Step 1.
Step 2.
Allocate and initialize the PCL font, form, and image libraries.
•
If you chose to have XPAF allocate the PCL resource libraries during
installation (you did not specify OPTIONS=NOPCL in the #GENRSC
macro), continue with step 2.
•
If you entered OPTIONS=NOPCL in the #GENRSC macro at
installation time, allocate and initialize the PCL resource libraries on
your host system. To manually allocate the libraries, use the
LDMUTIL batch utility. For instructions on using this utility, refer to
appendix A, “Defining and initializing native libraries.”
If you want to use libraries other than the default, add the PFONTLIB,
PFORMLIB, and PIMAGELIB parameters to either or both of these
locations:
•
•
The XINSXOSF member of XINPARM
The printer’s profile
Ensure that these parameters point to the DD statements that define the
PCL resource libraries for the specified printer.
NOTE: To use named fonts they must first be downloaded to your
printer. This can be achieved by running the sample PCL font
extraction REXX procedure, FONTEXTR, and then using LPR to send
the output dataset to the relevant printer. Please refer to the
FSDOWNLOAD PJL command in the System Administrator Guide for
the target printer for additional information.
For more information on the parameters and keywords mentioned in the
previous steps, refer to Section Five: XPAF Parameter and Keyword
Reference.
Section Two: Installing and Customizing XPAF
13-3
Setting up PCL-capable printers
Sending TCP batch print jobs to PCL-capable printers
Follow this procedure to send a document to a PCL-capable printer using
the TCP/LPR or TCP/IP protocols.
Step 1.
Ensure that your TCP JCL datasets have been created and contain your
customized XTCPLPRJ and XTCPIPJ members. Use XTCPLPRJ to send
documents using the TCP/LPR protocol, and XTCPIPJ to send
documents using the TCP/IP protocol.
Step 2.
Ensure that a printer profile has been created for each printer you will be
sending documents to using the TCP/LPR or TCP/IP protocols, and that
it contains all the necessary TCP-related printer profile parameters.
Step 3.
Send your document to the destination printer. XPAF will save the
document to a disk dataset, and use the specified TCP JCL member to
submit a batch job that will send it to the destination printer. When the
dataset has been successfully transmitted, XPAF deletes it.
If you have not correctly specified the TCP dataset and JCL member in
your printer’s profile, XPAF will issue an error message. To print the
dataset, you must manually LPR it. For example, if you are using IBM
TCP/LPR, you could issue this LPR command:
LPR 'dataset-name(member-name)' AT ip-address PRINTER
queue-name FILTER L BINARY
Refer to IBM’s TCP/IP for z/OS: User’s Guide for more information about
this and other LPR commands you can use. If you are using another
vendor’s TCP software, refer to their documentation for valid command
syntax.
For more information on TCP batch printing, refer to "TCP batch printing”
on page 15-5.
Section Two: Installing and Customizing XPAF
13-4
Setting up PCL-capable printers
Modifying document processing
There are several XPAF-supplied parameters and keywords used to print
PJL and job ticket documents. This section identifies some of the
keywords available in XPAF to change document processing. Refer to
Section Five: XPAF Parameter and Keyword Reference for information
about the keywords identified in this section and for other XPAF keywords
available for document processing.
Table 13-1.
Keywords for PJL and job ticket processing
Keyword
Function
XPJLMEM
Must be specified to indicate PJL processing.
XJOBTMEM
Specifies a job ticket to be retrieved from the dataset defined by LPRDSN.
XUSERAC1-3
Specifies user-defined variable information used by the members described
in this table for variable substitution at the time of document creation.
Using the insertion feature to add PJL and job ticket
commands
You can use the job ticket insertion feature to set device-specific features
on NPS and DocuSP printers, and the PJL insertion feature to set
device-specific features on PCL-capable printers. For example, when a
PJL member is created to print three copies of a document, XPAF only
transmits the document once, however, when the printer processes the
PJL three copies are printed.
The following members are provided in XPFSAMP:
•
•
•
XPJL3COP — an example of PJL commands
XJTKJOB — an example of a job ticket
XJTKJOB1 — an example of a variable insert
The XPFSAMP member, XPJL3COP, provides a set of PJL commands
that will produce three collated copies and suppress the printer-generated
banner page on a DC265LP printer.
@PJL
@PJL
@PJL
@PJL
@PJL
@PJL
@PJL
@PJL
@PJL
@PJL
COMMENT ** 3 copies, suppress DC265LP banner page **
SET COPIES=3
SET JOBOFFSET=ON
COMMENT XRXbegin
COMMENT OID_ATT_START_SHEET OID_VAL_JOB_SHEET_NONE;
COMMENT OID_ATT_JOB_TYPE OID_VAL_JOB_TYPE_PRINT;
COMMENT OID_ATT_INTERLEAVE OID_VAL_INTERLEAVE_NONE;
COMMENT OID_ATT_OUTPUT OID_VAL_OUTPUT_PAGE_COLLATE;
COMMENT XRXend
ENTER LANGUAGE=PCL
Section Two: Installing and Customizing XPAF
13-5
Setting up PCL-capable printers
The XPFSAMP member, XJTKJOB, when used on a DocuSP printer with
a stapler, provides a set of 2 copies of the document, each copy will be
stapled separately.
%XRXbegin: 001.0300
%XRXcopyCount: 2
%XRXedgeStitching: SinglePortrait
%XRXbookletMaker: False
%XRXedgeStitchPosition: none top
%XRXbinding: None
%XRXend
NOTE: Since the copying is performed at the printer level in this
example, each copy will contain a set of banner pages if banner
pages have been enabled in the JES printer definition.
XPAF can insert document-specific information into a job ticket or PJL
member using XJOBTMEM or XPJLMEM. Variable substitution occurs
when using the following information in XJOBTMEM or XPJLMEM:
Variable
Description
%FORMNAME
The JES FORM name used to process the
document, i.e. STD1
%STEPNAME
The job step name i.e. PRTSTEP
%ACCOUNT
The account number used to print the job i.e.
D498
%JOBNAME
The JES job name i.e. HWMPRTAC
%PRINTER
The XPAF/JES printer name i.e. PRT123
%STEPDDN
The job step ddname i.e SYSUT1
%USERAC1
User variable extended JCL field
%USERAC2
User variable extended JCL field
%USERAC3
User variable extended JCL field
%DEVICE
The printer device from the XPAF PPT i.e. N32
%IPADDR
The IP address of the document i.e 192.64.0.1
%IPADDZ
The default IP address from the XPAF PPT i.e
192.64.0.4
%LPRDSN
The name of the XPAF created temporary LPR
dataset
Section Two: Installing and Customizing XPAF
13-6
Setting up PCL-capable printers
Variable
Description
%JOBNO
The JES job number
%LINES
The number of records in the dataset
%PAGES
The number of pages in the dataset
%QNAME
The name of the LPR queue the document will
be sent to
%QNAMZ
The name of the default LPR queue in the
XPAF PPT
%PORT
The name of the IP port number the document
will be sent to
%PORZ
The name of the default IP port number in the
XPAF PPT
%USER
The user name of the account that submitted
the job
Advanced users of this feature can use most of the fields defined in the
following XPAF macros:
•
•
•
•
Document Information Block, member @XDIB in SAMPMAC
Printer Profile Table, member @XXQPPT in SAMPMAC
Output Data Block, member @XODB in SAMPMAC
XDIB DJDE extension, member @XDJD in SAMPMAC
Review the macros supplied in the sample macro library and use a '%'
followed by the field name.
For example, the JES output class is held in the XDIB in field XDIBSOCL.
To use the sysout class as a variable field in a PJL or job ticket command
file, specify %XDIBSOCL.
The XPFSAMP member, XJTKJOB1, shows how variable inserts can
override the XPAF-generated job name displayed on the job queue on a
DocuSP printer:
%XRXbegin: 001.0300
%XRXtitle: %JOBNAME %JOBNO %FORMNAME %XDIBSOCL
%XRXcopyCount: 1
%XRXend
NOTE: All PJL commands begin with the prefix “@PJL”. All job ticket
commands begin with the prefix “%XRX”.
Section Two: Installing and Customizing XPAF
13-7
Setting up PCL-capable printers
Default FORM and JOBNAME PJL command processing
You can create default PJL commands that will be used for a job based
on the JES job name or FORMS name. Simply create a member
containing PJL commands with the same name as the JOB or FORM.
XPAF first searches for a member that matches the JOBNAME or FORM
name and will use these commands if present.
The hierarchy of the member name to use is as follows:
1.
2.
3.
4.
JOBNAME
JES FORM name
extended JCL keyword XPJLMEM
The value specified by the XPJLMEM PPT keyword
Preparing to add PJL commands to XPAF-created PCL
documents
Step 1.
Create the relevant members in the LPRDSN dataset to include the PJL
desired parameters.
Step 2.
(Optional) To include a set of PJL commands that will be applied to
documents with no specified user-defined commands, point the
XPJLMEM parameter in the printer's PPT to the member containing the
desired commands.
Step 3.
Update the JCL to add the XPJLMEM keyword to the relevant OUTPUT
statement(s)
Step 4.
Ensure the target printer supports the PJL commands created in the PDS
member used.
Default FORM and JOBNAME job ticket command
processing
You can create default job ticket commands that will be used for a job
based on the JES job name or FORMS name. Simply create a member,
with the job ticket, with the same name as the JOB or FORM. XPAF first
searches for a member that matches the JOBNAME or FORM name and
will use these commands if present.
The hierarchy of the member name to use is as follows:
1.
2.
3.
4.
JOBNAME
JES FORM name
extended JCL keyword XJOBTMEM
The value specified by the XJOBTMEM PPT keyword.
Section Two: Installing and Customizing XPAF
13-8
Setting up PCL-capable printers
Preparing to add job ticket commands to XPAF-created PCL
documents
Step 1.
Create the relevant members in the LPRDSN dataset to include the
desired job ticket parameters.
Step 2.
(Optional) To include a set of job ticket commands that will be applied to
documents with no specified user-defined commands, point the
XJOBTMEM parameter in the printer's PPT to the member containing the
desired commands.
Step 3.
Update the JCL to add the XJOBTMEM keyword to the relevant OUTPUT
statement(s).
Step 4.
Ensure the target printer supports the job ticket commands created in the
PDS member used.
Section Two: Installing and Customizing XPAF
13-9
Setting up PCL-capable printers
Section Two: Installing and Customizing XPAF
13-10
Overview of the PDF Transform
14.
14
Overview of the PDF Transform
The XPAF PDF Transform takes data from any conventional datastream
(such as line-mode, XES, or LCDS/DJDE) and converts that data into
Adobe’s Portable Document Format (PDF). Once it has been converted,
the data can be:
•
Printed conventionally on any Xerox PDF-compliant printer
•
Attached to an E-mail and sent to any valid e-mail address in the
world
•
Transmitted using the direct LPR or Direct Socket protocols
•
Passed to the XPAF Batch JCL feature for subsequent processing,
such as
•
Storing on an FTP server for later viewing
•
Invoking LPR with additional parameter padding
NOTE: Xerox recommends using Adobe Reader 6.0 or above to view
your XPAF-generated PDF documents. Older versions of the Adobe
Acrobat Reader may not process and display PDF form objects
correctly.
Section Two: Installing and Customizing XPAF
14-1
Overview of the PDF Transform
Configuring XPAF
This section outlines how to configure your XPAF system for use with the
PDF Transform.
Adding the license string
The PDF Transform requires a license string tied to the CPUID that XOSF
runs under. To obtain a license string, contact your local Xerox Sales
Representative.
Step 1.
Create member XINSLSTR in your XPAF XINPARM dataset and copy and
paste the two records from the license string file (PC text file) into the new
member.
Step 2.
Save the newly created member, XINSLSTR.
Figure 14-3. Sample license string member XINSLSTR
Cpuid=FF01565A2066, ExpDate=01-Jan-2012, Feature=XPAF_PDF
LicenseString=BF5F1B29860CD8378406DA4ADD9
Creating a printer profile
Step 1.
Create a printer profile for the PDF Printer. Refer to the New initialization
parameters and New printer profile parameters sections of this document
for more information about the parameters you can specify.
a) Set an IP address and a Queue name (note that these values are
not used when TCPEMAIL=MAILONLY is specified).
Figure 14-4. Sample PDF printer profile configured for e-mail
support
DEVICE=PDF, Required to invoke the PDF transform
XMAILADR=EMAIL, EMAIL Address list member name
XSMTPCTL=XSMTPCTL, HTML e-mail skeleton member name
TCPMAIL=MAILONLY, (BOTH | MAILONLY)
TCPMODE=TCPLPR, Required to invoke e-mail support
LPRDSN=your.xpaf.XINPARM,
PRINTMSG=N
Step 2.
Step 3.
Create JES printer definitions for your new PDF printer(s) or use existing
JES printer definitions.
You are now ready to start your new PDF printers and generate documents in
PDF format.
Section Two: Installing and Customizing XPAF
14-2
Overview of the PDF Transform
PDF Font Substitution
This section describes how to set up and use a PDF Font Substitution
table with the XPAF PDF Transform. This feature was originally designed
to improve the viewing of documents rather than using XPAF converted
fonts. However, this need was obviated with the vast improvements made
to viewing Adobe Reader 6.0.
PDF Font Substitution can still be of benefit to customers wishing to
decrease the size of the PDF files generated by XPAF.
Defining a PDF font substitution table
A PDF font substitution table is created as a PDS member of the
XINPARM dataset. The member name is referenced via the XPDFFSUB
extended JCL, Printer Profile, or Initialization parameter.
An entry in the font substitution table, consists of a single line with four
values:
1. Xerox font name: This is the name of the Xerox font that you want to
substitute. It must be the complete name and wild cards are not
supported. For AFP jobs, the name must be the Xerox replica font name
and not the IBM character set name. For LCDS documents the Xerox font
name will be the name of the converted decentralized font, which may
include a split number.
2. Scaling factor: This is a number in the range 0.00001 to 9999999
which is used to scale the outline font both vertically and horizontally.
There is no ideal number for this value. The ‘font height’ of the original
Xerox font is a good value to start with. For LCDS documents, the font
height of the original Xerox font can be obtained by displaying the
XPAFXFI entry for the original font.
3. Escapement scaling factor: This is a real number in the range 0 to
9999999 which is used to scale the escapement value of the characters
in the outline font.
•
A value of ‘0’ indicates that the character widths of the outline font
are used.
•
A value of ‘1’ indicates that the widths of the original Xerox font are
used and multiplied by the scaling factor.
•
A value other than ‘0’ or ‘1’ indicates that the widths of the original
Xerox font are used and multiplied by the value specified.
4. Outline font name: The name of the outline font to use instead of the
Xerox converted font. This name should be one of the 14 supported
outline font names:
•
Helvetica
•
Helvetica-Oblique
•
Helvetica-Bold
•
Helvetica-BoldOblique
•
Courier
•
Courier-Oblique
•
Courier-Bold
•
Courier-BoldOblique
Section Two: Installing and Customizing XPAF
14-3
Overview of the PDF Transform
•
Times-Roman
•
Times-Bold
•
Times-Italic
•
Times-BoldItalic
•
Symbol
•
ZapfDingbats
Comments can be included in the table by placing an ‘*’ in column 1.
Figure 14-5. Sample PDF Font substitution table
*
* PDF FONT SUBSTITUTION TABLE
* ===========================
*
* '*' in column 1, is a comment
* /--Xerox font name
* |
* | /--Scaling factor
* | |
* | | /--Escapement Scaling factor
* | | | 0 = Use Outline font character escapement
* | | | 1 = Use Scaling factor
* | | | nn.nn = escapement factor
* | | |
* | | | /-- Outline font name
* | | | |
* | | | |
* v v v v
HL124B 100 0 Helvetica
H106JP 28 0 Helvetica
H108JP 33 0 Helvetica
H208JP 36 0 Helvetica-Bold
M0112B 36.36 36.36 Courier
P06BOB 37 0 Courier
P07TYA 41.65 0 Courier
P08TAC 50 0 Courier
P08TAB 50 0 Courier
UN104A 18 0 Helvetica
UN104B 18 0 Helvetica
UN104E 18 0 Helvetica
UN106E 25 40 Helvetica
UN107E 30 0 Helvetica
Section Two: Installing and Customizing XPAF
14-4
Overview of the PDF Transform
Points to consider
•
When creating the PDF font substitution table the best way is to start
with a ‘Scaling value’ equal to the Xerox font height and a
‘Escapement scaling value’ of ‘0’.
•
Adjust the ‘Scaling value’ until the height of the substituted font
matches the height of the original Xerox font.
•
Finally, adjust the ‘Escapement scaling value’ so the escapement
of the substituted font matches the widths of the original Xerox
font.
•
The formula: Escapement_scaling_value = 1000 / scaling_value
can be used to match the original Xerox font widths
•
You can refer to PC based fonts for the outline name. However, a
warning will be generated.
•
A maximum of 100 entries can be specified in the font substitution
table
Section Two: Installing and Customizing XPAF
14-5
Overview of the PDF Transform
Encrypting PDF Documents
PDF Encryption - Overview
Encrypted PDF documents are also referred to as “Secure”. Some PDF
readers will add “(SECURED)”, to the viewing window title, to show that
an encrypted document is being viewed
PDF documents are encrypted by specifying an owner password, a user
permissions value and an optional user password.
The Owner Password
The owner password is the master password and if supplied to the viewing
software will provide full access to the PDF document. To set the owner
password, use the XPDFOPW extended JCL keyword.
The User Password
The user password is required to open an encrypted PDF document for
viewing.
The user password can be null (an empty string).
If a null user password has been specified, the user is not required to
enter a password to view the document, and most viewers will
automatically display the document without prompting for a password. To
set the user password, use the XPDFUPW extended JCL keyword.
User Permissions
An encrypted PDF document has permission flags that tell the displaying
software which user actions are permitted and which are not. For
example, the permission flags can be set to prevent a user from printing
the PDF document. Not all of the permission flags are valid in the XPAF
environment. XPAF provides a set of keywords that will set the relevant
flags. See Chapter 43, “XPAF extended JCL keywords” for information on
the available options.
Encrypting PDF documents
To encrypt an XPAF generated PDF document use the XPDFOPW,
XPDFPW, and the XPDFPERM extended JCL keyword. Note: These
values can also be set via XPAF User Exit 2. Refer to sample user exit
XUXIT02E in XPFSAMP.
Section Two: Installing and Customizing XPAF
14-6
Overview of the PDF Transform
Points to note
This sections covers information relating to converting documents to PDF
format
General
This section applies to all data stream types.
Converting duplex documents
To reproduce the correct output, when converted documents are printed,
duplex documents are converted with blank pages inserted in the PDF file
where a blank page would occur on the original print stream. Also see the
PDFDUPLEX FEATURE= Printer Profile Parameter.
AFP Specific
This section relates to AFP data streams converted to PDF.
Viewing orientation
The viewing orientation of a page in a converted AFP document is taken
from the MDD, if one exists. If an MDD is not found, the value specified
for the PMODE keyword/parameter is used.
Section Two: Installing and Customizing XPAF
14-7
Overview of the PDF Transform
Known issues
DJDE processing considerations
•
If your DJDE document includes the COPIES keyword, you may
encounter errors viewing and printing the resulting PDF document.
Section Two: Installing and Customizing XPAF
14-8
Printing via TCP/IP
15.
15
Printing via TCP/IP
This chapter provides instructions for printing via TCP/IP. The TCP/IP
direct socket support allows XPAF to transmit transformed document data
across a network using TCP/IP socket.
This feature uses the IBM assembler macros from TCP/IP for z/OS
version 3, release 2, and is called EZASMI. These macros allow an
application to interface with the latest version of TCP/IP for z/OS and
provide for the new functionality of IBM’s TCP/IP interface, HPNS
(high-performance native sockets). Utilizing these macros ensures all
new performance and functionality that is added to IBM TCP/IP for z/OS
automatically works with XPAF without any application changes being
required.
TCP/IP printing methods
There are three methods available for printing via TCP/IP:
•
•
•
Direct LPR
Direct socket
TCP/IP batch
NOTE: Any vendor and version of TCP/IP can be used, but for direct
LPR, users must have IBM TCP/IP version 3.2.0 or higher installed.
Section Two: Installing and Customizing XPAF
15-1
Printing via TCP/IP
Direct LPR
Direct LPR uses the LPR/LPD protocol to send data to an LPD server. The
LPD server can reside on the printer or can be a separate device such as
a Windows or UNIX Server.
Direct socket
Direct socket uses a different protocol to send data to an IP address and
port number (referred to as a “socket”). XPAF sends the data as soon as
it is generated so there is no need to create an intermediate file. Only
certain printers can support this protocol.
TCP/IP batch
TCP/IP batch printing is used when direct printing is not desired or when
IBM TCP/IP support is unavailable.
XPAF JCL keywords XIPADDR, XIPPORT, XLPRQNAM allow for
dynamic IP assignment to a document via extended JCL. Each printer
definition contains a default IP address and port number to support
TCP/IP printing. If no IP address or port number is given via the JCL, the
defaults from the printer parameters are used for each document
transmission.
Section Two: Installing and Customizing XPAF
15-2
Printing via TCP/IP
Sending print jobs via TCP/IP
Follow these procedures to send documents to printers using the TCP/IP
protocol.
TCP direct LPR printing
Use this method if your printer supports the LPR/LPD protocol (or is
connected via an LPD server) and you are running IBM's TCP/IP for z/OS.
Step 1.
Review the TCPIPJOB initialization parameter within XINSXOSF.
Step 2.
Ensure that a printer profile has been created for the printer you will be
sending documents to using the direct LPR connection, and that it
contains all the necessary printer profile parameters.
For example
*PRT1240
DEVICE=PHASER,
IPADDR=13.245.111.001, (IP address of printer)
TCPPORT=515,(TCP port)
LPRQNAME=PASSTHRU,(LPR queue name)
TCPMODE=TCPLPR(Indicates LPR/LPD)
Step 3.
Send your document to the destination printer.
If you have not specified your printer’s profile correctly, XPAF will issue
an error message. See Section Six: XPAF Messages for instructions
concerning any error messages.
Section Two: Installing and Customizing XPAF
15-3
Printing via TCP/IP
TCP direct socket printing
Use this method if your printer supports a direct socket connection and
you are running IBM's TCP/IP for z/OS.
Step 1.
Review the initialization parameter TCPIPJOB.
Step 2.
Ensure that a printer profile has been created for the printer to which you
will be sending documents using the direct socket connection, and that it
contains all the necessary printer profile parameters.
For example:
*PRT1240
DEVICE=PHASER,
IPADDR=13.245.111.001,(IP address of printer)
TCPPORT=245,(TCP port)
TCPMODE=TCPIP(Indicates TCP/IP direct
socket)
Step 3.
Send your document to the destination printer.
If you have not specified your printer’s profile correctly, XPAF will issue
an error message. Refer to Section Six: XPAF Messages for instructions
concerning any error messages.
Section Two: Installing and Customizing XPAF
15-4
Printing via TCP/IP
TCP batch printing
Use this method if your printer supports the LPR/LPD protocol (or is
connected via an LPD server) and you are using a TCP/IP stack other
than IBM’s TCP/IP for z/OS.
Step 1.
Ensure that your TCP JCL dataset has been created and contains your
customized XTCPLPRJ member.
Step 2.
Ensure that a printer profile has been created for each printer to which you
will be sending documents using the direct TCP/LPR protocol, and that it
contains all the necessary TCP-related printer profile parameters
including:
LPRDSN=dataset-name
LPRJCL=member-name
TCPMODE=LPR
Step 3.
Send your document to the destination printer. XPAF will save the
document to a disk dataset, and use the specified TCP JCL member to
submit a batch job that will send it to the destination printer. When the
dataset has been successfully transmitted, XPAF deletes it.
If you have not specified the TCP dataset and JCL member in your
printer’s profile correctly, XPAF will issue an error message. To print the
dataset, you must manually LPR it. For example, if you are using IBM
TCP/IP, you could issue this LPR command:
LPR 'dataset-name(member-name)' (AT ip-address
queue-name FILTER l BINARY
PRINTER
Refer to IBM’s TCP/IP for z/OS: User’s Guide for more information about
this and other LPR commands you can use. If you are using another
vendor’s TCP software, refer to their documentation for valid command
syntax.
Section Two: Installing and Customizing XPAF
15-5
Printing via TCP/IP
Section Two: Installing and Customizing XPAF
15-6
Additional features
16.
16
Additional features
E-mail notification
Through the XPAF Printing process, you can receive e-mail notification of
job completion or any error conditions encountered while printing a job.
You can specify the recipients for the e-mail, as well as criteria for sending
it. For example, you might send notification to the user who submitted the
job and/or a system administrator. You might specify that you receive
e-mail notification only if an error occurs, or every time a document is
printed successfully to the requested printer on the Intranet.
A graphical representation of the processing XPAF performs is shown in
Figure 16-6.
Figure 16-6. Figure 1. E-mail processing overview
Section Two: Installing and Customizing XPAF
16-1
Additional features
Configuring e-mail support
Step 1.
Create member EMAILADR in the LPRJCL dataset to specify the
following e-mail options, a sample can be found in XPFSAMP:
Option
Description
MAILFROM(address)
Specify the e-mail address of the sender who will provide
notification when the document prints successfully. You can
enter any e-mail address that conforms to the SMTP protocol
naming standards.
Example:
MAILFROM(Host.PrintedOK@my.company.com)
XPAF enters this name in the FROM column in your email
software.
NOTE: If you will use XPAF to send e-mail outside of your
company intranet, then this email address must be a valid
e-mail address. Otherwise, your company proxy server will not
send it to the internet to reach the addressee.
MAILFERR(address)
Specify the e-mail address of the sender who will provide
notification if an error condition was raised while printing the
document to the required device. You can enter any e-mail
address that conforms to the SMTP protocol naming standards.
Example:
MAILFERR(Host.Failed@my.company.com)
XPAF enters this name in the FROM column in your email
software.
NOTE: If you will use XPAF to send e-mail outside of your
company intranet, then this email address must be a valid email
address. Otherwise, your company proxy server will not send it
to the internet to reach the addressee.
MAILSERVER(address)
Specify the address of the mail server you wish to use when
XPAF sends out the email data. This can be either an IP
address or a host name if your OS/390 system is set up for it.
Examples:
MAILSERVER(13.234.112.345)
MAILSERVER(MAIL-SERVER.MY.COMPANY)
Section Two: Installing and Customizing XPAF
16-2
Additional features
Option
Description
IPVERSION(Ipversion)
Use this option to specify the Internet Protocol version to use when
communicating with the SMTP mail server.
Ipversion [4 | 6]
4 specifies that IP version 4 is to be used
6 specifies that IP version 6 is to be used
EMAILTYPE(HTML)
EMAILTYPE(TEXT)
Specify HTML or TEXT to indicate whether the e-mail recipients
following this statement will receive e-mail notifications in HTML
or plain text format.
If you specify EMAILTYPE(HTML), users will receive
HTML-formatted notices using the HTMLDECK from the XPAF
printer definition pointed to by XSMTPCTL=HTMLDECK.
DOMAIN (name)
Specify the domain name that is used on the HELO function
when a connection to a mail server is established.
Example:
DOMAIN(mail.mailserver.net)
GLOBAL(name)
NOTIFY(condition)
EMAIL(emailaddress)
Use this option to define global network administrators for the
OS/390 environment. You can include as many instances of this
definition as you need.
name is for identification purposes only, and specifies the
administrator’s known name, It is not used in the SMTP protocol
generation.
condition [ERR | ALL]
ALL specifies that the administrator should receive e-mail
notification for all documents produced (those that print
successfully and also those that receive an error).
ERR specifies that the administrator should receive e-mail
notification only if there is an error producing a document.
emailaddress is the email address of the administrator who will
receive the e-mail notification.
Example:
GLOBAL(John) NOTIFY(ERR)
EMAIL(John.Smith@my.company.com)
Section Two: Installing and Customizing XPAF
16-3
Additional features
Option
Description
JOBNAME(JESJobName)
Use this option to define the users to be sent an e-mail for a
particular job. XPAF compares the values specified here to the
Document JES job name to determine if an e-mail should be sent.
If no match is found, no e-mail will be sent. You can include as
many instances of this definition as you need.
NOTIFY(condition)
EMAIL(emailaddress)
JES-jobn-Name specifies the JES job name.
condition [ERR | ALL]
ALL specifies that the user should receive notifications for all
documents (those that print successfully and also those that
receive an error).
ERR specifies that the user should receive e-mail notification only if
there is an error producing a document.
emailaddress is the email address of the user who will receive the
e-mail.
Example:
JOBNAME(REPORT27) NOTIFY(ALL)
EMAIL(Mary.Jones@my.company.com)
Section Two: Installing and Customizing XPAF
16-4
Additional features
Option
Description
USER(tso-id)
Use this option to define the users to be notified of print job
completion codes. XPAF compares the values specified here to
the Document Owner to determine if an e-mail notification
should be sent. If no match is found, no e-mail will be sent. You
can include as many instances of this definition as you need.
NOTIFY(condition)
EMAIL(emailaddress)
tso-id specifies the user’s mainframe logon id.
condition [ERR | ALL]
ALL specifies that the user should receive notifications for all
documents (those that print successfully and also those that
receive an error).
ERR specifies that the user should receive e-mail notification
only if there is an error producing a document.
emailaddress is the email address of the user who will receive
the e-mail notification.
Example:
USER(MJ12345) NOTIFY(ALL)
EMAIL(Mary.Jones@my.company.com)
SEND(value)
Use this option to specify whether an email will be sent to only the
first email address that matches the USER or JOBNAME option or
to all email addresses that match either the JOBNAME and/or
USER option.
value [ONE | ALL]
ONE specifies that only one email should be sent, it will be sent to
the first email address that matches the USER or JOBNAME
option. Once the email has been sent, the process will end and the
EMAILADR table will not be examined for additional matches
ALL specifies that multiple emails can be sent. An email will be
sent to all email addresses that specify a JOBNAME or USER that
match with the values of the document being processed.
Example:
SEND(ONE)
JOBNAME(REPORT28) NOTIFY(ALL)
EMAIL(jsmith@example.net)
USER(JSMITH) NOTIFY(ALL) EMAIL(jsmith@example.net)
In the example above, if USER JSMITH submits the job
REPORT28, only one email will be sent to jsmith@example.net.
Section Two: Installing and Customizing XPAF
16-5
Additional features
Section Two: Installing and Customizing XPAF
16-6
Additional features
Enabling XJCF simulation processing
To set up your system to run XPAF in XJCF simulation mode, you must
first create an XJCFSIM table. You can create your XJCFSIM table using
one of two options:
Manually code the entries to the table.
Create your table from your existing Xerox Information Module (XIM)
table(s). XIMCVT is a conversion tool provided in XPFSAMP that
translates your XIM table into an XJCFSIM table. This method generates
approximately 95 percent of the entries required to simulate your XJCF
jobs through XPAF.
You must review the converted source to ensure that all XIM statements
were converted correctly and to add the appropriate FORMS and/or
CLASS table entries.
Manually creating your XJCFSIM table
To create your XJCFSIM table manually, follow these steps.
Step 1 – Copy XJCFSIM from XPFSAMP
Copy the XJCFSIM member from XPFSAMP. This member provides a
model you can use to create your own table.
Step 2 – Edit the XJCFSIM member
Edit your new XJCFSIM member to add or update the necessary option,
JDL, and/or table entries.
Step 2A – Update the XJCFSIM OPTION statement
There are six processing options you can specify for the XJCFSIM table:
The DUP option enables you to specify duplicate keywords. Normally,
once a particular keyword is specified (for example, in the extended JCL
or FORMS table), any subsequent occurrences are ignored (for example,
in the CLASS table or initial packet). However, if you specify
OPTION,DUP=YES, duplicate keywords are allowed unless the first
instance is from extended JCL. Extended JCL always overrides any other
DJDE generation.
The default is DUP=NO.
The OTEXT option allows you to notify the printer operator when a new
form is needed. If you specify OPTION,OTEXT=YES, XPAF generates
OTEXT messages to inform the printer operator which dataset is printing
and which form it requires.
Normally, the OTEXT message uses the WAIT option if the form name is
different from the form on the last dataset. However, you can specify
OTEXT=(YES,NOWAIT) if you want to receive the OTEXT message
without the WAIT. You cannot use multiple forms in a single dataset.
The default is OTEXT=NO.
Section Two: Installing and Customizing XPAF
16-7
Additional features
For best-fit PDE processing, the TRCLIM option allows you to specify
whether the font index value can exceed the number of CHARS specified
for the job. You should use this option if your PDE has more than four
fonts available.
If you specify TRCLIM=YES, the TRC value cannot exceed the number of
fonts specified using the CHARS IBM JCL keyword. Depending on the
number of CHARS specified for the job, the font index value can be from
0 to 3.
If you specify TRCLIM=NO, the font index value can exceed the number
of fonts specified using the CHARS IBM JCL keyword. The font index
value can be from 0 to 15.
The default is TRCLIM=YES.
The BANRJDL option allows you to specify whether or not a JDL or JDE
included in the banner page DJDE packet should be overridden by a value
found in the JCL or in the XJCFSIM table.
Normally, if XJCF simulation is active and a JDL or JDE name is found in
the banner page initial DJDE packet, that name is replaced with the JDL
or JDE name specified for the job (in either the JCL or XJCFSIM table).
This ensures that the banner page is included as part of the print job for
stapling purposes.
If you specify BANRJDL=NO, however, the JDL or JDE name in the
banner page initial DJDE packet is not replaced.
The default is BANRJDL=YES.
The TRC option allows you to specify if the FONTINDEX= and DATA=
DJDEs will be generated when TRC=YES, or OPTCD=J are specified in
your JCL.
If you specify TRC=YES, DATA=(1,250) and FONTINDEX=(0,ZERO,4)
are generated.
If you specify TRC=NO, neither the DATA= nor FONTINDEX= is
generated.
The default is TRC=YES.
The WARN option allows you to disable the XJC4600 warning message.
The default is WARN=YES.
The OPTION statement, if used, must be the first statement and must be
used only once in the XJCFSIM table.
Example:
@XJCFSIM OPTION,DUP=YES,OTEXT=YES,
TRCLIM=NO,BANRJDL=NO
Step 2B – Add the JDL definition statement
A JDL definition statement is mandatory and must follow the OPTION
statement, if one is used. This statement names the JDL used to
reference other tables coded within XJCFSIM. The JDL name is required
and must be specified in columns 1–6. After the JDL definition statement,
you can code the tables belonging to that JDL in any order.
For each JDL you use, define the appropriate simulation tables:
CHARS
CLASS
DEST
FCB
FLASH
Section Two: Installing and Customizing XPAF
16-8
Additional features
FORMS
MODIFY
PDE
WRITER
NOTE: Numeric labels must be preceded by a #. Some assemblers
do not permit labels that begin with numeric characters. However, the
@XJCFSIM macro drops the # and generates the correct names.
You can use the ALIAS keyword to allow multiple JDL names to refer to
the same tables. The ALIAS keyword is optional.
Using the ALIAS=* command instructs XJCFSIM to use this table for all
JDLs.
Example:
DFAULT
TEST
Update the XJCFSIM FORMS
table
@XJCFSIM JDL,ALIAS=(APPL,FCOMB,PGMODE,OPRINF)
. . .
. . .
(tables for DFAULT JDL)
. . .
@XJCFSIM JDL
This feature simulates XJCF FORMS processing. XPAF generates DJDEs
for a job based on the form name specified on the DD or OUTPUT JCL
card used to process the job.
Your XJCFSIM FORMS table should contain an entry for each form you
use and its associated DJDEs. The label for each table entry is a FORMS
value. Numeric labels must be preceded by a #. For example, ASML4 and
#4 are valid labels.
You can specify the non-DJDE keywords DJDE, FCB, UCS, FLASH,
TWOUP, PAPERSIZE, LINECT, XIPADDR, XLPRQNAM, and CLUSTRTB
in this table. XPAF processes them as if they were coded in the JCL but
does not generate DJDE statements for them.
Example:
STD
#4
ASMP
ASML
ASML4
@XJCFSIM FORMS
@XJCFSIM FORMS,
'PMODE=PORTRAIT,DUPLEX=YES,'
@XJCFSIM FORMS,
'PMODE=PORTRAIT,DUPLEX=YES,'
@XJCFSIM FORMS,
'PMODE=LANDSCAPE,DUPLEX=YES,',
'FLASH=ASL2,FCB=LINA,'
@XJCFSIM FORMS,'TWOUP=YES,UCS=XX,',
'PMODE=LANDSCAPE,DUPLEX=YES,FLASH=ASL4,FCB=LINB,'
*
*
*
*
*
Each set of parameters is enclosed in quotes. You can specify up to ten
strings of parameters within quotes for a single form name.
Section Two: Installing and Customizing XPAF
16-9
Additional features
NOTE: Each string, including the last one, must end with a comma
inside the quotes.
Update the XJCFSIM CLASS
table
This feature simulates XJCF’s SYSOUT CLASS processing. XPAF
generates DJDEs used for a job based on the SYSOUT CLASS specified
in the JCL used to process the job.
For each output class, your XJCFSIM CLASS table can contain an entry
for that output class and its associated DJDEs. The label for each table
entry is a CLASS value. Numeric labels must be preceded by a #. For
example, X and #3 are valid labels.
You can specify the non-DJDE keywords DJDE, FCB, UCS, FLASH,
TWOUP, PAPERSIZE, LINECT, XIPADDR, XLPRQNAM, and CLUSTRTB
in this table. XPAF processes them as if they were coded in the JCL but
does not generate DJDE statements for them.
Example:
#3
X
@XJCFSIM CLASS,'PMODE=LANDSCAPE,DUPLEX=YES,',
'FLASH=TEST,FCB=LIN6,'
@XJCFSIM CLASS,'PMODE=PORTRAIT,DUPLEX=NO,'
*
Each set of parameters is enclosed in quotes. You can specify up to 10
strings of parameters within quotes for a single class.
NOTE: Each string, including the last one, must end with a comma
inside the quotes.
Update the XJCFSIM DEST
table
This feature allows you to generate DJDEs used for a job based on the
DEST specified in the JCL used to process the job.
This table is used to specify the XIPADDR and QNAME to use when
routing print jobs to specific printers based on the destination ID specified
in the JCL.
For each DEST ID, your XJCFSIM DEST table can contain an entry for
that destination and its associated DJDEs. The label for each table entry
is a DEST value. Numeric labels must be preceded by a #. For example,
X and #3 are valid labels.
You can specify the non-DJDE keywords DJDE, FCB, UCS, FLASH,
TWOUP, PAPERSIZE, LINECT, XIPADDR, XLPRQNAM, and CLUSTRTB
in this table. XPAF processes them as if they were coded in the JCL but
does not generate DJDE statements for them.
Example:
RMT25
@XJCFSIM DEST,'XIPADDR=13.245.113.77,XLPRQNAM=PASSTHRU,',
'CLUSTRTB=DEFAULT4517,'
PAYROLL @XJCFSIM DEST,'XIPADDR=13.245.112.106,XLPRQNAM=PORT1,',
'CLUSTRTB=DEFAULT4512,'
Section Two: Installing and Customizing XPAF
*
*
16-10
Additional features
Each set of parameters is enclosed in quotes. You can specify up to 10
strings of parameters within quotes for a single DEST.
NOTE: Each string, including the last one, must end with a comma
inside the quotes.
Update the XJCFSIM
WRITER table
This feature allows you to generate DJDEs used for a job based on the
WRITER specified in the JCL used to process the job.
This table is used to specify the XIPADDR and QNAME to use when
routing print jobs to specific printers based on the destination ID specified
in the JCL.
For each WRITER ID, your XJCFSIM WRITER table can contain an entry
for that destination and its associated DJDEs. The label for each table
entry is a WRITER value. Numeric labels must be preceded by a #. For
example, X and #3 are valid labels.
You can specify the non-DJDE keywords DJDE, FCB, UCS, FLASH,
TWOUP, PAPERSIZE, LINECT, XIPADDR, XLPRQNAM, and CLUSTRTB
in this table. XPAF processes them as if they were coded in the JCL but
does not generate DJDE statements for them.
Example:
RMT25
PAYROLL
@XJCFSIM WRITER,'XIPADDR=13.245.113.77,XLPRQNAM=PASSTHRU,',
'CLUSTRTB=DEFAULT4517,'
@XJCFSIM WRITER,'XIPADDR=13.245.112.106,XLPRQAM=PORT1,',
'CLUSTRTB=DEFAULT4512,'
*
*
Each set of parameters is enclosed in quotes. You can specify up to 10
strings of parameters within quotes for a single WRITER.
NOTE: Each string, including the last one, must end with a comma
inside the quotes.
Update the XJCFSIM FLASH
table
This feature simulates XJCF’s FLASH processing. XPAF generates
DJDEs based on the values in effect for these keywords in the XJCFSIM
FORMS table, XJCFSIM CLASS table, or JCL for the job:
•
COPIES — Indicates the copy to which the form will be applied.
•
FLASH — Names the IBM form flash.
•
PMODE — Indicates the orientation of the job.
•
TWOUP — Indicates whether multiple-up formats are used.
For each form you reference using the FLASH IBM JCL keyword, the
XJCFSIM FLASH table should contain a corresponding entry that
specifies, BFORM, COPIES, FORMS, PMODE, and/or TWOUP values.
The label for each table entry is a FLASH value. Numeric labels must be
preceded by a #. For example, CX02 and #10 are valid labels.
Section Two: Installing and Customizing XPAF
16-11
Additional features
For each entry in the XJCFSIM FLASH table, you can specify these
values:
Table 16-1.
XJCFSIM FLASH table entries
Value
BFORM
Description
Valid values:
form-name Name of a Xerox form to be printed on the back side of a duplex page.
NONE
COPIES
No form.
The number that indicates to which copy the forms will be applied.
For example, if you enter 3, the form will only be applied to the third copy of the
document; if you enter 25, the form will only be applied to the twenty-fifth copy.
Valid values:
0 through 255.
Default: 0 (all copies)
FORMS
Valid values:
form-name Name of a Xerox form to replace the IBM form flash.
NONE
PMODE
No form.
Valid values:
P or PORTRAIT
L or LANDSCAPE
B or BOTH
Specifying PMODE=B is equivalent to specifying PMODE=(P,L) or PMODE=(L,P).
Regardless of which value you specify in the JCL, the PMODE value in the JCL will
always match the table entry.
Default: B
TWOUP
Valid values:
Y or YES
N or NO
B or BOTH
Specifying TWOUP=B is equivalent to specifying TWOUP=(Y,N) or TWOUP=(N,Y).
Regardless of which value you specify in the JCL, the TWOUP value in the JCL will
always match the table entry.
Default: N
Section Two: Installing and Customizing XPAF
16-12
Additional features
Example:
C000
CX02
@XJCFSIM FLASH,PMODE=LANDSCAPE,TWOUP=(Y,N),FORMS=C000L
@XJCFSIM FLASH,
PMODE=LANDSCAPE,TWOUP=N,FORMS=CX02L,BFORM=NONE
@XJCFSIM FLASH,
PMODE=PORTRAIT,TWOUP=NO,FORMS=CX02P,BFORM=NONE
@XJCFSIM FLASH,
PMODE=PORTRAIT,TWOUP=YES,FORMS=CX02T,BFORM=NONE
@XJCFSIM FLASH,
PMODE=L,TWOUP=B,FORMS=CX05L,BFORM=NONE
@XJCFSIM FLASH,
PMODE=BOTH,TWOUP=NO,FORMS=CX05P,BFORM=NONE
CX02
#10
CX05
CX05
Update the XJCFSIM
MODIFY table
*
*
*
*
*
This feature simulates XJCF’s MODIFY processing. XPAF generates
DJDEs based on the values in effect for these keywords in the XJCFSIM
FORMS table, XJCFSIM CLASS table, or JCL for the job:
•
COPIES — Indicates to which copy the CME will be applied.
•
MODIFY — Names the CME to be used when printing the document.
•
PMODE — Indicates the orientation of the job.
For each CME you reference using the MODIFY IBM JCL keyword, the
XJCFSIM MODIFY table should contain a corresponding entry that
specifies COPIES, MODIFY, and PMODE values. The label for each table
entry is a MODIFY value. Numeric labels must be preceded by a #. For
example, CX03 and #5 are valid labels.
For each entry in the XJCFSIM MODIFY table, you can specify these
values:
Section Two: Installing and Customizing XPAF
16-13
Additional features
Table 16-2.
XJCF MODIFY table entries
Value
COPIES
Description
The number that indicates which copy the CME will be applied to.
For example, if you enter 3, the form will only be applied to the third copy of the document; if
you enter 25, the form will only be applied to the twenty-fifth copy.
Valid values:
0 through 255.
Default: 0 (all copies)
MODIFY
The CME to be used when printing the document.
PMODE
Valid values:
P or PORTRAIT
L or LANDSCAPE
B or BOTH
Specifying PMODE=B is equivalent to specifying PMODE=(P,L) or PMODE=(L,P). Regardless
of which value you specify in the JCL, the PMODE value in the JCL will always match the table
entry.
Default: B
Example:
C001
CX03
CX03
#5
Update the XJCFSIM FCB
table
@XJCFSIM
@XJCFSIM
@XJCFSIM
@XJCFSIM
MODIFY,MODIFY=CD03,PMODE=BOTH,COPIES=3
MODIFY,MODIFY=CG13,PMODE=P,COPIES=0
MODIFY,MODIFY=GP0D0,PMODE=L,COPIES=0
MODIFY,MODIFY=GW54,PMODE=B,COPIES=25
XPAF reads the XJCFSIM FCB table to obtain an LPI value for use in the
best-fit PDE selection. LPI values may include up to three decimal places.
XPAF will also generate DJDEs from the FCB table entry if they are
specified. These would typically be ASSIGN, TOF, BOF, and BEGIN
statements to be used instead of using the FCB itself. However, any valid
DJDE can be specified. You can specify the non-DJDE keywords DJDE,
FCB, UCS, FLASH, TWOUP, PAPERSIZE, LINECT, XIPADDR,
XLPRQNAM, and CLUSTRTB in this table. XPAF processes them as if
they were coded in the JCL but does not generate DJDE statements for
them. The label for each table entry in the XJCFSIM FCB table is an FCB
value. Numeric labels must be preceded by a #. For example, LIN6 and
#8 are valid labels.
Example:
LIN6
#8
LINA
LPI1
LPI2
@XJCFSIM FCB,LPI=6,
'BEGIN=(0.50 IN,0.50 IN),TOF=1,BOF=45,',
'ASSIGN=(1,1),ASSIGN=(12,45),'
@XJCFSIM FCB,LPI=8.1,
'BEGIN=(0.50 IN,0.50 IN),TOF=1,BOF=60,',
'ASSIGN=(1,1),ASSIGN=(12,60),'
@XJCFSIM FCB,LPI=10
@XJCFSIM FCB,LPI=11
@XJCFSIM FCB,LPI=12.125
Section Two: Installing and Customizing XPAF
*
*
*
*
16-14
Additional features
Update the XJCFSIM CHARS
table
This feature provides CHARS-to-Xerox font translation to determine
which PDE to select. During processing, XPAF determines which Xerox
font to use based on the values in effect for these keywords in the JCL for
the job:
•
•
CHARS — Identifies IBM fonts.
PMODE — Identifies the document orientation.
For each font you reference using the CHARS IBM JCL keyword, the
XJCFSIM CHARS table should contain a corresponding entry that
specifies FONTS and PMODE values. The label for each entry identifies
a CHARS value. Numeric labels must be preceded by a #. For example,
GT10 is a valid label.
Within the XJCFSIM CHARS table, you can specify these values for
PMODE:
P or PORTRAIT
L or LANDSCAPE
B or BOTH
Specifying PMODE=B is equivalent to specifying PMODE=(P,L) or
PMODE=(L,P). Regardless of which value you specify in the JCL, the
PMODE value in the JCL will always match the table entry. The default is
B.
Example:
GT10
GT10
GB10
GB10
SC10
SC10
TB10
TB10
Update the XJCFSIM PDE
table
@XJCFSIM
@XJCFSIM
@XJCFSIM
@XJCFSIM
@XJCFSIM
@XJCFSIM
@XJCFSIM
@XJCFSIM
CHARS,FONTS=L106GT,PMODE=L
CHARS,FONTS=P106GT,PMODE=P
CHARS,FONTS=L106GB,PMODE=LANDSCAPE
CHARS,FONTS=P106GB,PMODE=PORTRAIT
CHARS,FONTS=L106SC,PMODE=LANDSCAPE
CHARS,FONTS=P106SC,PMODE=PORTRAIT
CHARS,FONTS=L05TBC,PMODE=L
CHARS,FONTS=P05TBC,PMODE=P
This feature simulates XJCF’s best-fit PDE option. A PDE is always
selected unless you do not code any XJCFSIM PDE table.
XPAF selects a PDE based on the values in effect for the FONTS, LPI,
PMODE, and TWOUP keywords in the XJCFSIM PDE table. Each
keyword has a different importance in determining the best-fit PDE. The
order—from most important to least important—is as follows:
1.
2.
3.
4.
PMODE — Identifies the document orientation.
FONTS — Identifies the fonts used by the job.
LPI — Identifies the number of lines per inch.
TWOUP — Identifies either single- or multiple-up formats.
Evaluation of the FONTS keyword varies depending on whether font
indexing is being used:
•
If font indexing is being used (TRC=YES or DCB=OPTCD=J
specified in the JCL), all CHARS values are examined against all
fonts in each PDE.
•
If font indexing is not being used (TRC=YES and DCB=OPTCD=J
are not specified in the JCL), only the first CHARS value is examined
against the first font in each PDE.
Each entry in the XJCFSIM PDE table should correspond to a PDE
defined on the printer. The label for each entry identifies a PDE name.
Numeric labels must be preceded by a #. For example, L148GT is a valid
label.
Section Two: Installing and Customizing XPAF
16-15
Additional features
For each entry in the XJCFSIM PDE table, you can specify these values:
Table 16-3.
XJCFSIM PDE table entries
Value
Description
FONTS
The name or names of the fonts used by the PDE.
LPI
A lines-per-inch value of up to three decimal places.
PMODE
Valid values:
P or PORTRAIT
L or LANDSCAPE
B or BOTH
Specifying PMODE=B is equivalent to specifying PMODE=(P,L) or PMODE=(L,P).
Regardless of which value you specify in the JCL, the PMODE value in the JCL will
always match the table entry.
Default: B
TWOUP
Valid values:
Y or YES
N or NO
B or BOTH
Specifying TWOUP=B is equivalent to specifying TWOUP=(Y,N) or TWOUP=(N,Y).
Regardless of which value you specify in the JCL, the TWOUP value in the JCL will
always match the table entry.
Default: N
If no matches are found in the XJCFSIM PDE table for the
PMODE/LPI/TWOUP/ CHARS combination specified in the JCL, XPAF
uses the first PDE in the table. PDE selection processing generates a
FORMAT DJDE.
Example:
L148GT
P148GT
L106GT
L106GI
@XJCFSIM PDE,PMODE=LANDSCAPE,TWOUP=NO,LPI=8.1,
FONTS=(L146GT)
@XJCFSIM PDE,PMODE=PORTRAIT,TWOUP=NO,LPI=8.1,
FONTS=(P146GT)
@XJCFSIM PDE,PMODE=LANDSCAPE,TWOUP=B,LPI=6,
FONTS=(L106GT)
@XJCFSIM PDE,PMODE=LANDSCAPE,TWOUP=(YES,NO),
LPI=6,FONTS=(L106GI,L106GT,L106GB)
*
*
*
*
Step 3 – Assemble and link-edit XJCFSIM
Assemble and link-edit XJCFSIM into the XPAF load library.
Section Two: Installing and Customizing XPAF
16-16
Additional features
You can use the JXJCFSIM member in XPFSAMP to perform this
assembly. Modify the DD and COPY statements where necessary.
NOTE: The load module name must be XJCFSIM. If you change this
name, the module does not assemble correctly.
Section Two: Installing and Customizing XPAF
16-17
Additional features
Setting up XDS
This section describes the procedure used in setting up Xerox Direct Print
Services (XDS). It also explains the different options you can select when
initializing XDS.
Pre-setup considerations for XDS
The information in this section will help you make setup decisions for the
XDS subsystem. Read the information and decide how you want to handle
these considerations before you set up XDS.
Setup materials
Your sample source library contains these members which are used for
setting up XDS:
XDSCOPY
XDSMCS
XDSSETUP
Contains sample JCL to copy all XDS modules from the user-installed
XPFLOAD library to the user-defined LNKLST library.
Contains the XUMXDS1 usermod, which is called by XDSSETUP to move
all XDS modules to a separate dataset. It also reestablishes JCLIN for all
XDS XOSF members.
Contains sample JCL for:
•
Allocating the XDSLOAD library dataset
•
Adding the DDDEF to the SMPCSI target and distribution zones for
XDSLOAD
•
Receiving and applying the XUMXDS1 usermod
•
Using UCLIN to change the SYSLIB entry in the CSI distribution
library for XDS mods from XPFLOAD to XDSLOAD
XDSSTART
Contains a sample proc used to start XDS.
XDSSTOP
Contains a sample proc used to stop XDS.
XDS subset
The XDS subsystem performs all functions of XDS. You may, however,
elect to use a subset of XDS which performs only JCL syntax checking of
the SUBSYS parameter and uses no XOSF overhead. Use this XDS
subset in a multiple CPU environment to submit print jobs from one CPU
to another CPU with the specified printer attached.
If you use the XDS subset, you will need another copy of the full XDS
subsystem running on the CPU to which the print jobs are sent. This CPU
must have the printer attached to it.
Figure 10-1 illustrates a multiple processor environment with a different
version of XDS installed for each processor.
Section Two: Installing and Customizing XPAF
16-18
Additional features
Figure 16-1. Multiple processor environment for XDS
XDS initialization options
You can initialize XDS in one of these ways:
Automatically, by the Master Scheduler at IPL, before JES is started
Automatically, by z/OS at IPL, after JES is started
Manually by issuing the z/OS START operator command
NOTE: You must initialize the XDS subsystem before you can submit
any job using XDS.
Complete the following checklist for any XDS initialization option.
Section Two: Installing and Customizing XPAF
16-19
Additional features
Checklist for setting up XDS
To set up XDS initialization, you must perform these steps in the order
that they are listed. As each step is completed, enter a check in the
Completed column to track and record your progress.
Step
Action
1
Modify XDSSETUP
2
Submit XDSSETUP
3
Create a start-up proc
4
Modify the SYS1.PARMLIB members
A
Update the IEFSSNxx member
B
Update the COMMNDxx member
C
Authorize the XDSLOAD library
5
Define XDSSSTART and XDSSTOP
6
Define initialization parameters
7
Define the printer profiles
8
Perform an IPL
9
Verify the installation
Completed
Step 1 – Modify XDSSETUP
Change the variables in the XDSSETUP sample JCL to reflect your
user-defined qualifiers. Each of the required changes is marked “<==
CHANGE” in the XDSSETUP sample JCL.
Step 2 – Submit XDSSETUP
Submit the job XDSSETUP. When this job finishes, all modules required
for XDS will reside in the libraries you specified in the job JCL.
Section Two: Installing and Customizing XPAF
16-20
Additional features
Step 3 – Create a start-up proc
To use the XDS subsystem, you must create a start-up proc for this
XOSF. Use the sample proc STAGE2(XOSF00) as a base, then follow
these guidelines for the start-up proc:
NOTE: The name you specify for this XOSF FSS must be unique and
not used for any other XOSF FSS
Later in these procedures you will be allocating a new XINPARM library
with a unique name. Decide now on the XINPARM library name. Include
a DD statement in this XOSF start-up proc that names this new XINPARM
library.
If you are setting up XDS to be initialized before JES is started:
1.
Place the XOSF start-up proc in SYS1.PROCLIB.
2.
Be sure there are no SYSOUT statements in the XOSF start-up
proc.
3.
Be sure all dataset names in the XOSF start-up proc have a high
level qualifier that is cataloged in the Master Catalog.
4.
For non-VSAM datasets, make sure the DD statement in the
XOSF start-up proc specifies the UNIT and VOLSER.
5.
If you are setting up XDS to be initialized after JES is started,
place the XOSF start-up proc in a JES-controlled proclib.
Step 4 – Modify the SYS1.PARMLIB members
These steps describe how to update specific members of
SYS1.PARMLIB.
Step 4A – Update the IEFSSNxx member
Add the XOSF start-up proc name to the SYS1.PARMLIB(IEFSSNxx)FSS
list. Follow these guidelines:
•
If you are using all functions of XDS, include these parameters:
xds-name,XDSINITS,character
where
xds-name
The 4-character XDS subsystem name. It must be the
same as the name of the XOSF start-up proc you
created in SYS1.PROCLIB.
XDSINITS
The name of the XDS initialization routine used by XDS
for the full subsystem. XDSINITS resides in the z/OS
LNKLST library where XDS was loaded. Specify this
parameter only if you are setting up XDS to start before
JES is started.
Section Two: Installing and Customizing XPAF
16-21
Additional features
character
•
Your optional subsystem command character. Specify
this parameter only if you are setting up XDS to start
before JES is started.
If you are using only the JCL syntax checking function of XDS, use
these parameters:
xds-name,XDSINITJ
where
xds-name
The 4-character XDS subsystem name. It must be the
same as the name of the XOSF start-up proc you
created in SYS1.PROCLIB.
XDSINITJ
The name of the XDS initialization routine used by XDS
for the partial subsystem which does JCL syntax
checking only. XDSINITJ resides in the z/OS LNKLST
library where XDS was loaded.
Step 4B – Update the COMMNDxx member
If you are setting up XDS to start automatically after JES is started, add
this command statement to the member SYS1.PARMLIB(COMMNDxx):
COM='START XDSSTART'
Step 4C – Authorize the XDSLOAD library
To authorize the XDSLOAD library for use by XDS, perform these steps:
Add the XDSLOAD library to the z/OS link list,
SYS1.PARMLIB(LNKLSTxx).
Authorize the XDSLOAD library by adding it to
SYS1.PARMLIB(IEAAPFxx).
Step 5 – Define XDSSTART and XDSSTOP
To define the XDSSTART start-up proc, the XDSSTOP abend recovery
proc, and the command character for XDS, perform these steps:
1.
Copy these members to a JES-controlled proclib:
XDSSTART
XDSSTOP
2.
Modify the PARM parameter on the EXEC statement for the
XDSSTART proc to read:
//XDSSTART EXEC PGM=XDSSTART,
PARM='xds-name,character '
where
xds-name
The 4-character XDS subsystem name. It must be the
same as the name of the XOSF start-up proc you
created in SYS1.PROCLIB, and the name of the XOSF
FSS you specified in SYS1.PARMLIB(IEFSSNxx).
Section Two: Installing and Customizing XPAF
16-22
Additional features
character
3.
The optional subsystem command character. Be sure
the character you choose is not used for any other
subsystem command character.
Modify the PARM parameter on the EXEC statement for the
XDSSTOP proc to read:
//XDSSTOP EXEC PGM=XDSSTOP,PARM=xds-name
where xds-name is the 4-character XDS subsystem name. This must be
the same as the name of the XOSF start-up proc you created in
SYS1.PROCLIB, and the name of the XOSF FSS you specified in
SYS1.PARMLIB(IEFSSNxx).
Step 6 – Define initialization parameters
Define the initialization parameters for the XDS subsystem interface by
modifying your existing XINPARM library. If you do not have an existing
XINPARM library, you must allocate one with a unique name, then modify
it with these parameters:
1.
Add this parameter and its value to the XINSXOAF member in the
XINPARM library:
COMSSTYP=DIRECT
2.
Add these parameters and their values to the XINSXOSF member in
the new XINPARM library:
COMSSID=subsys-name,
COMSSTYP=DIRECT,
SUBSYS=subsys-name,
XLOGDSN=dataset-name,
ALOGDSN=dataset-name (optional)
The values for COMSSID and SUBSYS must be identical. They are the
same as the name of the XOSF start-up proc you created in
SYS1.PROCLIB, and the name of the XOSF FSS you specified in
SYS1.PARMLIB(IEFSSNxx).
NOTE: XDS only supports an SWA below the 16M line. For JES2
systems, specify SWA=BELOW in the JOBCLASS initialization
parameter. For JES3 systems, select option 0, 1, 2, or 3 in the
CIPARM initialization parameter to indicate an SWA below the 16M
line.
Step 7 – Define the printer profiles
Define a printer profile for each printer to be used with XDS. For
instructions on creating your printer profiles, refer to “Setting up printer
profiles” in chapter 5, “Customizing your system.”
Section Two: Installing and Customizing XPAF
16-23
Additional features
Step 8 – Perform an IPL
Perform an IPL to complete XDS setup. An IPL will:
•
•
•
Authorize required XDS and XOSF libraries
Update the z/OS link list
Update the Subsystem Name Table
Step 9 – Verify the installation
You can verify the accuracy of your software installation by performing an
IVP. For more information about performing an IVP, refer to chapter 18,
“Performing an installation verification procedure.”
Section Two: Installing and Customizing XPAF
16-24
Additional features
Connection to FTP servers/websites
You can set up XPAF to use batch LPR to FTP documents to your FTP
server or website. Refer to Setting up BATCH FTP for more information.
Setting up BATCH FTP
To use batch LPR to FTP documents to your server, you must first edit
your PDF printer definition as follows:
DEVICE=PDF,
IPADDR=13.245.113.77, Only required if used by FTP JCL/REXX
LPRQNAME=PASSTHRU,
Only required if used by FTP JCL/REXX
TCPMODE=LPR,
LPRDSN=MJONES.LPRJCL, Dataset containing skeleton JCL
LPRJCL=XTCPFTP
Skeleton JCL member (to invoke REXX FTPXPAF)
Review the sample skeleton JCL member XTCPFTP in XPFSAMP and the
sample REXX FTPXPAF. The XTCPFTP JCL is configured to execute the
REXX FTPXPAF.
Step 1.
Copy the XTCPFTP member from XPFSAMP into the dataset specified by
the LPRJCL parameter in your printer definition.
Step 2.
Copy the FTPXPAF member from XPFSAMP into the REXX library
referenced by your modified XTCPFTP skeleton JCL.
Step 3.
Review the parameters passed by XTCPFTP to the REXX. XTCPFTP
uses the XPAF variable substitution to replace keywords in the skeleton
JCL with document specific information.
NOTE: If you change the parameters passed to the REXX invoked by
the skeleton JCL, you must also modify the REXX accordingly.
Variable substitution occurs when using the following information in
XTCPFTP
Section Two: Installing and Customizing XPAF
16-25
Additional features
Variable
Description
%FORMNAME
The JES FORM name used to process the document. I.e. STD1
%STEPNAME
The job step name i.e. PRTSTEP
%ACCOUNT
The account number used to print the job i.e. D498
%JOBNAME
The JES job name i.e. HWMPRTAC
%PRINTER
The XPAF/JES printer name i.e. PRT123
%STEPDDN
The job step ddname i.e SYSUT1
%USERAC1
User variable extended JCL field
%USERAC2
User variable extended JCL field
%USERAC3
User variable extended JCL field
%DEVICE
The printer device from the XPAF PPT i.e. N32
%IPADDR
The IP address the document i.e 192.64.0.1
%IPADDZ
The default IP address from the XPAF printer profile i.e 192.64.0.4
%LPRDSN
The name of the XPAF created temporary LPR dataset
%JOBNO
The JES job number
%LINES
The number of records in the dataset
%PAGES
The number of pages in the dataset
%QNAME
The name of the LPR queue the document will be sent to
%QNAMZ
The name of the default LPR queue in the XPAF printer profile
%PORT
The name of the IP port number the document will be sent to
%PORZ
The name of the default IP port number in the XPAF printer profile
%USER
The user name of the account that submitted the job
Advanced users of this feature can use most of the fields defined in the
following XPAF macros:
•
Document Information Block, member @XDIB in SAMPMAC
•
Printer Profile Table, member @XXQPPT in SAMPMAC
•
Output Data Block, member @XODB in SAMPMAC
•
XDIB DJDE extension, member @XDJD in SAMPMAC
Section Two: Installing and Customizing XPAF
16-26
Additional features
Review the macros supplied in the sample macro library and use a '%'
followed by the field name.
For example, the JES output class is held in the XDIB in field XDIBSOCL.
To use the sysout class as a variable field in the XTCPFTP skeleton JCL
use the %XDIBSOCL keyword.
Section Two: Installing and Customizing XPAF
16-27
Additional features
Support for Emtex V-Services print servers
XPAF supports the Emtex V-Services print server as a printer type. In this
environment, XPAF is only a host and, as such, does no data conditioning
or transform of the data. XPAF will only receive the data file and send it
to the Emtex server. There is no communication from the server as to the
successful printing of the document. It is the users responsibility to make
sure all resources (AFP and LCDS) are available on the Emtex V-Services
print server prior to printing a document.
Defining the V-Services printer
The V-Services printer is defined in the XOSF printer profile. The printer
profile should include the following parameters:
DEVICE=VSERV,
IPADDR=ipaddr/host-name,
TCPMODE=tcpmode,
WRITER=REMOTE
The TCPMODE value can be one of the following: LPR, TCPLPR, or
TCPIP.
For TCPMODE=TCPIP, you must also specify TCPPORT= to identify the
port number that has been defined in the TCPIP connection profile on the
V-Services server.
For TCPMODE=LPR or TCPLPR, two additional keywords are provided to
allow XOSF to direct AFPA or LCDS data streams to the correct LPR
Queue on the V-Services Server:
AFPAQNAME
LCDSQNAME
AFPAQNAME defines the connection profile name on the V-Services
server that will receive AFPA data streams via LPR.
LCDSQNAME defines the connection profile name on the V-Services
server that will receive LCDS data streams via LPR.
These Queue Names must be defined on the XPAF V-Services server as
connection profile names.
Syntax:
LCDSQNAME=queue-name
AFPAQNAME=queue-name
where
queue-name is the 1- to 50-character queue name on this printer. The
queue name can include alphanumeric, national ($, #, @), or special
characters.
NOTE: Spaces are not valid characters within a queue name.
Default:
Examples:
None
LCDSQNAME=LCDSData
AFPAQNAME=AFPAData
Section Two: Installing and Customizing XPAF
16-28
Additional features
Overrides:
Related info:
None
See also the IPADDR, LPRBNDRY, LPRDSN, LPRJCL and TCPMODE
printer profile parameters for information on setting up your system for
TCP batch printing.
A Sample connection profile for use on the Emtex Server follows:
//CONNECT.CFG
//----------CLIENTTYPE=IPCCLN_CONNECT
SUBMITONHOLD=NO
//CONNECT DOWNLOAD PARAMETERS//
ENABLE_DOWNLOAD=YES
DOWNLOADPORT=9501
DOWNLOAD_PROFILE_NAME=XPAFAFPA
DEBUGMODE=0
//CONNECT LPD PARAMETERS//
ENABLE_LPD=YES
DATAPATH=USERPATH:\CONNECT\DTA
CONTROLPATH=USERPATH:\LPD
LPDQUEUEASOUTPUT=YES
A Sample printer profile called N40 the Emtex Server follows:
//N40.PRF
//------COPIES=1
DATATYPE=DISK
DEFAULTVIRTUALFONT=P06BOB
DEFAULT_COLOUR=BLACK
DISABLEOTEXTWAIT=YES
HOSTFORM=STD
INPUT=XRX2VDD
OUTPUT=VDD2PCL4
JDE=LETTER
JDL=DFAULT
OPRINFO=BOTH
OUTPUTPAPERSIZE=USLETTER
PREPROCESSDATATYPE=VARIABLE
PREPROCESSPCCTYPE=MACHINE
PREPROCESSPCCCOL=3
PREPROCESSDATACOL=4
PREPROCESSRECLTHFLD=2
REPORTSPLIT=BOTH
SEPCOUNT=1
SET=C:\VIPUSER\SET\USLETTER.SET
TYPE=XEROX
VIPFILE=XPAFLCDS
Section Two: Installing and Customizing XPAF
16-29
Additional features
Section Two: Installing and Customizing XPAF
16-30
Performing an installation verification procedure
17.
17
Performing an installation verification
procedure
On your installation file, you received programs to perform installation
verification procedures (IVPs) for:
•
•
•
The complete XPAF product
The CMA-SPOOL or CA-SPOOL subsystem
The XDS subsystem
The procedures consist of a series of jobs designed to validate your XPAF
installation, CMA-SPOOL or CA-SPOOL setup, and/or XDS setup.
Running the XPAF IVP
The XPAF IVP executes XOAF and XOSF functions to ensure that the
installation was successful. You can run the XPAF IVP through XOAF or
through batch jobs.
Running the CMA-SPOOL or CA-SPOOL IVP
The CMA-SPOOL or CA-SPOOL IVP executes XOSF functions only. You
can run these IVPs through XOAF. However, these IVPs cannot be run
through the IVP batch jobs supplied with XPAF.
Before you access XOAF to run the CMA-SPOOL or CA-SPOOL IVP, be
sure you have specified COMSSTYP=CMASPOOL in both the XINSXOAF
and XINSXOSF members o‘f XINPARM.
Running the XDS IVP
The XDS IVP executes XOSF functions only. You can run the XDS IVP
through XOAF. The XDS IVP cannot be run through the IVP batch jobs
supplied with XPAF.
Before you access XOAF to run the XDS IVP, be sure you have specified
COMSSTYP=DIRECT in both the XINSXOAF and XINSXOSF members
of XINPARM you created for XDS.
Section Two: Installing and Customizing XPAF
17-1
Performing an installation verification procedure
What does the IVP test?
The IVP tests to ensure your installation successfully generated all
components needed for XOAF and/or XOSF processing.
XOAF testing
When you select XOAF batch processing, XPAF generates a batch job
that loads a resource to a native library, then performs an LDM library
directory display for that library.
XOSF testing
The XOSF IVP jobs generate centralized and decentralized documents
using the resources prepared during XOAF installation.
•
To verify centralized printer processing, run the line-mode, DJDE,
page-formatted, and AFP IVPs.
•
To verify decentralized and PCL-capable printer processing, run the
line-mode, DJDE, XES, page-formatted, AFP, and pass-through
IVPs.
XPAF extended JCL testing
The DJDE, page-formatted, and AFP IVP jobs test XPAF extended JCL.
If you have not installed XPAF extended JCL on your system, you can
only run the line-mode IVP job.
Section Two: Installing and Customizing XPAF
17-2
Performing an installation verification procedure
Setup requirements
Before you execute the IVPs, ensure that you have installed the
necessary hardware and made the appropriate resources available to
XPAF.
Resources
To generate the expected results, use the DFAULT JSL provided with
XPAF in XPFSAMP.
Printer profile parameter settings
The resources for native Xerox IVP jobs are distributed in centralized
resource libraries. If you have changed the values for the SFONTLIB,
SFORMLIB, and SIMAGELIB printer profile parameters from their default
settings, you must change them back to SFONTLIB=CFONTLIB,
SFORMLIB=CFORMLIB and SIMAGELIB=CIMGLIB to print the IVPs
successfully.
Printing the line-mode IVP on PCL-capable printers
Before you print the line-mode IVP on a PCL-capable printer, verify that
the default font on the printer is a 6-point landscape font similar to L0112B
or XCP14-L.
Using a custom DJDE IDEN
The DJDE IVP uses the XPAF system default DJDE IDEN. To use a
different DJDE IDEN, you should run the IVPs before loading your
customized JSL to the host.
Printing the DJDE IVP on PCL-capable printers
When printing the DJDE IVP to a decentralized or PCL-capable printer,
the centralized images used for this IVP are converted to decentralized
format. An information message is issued but can be ignored.
Section Two: Installing and Customizing XPAF
17-3
Performing an installation verification procedure
Printing the AFP IVP
Before you verify AFP processing, be sure to:
•
Allocate IBM AFP resource libraries to XOSF. Refer to “Step 3 –
Update the system procedure library” in chapter 5, “Customizing
your system” for detailed information.
•
Ensure Sonoran Serif character set T05500 (medium, normal, 10
point) is available to your XPAF system.
•
Make the AFP resources in IVPRESC available to XOSF using one
of these methods:
—
Add IVPRESC to the XOSF start-up proc concatenation for the
PDEFLIB (page definition), FDEFLIB (form definition), and
OVERLIB (overlay) libraries.
—
Copy members from IVPRESC to the installation AFP resource
libraries you have assigned to PDEFLIB, FDEFLIB, and
OVERLIB. Copy the members with prefix P1 to PDEFLIB, F1 to
FDEFLIB, and O1 to OVERLIB.
Printing the IVPs on A4 paper
To print the IVPs on A4 paper, you must specify OPTIONS=A4 in the
#GENRSC installation macro before generating stage 2 jobs for resource
installation.
Section Two: Installing and Customizing XPAF
17-4
Performing an installation verification procedure
Executing the XPAF IVP
You can execute the XPAF IVPs using either of these options:
•
•
Batch jobs
XOAF
IVP batch jobs
IVP batch jobs are generated only if you specify YES and a print output
class in the IVP parameter of the #GENRSC macro. Refer to “Installation
service macro worksheets,” for a description of the RSCIVP parameter
and its values.
Submit the IVP job for the particular IVP you want to perform:
•
IVPJOB01: Verifies XOAF batch processing
•
IVPJOB02: Verifies line-mode processing
•
IVPJOB03: Verifies DJDE and extended JCL processing
•
IVPJOB04: Verifies XES processing
•
IVPJOB05: Verifies page-format and extended JCL processing
•
IVPJOB06: Verifies AFP and extended JCL processing
•
IVPJOB07: Verifies pass-through processing
Successful execution of each IVP job is indicated by a return code of 00
with no error messages.
Section Two: Installing and Customizing XPAF
17-5
Performing an installation verification procedure
XOAF IVP option
To execute IVPs from XOAF, enter I at the System Services menu
OPTION line and press ENTER. This panel appears:
Xerox Output Administrative Facility
Installation Verification Procedure
OPTION ===>
1..
2.
3.
4.
Verify
Verify
Verify
Verify
XOAF Batch Processing
Line Mode Processing
DJDE/Extended JCL Processing
XES Processing
SYSOUT Class:
5. Verify Page Format Processing
6. Verify AFP Processing
7. Verify Pass-Through Processing
Using A4 Paper? (Y/N):
DATASET PREFIX
XPFLOAD Library:
XINPARM Library:
Resource Libraries:
JOB CARD INFORMATION:
===> //JOBNAME JOB (ACCOUNT),'NAME',CLASS=A
===> //*
===> //*
===> //*
Use this panel to complete these fields:
Field
OPTION
Description
Select the type of processing you want to perform.
Valid values:
SYSOUT Class
1
Loads a form to the centralized form library, then performs an LDM
library directory display for that library.
2
Tests line-mode processing.
3
Tests DJDE and extended JCL processing.
4
Tests XES processing.
5
Tests page-formatted and extended JCL processing.
6
Tests AFP and extended JCL processing.
7
Tests pass-through document processing.
For XPAF IVP testing only. Enter your job SYSOUT class (centralized or
decentralized printer). If you select option 4 (Verify XES Processing), you must
enter the SYSOUT class for a PCL-capable printer or PDF device printer.
Section Two: Installing and Customizing XPAF
17-6
Performing an installation verification procedure
Field
Description
Using A4 Paper?
Indicate whether you are printing the IVP jobs on 8.5 by 11 inch or A4 paper.
Valid values:
Y
N
Indicates the paper size is A4.
Indicates the paper size is 8.5 by 11 inches.
NOTE: When using the option to print the DJDE IVP with extended JCL, the
output for letter size and A4 paper is not identical. Text may be shifted
slightly when it is printed on A4 paper.
DATASET PREFIX
Enter the high-level and mid-level qualifiers for your system load library.
XPFLOAD Library
XINPARM Library
Enter the high-level and mid-level qualifiers for the library containing your
initialization parameters.
Resource
Libraries
Enter the high-level and mid-level qualifiers for your resource libraries, if
different from your XPFLOAD library.
JOB CARD
INFORMATION
Enter your standard JCL job card information.
Press ENTER, and the second IVP panel appears:
Xerox Output Administrative Facility
Installation Verification Procedure
OPTION ===>
C. Cancel
JCL
E. Edit
JCL
K. Keep
JCL
S. Submit
JCL
On this panel, select the option you want to use and press ENTER. Valid
values are:
C
Cancels the generated JCL and returns to the initial Installation
Verification Procedure panel.
E
Displays the generated JCL for editing purposes.
Section Two: Installing and Customizing XPAF
17-7
Performing an installation verification procedure
K
Keeps the generated JCL in a sequential dataset. After you save
the JCL, you can access this dataset and submit the job without
regenerating the JCL each time.
S
Submits the JCL. Standard TSO/ISPF JCL submission error or
confirmation messages are displayed.
NOTE: You cannot use the END command or the PF3 key to exit this
panel. If you want to return to the previous panel and do not want to
display, submit or keep the JCL, you must enter C on the COMMAND
line and press ENTER.
Editing the JCL
If you enter E in the OPTION field on the JCL options panel, a panel the
similar to this appears:
//job-name JOB job-information
//*
//*
//*
//********************************************************************************//
//*
INSTALLATION VERIFICATION PROCEDURE - XOAJ1810
*//
//*
*//
//********************************************************************************//
//*
//XOAFBAT PROC
//XOAF
EXEC PGM=XOASUP00,REGION=1024K,PARM=(userid)
//STEPLIB DD
DISP=SHR,DSN=xpfload-library-name
//TABLELIB DD
DISP=SHR,DSN=font-table—library-name
//XINPARM DD
DISP=SHR,DSN=xinparm-library-name
//UJLLIST DD
SYSOUT=*,DCB=(RECFM=FBA,LRECL=133,BLKSIZE=1330)
//XOAPRINT DD
SYSOUT=*,DCB=(LRECL=121,RECFM=FB,BLKSIZE=6050)
//XOAIN
DD
DDNAME=SYSIN
//*
// PEND
//*
//S1
EXEC XOAFBAT
LOAD FORM('resource-library-name.IVPXOAF(DJ3F)')
('resource-library-name.CFORMLIB(DJ3F)') CENT
//*
//S2
EXEC XOAFBAT
LIB DIR('resource-library-name.CFORMLIB')
//*
You can edit and save the JCL and cancel or submit the job using
standard TSO/ISPF commands.
Section Two: Installing and Customizing XPAF
17-8
Performing an installation verification procedure
Keeping the JCL
If you enter K in the OPTION field on the JCL options panel, this panel
appears:
Xerox Output Administrative Facility
Installation Verification Procedure
COMMAND ===>
* To keep the JCL, enter a new sequential dataset name.
Dataset Name:
Use this panel to complete this field and press ENTER:
Field
Action
Dataset Name
Enter the name of the sequential dataset that is not currently cataloged. This is
the dataset in which your JCL will be stored.
To return to the previous panel, enter END and press ENTER.
Section Two: Installing and Customizing XPAF
17-9
Performing an installation verification procedure
Executing the CMA-SPOOL or CA-SPOOL IVP
To execute the CMA-SPOOL or CA-SPOOL IVPs, enter I on the System
Services menu OPTION line and press ENTER. This panel appears:
Xerox Output Administrative Facility
Installation Verification Procedure
OPTION ===>
1.
2.
3.
4.
Verify
Verify
Verify
Verify
XOAF Batch Processing
5. Verify Page Format Processing
Line Mode Processing
6. Verify AFP Processing
DJDE/Extended JCL Processing 7. Verify Pass-Through Processing
XES Processing
Subsystem:
Using A4 Paper? (Y/N):
DATASET PREFIX
XPFLOAD Library:
XINPARM Library:
Resource Libraries:
JOB CARD INFORMATION:
===> //JOBNAME JOB (ACCOUNT),'NAME',CLASS=A
===> //*
===> //*
===> //*
Use this panel to complete these fields:
Section Two: Installing and Customizing XPAF
17-10
Performing an installation verification procedure
Field
OPTION
Description
Select the type of processing you want to perform.
Valid values:
Subsystem
1
Loads a form to the centralized form library, then performs an LDM
library directory display for that library.
2
Tests line-mode processing.
3
Tests DJDE and extended JCL processing.
4
Tests XES processing.
5
Tests page-formatted and extended JCL processing.
6
Tests AFP and extended JCL processing.
7
Tests pass-through document processing.
Enter these parameters:
(subsys-name,class,,printer-name)
where
subsys-name
The 1- to 4-character subsystem name as defined in the
COMSSID parameter in the XINSXOSF member in
XINPARM you created for CMA-SPOOL or CA-SPOOL.
class
The 1-character output class defined for the CMA-SPOOL
or CA-SPOOL printer.
printer-name
The name of the printer to be used. The printer name must
be defined in the printer profile library. If you select option
2, Verify XES processing, you must specify a
decentralized printer.
Example:
SUBSYSTEM = (ESF,5,,PRT1652)
Using A4 Paper?
Indicate whether you are printing the IVP jobs on 8.5 by 11 inch or A4 paper.
Valid values:
Y
N
Indicates the paper size is A4.
Indicates the paper size is 8.5 by 11 inches.
NOTE: When using the option to print the DJDE IVP with extended JCL, the
output for letter size and A4 paper is not identical. Text may be shifted
slightly when it is printed on A4 paper.
DATASET PREFIX
Enter the high-level and mid-level qualifiers for your system load library.
XPFLOAD Library
XINPARM Library
Enter the high-level and mid-level qualifiers for the library containing your
initialization parameters.
Section Two: Installing and Customizing XPAF
17-11
Performing an installation verification procedure
Field
Description
Resource
Libraries
Enter the high-level and mid-level qualifiers for your resource libraries, if
different from your XPFLOAD library.
JOB CARD
INFORMATION
Enter your standard JCL job card information.
Press ENTER, and the second IVP panel appears:
Xerox Output Administrative Facility
Installation Verification Procedure
OPTION ===>
C. Cancel
JCL
E. Edit
JCL
K. Keep
JCL
S. Submit
JCL
On this panel, select the option you want to use and press ENTER. Valid
values are:
C
Cancels the generated JCL and returns to the initial Installation
Verification Procedure panel.
E
Displays the generated JCL for editing purposes.
K
Keeps the generated JCL in a sequential dataset. After you save
the JCL, you can access this dataset and submit the job without
regenerating the JCL each time.
S
Submits the JCL. Standard TSO/ISPF JCL submission error or
confirmation messages are displayed.
NOTE: You cannot use the END command or the PF3 key to exit this
panel. If you want to return to the previous panel and do not want to
display, submit or keep the JCL, you must enter C on the COMMAND
line and press ENTER.
Section Two: Installing and Customizing XPAF
17-12
Performing an installation verification procedure
Editing the JCL
If you enter E in the OPTION field on the JCL options panel, a panel the
similar to this appears:
//job-name JOB job-information
//*
//*
//*
//********************************************************************************//
//*
INSTALLATION VERIFICATION PROCEDURE - XOAJ1810
*//
//*
*//
//********************************************************************************//
//*
//XOAFBAT PROC
//XOAF
EXEC PGM=XOASUP00,REGION=1024K,PARM=(userid)
//STEPLIB DD
DISP=SHR,DSN=xpfload-library-name
//TABLELIB DD
DISP=SHR,DSN=font-table—library-name
//XINPARM DD
DISP=SHR,DSN=xinparm-library-name
//UJLLIST DD
SYSOUT=*,DCB=(RECFM=FBA,LRECL=133,BLKSIZE=1330)
//XOAPRINT DD
SYSOUT=*,DCB=(LRECL=121,RECFM=FB,BLKSIZE=6050)
//XOAIN
DD
DDNAME=SYSIN
//*
// PEND
//*
//S1
EXEC XOAFBAT
LOAD FORM('resource-library-name.IVPXOAF(DJ3F)')
('resource-library-name.CFORMLIB(DJ3F)') CENT
//*
//S2
EXEC XOAFBAT
LIB DIR('resource-library-name.CFORMLIB')
//*
You can edit and save the JCL and cancel or submit the job using
standard TSO/ISPF commands.
Section Two: Installing and Customizing XPAF
17-13
Performing an installation verification procedure
Keeping the JCL
If you enter K in the OPTION field on the JCL options panel, this panel
appears:
Xerox Output Administrative Facility
Installation Verification Procedure
COMMAND
===>
* To keep the JCL, enter a new sequential dataset name.
Dataset Name:
Use this panel to complete this field and press ENTER:
Field
Action
Dataset Name
Enter the name of the sequential dataset that is not currently cataloged. This is
the dataset in which your JCL will be stored.
To return to the previous panel, enter END and press ENTER.
Section Two: Installing and Customizing XPAF
17-14
Performing an installation verification procedure
Executing the XDS IVP
Before you execute the XDS IVPs, be sure XDS is initialized.
NOTE: To ensure proper execution of the IVPs, submit each IVP job
separately. Also, you must manually schedule the jobs.
To execute the XDS IVPs, enter I on the System Services panel OPTION
line and press ENTER. This panel appears:
Xerox Output Administrative Facility
Installation Verification Procedure
OPTION ===>
1.
2.
3.
4.
Verify
Verify
Verify
Verify
XOAF Batch Processing
Line Mode Processing
DJDE/Extended JCL Processing
XES Processing
Subsystem:
5. Verify Page Format Processing
6. Verify AFP Processing
7. Verify Pass-Through Processing
Using A4 Paper? (Y/N):
DATASET PREFIX
XPFLOAD Library:
XINPARM Library:
Resource Libraries:
JOB CARD INFORMATION:
===> //JOBNAME JOB (ACCOUNT),'NAME',CLASS=A
===> //*
===> //*
===> //*
Use this panel to complete these fields:
Section Two: Installing and Customizing XPAF
17-15
Performing an installation verification procedure
Field
OPTION
Description
Select the type of processing you want to perform.
Valid values:
Subsystem
1
Loads a form to the centralized form library, then performs an LDM
library directory display for that library.
2
Tests line-mode processing.
3
Tests DJDE and extended JCL processing.
4
Tests XES processing.
5
Tests page-formatted and extended JCL processing.
6
Tests AFP and extended JCL processing.
7
Tests pass-through document processing.
Enter these parameters:
(xds-name,printer-name,'SEP=x')
where
xds-name
The 4-character XDS subsystem name as defined in the
SUBSYS parameter in the XINSXOSF member of
XINPARM you created for XDS.
printer-name
The name of the printer to be used. The printer name must
be defined in the XOSF printer profile library. If you select
option 2, Verify XES processing, you must specify a
decentralized printer.
x
One of these values:
J
Produces job header and trailer pages.
D
Produces dataset separator pages.
JD Produces both job header and trailer pages and
dataset separator pages.
N
Produces no separator pages.
Default: N
Example:
SUBSYSTEM = (XOSF,PRT1652,'SEP=J')
Using A4 Paper?
Indicate whether you are printing the IVP jobs on 8.5 by 11 inch or A4 paper.
Valid values:
Y
N
Indicates the paper size is A4.
Indicates the paper size is 8.5 by 11 inches.
NOTE: When using the option to print the DJDE IVP with extended JCL, the
output for letter size and A4 paper is not identical. Text may be shifted
slightly when it is printed on A4 paper.
Section Two: Installing and Customizing XPAF
17-16
Performing an installation verification procedure
Field
Description
DATASET PREFIX
Enter the high-level and mid-level qualifiers for your system load library.
XPFLOAD Library
XINPARM Library
Enter the high-level and mid-level qualifiers for the library containing your
initialization parameters.
Resource
Libraries
Enter the high-level and mid-level qualifiers for your resource libraries, if
different from your XPFLOAD library.
JOB CARD
INFORMATION
Enter your standard JCL job card information.
Press ENTER, and the second IVP panel appears:
Xerox Output Administrative Facility
Installation Verification Procedure
OPTION ===>
C. Cancel
JCL
E. Edit
JCL
K. Keep
JCL
S. Submit
JCL
On this panel, select the option you want to use and press ENTER. Valid
values are:
C
Cancels the generated JCL and returns to the initial Installation
Verification Procedure panel.
E
Displays the generated JCL for editing purposes.
K
Keeps the generated JCL in a sequential dataset. After you save
the JCL, you can access this dataset and submit the job without
regenerating the JCL each time.
S
Submits the JCL. Standard TSO/ISPF JCL submission error or
confirmation messages are displayed.
NOTE: You cannot use the END command or the PF3 key to exit this
panel. If you want to return to the previous panel and do not want to
display, submit or keep the JCL, you must enter C on the COMMAND
line and press ENTER.
Section Two: Installing and Customizing XPAF
17-17
Performing an installation verification procedure
Editing the JCL
If you enter E in the OPTION field on the JCL options panel, a panel the
similar to this appears:
//job-name JOB job-information
//*
//*
//*
//********************************************************************************//
//*
INSTALLATION VERIFICATION PROCEDURE - XOAJ1810
*//
//*
*//
//********************************************************************************//
//*
//XOAFBAT PROC
//XOAF
EXEC PGM=XOASUP00,REGION=1024K,PARM=(userid)
//STEPLIB DD
DISP=SHR,DSN=xpfload-library-name
//TABLELIB DD
DISP=SHR,DSN=font-table—library-name
//XINPARM DD
DISP=SHR,DSN=xinparm-library-name
//UJLLIST DD
SYSOUT=*,DCB=(RECFM=FBA,LRECL=133,BLKSIZE=1330)
//XOAPRINT DD
SYSOUT=*,DCB=(LRECL=121,RECFM=FB,BLKSIZE=6050)
//XOAIN
DD
DDNAME=SYSIN
//*
// PEND
//*
//S1
EXEC XOAFBAT
LOAD FORM('resource-library-name.IVPXOAF(DJ3F)')
('resource-library-name.CFORMLIB(DJ3F)') CENT
//*
//S2
EXEC XOAFBAT
LIB DIR('resource-library-name.CFORMLIB')
//*
You can edit and save the JCL and cancel or submit the job using
standard TSO/ISPF commands.
Section Two: Installing and Customizing XPAF
17-18
Performing an installation verification procedure
Keeping the JCL
If you enter K in the OPTION field on the JCL options panel, this panel
appears:
Xerox Output Administrative Facility
Installation Verification Procedure
COMMAND
===>
* To keep the JCL, enter a new sequential dataset name.
Dataset Name:
Use this panel to complete this field and press ENTER:
Field
Action
Dataset Name
Enter the name of the sequential dataset that is not currently cataloged. This is
the dataset in which your JCL will be stored.
To return to the previous panel, enter END and press ENTER.
Section Two: Installing and Customizing XPAF
17-19
Performing an installation verification procedure
Verifying your output
When you perform the IVPs, check your output against the samples
provided in this section and verify they are similar. Banner pages are not
shown in the sample output; each job is separated by a cover page that
indicates the type of processing by which the sample output is produced.
At your site, these cover pages are replaced by your site-specific banner
pages.
Sample output is provided for these types of processing:
•
•
•
•
•
•
Line-mode
DJDE and extended JCL
XES
Page format
AFP
Pass-through
The XOAF IVP does not produce printed output.
Your IVP output quality may vary, depending on the model of printer you
use and its current print quality. Due to production variations when
printing the IVP samples, your IVP output may not precisely match the
samples provided.
After you have successfully run the IVP jobs, XPAF installation,
CMA-SPOOL or CA-SPOOL setup, and/or XDS setup is complete. For
information about using XPAF, CMA-SPOOL or CA-SPOOL, and/or XDS,
refer to Section Three: Managing Resources with XPAF and Section Four:
Printing Documents with XPAF.
Line-mode processing IVP sample output
The line-mode IVP sample is a single sided document similar to the
sample on the next page.
Section Two: Installing and Customizing XPAF
17-20
Performing an installation verification procedure
Section Two: Installing and Customizing XPAF
17-21
Performing an installation verification procedure
DJDE processing IVP sample output
The DJDE processing IVP sample is a single sided document similar to
the sample on the next printed page.place marker
XES processing IVP sample output
Section Two: Installing and Customizing XPAF
17-22
Performing an installation verification procedure
Section Two: Installing and Customizing XPAF
17-23
Performing an installation verification procedure
XES processing IVP sample output
The XES processing IVP sample is a single sided document similar to the
sample on the next printed page.
place marker
Section Two: Installing and Customizing XPAF
17-24
Performing an installation verification procedure
Section Two: Installing and Customizing XPAF
17-25
Performing an installation verification procedure
Page Format processing IVP sample output
The Page Format processing IVP sample prints as two single-sided
documents, similar to the samples on the next printed pages.
place marker
Section Two: Installing and Customizing XPAF
17-26
Performing an installation verification procedure
Section Two: Installing and Customizing XPAF
17-27
Performing an installation verification procedure
Section Two: Installing and Customizing XPAF
17-28
Performing an installation verification procedure
AFP processing IVP sample output
The AFP processing IVP sample output prints as two single-sided
documents, similar to the samples on the next printed pages.
place marker
Section Two: Installing and Customizing XPAF
17-29
Performing an installation verification procedure
Section Two: Installing and Customizing XPAF
17-30
Performing an installation verification procedure
Section Two: Installing and Customizing XPAF
17-31
Performing an installation verification procedure
Pass-through processing IVP sample output
The Pass-through processing IVP sample output prints as a single-sided
document, similar to the sample on the next printed page.
place marker
Section Two: Installing and Customizing XPAF
17-32
Performing an installation verification procedure
Section Two: Installing and Customizing XPAF
17-33
Performing an installation verification procedure
Section Two: Installing and Customizing XPAF
17-34
Section Three:
Managing Resources with XPAF
You can use Managing Resources with XPAF to:
•
•
•
•
•
•
•
Access the Xerox Output Administrative Facility (XOAF)
Manage font, form, image, and logo resources
Load PDL from a printer to a native library
Manage resource lists
Load custom font resources
Manage XPAF libraries
Manage paper-related, font, color cross-reference, and color
conversion tables
Before you begin to use XPAF’s resource management facilities, verify
that XPAF has been installed and that the installation verification
procedures (IVPs) can be run successfully.
As the administrator responsible for maintaining XPAF system resources,
you should be familiar with IBM z/OS data administration, including
allocating, loading, and deallocating sequential and partitioned datasets.
You also should be familiar with processing VSAM datasets using the IBM
Access Method Services.
If you are planning on using IBM look-alike (that is, replica) fonts that are
not distributed with XPAF (such as those purchased from Xerox Font
Services), you should be familiar with IBM font structure concepts.
Section Three: Managing Resources with XPAF
Accessing XOAF
18.
18
Accessing XOAF
This chapter summarizes the utilities that XOAF provides for loading,
converting, updating, and managing resources. To ensure that the
necessary resources are available to XPAF, you must perform the
applicable tasks related to each XOAF utility before you print documents.
After you create and store your resources, you can print documents
without using XOAF. You may occasionally need to use XOAF to perform
maintenance (for example, to add new fonts).
You can access XOAF utilities through ISPF panels, TSO commands, and
batch JCL.
Using ISPF panels
This section discusses the conventions used for ISPF panels, and
introduces you to the System Services menu and its XOAF options.
Panel conventions
You should be aware of the following conventions when using the ISPF
panels in XOAF.
Panel keys
These keys are in effect when you use XOAF panels:
•
Press the ENTER key to cause XPAF to process your input.
•
Enter either the HELP command on the COMMAND line or press the
PF1 function key to display online information about how to use that
panel.
•
Enter either the END command on the COMMAND line or press the
PF3 function key to return to a previous panel.
NOTE: If you have remapped your standard PF keys, use the
appropriate keys to perform these functions.
Section Three: Managing Resources with XPAF
18-1
Accessing XOAF
Valid values
Where space permits, the valid values or range of values for a field appear
after the field name. For example, this partial panel shows that the only
valid values for the ‘Rotation’ field are 0, 1, 2, and 3.
OUTPUT
Dataset Name:
Member Name:
OUTPUT SPECIFICATIONS
Rotation (0/1/2/3):
Information about the valid values for fields on a panel also appears in the
Help panel for that function.
Dataset names can be 1- to 44-characters long. Unless otherwise noted,
dataset names and member names must follow standard z/OS naming
conventions.
Option selection chaining
You can chain option selection values using a period as a separator to
provide direct access to the option you want to perform. You can go
directly to another option in two ways:
•
If you are on the System Services menu, a chained option selection
can be entered in the OPTION line. For example, entering 4.2.4 in
the System Services menu OPTION line will take you directly to the
Maintain the Coded Font Name (XPAFCFN) Table option.
•
If you are on a menu other than the System Services menu, or within
a data entry panel, a chained option selection must be preceded by
an equal sign ( = ) on the COMMAND line. For example, if you were
in the Maintain the Coded Font Name (XPAFCFN) Table data entry
panel, you would enter =7.2 on the COMMAND line to go directly
into the Browse a Member option on the Manage Libraries menu.
When you use chaining to access an option, pressing PF3 upon leaving
that option will return you to the System Services menu.
Section Three: Managing Resources with XPAF
18-2
Accessing XOAF
Panel message display
Two types of messages may appear on the terminal when you use the
ISPF panels in XPAF:
•
•
ISPF messages
XOAF system messages
NOTE: XPAF also may write messages to the z/OS system log
(SYSLOG), your XOAF log (XLOG) dataset, or the host operator
console.
For complete information about XPAF message handling and the
messages that can be generated, refer to Section Six: XPAF Messages.
ISPF messages
XPAF writes two versions of each ISPF message to the TSO terminal:
•
A short version that appears on the first row of an XOAF panel.
•
A long version that appears on the third row of an XOAF panel. You
can display this message only by either entering HELP on the
COMMAND line and pressing ENTER, or by pressing the PF1 key.
NOTE: If you are using the ISPF window “pop-up” option for
messages, the long version of the ISPF message can be
displayed anywhere on the panel.
If the long version of a message overwrites the option or
COMMAND line, press ENTER to refresh the panel display.
Other ISPF messages may be issued from the host system. These
messages are issued without a message number and prefix, and include
both upper and lowercase characters. Because these messages are not
issued by XPAF, they are not documented in Section Six: XPAF
Messages.
Section Three: Managing Resources with XPAF
18-3
Accessing XOAF
This sample panel shows both versions of an ISPF message issued by
XPAF:
Short ISPF Message
Long ISPF
Message
Xerox Output Administrative Facility MISSING REQUIRED ENTRY
Maintain Resident Font Lists
XOAF008E - ENTER LIST NAME AT THE CURSOR POSITION.
COMMAND ===>
* On COMMAND line, enter 'C' to create, 'D' to delete, or 'U' to update a list.
Dataset Name: TABLELIB
List Name:
XOAF system messages
XOAF system messages appear in response to XOAF activities. XPAF
may issue more than one message for some error conditions. Use the
messages collectively to help identify and correct errors.
XOAF system messages are displayed at the bottom of a panel, for
example:
Xerox Output Administrative Facility
Load Centralized Images to a Native Library
COMMAND ===>
INPUT
Dataset Name:
Member Name:
OUTPUT
Dataset Name:
Member Name:
XOAF
Message
UPL1406I RESOURCE GRAPH21 LOADED SUCCESSFULLY
Some XOAF system messages displayed on your TSO terminal exceed
80 characters, resulting in a truncated message. To read the complete
message, access the SYSLOG or XLOG dataset for your XOAF session.
NOTE: If you have set up your ISPF user environment to display PF
key values at the bottom of every panel, you may not be able to view
XOAF system messages.
Section Three: Managing Resources with XPAF
18-4
Accessing XOAF
Scroll fields
A ‘SCROLL’ field appears on some panels where the number of rows of
data to be displayed exceeds the physical rows available on the terminal
page. The ‘SCROLL’ field enables you to page forward and backward
through the list of data using the page FORWARD and BACKWARD
commands or function keys (typically PF8 and PF7).
For example, this panel shows a ‘SCROLL’ field:
Xerox Output Administrative Facility Row 1 to 7 of 17
Selection List of Font Table Members
COMMAND ===>
SCROLL===> PAGE
* Next to name, enter 'S' to select a member.
X0AD0A
X0AD0B
X0AD10
X0AD2A
X0AD2B
X0AE10
X0AG0A
Panels containing a ‘SCROLL’ field display a message indicating which
rows currently are being viewed and the total number of rows available for
viewing.
Section Three: Managing Resources with XPAF
18-5
Accessing XOAF
System Services menu
When you invoke XOAF, this menu appears:
Xerox Output Administrative Facility
System Services 5.0
OPTION ===>
1.
2.
3.
4.
5.
6.
7.
Load Resources
Convert Resources
Manage Resource Lists
Manage Tables
Manage Custom Replica Fonts
Display Printer Status
Manage Libraries
E.
I.
P.
T.
X.
ISPF Edit
Installation Verification Procedure
Xerox Page Format Editor
Help Tutorial
Exit
When you select an option from this menu, the system displays a
secondary menu from which other data entry panels can be accessed. To
select an option, enter the number of the option you want to use and press
ENTER. To return to this menu from a secondary menu, press PF3.
Section Three: Managing Resources with XPAF
18-6
Accessing XOAF
XOAF options
XOAF provides the menu options listed below. These options are
independent of one another; they do not need to be used together or in
any specific order.
•
•
•
•
•
•
•
Option
Option
Option
Option
Option
Option
Option
1,
2,
3,
4,
5,
6,
7,
Load Resources
Convert Resources
Manage Resource Lists
Manage Tables
Manage Custom Replica Fonts
Display Printer Status
Manage Libraries
These options are used specifically to manage resources. Figure 18-1
shows the organizational flow of the resource management
menus/options provided by XOAF.
A brief overview of each resource management option is provided later in
this chapter. Information on how and when to use each option can be
found in later chapters of Section Three.
Five additional options also appear on the System Services menu:
•
Option E, ISPF Edit, allows you to access the ISPF editor and
returns to XOAF at the end of the EDIT session. Before you invoke
any other editor, you must exit XOAF.
•
Option I, Installation Verification Procedure, allows you to generate
jobs that you can submit to test your installation. This option is
discussed in detail in Section Two: Installing and Customizing XPAF.
•
Option P, Xerox Page Format Editor, allows you to create and update
page formats which are used to format line-mode data streams. This
option is discussed in detail in the Section Eight: Xerox Page Format
Editor User Guide.
•
Option T, Help Tutorial, provides information about how to use the
online help feature available on each active panel.
•
Option X, Exit, ends your XOAF session.
To select an option on any menu, enter the number or letter of the option
you want to use and press ENTER.
Section Three: Managing Resources with XPAF
18-7
Accessing XOAF
Figure 18-1. Organizational flow of resource management panels
System Services
2. Convert
Resources
1. Load
Resources
3. Manage
Resource
Lists
1. Convert Centralized
Fonts to Decentralized
Fonts
1. Maintain Paper Tables
2. Convert Centralized
Logos to Decentralized
Fonts
3. Update IBM Font
Characteristics
Information
3. Convert Xerox Fonts to
IBM Format
4. Delete a Font Table or
Table Entry
4. Convert IBM AFP Page
Segments to Xerox .IMG
and/or RES Format
5. Maintain Color CrossReference Tables
1. Load Centralized Fonts
2. Maintain Font Tables
7. Manage
Libraries
Display the Status of
PDS(s) and Printers
6. Maintain the Color
Conversion Table
2. Load Centralized Forms
1. Manage Resident Font
Lists
3. Load Centralized
Images
2. Manage Resident Form
Lists
4. Load Centralized Logos
3. Manage Resident Image
Lists
5. Load Decentralized
Fonts
6. Display Printer
Status
5. Manage
Custom
Replica
Fonts
4. Manage
Tables
1. Install Custom Replica
Fonts (version 5
encoding or below)
1. Display a Directory of
Library Members
2. Install Custom Replica
Fonts (version 6
encoding or above)
3. Delete a Member
2. Browse a Member
4. Reload a Member
4. Manage Resident Logo
Lists
6. Load Decentralized
Forms
7. Load Decentralized
Images
8. Load PDL
(from option 1)
1. Maintain the Paper
Name Table
2. Maintain the Varying
Paper Size Table
3. Maintain the Cluster
Mapping Table
(from option 2)
(from option 1)
1. Maintain the Xerox Font
Information (XPAFXFI)
Table
1. Load Custom Replica
Fonts
2. Maintain the Character
Mapping Tables
2. Update the IPSTND
Table (optional)
3. Maintain the Font
Family Information
(XPAFFFI) Table
3. Update the
IBM-to-Xerox
(XPAFI2X) Table
(optional)
4. Maintain the Coded
Font Name (XPAFCFN)
Table
4. Update IBM Font
Characteristics
Information
5. Maintain the Code Page
Global Identifier
(CPGID) Table
6. Maintain the Font
Global Identifier (FGID)
Table
Section Three: Managing Resources with XPAF
18-8
Accessing XOAF
Load Resources menu option
You can use this option to:
•
Load centralized or decentralized fonts, forms, and images into
native libraries
•
Load centralized logos into a native library
•
Load print description language (PDL) members to a native library
To access this option, enter 1 on the System Services menu OPTION line
and press ENTER. This menu appears:
Xerox Output Administrative Facility
Load Resources
OPTION ===>
1.
Load Centralized Fonts
2.
Load or Compile Centralized Forms
3.
Load Centralized Images
4.
Load Centralized Logos
5.
Load Decentralized Fonts
6.
Load Decentralized Forms
7.
Load Decentralized Images
8.
Load PDL
Section Three: Managing Resources with XPAF
18-9
Accessing XOAF
Convert Resources menu option
You can use this option to:
•
•
•
Convert centralized fonts and logos to decentralized fonts
Convert Xerox fonts to IBM format
Convert IBM page segments to Xerox centralized or decentralized
format
To access this option, enter 2 on the System Services menu OPTION line
and press ENTER. This menu appears:
Xerox Output Administrative Facility
Convert Resources
OPTION ===>
1.
Convert Centralized Fonts to Decentralized Fonts
2.
Convert Centralized Logos to Decentralized Fonts
3.
Convert Xerox Fonts to IBM Format
4.
Convert IBM AFP Page Segments to Xerox .IMG and/or RES Format
Manage Resource Lists menu option
You can use this option to create and maintain lists of fonts, forms,
images, and logos that are resident on each printer so that XPAF knows
which resources must be downloaded at print time.
To access this option, enter 3 on the System Services menu OPTION line
and press ENTER. This menu appears:
Xerox Output Administrative Facility
Manage Resource Lists
OPTION ===>
1.
Manage Resident Font Lists
2.
Manage Resident Form Lists
3.
Manage Resident Image Lists
4.
Manage Resident Logo Lists
Section Three: Managing Resources with XPAF
18-10
Accessing XOAF
Manage Tables menu option
You can use this option to:
•
Create, update, or delete paper-related tables
•
Display, update, or delete font tables
•
Update IBM font characteristics table information
•
Create, delete, or update color cross-reference tables, which are
used to support highlight color for centralized printers
•
Load the color conversion table, which is used to map centralized
highlight colors to decentralized full color values
To access this option, enter 4 on the System Services menu OPTION line
and press ENTER. This menu appears:
Xerox Output Administrative Facility
Manage Tables
OPTION ===>
1.
Maintain Paper Tables
2.
Maintain Font Tables
3.
Update IBM Font Characteristics Information
4.
Delete a Font Table or Table Entry
5.
Maintain Color Cross-Reference Tables
6.
Maintain the Color Conversion Table
Manage Custom Replica Fonts menu option
You can use this option to make custom replica fonts available to XPAF.
To access this option, enter 5 on the System Services menu OPTION line
and press ENTER. This menu appears:
Xerox Output Administrative Facility
Manage Custom Replica Fonts
OPTION ===>
1.
Install Custom Replica Fonts (version 5 encoding or below)
2.
Install Custom Replica Fonts (version 6 encoding or above)
Section Three: Managing Resources with XPAF
18-11
Accessing XOAF
Display Printer Status menu option
You can use this option to:
•
Display the status of printers and PDS members by address space.
To access this option, enter 6 on the System Services menu OPTION line
and press ENTER. This menu appears:
Xerox Output Administrative Facility
Display Printer Status
OPTION ===>
1. Display the Status of PDS(s) and Printers
Manage Libraries menu option
You can use this option to list, browse, delete, and offload members of
native libraries and PDSs. You also can use this option to reload members
of native libraries.
NOTE: A native library is a VSAM library formatted for XPAF use.
To access this option, enter 7 on the System Services menu OPTION line
and press ENTER. This menu appears:
Xerox Output Administrative Facility
Manage Libraries
OPTION ===>
1.
Display a Directory of Library Members
2.
Browse a Member
3.
Delete a Member
4.
Reload a Member
Section Three: Managing Resources with XPAF
18-12
Accessing XOAF
Using TSO/batch commands
Section Three focuses on the use of ISPF panels to perform XOAF
functions. However, TSO/batch commands are available as alternatives
to using many of the XOAF panel options. Information on using particular
TSO/batch commands can also be found in Section Three. Refer to the
XPAF TSO/Batch Commands Quick Reference Card for a complete list of
the commands.
Coding conventions
The XOAF TSO/batch commands follow standard JCL coding
conventions. Items such as commas, single quotes, equal signs, and
parentheses are part of a definition’s syntax. When present, you must
include them exactly as indicated. Refer to the appropriate JCL reference
manual for a detailed description of valid syntax.
When allocating an XOAIN dataset ensure that it is in fixed format.
When coding a batch job, each new XOAF batch command must begin on
a new record. A command can continue across as many records as
necessary.
When submitting an XOAF batch job, do not delete the PARM statement
from the EXEC card. If you do, the batch job will fail with a return code of
0132. This return code indicates an invalid or missing parameter list.
Using TSO commands
You can execute the TSO/batch commands in two ways:
•
•
From the native TSO environment
From the ISPF Primary Option Menu
Executing commands in the native TSO environment
The native TSO environment does not use menus to access XOAF. The
instructions for entering, executing, and exiting an XOAF session using
the native TSO environment are:
Step 1.
Log on to TSO.
Step 2.
Enter XOAF (or a site-specific prompt) and press ENTER.
Step 3.
Enter a command statement as provided in Section Three for the XOAF
function. Press ENTER. A TSO message is displayed indicating success
or failure.
Step 4.
Enter END and press ENTER to exit XOAF.
CAUTION: You must use the XOAF command processor as
described. Do not access XOAF using a TSO CLIST and do not
invoke XOAF with the TSO CALL command. If you do, the results may
be unpredictable.
Section Three: Managing Resources with XPAF
18-13
Accessing XOAF
Executing commands from the ISPF Primary Option Menu
The instructions for entering, executing, and exiting an XOAF session
from the ISPF Primary Option Menu are:
Step 1.
On the ISPF Primary Option Menu, enter TSO XOAF on the Option line.
Press ENTER. The XOAF prompt will be displayed.
Step 2.
Enter a command statement as provided in Section Three for the XOAF
function. Press ENTER. A TSO message is displayed indicating success
or failure.
Step 3.
Enter END and press ENTER to exit XOAF and return to the ISPF Primary
Option Menu.
NOTE: Depending on your system, you may need to press ENTER
twice to display the XOAF prompt or to return to the ISPF Primary
Option Menu.
Using batch JCL
To use the batch environment to access an XOAF utility, submit a batch
job that reads a command statement from the JCL and invokes the
requested services. You can use JCL similar to this:
//job-name JOB job-information
//S1
EXEC
PGM=XOASUP00,REGION=2048K,PARM=userid
//STEPLIB
DD
DSN=prefix.XPFLOAD,DISP=SHR
//XINPARM
DD
DSN=prefix.XINPARM,DISP=SHR
//XOAFMSG
DD
DSN=prefix.XPFMLIB(XOAOO),DISP=SHR
//TABLELIB DD
DSN=prefix.TABLELIB,DISP=SHR
//UJLLIST
DD
SYSOUT=*
//XOAPRINT DD
SYSOUT=*,DCB=(LRECL=121,RECFM=FB,BLKSIZE=6050)
//XOAIN
DD
*
/* command statement */
/*
Section Three: Managing Resources with XPAF
18-14
Accessing XOAF
During the installation process, XOAFBAT is loaded into the system
procedure library. You can substitute XOAFBAT (shown below) in a batch
job.
//XOAFBAT
//XOAF
//STEPLIB
//TABLELIB
//XINPARM
//XOAFMSG
//XOAPRINT
//UJLLIST
//XOAIN
PROC
EXEC
DD
DD
DD
DD
DD
DD
DD
CORE=4096K,USER=
PGM=XOASUP00,REGION=&CORE,PARM=(&USER)
DSN=prefix.XPFLOAD,DISP=SHR
DSN=prefix.TABLELIB,DISP=SHR
DSN=prefix.XINPARM,DISP=SHR
DSN=prefix.XPFMLIB(XOAOO),DISP=SHR
SYSOUT=*,DCB=(LRECL=121,RECFM=FB,BLKSIZE=6050)
SYSOUT=*,DCB=(RECFM=FBA,LRECL=133,BLKSIZE=1330)
DDNAME=SYSIN
Sample batch jobs
The following examples execute batch jobs using the XOAFBAT
procedure.
This JCL causes a batch job to display a directory of members in a library.
//job-name JOB job-information
//XOAFBAT EXEC XOAFBAT,USER=userid
//SYSIN
DD *
LIB DIR(library-name)
/*
This JCL loads the MYCOLORS PDS member which resides in the
XPAF30.XPFSAMP dataset to the default table library, TABLELIB.
//job-name JOB job-information
//XOAFBAT EXEC XOAFBAT,USER=userid
//SYSIN
DD *
LOAD INKS('XPAF30.XPFSAMP(MYCOLORS)') TO('XPAF30.TABLELIB')
/*
Section Three: Managing Resources with XPAF
18-15
Accessing XOAF
Section Three: Managing Resources with XPAF
18-16
XPAF resources
19.
19
XPAF resources
This chapter provides an overview of the types of resources used by
XPAF and the libraries in which XPAF can store resources. XPAF stores
resources in two types of libraries:
•
Partitioned datasets.
•
Native libraries. A native library is a VSAM dataset that is used by
XPAF to store resources.
NOTE: Before you can manage your resources, you will need to know
the names of the resource libraries at your site. Library names and
the values of other resource management-related information are
specified by your systems programmer during installation using
initialization and printer profile parameters. Refer to appendix C,
“Resource management parameters” for a list of parameters whose
values you will need to know.
Depending on the data stream type being processed and the printer being
used, certain types of resources can be stored in a library and
downloaded at print time, inline in the data stream, or resident on the
printer if the printer is capable of storing resources. Refer to Section Four:
Printing Documents with XPAF for information regarding the print time
handling of resources for each data stream type.
Resources such as fonts, forms, images, and logos must be in a format
recognized by the Xerox printer whether they are library or
printer-resident, or included inline as part of the document:
•
Centralized printers recognize these Xerox file formats:
—
—
—
—
•
Decentralized printers recognize these Xerox file formats:
—
—
•
.FNT format for fonts
.FRM format for forms
.IMG format for images
.LGO format for logos
XES format for forms
Sixelized format for fonts and images
PCL-capable printers recognize these Xerox file formats:
—
—
PCL macro format for forms
Bitmapped format for fonts and images
For resources that are not already in a format required by the printer,
XPAF either performs dynamic resource conversions during XPAF
processing or provides XOAF options or TSO/batch commands to
preconvert and store those resources.
Section Three: Managing Resources with XPAF
19-1
XPAF resources
Fonts
A font is a set of printing characters that have common characteristics
such as style, width, height, and weight. This term is used in XPAF to
indicate one of these resources:
•
•
•
A centralized font stored in .FNT file format
A decentralized font stored in sixelized file format
A PCL or PDF font stored in bitmapped file format
XPAF currently supports only the 2700 font format for decentralized
(sixelized) fonts.
Specifying font libraries
XPAF stores fonts in these types of native libraries:
•
A centralized font library for fonts in .FNT format that will be
downloaded to a centralized printer
•
A decentralized font library for fonts in sixelized format that will be
downloaded to a decentralized printer
•
A PCL font library for fonts in bitmapped format that will be
downloaded to a PCL-capable printer
•
A PDF font library for fonts in bitmapped format that will be included
in a PDF document
During installation, your systems programmer specified these libraries to
XPAF by using the following parameters:
•
CFONTLIB initialization parameter or FONTLIB printer profile
parameter, which names the XOSF DD statement that specifies the
centralized font library for each printer.
•
DFONTLIB initialization parameter or FONTLIB printer profile
parameter, which names the XOSF DD statement that specifies the
decentralized font library for each printer.
•
SFONTLIB printer profile parameter, which names the XOSF DD
statement that specifies the centralized font library to be searched
when a font cannot be found in the decentralized font library. XPAF
looks at the corresponding centralized font to obtain the font metric
information it needs to determine line spacing. This parameter is
applicable only to DJDE data streams sent to a decentralized or
PCL-capable printer.
•
PFONTLIB initialization or printer profile parameter, which names
the XOSF DD statement that specifies the PCL font library for a
PCL-capable printer.
•
FFONTLIB initialization or printer profile parameter, which names the
XOSF DD statement that specifies the PDF font library for a PDF
device.
If you will be sending AFP documents to Xerox printers, your systems
programmer also specified the XOSF DD statement that identifies your
IBM font library by using the IBMFNTDD initialization parameter. XPAF
obtains font width information from this library.
Another parameter that may be specified during system installation and
which can affect your font libraries and resource downloading to
Section Three: Managing Resources with XPAF
19-2
XPAF resources
centralized printers is the DELFONT printer profile parameter. DELFONT
can be used to indicate that fonts which are downloaded with a document
will be deleted from the printer after the document has been printed.
For additional information about these parameters, refer to Section Five:
XPAF Parameter and Keyword Reference.
NOTE: On an individual job basis, the DELFONT and REVFONT
extended JCL keywords can affect the storing of fonts in the font
library or on the printer. Refer to Section Five: XPAF Parameter and
Keyword Reference for information about the function and format of
these keywords. Refer to Section Four: Printing Documents with
XPAF for information about their usage.
Understanding font types
Xerox distributes two sets of fonts with XPAF:
•
A set of U.S. (A03) and international (R03) Xerox centralized and
decentralized fonts. These fonts can be used without modification
when printing native mode documents. The fonts also can be used to
print DCF documents at 300 dpi; however, the IBM font
characteristics first must be converted before they can be used.
•
A set of standard replica fonts. A replica font is a Xerox font that
looks like an IBM font. These fonts can be used without modification
when printing AFP documents.
In addition to the XPAF-supplied fonts, you can use these types of fonts
which you have purchased from Xerox Font Services or a third-party
vendor:
•
•
Custom Xerox fonts
Custom replica fonts
If you use custom fonts, you must use various XOAF panel functions to
load the fonts into the appropriate libraries, perform conversions, and
generate the necessary font table entries.
NOTE: If you are using an IBM font that does not have a
corresponding replica font, you must acquire the custom replica font
from Xerox Font Services or a third-party vendor to print your
document through XPAF.
Appendix C lists some of the character sets that can be used in
documents sent to XPAF printers.
Section Three: Managing Resources with XPAF
19-3
XPAF resources
Using licensed fonts with XPAF
A licensed font is a font for which you are required to pay royalties to the
vendor depending on usage. You should contact your local Xerox
representative for the font format or other requirements if you plan to
obtain a licensed font for use with XPAF.
You can use licensed fonts with XPAF and Xerox printers in accordance
with the font licensor’s shrink-wrap license agreement or executable
license agreement which accompanies all licensed font products. If you
have any questions regarding the use of a specific font, you should
contact the font vendor directly. You are responsible for the proper
contractual use of licensed fonts.
CAUTION: Printing with a licensed font to a non-Xerox printer may
violate your licensing agreement.
Understanding dynamic font conversions
XPAF performs dynamic font conversions for documents converted to
PCL or PDF. When printing documents to a PCL-capable printer or
converting to PDF, XPAF searches the PCL or PDF font library to
determine if the font already resides in the library. If it does, XPAF uses
the font stored in the library. If it does not or if you have requested a
revision of the font, then XPAF dynamically converts the font from Xerox
2700 format to PCL or PDF bitmapped format. This conversion ensures
that the correct positioning is used when the page output is produced. The
font is then stored in the PCL or PDF font library.
Fonts which are included inline in the data stream are converted to PCL
or PDF format but are not stored in the PCL or PDF font library.
XPAF downloads the necessary fonts every time a PCL or PDF job is
printed but does not store them on the printer.
NOTE: For data streams for which dynamic font conversions are not
performed, you must convert the font from centralized to
decentralized format using either the Convert Centralized Fonts to
Decentralized Fonts option on the Convert Resources menu or the
CONVERT XFONT TSO/batch command. Refer to chapter 22,
“Converting resources” for more information about these options.
Section Three: Managing Resources with XPAF
19-4
XPAF resources
Understanding replica font processing
If you plan to use replica fonts, you should be aware of some of the
differences that exist between the Xerox and IBM font architecture:
•
IBM fonts used for printing AFP data streams typically are designed
to print at 240 or 300 dpi; replica fonts print at 300 dpi.
•
AFP generally uses an EBCDIC font mapping; XPAF uses an ASCII
font mapping.
•
A single IBM character set has no limit on the number of characters
it may contain. The Xerox printer architecture limits the size of each
centralized font to a maximum of 240 printable characters and 256K
of raster data. For decentralized fonts, the size limit is a maximum of
192 printable characters and 64K of raster data.
•
Xerox uses different formats (that is, .FNT and sixelized) for
centralized and decentralized fonts as well as different fonts for
different page orientations.
To adjust for these differences, XPAF uses a number of tables. These
tables provide XPAF with the cross-reference information needed to
process each replica font correctly. Use of these tables also helps XPAF
avoid having to read the IBM font libraries each time a document is
processed.
For detailed information about these tables, refer to chapter 20, “XPAF
tables.”
Using Xerox fonts in DCF/SCRIPT documents
When you use IBM’s Document Composition Facility (DCF) or SCRIPT
products to create a document that you intend to print on a Xerox laser
printer, you can use IBM fonts or centralized Xerox fonts. Using
centralized Xerox fonts gives you the benefit of 300-dpi fonts and
enhances throughput. This is because the internal 240-to-300 dpi
translations that may be performed when using IBM fonts are not
required. You can use any of the centralized Xerox fonts provided with
XPAF or any custom font you purchased for your system.
Xerox 300-dpi fonts for which no IBM resources exist can be used with
IBM's DCF program. However, they cannot be mixed with existing IBM
fonts, and they cannot be used as true replica fonts.
NOTE: Before you can format your DCF/SCRIPT documents using
Xerox fonts, your systems programmer must first update the
DCF/SCRIPT logical and physical device tables and the Generalized
Markup Language (GML) profile. Refer to Section Two: Installing and
Customizing XPAF for information about the steps that must be
performed.
For a complete list of available centralized Xerox fonts, refer to Xerox
Laser Printing Systems Standard Font Library Font User Guide. For DCF
information, refer to SCRIPT/VS Language Reference.
Section Three: Managing Resources with XPAF
19-5
XPAF resources
Using PCL fonts
PCL fonts are used by XPAF in one of the following methods:
•
The PCL generated by XPAF is produced using PCL temporary soft
fonts. XPAF downloads the fonts for each print job, and deletes
those fonts at the end of each job.
•
When permanent soft fonts are identified in the PCL font list XPAF
will download the fonts once, the first time they are referenced.
Once downloaded, XPAF assumes that the font remains in the
printer’s memory, and will only download the font again when the
XPAF printer is drained and restarted. Because the DocuSP printers
store permanent soft fonts on their hard drives, this restriction does
not apply.
•
Named fonts are permanently stored on the printer’s hard drive. This
allows XPAF to select the font based on their unique name and
eliminates the need for XPAF to download those fonts. Named fonts
are always available unless physically deleted by the FSDELETE
PJL command.
Using PDF fonts
Fonts for PDF documents are converted and included in the PDF file.
Section Three: Managing Resources with XPAF
19-6
XPAF resources
Loading and maintaining fonts
Table 19-1 identifies the options you use and the chapter to which you
should refer for each function needed to manage font resources.
Table 19-1.
Font management functions
If you want to ...
Load fonts (.FNT format) to a
centralized font library
Use this option ...
XOAF option:
Load Centralized Fonts option on
the Load Resources menu
Refer to this chapter ...
Chapter 21, “Loading
resources to a native library”
TSO/Batch command:
LOAD FONT
Load fonts (sixelized format) to a
decentralized font library
XOAF option:
Load Decentralized Fonts option
on the Load Resources menu
Chapter 21, “Loading
resources to a native library”
TSO/Batch command:
LOAD FONT
Convert fonts from centralized
(.FNT) to decentralized
(sixelized) format for printing to a
decentralized or PCL-capable
printer or PDF device
XOAF option:
Convert Centralized Fonts to
Decentralized Fonts option on the
Convert Resources menu
Chapter 22, “Converting
resources”
TSO/Batch command:
CONVERT XFONT
Use Xerox fonts in a DCF
document
XOAF option:
Convert Xerox Fonts to IBM
Format option on the Convert
Resources menu
Chapter 22, “Converting
resources”
TSO/Batch command:
CONVERT FONT
Use custom Xerox fonts
(Refer to chapter 25, “Managing
custom fonts” for options and
procedures)
Chapter 25, “Managing
custom fonts”
Use custom replica fonts
(Refer to chapter 25, “Managing
custom fonts” for options and
procedures)
Chapter 25, “Managing
custom fonts”
Section Three: Managing Resources with XPAF
19-7
XPAF resources
Forms
A form is an electronically composed arrangement of predefined items
such as lines, boxes, text, and images that may be printed as is or merged
with data during the printing process. This term is used in XPAF to
indicate one of these resources:
•
•
•
•
A
A
A
A
centralized form stored in .FRM file format
decentralized form stored in XES or XPAF-internal file format
PCL form stored in PCL macro file format
PDF object contained in the PDF document
Specifying form libraries
XPAF stores forms in these types of native libraries:
•
A centralized form library for forms in .FRM format that will be
downloaded to a centralized printer
•
A decentralized form library for forms in XES or XPAF-internal format
that will be downloaded to a decentralized printer
•
A PCL form library for forms in PCL macro format that will be
downloaded to a PCL-capable printer
During installation, your systems programmer specified these libraries to
XPAF by using the following parameters:
•
CFORMLIB initialization parameter or FORMLIB printer profile
parameter, which names the XOSF DD statement that specifies the
centralized form library for each printer.
•
DFORMLIB initialization parameter or FORMLIB printer profile
parameter, which names the XOSF DD statement that specifies the
decentralized form library for each printer.
•
SFORMLIB printer profile parameter, which names the XOSF DD
statement that specifies the secondary (centralized) form library for
the printer. XPAF searches the secondary library when a form cannot
be found in the primary (decentralized) form library. If a
corresponding centralized form is found, XPAF will convert it
dynamically to decentralized format. This parameter is applicable
only to DJDE data streams sent to a decentralized or PCL-capable
printer.
•
PFORMLIB initialization or printer profile parameter, which names
the XOSF DD statement that specifies the PCL form library for a
PCL-capable printer.
If you will be sending AFP documents to Xerox printers, your systems
programmer also specified the XOSF DD statement that identifies your
overlay library by using the OVERLAYDD initialization parameter.
Other parameters that may be specified during system installation and
which can affect your centralized form libraries and resource downloading
to centralized printers are listed below:
•
The DELFORM printer profile parameter can be used to indicate that
forms which are downloaded with a document be deleted from the
printer after the document has been printed.
Section Three: Managing Resources with XPAF
19-8
XPAF resources
•
The MERGEOVL initialization or printer profile parameter can be
used to merge all AFP overlays in a copy group the first time the
copy group is used in an AFP document. Each overlay in the copy
group is converted, then the individual converted overlays are
consolidated into a single .FRM file. The .FRM file is not saved in the
native form library, and is deleted from the printer at the completion
of the document.
•
The NOSTORE initialization or printer profile parameter can be used
to override the storing of converted AFP overlays in the centralized
form library. This will result in the AFP overlays being converted and
downloaded for every job. The downloaded resources will be deleted
from the printer at the end of the job.
•
The UNIQNAME initialization or printer profile parameter can be
used to specify that XPAF append a unique 6-character suffix to the
form name for any converted AFP overlay.
For additional information about these parameters, refer to Section Five:
XPAF Parameter and Keyword Reference.
NOTE: On an individual job basis, the DELFORM, MERGEOVL,
REVFORM, and REVOVLY extended JCL keywords and the
USERLIB IBM JCL keyword can affect the storing of forms in the form
library or on the printer. Refer to Section Five: XPAF Parameter and
Keyword Reference for information about the function and format of
these keywords. Refer to Section Four: Printing Documents with
XPAF for information about their usage.
Understanding dynamic form conversions
During data stream processing, XPAF searches the form library specified
by the CFORMLIB, DFORMLIB, FORMLIB, or PFORMLIB parameters to
determine if a form already resides in the library. If it does, XPAF uses the
form stored in the library. If it does not or if you have requested a revision
of the form, XPAF will perform dynamic conversions only for the following
types of printers and data streams:
•
For data streams sent to centralized printers, XPAF converts an
overlay in an AFP data stream to .FRM format the first time it is
referenced in a document and stores it in the centralized form library
with a 20-character name. The last six characters of this member
name are used as the form name on the printer. The converted
overlay is stored on the printer if the printer can store resources.
•
For data streams sent to decentralized printers:
—
XPAF searches the secondary (centralized) library specified by
the SFORMLIB printer profile parameter if a decentralized form
referenced in a DJDE data stream is not found in the primary
(decentralized) form library. If it finds one, XPAF dynamically
converts the form from .FRM to XES format the first time it is
referenced and stores the converted form in the decentralized
form library. The converted form also will be stored on the
printer if the printer can store resources.
Section Three: Managing Resources with XPAF
19-9
XPAF resources
•
—
Any dynamically converted colorized form in a DJDE data
stream will print in black when sent to a monochrome
decentralized printer and will print in color when sent to a color
decentralized printer.
—
Forms which are included inline in the data stream are not
dynamically converted.
—
XPAF converts a form in a page-formatted data stream from
.FRM to XES format the first time it is referenced in a document.
The converted form is stored in the decentralized form library for
that printer, and on the printer if the printer can store resources.
—
XPAF converts an overlay in an AFP data stream to a form in
XPAF-internal format the first time it is referenced in a document
and stores the form in the decentralized form library. The form is
then converted from XPAF-internal format to XES format before
being downloaded to the printer. The XES form is stored on the
printer if the printer can store resources.
For data streams sent to PCL-capable printers, XPAF converts an
XES form to a PCL macro which contains a set of PCL commands
that define the form. XPAF then stores the macro in the PCL form
library.
Forms which are included inline in the data stream are converted to
PCL macro format but are not stored in the PCL form library.
XPAF downloads the necessary forms every time a PCL job is printed
but does not store them on the printer.
Loading and maintaining forms
Table 19-2 identifies the options you use and the chapter to which you
should refer for each function needed to manage form resources.
Table 19-2.
Form management functions
If you want to ...
Load forms (.FRM format) to a
centralized form library
Use this option ...
XOAF option:
Load Centralized Forms option on
the Load Resources menu
Refer to this chapter ...
Chapter 21, “Loading
resources to a native library”
TSO/Batch command:
LOAD FORM
Load forms (XES format) to a
decentralized form library
XOAF option:
Load Decentralized Forms option
on the Load Resources menu
Chapter 21, “Loading
resources to a native library”
TSO/Batch command:
LOAD FORM
Section Three: Managing Resources with XPAF
19-10
XPAF resources
Images
An image is a resource that contains visual data such as a picture, map,
or graph. This term is used in XPAF to indicate one of these types of
Xerox resources:
•
•
•
A centralized image stored in .IMG file format
A decentralized image stored in sixelized or .IMG file format
A PCL image stored in bitmapped file format
For an IBM resource, this term is used in XPAF to indicate an image
referenced in an AFP data stream.
Specifying image libraries
XPAF stores images in these types of native libraries:
•
A centralized image library for images in .IMG format that will be
downloaded to a centralized printer
•
A decentralized image library for images in sixelized and .IMG
format that will be downloaded to a decentralized printer
•
A PCL image library for images in bitmapped format that will be
downloaded to a PCL-capable printer
•
A PDF image object that is included in the PDF file
During installation, your systems programmer specified these libraries to
XPAF by using the following parameters:
•
CIMAGELIB initialization parameter or IMAGELIB printer profile
parameter, which names the XOSF DD statement that specifies the
centralized image library for each printer.
•
DIMAGELIB initialization parameter or IMAGELIB printer profile
parameter, which names the XOSF DD statement that specifies the
decentralized image library for each printer.
•
SIMAGELIB printer profile parameter, which names the XOSF DD
statement that specifies the secondary (centralized) image library for
the printer. XPAF searches the secondary library when an image
cannot be found in the primary (decentralized) image library. If a
corresponding centralized image is found, XPAF will convert it
dynamically to decentralized format. This parameter is applicable
only to DJDE data streams sent to a decentralized or PCL-capable
printer.
•
PIMAGELIB initialization or printer profile parameter, which names
the XOSF DD statement that specifies the PCL image library for a
PCL-capable printer.
•
FIMAGELIB initialization or printer profile parameter, which names
the XOSF DD statement that specifies the PDF image library for PDF
devices.
If you will be sending AFP documents to Xerox printers, your systems
programmer also specified the XOSF DD statement that identifies your
page segment library by using the PAGESEGDD initialization parameter.
Section Three: Managing Resources with XPAF
19-11
XPAF resources
Other parameters that may be specified during system installation and
which can affect your centralized image libraries and resource
downloading to centralized printers are listed below:
•
The DELIMAGE printer profile parameter can be used to indicate
that images which are downloaded with a document be deleted from
the printer after the document has been printed.
•
The NOSTORE initialization or printer profile parameter can be used
to override the storing of converted AFP images in the centralized
image library. This will result in the AFP images being converted and
downloaded for every job. The downloaded resources will be deleted
from the printer at the end of the job.
•
The PRINTENV initialization parameter can be used to specify how
XPAF should dynamically convert AFP images colorized via the IID
structured field for printing on a centralized printer. Refer to
“Understanding dynamic conversions for colorized AFP IM-type
images” later in this chapter for more information about the function
of this parameter.
For additional information about these parameters, refer to Section Five:
XPAF Parameter and Keyword Reference.
NOTE: On an individual job basis, the DELIMAGE, REVIMAGE,
REVOPSEG, and REVPSEG extended JCL keywords and the
USERLIB IBM JCL keyword can affect the storing of images in the
image library or on the printer. Refer to Section Five: XPAF
Parameter and Keyword Reference for information about the function
and format of these keywords. Refer to Section Four: Printing
Documents with XPAF for information about their usage.
Understanding dynamic image conversions
During data stream processing, XPAF searches the image library
specified by the CIMAGELIB, DIMAGELIB, FIMAGELIB, IMAGELIB or
PIMAGELIB parameters to determine if an image already resides in the
library. If it does, XPAF uses the image stored in the library. If it does not
or if you have requested a revision of the image, XPAF will perform
dynamic conversions only for the following types of printers and data
streams:
•
For data streams sent to centralized printers:
—
XPAF converts a page segment in an AFP data stream to .IMG
format the first time it is referenced in a document and stores it
in the centralized image library. The converted page segment is
stored on the printer if the printer can store resources.
When naming your page segments for use with XPAF, the names
should not begin with the letter O. If you have page segments that
begin with O, they may not be converted or they may cause
unpredictable results when printed with XPAF.
—
XPAF converts an AFP IM image which is colorized via the IID
structured field to .IMG or RES .IMG format. Unless the image is
inline, the converted image is stored in the centralized image
library and on the printer if the printer can store resources.
Section Three: Managing Resources with XPAF
19-12
XPAF resources
Refer to “Understanding dynamic conversions for colorized AFP
IM-type images” later in this chapter for detailed information on
how XPAF handles dynamic conversion for these types of
images.
—
XPAF performs consolidation in AFP data streams for images
within a single IBM resource type. Images referenced within an
overlay, excluding those that are included in a page segment
referenced by the overlay, are consolidated and converted into a
single .IMG, then downloaded to the printer. Images referenced
within a page segment are consolidated and converted into a
single .IMG, then downloaded to the printer.
The converted image is stored in the centralized image library
and on the printer if the printer can store resources.
Images which are inline on a page but not referenced by another
resource (overlay or page segment) are consolidated and
converted to a single .IMG, then downloaded to the printer. The
.IMG file is neither stored in the centralized image library nor on
the printer.
For detailed information about AFP resource consolidation, refer
to Section Four: Printing Documents with XPAF.
•
For data streams sent to decentralized printers:
—
XPAF searches the secondary (centralized) library specified by
the SIMAGELIB parameter if a decentralized image referenced
in a DJDE data stream is not found in the primary
(decentralized) image library. If it finds one, XPAF dynamically
converts the image from .IMG to sixelized format the first time it
is referenced and stores the converted image in the
decentralized image library. The converted image also is stored
on the printer if the printer can store resources.
Any dynamically converted colorized centralized images will print
in black when sent to a monochrome decentralized printer and in
color when sent to a color decentralized printer. RES .IMG files
will print in black when sent to a monochrome decentralized
printer and will print in black and the specified highlight color
when sent to a color decentralized printer.
Images which are included inline in the data stream are not
dynamically converted.
—
XPAF converts any image referenced by a form in a
page-formatted data stream from .IMG to sixelized format, but
does not store it in the decentralized image library.
—
XPAF converts a page segment in an AFP data stream to an
image in .IMG format the first time it is referenced in a document
and stores the image in the decentralized image library. The
image is then converted from .IMG format to sixelized format
before being downloaded to the printer. The sixelized image is
stored on the printer if the printer can store resources.
When naming your page segments for use with XPAF, the names
should not begin with the letter O. If you have page segments that
Section Three: Managing Resources with XPAF
19-13
XPAF resources
begin with O, they may not be converted or they may cause
unpredictable results when printed with XPAF.
•
For data streams sent to PCL-capable printers, XPAF converts an
image from sixelized format to bitmapped (HP raster graphic) format
the first time it is referenced in a document. XPAF then stores the
converted image in the PCL image library.
Images which are included inline in the data stream are converted to
PCL format but are not stored in the PCL image library.
XPAF downloads the necessary images every time a PCL job is
printed but does not store them on the printer.
•
For data streams sent to PDF devices, XPAF converts an image from
sixelized format to a bitmapped PDF object format the first time it is
referenced in a document. XPAF then stores the converted image in
the PDF image library.
Images which are included inline in the data stream are converted to
PDF format but are not stored in the PDF image library.
XPAF includes the necessary image objects every time a PDF file is
created.
Understanding dynamic conversions for colorized AFP
IM-type images
During image processing, XPAF converts AFP image resources to the
appropriate .IMG format required for the target printer. For IM-type
images colorized via the IID structured field and sent to a centralized
printer, XPAF converts the image to a monochrome black .IMG file, a
monochrome RES .IMG file, and/or a two-color RES .IMG file, based on
these factors:
•
The value specified for the PRINTENV initialization parameter
•
The target printer (whether monochrome or highlight color)
•
Whether the color of the image is black only, color only, or both black
and color
•
Whether the image will be stored in the native centralized image
library
The final printed color of the image is dependent upon the ink color loaded
at the target printer.
Section Three: Managing Resources with XPAF
19-14
XPAF resources
Print factor relationships
The print factors identified previously only affect the resource when the
image is first converted or if it is revised. If the resource has been
previously converted, no change is made.
The relationship of how the print factors work together is shown in table
19-3. If you specify PRINTENV=MONO, XPAF only creates and prints a
monochrome black .IMG file, regardless of the other print factors.
.
Table 19-3.
Print factors for colorized images
Target printer is ...
Mono
AFP resource is ...
Highlight
PRINTENV=COLR
Mono
Highlight
PRINTENV=BOTH
Black only
Not stored in native library
A1
A
A
A
Black only
Stored in native library
A1
A
A
A
Color only (no black)
Not stored in native library
A1
B
A
B
Color only (no black)
Stored in native library
C1
B
C
D
Both black and color
Not stored in native library
A1
E
A
E
Both black and color
Stored in native library
F1
E
F
G
1
XPAF forces the PRINTENV=COLR parameter to PRINTENV=BOTH, and creates the
specified image type.
where
A
XPAF only creates and prints a monochrome black .IMG file.
B
XPAF only creates and prints a monochrome RES .IMG file.
C
XPAF creates both a monochrome black .IMG file and a monochrome
RES .IMG file, but only prints the monochrome black .IMG file.
D
XPAF creates both a monochrome black .IMG file and a monochrome
RES .IMG file, but only prints the monochrome RES .IMG file.
E
XPAF only creates and prints a two-color RES .IMG file.
F
XPAF creates both a monochrome black .IMG file and a two-color
RES .IMG file, but only prints the monochrome black .IMG file.
G
XPAF creates both a monochrome black .IMG file and a two-color
RES .IMG file, but only prints the two-color RES .IMG file.
Section Three: Managing Resources with XPAF
19-15
XPAF resources
Restrictions and limitations
These restrictions and limitations apply to color IID structured field
processing:
•
XPAF support is limited to IM-type images.
•
XPAF support does not include these features:
—
—
Reverse video processing
Image print impression processing
•
XPAF does not convert an image every time it is printed. If XPAF
does not revise the image, the existing image will be printed instead
of the updated image. Therefore, if you change the color in the IID
structured field for an image, you must also specify either the
REVOVLY or REVPSEG extended JCL keyword to reconvert the
image.
•
If you store color images in the centralized image library and you
specify PRINTENV=BOTH, XPAF maintains two separate copies of
the image: one black and the other color. When the image is printed,
XPAF downloads the appropriate file to the specified printer, using
the last six characters of the file name as the resource name stored
on the printer. Because the last six characters are the same for both
files, they will both have the same name when downloaded to a
printer. However, the two files will never be downloaded to or stored
on the same printer, so no naming conflict will exist.
•
All individual colors of a RES .IMG format image, other than black,
will be represented in a consolidated image as a single color. This
color will match the first colorized IID image color attribute value
encountered within the AFP resource or data stream.
Section Three: Managing Resources with XPAF
19-16
XPAF resources
Loading and maintaining images
Table 19-4 identifies the options you use and the chapter to which you
should refer for each function needed to manage image resources.
Table 19-4.
Image management functions
If you want to ...
Load images (.IMG format) to a
centralized image library
Use this option ...
XOAF option:
Load Centralized Images option on
the Load Resources menu
Refer to this chapter ...
Chapter 21, “Loading
resources to a native library”
TSO/Batch command:
LOAD IMAGE
Load images (sixelized format) to
a decentralized image library
XOAF option:
Load Decentralized Images option
on the Load Resources menu
Chapter 21, “Loading
resources to a native library”
TSO/Batch command:
LOAD IMAGE
Convert AFP page segments to
centralized or decentralized
format
XOAF option:
Convert IBM AFP Page Segments
to Xerox .IMG and/or RES Format
option on the Convert Resources
menu
Batch utility:
XRFBATCH
Convert AFP IM-type images
colorized via the IID structured
field to monochrome .IMG,
monochrome RES .IMG, and/or
two-color RES .IMG format
XOAF option:
Convert IBM AFP Page Segments
to Xerox .IMG and/or RES Format
option on the Convert Resources
menu
Batch utility:
XRFBATCH
Section Three: Managing Resources with XPAF
Chapter 22, “Converting
resources”
Chapter 30, “XRFBATCH
utility”
Chapter 22, “Converting
resources”
Chapter 30, “XRFBATCH
utility”
19-17
XPAF resources
Logos
A logo is a resource that contains an identifying graphical symbol such as
a trademarked company or product name. This term is used in XPAF to
indicate any Xerox centralized resource stored in .LGO file format.
Specifying a logo library
XPAF stores logos in a native centralized logo library. During installation,
your systems programmer used the CLOGOLIB initialization parameter or
LOGOLIB printer profile parameter to name the XOSF DD statement that
specifies the logo library for each centralized printer.
NOTE: Logos do not use a decentralized logo library. XPAF emulates
logos on decentralized printers through the use of decentralized
fonts.
Another parameter that may be specified during system installation and
which can affect your logo library and resource downloading is the
DELLOGO printer profile parameter. DELLOGO can be used to indicate
that logos which are downloaded with a document be deleted from the
printer after the document has been printed. For additional information
about the DELLOGO printer profile parameter, refer to Section Five:
XPAF Parameter and Keyword Reference.
NOTE: On an individual job basis, the DELLOGO and REVLOGO
extended JCL keywords can affect the storing of logos in the logo
library or on the printer. Refer to Section Five: XPAF Parameter and
Keyword Reference for information about the function and format of
these keywords. Refer to Section Four: Printing Documents with
XPAF for information about their usage.
Section Three: Managing Resources with XPAF
19-18
XPAF resources
Loading and maintaining logos
Table 19-5 identifies the options you use and the chapter to which you
should refer for each function needed to manage logo resources.
NOTE: XPAF does not dynamically convert logos. If you want to send
a centralized form that contains a logo to either a decentralized or
PCL-capable printer or PDF device you must first convert the logo to
a decentralized font using the Convert Centralized Logos to
Decentralized Fonts option on the Convert Resources menu.
Table 19-5.
Logo management functions
If you want to ...
Load logos (.LGO format) to a
centralized logo library
Use this option ...
XOAF option:
Load Centralized Logos option on
the Load Resources menu
Refer to this chapter ...
Chapter 21, “Loading
resources to a native library”
TSO/Batch command:
LOAD LOGO
Convert logos (.LGO format) that
are referenced in a centralized
form to decentralized fonts for
printing on a decentralized or
PCL-capable printer or PDF
device.
XOAF option:
Convert Centralized Logos to
Decentralized Fonts option on the
Convert Resources menu
Section Three: Managing Resources with XPAF
Chapter 22, “Converting
resources”
19-19
XPAF resources
Printer-resident resource lists
This section describes resource lists, which are lists of resources that are
resident on a selected printer. Resident resource list processing depends
on whether a printer supports and stores downloaded resources. This
ability is dependent on the printer’s hardware. If multiple printers store
exactly the same resources, they can share a single resource list.
Resource lists can be used in two ways:
•
You can use resource lists to avoid unnecessary resource
downloading each time a job is sent to a printer that normally stores
resources but does not have two-way communication with XPAF. For
example, you can use resource lists for a Nuvera printer in LCDS
mode to enable XPAF to retain a list of resources for the printer
when the printer is drained and then restarted.
•
You can use resource lists for a printer that does not normally store
resources but may have resources (such as cartridge fonts) resident
on the printer.
Resource lists can be maintained for each of these types of resources:
•
•
•
•
Fonts
Forms
Images
Logos
In addition to fonts that have been downloaded, a resident font list should
include default fonts that are built into the hard disk on the printer and any
cartridge fonts.
NOTE: Decentralized printers do not use logo lists. If you convert
logos to decentralized fonts for printing on decentralized printers,
XPAF will automatically include the decentralized fonts in the
decentralized printer’s font list if the printer can store resources.
Section Three: Managing Resources with XPAF
19-20
XPAF resources
Understanding resource list processing
XPAF maintains resource lists for each printer defined to XOSF. They list
the resources which are resident on the printer, either on a printer disk, in
the printer firmware, or on a resource cartridge in the printer.
XPAF maintains a separate resource list for each resource type (font,
form, image, and logo). You can define the list names via the FONTLIST,
FORMLIST, IMAGELIST, and LOGOLIST printer profile parameters, or
you can allow the list name to default to a unique name for each printer
and resource type.
XOSF updates resource lists every time resources are downloaded to a
printer that can store resources, such as a printer that has a disk storage
system. You should store resource lists in an XPAF native library so that
any updates made to them are maintained when you stop and restart the
printer. If a list is not stored in an XPAF native library, XOSF rebuilds a
new list each time you start the printer.
During printing, XOSF searches the resource lists to determine if the
requested resource must be downloaded to the printer. When a document
references a resource that is not in the resource list, XPAF downloads the
resource and XOSF updates the resource list. The next time that resource
is referenced, XOSF determines from the resource list that the resource
already resides on the printer and does not download it again. If you do
not store resource lists, XPAF will download every resource referenced in
a document the first time the document is printed after you restart a
printer. This download occurs even if the resource is already resident on
the printer since the initial resource list will be empty.
Because XPAF cannot use resources that are resident on PCL-capable
printers, resource lists are not required for this type of printer.
Automatic revision of Xerox native resources
If you have loaded a Xerox native resource into a native resource library
and you want XPAF to download the most current resource to a printer,
specify AUTOREV=XEROX (to indicate Xerox native resources) in the
XINSXOSF member in XINPARM or in the printer’s profile. This feature
applies to Xerox native resources only.
You should store all of the resource lists in the XPAF native library to
maintain the date and time stamps for the XOSF automatic revision
feature.
When a resource is referenced in a document, XPAF compares the date
and time stamp of the resource in the resource list with the date and time
stamp of the resource in the native resource library. If the native library
resource is newer than the one indicated in the resource list, XOSF forces
a download of the newer resource to the printer.
For example, if the most current resource is the one in the native resource
library, XPAF downloads that resource to the printer and updates the
resource list. If the most current resource is on the printer, no download
occurs.
If most current resource is . . .
Download to
printer occurs?
Resource list is . . .
In a native resource library
Yes
Updated
On the printer
No
Not updated
Section Three: Managing Resources with XPAF
19-21
XPAF resources
Specifying permanent resources
You should create and maintain resource lists for printers that do not store
resources. These lists allow XOSF to know which resources are present
in the printer’s firmware or resource cartridges. When you create these
resource lists, specify that the resources are permanent to ensure that the
XOSF automatic revision feature will not try to revise them.
Because XOSF does not update resource lists for this type of printer, you
must maintain the resource lists using these options on the Manage
Resource Lists menu to specify that resources are permanent:
•
•
•
•
Manage
Manage
Manage
Manage
Resident
Resident
Resident
Resident
Font Lists
Form Lists
Image Lists
Logo Lists
You can also use these TSO/batch commands to specify permanent
resources:
•
•
TABLE LOAD
TABLE UPDATE
Refer to chapter 23, “Managing resource lists” for more information on
these options and commands.
Section Three: Managing Resources with XPAF
19-22
XPAF resources
Specifying list processing
The DOWNLOAD/NODOWNLOAD setting of the FEATURE printer profile
parameter defines whether a printer supports downloaded resources. The
FILEKEEP/NOFILEKEEP setting of the FEATURE printer profile
parameter indicates whether a printer can store downloaded resources
permanently.
•
A printer that has a FEATURE setting of FILEKEEP can store
downloaded resources permanently. XPAF automatically adds the
resource name to the printer’s resource list when it downloads a
resource. Each printer that uses FEATURE=FILEKEEP must have its
own resource list.
CAUTION: If you delete a resource from a printer, you must
delete it from the corresponding printer’s resource list. This
ensures that XPAF will download the resource if it is referenced
again. Otherwise, unpredictable results may occur. Refer to
chapter 23, “Managing resource lists” for instructions on deleting
a resource from a resource list.
•
A printer that has a FEATURE setting of NOFILEKEEP cannot store
downloaded resources permanently. XPAF downloads all resources
needed for each job but does not update a resource list. This means
that if the same job is printed a second time, the resources will be
downloaded again.
Printers using FEATURE=NOFILEKEEP can share a resource list if
they have the same resident resources (for example, if they use the
same cartridge fonts).
NOTE: XPAF ignores the FILEKEEP/NOFILEKEEP setting of the
FEATURE printer profile parameter for PCL-capable printers
because PCL-capable printers do not store resources.
NOTE: If you specified FEATURE=NODOWNLOAD in your printer’s
profile, XPAF ignores the FILEKEEP/NOFILEKEEP setting.
Section Three: Managing Resources with XPAF
19-23
XPAF resources
Specifying list libraries and list names
During system installation, your systems programmer specified the
following information to XPAF for each printer that can support list
processing:
•
The XOSF DD statement that identifies the native library in which the
lists for resident fonts, forms, images, and logos are maintained for
each printer. This is specified by the LIBRARY printer profile
parameter.
•
The names of each resident font, form, image, and logo list for that
printer. These are specified by the FONTLIST, FORMLIST,
IMAGELIST, and LOGOLIST printer profile parameters.
If your systems programmer specified the LIBRARY parameter but
omitted a list parameter (that is, FONTLIST, FORMLIST, IMAGELIST, or
LOGOLIST) in the printer profile, XPAF will automatically create a list for
that resource type on the printer the first time it downloads a
corresponding resource to the printer. Depending on the resource type,
the list name is created using this convention:
•
For a channel-attached centralized printer, the list name is
FONTcuu, FORMcuu, IMAGcuu, or LOGOcuu, where cuu is the
value specified for the UNIT printer profile parameter.
•
For a remotely-attached centralized printer or a decentralized
printer, the list name is FONTslu, FORMslu, IMAGslu, or LOGOslu,
where slu is the value specified for the SLU printer profile parameter.
However, if your systems programmer did not specify a LIBRARY
parameter in the printer profile, XPAF cannot create resource lists for the
printer.
NOTE: You can cause XPAF to download resources even though
they are named in a particular resource list by including the
REVFONT, REVFORM, REVIMAGE, or REVLOGO extended JCL
keywords in the JCL used to submit a job. Refer to Section Four:
Printing Documents with XPAF for more information about overriding
resources.
Section Three: Managing Resources with XPAF
19-24
XPAF resources
Creating and maintaining resource lists
Table 19-6 identifies the options you use and the chapter to which you
should refer for each function needed to manage resident resource lists.
Table 19-6.
Resident resource list functions
If you want to ...
Create, update, or delete resident
font lists
Use this option ...
XOAF option:
Manage Resident Font Lists option
on the Manage Resource Lists
menu
Refer to this chapter ...
Chapter 23, “Managing
resource lists”
TSO/Batch command:
TABLE LOAD
TABLE UPDATE
TABLE DELETE
Create, update, or delete resident
form lists
XOAF option:
Manage Resident Form Lists
option on the Manage Resource
Lists menu
Chapter 23, “Managing
resource lists”
TSO/Batch command:
TABLE LOAD
TABLE UPDATE
TABLE DELETE
Create, update, or delete resident
image lists
XOAF option:
Manage Resident Image Lists
option on the Manage Resource
Lists menu
Chapter 23, “Managing
resource lists”
TSO/Batch command:
TABLE LOAD
TABLE UPDATE
TABLE DELETE
Create, update, or delete resident
logo lists
XOAF option:
Manage Resident Logo Lists
option on the Manage Resource
Lists menu
TSO/Batch command:
TABLE LOAD
TABLE UPDATE
TABLE DELETE
Section Three: Managing Resources with XPAF
Chapter 23, “Managing
resource lists”
Chapter 23, “Managing
resource lists”
19-25
XPAF resources
Automatic revision of AFP resources
XPAF supports the automatic revision of AFP resources for centralized,
decentralized, and PCL-capable printers. This support allows you to
automatically revise updated AFP resources when they are first
referenced within a document. XPAF will read the latest copy of an AFP
resource whenever access to that AFP resource is required for
processing. You do not have to explicitly specify a revision of these
resources or a refresh of the entire AFP resource library. AFP documents
will print using the most current version of the resource, not a copy that
was available at initialization or refresh time.
When processing AFP applications, XPAF also examines the ISPF
statistics field for the IBM PDS members to identify changes to those
members since the last XPAF conversion.
Limitations of support
Automatic revision of AFP resources is limited to the following types of
AFP resources:
•
•
•
•
Overlays
Page segments
Form definitions
Page definitions
NOTE: AFP font resources are not eligible for automatic revision.
Processing Xerox native resources within AFP data
streams
Because AFP overlay and page segment resources are converted into
Xerox .FRMs and .IMGs, Xerox native resources within AFP data streams
are subject to automatic revision. This support includes Xerox AFP replica
fonts.
Processing page segments embedded within overlays
When a page segment embedded within an unchanged AFP overlay is
revised automatically, the entire overlay, including any embedded page
segments, is also revised.
Section Three: Managing Resources with XPAF
19-26
XPAF resources
Enabling support
Automatic revision of AFP resources is enabled via the AUTOREV
initialization or printer profile parameter. Specify AUTOREV=A to indicate
revision of AFP resources or AUTOREV=B to indicate revision of both
AFP resources and Xerox native resources. Refer to Section Five: XPAF
Parameter and Keyword Reference for additional information.
Determining changes in AFP resource members
AFP resources reside as members in a PDS or PDS/E library. Whenever
a PDS or PDS/E member is updated, the unique TTR address of that
member is changed. This unique TTR value is accessible via the directory
entry of the modified member. Statistics, such as the date and time of the
latest update to a member, may also be present in the directory entry.
XPAF uses the TTR value and any available date and time statistics to
determine whether an AFP resource member has changed.
Section Three: Managing Resources with XPAF
19-27
XPAF resources
Print description language
Print description language (PDL) is the language used to describe printing
jobs to a laser printer. PDL describes the input (type, format,
characteristics), performs the processing functions (logical processing),
and describes the output (type, format, font selection, accounting
options).
PDL files can be created on a centralized printer or on your host
computer. For instructions on coding and compiling PDL, refer to the PDL
reference manual distributed with your Xerox printer.
Before using XPAF to print documents that reference PDL, you must
ensure that the same PDL members which are compiled on the printer are
loaded into the native PDL library for that printer. When they have been
loaded to the native library, PDL members are available for centralized
processing and for using in DJDE data streams sent to decentralized,
PCL-capable and PDF printers.
PDL object management
XPAF can manage PDL object resource files (types of JDL, PDE, CME,
TST, STK, LIB, or IDR) for centralized printers in the same manner as
fonts, forms, images and logos. This means that when a data stream
references a PDL object, it will be downloaded to the centralized printer if
it is determined that the resource is not already on the printer. This feature
is enabled by specifying PDLOBJ=YES in the printer profile.
JDL objects must first be loaded into the PDLLIB with the PDL loader in
the same manner as JSL source is loaded. It is important that the PDL
object corresponds to the source JSL for that object and that the source
JSL is also loaded into the same PDLLIB.
XOSF processing will recognize when a JDL object is referenced in the
data stream or the started JDL. By keeping a list of all JDL objects already
downloaded to a printer, the centralized conditioner will determine when
a referenced JDL object needs to be downloaded to the printer and will
retrieve it from the PDLLIB and download it to the printer. The PDLOBJ
resource list will be updated so that future references to the same JDL
object will not cause the resource to be downloaded again. If LIBRARY=
is specified in the printer profile the resource lists will be saved in that
library when the printer is stopped and retrieved when the printer is
started again. This will ensure that unnecessary downloading is avoided
between printer stops and starts. If AUTOREV=XEROX or BOTH has
been specified, it will also apply to PDL object resources.
It is important to note that different versions of printer OSS software
generate different levels of PDL object code. This may be generated by
the PDL command at the printer or by using an offline tool such as XJDC.
The printer OSS software level is typically known as V35 for 4050 and
4090 printers, V37 for 4850 and 4890 printers, and V3A for 4135, 4635
and any of the other channel-attached printers that support large paper
sizes such as 11x17-inches. There is a printer profile parameter to inform
XPAF which software version is running on any particular printer. The
parameter is LPSRELEASE= and the default values are as listed above
under the typical values.
When the PDL loader is used to load PDL objects, the PCLVER value is
used as part of the member name in the PDLLIB. When the centralized
conditioner downloads a PDL object, it attempts to match the PCLVER in
the member name to the LPSRELEASE value in the printer profile to
ensure that the downloaded code is the "best-fit" for the destination
printer. If an exact match to LPSRELEASE is not found, the first object
Section Three: Managing Resources with XPAF
19-28
XPAF resources
with the correct name and type will be downloaded. If none is found a
message is produced. If incorrect default values are entered,
unpredictable results may occur. In some cases (PDEs, STKs, TSTs,
LIBs, and IDRs) the object code has no PCLVER restrictions. JDL and
CME objects may be fully compatible also, for example, a JDL compiled
for a 4090 (V35) will run perfectly on a 4890 or 4635 because it will have
no unique requirements that the 4890 or 4635 do not support. This may
not be true of a JDL compiled on a 4890 or 4635 because they may have
ink or large paper size requirements that the 4090 does not support.
Enabling PDL object management
Follow these steps to enable PDL object management:
Step 1.
Load source JSL to the PDLLIB (existing requirement).
Step 2.
Load PDL objects to the PDLLIB with the appropriate PCLVER value. The
default is V35 and, if there are no color or large paper requirements, this
value will be sufficient.
Step 3.
Specify PDLOBJ=YES in your printer profile(s). This is honored for
centralized printers only.
Step 4.
Ensure that LIBRARY= has been specified in the printer profiles if you
want the resource lists maintained between printer stops and starts. The
recommended library to use is LIBRARY=XWRLIB.
Specifying PDL source file types
PDL consists of two file types:
•
•
Job source library (JSL) files
Cataloged member files
Section Three: Managing Resources with XPAF
19-29
XPAF resources
JSL format
A JSL file begins with a JDL command, includes system, catalog, and job
level commands, and ends with an END command. For example:
SAMPLE: JDL;
VFU1:
VFU
ASSIGN=(1,1),
TOF=1,
BOF=255;
FMT01:
PDE
PMODE=LANDSCAPE,
FONTS=L0112B,
BEGIN=(.18,.66);
STK2:
STOCKSET ASSIGN=('MAIN',MAIN),
ASSIGN=('AUX',AUX),
INIFEED='MAIN',
SYSPAGE='MAIN';
.
. (additional JSL statements)
.
END;
Cataloged member format
A cataloged member (also referred to as a global member) is one of the
following types of statements that will be referenced globally.
•
A copy modification entry (CME) is a set of statements that modifies
the output printing characteristics of a report by defining fonts, inks,
and constant data to be applied to specific print lines and columns.
•
A page description entry (PDE) is a set of statements that defines
page characteristics. These characteristics are the page orientation
(PMODE), logical page definitions (BEGINs), and fonts used with
line spacing (FONTS).
•
A stockset (STK) is a set of statements that defines a set of stocks
used in a report. Stocksets are also the means of associating stock
references (FEED=) with stock names (CLUSTERs).
•
An RTEXT (TST) definition is a set of statements defining text to be
printed on a separate page at the beginning of a report.
•
An ink descriptor entry (IDR) is a set of statements that defines the
ink catalogs, palette, and ink list to be used for used in a report.
•
A short-edge-feed MAP (LIB) is a set of statements that defines a
font substitution list to be used to print a document on large paper
that is fed short edge rather than long edge.
Section Three: Managing Resources with XPAF
19-30
XPAF resources
Some examples are shown below.
CME1:
END;
FMT1:
FMT2:
FMT3:
END;
CME LINE=1, POS=1, CONSTANT='MONTHLY TOTALS:';
PDE
PDE
PDE
BEGIN=(.18,.66),FONT=L0112B,PMODE=LANDSCAPE;
BEGIN=(.18,.50),FONT=L0212A,PMODE=LANDSCAPE;
BEGIN=(.14,.66),FONT=L0312A,PMODE=LANDSCAPE;
Using distributed sample PDL members
XPAF provides several sample PDL members in XPFSAMP, as shown in
table 19-7. You can copy and edit any of these members to create your
own PDL.
Table 19-7.
Sample PDL members in XPFSAMP
Member name
Description
DFAULT
Contains a JSL you can use to print online jobs or
output that was written to file.
GLOBJSL
Contains standard PDE members that can be
referenced by multiple JSLs or DJDEs.
Specifying a native PDL library
XPAF provides a native library for storing PDL called PDLLIB, which
contains the same JSL and cataloged members as the DFAULT and
GLOBJSL members in XPFSAMP.
You also can name your own native library by specifying it in the XOSF
start-up proc DD statement named by the PDLLIB initialization or printer
profile parameter. Each printer can name its own native PDL library, or all
printers can share one common native PDL library.
Section Three: Managing Resources with XPAF
19-31
XPAF resources
Creating and loading PDL
Before using XPAF to print documents that reference PDL, you must
ensure that the same PDL members which are compiled on the printer are
loaded into the native PDL library for that printer. When they have been
loaded to the native library, PDL members are available for centralized
processing and for using in DJDE data streams sent to decentralized and
PCL-capable printers and PDF devices.
CAUTION: You must ensure that the PDL members compiled on the
printer are identical to those loaded to the native PDL library, or your
results will be unpredictable.
Perform one of the following procedures to ensure that the PDL on the
printer matches the PDL on the host:
Option 1: Maintaining PDL on the printer
Step 1.
Create or update PDL source members on the printer.
Step 2.
Compile the members into object code on the printer.
Step 3.
Upload the PDL source members to a PDS on the host.
Step 4.
Use one of these options to load the host members to a native PDL library:
•
•
Load PDL option on the Load Resources menu
Load PDL TSO/batch command
Refer to chapter 21, “Loading resources to a native library” for more
information on the Load PDL option or LOAD PDL TSO/batch command.
Option 2: Maintaining PDL on the host
Step 1.
Create or update PDL source members on the host.
Step 2.
Download the host members to the printer and compile them into object
code on the printer.
Step 3.
Use one of these options to load the host members to a native PDL library:
•
•
Load PDL option on the Load Resources menu
LOAD PDL TSO/batch command
Refer to chapter 21, “Loading resources to a native library” for more
information on the Load PDL option or LOAD PDL TSO/batch command.
Section Three: Managing Resources with XPAF
19-32
XPAF resources
Page formats
A Xerox page format is a set of specifications used to format line-mode
data streams before sending them to the printer. A page format allows you
to enhance the effectiveness of your line-mode applications without
changing the application program.
You can incorporate fonts, forms (.FRM format only), images, logos,
highlight color, and many other features by using page formats. In
addition, the conditional formatting feature allows you to change page
features dynamically based on conditions within the input stream.
Specifying a page format library
During system installation, your systems programmer named the XOSF
DD statement that specifies the name of the page format library at the
system level using the PGFRMDD initialization parameter or at the printer
level using the PAGEFORMLIB printer profile parameter. For more
information about these parameters, refer to Section Five: XPAF
Parameter and Keyword Reference.
Understanding page format processing
You use the Xerox page format editor to create and compile a Xerox page
format. The page format then can be invoked in a line-mode application
by using the PAGEFORM extended JCL keyword. Refer to Section Eight:
Xerox Page Format Editor User Guide for information about creating and
using page formats.
During processing, XPAF will retrieve the page format from the page
format library and use it to convert line-mode data into either a Metacode
or XES data stream. Any .FRM forms referenced in a page-formatted
document and sent to a decentralized printer will be converted
dynamically to XES format. The XES version of the form will be stored in
the decentralized library named by the DFORMLIB initialization
parameter or FORMLIB printer profile parameter.
NOTE: On an individual job basis, the USERLIB IBM JCL keyword
can affect the storing of forms referenced by a page format on the
printer. Refer to Section Five: XPAF Parameter and Keyword
Reference for information about the function and format of this
keyword. Refer to Section Four: Printing Documents with XPAF for
information about its usage.
Creating and maintaining page format datasets
You can create and maintain page format datasets through option P on
the System Services menu. Refer to Section Eight: Xerox Page Format
Editor User Guide for detailed information about setting up and
maintaining page format datasets.
Section Three: Managing Resources with XPAF
19-33
XPAF resources
Section Three: Managing Resources with XPAF
19-34
XPAF tables
20.
20
XPAF tables
This chapter describes the following tables that XPAF uses during
processing:
•
Paper-related tables
•
Font tables
•
Color cross-reference tables
•
Color conversion table
NOTE: Before you can manage your resources, you will need to know
the names of the table libraries at your site. The XOAF and/or XOSF
DD statements that specify the library names typically are identified
by your systems programmer during installation using initialization
and printer profile parameters. Refer to appendix C, “Resource
management parameters” for a list of parameters whose values you
will need to know.
Section Three: Managing Resources with XPAF
20-1
XPAF tables
Paper-related tables
The paper-related tables are a set of tables used by XPAF to determine
paper size, AFP bin number, and paper tray processing. The
paper-related tables are stored in a native library specified by the XOSF
DD statement identified by your systems programmer during installation
using the PAPTBLDD initialization or printer profile parameter. XPAF
supplies default paper-related tables in TABLELIB.
XPAF uses three types of paper-related tables:
Table 20-1.
Types of paper-related tables
Table
Function
Paper name
This table is used to assign paper sizes to paper names. XPAF uses these values
to determine which paper size to use when formatting a document. You can specify
the currently active paper name table with the PAPNAMTB initialization parameter,
printer profile parameter, or extended JCL keyword.
Varying paper size
This table is used to map AFP bin numbers to paper names. These paper names
are then matched to paper sizes in the currently active paper name table. You can
specify the currently active varying paper size table with the VARPAPTB
initialization parameter, printer profile parameter, or extended JCL keyword.
Cluster mapping
This table is used to map centralized paper tray cluster names to paper trays on
decentralized and PCL-capable printers. Each paper tray is mapped to a tray select
character. You can specify the currently active cluster mapping table with the
CLUSTRTB printer profile parameter or extended JCL keyword.
XPAF uses the currently active paper name table to determine the paper
size that corresponds to a paper name specified in any of these locations:
•
The PAPERSIZ initialization parameter, printer profile parameter, or
extended JCL keyword
•
A varying paper size table
•
The active JDE PAPERSIZE= value
Refer to Section Five: XPAF Parameter and Keyword Reference for more
information about how to use the PAPTBLDD, PAPNAMTB, VARPAPTB,
CLUSTRTB, and PAPERSIZ parameters and keywords.
CAUTION: XPAF cannot verify that the specified paper size matches
the paper size that actually is loaded in the specified paper tray on
the target printer. You must ensure that each printer tray contains the
paper that corresponds to the currently active XPAF paper-related
tables.
Creating a new paper-related table
You can create a new paper-related table or modify or delete any existing
paper-related tables through the Maintain Paper Tables option on the
Section Three: Managing Resources with XPAF
20-2
XPAF tables
Manage Tables menu. Refer to chapter 24, “Managing XPAF tables” for
information about how to use the XOAF panels to maintain the
paper-related tables.
Table type prefixes
When you specify a paper-related table name in the applicable
parameters, keywords, or XOAF panels, XPAF automatically will prefix
that name with one of these table type abbreviations:
•
•
•
PNAM for paper name table
VPSZ for varying paper size table
CMAP for cluster mapping table
For example, if you specify PAPER01 for the PAPNAMTB initialization
parameter, XPAF will reference the table in TABLELIB as
PNAMPAPER01. Or, if you create a varying paper size table using the
Maintain Paper Tables option and specify VARSIZE01 in the ‘Member
Name’ field, XPAF stores the member as VPSZVARSIZE01 in TABLELIB.
If you use the Maintain Paper Tables option to edit this table, do not
specify the prefix portion of the name in the ‘Member Name’ field.
However, you will see these prefixes if you view the contents of TABLELIB
during an LDM OFFLOAD or if you use the Display a Directory of Library
Members option on the Manage Libraries menu.
Default table names
Each paper-related table has a default table named DEFAULT. These
default tables are used during XOAF processing. When you create a new
table, the entries from the default table are used as initial field values,
which you can then modify. When you update a table, if you leave the
‘Member Name’ field blank, the default table will be substituted. Each
default table is stored in TABLELIB using the appropriate table type prefix
as previously defined.
Cluster mapping tables also have a default table for every decentralized
and PCL-capable printer model supported by XPAF. These tables use the
naming convention DEFAULTxxxx, where xxxx is the printer model. For
example, the 4235’s default cluster mapping table is named
DEFAULT4235. The default cluster mapping table for all NPS printers is
named DEFAULTDPNP. Printers configured with the same paper tray
definitions can share the same cluster mapping table.
NOTE: The paper name in the default varying paper size and cluster
mapping tables defaults to LETTER. To set the default paper name in
these tables to A4, specify OPTIONS=A4 in the #GENRSC macro.
For further information, refer to Section Two: Installing and
Customizing XPAF.
Paper name table
The paper name table allows you to assign a paper size to a generic
name. For example, 8-1/2- by 11-inch paper is known as LETTER. You
Section Three: Managing Resources with XPAF
20-3
XPAF tables
could define your company letter head as LTRHEAD or another name of
your choice.
This section provides the following information about the paper name
table:
•
The default values supplied with XPAF
•
How to define and use values other than the supplied defaults for the
paper name table
•
How XPAF processes the paper name table
Default table values
A default paper name table called DEFAULT is supplied with XPAF in
TABLELIB. Table 20-2 shows the values defined for the default paper
name table.
Table 20-2.
Default paper name table values
Paper name
Width
Height
Unit measure
#10
4.25
9.5
IN
#7
3.78
7.5
IN
A3
11.69
16.54
IN
A4
8.27
11.69
IN
A5
5.83
8.27
IN
A6
4.12
5.83
IN
B4
9.84
13.9
IN
B5
6.93
9.84
IN
C5
6.38
9.02
IN
DL
4.33
8.66
IN
EXEC
7.25
10.5
IN
LEGAL
8.5
14
IN
LEGL13
8.5
13
IN
LETTER
8.5
11
IN
LONG
11
17
IN
POST
3.5
5.5
IN
STATMT
5.5
8.5
IN
Section Three: Managing Resources with XPAF
20-4
XPAF tables
Table specification
You can change the dimensions for a paper name already defined in a
paper name table by using the Maintain Paper Tables option. For
example, you may change the dimensions for LEGAL from 8.5 by 14
inches to 8.25 by 13.5 inches. Then, when you specify LEGAL in the
PAPERSIZ initialization parameter, printer profile parameter, or extended
JCL keyword, XPAF will use the dimensions of 8.25 by 13.5 inches to
format your document.
You can also add new paper names to a paper name table by using the
Maintain Paper Tables option, then specify those names in PAPERSIZ.
For example, you may add a new paper name called NEWSIZ which has
the dimensions of 7 by 8 inches. If you then specify PAPERSIZ=NEWSIZ
in your initialization parameters, printer profile, or extended JCL, XPAF
will reference the NEWSIZ dimensions in the currently active paper name
table and format the document for the paper size of 7 by 8 inches.
NOTE: For these examples to work, you must specify the paper name
table in which you have defined LEGAL or NEWSIZ in the
PAPNAMTB initialization parameter, printer profile parameter, or
extended JCL keyword.
Table processing
XPAF looks up the paper name specified in the PAPERSIZ initialization
parameter, printer profile parameter, or extended JCL keyword in the
currently active paper name table. However, if you enter the width, height,
and unit dimensions in the PAPERSIZ printer profile parameter or
extended JCL keyword, XPAF uses those dimensions and not the ones
from the paper name table.
If you specify a paper name (such as LEGAL) for PAPERSIZ, XPAF
checks to see if a paper name table has been specified through the
PAPNAMTB initialization parameter, printer profile parameter, or
extended JCL keyword.
•
If no paper name table is specified, XPAF uses the default paper
name table (DEFAULT) to determine the paper dimensions for the
document.
•
If a paper name table is specified or if the default paper name table
is used, XPAF looks in that table to determine the paper dimensions
to use for the document.
—
If the specified paper name exists in the currently active paper
name table, XPAF uses the paper size defined for that paper
name.
—
If the specified paper name is not defined in the currently active
paper name table but is defined through PAPERSIZ (for
example, LEGAL is predefined as 8.5 by 14 inches), XPAF uses
PAPERSIZ’s definition for the paper dimensions.
—
If the specified paper name is not defined either in the currently
active paper name table or through PAPERSIZ, XPAF uses the
hard-coded default value of 8.5 by 11 inches for the paper
dimensions.
Section Three: Managing Resources with XPAF
20-5
XPAF tables
Table 20-3 summarizes the overrides for paper size processing as related
to the paper name table.
Table 20-3.
Paper name table processing overrides
IF PAPERSIZ value is ...
Width, Height, Units (for printer
profile parameter and extended
JCL keyword only)
And paper name
table is ...
ignored
And paper name
in table ...
not applicable
Example:
PAPERSIZ=(9P5,11P0,IN)
1
The value
used is...
Width, Height, Units
9.5 by 11 inches
Paper name
specified
does exist
Dimensions defined
for LEGAL in paper
name table
Example: PAPERSIZ=LEGAL
PAPNAMTB=PAPER01
LEGAL
(8.5 by 20 inches 1)
8.5 by 20 inches
Paper name
specified
does not exist
Default dimensions
defined for A4 in
PAPERSIZ
Example: PAPERSIZ=A4
PAPNAMTB=PAPER01
no entry for A4
8.27 by 11.69
inches
Paper name
specified
does not exist
Default value of 8.5
by 11 inches
Example: PAPERSIZ=NEWSIZ
PAPNAMTB=PAPER01
no entry for
NEWSIZ
8.5 by 11 inches
Paper name
not specified or invalid
table
not applicable
Dimensions defined
for LEGAL in
PAPERSIZ
Example: PAPERSIZ=LEGAL
PAPNAMTB=
Paper name
not specified or invalid
table
Example: PAPERSIZ=NEWSIZ
PAPNAMTB=
8.5 by 14 inches
not applicable
Default value of 8.5
by 11 inches
8.5 by 11 inches
You updated the value of LEGAL in PAPER01 to be 8.5 by 20 inches.
Section Three: Managing Resources with XPAF
20-6
XPAF tables
Varying paper size table
An AFP document can use more than one paper size if you specify a
different bin number for each paper size in the MMC structured field of the
copy subgroup within the medium map. For example, you may include
oversized statement sheets with a cover letter.
For XPAF to process this type of document, each bin number must be
mapped to a paper name in the varying paper size table. The paper name
is then mapped to a paper size in the paper name table.
This section provides the following information about the varying paper
size table:
•
The default values supplied with XPAF
•
How to define and use values other than the supplied defaults for the
varying paper size table
•
How XPAF processes the varying paper size table
Default table values
A default varying paper size table called DEFAULT is supplied with XPAF
in TABLELIB. Table 20-4 shows the values defined for the default varying
paper size table. The first row is the table’s default entry and is used if a
bin number error is encountered during processing.
Table 20-4.
AFP bin #
Default varying paper size table values
Paper
name
Tray
Select
CEP
FEED
JDE
JDL
00
LETTER
1
MAIN
PGMODE
DFAULT
01
LETTER
1
MAIN
PGMODE
DFAULT
02
A4
1
MAIN
PGA4
DFAULT
03
LEGAL
1
MAIN
PG14
DFAULT
04
LONG
1
MAIN
PG1711
DFAULT
NOTE: The paper name for the default entry (AFP Bin # 00) defaults
to LETTER. To set the default paper name to A4 (which also changes
the JDE to PGA4), specify OPTIONS=A4 in the #GENRSC macro.
For further information, refer to Section Two: Installing and
Customizing XPAF.
Section Three: Managing Resources with XPAF
20-7
XPAF tables
Table specification
To enable this feature, you must specify a varying paper size table using
the VARPAPTB initialization parameter, printer profile parameter, or
extended JCL keyword.
For varying paper size table processing to work correctly, you must add a
table entry using the Maintain Paper Tables option to the varying paper
size table for each AFP bin number specified in the MMC structured fields.
This table entry includes a paper name, an XES printer tray value, a
centralized FEED command, and the associated JDE and JDL
commands.
When userlibs are used in conjunction with varying paper size tables, and
a JDL/JDE switch occurs, the RSTACK initialization parameter may affect
document processing. For RSTACK settings E, N, or O, resources may be
referenced across JDL/JDE environments. For RSTACK settings S, B, or
G, resources referenced in the previous JDL/JDE environment will not be
valid because a program and printer reset is performed when the
RSTACK is processed. You must determine the correct setting for your
environment.
NOTE: The JDE/JDL commands from the varying paper size table will
be included in the data stream. The corresponding JDE/JDL on the
printer must specify paper size dimensions which match the paper
size dimensions obtained from the paper name table for this paper
name.
Table processing
When XPAF encounters an AFP bin number in a data stream, processing
for the varying paper sizes occurs as follows:
•
If the bin number matches an entry in the varying paper size table,
the paper name in the varying paper size table is matched to a paper
name in the paper name table to determine the paper size.
•
If the bin number does not match an entry in the varying paper size
table, XPAF uses the default entry in the varying paper size table to
determine the paper size. The first entry is always the default entry
in a varying paper size table.
NOTE: The default paper name for the default entry in the
varying paper size table is either LETTER or A4, depending on
your entry in the OPTIONS parameter of the #GENRSC macro.
However, if you have modified either the paper name value in
this table or the dimensions specified for this paper name in a
paper name table, the modified value is used as the paper size.
•
If any errors are encountered while processing the paper name or
varying paper size tables, XPAF uses the value from the PAPERSIZ
initialization parameter, printer profile parameter, or extended JCL
keyword.
Section Three: Managing Resources with XPAF
20-8
XPAF tables
Once a paper name is obtained from PAPERSIZ, XPAF matches it to
a paper name in the paper name table to determine the paper size.
Table 20-5 shows examples of the relationship between the varying paper
size table, the paper name table, and the PAPERSIZ value.
Table 20-5.
Varying paper size table processing examples
Varying paper size
table entries
AFP Bin #: 1
Paper name
table
specified?
Paper name
found in table?
PAPERSIZ
value
Yes
Yes
Not applicable
Dimensions for NEWSIZ
from paper name table
Yes
No
LETTER
Dimensions for LETTER
from paper name table
No
Not applicable
A4
Dimensions for A4 from
PAPERSIZ
Yes
Yes
Not applicable
Dimensions for LETTER
from paper name table
Yes
No
LEGAL
Dimensions for LEGAL
from paper name table
No
Not applicable
A4
Dimensions for A4 from
PAPERSIZ
Yes 1
Not applicable 1
LEGAL 2
Dimensions for LEGAL
from paper name table
Paper Name: NEWSIZ
AFP Bin #: 1
Paper Name: NEWSIZ
AFP Bin #: 1
Paper Name: NEWSIZ
AFP Bin #: undefined
Paper Name: uses
default value (LETTER)
AFP Bin #: undefined
Paper Name: uses
default value (LETTER)
AFP Bin #: undefined
Paper Name: uses
default value (LETTER)
No varying paper size
table defined
1
2
Actual paper size used
If there is no valid varying paper size table defined, XPAF looks at PAPERSIZ to obtain a paper name. Then, XPAF looks at the
currently active paper name table to determine the paper size associated with the paper name.
The tray selection processing described in “Tray selection for undefined/invalid varying paper size table conditions” later in this
chapter takes affect when the varying paper size table is not valid or undefined.
Section Three: Managing Resources with XPAF
20-9
XPAF tables
Tray selection for undefined/invalid varying paper size table
conditions
If the varying paper size table is either not specified, invalid, or specified
but cannot be opened, tray selection is determined in the following
manner:
•
For centralized printers, XOSF uses the bin number specified in the
MMC structured field to generate a DJDE FEED command. Table
20-6 shows the DJDE FEED command generated for each bin
number.
Table 20-6.
AFP paper tray selection without varying
paper size table for centralized printers
Bin number
DJDE FEED command
0, 1
MAIN
2
AUX
3
TRAY3 1
4
TRAY4 1
5
TRAY5 1
6
TRAY6 1
7
TRAY7 1
8
TRAY8 1
9
TRAY9 1
1
If bins 3 through 9 are specified in the MMC structured field, these cluster
names must be valid for the printer on which the document will be printed.
•
For decentralized and PCL-capable printers, XOSF issues a tray
select command based on three criteria:
—
—
—
AFP bin number within the copy group
Paper name specified in PAPERSIZ
Printer type
Table 20-7 lists the tray select command XOSF issues to PCL-capable
printers based on whether the primary or auxiliary feed is used and based
on the paper name specified in PAPERSIZ.
For both decentralized and PCL-capable printers, if no AFP bin number or
AFP bin number 1 is specified within the copy group, XOSF uses the
primary feed. If any AFP bin number other than 1 is specified within the
copy group, XOSF uses the auxiliary feed.
Section Three: Managing Resources with XPAF
20-10
XPAF tables
For example, as shown in table 20-7, if AFP bin number 1 is specified
within the copy group and LEGAL is specified in PAPERSIZ, XOSF will
issue tray select command 1 to a DocuSP printer. If AFP bin number 2 is
specified within the copy group and LEGAL is specified in PAPERSIZ,
XOSF will issue tray select command 4 to a DocuSP printer 2.
Table 20-7.
AFP paper tray selection without varying paper size table for
PCL-capable printers
PAPER- SIZ
value
NPS printers
Prim
Prim
Aux
Prim
#10
2
2
EF/BF 3
#7
2
2
EF/BF
A3
1
4
1-3
1
4
1-5
A5
1
2
1
A6
1
4
BF
B4
1
4
B5
2
2
EF/BF
C5
2
2
EF/BF
DL
2
2
EF/BF
EXEC
1
4
1
1
4
1-3
1
4
1-3
1
4
1-5
LONG
1
4
1-3
POST
2
2
STATMT
1
4
A4
LEGAL
1
1
LEGL13
LETTER
1
Aux
DocuSP printers N-series printers
Section Three: Managing Resources with XPAF
Aux
1
20-11
XPAF tables
Cluster mapping table
When printing DJDE data streams on decentralized or PCL-capable
printers, XPAF uses cluster mapping tables to map a centralized paper
tray cluster name to a paper tray on the decentralized or PCL-capable
printer. Each cluster name is mapped to an XES or PCL tray select code.
NOTE: Remapping paper trays on the printer is not supported by
XPAF. Use the cluster mapping tables instead to map a centralized
paper tray cluster name to a paper tray on a decentralized or
PCL-capable printer.
This section provides the following information about the cluster mapping
table:
•
The default values supplied with XPAF
•
How to define and use values other than the supplied defaults for the
cluster mapping table
•
How XPAF processes the cluster mapping table
Default table values
A default cluster mapping table is supplied with XPAF in TABLELIB for
each decentralized or PCL-capable printer model. Each table is named
DEFAULTxxxx, where xxxx represents the first four characters of the
printer model.
Once the cluster mapping table name has been determined, the entry
within that table with blanks for the cluster name is the default entry and
will be used when a cluster name is referenced that is not in the table.
Section Three: Managing Resources with XPAF
20-12
XPAF tables
A default cluster mapping table named DEFAULT is also supplied in
TABLELIB. This default table, shown in table 20-8, is used by XOAF and
represents a generic printer.
Table 20-8.
Default cluster mapping table values
Cluster name
Paper name
Tray Select
LETTER
1
AUX
LETTER
2
MAIN
LETTER
1
OPR
LETTER
1
TRAY1
LETTER
1
TRAY2
LETTER
2
TRAY3
LETTER
3
TRAY4
LETTER
4
The paper name for each entry defaults to LETTER. To set the default
paper name to A4, specify OPTIONS=A4 in the #GENRSC macro during
the resource installation. For more information, refer to Section Two:
Installing and Customizing XPAF.
Table specification
You can create new cluster mapping tables using the Maintain Paper
Tables option and specify them in the CLUSTRTB printer profile
parameter or extended JCL keyword. Printers configured with the same
paper tray definitions can share the same cluster mapping table.
For cluster mapping table processing to work correctly, each value
specified in the FEED DJDE or extended JCL keyword must match a
cluster name in the cluster mapping table.
Section Three: Managing Resources with XPAF
20-13
XPAF tables
Table processing
CAUTION: If you specify a value for PAPERSIZ in your extended
JCL, that value overrides all paper name values in your currently
active cluster mapping table. Therefore, the paper name processing
described in this section does not apply. However, all other cluster
mapping table processing occurs normally.
When XPAF encounters a value for the FEED= parameter (in PDLLIB, a
DJDE, or extended JCL), while processing a data stream being sent to a
decentralized or PCL-capable printer, cluster mapping table processing
occurs as follows:
•
If the cluster name matches an entry in the cluster mapping table,
the tray select code is retrieved. The tray select code is used to
select the correct paper tray on the decentralized or PCL-capable
printer.
•
If the cluster name does not match an entry in the cluster mapping
table, XPAF uses the default entry (with a blank cluster name) to
determine the tray select code.
•
If any errors are encountered while processing the paper name
table, XPAF uses the value from the PAPERSIZ initialization or
printer profile parameter to determine the paper size.
Tray selection for invalid/override paper name conditions
If the paper name entry that matches the cluster name field in the cluster
mapping table is not used because of an invalid or override condition,
XPAF still determines tray selection based on the valid cluster name in the
table. You must ensure that the correct size paper is loaded in the correct
tray of the target printer. For example, if you specify FEED=MAIN and
PAPERSIZ=LEGAL in your extended JCL, XPAF would assume that legal
size paper is loaded in tray 1 for this cluster mapping table:
Cluster name
Paper name
Tray Select
LETTER
1
AUX
LEGAL
2
MAIN
LETTER
1
Section Three: Managing Resources with XPAF
20-14
XPAF tables
Font tables
The font tables are a set of tables related to font processing. The font
tables are stored in the native library identified by the XOAF and XOSF
DD statements that were specified by your systems programmer during
installation using the FNTTBLDD initialization parameter. For more
information about this parameter, refer to Section Five: XPAF Parameter
and Keyword Reference.
The font table members can be categorized as follows:
•
Xerox font-related tables. These tables are used by XPAF when
converting centralized fonts to decentralized fonts, for printing
centralized (DJDE) documents on decentralized printers, and for
printing page-formatted documents.
•
Replica font-related tables. These tables are used by XPAF when
printing AFP documents on Xerox printers.
Some of the table members can be updated through various XOAF
options and their TSO/batch equivalents. Those members that cannot be
updated through XOAF can be viewed through the Display a Directory of
Library Members option on the Manage Libraries menu. Refer to chapter
27, “Managing XPAF libraries” for information about how to use this
option.
The role of each table during XPAF processing and the XOAF options
available to update each table are discussed in detail later in this chapter.
The conditions under which you will need to update one or more of the
tables also are identified.
NOTE: If you plan to use only the XPAF-distributed Xerox and replica
fonts without any modification, you do need to update these tables.
Concepts
Before you can update the font table members, you should be familiar with
the following concepts.
Character identifier
A character identifier (also known as a CHARID) is a unique 8-character
name that identifies a single IBM character. A given character identifier
will map to the same character. For example, the character identifier
LA020000 always maps to “A”.
Section Three: Managing Resources with XPAF
20-15
XPAF tables
Character set
A character set is a collection of character properties and raster images
for a group of character identifiers. A character set may contain any
number of characters.
The character set properties define characteristics at two levels:
•
Those that apply to all characters within the character set. This
includes the following information:
—
—
—
•
Typeface name
Point size
Weight, style, and font width (such as condensed) of the
characters
Those that apply to individual characters. This includes the following
information:
—
—
—
Baseline of a character showing its general alignment
Dimensions of the character
Position of the raster within the character cell
Character map
A character map links a character identifier to an ASCII or EBCDIC value
that identifies a location within a font.
Code page
A code page links a code point (X'00' – X'FF') to a character identifier.
This disassociation of the code point from the raster pattern allows for the
dynamic mapping of hexadecimal values to the same or different images,
depending on the code page mapping.
A code page can contain a complete character set or a subset of that
character set. A single IBM code page can identify up to 256 code
point/character identifier pairs.
For fonts used on a centralized printer, the code page (which is also called
a character map) can define no more than 240 printable characters. For
fonts used on a decentralized printer, the code page definition cannot
exceed 192 printable characters. In the Xerox environment, some
characters are reserved for print commands such as Form Feed.
A default character is defined in each code page. This character is printed
if an undefined code point is encountered during printing.
Section Three: Managing Resources with XPAF
20-16
XPAF tables
Coded font
A coded font links a code page, which typically is EBCDIC, to a character
set, as shown in this example.
Coded font
Code page
Character set
Code point
CHARID
CHARID
Raster
X'81'
LA010000
LA010000
a
X'C1'
LA020000
LA020000
A
X'82'
LB010000
LB010000
b
X'C2'
LB020000
LB020000
B
X'83'
LC010000
LC010000
c
...
...
X'C9'
LI020000
...
LI020000
I
...
X'7B'
SM010000
SM010000
#
Plane mapping
The Xerox printer architecture limits the size of each centralized font to a
maximum of 240 printable characters and 256K of raster data. For
decentralized fonts, the size limit is a maximum of 192 printable
characters and 64K of raster data.
To accommodate character sets that exceed the size limitations, one font
must be split into multiple fonts; these resulting fonts are called planes.
For example, more than one replica font may be required for an IBM
character set because a single IBM character set can have over 800
rasters.
XPAF uses plane mapping, which is the linking of more than one font to a
character set, to place characters into centralized or decentralized fonts.
To accommodate both centralized and decentralized fonts, Xerox limits
the font mapping size to a maximum of 192 printable characters and 64K
of raster data.
XPAF uses two types of plane mapping:
•
Centralized-to-decentralized plane mapping, which allows a
centralized font to be linked to a maximum of 8 decentralized planes.
All planes (planes 01 through 08) can be used by your site. For more
information about this type of plane mapping, refer to “Converting
centralized fonts to decentralized fonts” in chapter 22, “Converting
resources.”
Section Three: Managing Resources with XPAF
20-17
XPAF tables
•
ISO8859-1 plane mapping, which allows more than 192 characters
of a replica font to be associated together. ISO8859-1 plane
mapping provides for up to 16 planes for one replica font:
—
—
Planes 0 to 11 (‘0’ to ‘B’) are reserved for Xerox use.
Planes 12 to 15 (‘C’ to ‘F’) can be used by your site.
For more information about this type of plane mapping, refer to “Using
custom replica fonts” in chapter 25, “Managing custom fonts.” Refer
to “ISO8859-1 split plane mapping” later in this chapter for
information about how XPAF handles the 64K of raster data limitation.
All characters to be defined are assigned a unique character identifier.
Each character identifier (CHARID) is allocated to a certain ASCII code
point. For example:
•
The character “A” (CHARID LA020000) is assigned to plane 0, code
point X'41'.
•
The character “™” (CHARID SM540000) is assigned to plane 2,
code point X'C1'.
Different characters can be assigned the same code points in different
planes. For example, the uppercase I, the semicolon, the left brace, and
the equal sign may have the same code point but reside in different
planes.
ISO8859-1 split plane mapping
For IBM character sets above the 14 point size, the 64K raster area in a
plane is quickly exceeded. Therefore, the characters assigned to each
plane will not fit into one replica font.
Because of this, each plane for font point sizes above 14 must be split
further into more replica fonts. Each replica font will contain a subset of
characters from the original plane. For example, if plane 0 is split into two
split planes:
•
Some characters will be placed in split plane 1 for plane 0.
•
The rest of the characters will be placed in split plane 2 for plane 0.
The planes are named in this manner: the split number is followed by the
number of the original plane (‘0’ to ‘F’). For example:
•
•
•
•
•
00: No split, plane 0
10: Split 1 of plane 0
21: Split 2 of plane 1
0F: No split, plane 15
4F: Split 4 of plane 15
Xerox uses a defined split plane mapping for each type of replica font:
•
For standard replica fonts, a single plane is split into several split
planes. The number of split planes depends on the point size of the
font. For example, an 18-to-22 point font requires plane 0 to be split
into two split planes. A 36-point font requires 4 split planes for each
plane 0 to 3.
•
To minimize the number of split planes, Xerox places characters in
the fonts so that as much of raster area is filled as possible.
Section Three: Managing Resources with XPAF
20-18
XPAF tables
•
For custom replica fonts, if the point size is greater than 13, planes
12 to 15 (‘C’ to ‘F’) are divided evenly into split planes:
Point size
No. of splits per
original plane
4–12
0
13–17
2
18–24
4
25–36
8
Xerox font-related tables
The font table members used during the processing of Xerox fonts are
summarized in table 20-9 and discussed in detail following the table.
Table 20-9.
Member
name
Xerox font processing tables
Description
Function
XPAFA2A
ASCII-to-ASCII
Links the character mapping of the centralized version of the font to
the character mapping of the decentralized version of the font.
XPAFEFW
EBCDIC font widths
Contains information that is needed to position characters in Xerox
fonts correctly at print time for a page-formatted document.
XPAFE2A
EBCDIC-to-ASCII
Links EBCDIC values for IBM code pages to ASCII values for Xerox
fonts specified in a page-formatted document.
NOTE: A Xerox font can use either a Xerox code page or an
IBM code page.
XPAFFFI
Font family
information
Contains information used to create a font descriptor structured
field when a Xerox font is converted for use in a DCF document.
XPAFXFI
Xerox font information
Contains information about centralized and decentralized fonts,
including character mapping information.
Various
Character mapping
Consists of a number of character mapping tables. Some of these
tables contain centralized and decentralized ASCII character
mapping; others contain EBCDIC mapping.
Section Three: Managing Resources with XPAF
20-19
XPAF tables
ASCII-to-ASCII (XPAFA2A) table
The XPAFA2A table is used when printing centralized (DJDE) documents
on decentralized printers to determine where a character is mapped within
the decentralized version of the font being used.
Entries within the XPAFA2A table are created or modified only when the
XPAFXFI table is updated. Each entry is created using the character
mapping tables for the centralized and decentralized formats in the
XPAFXFI table entries.
EBCDIC font widths (XPAFEFW) table
The XPAFEFW table contains the Xerox font widths for a given IBM
character set in order based on the code page width (X'00' – X'FF') of
each character. Typically, this arrangement is in EBCDIC format.
XPAF uses this table when processing page-formatted documents to
position characters correctly at print time. If a particular code
page/character set pair is encountered that does not have an XPAFEFW
table entry, XPAF attempts to build an entry dynamically before
terminating processing and requeueing the document.
The XPAFEFW table is created and updated during installation by
RJOB105. For Xerox fonts that will be used in page-formatted documents,
the XPAFE2A table also can be created or updated by using either the
Update Xerox Font Characteristics Information option on the Xerox Page
Format Editor menu or the CONVERT FONT TSO/batch command. Refer
to Section Eight: Xerox Page Format Editor User Guide for more
information about using this option or command.
NOTE: The XPAFEFW also is used when processing replica fonts.
Refer to “Replica font-related tables” later in the chapter for more
information.
Section Three: Managing Resources with XPAF
20-20
XPAF tables
EBCDIC-to-ASCII (XPAFE2A) table
The XPAFE2A table translates EBCDIC values for IBM code pages to
ASCII values for Xerox fonts. XPAF uses this table to translate the
incoming IBM code point to the appropriate code point in the correct
plane.
NOTE: If a document references a code page for which there is no
XPAFE2A table entry, the printing of the document is terminated, and
the document is requeued.
The XPAFE2A table is created or updated during installation by running
RJOB105. For Xerox fonts that will be used in page-formatted documents,
the XPAFE2A table also can be created or updated by using either the
Update Xerox Font Characteristics Information option on the Xerox Page
Format Editor menu or the CONVERT FONT TSO/batch command. Refer
to Section Eight: Xerox Page Format Editor User Guide for more
information about using this option or command.
Each XPAFE2A table entry contains the IBM code page name, Xerox
centralized or decentralized character mapping name, and the EBCDIC
code point of the character defined as the default character in the named
code page.
NOTE: The XPAFE2A also is used when processing replica fonts.
Refer to “Replica font-related tables” later in the chapter for more
information.
Font family information (XPAFFFI) table
The XPAFFFI table supports the use of Xerox centralized fonts in IBM’s
DCF/SCRIPT software product. This table provides font characteristics
that are used with .DF control words and that permit the font to be
referenced by font type as well as by font name.
When Xerox font characteristics are converted to IBM format during the
processing of the Convert Xerox Fonts to IBM Format option on the
Convert Resources menu or the CONVERT FONT TSO/batch command,
this table is used to create the font descriptor structured field in the
character set member.
XPAF provides font family information table entries for Universe and
Press Roman fonts. If you use any fonts other than these, you must
update the font family information table.
You can display, create, or modify the XPAFFFI table by using the
Maintain the Font Family Information (XPAFFFI) Table option on the
Maintain Font Tables menu. Refer to chapter 24, “Managing XPAF tables”
for more information about this option.
Section Three: Managing Resources with XPAF
20-21
XPAF tables
Xerox font information (XPAFXFI) table
The XPAFXFI table contains font naming and metrics information (for
example, typeface, weight, width, point size, and print direction) for
centralized and decentralized fonts stored in native font libraries. This
table also identifies the name of the character mapping tables that contain
the centralized and decentralized character mappings and the code page
for each font.
The XPAFXFI table is used under these conditions:
•
Whenever a DJDE application is printed on a decentralized printer.
•
When fonts are converted from centralized to decentralized format.
XPAF uses the centralized and decentralized formats to determine
where to place the centralized characters in the decentralized font. It
uses the values associated with the code page to determine which
characters to include in the decentralized font.
•
During the conversion of Xerox fonts for use in IBM DCF documents.
This table is referenced during the processing of the Convert Xerox
Fonts to IBM Format option on the Convert Resources menu, which
makes Xerox fonts available to IBM’s DCF product.
Entries to this table are generated automatically for each font that you
load using either the Load Centralized Fonts option on the Load
Resources menu or the LOAD FONT TSO/batch command. Optionally,
entries can be generated for this table when you load fonts using the Load
Decentralized Fonts option on the Load Resources menu or the LOAD
FONT TSO/batch command.
You can display, create, or modify the XPAFXFI table by using the
Maintain the Xerox Font Information (XPAFXFI) Table option on the
Maintain Font Tables menu. Refer to chapter 24, “Managing XPAF tables”
for more information about this option.
Section Three: Managing Resources with XPAF
20-22
XPAF tables
Character mapping tables
Character mapping tables contain mapping information for characters
within a character mapping variation. These tables link a character
identifier to a location within a font in ASCII or EBCDIC representation.
Each entry in a character mapping table contains a character identifier
(CHARID) and a corresponding code point.
Character mapping tables can be categorized as follows:
•
Centralized and decentralized character mapping tables define code
points, which typically are ASCII.
—
A centralized character mapping table is a mapping variation
that relates a character ID to a location, expressed as an ASCII
value, in the centralized font map.
—
A decentralized character mapping table is a mapping variation
that relates a character ID to a location within a specific plane
number, expressed as an ASCII value, in the decentralized font
map.
The centralized and decentralized mapping tables are used during
centralized-to-decentralized font conversion to determine the
character mapping of the resulting decentralized font. Refer to
chapter 22, “Converting resources” for more information about
centralized-to-decentralized font conversion.
•
Code page tables define code points, which typically are EBCDIC. A
code page mapping relates a character ID to a location, expressed
as an EBCDIC value, in the centralized font map. These tables are
used to replicate an IBM code page during a conversion of Xerox
fonts for use in a DCF document.
Appendix D describes the naming conventions for XPAF-supplied
character mapping tables and identifies the default tables used during the
centralized-to-decentralized font and DCF conversions. The source for
the character mapping tables is distributed with XPAF in XPFSAMP.
You can display or create new character mapping tables or add entries to
existing tables by using the Maintain Character Mapping Tables option on
the Maintain Font Tables menu. Refer to chapter 24, “Managing XPAF
tables” for more information about this option.
Section Three: Managing Resources with XPAF
20-23
XPAF tables
Replica font-related tables
The font table members used during the processing of replica fonts for
AFP data streams are summarized in table 20-10 and discussed in detail
following the table.
Table 20-10. Replica font processing tables
Member
name
Description
Function
CPGID
Code page global
identifier
Contains the code page names and corresponding character set
global identifier/code page global identifier pair for each name.
FGID
Font global identifier
Contains the character set names and the corresponding font global
identifier and space character width for each name.
IPDFLT
IPDFLT
Contains the default version of the IPSTND table.
IPSTND
IPSTND
Links an IBM character identifier (CHARID) to a particular plane and
ASCII code point within that plane.
XPAFAFW
ASCII font widths
Contains information about each replica font, including the widths of
all characters within that font.
XPAFCFN
Coded font name
Contains the code page/character set pair to be used for each IBM
coded font.
XPAFEFW
EBCDIC font widths
Contains the width (at 300 dpi) of each character contained in the
IBM font.
XPAFE2A
EBCDIC-to-ASCII
Links each character in a Xerox or replica font to a split/plane and
the ASCII code point within that split/plane.
XPAFIFW
IBM font widths
Contains the widths (at 240 dpi) of each character in the IBM font.
XPAFIFW3
IBM font widths
Contains the widths (at 300 dpi) of each character in the IBM font.
XPAFI2I
IBM-to-IBM
Contains identification text taken from the IBM character set.
XPAFI2X
IBM-to-Xerox
Links each IBM character set to a group of replica fonts. Each replica
font references one plane or split of a plane.
Throughout this section, references are made to RJOB105, which is a
batch job that is run when XPAF resources are installed. This job creates
or modifies the following font table members to ensure that the table
information is in synchronization with the information contained in your
IBM font library:
•
•
•
•
•
•
•
CPGID
FGID
XPAFCFN
XPAFEFW
XPAFE2A
XPAFIFW
XPAFIFW3
Section Three: Managing Resources with XPAF
20-24
XPAF tables
Thereafter, XPAF provides several options you can use to create or
update the IBM font table entries. You should run the appropriate IBM font
table update option to ensure synchronization whenever changes are
made to the IBM font library or additional replica fonts are installed:
•
If you change an IBM coded font or add new fonts to your IBM font
library, use one of these options to update the tables:
—
Update IBM Font Characteristics Information on the Manage
Tables menu
—
CONVERT IBM TSO/batch command
Refer to chapter 24, “Managing XPAF tables” for information about
using this option or command.
•
If you install custom replica fonts, you must run one of these options
to rebuild the tables:
—
Update IBM Font Characteristics Information on the Install
Custom Replica Fonts (version 5 encoding or below) menu or
the CONVERT IBM TSO/batch command
—
Install Custom Replica Fonts (version 6 encoding or above) on
the Manage Custom Replica Fonts menu
Refer to chapter 25, “Managing custom fonts” for information about
how to use these options when installing custom replica fonts.
Code page global identifier (CPGID) table
The CPGID table contains IBM code page names and the corresponding
graphic character set global identifier and code page global identifier for
each code page name. XPAF uses the CPGID table to support the
processing of MCF-2 structured fields that contain global resource
identifiers (GRIDs).
When an MCF-2 structured field is encountered by XPAF during the
processing of an AFP data stream, XPAF examines the repeating group
for the Fully Qualified Name triplet to determine whether it specifies a
code page name type. If a code page name type exists, XPAF uses the
specified code page name for the processing of the current font.
If the repeating group for the Fully Qualified Name triplet does not contain
a code page name type but does contain a GRID, XPAF uses the graphic
character set global identifier and code page global identifier values in the
GRID to obtain the code page name of the font being processed from the
CPGID table. If XPAF does not find the graphic character set global
identifier or code page global identifier value in this table, document
processing is terminated, an error message is issued, and the document
is requeued.
The CPGID table is created during installation by running RJOB105. The
CPGID table also is created or updated automatically whenever you run
one of XPAF’s IBM font table update options. RJOB105 and the update
options extract the graphic character set global identifier and code page
global identifier values from the code page descriptor record of each code
page member in your IBM font library. XPAF uses these values to create
an entry in the CPGID table.
Section Three: Managing Resources with XPAF
20-25
XPAF tables
You can create or update entries in this table manually by using the
Maintain the Code Page Global Identifier (CPGID) Table option on the
Maintain Font Tables menu. Refer to chapter 24, “Managing XPAF tables”
for more information about this option. Manual updates may be necessary
if, for example, an entry cannot be found in the CPGID table when XPAF
processes an MCF-2 structured field’s GRID.
Font global identifier (FGID) table
The FGID table contains IBM character set names and the corresponding
font global identifier and width of the space character for each character
set name. XPAF uses the FGID table to support the processing of MCF-2
structured fields that contain GRIDs.
When an MCF-2 structured field is encountered by XPAF during the
processing of an AFP data stream, XPAF examines the repeating group
for the Fully Qualified Name triplet to determine whether it specifies a
character set name type. If a character set name type exists, XPAF uses
the specified character set for the processing of the current font.
If the repeating group for the Fully Qualified Name triplet does not contain
a character set name type but does contain a GRID, XPAF uses the font
global identifier and space character width values in the GRID to obtain
the character set name from the FGID table. If XPAF does not find the font
global identifier value in this table, document processing is terminated, an
error message is issued, and the document is requeued.
Once a valid entry is retrieved from the FGID table, the character set
name is adjusted. To adjust the name, the code page name value for the
font being processed is used as a key into an internal XPAF table to
determine a font family complement ID value. The complement ID value
is then substituted as the sixth character of the character set name. This
revised character set name is the name used by XPAF for the processing
of the current font. Refer to figure 20-1 for an example of this substitution
process.
The FGID table is created during installation by running RJOB105. The
FGID table also is created or updated automatically whenever you run one
of XPAF’s IBM font table update options. RJOB105 and the update
options extract the font global identifier and the nominal horizontal font
size values for each character set name from the font descriptor record in
your IBM font library. XPAF uses these values to create an entry in the
FGID table.
NOTE: XPAF stores the nominal horizontal font size in the font global
identifier table as the space character width.
You can create or update entries in this table manually by using the
Maintain the Font Global Identifier (FGID) Table option on the Maintain
Font Tables menu. Refer to chapter 24, “Managing XPAF tables” for more
information about this option. Manual updates may be necessary if, for
example, an entry cannot be found in the FGID table when XPAF
processes an MCF-2 structured field’s GRID.
Section Three: Managing Resources with XPAF
20-26
XPAF tables
IPDFLT table
The IPDFLT table is identical to the IPSTND table that is supplied with
XPAF in TABLELIB. However, it cannot be altered and is retained as the
default version of the IPSTND table.
Figure 20-1. CPGID and FGID table processing for GRIDs
Section Three: Managing Resources with XPAF
20-27
XPAF tables
IPSTND table
The IPSTND table defines every character for each IBM font supported by
replica fonts. For each character, this table links the IBM character
identifier (CHARID) value to a Xerox plane number and an ASCII code
point location within that plane. RJOB105 uses this table to build the
XPAFE2A table.
NOTE: If a character identifier does not appear in this table, XPAF
cannot support that character. During printing, any unsupported
character prints using the default character for that code page.
The IPSTND table is supplied with XPAF in TABLELIB. If you install
custom replica fonts, you must run one of these options on the Manage
Custom Replica Fonts menu to update the table:
•
Update the IPSTND Table on the Install Custom Replica Fonts
(version 5 encoding or below) menu
•
Install Custom Replica Fonts (version 6 encoding or above)
Refer to chapter 25, “Managing custom fonts” for information about how
to use these options.
ASCII font widths (XPAFAFW) table
The XPAFAFW table contains an entry for every replica font. Each entry
contains the replica font name, general information about the font (for
example, baseline to top of cell and kerning information), and the width of
every character in that font.
XPAF uses this table to correct the positioning of characters when
converting character placements from 240 to 300 dpi. If an XPAFAFW
table entry cannot be found for a font during processing, XPAF terminates
processing and requeues the document.
The XPAFAFW table is supplied with XPAF in TABLELIB and is updated
automatically whenever additional replica fonts are loaded into the
centralized font library using the Install Custom Replica Fonts (version 6
encoding or above) option on the Manage Custom Replica Fonts menu.
You also can update the XPAFAFW table when you load replica fonts into
the decentralized font library using either the Load Custom Replica Fonts
option on the Install Custom Replica Fonts (version 5 encoding or below)
menu or the LOAD FONT TSO/batch command.
Section Three: Managing Resources with XPAF
20-28
XPAF tables
Coded font name (XPAFCFN) table
The XPAFCFN table provides XPAF with the names of the code page and
character set that make up the IBM coded fonts in your IBM font library.
XPAF uses this table to determine which code page/character set pair is
required for a specified coded font. If a coded font is found that does not
have a XPAFCFN table entry, XPAF searches the IBM font library
identified by the XOSF DD statement that was specified using the
IBMFONTDD initialization parameter and creates an entry dynamically.
The XPAFCFN table is created during installation by running RJOB105.
The XPAFCFN table also is created or updated automatically whenever
you run one of XPAF’s IBM font table update options. RJOB105 and the
update options create an entry in this table for every coded font contained
in the referenced IBM font library. Each table entry contains the IBM
coded font name followed by the code page name and character set name
specified in that coded font.
You can use Maintain the Coded Font Name (XPAFCFN) Table on the
Maintain Font Tables menu if you need to make a small amount of
changes or additions to this table. Otherwise, use the Update IBM Font
Characteristics Information option on the Manage Tables menu or the
CONVERT IBM TSO/batch command to rebuild the XPAFCFN table and
other tables that are needed to support replica fonts.
Refer to chapter 24, “Managing XPAF tables” for more information about
using these options.
EBCDIC font widths (XPAFEFW) table
The XPAFEFW table contains the Xerox font widths for a given IBM
character set in order based on the code page width (X'00' – X'FF') of
each character. Typically, this arrangement is in EBCDIC format.
XPAF uses this table in conjunction with the XPAFIFW table to calculate
where each character from the replica font should be placed when
emulating the spacing of an IBM font. If a particular code page/character
set pair is encountered that does not have an XPAFEFW table entry,
XPAF attempts to build an entry dynamically before terminating
processing and requeueing the document.
The XPAFEFW table is created and updated during installation by
RJOB105 using data from the XPAFAFW table, the IBM code page, and
the XPAFI2X table. The XPAFEFW table also is created or updated
automatically whenever you run one of XPAF’s IBM font table update
options.
Each table entry contains a code page name, character set name, and
font information (that is, baseline to top of cell, kern values etc.) for each
plane used to replicate that code page/character set pair.
The table also contains the widths at 300 dpi of each character referenced
in the code page/character set pair. The width information in this table is
calculated by dividing the corresponding width from the XPAFIFW table
entry by 240 and then multiplying by 300. The result is rounded down to
the nearest whole number.
Section Three: Managing Resources with XPAF
20-29
XPAF tables
EBCDIC-to-ASCII (XPAFE2A) table
The XPAFE2A table translates EBCDIC values for IBM code pages to
ASCII values for Xerox and replica fonts. XPAF uses this table to translate
the incoming IBM code point to the appropriate code point in the correct
plane. The XPAFI2X table is then used to establish which Xerox or replica
font should be used for the plane specified in the XPAFE2A table.
NOTE: If a document references a code page for which there is no
XPAFE2A table entry, the printing of the document is terminated, and
the document is requeued.
The XPAFE2A table is created or updated during installation by running
RJOB105. The XPAFE2A table also is created or updated automatically
when you run one of XPAF’s IBM font table update options. RJOB105 and
the update options create or update table entries, each of which contains
the IBM code page name, Xerox centralized or decentralized character
mapping name, and the EBCDIC code point of the character defined as
the default character in the named code page.
If you load a new centralized font, you must run either the Convert Xerox
Fonts to IBM Format option on the Convert Resources menu or
CONVERT FONT TSO/batch command before you use a centralized or
decentralized version of the font in a DCF/SCRIPT document. This
ensures that the XPAFEFW table is updated with information that is
needed to position characters correctly at print time. Refer to chapter 22,
“Converting resources” for more information about using this option or
command.
IBM font widths (XPAFIFW) table
The XPAFIFW table contains the width of each IBM character in an IBM
character set/code page pair. The widths in this table are used for text
string placement comparisons to ensure that an XPAF formatted
document prints the same as an AFP document.
XPAF uses this table to establish the widths of the characters referenced
in the specified IBM code page/character set pair. If a particular code
page/character set pair is found that does not have an XPAFIFW table
entry, XPAF searches the IBM font library identified by the XOSF DD
statement that was specified using the IBMFONTDD initialization
parameter and creates an entry dynamically. If the character set cannot
be found in the IBM font library, the processing of the document is
terminated, and the document is requeued.
The XPAFIFW table is created and updated during installation by
RJOB105 and XPAF. The XPAFIFW table also is created or updated
automatically when you run one of XPAF’s IBM font table update options.
This table contains the widths at 240 dpi of all characters referenced by
each code page/character set pair found by RJOB105 when processing
the coded font members of the IBM font library referenced. Each entry
contains the code page name and character set name followed by width
information for each character referenced by the named code page.
Section Three: Managing Resources with XPAF
20-30
XPAF tables
IBM font widths (XPAFIFW3) tables
The XPAFIFW3 table contains the width of each IBM character in an IBM
character set/code page pair. The widths in this table are used for text
string placement comparisons to ensure that an XPAF formatted
document prints the same as an AFP document.
XPAF uses this table to establish the widths of the characters referenced
in the specified IBM code page/character set pair. If a particular code
page/character set pair is found that does not have an XPAFIFW3 table
entry, XPAF searches the IBM font library identified by the XOSF DD
statement that was specified using the IBMFONTDD initialization
parameter and creates an entry dynamically. If the character set cannot
be found in the IBM font library, the processing of the document is
terminated, and the document is requeued.
The XPAFIFW3 table is created and updated during installation by
RJOB105 and XPAF. The XPAFIFW table also is created or updated
automatically when you run one of XPAF’s IBM font table update options.
This table contains the widths at 300 dpi of all characters referenced by
each code page/character set pair found by RJOB105 when processing
the coded font members of the IBM font library referenced. Each entry
contains the code page name and character set name followed by width
information for each character referenced by the named code page.
IBM-to-IBM (XPAFI2I) table
The XPAFI2I table contains an entry for every IBM character set
distributed with XPAF (that is, every character set supported as standard).
Each table entry contains the character set name followed by the first 36
bytes of data from the font descriptor structured field in that character set.
The XPAFI2I table is supplied with XPAF in TABLELIB. This table is used
to allow the standard IBM character sets to be renamed without having to
create new XPAFI2X table entries.
Section Three: Managing Resources with XPAF
20-31
XPAF tables
IBM-to-Xerox (XPAFI2X) table
The XPAFI2X table identifies the Xerox fonts needed to replicate the fonts
represented by an IBM character set. The XPAFI2X table links each IBM
character set to a group of replica fonts. Each replica font references a
specific plane or split of a plane. A plane is split when all of the characters
specified in that plane do not fit into one replica font.
NOTE: Even if a plane is empty, it may still be listed in the XPAFI2X
table in order to reserve the name for future use.
The XPAFI2X table also contains the point size of the IBM character set.
This value is used by XPAF to establish which characters are in which
split. RJOB105 uses this table in conjunction with the IPSTND table to
build the XPAFE2A table.
NOTE: During document processing, if XPAF encounters a character
set that does not have a corresponding XPAFI2X table entry, XPAF
searches the XPAFI2I table for a matching entry. This allows XPAF
to recognize a character set that is a copy of a supported font.
The XPAFI2X table is supplied with XPAF in TABLELIB. If you install
custom replica fonts, you must run one of these options to update the
table:
•
Update the IBM-to-Xerox (XPAFI2X) Table on the Install Custom
Replica Fonts (version 5 encoding or below) menu
•
Install Custom Replica Fonts (version 6 encoding or above) on the
Manage Custom Replica Fonts menu
Refer to chapter 25, “Managing custom fonts,” for information about how
to use these options.
Section Three: Managing Resources with XPAF
20-32
XPAF tables
Color cross-reference tables
The color cross-reference tables are a set of tables used to support Xerox
highlight color printing capabilities for centralized printers. Highlight color
is the use of a single solid (spot) color to accentuate or contrast material
from monochromatic (usually black) printed areas. Xerox uses the term
“highlight color” to mean printing with black plus one color.
DJDE, page-formatted, or AFP documents can be set up for a particular
color. If the colors in your document do not match the colors on your
highlight printer, you can use a color-cross reference table to map the
color specified in the document to the color specified in the printer ink
source language (ISL).
For example, you can map blue to red. Or, let’s say a page-formatted
document references the colors turquoise and green, but the printer ISL
defines the highlight color as red. Using a color cross-reference table, you
can map both turquoise and green to red. For more information about how
to use highlight color in documents, refer to Section Four: Printing
Documents with XPAF.
NOTE: Xerox printers that support full color printing do not require
color cross-reference tables.
Library and default table definition
The color cross-reference tables are stored in the library which was
identified by the XOSF DD statement specified by your systems
programmer during installation using the INKXLIB initialization or printer
profile parameter. During installation, your systems programmer also may
have identified a default color cross-reference table by specifying the
INKXREF initialization or printer profile parameter.
For more information about these parameters, refer to Section Five: XPAF
Parameter and Keyword Reference.
Table maintenance
Your application programmers will need to identify the highlight color to
be substituted for colors specified in DJDE, page-formatted, or AFP
documents. You can then use the Maintain Color Cross-Reference Tables
option on the Manage Tables menu to create and maintain color
cross-reference tables. Each table you create can be used by multiple
highlight color printers. Refer to Chapter 24, “Managing XPAF tables” for
information about using this option.
Section Three: Managing Resources with XPAF
20-33
XPAF tables
Color conversion table
The color conversion table maps highlight colors to decentralized color
values, allowing you to print DJDE documents that contain highlight color
on PCL printers and convert to PDF without modifying the documents.
XPAF uses the color conversion table to map centralized printer ink
names to RGB color values which are then used to define PCL or PDF
colors.
Library and default table definition
XPAF provides a default color conversion table, named COLR4700, in
XPFSAMP. The color conversion table is preloaded for you and resides in
the native library specified in the XOSF start-up proc DD statement
named by the INKXLIB initialization parameter or printer profile
parameter. For more information about the INKXLIB parameter, refer to
Section Five: XPAF Parameter and Keyword Reference.
Table maintenance
You can modify a copy of the color conversion table to add custom colors.
If you do, you must then reload it using one of these options:
•
Maintain the Color Conversion Table option on the Manage Tables
menu
•
LOAD INKS TSO/batch command
Refer to chapter 24, “Managing XPAF tables,” for information about
maintaining the color conversion table.
Section Three: Managing Resources with XPAF
20-34
Loading resources to a native library
21.
21
Loading resources to a native library
This chapter describes how to use the options available through the Load
Resources menu to load these types of resources:
•
Fonts. Use the Load Centralized Fonts and Load Decentralized
Fonts options to load fonts to the native centralized and
decentralized font libraries. These options must be performed for
any .FNT or sixelized (2700 format) font files that are referenced in a
document but not resident on the selected printer.
For centralized fonts, XPAF automatically builds XPAFXFI table
entries for the fonts during the load process. For decentralized fonts,
you can specify whether you want XPAF to build the table entries.
NOTE: You do not want to build XPAFXFI table entries for a
decentralized font if a centralized version of the font already
exists in the native centralized font library.
•
Forms. Use the Load Centralized Forms and Load Decentralized
Forms options to load forms to the native centralized and
decentralized form libraries. These options must be performed for
any .FRM or XES form files that are referenced in a document but
not resident on the selected printer.
•
Images. Use the Load Centralized Images and Load Decentralized
Images options to load images to the native centralized and
decentralized image libraries. These options must be performed for
any .IMG or sixelized image files that are referenced in a document
but not resident on the selected printer.
•
Logos. Use the Load Centralized Logos option to load .LGO files to
the native centralized logo library. This option must be performed for
any .LGO file that is referenced in a form but not resident on the
selected printer.
•
PDL. Use the Load PDL option to load PDL members to a native
PDL library. Whenever you change PDL on a printer, you also must
update it on the host and use this option to load the updated host
version to a native library.
Before resource files can be processed by any of the options on the Load
Resources menu, they must be transferred from their existing location,
such as on a printer, by file and stored in the same format as on the file.
After the files have been transferred, they can be loaded to a native
library. Refer to Section Two: Installing and Customizing XPAF for
information about uploading printer resources.
Section Three: Managing Resources with XPAF
21-1
Loading resources to a native library
Loading centralized fonts
To load fonts to the centralized font library, enter 1 on the Load Resources
menu OPTION line and press ENTER. This panel appears:
Xerox Output Administrative Facility
Load Centralized Fonts to a Native Library
COMMAND ===>
INPUT
Dataset Name:
Member Name:
OUTPUT
Dataset Name:
XPAFXFI TABLE SPECIFICATIONS
Centralized Character Mapping Name:
Decentralized Character Mapping Name:
Code Page Name:
Complete these fields and press ENTER:
Field
Action
Dataset Name
Enter the name of the PDS, sequential dataset, or native centralized font library
that contains the centralized font(s) to be loaded. If you have multiple fonts
concatenated in a single file, they must be loaded from a sequential dataset with
valid headers. All fonts within the sequential dataset will be loaded. The dataset
specifications for a PDS or sequential dataset are:
INPUT
RECFM=F or FB
LRECL=128
BLKSIZE=A value appropriate for your site
Member Name
•
Enter a 1- to 8-character member name if the font is stored in a PDS or a
1- to 20-character member name if the font is stored in a native library.
You can enter a specific font name in this field, or use a wildcard character
to select all fonts or fonts beginning with a certain prefix. For example:
*
Selects all members.
RX*
Selects all members that begin with RX.
RX?ABC Selects all members that begin with RX, end with ABC, and
have one character in between RX and ABC.
RX1ABC Selects the single member RX1ABC.
•
Leave this field blank if the font is stored in a sequential dataset.
Section Three: Managing Resources with XPAF
21-2
Loading resources to a native library
Field
Action
Dataset Name
Enter the name of the native centralized font library. In the XOSF start-up proc,
this is the dataset name in the DD statement specified for the centralized font
library by the CFONTLIB initialization parameter or the FONTLIB printer profile
parameter. For each font loaded, the output member name is constructed from
the name in the font header record.
OUTPUT
XPAFXFI TABLE
SPECIFICATIONS
Centralized
Character
Mapping Name
Enter the 1- to 6-character name of the character mapping table that contains
the centralized character mapping of the font. For each character in the font, this
table contains the character ID and its ASCII hexadecimal mapping value. This
name is passed to the ‘Centralized Character Mapping Name’ field in the
XPAFXFI table.
Default: CCMV01
Decentralized
Character
Mapping Name
Enter the 1- to 6-character name of the character mapping table that contains
the decentralized character mapping of the font. For each character in the font,
this table contains the character ID, plane number, and its ASCII hexadecimal
mapping value. This name is passed to the ‘Decentralized Character Mapping
Name’ field in the XPAFXFI table.
Default: DCMV60
Code Page Name
•
Enter the 1- to 6-character name of the character mapping table that
contains the code page mapping for the font (for example, XCP5). This
name is passed to the ‘Code Page Name’ field in the XPAFXFI table.
NOTE: You can specify either the name of an XPAF-supplied code
page mapping, the name of an IBM code page mapping, or the name
of a code page mapping that you have created. Refer to Chapter 29,
“Character mapping tables” for more information about XPAF-supplied
code page mappings. Refer to chapter 24, “Managing XPAF tables,”
for information about using IBM code pages or creating your own
character mapping tables.
•
Leave this field blank if an entry already exists in the XPAFXFI table for
this font.
Default: Six space characters
Section Three: Managing Resources with XPAF
21-3
Loading resources to a native library
TSO/Batch command
You can use this TSO/batch command as an alternative to using the Load
Centralized Fonts option:


LOA D FON T('input-dataset-name[(  member-name  )]')
*


 centralized-format 
[TO]('output-dataset-name') TYP E(LCDS) [IFO RMAT( 
)
CCMV01


 decentralized-format 
OFO RMAT( 
 ) CODEPAGE(code-page-name)]
DCMV60


A customized sample XOAF Batch job for loading LCDS (centralized)
fonts can be found in the STAGE2 library as member RLFNTLD.
Section Three: Managing Resources with XPAF
21-4
Loading resources to a native library
Loading centralized forms
To load forms to the centralized form library, enter 2 on the Load
Resources menu OPTION line and press ENTER. This panel appears:
Xerox Output Administrative Facility
Load or Compile Centralized Forms to a Native Library
COMMAND ===>
INPUT
Dataset Name: FSLLIB
Member Name:
Input will be loaded if source is 128-bytes
Input will be compiled if source is 80-bytes
OUTPUT
Dataset Name: 'XPAF50.TESTING.CFORMLIB'
Member Name:
NOTE:
OUTPUT Member Name is required if INPUT file is sequential
with no tape header label record.
OUTPUT Member Name is ignored if FSL source is being compiled.
(Input source is 80-bytes)
Complete these fields and press ENTER:
Field
INPUT
Dataset Name
Action
Enter the name of the PDS or sequential dataset that contains the centralized
form(s) to be loaded. If you have multiple forms concatenated in a single file, they
must be loaded from a sequential dataset with valid headers. The dataset
specifications are:
RECFM=F or FB
LRECL=128
BLKSIZE=A value appropriate for your site
Member Name
OUTPUT
Dataset Name
•
Enter a 1- to 8-character member name if the form is stored in a PDS.
•
Enter an asterisk ( * ) to load all forms in a PDS.
•
Leave this field blank if the form is stored in a sequential dataset.
Enter the name of the native centralized form library. In the XOSF start-up proc, this
is the dataset name in the DD statement specified for the centralized form library in
the CFORMLIB initialization parameter or FORMLIB printer profile parameter.
Section Three: Managing Resources with XPAF
21-5
Loading resources to a native library
Field
Member Name
Action
•
Enter the 1- to 6-character name of the form as it will be known to the printer.
•
The output member name is required when the input is from a sequential
dataset with no centralized form header record.
•
Leave this field blank if you want the output member name to be constructed
from the form name in the centralized form header record.
The member name must conform to the form naming conventions required for your
centralized printer. Refer to your centralized printer manual for more information.
TSO/Batch command
You can use this TSO/batch command as an alternative to using the Load
Centralized Forms option:


LOA D FOR M('input-dataset-name[(  member-name  )]')
*


[TO]('output-dataset-name[(member-name)]') LCDS
A customized sample XOAF Batch job for loading LCDS (centralized)
forms can be found in the STAGE2 library as member RLFRMLD.
Section Three: Managing Resources with XPAF
21-6
Loading resources to a native library
Loading centralized images
To load images to the centralized image library, enter 3 on the Load
Resources menu OPTION line and press ENTER. This panel appears:
Xerox Output Administrative Facility
Load Centralized Images to a Native Library
COMMAND ===>
INPUT
Dataset Name:
Member Name:
OUTPUT
Dataset Name:
Member Name:
Complete these fields and press ENTER:
Field
Action
Dataset Name
Enter the name of the PDS or sequential dataset that contains the centralized
image(s) to be loaded. If you have multiple images concatenated in a single file,
they must be loaded from a sequential dataset with valid headers. The dataset
specifications are:
INPUT
RECFM=F or FB
LRECL=128
BLKSIZE=A value appropriate for your site
Member Name
OUTPUT
•
Enter a 1- to 8-character member name if the image is stored in a PDS.
•
Enter an asterisk ( * ) to load all images in a PDS.
•
Leave this field blank if the image is stored in a sequential dataset.
Dataset Name
Enter the name of the native centralized image library. In the XOSF start-up
proc, this is the dataset name in the DD statement specified for the centralized
image library by the CIMAGELIB initialization parameter or the IMAGELIB
printer profile parameter.
Member Name
•
Enter the 1- to 6-character image name as it will be known to the printer.
•
The output member name is required when the input is from a sequential
dataset with no centralized image header record.
•
Leave this field blank if you want the output member name to be
constructed from the image name in the centralized image header record.
Section Three: Managing Resources with XPAF
21-7
Loading resources to a native library
TSO/Batch command
You can use this TSO/batch command as an alternative to using the Load
Centralized Images option:


LOA D IMA GE('input-dataset-name[(  member-name  )]')
*


[TO]('output-dataset-name[(member-name)]') LCDS
A customized sample XOAF Batch job for loading LCDS (centralized)
images can be found in the STAGE2 library as member RLIMGLD.
Section Three: Managing Resources with XPAF
21-8
Loading resources to a native library
Loading centralized logos
To load logos to the centralized logo library, enter 4 on the Load
Resources menu OPTION line and press ENTER. This panel appears:
Xerox Output Administrative Facility
Load Centralized Logos to a Native Library
COMMAND ===>
INPUT
Dataset Name:
Member Name:
OUTPUT
Dataset Name:
Member Name:
Complete these fields and press ENTER:
Field
Action
Dataset Name
Enter the name of the PDS or sequential dataset that contains the logo(s) to be
loaded. If you have multiple logos concatenated in a single file, they must be
loaded from a sequential dataset with valid headers. The dataset specifications
are:
INPUT
RECFM=F or FB
LRECL=128
BLKSIZE=A value appropriate for your site
Member Name
OUTPUT
•
Enter a 1- to 8-character member name if the logo is stored in a PDS.
•
Enter an asterisk ( * ) to load all logos in a PDS.
•
Leave this field blank if the logo is stored in a sequential dataset.
Dataset Name
Enter the name of the native centralized logo library. In the XOSF start-up proc,
this is the dataset name in the DD statement specified for the centralized logo
library by the CLOGOLIB initialization parameter or the LOGOLIB printer profile
parameter.
Member Name
•
Enter the 1- to 6-character logo name as it will be known to the printer.
•
Leave this field blank if you want the output member name to be
constructed from the logo name in the centralized logo header record.
The member name must conform to the logo naming conventions required for
your centralized printer. Refer to your centralized printer manual for more
information.
Section Three: Managing Resources with XPAF
21-9
Loading resources to a native library
TSO/Batch command
You can use this TSO/batch command as an alternative to using the Load
Centralized Logos option:


LOA D LOG O('input-dataset-name[(  member-name  )]')
*


[TO]('output-dataset-name[(member-name)]')
A customized sample XOAF Batch job for loading LCDS (centralized)
logos can be found in the STAGE2 library as member RLLGOLD.
Section Three: Managing Resources with XPAF
21-10
Loading resources to a native library
Loading decentralized fonts
To load fonts to the decentralized font library, enter 5 on the Load
Resources menu OPTION line and press ENTER. This panel appears:
Xerox Output Administrative Facility
Load Decentralized Fonts to a Native Library
COMMAND ===>
INPUT
Dataset Name:
Member Name:
OUTPUT
Dataset Name:
XPAFXFI TABLE SPECIFICATIONS
Create Table Entry? (Y/N):
Code Page Name:
Complete these fields and press ENTER:
Field
Action
Dataset Name
Enter the name of the PDS, sequential dataset, or native decentralized font
library that contains the decentralized font(s) to be loaded. If you have multiple
fonts concatenated in a single file, they must be loaded from a sequential
dataset with valid headers. All fonts within the sequential dataset will be loaded.
The dataset specifications for a PDS or sequential dataset are:
INPUT
RECFM=F or FB
LRECL=80
BLKSIZE=A value appropriate for your site
Member Name
•
Enter a 1- to 8-character member name if the font is stored in a PDS or a
1- to 20-character member name if the font is stored in a native library.
You can enter a specific font name in this field, or use a wildcard character
to select all fonts or fonts beginning with a certain prefix. For example:
*
Selects all members.
RX*
Selects all members that begin with RX.
RX?ABC Selects all members that begin with RX, end with ABC, and
have one character in between RX and ABC.
RX1ABC Selects the single member RX1ABC.
•
Leave this field blank if the font is stored in a sequential dataset.
Section Three: Managing Resources with XPAF
21-11
Loading resources to a native library
Field
OUTPUT
Dataset Name
Action
Enter the name of the native decentralized font library. In the XOSF start-up
proc, this is the dataset name in the DD statement specified for the
decentralized font library by the DFONTLIB initialization parameter or the
FONTLIB printer profile parameter.
For each font loaded, the output member name is constructed from the font
name in the font header record.
XPAFXFI TABLE
SPECIFICATIONS
Create Table
Entry?
Specify whether you want a XPAFXFI table entry created automatically for this
font.
Valid values:
Y
Automatically creates an XPAFXFI table entry for this font. Select this
value only if you are not loading a centralized version of this font.
N
Does not create an entry.
Default: N
NOTE: The name of the table entry is constructed from the first six
characters of the font name in the font header record.
Code Page Name
If you specified a value of Y in the ‘Create Table Entry?’ field, enter the 1- to
6-character name of the character mapping table that contains the code page
mapping for the font (for example, XCP12).
NOTE: You can specify either the name of an XPAF-supplied code page
mapping, the name of an IBM code page mapping, or the name of a code
page mapping that you have created. Refer to Chapter 29, “Character
mapping tables” for more information about XPAF-supplied code page
mappings. Refer to chapter 24, “Managing XPAF tables,” for information
about using IBM code pages or creating your own character mapping
tables.
Default: None
TSO/Batch command
You can use this TSO/batch command as an alternative to using the Load
Decentralized Fonts option:


LOA D FON T('input-dataset-name[(  member-name  )]')
*


 (2700)

[TO]('output-dataset-name') TYP E 

 (270X) CODEPAGE(code-page-name) 
Section Three: Managing Resources with XPAF
21-12
Loading resources to a native library
Loading decentralized forms
To load forms to the decentralized form library, enter 6 on the Load
Resources menu OPTION line and press ENTER. This panel appears:
Xerox Output Administrative Facility
Load Decentralized Forms to a Native Library
COMMAND ===>
INPUT
Dataset Name:
Member Name:
OUTPUT
Dataset Name:
Member Name:
NOTE: Output member name is required if input file is sequential with no file
header label record.
Complete these fields and press ENTER:
Field
INPUT
Dataset Name
Action
Enter the name of the PDS that contains the decentralized form(s) to be loaded.
Decentralized forms must be stored in a PDS. The dataset specifications are:
RECFM=F or FB
LRECL=128
BLKSIZE=A value appropriate for your site
Member Name
OUTPUT
•
•
Enter a 1- to 8-character member name.
Enter an asterisk ( * ) to load all forms in a PDS.
Dataset Name
Enter the name of the native decentralized form library. In the XOSF start-up
proc, this is the dataset name in the DD statement specified for the
decentralized form library by the DFORMLIB initialization parameter or the
FORMLIB printer profile parameter.
Member Name
•
Enter the 1- to 20-character form name as it will be known to the printer.
•
Leave this field blank if you want the output member name to be the same
as the input member name.
The member name must conform to the form naming conventions required for
your decentralized printer. Refer to your decentralized printer manual for more
information.
Section Three: Managing Resources with XPAF
21-13
Loading resources to a native library
TSO/Batch command
You can use this TSO/batch command as an alternative to using the Load
Decentralized Forms option:


LOA D FOR M('input-dataset-name(  member-name  )')
*


[TO]('output-dataset-name[(member-name)]') DEC ENTRALIZED
Section Three: Managing Resources with XPAF
21-14
Loading resources to a native library
Loading decentralized images
To load images to the decentralized image library, enter 7 on the Load
Resources menu OPTION line and press ENTER. This panel appears:
Xerox Output Administrative Facility
Load Decentralized Images to a Native Library
COMMAND ===>
INPUT
Dataset Name:
Member Name:
OUTPUT
Dataset Name:
Member Name:
NOTE: Output member name is required if input file is sequential with no file
header label record.
Complete these fields and press ENTER:
Field
INPUT
Dataset Name
Action
Enter the name of the PDS that contains the decentralized image(s) to be
loaded. The recommended dataset specifications are:
RECFM=F or FB
LRECL=128
BLKSIZE=A value appropriate for your site
Member Name
OUTPUT
•
•
Enter a 1- to 8-character member name.
Enter an asterisk ( * ) to load all images in a PDS.
Dataset Name
Enter the name of the native decentralized image library. In the XOSF start-up
proc, this is the dataset name in the DD statement specified for the
decentralized image library by the DIMAGELIB initialization parameter or the
IMAGELIB printer profile parameter.
Member Name
•
Enter the 1- to 20-character image name as it will be known to the printer.
•
Leave this field blank if you want the output member name to be the same
as the input member name.
The member name must conform to the image naming conventions required for
your decentralized printer. Refer to your decentralized printer manual for more
information.
Section Three: Managing Resources with XPAF
21-15
Loading resources to a native library
TSO/Batch command
You can use this TSO/batch command as an alternative to using the Load
Decentralized Images option:


LOA D IMA GE('input-dataset-name(  member-name  )')
*


[TO]('output-dataset-name[(member-name)]') DEC ENTRALIZED
Section Three: Managing Resources with XPAF
21-16
Loading resources to a native library
Loading PDL
To load a PDL member, enter 8 on the Load Resources menu OPTION
line and press ENTER. This panel appears:
Xerox Output Administrative Facility
Load PDL to a Native Library
COMMAND ===>
INPUT
Dataset Name:
Member Name:
OUTPUT
Dataset Name:
PCL Version:
NOTE:
Use the following PCL versions if using JDL with large paper size
or color options:
V3A FOR 11 X 17 (4635)
V37 FOR COLOR
(4890)
V35 FOR NORMAL (4090) - Default
Complete these fields and press ENTER:
Field
INPUT
Dataset Name
Action
Enter the name of the PDS where the source members are stored. The
recommended dataset specifications are:
RECFM=FB
For JSL source files, use RECFM=FB, LRECL=80
For PDL object files, use RECFM=FB, LRECL=128
BLKSIZE=A value appropriate for your site
NOTE: The PDL loader identifies text in 80-byte records as JSL
source files. 128-byte records containing binary data with a standard
file header preceding them are identified as PDL objects.
Member Name
Enter the 1- to 8-character name of the member in which the PDL resides.
Wild cards may be specified in the input member name to facilitate mass
loading. The * and ? wild cards may be specified. Any text following an “ * “ is
considered to match the member name character position. Any text in the
position indicated with a “ ? “is considered to match.
Section Three: Managing Resources with XPAF
21-17
Loading resources to a native library
Field
Action
Dataset Name
Enter the name of the native library to which the PDL member is being loaded.
This is the dataset in the XOSF start-up proc DD statement named by the
PDLLIB initialization or printer profile parameter.
OUTPUT
PCL Version
Enter the version of the printer control language software running on the
centralized printer. Any eight characters can be used to indicate the software
version.
Default: V35
For PDL object files the PCLVER is saved as a part of the member name. When
an attempt is made to match the PCLVER to the printer definition
LPSRELEASE and an exact match cannot be found, the first object with the
correct name and type will be used. Refer to chapter 19, “XPAF resources,” for
more information.
CAUTION: If incorrect default values are entered, unpredictable results
may occur.
NOTE: Specify V37 when PDL object files contain color references.
Specify V3A when you have specified large paper sizes such as 11x17
inches.
TSO/Batch command
You can use this TSO/batch command as an alternative to using the Load
PDL option:
LOA D PDL('input-dataset-name(member-name)')
 Vnn 
[TO]('output-dataset-name')[PCL VER( 
 )]
 V35 
A customized sample XOAF Batch job for loading LCDS (centralized) PDL
can be found in the STAGE2 library as member RLJSLLD.
Section Three: Managing Resources with XPAF
21-18
Loading resources to a native library
PDL loader member naming conventions
When you load PDL to the native library, the PDL loader creates a
separate member for each labeled statement included in the PDL and
assigns it a 20-byte name. The format is as follows:
Table 21-1.
PDL member name processing
File type
JSL format
Member name format
Each member name is a 20-byte name constructed using the JDL name, the statement
identifier, and the type separated by periods.
The first 6 characters contain the JDL name, which may be padded with space
characters at the end of the name if it is not 6 characters. After a period, the next 6
characters contain the statement identifier, which may be padded with space
characters at the end of the name if it is not 6 characters. After a period, the
3-character type is followed by 3 space characters.
For example, if the JDL name is DFAULT, the statement identifier is DFLT, and the
type is JDE, the member name generated would be “DFAULT.DFLT .JDE ”.
Cataloged
member format
Each member name is a 20-byte name constructed using a constant string, the
statement identifier, and the type separated by periods.
The first 6 characters is the constant string ‘$GLOB$’. After a period, the next 6
characters is the statement identifier, which may be padded with space characters at
the end of the name if it is not 6 characters. After a period, the 3-character type is
followed by 3 space characters.
For example, if the statement identifier is FMT1 and the type is PDE, the member
name generated would be “$GLOB$.FMT1 .PDE ”.
PDL object files
Each object name is a 20-byte name constructed using the file name, the file type, and
the PCL version separated by periods.
The first 6 characters is the file name, which may be padded with space characters at
the end of the name if it is not 6 characters. After a period the next 3 characters are
the file type. After a period, the PCL version may be padded with space characters if
it is not 8 characters.
For example, if the file name is DFAULT, the file type is JDL, and the PCL version is
3.5, the PDL object name would be “DFAULT.JDL.V35
”.
Section Three: Managing Resources with XPAF
21-19
Loading resources to a native library
PDL processing considerations
The PDL loader loads PDL as coded. The loader is not designed to handle
PDL coding errors. Should errors exist within the PDL, the results may be
unpredictable.
In addition, note these considerations when using the PDL loader:
•
If your PDL contains statements with duplicate names, they will be
flagged as errors during the loading process.
•
If you have used the PDL loader to load an updated PDL member,
you must drain and restart the printer before using the updated PDL.
•
If you simultaneously load PDL members to a native library and print
documents through XOSF, you may receive error messages
indicating that a requested resource is unavailable. As a result,
decentralized documents may be printed incorrectly. If there are
errors in a document, resubmit the print job after PDL loading has
completed and the printer has been restarted.
•
If you reload a PDL object member and a corresponding JSL source
member and are using AUTOREV, you must drain and restart the
printer for the source object to remain in sync.
PDL compile function
XPAF will now, optionally, compile any JSL loaded with the PDL Loader.
Compiled JSL (PDL Objects) have been a loadable resource with the PDL
XPAF/XPSC V3R0 Maintenance Bulletin for WA5201 (05/20/2005) 4-21
Technical notes
Loader for some time. XOAF now has the ability to invoke the PDL
Compiler and then load the output PDL Objects into the PDLLIB without
any user intervention.
This function is invoked when the LOAD PDL command is used in the
batch XOAF environment or option 1.8 (Load PDL) is used in the on-line
TSO environment.
Enabling the PDL Compiler
A new XINSXOAF XINPARM parameter, XPDL=YES will enable the PDL
Compiler. Additionally, six new system information files must be installed from
the XPAF Maintenance file and their DDs must be added to your XOAF JCL
(TSO CLIST or Batch) as follows:
//CON DD DISP=SHR,DSN=your.hlq.XPDLCNF
//MSG DD DISP=SHR,DSN=your.hlq.XPDLMSG
//INVXLT DD DISP=SHR,DSN=your.hlq.INVXLT
//PCCFIL DD DISP=SHR,DSN=your.hlq.PCCFIL
//TYPFIL DD DISP=SHR,DSN=your.hlq.TYPFIL
//XPDLDFT DD DISP=SHR,DSN=your.hlq.XPDLDFT
Section Three: Managing Resources with XPAF
21-20
Loading resources to a native library
Instructions for unloading these files are included in section 3 of this
Maintenance Bulletin under the heading XPDL Resource datasets.
In addition to the new DDs in your TSO CLIST, you must also specify a
FREE FILE(SYSPRINT) to avoid some file allocation issues. A sample of
an updated XOAF CLIST follows:
PROC 0
CONTROL NOFLUSH NOMSG
OUTDES XXX REUSE CLASS(X)
ALLOC FILE(XINPARM) DA('your.hlq.XINPARM') SHR
ALLOC FILE(TABLELIB) DA('your.hlq.TABLELIB') SHR
ALLOC FILE(CON) DA('your.hlq.XPDLCNF') SHR
ALLOC FILE(MSG) DA('your.hlq.XPDLMSG') SHR
ALLOC FILE(INVXLT) DA('your.hlq.INVXLT') SHR
ALLOC FILE(PCCFIL) DA('your.hlq.PCCFIL') SHR
ALLOC FILE(TYPFIL) DA('your.hlq.TYPFIL') SHR
ALLOC FILE(XPDLDFT) DA('your.hlq.XPDLDFT') SHR
ALLOC FILE(UJLLIST) OUTDES(XXX) SYSOUT REU
FREE FILE(SYSPRINT)
ISPEXEC SELECT PGM(XOASPF00) NEWPOOL
FREE FILE(CON)
FREE FILE(MSG)
FREE FILE(INVXLT)
FREE FILE(PCCFIL)
FREE FILE(TYPFIL)
FREE FILE(XPDLDFT)
FREE FILE(UJLLIST)
FREE FILE(SYSPRINT)
FREE FILE(TABLELIB)
FREE FILE(XINPARM)
EXIT
PDL loader report
The PDL loader generates a report that shows the contents of each PDL library
member created during loading. Figure 21-1 shows a sample report.
The report is written to a dataset with the DD name UJLLIST, included in
the XOAF logon proc and XOAF batch JCL. As shown in the following
examples, you can specify a dataset name in place of SYSOUT.
//XOAFBAT
//XOAF
//UJLLIST
//XOAIN
PROC
EXEC
CORE=4096K,USER=
PGM=XOASUP00,REGION=&CORE,PARM=(&USER)
.
additional DD statements
.
DD
SYSOUT=*,DCB=(RECFM=FBA,LRECL=133,BLKSIZE=1330)
DD
DDNAME=SYSIN
Section Three: Managing Resources with XPAF
21-21
Loading resources to a native library
//XOAFBAT
//XOAF
//UJLLIST
//XOAIN
PROC
EXEC
CORE=4096K,USER=
PGM=XOASUP00,REGION=&CORE,PARM=(&USER)
.
additional DD statements
.
DD
DSN=prefix.UJLLIST,DISP=SHR
DD
DDNAME=SYSIN
If you specify a dataset name in the XOAF logon proc or batch JCL, you
must preallocate a sequential dataset with these specifications:
RECFM=FBA
LRECL=133
BLKSIZE=1330
Deleting obsolete PDL members
You can delete the obsolete members from a native PDL library by using
either the Display a Directory of Library Members option or the Delete a
Member option on the Manage Libraries menu. Refer to chapter 27,
“Managing XPAF libraries,” for information about how to use these
options.
Alternatively, you can use the LIBRARY DIRECTORY or LIBRARY
DELETE TSO/batch commands to display or delete obsolete members.
Refer to chapter 27, “Managing XPAF libraries,” for the format for these
commands.
Section Three: Managing Resources with XPAF
21-22
Loading resources to a native library
Figure 21-1. Sample PDL loader report
X E R O X
P D L
L O A D E R
R E P O R T
PAGE
INPUT-DSN=XPAF30.PDLSOURCE
INPUT-MEMBER=SAMPLE1
OUTPUT-DSN=XPAF30.PDLLIB
PCLVER=V35
*************************
DFAULT.DFLT .JDE
************************
DFLT:
JDE;
ACCT
USER=NONE;
BANNER
HCOUNT=1,
HJOBNO=(12,5),
HRPTNA=(18,8),
TCOUNT=1,
TEST=(C1 OR C2);
IDEN
OFFSET=0,
OPRINFO=NO,
PREFIX='@@@DJDE',
SKIP=8;
LINE
DATA=(0,250),
FCB=IGNORE,
UCSB=IGNORE,
VFU=VFU1;
OUTPUT
DUPLEX=YES,
FORMAT=FMT01,
GRAPHICS=YES,
OFFSET=NONE,
STAPLE=NO,
STOCKS=STK2;
RAUX
TEST=(C1 OR C5);
RECORD
LENGTH=214;
RSTACK
ACCTINFO=(32,20),
DELIMITER=YES,
HRPTNA=(16,16),
PRINT=NONE,
TEST=(C4);
************************************************************************
*************************
$GLOB$.FMT1 .PDE
************************
FMT1:
PDE
BEGIN=(.18,.66),
FONT=L0112B,
PMODE=LANDSCAPE;
************************************************************************
*************************
$GLOB$.FMT2 .PDE
************************
FMT2:
PDE
BEGIN=(.18,.50),
FONT=L0212A,
PMODE=LANDSCAPE;
************************************************************************
UJL0701I PDL LOADER COMPLETED SUCCESSFULLY
Section Three: Managing Resources with XPAF
1
21-23
Loading resources to a native library
Section Three: Managing Resources with XPAF
21-24
Converting resources
22.
22
Converting resources
This chapter describes how to use the options available through the
Convert Resources menu to perform these types of conversions:
•
Convert centralized fonts in .FNT format to decentralized (sixelized)
format. You must use this option when you want to print a document
that was originally coded for a centralized printer on an XES printer
NOTE: XPAF 6.0 will automatically convert LCDS fonts to an
intermediate format and then to PCL or PDF as required. There is no
need to manually preconvert fonts. Refer to the FNTLGOCONV
initialization parameter for information on how to disable this feature.
•
Convert logos in .LGO format to decentralized fonts. You must use
this option when you want to print a document that was originally
coded for a centralized printer on an XES printer. Any logos included
in a LCDS form must be converted separately and made available to
the printer prior to printing the job.
NOTE: XPAF 6.0 will automatically convert LCDS logos to an
intermediate format and then to PCL or PDF as required. There is no
need to manually preconvert logos. Refer to the FNTLGOCONV
initialization parameter for information on how to disable this feature.
•
Convert a Xerox font to IBM format for use in a DCF/SCRIPT
document.
•
Preconvert AFP page segments to .IMG or RES .IMG format and
load them to native libraries. By preconverting the page segments,
your document can be printed without having to wait for a dynamic
conversion during processing.
Converting centralized fonts to decentralized fonts
Before using this option, you should be aware of certain considerations
related to performing a centralized-to-decentralized font conversion. You
also should verify that the XPAFXFI table contains valid character
mapping information for the fonts to be converted.
Conversion considerations
Note these considerations when performing a centralized-todecentralized font conversion:
•
Inverse portrait and inverse landscape centralized replica fonts
cannot be converted to decentralized fonts. Decentralized inverse
Section Three: Managing Resources with XPAF
22-1
Converting resources
portrait and inverse landscape fonts are actually portrait and
landscape fonts with the rasters inverted. When these fonts are
converted for use with AFP documents they will be positioned
incorrectly in your document. You must obtain the correct versions of
these fonts from Xerox Font Services or a third-party vendor.
•
One centralized font can be mapped to up to eight decentralized
fonts, also known as planes, during centralized-to-decentralized font
conversion. While a centralized font can contain up to 240
characters, a decentralized font can contain only a maximum of 192
characters. For example, DCMV01, the default decentralized
character mapping table provided with XPAF, places the most
commonly used 192 code points in plane 01, also known as the
primary plane. The remaining code points are placed in plane 02.
•
If you are converting a centralized font that contains more than 192
characters to a decentralized font, you may want to adjust which
characters will reside in the primary plane, plane 01, and which
characters will be mapped to the remaining planes (02 through 08).
Refer to “Adjusting your decentralized character mapping tables”
later in this chapter for instructions about how to adjust the way
characters in your font are distributed in each plane.
•
Each plane can contain a maximum of 64K of raster data. During
centralized-to-decentralized font conversion, if a font contains more
than 64K of raster data, its characters must be placed in more than
one plane. If the 64K storage memory limit for a decentralized font is
reached during conversion, this means that a plane is full. XPAF
issues a message telling you which plane is full and stops
processing all remaining character IDs. You must edit the
appropriate decentralized character mapping table, change the
plane numbers for the remaining character IDs and code points to a
plane number that is not full, and run the
centralized-to-decentralized conversion again.
•
If you attempt to convert a font and exceed the 64K storage limit,
refer to “Adjusting your decentralized character mapping tables”
later in this chapter for information about the steps you must take to
perform the conversion successfully.
•
Some ASCII code points are reserved for XPAF or printer use, and
therefore cannot have any characters assigned to them. For more
information about reserved code points, refer to the discussions
about creating character mapping tables from a dataset and online in
chapter 24, “Managing XPAF tables.”
•
If you have two character IDs mapped to the same code point and
plane number combination, XPAF issues a message telling you
which character ID in the font is in error. Font conversion continues,
but the character ID that tried to use an existing code point/plane
number combination is dropped from font processing and will not be
found in the new font. You must edit the appropriate decentralized
character mapping table, change the plane number of the character
ID in error to an unused code point and plane number combination,
and run centralized-to- decentralized font conversion again.
Section Three: Managing Resources with XPAF
22-2
Converting resources
Verifying XPAFXFI table entries
Before you use this option, you must ensure that the XPAFXFI table entry
for the centralized font contains valid centralized and decentralized
character mapping names. During centralized-todecentralized conversion, XOAF uses the centralized and decentralized
character mapping names to determine where to place the centralized
characters in the decentralized font. If the XPAFXFI table does not
contain valid centralized and decentralized character mapping name
entries, XOAF terminates centralized-to-decentralized font conversion
and issues an error message.
To ensure that the XPAFXFI table contains the necessary entries,
complete these steps:
Step 1.
Use the Load Centralized Fonts option on the Load Resources menu or
the LOAD FONT TSO/batch command to load the centralized version of
the font to the centralized font library. Specify the centralized and
decentralized character mapping table names here. If none are specified,
default names are generated to the XPAFXFI table during loading. Refer
to chapter 21, “Loading resources to a native library,” for more information
about this option.
Step 2.
Use the Maintain the Xerox Font Information (XPAFXFI) Table option on
the Maintain Font Tables menu to verify that the appropriate character
mapping table names are listed in the ‘Centralized Character Mapping
Name’ and ‘Decentralized Character Mapping Name’ fields. Refer to
chapter 24, “Managing XPAF tables,” for more information about this
option.
Step 3.
Use the Maintain the Character Mapping Tables option on the Maintain
Font Tables menu to verify that all expected character IDs exist in the
centralized character mapping table, and that the character IDs in the
decentralized character mapping table are mapped to the desired code
point and plane number combinations. Refer to chapter 24, “Managing
XPAF tables,” for more information about this option.
If you need to modify the decentralized character mapping table, refer to
“Adjusting your decentralized character mapping tables” later in this
chapter before performing centralized-to-decentralized font conversion.
Section Three: Managing Resources with XPAF
22-3
Converting resources
Using this option
To convert fonts from centralized to decentralized format, enter 1 on the
Convert Resources menu OPTION line and press ENTER. This panel
appears:
Xerox Output Administrative Facility
Convert Centralized Fonts to Decentralized Fonts
COMMAND ===>
INPUT
Dataset Name:
Member Name:
OUTPUT
Dataset Name:
OUTPUT SPECIFICATIONS
Message Listing:
Font Sample (Y/N/R):
Lower Range Limit:
Upper Range Limit:
Complete these fields and press ENTER:
Field
Action
Dataset Name
Enter the name of the PDS, sequential dataset, or native centralized font library
that contains the centralized font you want to convert. If you have multiple fonts
concatenated in a single file, they must be converted from a sequential dataset
with valid headers. All fonts within the sequential dataset will be converted. The
dataset specifications for a PDS or sequential dataset are:
INPUT
RECFM=F or FB
LRECL=128
BLKSIZE=A value appropriate for your site
Section Three: Managing Resources with XPAF
22-4
Converting resources
Field
Member Name
Action
•
Enter the 1- to 8-character member name if the font is stored in a PDS or
native library. The member name may or may not match the logical font
name.
You can enter a specific font name in this field, or use a wildcard character
to select all fonts or fonts beginning with a certain prefix. For example:
*
Selects all members.
RX*
Selects all members that begin with RX.
RX?ABC Selects all members that begin with RX, end with ABC, and
have one character in between RX and ABC.
RX1ABC Selects the single member RX1ABC.
•
Leave this field blank if the font is stored in a sequential dataset.
NOTE: Remember that you cannot convert a licensed centralized font to a
decentralized font. Instead, you must obtain a licensed decentralized
version of the font.
OUTPUT
Dataset Name
Enter the name of the native decentralized font library where the converted font
will be stored. In the XOSF start-up proc, this is the dataset name in the DD
statement specified for the decentralized font library by the DFONTLIB
initialization parameter or FONTLIB printer profile parameter.
The decentralized font name is constructed from the name in the centralized
font header record.
OUTPUT
SPECIFICATIONS
Message Listing
Enter the name of the sequential dataset to which you want conversion
messages to be written. The dataset contents are in XES format and can be
sent to any decentralized printer. Do not specify the XOAF message dataset.
Refer to Section Six: XPAF Messages for an explanation of font conversion
messages and any required user action.
The recommended dataset specifications are:
RECFM=FB
LRECL=133
BLKSIZE=A value appropriate for your site
Default: None
Section Three: Managing Resources with XPAF
22-5
Converting resources
Field
Font Sample
Action
Identify the type of font information to be stored in the dataset specified in the
‘Message Listing’ field. It can be either the font sample for the converted
decentralized font, the font sample plus a raster breakdown for each character
in a specified range, or nothing.
Valid values:
Y
Generates the font sample for the converted decentralized font and
stores it in the dataset identified in the ‘Message Listing’ field.
N
Does not generate anything in the message listing dataset.
R
Generates the font sample for the converted decentralized font plus a
raster breakdown for each character in a specified range. This
information is stored in the dataset identified in the ‘Message Listing’
field. You also must specify values in the ‘Lower Range Limit’ and
‘Upper Range Limit’ fields.
Default: None
Lower Range Limit
Enter the ASCII code point starting value for the raster breakdown, which will
be stored in the dataset identified in the ‘Message Listing’ field.
Valid values:
A 2-digit hexadecimal value from 20 through FF. To select all
characters, enter 20 here and FF in the ‘Upper Range Limit’
field.
Default: None
NOTE: Some ASCII code points are reserved for XPAF or printer use, and
therefore cannot have any characters assigned to them. For more
information about reserved code points, refer to the discussions about
creating character mapping tables from a dataset and online in chapter 24,
“Managing XPAF tables.”
Upper Range Limit
Enter the ASCII code point ending value for the raster breakdown, which will be
stored in the dataset identified in the ‘Message Listing’ field.
Valid values:
A 2-digit hexadecimal value from 20 through FF. To select all
characters, enter 20 in the ‘Lower Range Limit’ field and FF
here.
Default: None
NOTE: The output created by the ‘Lower Range Limit’ and ‘Upper Range
Limit’ fields may be large depending upon the font size and the number of
characters specified in these fields.
Section Three: Managing Resources with XPAF
22-6
Converting resources
TSO/Batch command
You can use this TSO/batch command as an alternative to using the
Convert Centralized Fonts to Decentralized Fonts option:


CON VERT XFO NT('input-dataset-name[(  member-name  )]')
*


 Y 
[TO]('output-dataset-name') SAM PLE(  N  ) [LIST('list-dataset-name')


 R 
LOW ER(nn) UPP ER(nn)]
NOTE: If SAMPLE is set to Y, LIST is required. If SAMPLE is set to
R, LIST, LOWER, and UPPER are required. nn is a hexadecimal
value from 20 to FF.
Adjusting your decentralized character mapping tables
You will need to adjust your character mapping tables under these
conditions:
•
If you exceed the 64K storage limitation during the
centralized-to-decentralized font conversion
•
If you want to adjust the way the characters in your font are
distributed to which planes for greater printing performance
Adjusting to accommodate the 64K storage limitation
Perform one of these procedures if XPAF issues a message during the
centralized-to-decentralized font conversion telling you the plane is full.
•
If you specified DCMV01 as the decentralized character mapping
table for the font in the XPAFXFI table and exceeded the 64K
storage limitation during font conversion, perform these steps:
1.
Use the Maintain the Xerox Font Information (XPAFXFI) Table
option on the Maintain Font Tables menu to specify DCMV02 in
the ‘Decentralized Character Mapping Name’ field for the font.
DCMV02 more evenly distributes the code points for large fonts
between two planes rather than placing the most commonly
used 192 code points in plane 01.
2.
Run the centralized-to-decentralized font conversion again
using either the Convert Centralized Font to Decentralized Fonts
option on the Convert Resources menu or the CONVERT
XFONT TSO/batch command.
Section Three: Managing Resources with XPAF
22-7
Converting resources
3.
•
•
Use the Convert Xerox Fonts to IBM Format option on the
Convert Resources menu or the CONVERT FONT TSO/batch
command to ensure that the XPAFEFW and XPAFE2A tables
are updated with information that is needed to position
characters correctly at print time. Refer to “Converting Xerox
fonts to IBM format” later in this chapter for more information.
If you specified DCMV02 as the decentralized character mapping
table for the font in the XPAFXFI table and exceeded the 64K
storage limitation during font conversion, perform these steps:
1.
Create a site-specific decentralized character mapping table
which maps the code points for the font across more than two
planes. Then load the table using the Create/Update a
Character Mapping Table from a Dataset option on the Maintain
Character Mapping Tables menu. Refer to chapter 24,
“Managing XPAF tables,” for more information about creating
and loading character mapping tables.
2.
Use the Maintain the Xerox Font Information (XPAFXFI) Table
option on the Maintain Font Tables menu to specify the name of
the new decentralized character mapping table in the
‘Decentralized Character Mapping Name’ field for the font.
3.
Run the centralized-to-decentralized font conversion again
using either the Convert Centralized Font to Decentralized Fonts
option on the Convert Resources menu or the CONVERT
XFONT TSO/batch command.
4.
Use the Convert Xerox Fonts to IBM Format option on the
Convert Resources menu or the CONVERT FONT TSO/batch
command to ensure that the XPAFEFW and XPAFE2A tables
are updated with information that is needed to position
characters correctly at print time. Refer to “Converting Xerox
fonts to IBM format” later in this chapter for more information.
If you specified your site-specific character mapping table as the
decentralized character mapping table for the font in the XPAFXFI
table and exceeded the 64K storage limitation during font
conversion, perform these steps:
1.
Edit the PDS member that is the input source for the
decentralized character mapping table you want to modify.
Change the plane numbers for the remaining character IDs and
code points to a plane number that is not full. Then load the
table using the Create/Update a Character Mapping Table from
a Dataset option on the Maintain Character Mapping Tables
menu. Refer to chapter 24, “Managing XPAF tables,” for more
information about creating and loading character mapping
tables.
2.
Use the Maintain the Xerox Font Information (XPAFXFI) Table
option on the Maintain Font Tables menu to specify the name of
the new decentralized character mapping table in the
‘Decentralized Character Mapping Name’ field for the font.
Section Three: Managing Resources with XPAF
22-8
Converting resources
3.
Run the centralized-to-decentralized font conversion again
using either the Convert Centralized Font to Decentralized Fonts
option on the Convert Resources menu or the CONVERT
XFONT TSO/batch command.
4.
Use the Convert Xerox Fonts to IBM Format option on the
Convert Resources menu or the CONVERT FONT TSO/batch
command to ensure that the XPAFEFW and XPAFE2A tables
are updated with information that is needed to position
characters correctly at print time. Refer to “Converting Xerox
fonts to IBM format” later in this chapter for more information.
Adjusting for performance optimization
If all of your converted characters fit into one plane, you can either leave
them in this configuration, or you can move the characters you do not use
frequently into a second plane. You must determine if you receive greater
printing performance by loading one large font, or by loading two smaller
fonts and switching between them during a print job.
If more than one plane is needed to represent a font, place all of your most
commonly used characters in the primary plane. The less font switching
that occurs during a print job, the greater printing performance you will
receive. For example, if the 26 characters of the English alphabet are
mapped to plane 01 and the é character is mapped to plane 02, moving
the é character to the primary plane would result in less font switching
when printing documents containing French text.
To adjust a decentralized character mapping table, follow this procedure.
Step 1.
Offload your existing font tables so that you have a backup. Refer to
chapter 27, “Managing XPAF libraries,” for instructions about offloading
members of a library.
Step 2.
Edit the PDS member that is the input source for the decentralized
character mapping table you want to modify. Adjust which code point and
plane number each character ID will reside in after conversion. Then load
the table using the Create/Update a Character Mapping Table from a
Dataset option on the Maintain Character Mapping Tables menu.
Step 3.
Run the centralized-to-decentralized font conversion using either the
Convert Centralized Font to Decentralized Fonts option on the Convert
Resources menu or the CONVERT XFONT TSO/batch command.
Step 4.
Use the Convert Xerox Fonts to IBM Format option on the Convert
Resources menu or the CONVERT FONT TSO/batch command to ensure
that the XPAFEFW and XPAFE2A tables are updated with information
that is needed to position characters correctly at print time. Refer to
“Converting Xerox fonts to IBM format” later in this chapter for more
information.
Step 5.
For all printers using font lists, use the REVFONT extended JCL keyword
to download the newly converted font.
Section Three: Managing Resources with XPAF
22-9
Converting resources
Font conversion sample
As part of the XPAF centralized-to-decentralized font conversion, you can
specify that a sample of the converted font be generated to a message
dataset. The sample can be generated with just a decentralized code
points table and font sample or with these items plus a raster sample.
On the following pages, a centralized-to-decentralized font conversion
scenario is given. In this example, the contents of the XPAFXFI table,
centralized character mapping table, and decentralized character
mapping table for font RA12BP are shown. Then the Convert Centralized
Fonts to Decentralized Fonts panel entries which initiate the font
conversion are shown. Lastly, the contents of the resulting message
dataset are shown and explained.
NOTE: This example is meant only to explain the contents of the
message dataset generated during centralized-to-decentralized font
conversion. You already should be familiar with the required
components and procedures related to centralized-todecentralized font conversion before you read this example.
Sample Xerox font information table requirements
The font RA12BP must have the XPAFXFI table set up with entries for its
centralized and decentralized character mapping tables. In this example,
the centralized character mapping table for RA12BP is CSAMP1, and its
decentralized character mapping table is DSAMP1. A sample panel is
shown below.
Refer to chapter 24, “Managing XPAF tables,” for more information about
updating the XPAFXFI table.
Xerox Output Administrative Facility
Maintain the Xerox Font Information (XPAFXFI) Table
COMMAND ===>
* On COMMAND line, enter 'U' to create or update an entry.
Logical Font Name: RA12BP
SPECIFICATIONS
Font Name:
Centralized Character Mapping Name:
Decentralized Character Mapping Name:
Code Page Name:
Font Width:
Font Height:
Baseline to Top of Cell:
Decentralized Font Name:
Section Three: Managing Resources with XPAF
RA12BP
CSAMP1
DSAMP1
RXCP08
0017
0024
0019
22-10
Converting resources
Sample centralized character mapping table requirements
The contents of the sample centralized character mapping table CSAMP1
are:
CHARID=LA010000
CHARID=LA020000
CHARID=LB010000
CHARID=LB020000
CHARID=LC010000
CHARID=LC020000
CHARID=LD010000
CHARID=LD020000
CHARID=LE010000
CHARID=LE020000
CHARID=LF010000
CHARID=LF020000
CHARID=LG010000
CHARID=LG020000
CHARID=LH010000
CHARID=LH020000
CHARID=LI010000
CHARID=LI020000
CHARID=LJ010000
CHARID=LJ020000
CHARID=LK010000
CHARID=LK020000
CHARID=LL010000
CHARID=LL020000
CHARID=LM010000
CHARID=LM020000
CHARID=LN010000
CHARID=LN020000
CHARID=LO010000
CHARID=LO020000
CHARID=LP010000
CHARID=LP020000
CHARID=LQ010000
CHARID=LQ020000
CHARID=LR010000
CHARID=LR020000
CHARID=LS010000
CHARID=LS020000
CHARID=LT010000
CHARID=LT020000
CHARID=LU010000
CHARID=LU020000
CHARID=LV010000
CHARID=LV020000
CHARID=LW010000
CHARID=LW020000
CHARID=LX010000
CHARID=LX020000
CHARID=LY010000
CHARID=LY020000
CHARID=LZ010000
CHARID=LZ020000
ASCII=61
ASCII=41
ASCII=62
ASCII=42
ASCII=63
ASCII=43
ASCII=64
ASCII=44
ASCII=65
ASCII=45
ASCII=66
ASCII=46
ASCII=67
ASCII=47
ASCII=68
ASCII=48
ASCII=69
ASCII=49
ASCII=6A
ASCII=4A
ASCII=6B
ASCII=4B
ASCII=6C
ASCII=4C
ASCII=6D
ASCII=4D
ASCII=6E
ASCII=4E
ASCII=6F
ASCII=4F
ASCII=70
ASCII=50
ASCII=71
ASCII=51
ASCII=72
ASCII=52
ASCII=73
ASCII=53
ASCII=74
ASCII=54
ASCII=75
ASCII=55
ASCII=76
ASCII=56
ASCII=77
ASCII=57
ASCII=78
ASCII=58
ASCII=79
ASCII=59
ASCII=7A
ASCII=5A
Section Three: Managing Resources with XPAF
22-11
Converting resources
Sample decentralized character mapping table requirements
The contents of the decentralized character mapping table DSAMP1 are:
CHARID=LA010000
CHARID=LA020000
CHARID=LB010000
CHARID=LB020000
CHARID=LC010000
CHARID=LC020000
CHARID=LD010000
CHARID=LD020000
CHARID=LE010000
CHARID=LE020000
CHARID=LF010000
CHARID=LF020000
CHARID=LG010000
CHARID=LG020000
CHARID=LH010000
CHARID=LH020000
CHARID=LI010000
CHARID=LI020000
CHARID=LJ010000
CHARID=LJ020000
CHARID=LK010000
CHARID=LK020000
CHARID=LL010000
CHARID=LL020000
CHARID=LM010000
CHARID=LM020000
CHARID=LN010000
CHARID=LN020000
CHARID=LO010000
CHARID=LO020000
CHARID=LP010000
CHARID=LP020000
CHARID=LQ010000
CHARID=LQ020000
CHARID=LR010000
CHARID=LR020000
CHARID=LS010000
CHARID=LS020000
CHARID=LT010000
CHARID=LT020000
CHARID=LU010000
CHARID=LU020000
CHARID=LV010000
CHARID=LV020000
CHARID=LW010000
CHARID=LW020000
CHARID=LX010000
CHARID=LX020000
CHARID=LY010000
CHARID=LY020000
CHARID=LZ010000
CHARID=LZ020000
ASCII=41
ASCII=41
ASCII=42
ASCII=42
ASCII=43
ASCII=43
ASCII=44
ASCII=44
ASCII=45
ASCII=45
ASCII=46
ASCII=46
ASCII=47
ASCII=47
ASCII=48
ASCII=48
ASCII=49
ASCII=49
ASCII=4A
ASCII=4A
ASCII=4B
ASCII=4B
ASCII=4C
ASCII=4C
ASCII=4D
ASCII=4D
ASCII=4E
ASCII=4E
ASCII=4F
ASCII=4F
ASCII=50
ASCII=50
ASCII=51
ASCII=51
ASCII=52
ASCII=52
ASCII=53
ASCII=53
ASCII=54
ASCII=54
ASCII=55
ASCII=55
ASCII=56
ASCII=56
ASCII=57
ASCII=57
ASCII=58
ASCII=58
ASCII=59
ASCII=59
ASCII=5A
ASCII=5A
Section Three: Managing Resources with XPAF
PLANE=01
PLANE=02
PLANE=01
PLANE=02
PLANE=01
PLANE=02
PLANE=01
PLANE=02
PLANE=01
PLANE=02
PLANE=01
PLANE=02
PLANE=01
PLANE=02
PLANE=01
PLANE=02
PLANE=01
PLANE=02
PLANE=01
PLANE=02
PLANE=01
PLANE=02
PLANE=01
PLANE=02
PLANE=01
PLANE=02
PLANE=01
PLANE=02
PLANE=01
PLANE=02
PLANE=01
PLANE=02
PLANE=01
PLANE=02
PLANE=01
PLANE=02
PLANE=01
PLANE=02
PLANE=01
PLANE=02
PLANE=01
PLANE=02
PLANE=01
PLANE=02
PLANE=01
PLANE=02
PLANE=01
PLANE=02
PLANE=01
PLANE=02
PLANE=01
PLANE=02
22-12
Converting resources
Notice how the lowercase characters (LA010000, LB010000, and so on)
in the decentralized character mapping table will be mapped to different
ASCII code points after font conversion than they are mapped to in the
centralized character mapping table. Also, all lowercase characters will
be mapped to plane 01, and all uppercase characters will be mapped to
plane 02 after font conversion.
Sample Convert Centralized Fonts to Decentralized Fonts
panel requirements
The sample panel entries for the Convert Centralized Fonts to
Decentralized Fonts option are shown below.
Xerox Output Administrative Facility
Convert Centralized Fonts to Decentralized Fonts
COMMAND ===>
INPUT
Dataset Name: 'XRESC.XPAF30.CFONTLIB'
Member Name: RA12BP
OUTPUT
Dataset Name: 'XRESC.XPAF30.DFONTLIB'
OUTPUT SPECIFICATIONS
Message Listing:
Font Sample (Y/N/R):
Lower Range Limit:
Upper Range Limit:
'TJONES.XPAF30.FONTSAMP'
R
40
42
In this example, a sample of the converted font, including raster samples,
was requested by entering R in the ‘Font Sample’ field. The message
dataset in which the font sample will be produced is
TJONES.XPAF30.FONTSAMP. A raster sample of code points 40, 41,
and 42 will be produced in this message dataset if those code points exist
in the decentralized character mapping table for this font.
Section Three: Managing Resources with XPAF
22-13
Converting resources
Sample message dataset produced
Given the contents of the XPAFXFI table, centralized character mapping
table, and decentralized character mapping table for font RA12BP shown
previously, and the entries made on the sample Convert Centralized
Fonts to Decentralized Fonts panel, the output shown in figures 22-1
through 22-8 is representative of what would be generated to the
message dataset TJONES.XPAF30.FONTSAMP. These figures follow an
explanation of the output. Each figure represents one page of output in
the message dataset, and the order in which the information is presented
in this example is the same order that you would find in the message
dataset.
In this example, the centralized font RA12BP was converted into two
planes, as specified in its decentralized character mapping table. Figures
22-1 through 22-4 represent the output for plane 01, and figures 22-5
through 22-8 represent the output for plane 02.
The decentralized font name shown in all these figures is the centralized
font name appended with the @ symbol and a number. This number
represents the plane number to which this information pertains. For
example, RA12BP@1 is plane 01 of the converted font, and RA12BP@2
is plane 02 of the converted font.
Since R was specified in the ‘Font Sample’ field on the XOAF panel, there
are three sections of information produced in the message dataset:
•
•
•
A raster sample of the specified decentralized code points
A decentralized code points table
A font sample
This font information is listed in this order for each plane of the converted
font.
NOTE: If Y had been specified in the ‘Font Sample’ field, only the
decentralized code points table and font sample for each plane would
be produced in the message dataset. If N had been specified in the
‘Font Sample’ field, nothing would be generated to a message
dataset, but the centralized font would still have been converted to
decentralized format based on the entries in the centralized and
decentralized character mapping tables.
Raster sample for plane 01
The first item in the message dataset, the raster sample, consists of a
representation of each character in the specified code point range, one
page per code point. Each page gives the font statistics in the upper left,
the character statistics in the upper right, and a raster sample of the
converted character at the bottom of the page. Figures 22-1 and 22-2
show the raster samples for the decentralized code points 41 and 42,
respectively.
Section Three: Managing Resources with XPAF
22-14
Converting resources
Only the applicable statistics for a font are listed. This list contains all
possible fields, but not all of these statistics will be relevant for every font:
•
•
•
•
•
•
•
•
•
Kerning
Orientation
Pitch
Line spacing (in dots)
Top of cell to baseline (in dots)
Bottom of cell to baseline (in dots)
Highest character code
Centralized character mapping name
Decentralized character mapping name
The decentralized font name, which includes the plane number, is given
on the first line in the upper left. Other important fields to note are the
‘Highest character code’ field which reflects the largest code point listed
in the decentralized character mapping table. For example, the highest
code point in the DSAMP1 table is 5A. The ‘Centralized Character
Mapping’ field and the ‘Decentralized Character Mapping’ field
correspond to the ‘Centralized Character Mapping Name’ field and the
‘Decentralized Character Mapping Name’ field, respectively, in the
XPAFXFI table.
The statistics for the character that is shown at the bottom of the page are
listed in the upper right under the heading ‘Glyph characteristics.’ These
fields are included:
•
•
•
•
•
•
•
Code point
Bytes per raster
Number of rasters
Escapement
Alignment
Scaling
Kerning
The value listed in the ‘Code point’ field is the centralized code point of
the character shown in the raster sample. However, the character shown
in the raster sample is a decentralized character, which is assigned a
decentralized code point. The code point of the same character in the
centralized and decentralized character mapping tables may or may not
match.
The raster sample shown in figure 22-1 is the lowercase letter ‘a’, which
is character ID LA010000. This character ID is assigned to code point 61
in the centralized character mapping table, and it is assigned to code point
41 and plane 01 in the decentralized character mapping table. Because
code point 41 was specified to be part of the raster sample range, the
lowercase letter ‘a’ is shown in the raster sample area, and the value of
‘61’ is shown in the ‘Code Point’ field in the font statistics section.
Similarly, figure 22-2 shows the lowercase ‘b’ character, which is stored
at code point 62 in the centralized character mapping table and at code
point 42 and plane 01 in the decentralized character mapping table. Note
that regardless of the contents of the decentralized character mapping
table, the space character is always mapped to code point 20. Also, there
can be no decentralized characters stored in code points 00 through 1F.
Each raster sample shown at the bottom of the page is a character that
matches a decentralized code point value that falls in the range entered
in the ‘Lower Range Limit’ and ‘Upper Range Limit’ fields on the XOAF
panel. If a value entered here does not exist in the decentralized character
mapping table, it will not be included in the message dataset. For this
example, code points 40 through 42 were requested. Since there is no
code point 40 in this font’s decentralized character mapping table, there
is no raster sample generated for it.
Section Three: Managing Resources with XPAF
22-15
Converting resources
Decentralized code points table for plane 01
The next item in the message dataset shows the code points that were
converted in the decentralized code points table with their widths. The
decentralized code points table for font RA12BP@1 is shown in figure
22-3.
The code point values are read by starting with a number on the Y-axis
and then reading a number on the X-axis. For example, the entry for code
point 20 is shown in the third row and the first column of the table, and its
width is 17. Code points that were not converted either have no entry or
two dots.
The information at the bottom of the decentralized code points table gives
you all the statistics about the decentralized font that are applicable.
These are the same statistics that are listed in the upper left of each raster
sample page.
Font sample for plane 01
The last item in the message dataset shows the font sample. The font
sample for font RA12BP@1 is shown in figure 22-4. A font sample
consists of a box for each converted code point that contains the
decentralized code point number in the lower left, the font width in the
lower right, and a representation of the actual character in the top of the
box. Note that in this example, the decentralized code point 41 is the
lowercase letter ‘a’ which you saw in the raster sample in figure 22-1.
Dataset contents for plane 02
For plane 02, the raster samples of the specified decentralized code
points, a decentralized code points table, and a font sample are shown in
figures 22-5 through 22-8. These figures contain the same type of
information that was previously described for plane 01. For more
information about how plane numbers are used with decentralized fonts,
refer to “Adjusting your decentralized character mapping tables” earlier in
this chapter.
Section Three: Managing Resources with XPAF
22-16
Converting resources
Figure 22-1. Raster sample for decentralized code point 41, plane 01
Font Characteristics for RA12BP@1
Orientation: PORTRAIT
Pitch: FIXED
Linespacing: 24
Top of Cell to Baseline: 19
Bottom of cell to Baseline: 5
Highest character code: 5A
Centralized character mapping: CSAMP1
Decentralized character mapping: DSAMP1
BC
BL
Glyph characteristics
Code point: 61
Bytes per raster:
Number of rasters
Escapement: 17
Alignment: 5
Scaling: 30
Kerning: 0
2
14
TC
BC = BOTTOM OF CELL
BL = BASELINE
TC = TOP OF CELL
Section Three: Managing Resources with XPAF
22-17
Converting resources
Figure 22-2. Raster sample for decentralized code point 42, plane 01
Font Characteristics for RA12BP@1
Orientation: PORTRAIT
Pitch: FIXED
Linespacing: 24
Top of Cell to Baseline: 19
Bottom of cell to Baseline: 5
Highest character code: 5A
Centralized character mapping: CSAMP1
Decentralized character mapping: DSAMP1
BC
BL
Glyph characteristics
Code point: 62
Bytes per raster:
Number of rasters
Escapement: 17
Alignment: 5
Scaling: 30
Kerning: 0
2
14
TC
BC = BOTTOM OF CELL
BL = BASELINE
TC = TOP OF CELL
Section Three: Managing Resources with XPAF
22-18
Converting resources
Figure 22-3. Decentralized code points table for converted font RA12BP, plane 01
XFC0310I FONT RA12BP@1 CONVERTED WITH 27 CHARACTERS.
Decentralized code points (Widths Table)
-0
-1
-2
-3
-4
-5
-6
-7
-8
-9
012- 17
..
..
..
..
..
.. ..
..
..
3- ..
..
..
..
..
..
.. ..
..
..
4- ..
17
17
17
17
17
17
17
17
17
5- 17
17
17
17
17
17
17
17
17
17
6789ABCDEFFont Characteristics for RA12BP@1
Orientation: PORTRAIT
Pitch: FIXED
Linespacing: 24
Top of Cell to Baseline: 19
Bottom of cell to Baseline: 5
Highest character code: 5A
Input Format: CSAMP1
Output Format: DSAMP1
Section Three: Managing Resources with XPAF
-A
-B
-C
-D
-E
-F
..
..
17
17
..
..
17
..
..
17
..
..
17
..
..
17
..
..
17
22-19
Converting resources
Figure 22-4. Font sample for converted font RA12BP, plane 01
RA12BP@1
20 17
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
41 17
42 17
43 17
44 17
45 17
46 17
47 17
48 17
49 17
4A 17
4B 17
4C 17
4D 17
4E 17
4F 17
p
q
r
s
t
u
v
w
x
y
z
50 17
51 17
52 17
53 17
54 17
55 17
56 17
57 17
58 17
59 17
5A 17
Section Three: Managing Resources with XPAF
22-20
Converting resources
Figure 22-5. Raster sample for decentralized code point 41, plane 02
Font Characteristics for RA12BP@2
Orientation: PORTRAIT
Pitch: FIXED
Linespacing: 24
Top of Cell to Baseline: 19
Bottom of cell to Baseline: 5
Highest character code: 5A
Centralized character mapping: CSAMP1
Decentralized character mapping: DSAMP1
BC
BL
Glyph characteristics
Code point: 41
Bytes per raster:
Number of rasters
Escapement: 17
Alignment: 5
Scaling: 30
Kerning: 0
2
15
TC
BC = BOTTOM OF CELL
BL = BASELINE
TC = TOP OF CELL
Section Three: Managing Resources with XPAF
22-21
Converting resources
Figure 22-6. Raster sample for decentralized code point 42, plane 02
Font Characteristics for RA12BP@2
Orientation: PORTRAIT
Pitch: FIXED
Linespacing: 24
Top of Cell to Baseline: 19
Bottom of cell to Baseline: 5
Highest character code: 5A
Centralized character mapping: CSAMP1
Decentralized character mapping: DSAMP1
BC
BL
Glyph characteristics
Code point: 42
Bytes per raster:
Number of rasters
Escapement: 17
Alignment: 5
Scaling: 30
Kerning: 0
2
14
TC
BC = BOTTOM OF CELL
BL = BASELINE
TC = TOP OF CELL
Section Three: Managing Resources with XPAF
22-22
Converting resources
Figure 22-7. Decentralized code points table for converted font RA12BP, plane 02
XFC0310I FONT RA12BP@2 CONVERTED WITH 27 CHARACTERS.
Decentralized code points (Widths Table)
-0
-1
-2
-3
-4
-5
-6
-7
-8
-9
012- 17
..
..
..
..
..
.. ..
..
..
3- ..
..
..
..
..
..
.. ..
..
..
4- ..
17
17
17
17
17
17
17
17
17
5- 17
17
17
17
17
17
17
17
17
17
6789ABCDEFFont Characteristics for RA12BP@2
Orientation: PORTRAIT
Pitch: FIXED
Linespacing: 24
Top of Cell to Baseline: 19
Bottom of cell to Baseline: 5
Highest character code: 5A
Input Format: CSAMP1
Output Format: DSAMP1
Section Three: Managing Resources with XPAF
-A
-B
-C
-D
-E
-F
..
..
17
17
..
..
17
..
..
17
..
..
17
..
..
17
..
..
17
22-23
Converting resources
Figure 22-8. Font sample for converted font RA12BP, plane 02
RA12BP@2
20 17
A
B
C
D
E
F
G
H
I
J
K
L
M
N
O
41 17
42 17
43 17
44 17
45 17
46 17
47 17
48 17
49 17
4A 17
4B 17
4C 17
4D 17
4E 17
4F 17
P
Q
R
S
T
U
V
W
X
Y
Z
50 17
51 17
52 17
53 17
54 17
55 17
56 17
57 17
58 17
59 17
5A 17
Section Three: Managing Resources with XPAF
22-24
Converting resources
Converting centralized logos to decentralized fonts
To manually convert centralized logos to decentralized fonts, enter 2 on
the Convert Resources menu OPTION line and press ENTER. This panel
appears:
Xerox Output Administrative Facility
Convert Centralized Logos to Decentralized Fonts
COMMAND ===>
INPUT
Dataset Name:
Member Name:
OUTPUT
Dataset Name:
OUTPUT SPECIFICATIONS
Message Listing:
Logo Sample (Y/N):
Complete these fields and press ENTER:
Field
Action
Dataset Name
Enter the name of the PDS, sequential dataset, or native logo library that
contains the centralized logo(s) you want to convert. If you have multiple logos
concatenated in a single file, they must be converted from a sequential dataset
with valid headers. The dataset specifications for a PDS or sequential dataset
are:
INPUT
RECFM=F or FB
LRECL=128
BLKSIZE=A value appropriate for your site
Member Name
•
Enter the 1- to 8-character member name if the logo is stored in a PDS or
native library. The logo name must be unique and must not match a
decentralized font name.
•
Enter an asterisk ( * ) to load all logos in the PDS or native library.
•
Leave this field blank if the logo is stored in a sequential dataset.
Section Three: Managing Resources with XPAF
22-25
Converting resources
Field
Action
Dataset Name
Enter the name of the native decentralized font library where the converted
logos will be stored. In the XOSF start-up proc, this is the dataset name in the
DD statement specified for the decentralized font library by the DFONTLIB
initialization parameter or the FONTLIB printer profile parameter.
OUTPUT
The name of the converted font is constructed from the name in the logo header
record.
OUTPUT
SPECIFICATIONS
Message Listing
Enter the name of the sequential dataset to which you want conversion-related
messages to be written. The recommended dataset specifications are:
RECFM=FB
LRECL=133
BLKSIZE=A value appropriate for your site
The dataset contents are in XES format and can be sent to a decentralized
printer with duplexing capability (for example, the 4213 printer). Do not specify
the XOAF log dataset. Refer to Section Six: XPAF Messages for an explanation
of logo conversion messages and any required user action.
The message dataset contains a code point table for each logo you convert.
This table is similar to the sample shown in figure 22-9.
Logo Sample
Indicate whether you want XPAF to generate a sample of the converted logo
and store that sample in the message dataset identified in the ‘Message Listing’
field.
Valid values:
Y
Generates a sample of the converted logo and stores it in the dataset
identified in the ‘Message Dataset Name’ field.
N
Does not generate a sample in the message listing dataset.
Default: N
TSO/Batch command
You can use this TSO/batch command as an alternative to using the
Convert Centralized Logos to Decentralized Fonts option:


CON VERT LOG O('input-dataset-name[(  member-name  )]')
*


 Y 
[TO]('output-dataset-name') SAM PLE( 
 ) [LIS T('list-dataset-name')]
 N 
NOTE: If SAMPLE is set to Y, LIST is required.
Section Three: Managing Resources with XPAF
22-26
Converting resources
Sample logo code points table
Figure 22-9 shows a sample code points table. The code points table
indicates the available decentralized code points for the centralized logo
you converted. The bottom of the code point table provides additional
information about the logo, including:
•
•
•
•
Orientation
Logo height and width
Highest character code used
Coding sequence for first and second lines
Figure 22-9. Sample logo code points table
Processing begins for logo 1; EAGLE
XLC0321I LOGO EAGLE CONVERTED WITH 7 CHARACTERS.
Decentralized code points (Widths Table)
-0
-1
-2
-3
-4
-5
-6
-7
-8
012- 100
..
..
..
..
..
..
..
..
3- ..
..
..
..
..
..
..
..
..
4- .. 100 100 100 100 100 100
..
56789ABCDEFLogo Characteristics
Orientation: PORTRAIT
Logo Height: 184
Logo Width: 285
Highest character code: 47
Coding Sequence for 1st line: ABC
Sequence for 2nd line: DEF
Note: The origin must be set before each line.
Section Three: Managing Resources with XPAF
-9
-A
-B
-C
-D
-E
-F
..
..
..
..
..
..
..
..
..
..
..
..
..
..
22-27
Converting resources
Converting Xerox fonts to IBM format
Before using this option to convert a Xerox font to a format that is
recognized by DCF/SCRIPT, you must ensure that you have entered a
code page name for the font in the XPAFXFI table. If a code page name
is not specified, the conversion will fail and a series of messages will be
displayed indicating that a member was not found.
To ensure that the XPAFXFI table contains the necessary entries,
complete these steps:
Step 1.
Use the Maintain the Xerox Font Information (XPAFXFI) Table option on
the Maintain Font Tables menu to enter a valid code page name for the
font(s).
Step 2.
Reconvert the Xerox font to IBM format using either the Convert Xerox
Fonts to IBM Format option or the CONVERT FONT TSO/batch
command.
Using this option
To convert Xerox fonts to IBM format, enter 3 on the Convert Resources
menu OPTION line and press ENTER. This panel appears:
Xerox Output Administrative Facility
Convert Xerox Fonts to IBM Format
COMMAND ===>
INPUT
Dataset Name:
Logical Font Name:
OUTPUT
Dataset Name:
Complete these fields and press ENTER:
NOTE: This conversion requires a region of at least eight megabytes
to run successfully.
Section Three: Managing Resources with XPAF
22-28
Converting resources
Field
INPUT
Dataset Name
Action
Enter the name of the PDS or native centralized library in which the font is
stored. The dataset specifications for a PDS are:
RECFM=F or FB
LRECL=128
BLKSIZE=A value appropriate for your site
Logical Font Name
OUTPUT
Dataset Name
•
Enter the 1- to 6-character name of the Xerox centralized font that you
want to use in a DCF document. The name must match the logical font
name in the XPAFXFI table.
•
Enter an asterisk ( * ) to convert all fonts in the PDS or native centralized
library.
Enter the name of the PDS set up to store the IBM-format fonts to be referenced
by DCF/SCRIPT. The dataset specifications are:
RECFM=VBM
LRECL=8205 or greater
BLKSIZE=A value equal to the LRECL value plus 4
The name of the font in the output dataset is constructed from the name in the
font header record of the font in the input dataset.
TSO/Batch command
You can use this TSO/batch command as an alternative to using the
Convert Xerox Fonts to IBM Format option:


CON VERT FON T('input-dataset-name(  member-name  )')
*


[TO]('output-dataset-name')
Section Three: Managing Resources with XPAF
22-29
Converting resources
Making a new Xerox font available to DCF/SCRIPT
Follow this procedure to make a new Xerox font available to
DCF/SCRIPT:
NOTE: You do not need to run this procedure for the set of replica
fonts distributed with XPAF. XPAF provides the converted version of
these fonts in the AFPFONTS dataset.
Step 1.
Offload your existing font tables so that you have a backup. Refer to
chapter 27, “Managing XPAF libraries,” for instructions about how to
offload resources.
Step 2.
Upload the centralized font to a PDS or sequential dataset on the host.
Refer to Section Two: Installing and Customizing XPAF for instructions
about how to upload resources.
Step 3.
Load the font from the PDS or sequential dataset to the centralized font
library using either the Load Centralized Fonts option on the Load
Resources menu or the LOAD FONT TSO/batch command. The system
automatically generates entries to the XPAFXFI table. Refer to chapter
21, “Loading resources to a native library,” for more information about
using this option.
Step 4.
If necessary, create an entry for the font in the XPAFFFI table, using the
Maintain the Font Family Information (XPAFFFI) Table option on the
Maintain Font Tables menu. Refer to chapter 24, “Managing XPAF
tables,” for more information about using this option.
Step 5.
Update the XPAFXFI table with the character mapping and code page
information for the font, using the Maintain the Xerox Font Information
(XPAFXFI) Table option on the Maintain Font Tables menu. Refer to
chapter 24, “Managing XPAF tables,” for more information about using
this option.
To reference the font by an alias, enter the alias name as the logical font
name. This is the name by which the font is known to DCF.
Step 6.
Convert the Xerox font using either the Convert Xerox Font to IBM Format
option on the Convert Resources menu or the CONVERT FONT
TSO/batch command. This conversion creates an IBM look-alike version
of the font that DCF recognizes. If you use an IBM code page with this
font, the code page must reside in the same library in which the converted
font is stored.
Step 7.
Create a DCF index with the new font by executing the JCL provided with
DCF.
Section Three: Managing Resources with XPAF
22-30
Converting resources
Associating a Xerox font with a code page
A Xerox font can use either a Xerox code page or an IBM code page. If
you use an IBM code page, ensure that the Xerox font supports the
characters defined in the code page.
If you change the code page used by a Xerox font, you must make the new
code page information available to DCF/SCRIPT. To do this, perform
these steps:
Step 1.
Update the XPAFXFI table with the character mapping and code page
information for the font, using the Maintain the Xerox Font Information
(XPAFXFI) Table option on the Maintain Font Tables menu. Refer to
chapter 24, “Managing XPAF tables,” for more information about using
this option.
To reference the font by an alias, enter the alias name as the logical font
name. This is the name by which the font is known to DCF.
Step 2.
Convert the Xerox font using either the Convert Xerox Font to IBM Format
option on the Convert Resources menu or the CONVERT FONT
TSO/batch command. This conversion creates an IBM look-alike version
of the font that DCF recognizes. If you use an IBM code page with this
font, the code page must reside in the same library in which the converted
font is stored.
Section Three: Managing Resources with XPAF
22-31
Converting resources
Converting IBM AFP page segments to Xerox .IMG and/or
RES format
This option can be used to convert all the AFP page segments in a PDS
to .IMG and/or RES .IMG format and load the resulting images to a native
image library. The option converts AFP page segments from their original
resolution to images in either Xerox .IMG or Xerox RES .IMG format. The
conversion method is specified by the ‘Conversion Type’ field. By using
this option to preconvert page segments to images instead of letting XPAF
perform the conversion dynamically at print time, you will save processing
time when you print the images for the first time.
NOTE: The utility, XRFBATCH, also can be used to perform this
function. Refer to Chapter 30, “XRFBATCH utility” for more
information about XRFBATCH.
You can include IOCA-encoded images in your page segment library.
However, these images will be converted only into .IMG format. They
cannot be converted to RES .IMG format.
There is no revision support in XOAF. After you convert a page segment
using this option, it will not be reconverted if you change it. To use a
revised version of a page segment, you must perform either of these
actions:
•
Delete the converted version from the native image library and rerun
this option.
•
Revise the page segment via XOSF by specifying the REVPSEG
extended JCL keyword when you print the document. Refer to
Section Five: XPAF Parameter and Keyword Reference for
information about the REVPSEG extended JCL keyword.
Section Three: Managing Resources with XPAF
22-32
Converting resources
Using this option
To convert IBM AFP page segments to .IMG and/or RES .IMG format,
enter 4 on the Convert Resources menu OPTION line and press ENTER.
This panel appears:
Xerox Output Administrative Facility
Convert IBM AFP Page Segments to Xerox .IMG and/or RES Format
COMMAND ===>
INPUT
Dataset Name:
OUTPUT
Dataset Name:
SPECIFICATIONS
Message Dataset Name:
Destination Printer (C/D):
Maximum Images (1 to 999):
Conversion Type (0/1/3):
Orientation (P/L/I/J):
Print Environment (M/C/B):
C
16
1
P
M
NOTE: Additional keywords not covered by this panel display may be
entered when the Edit JCL option is presented. At that point enter E
to see Appendix E for additional keywords.
Complete these fields and press ENTER:
Section Three: Managing Resources with XPAF
22-33
Converting resources
Field
INPUT
Dataset Name
Action
Enter the name of the PDS that contains the IBM page segments that you want
to convert to Xerox images. The recommended dataset specifications are:
RECFM=VBM or VBA
LRECL=A value greater than or equal to the length of the longest record
within a resource contained in the library
BLKSIZE=A value equal to the LRECL value plus 4
All page segments in the named library will be converted to 300-dpi Xerox
images with scaling based on the value you specify in the ‘Conversion Type’
field.
NOTE: XPAF does not convert page segments that have names which start
with the letter O.
OUTPUT
Dataset Name
SPECIFICATIONS
Message Dataset
Name
Enter the name of the native centralized or decentralized image library that has
been allocated and formatted to contain images. In the XOSF start-up proc, this
is the dataset name in the DD statement specified by the CIMAGELIB or
DIMAGELIB initialization parameter or by the IMAGELIB printer profile
parameter.
Enter the name of the dataset to be used for logging messages. You can specify
the XOAF log dataset, or enter the name of a sequential dataset with these
specifications:
RECFM=VB
LRECL=256
BLKSIZE=4096
If you leave this field blank, you may specify a message dataset name in the
XPAFXLOG DD statement in the generated JCL. The dataset name defaults to
XPAFXLOG, preceded by the prefix you specified for the XPAF load library. If
you specify a message dataset in this field, it will override the dataset name
specified in the XPAFXLOG DD statement.
If you do not want to log XPAF messages, edit the generated JCL and specify
DD DUMMY for XPAFXLOG.
Destination
Printer
Specify whether the page segments should be converted to images in
centralized or decentralized format.
Valid values:
C
D
Specifies that your destination printer is a centralized printer.
Specifies that your destination printer is a decentralized printer.
Default: C
Maximum Images
Enter the maximum number of images within a single page segment in the
library that is to be converted.
Valid values: 1 through 999.
Default: 16
Section Three: Managing Resources with XPAF
22-34
Converting resources
Field
Conversion Type
Action
Specify the image resolution conversion type.
Valid values:
0
Does not scale the image dimension but does scale the position of the
image. Image position scaling allows the image to print in the correct
relative location on the page when printed on a Xerox printer as
opposed to printing on an IBM printer. Image position scaling is
increased by a factor of 25%.
1
Scales the image dimension and image position of an AFP image to
300 dpi before sending it to the printer. IOCA-encoded images are
scaled from any resolution to 300 dpi. All other AFP images are scaled
from 240-to-300 dpi, an increase of 25%.
3
Scales the image dimension and image position of an AFP image to
300 dpi based on the current L-units value specified in the IDD or IID
structured field of the image. IOCA-encoded images are scaled from
any resolution to 300 dpi. For IM-type images, any L-units value that
does not specify 300 dpi is assumed to be 240 dpi.
Default: 1
NOTE: If you specify 0, the size of the converted image will print smaller in
XPAF (by a factor of 20%) than the original 240 dpi image printed in AFP.
Section Three: Managing Resources with XPAF
22-35
Converting resources
Field
Orientation
Action
Specify the hardware orientation for the page.
Valid values:
P
Portrait. Use P if PMODE=PORT and the image will be printed on a
simplex or duplex page or on the front of a tumble duplex page.
L
Landscape. Use L if PMODE=LAND or the printer uses short-edge
feed and the image will be printed on a simplex or duplex page or on
the front of a tumble duplex page.
I
Inverse portrait. Use I if PMODE=PORT and the image will be printed
on the back of a tumble duplex page.
J
Inverse landscape. Use J if PMODE=LAND or the printer uses
short-edge feed and the image will be printed on the back of a tumble
duplex page.
Default: P
NOTE: AFP images that were generated for IBM printers are rotated 0
degrees. For these images, regardless of document orientation, be sure to
specify a rotation of P.
Print Environment
Identify the type of centralized printers you use to print AFP data streams
through XPAF. This field is used to determine how XPAF converts images
colorized via the IID structured field for printing on a centralized printer.
This field only applies to AFP data streams containing images colorized via the
IID structured field that will be sent to centralized printers.
Valid values:
M
Specifies that XPAF jobs are printed only on monochrome printers.
XPAF converts any colorized images to monochrome black .IMG files.
C
Specifies that XPAF jobs are printed only on highlight color printers.
XPAF converts any colorized images to color RES .IMG files.
B
Specifies that XPAF jobs are printed on both monochrome and
highlight color printers. XPAF converts any colorized images to both
monochrome black .IMG and color RES .IMG files.
Default: M
Section Three: Managing Resources with XPAF
22-36
Converting resources
After you enter all necessary field values and press ENTER, a panel
similar to this appears:
Xerox Output Administrative Facility
Convert IBM AFP Page Segments to Xerox .IMG and/or RES Format
COMMAND ===>
DATASET PREFIX
XPFLOAD Library:
JOB CARD INFORMATION
===> //JOBNAME JOB (ACCOUNT),'NAME',CLASS=A
===> //*
===> //*
===> //*
Complete these fields and press ENTER:
Field
DATASET PREFIX
Action
Enter the high-level and mid-level qualifiers for your system load library.
XPFLOAD Library
JOB CARD
INFORMATION
Enter site-specific job card information.
Section Three: Managing Resources with XPAF
22-37
Converting resources
After you verify the information and press ENTER, this panel appears:
Xerox Output Administrative Facility
Convert IBM AFP Page Segments to Xerox .IMG and/or RES Format
OPTION ===>
C.
Cancel JCL
E.
Edit JCL
K.
Keep JCL
S.
Submit JCL
On this panel, select the option you want to use and press ENTER. Valid
values are:
C
Cancels the generated JCL and returns to the initial Convert IBM
Page Segments to Xerox .IMG Format panel.
E
Displays the generated JCL for editing purposes.
K
Keeps the generated JCL in a sequential dataset. After you save
the JCL, you can access this dataset and submit the job without
regenerating the JCL each time.
S
Submits the JCL. Standard TSO/ISPF JCL submission error or
confirmation messages are displayed.
NOTE: You cannot use the END command or the PF3 key to exit this
panel. If you want to return to the previous panel and do not want to
display, submit or keep the JCL, you must enter C on the COMMAND
line and press ENTER.
Section Three: Managing Resources with XPAF
22-38
Converting resources
Editing the JCL
If you enter E in the OPTION line on the JCL options panel, a panel
containing JCL similar to this appears:
//job-name JOB job-information
//*
//*
//*
//**********************************************************************/
//*
*/
//*
DESCRIPTION: CONVERT PAGE SEGMENTS TO .IMG/RES FORMAT - XOAJ0260.*/
//*
*/
//**********************************************************************/
//XRFBATCH EXEC PGM=XRFBATCH,COND=(0,NE),
//
PARM=('DESTPRTR=destination-printer',
//
'MAXIMGPS=nnn',
//
'CONVTYPE=conversion-type',
//
'ROTATION=rotation',
//
'PRINTENV=printer-environment')
//STEPLIB
DD DSN=prefix.XPFLOAD,DISP=SHR
//INFILE
DD DSN=input-dataset-name,DISP=SHR
//IMAGELIB
DD DSN=output-dataset-name,DISP=SHR
//XPAFXLOG
DD DSN=prefix.XPAFXLOG,DISP=OLD
//
You can edit and save the JCL and cancel or submit the job using
standard TSO/ISPF commands.
Section Three: Managing Resources with XPAF
22-39
Converting resources
Keeping the JCL
If you enter K in the OPTION line on the JCL options panel, this panel
appears:
Xerox Output Administrative Facility
Convert IBM AFP Page Segments to Xerox .IMG and/or RES Format
COMMAND ===>
* To keep the JCL, enter a new sequential dataset name.
Dataset Name:
Complete this field and press ENTER:
Field
Dataset Name
Action
Enter the name of the sequential dataset that is not currently cataloged. This is
the dataset in which your JCL will be stored.
To return to the previous panel, enter END and press ENTER.
Section Three: Managing Resources with XPAF
22-40
Managing resource lists
23.
23
Managing resource lists
This chapter describes how to use the options available on the Manage
Resource Lists menu to maintain printer-resident font, form, image, and
logo lists. XOSF uses the lists to determine whether a requested resource
must be downloaded. For more information about XPAF list processing,
refer to “Printer-resident resource lists” in chapter 19, “XPAF resources.”
Managing resident font lists
To create, delete, or update resident font lists, enter 1 on the Manage
Resource Lists menu OPTION line and press ENTER. This panel
appears:
Xerox Output Administrative Facility
Manage Resident Font Lists
COMMAND ===>
* On COMMAND line, enter 'C' to create, 'D' to delete, or 'U' to update a list.
Dataset Name:
List Name:
On the COMMAND line, specify the function you want to perform. Valid
values are:
C
D
U
Create a new list.
Delete an existing list.
Update an existing list.
Section Three: Managing Resources with XPAF
23-1
Managing resource lists
Then complete these fields and press ENTER:
Field
Action
Dataset Name
Enter the name of the native library that contains all the resident resource lists.
In the XOSF start-up proc, this is the dataset name in the DD statement
specified by the LIBRARY printer profile parameter.
List Name
Enter the name of the font list to be created or updated. The name can be one
of the following:
•
A 1- to 20-character name that matches the name assigned to the
FONTLIST printer profile parameter
•
FONTcuu for an existing list that was generated by XOSF for a
channel-attached centralized printer
•
FONTslu for an existing list that was generated by XOSF for a
remotely-attached centralized printer or a decentralized printer
NOTE: Font list names are case-sensitive. When deleting or updating a list,
type the name exactly as it was entered originally (uppercase/lowercase
letters).
Creating a resident font list
If you enter C on the COMMAND line of the Manage Resident Font Lists
panel, a panel similar to this appears:
Xerox Output Administrative Facility
Creating List - FONTPRT1
COMMAND ===>
NAME
1.
3.
5.
7.
9.
11.
13.
15.
17.
19.
21.
23.
25.
PERMANENT?
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
NAME
2.
4.
6.
8.
10.
12.
14.
16.
18.
20.
22.
24.
26.
PERMANENT?
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Element Count = 0
Section Three: Managing Resources with XPAF
23-2
Managing resource lists
In the sample panel, a resident font list named FONTPRT1 is being
created.
The numbers provided on the panel are for convenience. Use these
conventions when entering font names:
•
•
Enter one or more font names and press ENTER:
—
Enter a 1- to 20-character, case-sensitive font name in the
‘NAME’ field.
—
Enter N in the ‘PERMANENT?’ field if the font is not a cartridge
or resident font. Otherwise, leave Y in the ‘PERMANENT?’ field.
—
You can enter font names in any order on the panel. Although
the panel displays 26 fields for entering fonts, you can enter
more than 26 font names. Each time you press ENTER, XPAF
processes the fonts and clears the panel. You may then enter
additional font names.
—
When you press ENTER, ‘Element Count’ displays the number
of fonts added to the list during this session. This is a
display-only field.
—
Enter END on the COMMAND line and press ENTER to save the
list and return to the preceding option panel.
Enter CANCEL or ABORT on the COMMAND line and press ENTER
to end the session without creating the list.
Before you modify a list, you must stop all printers using that list. When
you restart the printer, XPAF activates the new list.
TSO/Batch command
You can use this TSO/batch command as an alternative to using the
Manage Resident Font Lists option to create a new font list:
TAB LE LOA D('list-dataset-name(list-name)')
FRO M('input-dataset-name[(member-name)]') TYP E(FNTL)
The format of the records within the dataset must be fixed-length records
that are 21 bytes long. The first 20 bytes of each record is the font name.
The last byte (Y or N) indicates whether the font is permanent.
Section Three: Managing Resources with XPAF
23-3
Managing resource lists
Deleting a resident font list
Enter D on the COMMAND line of the Manage Resident Font Lists panel,
and enter the name of the library in which the list resides and the list
name. Then press ENTER.
XOAF displays a message indicating whether the list was deleted
successfully.
TSO/Batch command
You can use this TSO/batch command as an alternative to using the
Manage Resident Font Lists option to delete a font list:
TAB LE DEL ETE('list-dataset-name(list-name)')
Updating a resident font list
If you enter U on the COMMAND line of the Manage Resident Font Lists
panel, a panel similar to this appears:
Xerox Output Administrative Facility
Update a Resident Font List
COMMAND ===>
* On COMMAND line, enter 'A' to add an entry.
* Next to name, enter 'D' to delete an entry.
NAME
UN107A
UN107B
PR111A
PERMANENT?
N
N
N
NAME
UN104A
UN107C
L01BOA
PERMANENT?
N
N
N
Under the ‘NAME’ headings, XOAF displays the names of the fonts that
have been entered in the list. A Y in the ‘PERMANENT?’ field indicates
that the font is permanent. In the sample panel, the list being updated
already contains the font names UN107A, UN104A, UN107B, UN107C,
PR111A, and L01BOA.
Section Three: Managing Resources with XPAF
23-4
Managing resource lists
TSO/Batch command
You can use this TSO/batch command as an alternative to using the
Manage Resident Font Lists option to update a font list:
TAB LE UPDATE('list-dataset-name(list-name)') TYPE(FNTL)
ADD
FUN CTION(
 DEL ETE

) NAM E(font-name)[(P)]

Use the (P) option after font-name to indicate that the font being added is
a permanent font, either printer-resident or cartridge.
Adding a new font to the list
Enter A on the COMMAND line and press ENTER. A panel similar to this
appears:
Xerox Output Administrative Facility
Updating List - FONTPRT1
COMMAND ===>
NAME
1.
3.
5.
7.
9.
11.
13.
15.
17.
19.
21.
23.
25.
PERMANENT?
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
NAME
2.
4.
6.
8.
10.
12.
14.
16.
18.
20.
22.
24.
26.
PERMANENT?
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
In the sample panel, the resident font list named FONTPRT1 is being
updated.
Section Three: Managing Resources with XPAF
23-5
Managing resource lists
The numbers provided on the panel are for convenience. Use these
conventions when entering font names:
•
•
Enter one or more font names and press ENTER:
—
Enter a 1- to 20-character, case-sensitive font name in the
‘NAME’ field.
—
Enter N in the ‘PERMANENT?’ field if the font is not a cartridge
or resident font. Otherwise, leave Y in the ‘PERMANENT?’ field.
—
You can enter font names in any order on the panel. Although
the panel displays 26 fields for entering fonts, you can enter
more than 26 font names. Each time you press ENTER, XPAF
processes the fonts and clears the panel. You may then enter
additional font names.
After you add all your new fonts to the list, press ENTER. The
system returns to the Update a Resident Font List panel and
displays
* ADDED *
to the right of each new font added to the list. To add more fonts to
the font list, enter A on the COMMAND line and repeat this procedure.
Deleting a font from the list
Tab to the font name and enter D to the left of each font name you want
to delete. Press ENTER. The system deletes the font from the list and
displays
*DELETED*
to the right of the font name deleted from the list.
Section Three: Managing Resources with XPAF
23-6
Managing resource lists
Managing a PCL font list
Each printer profile can contain a PCL font list (a PDS member contained
in the XINPARM dataset). The printer profile parameter, FONTLIST=,
points to the PDS member name.
PDS member names are entered in the following manner:
FONTLIST=membername
where
membername
The PDS member name.
Within the PDS member, the PCL fonts are listed as:
fontname 0
or
fontname nnn
where
fontname 0
Indicates a named font on the printer.
fontname nnn
Indicates a permanent soft font identified by a unique
3-digit number.
The following list is an example of a PCL font list.
L0112B 0
P0612B 0
XGT50L 700
XGT50P 701
In the example above, the first two fonts, L0112B and P0612B, already
exist on the printer’s hard drive and will be invoked by name within the
XPAF generated PCL data stream. They will not be downloaded by XPAF.
Fonts XGT50L and XGT50P are permanent soft fonts and are only
downloaded after the XPAF printer is started. These fonts are
downloaded with he first job to reference them. Subsequent jobs will
invoke the fonts with the 3-digit font identification number assigned in the
FONTLIST member (700, or 701 in the sample above).
NOTE: For XPAF to use named fonts, they must be based on XPAF
generated 2700 type fonts. This is required to correctly calculate
page positioning. The PCL transform calculates positioning within a
page on font metrics, therefore, XPAF must use the same font as
loaded on the printer.
A sample REXX procedure, FONTEXTR, is included in SAMPLIB.
FONTEXTR extracts and formats a font suitable for downloading.
Section Three: Managing Resources with XPAF
23-7
Managing resource lists
Keeping permanent soft fonts in printer memory
As long as the printer remains powered on, permanent soft fonts will
remain in the printer’s memory and XPAF does not have to download
them for each job. In the event that the XPAF printer is powered off, the
XPAF printer must be drained and restarted. Draining and restarting the
XPAF printer will reload the fonts into the printer’s memory when they are
first referenced in a document, and will maintain your data integrity.
Managing resident form lists
To create, delete, or update resident forms lists, enter 2 on the Manage
Resource Lists menu OPTION line and press ENTER. This panel
appears:
Xerox Output Administrative Facility
Manage Resident Form Lists
COMMAND ===>
* On COMMAND line, enter 'C' to create, 'D' to delete, or 'U' to update a list.
Dataset Name:
List Name:
On the COMMAND line, specify the function you want to perform. Valid
values are:
C
D
U
Create a new list.
Delete an existing list.
Update an existing list.
Section Three: Managing Resources with XPAF
23-8
Managing resource lists
Then complete these fields and press ENTER:
Field
Action
Dataset Name
Enter the name of the native library that contains all the resident resource lists.
In the XOSF start-up proc, this is the dataset name in the DD statement
specified by the LIBRARY printer profile parameter.
List Name
Enter the name of the form list to be created or updated. The name can be one
of the following:
•
A 1- to 20-character name that matches the name assigned to the
FORMLIST printer profile parameter
•
FORMcuu for an existing list that was generated by XOSF for a
channel-attached centralized printer
•
FORMslu for an existing list that was generated by XOSF for a
remotely-attached centralized printer or a decentralized printer
NOTE: Form list names are case-sensitive. When deleting or updating a
list, type the name exactly as it was entered originally (uppercase/
lowercase letters).
Creating a resident form list
If you enter C on the COMMAND line of the Manage Resident Form Lists
panel, a panel similar to this appears:
Xerox Output Administrative Facility
Creating List - FORMPRT1
COMMAND ===>
NAME
1.
3.
5.
7.
9.
11.
13.
15.
17.
19.
21.
23.
25.
PERMANENT?
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
NAME
2.
4.
6.
8.
10.
12.
14.
16.
18.
20.
22.
24.
26.
PERMANENT?
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Element Count = 0
Section Three: Managing Resources with XPAF
23-9
Managing resource lists
In the sample panel, a resident form list named FORMPRT1 is being
created.
The numbers provided on the panel are for convenience. Use these
conventions when entering form names:
•
Enter one or more form names and press ENTER:
—
Enter a 1- to 6-character, case-sensitive form name in the
‘NAME’ field.
—
Enter N in the ‘PERMANENT?’ field if the form is not a cartridge
or resident form. Otherwise, leave Y in the ‘PERMANENT?’
field.
—
You can enter form names in any order on the panel. Although
the panel displays 26 fields for entering forms, you can enter
more than 26 form names. Each time you press ENTER, XPAF
processes the forms and clears the panel. You may then enter
additional form names.
—
When you press ENTER, ‘Element Count’ displays the number
of forms added to the list during this session. This is a
display-only field.
•
Enter END on the COMMAND line and press ENTER to save the list
and return to the preceding option panel.
•
Enter CANCEL or ABORT on the COMMAND line and press ENTER
to end the session without creating the list.
Before you modify a list, you must stop all printers using that list. When
you restart the printer, XPAF activates the new list.
TSO/Batch command
You can use this TSO/batch command as an alternative to using the
Manage Resident Form Lists option to create a new form list:
TAB LE LOA D('list-dataset-name(list-name)')
FRO M('input-dataset-name[(member-name)]') TYP E(FRML)
The format of the records within the dataset must be fixed-length records
that are 7 bytes long. The first 6 bytes of each record is the form name.
The last byte (Y or N) indicates whether the form is permanent.
Section Three: Managing Resources with XPAF
23-10
Managing resource lists
Deleting a resident form list
Enter D on the COMMAND line of the Manage Resident Form Lists panel,
and enter the name of the library in which the list resides and the list
name. Then press ENTER.
XOAF displays a message indicating whether the list was deleted
successfully.
TSO/Batch command
You can use this TSO/batch command as an alternative to using the
Manage Resident Form Lists option to delete a form list:
TAB LE DEL ETE('list-dataset-name(list-name)')
Updating a resident form list
If you enter U on the COMMAND line of the Manage Resident Form Lists
panel, a panel similar to this appears:
Xerox Output Administrative Facility
Update a Resident Form List
COMMAND ===>
* On COMMAND line, enter 'A' to add an entry.
* Next to name, enter 'D' to delete an entry.
NAME
ORDER
MEDICAL
DENTAL
PERMANENT?
N
N
N
NAME
SUPPLY
ADDRESS
PERMANENT?
N
N
Under the ‘NAME’ headings, XOAF displays the names of the forms that
have been entered in the list. A Y in the ‘PERMANENT?’ field indicates
that the form is permanent. In the sample panel, the list being updated
already contains the form names ORDER, SUPPLY, MEDICAL,
ADDRESS, and DENTAL.
Section Three: Managing Resources with XPAF
23-11
Managing resource lists
TSO/Batch command
You can use this TSO/batch command as an alternative to using the
Manage Resident Form Lists option to update a form list:
TAB LE UPDATE('list-dataset-name(list-name)') TYP E(FRML)
ADD
 DEL ETE
FUN CTION(

) NAM E(form-name)[(P)]

Use the (P) option after form-name to indicate that the form being added
is a permanent form, either printer-resident or cartridge.
Adding a new form to the list
Enter A on the COMMAND line and press ENTER. A panel similar to this
appears:
Xerox Output Administrative Facility
Updating List - FORMPRT1
COMMAND ===>
NAME
1.
3.
5.
7.
9.
11.
13.
15.
17.
19.
21.
23.
25.
PERMANENT?
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
NAME
2.
4.
6.
8.
10.
12.
14.
16.
18.
20.
22.
24.
26.
PERMANENT?
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
In the sample panel, the resident form list named FORMPRT1 is being
updated.
Section Three: Managing Resources with XPAF
23-12
Managing resource lists
The numbers provided are for convenience. Use these conventions when
entering form names:
•
•
Enter one or more form names and press ENTER:
—
Enter a 1- to 6-character, case-sensitive form name in the
‘NAME’ field.
—
Enter N in the ‘PERMANENT?’ field if the form is not a cartridge
or resident form. Otherwise, leave Y in the ‘PERMANENT?’
field.
—
You can enter form names in any order on the panel. Although
the panel displays 26 fields for entering forms, you can enter
more than 26 form names. Each time you press ENTER, XPAF
processes the forms and clears the panel. You may then enter
additional form names.
After you add the first group of form names, press ENTER. The
system returns to the Update a Resident Form List panel and
displays
* ADDED *
to the right of each new form added to the list. To add more forms to
the form list, enter A on the COMMAND line and repeat this
procedure.
Deleting a form from the list
Tab to the form name and enter D to the left of each form name you want
to delete. Press ENTER. The system deletes the form from the list and
displays
*DELETED*
to the right of the form deleted from the list.
Section Three: Managing Resources with XPAF
23-13
Managing resource lists
Managing resident image lists
To create, delete, or update resident image lists, enter 3 at the Manage
Resource Lists menu OPTION line and press ENTER. This panel
appears:
Xerox Output Administrative Facility
Manage Resident Image Lists
COMMAND ===>
* On COMMAND line, enter 'C' to create, 'D' to delete, or 'U' to update a list.
Dataset Name:
List Name:
On the COMMAND line, specify the function you want to perform. Valid
values are:
C
D
U
Create a new list.
Delete an existing list.
Update an existing list.
Then complete these fields and press ENTER:
Field
Action
Dataset Name
Enter the name of the native library that contains all the resident resource lists.
In the XOSF start-up proc, this is the dataset name in the DD statement
specified by the LIBRARY printer profile parameter.
List Name
Enter the name of the image list to be created or updated. The name can be
one of the following:
•
A 1- to 20-character name that matches the name assigned to the
IMAGELIST printer profile parameter
•
IMAGcuu for an existing list that was generated by XOSF for a
channel-attached centralized printer
•
IMAGslu for an existing list that was generated by XOSF for a
remotely-attached centralized printer or a decentralized printer
NOTE: Image list names are case-sensitive. When deleting or updating a
list, type the name exactly as it was entered originally
(uppercase/lowercase letters).
Section Three: Managing Resources with XPAF
23-14
Managing resource lists
Creating a resident image list
If you enter C on the COMMAND line of the Manage Resident Image Lists
panel, a panel similar to this appears:
Xerox Output Administrative Facility
Creating List - IMAGPRT1
COMMAND ===>
NAME
PERMANENT?
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
1.
3.
5.
7.
9.
11.
13.
15.
17.
19.
21.
23.
25.
NAME
2.
4.
6.
8.
10.
12.
14.
16.
18.
20.
22.
24.
26.
PERMANENT?
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Element Count = 0
In the sample panel, a resident image list named IMAGPRT1 is being
created.
•
Enter one or more image names and press ENTER:
—
Enter a 1- to 6-character, case-sensitive image name in the
‘NAME’ field.
—
Enter N in the ‘PERMANENT?’ field if the image is not a
cartridge or resident image. Otherwise, leave Y in the
‘PERMANENT?’ field.
—
You can enter image names in any order on the panel. Although
the panel displays 26 fields for entering images, you can enter
more than 26 image names. Each time you press ENTER, XPAF
processes the images and clears the panel. You may then enter
additional image names.
—
When you press ENTER, ‘Element Count’ displays the number
of images added to the list during this session. This is a
display-only field.
•
Enter END on the COMMAND line and press ENTER to save the list
and return to the preceding option panel.
•
Enter CANCEL or ABORT on the COMMAND line and press ENTER
to end the session without creating the list.
Before you modify a list, you must stop all printers using that list. When
you restart the printer, XPAF activates the new list.
Section Three: Managing Resources with XPAF
23-15
Managing resource lists
TSO/Batch command
You can use this TSO/batch command as an alternative to using the
Manage Resident Image Lists option to create a new image list:
TAB LE LOA D('list-dataset-name(list-name)')
FRO M('input-dataset-name[(member-name)]') TYP E(IMGL)
The format of the records within the dataset must be fixed-length records
that are 7 bytes long. The first 6 bytes of each record is the image name.
The last byte (Y or N) indicates whether the image is permanent.
Deleting a resident image list
Enter D on the COMMAND line of the Manage Resident Images List
panel, and enter the name of the library in which the list resides and the
list name. Then press ENTER.
XOAF displays a message indicating whether the list was deleted
successfully.
TSO/Batch command
You can use this TSO/batch command as an alternative to using the
Manage Resident Image Lists option to delete an image list:
TAB LE DEL ETE('list-dataset-name(list-name)')
Section Three: Managing Resources with XPAF
23-16
Managing resource lists
Updating a resident image list
If you enter U on the COMMAND line of the Manage Resident Images
Lists panel, a panel similar to this appears:
Xerox Output Administrative Facility
Update a Resident Image List
COMMAND ===>
* On COMMAND line, enter 'A' to add an entry.
* Next to name, enter 'D' to delete an entry.
NAME
PLANE
TRAIN
BIKE
PERMANENT?
N
N
N
NAME
CAR
BOAT
PERMANENT?
N
N
Under the ‘NAME’ headings, XOAF displays the names of the images that
have been entered in the list. A Y in the ‘PERMANENT?’ field indicates
that the image is permanent. In the sample panel, the list being updated
already contains the image names PLANE, CAR, TRAIN, BOAT, and
BIKE.
TSO/Batch command
You can use this TSO/batch command as an alternative to using the
Manage Resident Image Lists option to update an image list:
TAB LE UPDATE('list-dataset-name(list-name)') TYP E(IMGL)
ADD ) NAM E(image-name)[(P)]

 DEL ETE 
FUN CTION(
Use the (P) option after image-name to indicate that the image being
added is a permanent image, either printer-resident or cartridge.
Section Three: Managing Resources with XPAF
23-17
Managing resource lists
Adding a new image to the list
Enter A on the COMMAND line and press ENTER. A panel similar to this
appears.
Xerox Output Administrative Facility
Updating List - IMAGPRT1
COMMAND ===>
NAME
PERMANENT?
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
1.
3.
5.
7.
9.
11.
13.
15.
17.
19.
21.
23.
25.
NAME
2.
4.
6.
8.
10.
12.
14.
16.
18.
20.
22.
24.
26.
PERMANENT?
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
In the sample panel, the resident image list named IMAGPRT1 is being
updated.
The numbers provided are for convenience. Use these conventions when
entering image names:
•
•
Enter one or more image names and press ENTER:
—
Enter a 1- to 6-character, case-sensitive image name in the
‘NAME’ field.
—
Enter N in the ‘PERMANENT?’ field if the image is not a
cartridge or resident image. Otherwise, leave Y in the
‘PERMANENT?’ field.
—
You can enter image names in any order on the panel. Although
the panel displays 26 fields for entering images, you can enter
more than 26 image names. Each time you press ENTER, XPAF
processes the images and clears the panel. You may then enter
additional image names.
After you add the first group of image names, press ENTER. The
system returns to the Update a Resident Image List panel and
displays
* ADDED *
to the right of each new image added to the list. To add more images
to the image list, enter A on the COMMAND line and repeat this
procedure.
Section Three: Managing Resources with XPAF
23-18
Managing resource lists
Deleting an image from the list
Tab to the image name and enter D to the left of each image name you
want to delete. Press ENTER. The system deletes the image from the list
and displays
*DELETED*
to the right of the image name deleted from the list.
Section Three: Managing Resources with XPAF
23-19
Managing resource lists
Managing resident logo lists
To create, delete, or update resident logo lists, enter 4 at the Manage
Resource Lists menu OPTION line and press ENTER. This panel
appears:
Xerox Output Administrative Facility
Manage Resident Logo Lists
COMMAND ===>
* On COMMAND line, enter 'C' to create, 'D' to delete, or 'U' to update a list.
Dataset Name:
List Name:
On the COMMAND line, specify the function you want to perform. Valid
values are:
C
D
U
Create a new list.
Delete an existing list.
Update an existing list.
Then complete these fields and press ENTER:
Field
Action
Dataset Name
Enter the name of the native library that contains all the resident resource lists.
In the XOSF start-up proc, this is the dataset name in the DD statement
specified by the LIBRARY printer profile parameter.
List Name
Enter the name of the logo list to be created or updated. The name can be one
of the following:
•
A 1- to 20-character name that matches the name assigned to the
LOGOLIST printer profile parameter
•
LOGOcuu for an existing list that was generated by XOSF for a
channel-attached centralized printer
•
LOGOslu for an existing list that was generated by XOSF for a
remotely-attached centralized printer
NOTE: Logo list names are case-sensitive. When deleting or updating a
list, type the name exactly as it was entered originally
(uppercase/lowercase letters).
Section Three: Managing Resources with XPAF
23-20
Managing resource lists
Creating a resident logo list
If you enter C on the COMMAND line of the Manage Resident Logo Lists
panel, a panel similar to this appears:
Xerox Output Administrative Facility
Creating List - LOGOPRT1
COMMAND ===>
NAME
PERMANENT?
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
1.
3.
5.
7.
9.
11.
13.
15.
17.
19.
21.
23.
25.
NAME
2.
4.
6.
8.
10.
12.
14.
16.
18.
20.
22.
24.
26.
PERMANENT?
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Element Count = 0
In the sample panel, a resident logo list named LOGOPRT1 is being
created.
The numbers provided on the panel are for convenience. Use these
conventions when entering logo names:
•
Enter one or more logo names and press ENTER:
—
Enter a 1- to 6-character, case-sensitive logo name in the
‘NAME’ field.
—
Enter N in the ‘PERMANENT?’ field if the logo is not a cartridge
or resident logo. Otherwise, leave Y in the ‘PERMANENT?’ field.
—
You can enter logo names in any order on the panel. Although
the panel displays 26 fields for entering logos, you can enter
more than 26 logo names. Each time you press ENTER, XPAF
processes the logos and clears the panel. You may then enter
additional logo names.
—
When you press ENTER, ‘Element Count’ displays the number
of logos added to the list during this session. This is a
display-only field.
•
Enter END on the COMMAND line and press ENTER to save the list
and return to the preceding option panel.
•
Enter CANCEL or ABORT on the COMMAND line and press ENTER
to end the session without creating the list.
Before you modify a list, you must stop all printers using that list. When
you restart the printer, XPAF activates the new list.
Section Three: Managing Resources with XPAF
23-21
Managing resource lists
TSO/Batch command
You can use this TSO/batch command as an alternative to using the
Manage Resident Logo Lists option to create a new logo list:
TAB LE LOA D('list-dataset-name(list-name)')
FRO M('input-dataset-name[(member-name)]') TYP E(LGOL)
The format of the records within the dataset must be fixed-length records
that are 7 bytes long. The first 6 bytes of each record is the logo name.
The last byte (Y or N) indicates whether the logo is permanent.
Deleting a resident logo list
Enter D on the COMMAND line of the Manage Resident Logo Lists panel,
and enter the name of the library in which the list resides and the list
name. Then press ENTER.
XOAF displays a message indicating whether the list was deleted
successfully.
TSO/Batch command
You can use this TSO/batch command as an alternative to using the
Manage Resident Logo Lists option to delete a logo list:
TAB LE DEL ETE('list-dataset-name(list-name)')
Section Three: Managing Resources with XPAF
23-22
Managing resource lists
Updating a resident logo list
If you enter U on the COMMAND line of the Manage Resident Logo Lists
panel, a panel similar to this appears:
Xerox Output Administrative Facility
Update a Resident Logo List
COMMAND ===>
* On COMMAND line, enter 'A' to add an entry.
* Next to name, enter 'D' to delete an entry.
NAME
BIKE
PLANE
TRUCK
PERMANENT?
N
N
N
NAME
car
Train
PERMANENT?
N
N
Under the ‘NAME’ headings, XOAF displays the names of the logos that
have been entered in the list. A Y in the ‘PERMANENT?’ field indicates
that the logo is permanent. In the sample panel, the list being updated
already contains the logo names BIKE, car, PLANE, Train, and TRUCK.
TSO/Batch command
You can use this TSO/batch command as an alternative to using the
Manage Resident Logo Lists option to update a logo list:
TAB LE UPDATE('list-dataset-name(list-name)') TYP E(FRML)

ADD ) NAM E(logo-name)[(P)]

 DEL ETE 
FUN CTION(
Use the (P) option after logo-name to indicate that the logo being added
is a permanent logo, either printer-resident or cartridge.
Section Three: Managing Resources with XPAF
23-23
Managing resource lists
Adding a new logo to the list
Enter A on the COMMAND line and press ENTER. A panel similar to this
appears:
Xerox Output Administrative Facility
Updating List - LOGOPRT1
COMMAND ===>
NAME
PERMANENT?
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
1.
3.
5.
7.
9.
11.
13.
15.
17.
19.
21.
23.
25.
NAME
2.
4.
6.
8.
10.
12.
14.
16.
18.
20.
22.
24.
26.
PERMANENT?
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
In the sample panel, the resident logo list named LOGOPRT1 is being
updated.
The numbers provided are for convenience. Use these conventions when
entering logo names:
•
•
Enter one or more logo names and press ENTER:
—
Enter a 1- to 6-character, case-sensitive logo name in the
‘NAME’ field.
—
Enter N in the ‘PERMANENT?’ field if the logo is not a cartridge
or resident logo. Otherwise, leave Y in the ‘PERMANENT?’ field.
—
You can enter logo names in any order on the panel. Although
the panel displays 26 fields for entering logos, you can enter
more than 26 logo names. Each time you press ENTER, XPAF
processes the logos and clears the panel. You may then enter
additional logo names.
After you add the first group of logo names, press ENTER. The
system returns to the Update a Resident Logo List panel and
displays
* ADDED *
to the right of each new logo added to the list. To add more logos to
the logo list, enter A on the COMMAND line and repeat this
procedure.
Section Three: Managing Resources with XPAF
23-24
Managing resource lists
Deleting a logo from the list
Tab to the logo name and enter D to the left of each logo name you want
to delete. Press ENTER. The system deletes the logo from the list and
displays
*DELETED*
to the right of the logo name deleted from the list.
Section Three: Managing Resources with XPAF
23-25
Managing resource lists
Section Three: Managing Resources with XPAF
23-26
Managing XPAF tables
24.
24
Managing XPAF tables
This chapter describes how to use the options available on the Manage
Tables menu to maintain these XPAF tables:
•
•
•
•
•
•
•
•
•
•
•
•
•
Paper-related
XPAFXFI
Character mapping
XPAFFFI
XPAFCFN
CPGID
FGID
XPAFEFW
XPAFE2A
XPAFIFW
XPAFIFW3
Color cross-reference
Color conversion
The chapter also identifies an option that is available for deleting font
tables or table entries.
Maintaining paper-related tables
To access the paper-related tables, enter 1 on the Manage Tables menu
OPTION line and press ENTER. This panel appears:
Xerox Output Administrative Facility
Maintain Paper Tables
OPTION ===>
1.
Maintain the Paper Name Table
2.
Maintain the Varying Paper Size Table
3.
Maintain the Cluster Mapping Table
Enter the number of the option you want to select and press ENTER.
Section Three: Managing Resources with XPAF
24-1
Managing XPAF tables
Paper name table
To access a paper name table, enter 1 on the Maintain Paper Tables
menu OPTION line and press ENTER. This panel appears:
Xerox Output Administrative Facility
Maintain the Paper Name Table
COMMAND ===>
* On COMMAND line, enter 'C' to create, 'D' to delete, or 'U' to update a table.
Dataset Name:
Member Name:
On the COMMAND line, specify the function you want to perform. Valid
values are:
C
D
U
Create a new table.
Delete an existing table.
Update an existing table.
Then complete these fields and press ENTER:
Field
Action
Dataset Name
Enter the name of the native library that contains the paper-related tables. In
the XOSF start-up proc, this is the dataset name in the DD statement specified
by the PAPTBLDD initialization or printer profile parameter.
Member Name
•
Enter the 1- to 16-character member name of the paper name table you
want to maintain. The name can include alphanumeric or national ($, #,
@) characters.
•
When creating a new table or updating an existing table, leave this field
blank to select the default paper name table.
•
When deleting an existing table, a member name is required.
Section Three: Managing Resources with XPAF
24-2
Managing XPAF tables
Creating or updating a paper name table
If you enter C or U on the COMMAND line of the Maintain the Paper Name
Table panel, complete the fields, and press ENTER, a panel similar to this
appears:
Xerox Output Administrative Facility Row 1 to 13 of 17
Maintain Paper Name Table
COMMAND ===>
SCROLL===> PAGE
* Next to entry, enter 'A' to add, 'D' to delete, or 'U' to update.
Table Name: TAB01
PAPER NAME
#10
#7
A3
A4
A5
A6
B4
B5
C5
DL
EXEC
LEGAL
LEGL13
WIDTH HEIGHT
4.25
9.5
3.78
7.5
11.69 16.54
8.27 11.69
5.83
8.27
4.12
5.83
9.84
13.9
6.93
9.84
6.38
9.02
4.33
8.66
7.25
10.5
8.5
14
8.5
13
UNIT
MEASURE
IN
IN
IN
IN
IN
IN
IN
IN
IN
IN
IN
IN
IN
You can use this panel to add a new entry, delete an entry, or update an
entry:
•
To add a new entry, use one of two methods:
—
Enter A on the COMMAND line and press ENTER.
NOTE: If you enter A on the COMMAND line, all other table
entries listed are ignored.
—
Tab to the table entry that has attributes similar to the entry you
want to add, enter A to the left of the entry, and press ENTER.
For both options, XPAF displays the Add Entry panel for the paper
name table.
•
To delete an entry, tab to the table entry you want to delete, enter D
to the left of the entry, and press ENTER. No other panel is
displayed.
•
To update an entry, tab to the table entry you want to update, enter U
to the left of the entry, and press ENTER. XPAF displays the Update
Entry panel for the paper name table.
Section Three: Managing Resources with XPAF
24-3
Managing XPAF tables
Adding or updating a paper name table entry
If you enter A on the COMMAND line or next to a table entry on the
Maintain Paper Name Table panel and press ENTER, a panel similar to
this appears:
Xerox Output Administrative Facility
Add Entry to Paper Name Table
COMMAND ===>
Table Name: TAB01
Paper Name:
Width:
Height:
Unit Measure:
If you enter U next to a table entry on the Maintain Paper Name Table
panel and press ENTER, a panel similar to this appears:
Xerox Output Administrative Facility
Update Entry in Paper Name Table
COMMAND ===>
Table Name: TAB01
Paper Name: LETTER
Width: 8.5
Height: 11
Unit Measure: IN
NOTE: If you entered A on the COMMAND line, the panel is displayed
without any field entries. If you entered A or U next to a table entry,
the information for the selected entry is displayed on the panel.
Section Three: Managing Resources with XPAF
24-4
Managing XPAF tables
Complete these fields and press ENTER:
Field
Action
Table Name
Displays the name of the paper name table for which this entry will be added or
updated.
Paper Name
•
On the Add panel, enter the name associated with the specified page
dimensions. This must be a unique name.
Valid values:
•
Width
On the Update panel, this field displays the paper name to be updated.
This field cannot be changed.
Enter the length of the short edge side of the page.
Valid values:
Height
A 1- to 5-digit number in decimal format (for example, 11.25).
Enter the length of the long edge side of the page.
Valid values:
Unit Measure
A 1- to 6-character name. The name can include
alphanumeric or national ($, #, @) characters.
A 1- to 5-digit number in decimal format (for example, 11.25).
Enter the unit of measure in which the height and width are defined.
Valid values:
CM
DOTS
IN
MM
XDOTS
Centimeters
300 dots per inch
Inches
Millimeters
600 dots per inch
You should be aware of the following items when using this panel:
•
The dimensions entered in the ‘Width’, ‘Height’, and ‘Unit Measure’
fields for the paper name will be converted into dots for use by XPAF.
In the conversion process, some rounding may occur. The Add or
Update panel will show the actual value used by XPAF after
rounding. For example, if you enter a ‘Width’ value of 11.269 and a
‘Unit Measure’ value of INCHES, XPAF converts and rounds the
dimension from INCHES to DOTS. Then, when converted back to
inches, XPAF displays a value of 11.27 in the ‘Width’ field, which is
the nearest rounded value.
•
The value entered for the ‘Height’ field must be equal to or greater
than the value entered in the ‘Width’ field. If the ‘Width’ value is
greater than the ‘Height’ value, XPAF will exchange the two values
(that is, place the greater value in the ‘Height’ field).
•
If you change the ‘Unit Measure’ field and press ENTER, the values
in the ‘Width’ and ‘Height’ fields are now expressed in the newly
entered unit of measure. If the values in these fields are not correct,
enter the correct values.
Section Three: Managing Resources with XPAF
24-5
Managing XPAF tables
•
The maximum dimensional value, based on ‘Unit Measure,’ that can
be entered in either the ‘Width’ or the ‘Height’ field is:
—
—
—
—
—
277.42 CM
32767 DOTS
109.22 IN
2774.5 MM
65534 XDOTS
After you enter the required information and press ENTER, XPAF either
adds this new entry to the specified table, or updates the selected existing
entry, and returns to the previous panel.
NOTE: If XOAF displays a message when you press ENTER, review
the values in the ‘Width’ and ‘Height’ fields. Press ENTER to accept
the displayed values, or enter the correct values in the fields and then
press ENTER. To ignore the changes you made, and return to the
previous panel, press PF3.
Deleting a paper name table
If you enter D on the COMMAND line of the Maintain the Paper Name
Table panel, complete the fields, and press ENTER. XPAF displays a
message indicating whether the table was deleted successfully.
Section Three: Managing Resources with XPAF
24-6
Managing XPAF tables
Varying paper size table
To access a varying paper size table, enter 2 on the Maintain Paper
Tables menu OPTION line, and press ENTER. This panel appears:
Xerox Output Administrative Facility
Maintain the Varying Paper Size Table
COMMAND ===>
* On COMMAND line, enter 'C' to create, 'D' to delete, or 'U' to update a table.
Dataset Name:
Member Name:
On the COMMAND line, specify the function you want to perform. Valid
functions are:
C
D
U
Create a new table.
Delete an existing table.
Update an existing table.
Then complete these fields, and press ENTER:
Field
Action
Dataset Name
Enter the name of the native library that contains the paper-related tables. In
the XOSF start-up proc, this is the dataset name in the DD statement specified
by the PAPTBLDD initialization or printer profile parameter.
Member Name
•
Enter the 1- to 16-character member name of the varying paper size table
you want to maintain. The name can include alphanumeric or national ($,
#, @) characters.
•
When creating a new table or updating an existing table, leave this field
blank to select the default paper name table.
•
When deleting an existing table, a member name is required.
Section Three: Managing Resources with XPAF
24-7
Managing XPAF tables
Creating or updating a varying paper size table
If you enter C or U on the COMMAND line of the Maintain the Varying
Paper Size Table panel, complete the fields, and press ENTER, a panel
similar to this appears:
Xerox Output Administrative Facility
Maintain Varying Paper Size Table
COMMAND ===>
* Next to entry, enter 'A' to add, 'D' to delete, or 'U' to update.
Table Name: TAB02
AFP
TRAY
CEP
BIN # PAPER NAME
SELECT FEED JDE
00 LETTER
1
MAIN PGMODE
01 LETTER
1
MAIN PGMODE
02 A4
1
MAIN PGA4
03 LEGAL
1
MAIN PG14
04 LONG
1
MAIN PG1711
**** END OF VARYING PAPER SIZE TABLE ****
JDL
DFAULT
DFAULT
DFAULT
DFAULT
DFAULT
You can use this panel to add a new entry, delete an entry, or update an
entry:
•
To add a new entry, use one of these two methods:
—
Enter A on the COMMAND line and press ENTER.
NOTE: If you enter A on the COMMAND line, all other table
entries listed are ignored.
—
Tab to the table entry that has attributes similar to the entry you
want to add, enter A to the left of the entry, and press ENTER.
For both options, XPAF displays the Add Entry panel for the varying
paper size table.
•
To delete an entry, tab to the table entry you want to delete, enter D
to the left of the entry, and press ENTER. No other panel is
displayed.
•
To update an entry, tab to the table entry you want to update, enter U
to the left of the entry, and press ENTER. XPAF displays the Update
Entry panel for the varying paper size table.
Section Three: Managing Resources with XPAF
24-8
Managing XPAF tables
Adding or updating a varying paper size table entry
If you enter A on the COMMAND line or next to a table entry on the
Maintain Varying Paper Size Table panel, a panel similar to this appears:
Xerox Output Administrative Facility
Add Entry to Varying Paper Size Table
COMMAND ===>
Table Name: TAB02
AFP Bin #:
Paper Name:
XES Tray:
CEP FEED:
JDE:
JDL:
If you enter U next to a table entry on the Maintain Varying Paper Size
Table panel, a panel similar to this appears:
Xerox Output Administrative Facility
Update Entry in Varying Paper Size Table
COMMAND ===>
Table Name: TAB02
AFP Bin #: 00
Paper Name: LETTER
Tray Select Code: 1
CEP FEED: MAIN
JDE: PGMODE
JDL: DFAULT
NOTE: If you entered A on the COMMAND line, the panel is displayed
without any field entries. If you entered A or U next to a table entry,
the information for the selected entry is displayed on the panel.
Section Three: Managing Resources with XPAF
24-9
Managing XPAF tables
Complete these fields and press ENTER:
Field
Action
Table Name
Displays the name of the varying paper size table for which this entry will be
added or updated.
AFP Bin #
•
On the Add panel, enter the AFP bin number within the copy subgroup in
the form definition medium map you want to map to the specified paper
trays. This must be a unique number.
Valid values:
A 2-digit hexadecimal value from 00 through FF.
Default: 00
•
Paper Name
On the Update panel, this field displays the AFP bin number to be
updated. This field cannot be changed.
Enter the name of the paper size to be used in this tray. This name must be
defined in a paper name table.
Valid values:
Tray Sel
Enter the parameter for the XES or PCL tray select command you want to map
to the specified AFP bin number. The actual paper tray this command maps to
depends on your printer’s setup. For example, a 3 XES tray select command
could map to tray 4 on your printer. Refer to your printer’s PDL reference
manual for paper tray mapping information.
Valid values:
CEP FEED
A 1- to 6-character name. The name can include
alphanumeric or national ($, #, @) characters.
A 1-character command (0 through 9, A through F).
Enter the centralized paper tray cluster name to map to the specified AFP bin
number.
Valid values: A 1- to 6-character name.
JDE
Enter the JDE name to be used for this copy subgroup.
Valid values: A 1- to 6-character name.
JDL
Enter the JDL name to be used for this copy subgroup.
Valid values: A 1- to 6-character name.
After you enter the required information and press ENTER, XPAF adds
this entry to the specified table or updates the selected entry and returns
to the previous panel.
Deleting a varying paper size table
If you enter D on the COMMAND line of the Maintain the Varying Paper
Size Table panel, complete the fields, and press ENTER. XPAF displays
a message indicating whether the table was deleted successfully.
Section Three: Managing Resources with XPAF
24-10
Managing XPAF tables
Cluster mapping table
To access a cluster mapping table, enter 3 on the Maintain Paper Tables
menu OPTION line and press ENTER. This panel appears:
Xerox Output Administrative Facility
Maintain the Cluster Mapping Table
COMMAND ===>
* On COMMAND line, enter 'C' to create, 'D' to delete, or 'U' to update a table.
Dataset Name:
Member Name:
On the COMMAND line, specify the function you want to perform. Valid
values are:
C
D
U
Create a new table.
Delete an existing table.
Update an existing table.
Then complete these fields and press ENTER:
Field
Action
Dataset Name
Enter the name of the native library that contains the paper-related tables. In
the XOSF start-up proc, this is the dataset name in the DD statement specified
by the PAPTBLDD initialization or printer profile parameter.
Member Name
•
Enter the 1- to 16-character member name of the cluster mapping table
you want to maintain. The name can include alphanumeric and national
($, #, @) characters.
•
If the member name is left blank for a create or update function, the
default member name (DEFAULT) will be assumed.
•
When deleting an existing table, a member name is required.
Section Three: Managing Resources with XPAF
24-11
Managing XPAF tables
Creating or updating a cluster mapping table
If you enter C or U on the COMMAND line of the Maintain the Cluster
Mapping Table panel, complete the fields, and press ENTER, a panel
similar to this appears:
Xerox Output Administrative Facility
Maintain Cluster Mapping Table
COMMAND ===>
* Next to entry, enter 'A' to add, 'D' to delete, or 'U' to update.
Table Name: TAB03
CLUSTER NAME
PAPER NAME
LETTER
AUX
LETTER
MAIN
LETTER
OPR
LETTER
TRAY1
LETTER
TRAY2
LETTER
TRAY3
LETTER
TRAY4
LETTER
**** END OF CLUSTER MAPPING TABLE
TRAY SEL
1
2
21
1
1
2
3
4
****
You can use this panel to add a new entry, delete an entry, or update an
entry:
•
To add a new entry, use one of two methods:
—
Enter A on the COMMAND line and press ENTER.
NOTE: If you enter A on the COMMAND line, all other table
entries listed are ignored.
—
Tab to the table entry that has attributes similar to the entry you
want to add, enter A to the left of the entry, and press ENTER.
For both options, XPAF displays the Add Entry panel for the cluster
mapping table.
•
To delete an entry, tab to the table entry you want to delete, enter D
to the left of the entry, and press ENTER. No other panel is
displayed.
•
To update an entry, tab to the table entry you want to update, enter U
to the left of the entry, and press ENTER. XPAF displays the Update
Entry panel for the cluster mapping table.
Section Three: Managing Resources with XPAF
24-12
Managing XPAF tables
Adding or updating a cluster mapping table entry
If you enter A on the COMMAND line or next to a table entry on the
Maintain Cluster Mapping Table panel, a panel similar to this appears:
Xerox Output Administrative Facility
Add Entry to Cluster Mapping Table
COMMAND ===>
Table Name: TAB03
Cluster Name:
Paper Name:
Tray select code:
If you enter U next to a table entry on the Maintain Cluster Mapping Table
panel, a panel similar to this appears:
Xerox Output Administrative Facility
Update Entry in Cluster Mapping Table
COMMAND ===>
Table Name: TAB03
Cluster Name: MAIN
Paper Name: LETTER
Tray select code: 21
NOTE: If you entered A on the COMMAND line, the panel is displayed
without any field entries. If you entered A or U next to a table entry,
the information for the selected entry is displayed on the panel.
Section Three: Managing Resources with XPAF
24-13
Managing XPAF tables
Complete these fields and press ENTER:
Field
Action
Table Name
Displays the name of the cluster mapping table for which this entry will be
added or updated.
Cluster Name
•
On the Add panel, enter the centralized paper tray cluster name that this
entry is being created for. This name must be unique.
Valid values:
•
Paper Name
Any combination of alphanumeric and/or national ($, #,
@) characters. All blanks are also valid and define the
entry to be used as the default when a user referenced
cluster name does not exist.
On the Update panel, this field displays the centralized paper tray cluster
name entry that is being updated. This field cannot be changed.
Enter the name of the paper size to be used in this tray. This name must be
defined in a paper name table.
Valid values:
A 1- to 6-character name. The name can include
alphanumeric and national ($, #, @) characters.
NOTE: The Paper Name value is no longer used to determine the size of
the paper in the tray. The size of the paper is determined by the
PAPERSIZE= parameter in the active JDE. The Paper Name filed in the
cluster mapping table has been retained for compatibility with previous
releases.
Tray Select Code
Enter the value for the XES or PCL tray select command which will select the
desired paper tray on the decentralized or PCL-capable printer. The values
used will depend on the specific printer being used. For example, a 4 XES tray
select command maps to physical tray 2 on a 4517 printer. Refer to your
printer’s PDL reference manual for paper tray mapping information.
Valid values:
A 1- to 3-character command code. The command code can
be any valid tray select character, but cannot be all spaces or
include imbedded spaces.
After you enter the required information and press ENTER, XPAF adds
this entry to the specified table or updates the selected entry and returns
to the previous panel.
Deleting a cluster mapping table
If you enter D on the COMMAND line of the Maintain the Cluster Mapping
Table panel, complete the fields, and press ENTER. XPAF displays a
message indicating whether the table was deleted successfully.
Section Three: Managing Resources with XPAF
24-14
Managing XPAF tables
Maintaining font tables
XPAF font tables can be viewed and/or modified. Using this option, you
can:
•
Display or maintain the XPAFXFI table, which contains information
about fonts used by XPAF.
•
Display or update the character mapping tables, which map the
characters in the centralized and decentralized versions of a font.
•
Display or maintain the XPAFFFI table, which permits the font to be
referred to by font type as well as by font name.
•
Display or maintain the XPAFCFN table, which maps IBM coded font
names to code page names and character set names.
•
Browse, create, update, or delete entries in the CPGID and FGID
tables. The CPGID and FGID tables are used by XPAF to support the
processing of MCF-2 structured fields that contain process global
resource identifier (GRID) values.
To access the font table options, enter 2 on the Manage Tables menu
OPTION line and press ENTER. This menu appears:
Xerox Output Administrative Facility
Maintain Font Tables
OPTION ===>
1.
Maintain the Xerox Font Information (XPAFXFI) Table
2.
Maintain the Character Mapping Tables
3.
Maintain the Font Family Information (XPAFFFI) Table
4.
Maintain the Coded Font Name (XPAFCFN) Table
5.
Maintain the Code Page Global Identifier (CPGID) Table
6.
Maintain the Font Global Identifier (FGID) Table
Enter the number of the option you want to select and press ENTER.
Section Three: Managing Resources with XPAF
24-15
Managing XPAF tables
XPAFXFI table
To access the XPAFXFI table, enter 1 on the Maintain Font Tables menu
OPTION line and press ENTER. This panel appears:
Xerox Output Administrative Facility
Maintain the Xerox Font Information (XPAFXFI) Table
COMMAND ===>
* Enter font name, or leave blank for a member list.
Font Name:
Complete this field and press ENTER:
Field
Action
Font Name
•
Enter the 1- to 6-character name of the logical font for which you want to
create or update an entry.
•
Leave this field blank to display a selection list.
If you leave the ‘Font Name’ field blank, a panel similar to this appears:
Xerox Output Administrative Facility
Selection List of Font Table Members
COMMAND ===>
* Next to name, enter 'S' to select a member.
FFMT01
FFMT02
FFMT10
FFMT11
FORMSL
FORMSP
To select an XPAFXFI table entry from this list, tab to the appropriate
member name, enter S, and then press ENTER.
Section Three: Managing Resources with XPAF
24-16
Managing XPAF tables
Updating or creating an XPAFXFI table entry
After you enter a font name on the Maintain the Xerox Font Information
(XPAFXFI) Table panel or select a font from the Selection List of Font
Table Members panel, a panel similar to this appears:
Xerox Output Administrative Facility
Maintain the Xerox Font Information (XPAFXFI) Table
COMMAND ===>
* On COMMAND line, enter 'U' to create or update an entry.
Logical Font Name: L02BOA
SPECIFICATIONS
Font Name:
Centralized Character Mapping Name:
Decentralized Character Mapping Name:
Code Page Name:
Font Width:
Font Height:
Baseline to Top of Cell:
Decentralized Font Name:
FFMT01
CCMV01
DCMV01
XCP5
0020
0037
0029
Enter U on the COMMAND line to either change the font characteristics
or create a new logical font name with the same or different
characteristics. You can type over the existing entries.
Section Three: Managing Resources with XPAF
24-17
Managing XPAF tables
Complete these fields and press ENTER:
Field
Logical Font Name
Action
Enter the 1- to 6-character logical name of the font. This is the name by which
the font is known to XPAF:
•
For fonts used in native mode documents, this name must be the same as
the value in the ‘Font Name’ field.
•
For fonts used in page-formatted documents or AFP documents at 300 dpi
using Xerox fonts, XPAF uses this name to determine which code page to
use. By changing the logical font name and the code page name, you can
use different character mappings for the same font.
•
If you are using a licensed font and the true centralized font name is
entered in the ‘Font Name’ field, you can enter an alternate name for the
centralized version of the font. This allows you to use the name of your
choice rather than the licensed font name, which may not conform to your
font naming conventions.
When you change the logical font name and the new font name is unique, the
system creates a new member in the XPAFXFI table.
SPECIFICATIONS
Font Name
Enter the 1- to 6-character Xerox font name. This is the name of the font as it
resides in the font library. During native mode processing, this field is not
examined.
Centralized
Character
Mapping Name
Enter the 1- to 6-character name of the character mapping table that contains
the centralized character mapping of the font. This table contains the character
ID and ASCII hexadecimal mapping value for each character in the font.
Default: CCMV01
Decentralized
Character
Mapping Name
Enter the 1- to 6-character name of the character mapping table that contains
the decentralized character mapping of the font. This table contains the
character ID, plane number, and ASCII hexadecimal mapping value for each
character in the font.
Default: DCMV01
Code Page Name
Enter the 1- to 6-character name of the character mapping table that contains
the code page mapping for this font. The code page contains the character IDs
and their associated EBCDIC code points when used in an AFP document.
Font Width
Enter the average width in dots of the characters in the font.
Font Height
Enter the height in dots of the font.
Baseline to Top of
Cell
Enter the number of dots between the baseline and the top of the font cell.
Decentralized
Font Name
If the font is a licensed font, enter the 1- to 20-character name of the
decentralized version of the font.
Section Three: Managing Resources with XPAF
24-18
Managing XPAF tables
Deleting an XPAFXFI table entry
To delete entries from this table, use the Delete a Font Table or Table
Entry option on the Manage Tables menu panel. Refer to “Deleting a font
table or table entry” later in this chapter for information about using this
option.
Specifying the code page for a Xerox font
You can associate a Xerox font with one or more code pages by creating
new aliases through the XPAFXFI table and assigning a different code
page to each alias. Follow this procedure:
Step 1.
Create a character mapping table that contains the new code page
information. Follow the procedure described in “Creating a new character
mapping table from a dataset” later in this chapter.
Step 2.
Use Maintain the Xerox Font Information (XPAFXFI) Table option on the
Maintain Font Tables menu to update the XPAFXFI table to reference the
new code page name.
Step 3.
If you are associating the font with more than one code page, enter the
new logical name for this font when used with the code page specified in
step 2.
If the font is used in DCF documents, perform the next two steps:
Step 4.
Convert the Xerox font by using the Convert Xerox Font to IBM Format
option on the Convert Resources menu. This conversion creates an IBM
look-alike version of the font that DCF recognizes.
NOTE: If you use an IBM code page with this font, the code page
must reside in the output font library in which the converted font is
stored.
Step 5.
Create a DCF index for the new font by executing the JCL provided with
DCF.
Section Three: Managing Resources with XPAF
24-19
Managing XPAF tables
Character mapping tables
To access the character mapping table options, enter 2 on the Maintain
Font Tables menu OPTION line and press ENTER. This menu appears:
Xerox Output Administrative Facility
Maintain the Character Mapping Tables
OPTION ===>
1.
Display an Existing Character Mapping Table
2.
Create/Update a Character Mapping Table from a Dataset
3.
Create/Update a Character Mapping Table On-line
Enter the number of the option you want to perform and press ENTER.
Displaying an existing character mapping table
To display the values assigned to each character identifier in a character
mapping table, enter 1 on the Maintain the Character Mapping Tables
menu OPTION line. Press ENTER. This panel appears:
Xerox Output Administrative Facility
Display an Existing Character Mapping Table
COMMAND ===>
Character Mapping Name:
Table Type (CC/DC/CP):
Section Three: Managing Resources with XPAF
24-20
Managing XPAF tables
Complete these fields and press ENTER:
Field
Action
Character Mapping
Name
Enter the name of the centralized character mapping, decentralized character
mapping, or code page table you want to display.
Table Type
Enter the type of table you want to display.
Valid values:
CC Specifies a centralized character mapping table which shows each
character ID in the table with its associated ASCII value.
DC Specifies a decentralized character mapping table which shows each
character ID in the table with its associated ASCII value and plane
number.
CP Specifies a Xerox code page table which shows each character ID in
the table with its associated EBCDIC value.
Default: None
NOTE: If you select a table type other than the type of table you want to
display, the displayed information will not be correct. For example, if you
want to display a decentralized character mapping table, and you enter CC
instead of DC, XPAF will display the information for a centralized character
mapping table, which will not be accurate.
Section Three: Managing Resources with XPAF
24-21
Managing XPAF tables
After you press ENTER, a panel similar to the panel shown below will
appear.
Xerox Output Administrative Facility
Display an Existing Character Mapping Table
COMMAND ===>
Character Mapping Name: CCMV01
CHARACTER ID
CEPHEXBA
CEPHEXBF
CEPHEXB2
CEPHEXDF
CEPHEXD2
CEPHEXEA
CEPHEXEB
CEPHEXEC
CEPHEXED
ASCII VALUE
BA
BF
B2
DF
D2
EA
EB
EC
ED
The sample panel shown above displays information for a centralized
character mapping.
NOTE: The column headings that appear on the panel will differ,
depending on the type of table selected:
•
The ASCII VALUE column appears only for centralized
or decentralized character mappings.
•
The PLANE NUMBER column appears only for
decentralized character mappings.
•
The EBCDIC VALUE column appears only for Xerox
code pages.
The following fields/columns may appear on this panel:
Field/Column
Action
Character Mapping
Name
Displays the name of the centralized mapping, decentralized mapping, or code
page table you want to display.
CHARACTER ID
Displays the standard font character identifier that uniquely identifies each
character.
PLANE NUMBER
Displays the plane number in which the associated code point resides.
ASCII VALUE
Displays the location of the character, in ASCII representation, in the
centralized or decentralized font.
EBCDIC VALUE
Displays the location of the character, in EBCDIC representation, in the Xerox
code page.
Section Three: Managing Resources with XPAF
24-22
Managing XPAF tables
The following panel displays information for a decentralized character
mapping:
Xerox Output Administrative Facility
Display an Existing Character Mapping Table
COMMAND ===>
Character Mapping Name: DCMV01
CHARACTER ID
CEPHEXBA
CEPHEXBF
CEPHEXB2
CEPHEXDF
CEPHEXD2
CEPHEXEA
CEPHEXEB
CEPHEXEC
CEPHEXED
PLANE NUMBER
02
02
02
02
02
02
02
02
02
ASCII VALUE
46
47
45
49
48
4A
4B
4C
4D
The following panel displays information for a code page:
Xerox Output Administrative Facility
Display an Existing Character Mapping Table
COMMAND ===>
Character Mapping Name: RXCP08
CHARACTER ID
GF020000
LA010000
LA020000
LA110000
LA120000
LA130000
LA140000
LA150000
LA160000
EBCDIC VALUE
0F
81
C1
52
DF
49
DB
48
DA
Section Three: Managing Resources with XPAF
24-23
Managing XPAF tables
Creating a new character mapping table from a dataset
Use this option to create or update character mapping tables by loading
character mapping information from a dataset. The input data must be
stored in a PDS.
During the load process, if the character mapping name you provide does
not correspond to an existing table, XPAF creates a new table. If you are
updating a table, XPAF replaces the existing table with the revised table.
For this reason, the input dataset must contain character mapping
information for both the existing entries and new entries you are adding.
To create or update a character mapping table using a PDS as the input
source, use either a new PDS or an existing PDS. The steps for each
method are discussed in the following sections.
Using a new PDS
Step 1.
Create a PDS with these attributes:
RECFM=FB
LRECL=80
Step 2.
Within a member of the PDS, enter the character mapping information that
you want to load to an XPAF character mapping table.The member name
within the PDS must be the same as the character mapping name you
want to use. The member name becomes the character mapping name
when you load the information to XPAF.
The format of the data in the input PDS member varies depending on the
character information you load. For centralized font information, include
the character ID and ASCII value. For decentralized font information,
include the character ID, ASCII value, and plane number.
You should use the primary plane, plane 01, for your most commonly used
characters. Characters that will not fit in plane 01 should be placed in
plane 02 until it is full, and then planes 03-08 should be used in ascending
order. For code page information, include the character ID and EBCDIC
value.
The format for a centralized character mapping table entry is:
CHARID=xxxxxxxx ASCII=nn
The format for a decentralized character mapping table entry is:
CHARID=xxxxxxxx ASCII=nn PLANE=nn
The format for a Xerox code page table entry is:
CHARID=xxxxxxxx EBCDIC=nn
where
•
xxxxxxxx is the 8-digit character ID name.
•
nn is the 2-digit ASCII or EBCDIC hexadecimal value, or the 2-digit
decimal value for the plane number (01 to 08).
•
One or more spaces separate each value in the PDS member.
Section Three: Managing Resources with XPAF
24-24
Managing XPAF tables
Note these restrictions when creating or updating table entries:
•
Do not assign EBCDIC X'40' or ASCII X'20' to a character other than
a space. The ASCII X'20' code point always represents the space
character in a decentralized font, whether the code point X'20' is
listed in the decentralized character mapping table or not.
•
Decentralized character mapping tables cannot map characters to
these ASCII code points:
X'00' through X'1F'
•
When printing documents on decentralized printers in EBCDIC
mode, do not map characters in decentralized character mapping
tables to these ASCII code points:
X'80' through X'97'
X'D6' through X'DB'
X'E5’
The following example shows an entry for a centralized character
mapping table:
CHARID=LA010000 ASCII=61
CHARID=LA020000 ASCII=41
The following example shows an entry for a decentralized character
mapping table:
CHARID= LA010000 ASCII=61 PLANE=01
CHARID= LA020000 ASCII=41 PLANE=01
The following example shows an entry for a Xerox code page table:
CHARID=LA010000 EBCDIC=81
CHARID=LA020000 EBCDIC=C1
Using an existing PDS
Edit an existing PDS member to change the appropriate character
mapping values. You can edit a PDS you created previously or one of the
sample character mapping tables provided in XPFSAMP.
After completing either your entries to the input PDS or your changes to
the character mapping table in XPFSAMP, you can load the information
to XPAF.
Section Three: Managing Resources with XPAF
24-25
Managing XPAF tables
Enter 2 on the Maintain the Character Mapping Tables menu OPTION line
and press ENTER. This panel appears:
Xerox Output Administrative Facility
Create/Update a Character Mapping Table from a Dataset
COMMAND ===>
Character Mapping Name:
Dataset Name:
Complete these fields and press ENTER:
Field
Character Mapping
Name
Dataset Name
Action
•
Enter the character mapping name. This is the name of the character
mapping table you are creating or updating. This name must correspond
to a member name in the input PDS.
•
Leave this field blank to create or update a character mapping table for
each member contained in the input PDS.
Enter the name of the PDS that contains the character mapping information that
will be loaded to XPAF. Do not include the member name; XPAF uses the
‘Character Mapping Name’ value as the input member name.
Section Three: Managing Resources with XPAF
24-26
Managing XPAF tables
Creating a new character mapping table online
This option allows you to define characters one at a time. You can create
a new table or add entries to an existing table, but you cannot modify
existing entries.
NOTE: To delete entries from this table, use the Delete a Font Table
or Table Entry option on the Manage Tables menu panel. Refer to
“Deleting a font table or table entry” later in this chapter for
information about using this option.
To create a new character mapping online, enter 3 on the Maintain the
Character Mapping Tables menu OPTION line and press ENTER. This
panel appears:
Xerox Output Administrative Facility
Create/Update a Character Mapping Table On-line
COMMAND ===>
Character Mapping Name:
Character ID:
EBCDIC Value or Plane Number:
ASCII Value:
Complete the following fields and press ENTER:
NOTE: Enter only the values required for the appropriate type of
character mapping table:
•
The required fields for centralized character mapping
tables are: ‘Character Mapping Name’, ‘Character ID’,
and ‘ASCII Value’.
•
The required fields for decentralized character mapping
tables are: ‘Character Mapping Name’, ‘Character ID’,
‘Plane Number’, and ‘ASCII Value’.
•
The required fields for Xerox code page tables are:
‘Character Mapping Name’, ‘Character ID’, and
‘EBCDIC Value’.
Section Three: Managing Resources with XPAF
24-27
Managing XPAF tables
Field
Action
Character Mapping
Name
Enter the centralized or decentralized character mapping name as found in the
XPAFXFI table.
Character ID
Enter the 8-character standard font character identifier that uniquely identifies
each character. This name is used to match characters between centralized
fonts and decentralized fonts as well as centralized mapping variations and
code pages.
EBCDIC Value or Plane
Number
•
For Xerox code page tables, enter the 2-digit hexadecimal EBCDIC value
which represents the location of the character in the Xerox code page.
NOTE: Do not assign EBCDIC X'40' to a character other than a space
or your font conversion results may be unpredictable.
•
ASCII Value
For decentralized character mapping tables, enter the 2-digit plane
number (01–08).
Enter the 2-digit hexadecimal ASCII value which represents the location of the
character in either the centralized or the decentralized font. Note these
restrictions:
•
Do not assign ASCII X'20' to a character other than a space. The ASCII
X'20' code point always represents the space character in a decentralized
font, whether the code point X'20' is listed in the decentralized character
mapping table or not.
•
Decentralized character mapping tables cannot map characters to these
ASCII code points:
X'00' through X'1F'
•
When printing documents on decentralized printers in EBCDIC mode, do
not map characters in decentralized character mapping tables to these
ASCII code points:
X'80' through X'97'
X'D6' through X'DB'
X'E5'
Section Three: Managing Resources with XPAF
24-28
Managing XPAF tables
XPAFFFI table
To access the font family information table, enter 3 on the Maintain Font
Tables menu OPTION line and press ENTER. This panel appears:
Xerox Output Administrative Facility
Maintain the Font Family Information (XPAFFFI) Table
COMMAND ===>
* Enter font family name, or leave blank for a member list.
Font Family Name:
Complete this field and press ENTER:
Field
Action
Font Family Name
•
Enter the 1- to 6-character name of the font family for which you want to
display, create, or update an entry.
•
Leave this field blank to display a selection list.
If you leave the ‘Font Family Name’ field blank, a panel similar to this
appears:
Xerox Output Administrative Facility
Selection List of Font Table Members
COMMAND ===>
* Next to name, enter 'S' to select a member.
L00TPA
L00TPB
L00TPC
L01BOA
L01BOB
L01ITA
To select the font family you want to update, tab to the appropriate
member name, enter S, and press ENTER.
Section Three: Managing Resources with XPAF
24-29
Managing XPAF tables
When you enter a font name on the Maintain the Font Family Information
(XPAFFFI) Table panel, or select a font from the Selection List of Font
Table Members panel, a panel similar to this appears:
Xerox Output Administrative Facility
Maintain the Font Family Information (XPAFFFI) Table
COMMAND ===>
* On COMMAND line, enter 'U' to create or update an entry.
Font Name: L00TPC
FONT CHARACTERISTICS
Typeface:
Weight:
Font Width:
Point Size:
Rotation (000/090/180/270):
Orientation (P/L/I/J):
FONT ATTRIBUTES
Italics (Y/N):
Outlined (Y/N):
Overstruck (Y/N):
Underlined (Y/N):
TRENDPS
MEDIUM
NORMAL
12
000
L
N
N
N
N
Enter U on the COMMAND line to either update or create a table entry.
Then complete these fields and press ENTER:
Field
Font Name
FONT
CHARACTERISTICS
Action
This field displays the name of the font:
•
Do not change this name if you want to update an existing table.
•
Enter a unique 1- to 6-character font name if you want to create a new
table.
•
Enter the name of an existing font in the table if you want to display
information for a different font.
Enter the descriptive name of the font family.
Typeface
Section Three: Managing Resources with XPAF
24-30
Managing XPAF tables
Field
Weight
Action
Enter the weight of the font.
Valid values:
ULTRALIGHT
EXTRALIGHT
LIGHT
SEMILIGHT
MEDIUM
SEMIBOLD
BOLD
EXTRABOLD
ULTRABOLD
Font Width
Enter the width of the font.
Valid values:
ULTRACONDENSED
EXTRACONDENSED
CONDENSED
SEMICONDENSED
NORMAL
SEMIEXPANDED
EXPANDED
EXTRAEXPANDED
ULTRAEXPANDED
Point Size
Enter the actual point size of the font.
Rotation
Enter the angle of rotation of the characters in degrees relative to the baseline.
Valid values:
000
090
180
270
Orientation
Enter the print direction.
Valid values:
P
L
I
J
FONT ATTRIBUTES
Italics
Portrait
Landscape
Inverse portrait
Inverse landscape
Indicate whether the font’s attributes include italics.
Valid values:
Y
N
Includes the italics font attribute.
Does not include the italics font attribute.
Section Three: Managing Resources with XPAF
24-31
Managing XPAF tables
Field
Outlined
Action
Indicate whether the font’s attributes include outline.
Valid values:
Y
N
Overstruck
Includes the outline font attribute.
Does not include the outline font attribute.
Indicate whether the font’s attributes include overstruck.
Valid values:
Y
N
Underlined
Includes the overstruck font attribute.
Does not include the overstruck font attribute.
Indicate whether the font’s attributes include underline.
Valid values:
Y
N
Includes the underline font attribute.
Does not include the underline font attribute.
Section Three: Managing Resources with XPAF
24-32
Managing XPAF tables
XPAFCFN table
To access the coded font name table, enter 4 on the Maintain Font Tables
menu OPTION line and press ENTER. This panel appears:
Xerox Output Administrative Facility
Maintain the Coded Font Name (XPAFCFN) Table
COMMAND ===>
* Enter coded font name, or leave blank for a member list.
Coded Font Name:
Complete this field and press ENTER:
Field
Coded Font Name
Action
•
Enter the 1- to 8-character name of the coded font for which you want to
update table entries.
•
Leave this field blank to display a selection list.
NOTE: To delete entries from this table, use the Delete a Font Table
or Table Entry option on the Manage Tables menu panel. Refer to
“Deleting a font table or table entry” later in this chapter for
information about using this option.
Section Three: Managing Resources with XPAF
24-33
Managing XPAF tables
If you leave the ‘Coded Font Name’ field blank, a panel similar to this
appears:
Xerox Output Administrative Facility
Selection List of Font Table Members
COMMAND ===>
* Next to name, enter 'S' to select a member.
X0AD0A
X0AD0B
X0AD10
X0AD2A
X0AD2B
X0AE10
X0AG0A
To select a coded font from this list, tab to the appropriate member name,
enter S, and press ENTER.
When you enter a font name on the Maintain the Coded Font Name
(XPAFCFN) Table panel, or select a font from the Selection List of Font
Table Members panel, a panel similar to this appears:
Xerox Output Administrative Facility
Maintain the Coded Font Name (XPAFCFN) Table
COMMAND ===>
* On COMMAND line, enter 'U' to create or update an entry.
Coded Font Name: X0AD0A
Code Page Name: T1000293
Character Set Name: C0L0AD10
Enter U on the COMMAND line to either update or create a table entry.
Then complete these fields and press ENTER:
Section Three: Managing Resources with XPAF
24-34
Managing XPAF tables
Field
Coded Font Name
Action
Enter the 1- to 8-character IBM coded font name. Include the Xn prefix, where:
•
•
n = 0 for 3820 fonts
n = 1, 2, 3, or 4 for 3800 fonts
Code Page Name
Enter the 1- to 8-character IBM code page name associated with this coded font
name. Include the T1 prefix.
Character Set Name
Enter the 1- to 8-character IBM character set name associated with this coded
font name. Include the Cn prefix, where:
•
•
n = 0 for 3820 fonts
n = 1, 2, 3, or 4 for 3800 fonts
If the coded font name is a new name, a new coded font will be added to
the table.
Section Three: Managing Resources with XPAF
24-35
Managing XPAF tables
CPGID table
To access the CPGID table, enter 5 on the Maintain Font Tables menu
OPTION line and press ENTER. This panel appears:
Xerox Output Administrative Facility
Maintain the Code Page Global Identifier (CPGID) Table
COMMAND ===>
* On COMMAND line, enter 'B' to browse, 'U' to create or update, or
'D' to delete.
Graphic Character Set Global Identifier:
Code Page Global Identifier:
Code Page Name:
On the COMMAND line, specify the function you want to perform. Valid
values are:
B
Browse an entry. You also must enter values in the ‘Graphic
Character Set Global Identifier’ and the ‘Code Page Global
Identifier’ fields to browse an entry.
U
Create or update an entry. You also must enter values in all three
fields to create or update an entry.
D
Delete an entry. You also must enter values in the ‘Graphic
Character Set Global Identifier’ and the ‘Code Page Global
Identifier’ fields to delete an entry.
NOTE: The default option is B (browse).
Section Three: Managing Resources with XPAF
24-36
Managing XPAF tables
Depending on the value you selected, complete these fields and press
ENTER:
Field
Graphic Character Set
Global Identifier
Action
Enter the graphic character set global identifier. This value must specify a
2-byte hexadecimal number (for example, 0479).
Valid values:
Code Page Global
Identifier
Enter the code page global identifier. This value must specify a 2-byte
hexadecimal number (for example, 0169).
Valid values:
Code Page Name
A 4-digit hexadecimal value from 0000 through FFFF.
A 4-digit hexadecimal value from 0000 through FFFF.
Enter the 8-character IBM code page name. The name must begin with the
letter “T” (for example, T1000361).
NOTE: If you update or delete an entry using this option and later run
any of XPAF’s IBM font table update options, the original entry that
you updated or deleted may be recreated or changed in the CPGID
table. This will occur because the values in your IBM font library will
override any value in the CPGID table.
Section Three: Managing Resources with XPAF
24-37
Managing XPAF tables
FGID table
To access the FGID table, enter 6 on the Maintain Font Tables menu
OPTION line and press ENTER. This panel appears:
Xerox Output Administrative Facility
Maintain the Font Global Identifier (FGID) Table
COMMAND ===>
* On COMMAND line, enter 'B' to browse, 'U' to create or update, or
'D' to delete.
Font Global Identifier:
Space Character Width:
Character Set Name:
On the COMMAND line, specify the function you want to perform. Valid
values are:
B
Browse an entry. You also must enter values in the ‘Font Global
Identifier’ and the ‘Space Character Width’ fields to browse an
entry.
U
Create or update an entry. You also must enter values in all three
fields to create or update an entry.
D
Delete an entry. You also must enter values in the ‘Font Global
Identifier’ and the ‘Space Character Width’ fields to delete an
entry.
NOTE: The default option is B (browse).
Section Three: Managing Resources with XPAF
24-38
Managing XPAF tables
Depending on the value you selected, complete these fields and press
ENTER:
Field
Font Global Identifier
Action
Enter the font global identifier. This value must specify a 2-byte hexadecimal
number (for example, 0904).
Valid values:
Space Character
Width
Enter the width of the space character. This value must specify a 2-byte
hexadecimal number (for example, 0028). The value should match the nominal
horizontal font size specified for the character set in the font descriptor record
in your IBM font library.
Valid values:
Character Set Name
A 4-digit hexadecimal value from 0000 through FFFF.
A 4-digit hexadecimal value from 0000 through FFFF.
Enter the 8-character name of the IBM character set. The name must begin with
the letter “C” (for example, C0N20060).
NOTE: If you update or delete an entry using this option and
later run any of XPAF’s IBM font table update options, the
original information you updated or the entry you deleted may be
recreated or changed in the FGID table. This will occur because
the values in your IBM font library will override any value in the
FGID table.
Section Three: Managing Resources with XPAF
24-39
Managing XPAF tables
Updating IBM font characteristics information
Use this option to submit a batch job that creates entries to the font tables
containing IBM font information required by XPAF. The batch job creates
entries for these font tables:
•
•
•
•
•
•
•
CPGID
FGID
XPAFCFN
XPAFEFW
XPAFE2A
XPAFIFW
XPAFIFW3
The font tables are built by RJOB105 during resource installation. Use this
option to rebuild the tables if you change the code page assigned to a font
or if you add new IBM fonts.
Submit a job for each library included in the IBM font library concatenation
in your XOSF start-up proc. Execute the jobs in the reverse order of the
library concatenation (that is, the first library included must be the last
converted). Because the table entries created by this option replace any
duplicate entries already present in the font tables, this procedure
ensures that the table entries created for the first library in your
concatenation are not overwritten.
Section Three: Managing Resources with XPAF
24-40
Managing XPAF tables
Using this option
To update IBM font characteristics information, enter 3 on the Manage
Tables menu OPTION line and press ENTER. This panel appears:
Xerox Output Administrative Facility
Update IBM Font Characteristics Information
COMMAND ===>
IBM FONT LIBRARY
Dataset Name:
DATASET PREFIX
XPFLOAD Library:
XINPARM Library:
Font Table Library:
JOB CARD INFORMATION
===> //JOBNAME JOB (ACCOUNT),'NAME',CLASS= ,MSGCLASS=
===> //*
===> //*
===> //*
Complete these fields:
Field
IBM FONT LIBRARY
Dataset Name
DATASET PREFIX
Action
Enter the name of the IBM font library dataset, including the high-level qualifier.
In the XOSF start-up proc, this is the dataset name in the DD statement
specified by the IBMFONTDD initialization parameter. Be sure to enclose the
dataset name in single quotation marks.
Enter the high-level and mid-level qualifiers for your system load library.
XPFLOAD Library
XINPARM Library
Enter the high-level and mid-level qualifiers (if different from XPFLOAD) for the
library containing your initialization parameters.
Font Table Library
Enter the high-level and mid-level qualifiers (if different from XPFLOAD) for the
library in which the font tables are stored. In the XOSF start-up proc, this is the
dataset name in the DD statement specified by the FNTTBLDD initialization
parameter.
JOB CARD
INFORMATION
Enter site-specific job card information.
Section Three: Managing Resources with XPAF
24-41
Managing XPAF tables
Press ENTER, and this panel appears:
Xerox Output Administrative Facility
Update IBM Font Characteristics Information
OPTION ===>
C.
Cancel JCL
E.
Edit JCL
K.
Keep JCL
S.
Submit JCL
Select the option you want to perform and press ENTER. Valid values are:
C
Cancels the generated JCL and returns to the initial Update IBM
Font Characteristics panel.
E
Displays the generated JCL for editing purposes.
K
Keeps the generated JCL in a sequential dataset. After you save
the JCL, you can access this dataset and submit the job without
regenerating the JCL each time.
S
Submits the JCL. Standard TSO/ISPF JCL submission error or
confirmation messages are displayed.
NOTE: You cannot use the END command or the PF3 key to exit this
panel. If you want to return to the previous panel and do not want to
display, submit, or keep the JCL, you must enter C on the COMMAND
line and press ENTER.
Section Three: Managing Resources with XPAF
24-42
Managing XPAF tables
Editing the JCL
If you enter E in the OPTION line on the JCL options panel, a panel
containing JCL similar to this appears:
// job-name JOB job-information
//*
//**************************************************************/
//* CREATE IBM FONT CHARACTERISTICS - XOAJ0360
*/
//**************************************************************/
//*
//S1 EXEC PGM=XOASUP00,REGION=8192K,PARM=userid
//STEPLIB
DD DISP=SHR,
//
DSN=prefix.XPFLOAD
//SYSPRINT DD SYSOUT=X
//TABLELIB DD DISP=SHR,
//
DSN=prefix.font-table-library-name
//XINPARM
DD DISP=SHR,
//
DSN=prefix.XINPARM
//XOAPRINT DD SYSOUT=*,DCB=(LRECL=121,RECFM=FB,BLKSIZE=6050)
//XOAIN
DD *
CONVERT IBM('ibm-font-library-dataset-name')
/*
You can edit and save the JCL and cancel or submit the job by using
standard TSO/ISPF commands.
Section Three: Managing Resources with XPAF
24-43
Managing XPAF tables
Keeping the JCL
If you enter K in the OPTION line on the JCL options panel, this panel
appears:
Xerox Output Administrative Facility
Update IBM Font Characteristics Information
COMMAND ===>
* To keep the JCL, enter a new sequential dataset name.
Dataset Name:
Complete this field and press ENTER:
Field
Dataset Name
Action
Enter the name of the sequential dataset that is not currently cataloged. This is
the dataset in which your JCL will be stored.
To return to the previous panel, enter END and press ENTER.
TSO/Batch command
You can use this TSO/batch command as an alternative to using the
Update IBM Font Characteristics Information option:
CON VERT IBM('ibm-font-library-dataset-name')
Section Three: Managing Resources with XPAF
24-44
Managing XPAF tables
Deleting a font table or table entry
You can use this option to delete any of the XPAF font tables listed below.
You also can use this option to delete entries that are used by XPAF
within these tables.
•
•
•
•
•
•
•
•
•
•
•
•
•
CPGID
FGID
XPAFAFW
XPAFA2A
XPAFCFN
XPAFEFW
XPAFE2A
XPAFFFI
XPAFIFW
XPAFIFW3
XPAFI2X
XPAFXFI
Character mapping tables you have created
CAUTION: Do not delete any XPAF-generated tables without a
thorough understanding of their use or without providing a
replacement table, if appropriate. For example, the XPAFEFW and
XPAFE2A tables that are distributed with XPAF contain information
which is required for successful processing of page-formatted
documents. Therefore, these tables must not be deleted.
Deleting a font table
To delete a font table, enter 4 on the Manage Tables menu OPTION line
and press ENTER. This panel appears:
Xerox Output Administrative Facility
Delete a Font Table or Table Entry
COMMAND ===>
* On COMMAND line, enter '1' to delete a table or '2' to delete a table entry.
Dataset Name:
Table Name:
Section Three: Managing Resources with XPAF
24-45
Managing XPAF tables
Enter 1 on the COMMAND line to delete a table. Then complete these
fields and press ENTER:
Field
Action
Dataset Name
Enter the name of the dataset containing the tables to be processed. In the
XOSF start-up proc, this is the dataset name in the DD statement specified by
the FNTTBLDD initialization parameter.
Table Name
Enter the name of the table you are deleting. Select a table name from this list
or enter the name of a character mapping table:
CPGID
FGID
XPAFAFW
XPAFA2A
XPAFCFN
XPAFEFW
XPAFE2A
XPAFFFI
XPAFIFW
XPAFIFW3
XPAFI2X
XPAFXFI
NOTE: If you delete an entry in the CPGID or FGID tables using this
option and later run any of XPAF’s IBM font table update options, the
entry you deleted may be recreated in the table. This will occur
because the values in your IBM font library will override any value in
the CPGID or FGID tables.
Deleting a table entry
To delete a font table entry, enter 4 at the Maintain XPAF Tables menu
OPTION line and press ENTER. The Delete a Font Table or Table Entry
panel (already shown) appears.
Section Three: Managing Resources with XPAF
24-46
Managing XPAF tables
Enter 2 on the COMMAND line to delete a table entry. Then complete
these fields:
Field
Action
Dataset Name
Enter the name of the dataset containing the tables to be processed. In the
XOSF start-up proc, this is the dataset name in the DD statement specified by
the FNTTBLDD initialization parameter.
Table Name
Enter the name of the table from which you want to delete an entry. Select a
table name from this list or enter the name of a character mapping table:
CPGID
FGID
XPAFAFW
XPAFA2A
XPAFCFN
XPAFEFW
XPAFE2A
XPAFFFI
XPAFIFW
XPAFIFW3
XPAFI2X
XPAFXFI
After you complete your entries, press ENTER. A panel similar to this
appears:
Xerox Output Administrative Facility
Delete a Table Entry
COMMAND ===>
* Next to name, enter 'D' to delete an entry.
FFMT01
FFMT03
FFMT10
FORMSL
FRMS7L
L00TPA
L00TPC
FFMT02
FFMT04
FFMT11
FORMSP
FRMS7P
L00TPB
L01BOA
Tab to the table entry you want to delete and enter D to the left of the
entry. Press ENTER. The system deletes the entry from the table and
displays
* DELETED *
to the right of the entry.
Section Three: Managing Resources with XPAF
24-47
Managing XPAF tables
Maintaining color cross-reference tables
To create, delete, or update color cross-reference tables, enter 5 on the
Manage Tables menu OPTION line and press ENTER. This panel
appears:
Xerox Output Administrative Facility
Maintain Color Cross-Reference Tables
COMMAND ===>
* On COMMAND line, enter 'C' to create, 'D' to delete, or 'U' to update a table.
Dataset Name:
Table Name:
On the COMMAND line, specify the function you want to perform. Valid
values are:
C
D
U
Create a new color cross-reference table.
Delete an existing color cross-reference table.
Update an existing color cross-reference table.
Then complete these fields and press ENTER:
Field
Action
Dataset Name
Enter the name of the native library where the color cross-reference table is or
will be stored. This is the dataset name referenced by the INKXLIB initialization
or printer profile parameter, or extended JCL keyword.
Table Name
Enter the 1- to 8-character name of the table you are creating or updating. This
is the table name referenced by the INKXREF initialization or printer profile
parameter, or extended JCL keyword.
Section Three: Managing Resources with XPAF
24-48
Managing XPAF tables
Creating/Updating a color cross-reference table
If you enter C (create) or U (update) on the COMMAND line of the
Maintain Color Cross-Reference Tables panel, a panel similar to this
appears:
Xerox Output Administrative Facility
Creating Table - COLOR
COMMAND ===>
SCROLL ===>
* On COMMAND line, enter 'A' to add an entry.
* Next to “Set“ field, enter 'U' to update an entry, then overtype value
in “To“ field.
* Next to “Set“ field, enter 'D' to delete an entry.
Set: BLACK
To: BLACK
Set: BLUE
To: BLUE
Set: BROWN
To: BROWN
Set: GREEN
To: GREEN
Set: PINK
To: PINK
If you are creating a new table, the title reads “Creating Table - NAME”. If
you are updating an existing table, the title reads “Updating Table NAME”. In either case, NAME is the table name you specified on the
previous panel. For example, in the sample panel, a cross-reference table
named COLOR is being created.
Use this panel to add, update, or delete color cross-references within the
table.
•
If you are creating a new table, the default values are displayed in
the ‘Set’ and ‘To’ fields, as shown in the sample panel.
•
If you are updating a table, the previously established
cross-references are displayed.
You can page forward or backward using standard scroll commands.
Section Three: Managing Resources with XPAF
24-49
Managing XPAF tables
Adding a new color cross-reference entry
To add a new color cross-reference entry to the table, enter A on the
COMMAND line and press ENTER. A panel similar to this appears:
Xerox Output Administrative Facility
Updating Table - COLOR
COMMAND ===>
Set:
To:
Set:
To:
Set:
To:
Set:
To:
Set:
To:
Add the new color cross-reference entries to the table. You can page
forward or backward using standard scroll commands.
Complete these fields:
Field
Action
Set
Enter the ink color that you want to change.
To
Enter the Xerox color to which you are cross-referencing the color named in the
‘Set’ field. For example:
Set: CAT.NEW PALETTE.ORANGE
To: CAT2.OLD PALETTE.LIGHT PINK
After you complete your entries, press ENTER. XOAF returns to the
Updating Table panel. The new entries are displayed at the beginning of
the table. The next time you update the table, all of the entries will be
displayed in alphabetic order.
Section Three: Managing Resources with XPAF
24-50
Managing XPAF tables
Updating a color cross-reference entry
To update a color cross-reference entry in the table, enter U to the left of
the ‘Set’ field, type the new name over the existing color cross-reference
name in the ‘To’ field, and press ENTER.
Use these fields on the panel:
Field
Action
Set
Displays the color that you want to change.
To
Enter the Xerox color to which you are cross-referencing the color named in the
‘Set’ field. This must be a color name that exists in your printer ISL.
The color cross-reference name can be specified in this format:
inkcat.palette.color
where
inkcat
Name of the ink catalog defined in the printer ISL. This name, which is
optional, can be up to 6 characters long.
palette Name of a palette defined in the ink catalog. This name, which also is
optional, can be up to 32 characters long.
color
Name of the color within the palette. This name can be up to 32
characters long.
For example, PROD.SOLID.RED refers to the red ink in the solid palette in the
catalog named PROD.
Deleting a color cross-reference entry
To delete a color cross-reference entry from the table, enter D to the left
of the ‘Set’ field for the color cross-reference entry you want to delete and
press ENTER. No additional panels are displayed.
Deleting a color cross-reference table
To delete a color cross-reference table, enter D on the COMMAND line on
the Maintain Color Cross-Reference Tables panel. Then enter the name
of the library in which the table resides and the table name. Press ENTER.
XOAF displays a message indicating whether the table was deleted. No
additional panels are displayed.
Section Three: Managing Resources with XPAF
24-51
Managing XPAF tables
Maintaining the color conversion table
To modify the default color conversion table to add custom colors, follow
this procedure:
Step 1.
Make a copy of the default table. The default color conversion table,
named COLR4700, is provided with XPAF and is stored in XPFSAMP.
Step 2.
Edit the new PDS member.
Step 3.
Load the edited color conversion table using either of these methods:
•
Use the Maintain the Color Conversion Table option on the Manage
Tables menu. Refer to the next section, “Using this option,” for
detailed information about how to use the Maintain the Color
Conversion Table option.
•
Use the LOAD INKS TSO/batch command. Refer to “TSO/Batch
command” later in this chapter for the format for this command.
Using this option
To load the color conversion table, enter 6 on the Manage Tables menu
OPTION line and press ENTER. This panel appears:
Xerox Output Administrative Facility
Maintain the Color Conversion Table
COMMAND ===>
INPUT
Dataset Name:
Member Name:
OUTPUT
Dataset Name:
Section Three: Managing Resources with XPAF
24-52
Managing XPAF tables
Complete these fields and press ENTER:
Field
INPUT
Dataset Name
Action
Enter the name of the PDS where the color conversion table is stored. The
recommended dataset specifications are:
RECFM=FB
LRECL=80
BLKSIZE=A value appropriate to your site
Member Name
OUTPUT
Dataset Name
Enter the 1- to 8-character name of the member in which the color conversion
table resides.
Enter the name of the native library to which the color conversion table is being
loaded. In the XOSF start-up proc, this is the dataset name in the DD statement
specified by the INKXLIB initialization parameter or printer profile parameter.
TSO/Batch command
You can use this TSO/batch command as an alternative to using the
Maintain the Color Conversion Table option:
LOA D INK S('input-dataset-name(member-name)')
[TO]('output-dataset-name')
Section Three: Managing Resources with XPAF
24-53
Managing XPAF tables
Color conversion table loader report
The color conversion table loader automatically generates a report that
shows the ISL source as it is read from the PDS member. Figure 24-1
shows a sample report.
The report is written to a dataset with the DD name UJLLIST, included in
the XOAF logon proc and XOAF batch JCL. As shown in the following
examples, you can specify a dataset name in place of SYSOUT.
//XOAFBAT
//XOAF
PROC
EXEC
//UJLLIST
//XOAIN
CORE=4096K,USER=
PGM=XOASUP00,REGION=&CORE,PARM=(&USER)
.
additional DD statements
.
DD
SYSOUT=*,DCB=(RECFM=FBA,LRECL=133,BLKSIZE=1330)
DD
DDNAME=SYSIN
//XOAFBAT
//XOAF
PROC
EXEC
//UJLLIST
//XOAIN
DD
DD
CORE=4096K,USER=
PGM=XOASUP00,REGION=&CORE,PARM=(&USER)
.
additional DD statements
.
DSN=prefix.UJLLIST,DISP=SHR
DDNAME=SYSIN
If you specify a dataset name in the XOAF logon proc or batch JCL, you
must preallocate a sequential dataset with these specifications:
RECFM=FBA
LRECL=133
BLKSIZE=1330
Section Three: Managing Resources with XPAF
24-54
Managing XPAF tables
Figure 24-1. Sample color conversion table loader report
XEROX COLOR CONVERSION TABLE LOADER REPORT
PAGE
1
INPUT-DSN=XPAF30.XPFSAMP
INPUT-MEMBER=COLR4700
OUTPUT-DSN=XPAF30.TABLELIB
OUTPUT-TABLE=COLOR-CONV-4850-4700
/* BLACKS */
'K0'
: COLOR GRAY=0;
'WHITE'
: COLOR GRAY=0;
'K1'
: COLOR GRAY=0.06666;
'K3'
: COLOR GRAY=0.13333;
'K9'
: COLOR GRAY=0.20000;
'EXTREMELY LIGHT GRAY': COLOR GRAY=0.20000;
'K15'
: COLOR GRAY=0.26666;
'K23'
: COLOR GRAY=0.33333;
'DARK GRAY'
: COLOR GRAY=0.80000;
'K95'
: COLOR GRAY=0.86666;
'VERY DARK GRAY'
: COLOR GRAY=0.86666;
'K98'
: COLOR GRAY=0.93333;
'K100'
: COLOR GRAY=1.00000;
'BLACK'
: COLOR GRAY=1.00000;
/* CYAN */
'CYAN'
'TURQ'
'TURQUOISE'
: COLOR RGB=(-0.1458,0.3090,0.7985);
: COLOR RGB=(-0.1500,0.4450,0.7880);
: COLOR RGB=(-0.1500,0.4450,0.7880);
/* MAGENTA */
'MAGENTA'
'PINK'
: COLOR RGB=(0.83266,-0.039,0.4142);
: COLOR RGB=(0.83266,-0.039,0.4142);
/* OTHERS */
'BROWN'
'YELLOW'
'MUSTARD'
'ORANGE'
'PURPLE'
:
:
:
:
:
COLOR
COLOR
COLOR
COLOR
COLOR
RGB=(0.30000,0.0600,0.0170);
RGB=(1.05570,0.8865,-0.083);
RGB=(1.02000,0.7200,0.1600);
RGB=(0.95010,0.2511,0.0048);
RGB=(0.18000,-0.030,0.3940);
/* BLUES */
'B1K96'
: COLOR RGB=(0.07480,0.0779,0.0818);
'B2K20'
: COLOR RGB=(0.78521,0.7972,0.8006);
'B2K93'
: COLOR RGB=(0.08348,0.0922,0.1002);
'B3K75'
: COLOR RGB=(0.23677,0.2502,0.2625);
END;
UIL0701I COLOR CONVERSION TABLE LOADER COMPLETED SUCCESSFULLY
Section Three: Managing Resources with XPAF
24-55
Managing XPAF tables
Section Three: Managing Resources with XPAF
24-56
Managing custom fonts
25.
25
Managing custom fonts
This chapter describes how to make custom Xerox or custom replica fonts
(that is, fonts which were purchased from Xerox or a third-party vendor)
available to XPAF.
Using custom Xerox fonts
Before using Xerox fonts that were not provided with XPAF, you must use
various XOAF options to load the fonts and update the appropriate XPAF
font tables. To print documents prepared for a centralized printer on a
decentralized or PCL-capable printer or converted to PDF, you must load
both centralized and decentralized versions of the font to native libraries.
Follow this procedure to load custom Xerox fonts to native libraries.
Step 1.
Offload your existing font tables so that you have a backup. Refer to
chapter 27, “Managing XPAF libraries,” for instructions about offloading
members of a library.
Step 2.
Upload the fonts to a PDS or sequential dataset on the host. The dataset
can contain either centralized fonts or decentralized fonts; you cannot
store both types of fonts in the same dataset. Refer to Section Two:
Installing and Customizing XPAF for instructions about uploading
datasets.
Step 3.
Load the fonts from the PDS or sequential dataset to the native font library
using either the Load Centralized Fonts option or Load Decentralized
Fonts option on the Load Resources menu or the LOAD FONT TSO/batch
command.
When loading centralized fonts, the system automatically generates
entries to the XPAFXFI table; when loading decentralized fonts, you
optionally specify whether entries are generated to this table.
You can view and update the XPAFXFI table using the Maintain the Xerox
Font Information (XPAFXFI) Table option on the Maintain Font Tables
menu. Refer to chapter 24, “Managing XPAF tables,” for information about
how to use this option.
Section Three: Managing Resources with XPAF
25-1
Managing custom fonts
Step 4.
Create character mapping tables for each of the following using the
Maintain Character Mapping Tables option on the Maintain Font Tables
menu:
•
Centralized mapping which contains the character IDs and the ASCII
mapping values for the centralized font.
•
Decentralized mapping which contains the character IDs, plane
numbers, and the ASCII mapping values for the decentralized font.
•
Code page that contains the character IDs and the EBCDIC mapping
values. This table defines the characters that are available in the
font.
Be sure to use the same name for these tables that you used when you
loaded the font to the native font library.
Step 5.
Update the XPAFXFI table with information for the font using the Maintain
the Xerox Font Information (XPAFXFI) Table option on the Maintain Font
Tables menu. If the decentralized font name is different from the
centralized font name, enter the name in the ‘Decentralized Font Name’
field. You also can set up a different logical font name that allows you to
use the same font with a different code page.
Step 6.
If you do not have a decentralized version of the font, but want to use that
same font in documents printed on a decentralized or PCL-capable
printer, convert the centralized font using either the Convert Centralized
Fonts to Decentralized Fonts option on the Convert Resources menu or
the CONVERT XFONT TSO/batch command.
Using custom replica fonts
Before using custom replica fonts (that is, replica fonts which were not
provided with XPAF), you must use the options on the Manage Custom
Replica Fonts menu to load the fonts and update the appropriate XPAF
font tables.
Limitations and considerations
Review these limitations and considerations before adding custom replica
fonts to your XPAF system.
IBM resources
You cannot use the Manage Custom Replica Fonts menu options to add
Xerox fonts to XPAF to be used in the 240 dpi environment. You must
have the necessary IBM character sets and associated code pages.
To add Xerox fonts for which corresponding IBM resources do not exist,
refer to “Converting Xerox fonts to IBM format” in chapter 22, “Converting
resources.”
Section Three: Managing Resources with XPAF
25-2
Managing custom fonts
Font names
If you have acquired custom replica fonts from Xerox Font Services, a
third-party vendor, or a software utility, use this naming convention:
CUnnno
where
CUnnn A unique 5-character font name.
o
The orientation, either P, L, I, or J.
CAUTION: To avoid name conflicts with existing and future
XPAF-provided fonts, use CU as the first two characters for all
custom font names.
The 5-character font name limitation also applies to decentralized fonts.
Even though decentralized fonts can have 20-character font names, you
must adhere to this font naming convention because the XPAFAFW table
is keyed from the first 5 characters of the font name.
Truncation of fractional differences
Before you load custom fonts to a native font library, ensure that the
widths of the characters in the input dataset have been truncated rather
than rounded. At print time, your documents will contain lateral positioning
errors if the character widths are rounded.
When printing AFP documents, XPAF performs an error correction to
compensate for font truncation. It calculates the accumulated loss due to
truncation and adjusts for it by adding a pel as needed. Font rounding
causes the current position to be greater than expected, leading to
placement problems.
If you did not acquire your fonts from Xerox Font Services, check with your
typestroke vendor to verify that the fonts they generate are truncated.
Orientation
To use all four IBM orientations, you must create a separate font for each
orientation (landscape, portrait, inverse landscape, and inverse portrait).
Section Three: Managing Resources with XPAF
25-3
Managing custom fonts
Split fonts (version 5 encoding or below only)
Before you can load a custom font to XPAF, you must create a replica font
using ISO8859-1 mapping. ISO8859-1 mapping limits character data to
64K. Therefore, 18-point or larger fonts must be split over several planes.
For example, to add a 36-point font, you might use 3 planes (10, 20, and
30, where 1, 2, and 3 represent the split planes within plane 0).
If you add a new typeface that uses an existing character name, you must
adopt the split convention. If you add a character set that contains only
new characters, you do not need to use the split convention. When
creating the XPAFI2X table entry using the Maintain the IBM-to-Xerox
(XPAFI2X) Table option on the Install Custom Replica Fonts menu, use
your own mapping convention and specify a point size of zero (P00). The
point size value is used only to determine whether to use the split
convention.
Font widths (version 5 encoding or below only)
To use both centralized and decentralized fonts, you must be aware of
how the XPAFAFW table is generated and how it is used. This table
contains information from the font header that XPAF requires to correctly
position characters on the page. For example, XPAF requires the left and
right kerning values of the font to align italic fonts correctly.
When you load a centralized custom font, an XPAFAFW table entry is
automatically generated, and both left and right kerning values are
available. When you load a decentralized custom font, you can optionally
generate an XPAFAFW table entry.
NOTE: For both centralized and decentralized custom replica fonts
using version 5 encoding and below, the orientation specified by the
last character of the font name must match the orientation specified
by the ‘Orientation’ field in the Load Custom Replica Fonts option.
Otherwise, an XPAFAFW table entry will not be generated.
If you do not generate an XPAFAFW table entry, only the right kerning
value is available. XPAF requires both kerning values. To provide XPAF
with the required left and right kerning values, load a centralized version
of each custom replica font.
To produce a decentralized version of the font, use either the Convert
Centralized Fonts to Decentralized Fonts option on the Convert
Resources menu or the CONVERT XFONT TSO/batch command.
Section Three: Managing Resources with XPAF
25-4
Managing custom fonts
Selecting custom font support
To access the Manage Custom Replica Fonts menu, enter 5 on the
System Services menu OPTION line and press ENTER. This menu
appears:
Xerox Output Administrative Facility
Manage Custom Replica Fonts
OPTION ===>
1.
Install Custom Replica Fonts (version 5 encoding or below)
2.
Install Custom Replica Fonts (version 6 encoding or above)
Select the option you want to perform and press ENTER:
•
Enter 1 to load custom replica fonts using version 5 encoding or
below from a PDS or sequential dataset to a native library.
•
Enter 2 to load custom replica fonts using version 6 encoding or
above from a PDS or sequential dataset to a native library.
Section Three: Managing Resources with XPAF
25-5
Managing custom fonts
Installing custom replica fonts (version 5 encoding or below)
Select option 1 on the Manage Custom Replica Fonts menu if you are
installing custom replica fonts using version 5 encoding or below. Press
ENTER. This menu appears:
Xerox Output Administrative Facility
Install Custom Replica Fonts (version 5 encoding or below)
OPTION ===>
1.
Load Custom Replica Fonts
2.
Update the IPSTND Table (optional)
3.
Update the IBM-to-Xerox (XPAFI2X) Table (optional)
4.
Update IBM Font Characteristics Information
Use this menu to load the font to XPAF as you perform the following steps:
NOTE: For each font you load, you must have these two
corresponding AFP resources:
Appropriate character sets (C0xxxxxx)
Associated code pages (T1xxxxxx)
Step 1.
Obtain the replica font from Xerox Font Services or a third-party vendor.
This step is required to generate a custom replica of the IBM font you want
to use.
Step 2.
Upload the font from the delivery file into a PDS or a sequential dataset.
This dataset can contain either centralized fonts or decentralized fonts.
Refer to Section Two: Installing and Customizing XPAF for information
about uploading datasets.
NOTE: You cannot store both types of fonts in the same dataset.
Step 3.
Use the Load Custom Replica Fonts option on the Install Custom Replica
Fonts menu or the LOAD FONT TSO/batch command to load the font to
XPAF from a PDS or a sequential dataset into the appropriate native font
library. During the load process, an entry is made in the XPAFAFW table
to provide XPAF with font metrics information.
Section Three: Managing Resources with XPAF
25-6
Managing custom fonts
Step 4.
Use the Update the IPSTND Table option on the Install Custom Replica
Fonts menu to update the IPSTND table. The IPSTND table provided with
XPAF contains the character identifiers that are supported by XPAF.
If the font you are loading contains characters that are not included in the
standard IPSTND table, add the new characters to the table using this
option. This table reflects your site's variance from ISO8859-1.
To help prevent the possibility of corrupting existing font information, you
cannot update entries for the XPAF-supported character identifiers.
Step 5.
Use the Update the IBM-to-Xerox (XPAFI2X) option on the Install Custom
Replica Fonts menu to update the XPAFI2X table. This table links an IBM
font character set name to the corresponding custom replica font name(s).
This step is required only if you are adding a new character set or
modifying an existing replica font.
Step 6.
Use the either the Update IBM Font Characteristics Information option on
the Install Custom Replica Fonts menu or the CONVERT IBM TSO/batch
command to create IBM font characteristics for the custom replica font.
This step submits a batch job that generates entries for the IBM fonts to
these XPAF tables:
•
•
•
•
•
•
•
CPGID
FGID
XPAFCFN
XPAFEFW
XPAFIFW3
XPAFE2A
XPAFIFW
Section Three: Managing Resources with XPAF
25-7
Managing custom fonts
Loading custom replica fonts
To load custom replica fonts to a native library, enter 1 on the Install
Custom Replica Fonts menu OPTION line and press ENTER. This panel
appears:
Xerox Output Administrative Facility
Load Custom Replica Fonts
COMMAND ===>
Processing Mode (BG/FG):
INPUT
Dataset Name:
Member Name:
INPUT SPECIFICATIONS
Orientation (P/L/I/J):
Centralized or Decentralized Fonts (C/D):
OUTPUT
Dataset Name:
OUTPUT SPECIFICATIONS
Create XPAFAFW Table Entry? (Y/N):
Section Three: Managing Resources with XPAF
25-8
Managing custom fonts
Complete these fields and press ENTER:
Field
Processing Mode
Action
Specify the processing mode in which to load fonts.
Valid values:
BG
Loads the fonts in batch mode. The Load Custom Replica Fonts
batch job panel appears.
FG
Load the fonts in foreground.
NOTE: Loading a large number of fonts may take a significant amount of
time.
INPUT
Dataset Name
Enter the name of the PDS or sequential dataset that contains the fonts to be
loaded. This dataset must contain either centralized fonts or decentralized
fonts; you cannot mix font types in the same dataset. If you have multiple fonts
concatenated in a single file, they must be loaded from a sequential dataset
with valid headers. The dataset specifications are:
Centralized:
RECFM=F or FB
LRECL=128
BLKSIZE=A value appropriate for your site
Decentralized:
RECFM=F or FB
LRECL=80
BLKSIZE=A value appropriate for your site
Member Name
INPUT
SPECIFICATIONS
Orientation
•
Enter the 1- to 8-character member name if the font is stored in a PDS.
•
Enter an asterisk ( * ) to load all fonts in a PDS.
•
Leave this field blank if the font is stored in a sequential dataset.
Enter the font orientation. If the orientation specified by the last character of the
font name does not match the value for this field, an XPAFAFW table entry will
not be generated.
Valid values:
P
L
I
J
Portrait
Landscape
Inverse portrait
Inverse landscape
Default: L
Centralized or
Decentralized
Fonts?
Specify the type of fonts to be loaded.
Valid values:
C
D
Loads centralized fonts.
Loads decentralized fonts.
Section Three: Managing Resources with XPAF
25-9
Managing custom fonts
Field
Action
Dataset Name
Enter the name of the native centralized or decentralized font library to which
the fonts will be loaded. In the XOSF start-up proc, this is the dataset name in
the DD statement specified by the CFONTLIB or DFONTLIB initialization
parameter or the FONTLIB printer profile parameter.
OUTPUT
OUTPUT
SPECIFICATIONS
Create XPAFAFW
Table Entry?
If you are loading a decentralized font, indicate whether you want to generate
entries to the XPAFAFW table. If you are loading a centralized font, an
XPAFAFW table entry automatically will be generated; any entry in this field will
be ignored.
Valid values:
Y
Generates entries to the XPAFAFW table. Enter this value if you are
not loading the equivalent centralized version of this font.
N
Does not generate entries to the XPAFAFW table. Enter this value if
you have loaded or intend to load the equivalent centralized version of
this font.
Using background mode
When you load fonts in background mode, this panel appears:
Xerox Output Administrative Facility
Load Custom Replica Fonts
COMMAND ===>
DATASET PREFIX
XPFLOAD Library:
XINPARM Library:
Font Table Library:
JOB CARD INFORMATION
===> //JOBNAME JOB (ACCOUNT),'NAME' ,CLASS= ,MSGCLASS=
===> //*
===> //*
===> //*
Section Three: Managing Resources with XPAF
25-10
Managing custom fonts
Complete these fields:
Field
Action
DATASET PREFIX
Enter the high-level and mid-level qualifiers for your system load library.
XPFLOAD Library
XINPARM Library
Enter the high-level and mid-level qualifiers (if different from XPFLOAD) for the
library containing your initialization parameters.
Font Table Library
Enter the high-level and mid-level qualifiers (if different from XPFLOAD) for the
library in which the font tables are stored. In the XOSF start-up proc, this is the
dataset name in the DD statement specified by the FNTTBLDD initialization
parameter.
JOB CARD
INFORMATION
Enter site-specific job card information.
Press ENTER, and this panel appears:
Xerox Output Administrative Facility
Load Custom Replica Fonts
OPTION ===>
C.
Cancel JCL
E.
Edit JCL
K.
Keep JCL
S.
Submit JCL
Section Three: Managing Resources with XPAF
25-11
Managing custom fonts
Select the option you want to perform and press ENTER. Valid values are:
C
Cancels the generated JCL and returns to the initial Load Custom
Fonts to a Native Library panel.
E
Displays the generated JCL for editing purposes.
K
Keeps the generated JCL in a sequential dataset. After you save
the JCL, you can access this dataset and submit the job without
regenerating the JCL each time.
S
Submits the JCL. Standard TSO/ISPF JCL submission error or
confirmation messages are displayed.
NOTE: You cannot use the END command or the PF3 key to exit this
panel. If you want to return to the previous panel and do not want to
display, submit, or keep the JCL, you must enter C on the COMMAND
line and press ENTER.
Editing the JCL
If you enter E in the OPTION line on the JCL options panel, a panel
containing JCL similar to this appears:
//job-name JOB job-information
//*
//*
//*************************************************************/
//* CUSTOM REPLICA FONT LOADER - XOAJ0381
*/
//*************************************************************/
//*
//S1 EXEC PGM=XOASUP00,REGION=8192K,PARM=userid
//STEPLIB
DD DISP=SHR,
//
DSN=prefix.XPFLOAD
//SYSPRINT DD SYSOUT=X
//TABLELIB DD DISP=SHR,
//
DSN=prefix.font-table-library-name
//XINPARM
DD DISP=SHR,
//
DSN=prefix.XINPARM
//XOAPRINT DD SYSOUT=*,DCB=(LRECL=121,RECFM=FB,BLKSIZE=6050)
//XOAIN
DD *
LOA FONT('prefix.input-dataset-name') ('prefix.output-dataset-name')
TYPE(type) ORIEN(orientation)
/*
You can edit and save the JCL and cancel or submit the job using
standard TSO/ISPF commands.
Section Three: Managing Resources with XPAF
25-12
Managing custom fonts
Keeping the JCL
If you enter K in the OPTION line on the JCL options panel, this panel
appears:
Xerox Output Administrative Facility
Load Custom Replica Fonts
COMMAND ===>
* To keep the JCL, enter a new sequential dataset name.
Dataset Name:
Complete this field and press ENTER:
Field
Dataset Name
Action
Enter the name of the sequential dataset that is not currently cataloged. This is
the dataset in which your JCL will be stored.
To return to the previous panel, enter END and press ENTER.
TSO/Batch command
You can use this TSO/batch command as an alternative to the Load
Custom Replica Fonts option:


LOA D FON T('input-dataset-name[(  member-name  )]')
*




[TO]('output-dataset-name') TYP E(  REPL  )
 270R 



ORIEN( 



P 
L 
)
I 

J 
NOTE: Specify one of these options for TYPE:
•
•
REPL (for centralized replica fonts)
270R (for decentralized replica fonts, create an ASCII font widths
table entry)
Section Three: Managing Resources with XPAF
25-13
Managing custom fonts
Updating the IPSTND table (optional)
The IPSTND table shipped with XPAF contains the standard character set
supported by XPAF. If the fonts you are loading include new characters
that are not currently contained in the existing ISO8859-1 character set
supported by XPAF, you must add them to the IPSTND table. If the new
fonts do not contain new characters, you do not need to perform this step.
You can add or update custom replica font entries in this table. You
cannot update the entries for the XPAF-provided replica fonts. This
limitation reduces the possibility of corrupting existing font entries.
Using this option
To update the IPSTND table, enter 2 on the Install Custom Replica Fonts
menu OPTION line and press ENTER. This panel appears:
Xerox Output Administrative Facility
Update the IPSTND Table
COMMAND ===>
* On COMMAND line, enter 'U' to create or update an entry, or 'D' to
delete an existing entry.
* Leave COMMAND line blank to view an existing entry.
Character ID:
Plane Number:
ASCII Value:
On the COMMAND line, specify the function you want to perform. Valid
values are:
U
Create or update a table entry. You also must enter values
in all three fields to create or update an entry.
D
Delete a table entry. You also must enter values in all three
fields to delete an entry.
blank
Display an existing table entry. You also must enter a value
in the ‘Character ID’ field to display an entry.
Section Three: Managing Resources with XPAF
25-14
Managing custom fonts
Then complete these fields and press ENTER:
Field
Action
Character ID
Enter the 8-character IBM identifier for the character you are displaying,
creating, updating, or deleting.
Plane Number
Enter the number of the plane to which you are adding this character or where
the character is stored.
Valid values: A 2-character value between 0C and 0F.
NOTE: Planes 00 through 0B are reserved for future character support;
therefore, you must add your characters to planes 0C through 0F. This will
ensure that added characters will not be overwritten as new support is
added to the XPAF-supplied default table.
ASCII Value
Enter the 2-digit hexadecimal ASCII code that represents the character’s
position in the plane defined above.
Section Three: Managing Resources with XPAF
25-15
Managing custom fonts
Updating the XPAFI2X table (optional)
If you are loading a character set that is completely new to XPAF, you
must update the XPAFI2X table. The XPAFI2X table provides a link
between the IBM font character set name and its corresponding replica
font(s).
You can add or update entries for the custom replica fonts in the XPAFI2X
table. After an entry is made, XPAF verifies that the specified fonts
associated with the new character set have been loaded into the
appropriate font library. You cannot update the entries for the
XPAF-provided replica fonts.
Using this option
To update the XPAFI2X table, enter 3 on the Install Custom Replica Fonts
menu OPTION line and press ENTER. This panel appears:
Xerox Output Administrative Facility
Update the IBM-to-Xerox (XPAFI2X) Table
COMMAND ===>
* On COMMAND line, enter 'C' to create an entry, or 'D' to delete an
existing entry.
* Leave COMMAND line blank to view an existing entry.
Character Set Name:
You can add a new entry, update an entry, or delete an entry:
•
To create a new entry, use one of two methods:
—
Enter C on the COMMAND line, a unique name in the ‘Character
Set Name’ field, and press ENTER.
—
Leave the COMMAND line blank and, in the ‘Character Set
Name’ field, enter the name of an existing character set that you
want to use as a model for the new character set you are
creating. Press ENTER.
•
To delete an existing entry, enter D on the COMMAND line and the
character set name in the ‘Character Set Name’ field. Press ENTER.
•
To update an existing entry, enter the character set name in the
‘Character Set Name’ field and press ENTER. To display a list of
members, leave this field and the COMMAND line blank, and press
ENTER.
Section Three: Managing Resources with XPAF
25-16
Managing custom fonts
If you leave the ‘Character Set Name’ field blank, a member selection
panel similar to this appears:
Xerox Output Administrative Facility
Selection List of Font Table Members
COMMAND ===>
* Next to name, enter 'S' to select a member.
A055A0
A055B0
A055D0
A055F0
A055H0
A055J0
To select a character set name from this list, tab to the field next to the
character set name, enter S, and press ENTER.
When you enter a character set name on the Update the IBM-to-Xerox
(XPAFI2X) Table panel or select a character set from the Selection List of
Font Table Members panel, a panel similar to this appears:
Xerox Output Administrative Facility
Update the IBM-to-Xerox (XPAFI2X) Table
COMMAND ===>
* On COMMAND line, enter 'U' to create or update an entry.
IBM Character Set Name: A055A0
Replica Font Point Size: P11
NO.
1
2
3
4
5
6
7
8
9
10
NO.
11
12
13
14
15
16
17
18
19
20
FONT NAME
XAR80
XAR81
XAR82
XAR83
XAR84
PLANE
00
01
02
03
04
Section Three: Managing Resources with XPAF
FONT NAME
PLANE
25-17
Managing custom fonts
If you are creating a new table, the panel is blank with the exception of the
IBM character set name. If you are displaying an existing table, the
information for the character set is displayed.
•
To update the table, enter U in the COMMAND line and type over the
existing entries with the new information. Do not change the IBM
character set name.
•
To create a new table from an existing one, first type over the
existing entries with the new information. Then enter U in the
COMMAND line and a new name in the ‘IBM Character Set Name’
field.
Complete these fields and press ENTER:
Field/Column
Action
IBM Character Set
Name
Enter the name of the IBM character set you are updating. This is the name of
the IBM font as found in the IBM system font library, excluding the Cn prefix.
Replica Font
Point Size
Enter the point size of the custom replica font in the format Pnn, where nn is the
point size. For a character set that has only new characters, use a point size of
zero (P00).
FONT NAME
Enter the 1- to 5-character name of the custom replica font. Do not include a
suffix to indicate the font orientation. You can enter up to 20 replica fonts for a
single IBM character set name.
PLANE
Enter a 2-character value specifying the plane where the custom replica font is
stored. The first character represents the split plane to which split fonts are
loaded. The second character identifies the plane. For example, to add a
custom replica font to plane C, enter 0C.
If you are not entering a split plane font, the first character must be a zero.
NOTE: Planes 00 through 4B are reserved for Xerox use.
Section Three: Managing Resources with XPAF
25-18
Managing custom fonts
Updating IBM font characteristics information
Use this option to submit a batch job that creates entries to the font tables
containing IBM font information required by XPAF. The batch job creates
entries for these font tables:
•
•
•
•
•
•
•
CPGID
FGID
XPAFCFN
XPAFEFW
XPAFE2A
XPAFIFW
XPAFIFW3
The font tables are built by RJOB105 during resource installation. Use this
option to rebuild the tables if you change the code page assigned to a font
or if you add new IBM fonts.
Submit a job for each library included in the IBM font library concatenation
in your XOSF start-up proc. Execute the jobs in the reverse order of the
library concatenation (that is, the first library included must be the last
converted). Because the table entries created by this option replace any
duplicate entries already present in the font tables, this procedure
ensures that the table entries created for the first library in your
concatenation are not overwritten.
Section Three: Managing Resources with XPAF
25-19
Managing custom fonts
Using this option
To update IBM font characteristics information in the appropriate font
tables, enter 4 on the Install Custom Replica Fonts menu OPTION line
and press ENTER. This panel appears:
Xerox Output Administrative Facility
Update IBM Font Characteristics Information
COMMAND ===>
IBM FONT LIBRARY
Dataset Name:
DATASET PREFIX
XPFLOAD Library:
XINPARM Library:
Font Table Library:
JOB CARD INFORMATION
===> //JOBNAME JOB (ACCOUNT),'NAME' ,CLASS= ,MSGCLASS=
===> //*
===> //*
===> //*
Complete these fields:
Field
IBM FONT LIBRARY
Dataset Name
Action
Enter the name of the IBM font library dataset, including the high-level qualifier.
In the XOSF start-up proc, this is the dataset name in the DD statement
specified by the IBMFONTDD initialization parameter.
Be sure to enclose the dataset name in single quotation marks.
DATASET PREFIX
Enter the high-level and mid-level qualifiers for your system load library.
XPFLOAD Library
XINPARM Library
Enter the high-level and mid-level qualifiers (if different from XPFLOAD) for the
library containing your initialization parameters.
Section Three: Managing Resources with XPAF
25-20
Managing custom fonts
Field
Action
Font Table Library
JOB CARD
INFORMATION
Enter the high-level and mid-level qualifiers (if different from XPFLOAD) for the
library in which the font tables are stored. In the XOSF start-up proc, this is the
dataset name in the DD statement specified by the FNTTBLDD initialization
parameter.
Enter site-specific job card information.
Press ENTER, and this panel appears:
Xerox Output Administrative Facility
Update IBM Font Characteristics Information
OPTION ===>
C.
Cancel JCL
E.
Edit JCL
K.
Keep JCL
S.
Submit JCL
Select the option you want to perform and press ENTER. Valid values are:
C
Cancels the generated JCL and returns to the initial Update IBM
Font Characteristics panel.
E
Displays the generated JCL for editing purposes.
K
Keeps the generated JCL in a sequential dataset. After you save
the JCL, you can access this dataset and submit the job without
regenerating the JCL each time.
S
Submits the JCL. Standard TSO/ISPF JCL submission error or
confirmation messages are displayed.
NOTE: You cannot use the END command or the PF3 key to exit this
panel. If you want to return to the previous panel and do not want to
display, submit, or keep the JCL, you must enter C on the COMMAND
line and press ENTER.
Section Three: Managing Resources with XPAF
25-21
Managing custom fonts
Editing the JCL
If you enter E in the OPTION line on the JCL options panel, a panel
containing JCL similar to this appears:
//job-name JOB job-information
//*
//**************************************************************/
//* CREATE IBM FONT CHARACTERISTICS - XOAJ0360
*/
//**************************************************************/
//*
//S1 EXEC PGM=XOASUP00,REGION=8192K,PARM=userid
//STEPLIB
DD DISP=SHR,
//
DSN=prefix.XPFLOAD
//SYSPRINT DD SYSOUT=X
//TABLELIB DD DISP=SHR,
//
DSN=prefix.font-table-library-name
//XINPARM
DD DISP=SHR,
//
DSN=prefix.XINPARM
//XOAPRINT DD SYSOUT=*,DCB=(LRECL=121,RECFM=FB,BLKSIZE=6050)
//XOAIN
DD *
CONVERT IBM('ibm-font-library-dataset-name')
/*
You can edit and save the JCL and cancel or submit the job by using
standard TSO/ISPF commands.
Keeping the JCL
If you enter K in the OPTION line on the JCL options panel, this panel
appears:
Xerox Output Administrative Facility
Update IBM Font Characteristics Information
COMMAND ===>
* To keep the JCL, enter a new sequential dataset name.
Dataset Name:
Section Three: Managing Resources with XPAF
25-22
Managing custom fonts
Complete this field and press ENTER:
Field
Dataset Name
Action
Enter the name of the sequential dataset that is not currently cataloged. This is
the dataset in which your JCL will be stored.
To return to the previous panel, enter END and press ENTER.
TSO/Batch command
You can use this TSO/batch command as an alternative to using the
Update IBM Font Characteristics Information option:
CON VERT IBM('ibm-font-library-dataset-name')
Example
This example illustrates the procedure for adding a custom replica font to
XPAF. The example is based on these assumptions:
•
X0MKSIG1 is the IBM coded font that you want to use with XPAF.
•
X0MKSIG1 points to character set C0CSSIG1 and code page
T1SIG1.
•
C0CSSIG1 contains the raster patterns and related information that
define two character s SIGMK001 and SIGMK002.
•
T1SIG1 maps SIGMK001 and SIGMK002 to the EBCDIC code points
X'C1' and X'C2'.
•
X0MKSIG1 is currently used in DCF to add a signature to memos, as
illustrated by these DCF commands in the DCF source:
.
.
.df sig1 font X0MKSIG1 [df = define font, define a font to DCF with a DCF name of SIG1]
.bf sig1
[bf = begin font, tells DCF to start using the font defined as SIG1]
AB
["A" = X'C1' and "B" = X'C2']
.pf
[pf = previous font, tells DCF to restore the previous font]
.
.
•
The point size is 14.
•
Four custom replica fonts are created, one for each rotation:
CMKSGI, CMKSGJ, CMKSGL, and CMKSGP.
NOTE: The sixth character of the font name identifies the
character rotation.
Section Three: Managing Resources with XPAF
25-23
Managing custom fonts
Follow this procedure to load this font:
Step 1.
To use X0MKSIG1 with XPAF, first obtain a custom replica font that
contains the new characters (SIGMK001 and SIGMK002). You can obtain
a custom replica font from Xerox Font Services or a third-party vendor.
During font conversion, the two new characters (SIGMK001 and
SIGMK002) are converted and placed in CMKSGI, CMKSGJ, CMKSGL,
and CMKSGP in positions X'41' and X'42', respectively. It is your
responsibility to instruct Xerox Font Services or the third-party vendor
which positions to use for the new characters.
Step 2.
After you receive the custom replica fonts from your vendor, you are ready
to add them to XPAF. Begin by offloading the font table dataset so you
have a backup.
Step 3.
Upload the fonts to a PDS or a sequential dataset on the host. This
dataset can contain either centralized fonts or decentralized fonts; you
cannot store both types of fonts in the same dataset. This example
assumes that CMKSGI, CMKSGJ, CMKSGL, and CMKSGP are
centralized fonts.
Step 4.
Use the Load Custom Replica Fonts option on the Install Custom Replica
Fonts menu to load the fonts into the native centralized font library. This
step generates an XPAFAFW table entry, which makes the custom replica
fonts’ characteristics available to XPAF.
You can browse the XPAFAFW table to ensure that the new entries have
been correctly created.
Step 5.
Use the Update the IPSTND Table option on the Install Custom Replica
Fonts menu to add character mapping entries for the two new characters
(SIGMK001 and SIGMK002). The sample shown here illustrates the type
of entries you must make on this panel:
Character ID: SIGMK001
Plane Number: 0F
ASCII Value: 41
Step 6.
Use the Update the IBM-to-Xerox (XPAFI2X) Table option on the Install
Custom Replica Fonts menu to create an entry to indicate that CMKSG is
related to IBM character set C0CSSIG1. The sample shown here
illustrates the type of entries you must make on this panel:
IBM Character Set Name: CSSIG1
NO. FONT NAME
1
CMKSG
2
PLANE
0F
Replica Font Point Size: P14
NO.
11
12
FONT NAME PLANE
Omit the sixth character of the font name (the rotation).
Section Three: Managing Resources with XPAF
25-24
Managing custom fonts
Step 7.
Use the Update IBM Font Characteristics Information option on the Install
Custom Replica Fonts menu to generate and then submit the JCL to
extract the necessary information from the IBM font library and create
entries to these tables:
•
•
•
•
•
•
•
CPGID
FGID
XPAFCFN
XPAFEFW
XPAFE2A
XPAFIFW
XPAFIFW3
After the job completes successfully, you can begin using font X0MKSIG1
in documents that are printed through XPAF.
Section Three: Managing Resources with XPAF
25-25
Managing custom fonts
Installing custom replica fonts (version 6 encoding or
above)
Select option 2 on the Manage Custom Replica Fonts menu to install
custom replica fonts using version 6 encoding or above. This option loads
the specified fonts into the appropriate native font library and generates
entries to these tables:
•
•
•
•
•
•
•
•
•
•
CPGID
FGID
IPSTND
XPAFAFW
XPAFCFN
XPAFEFW
XPAFE2A
XPAFIFW
XPAFIFW3
XPAFI2X
If you have already uploaded the fonts from file to a PDS or sequential
dataset on the host, you can use this option to install your custom fonts
from disk. Otherwise, you can use this option to install the fonts directly
from file.
Custom replica font distribution file
Xerox Font Services distributes custom replica fonts (version 6 encoding
or above) on a file containing these three files:
Table 25-1.
Version 6 encoding or above file files for custom fonts
File
Function
File 1 (FNTFILE)
Contains the centralized or decentralized fonts to be
installed.
File 2 (I2XFILE)
Identifies the IBM character set you are updating, the
replica font(s) corresponding to the IBM character set,
and the point size(s) of the custom replica font(s). The
information in this file is used to update the XPAFI2X
table.
File 3 (CD#FILE)
Identifies the character identifiers (CHARIDs) for this
character set. The information in this file is used to
update the IPSTND table if the font contains character
identifiers that are not already in the table.
Section Three: Managing Resources with XPAF
25-26
Managing custom fonts
Font library space requirements
Before you use this option, use the following guidelines to determine the
amount of space required in the native font libraries to load custom replica
fonts successfully.
On average, centralized fonts require about four blocks of storage per
font, and decentralized fonts require about five blocks of storage per font.
However, a font can require as much as 18 blocks of storage.
To calculate the approximate space required for a font, multiply the file
block size by the number of blocks in the font, then divide by the record
size used to define the native font library. Increase the value by 15% to
handle variations within the fonts. Add the final amount to the REC value
in the JCL used to allocate the native library.
For example, if the decentralized font Z2Y8AP has a block size of 80, the
decentralized font library is defined with a record size of 4089, and there
are 107 blocks in the font, then:
80 x 107 = 8560
8560 / 4089 = 2.10
2.10 x .15 = 0.32
2.10 + 0.32 = 2.42, which rounds up to a value of 3
Therefore, you will need 3 free records in the decentralized font library
dataset. Refer to Section Two: Installing and Customizing XPAF for more
information on determining the size of and expanding native libraries.
Section Three: Managing Resources with XPAF
25-27
Managing custom fonts
Using this option
To install custom replica fonts (version 6 encoding or above), enter 2 on
the Manage Custom Replica Fonts menu OPTION line and press ENTER.
This panel appears:
Xerox Output Administrative Facility
Install Custom Replica Fonts (version 6 encoding or above)
COMMAND ===>
Font Name(s):
Centralized Font (Y/N):
INSTALL INPUT FROM DISK
Font Dataset Name:
XPAFI2X Table Dataset Name:
Character Map Dataset Name:
INSTALL INPUT FROM file
Storage Unit:
VOLSER:
OUTPUT
Native Font Library Name:
Message Dataset Name:
IBM Font Library Name:
You must complete the ‘Font Name(s)’ and ‘Centralized Font’ fields
whether you are installing your fonts from file or disk. Then complete
either the section for disk or file, but not both.
•
If you install your custom fonts from disk, enter the names of the
font, XPAFI2X table, and character mapping datasets, and omit the
unit and volume serial number.
•
If you install your custom fonts from file, you must specify the unit
and volume serial number for the file. Do not enter values for the
font, XPAFI2X table, and character mapping datasets. XOAF will
automatically locate the files on the file.
CAUTION: Depending on the number of fonts on your custom font
distribution file, installing custom replica fonts using this option can
be a lengthy process. While the fonts are being installed, you cannot
print documents though XPAF. Therefore, you should schedule your
custom font installation for a time when print jobs are not run.
Section Three: Managing Resources with XPAF
25-28
Managing custom fonts
Complete these fields:
Field
Font Name(s)
Centralized Font
Action
Enter the name of the font(s) to be loaded. You can enter a specific font name
in this field, or use a wildcard character to select all fonts or fonts beginning with
a specified prefix. For example:
*
Selects all fonts.
AF*
Selects fonts beginning with AF.
AF1?JP
Selects fonts that begin with AF1, end with JP, and have one
character between AF1 and JP.
AF18JP
Selects the single font AF18JP.
Indicate whether you are loading centralized or decentralized fonts.
Valid values:
Y
N
Loads centralized fonts.
Loads decentralized fonts.
NOTE: If you are installing both centralized and decentralized versions of
a custom replica font, you must install the decentralized version BEFORE
the centralized version to ensure that the correct font widths information is
made available to XPAF.
INSTALL INPUT FROM
DISK
Font Dataset
Name
Enter the name of the PDS or sequential dataset that contains the fonts to be
loaded. This dataset must contain either centralized fonts or decentralized
fonts; you cannot mix font types within a dataset. If you have multiple fonts
concatenated in a single file, they must be loaded from a sequential dataset
with valid headers. The dataset specifications are:
Centralized:
RECFM=FB
LRECL=128
BLKSIZE=A value appropriate for your site
Decentralized:
RECFM=FB
LRECL=80
BLKSI ZE=A value appropriate for your site
XPAFI2X Table
Dataset Name
Enter the name of the sequential dataset that contains the XPAFI2X table
entries. The dataset specifications are:
RECFM=FB
LRECL=168
BLKSIZE=A value appropriate for your site
Section Three: Managing Resources with XPAF
25-29
Managing custom fonts
Field
Character Map
Dataset Name
Action
•
Enter the name of the sequential dataset that contains the character
mapping table entries. The dataset specifications are:
RECFM=FB
LRECL=12
BLKSIZE=A value appropriate for your site
•
INSTALL INPUT FROM
file
Leave this field blank if there are no new character IDs to be added to the
IPSTND table.
Enter the unit for the device on which the files from the file will be read.
Storage Unit
VOLSER
Enter the 6-character volume serial number of the file that contains the fonts to
be installed. This name is displayed at the system operator console to identify
the file to be mounted. Because custom font files are non-labeled, this field is
optional.
Examples:
C6X034
FONTS1
XPAFNT
Default: FONTAP
OUTPUT
Native Font
Library Name
Enter the name of the native centralized or decentralized font library to which
the fonts will be loaded. In the XOSF start-up proc, this is the dataset in the DD
statement specified by the CFONTLIB or DFONTLIB initialization parameter or
the FONTLIB printer profile parameter.
For each font loaded, the member name is constructed from the name in the
font header.
Message Dataset
Name
Enter the name of the sequential dataset to which you want custom font
installation-related messages to be written. The dataset specifications are:
RECFM=FB
LRECL=133
BLKSIZE=A value appropriate for your site
Do not specify the XOAF log dataset. Refer to Section Six: XPAF Messages for
an explanation of custom font installation-related messages and any required
user actions.
Section Three: Managing Resources with XPAF
25-30
Managing custom fonts
Field
Action
IBM Font Library
Name
Enter the name of the library that contains the IBM fonts. This is the dataset
identified by the IBMFONT DD statement in the XOSF start-up proc. Verify that
the IBM fonts have already been loaded into this library before you install
custom replica fonts.
Information from the IBM font library is used to generate entries to these font
tables:
•
•
•
•
•
•
•
CPGID
FGID
XPAFCFN
XPAFEFW
XPAFE2A
XPAFIFW
XPAFIFW3
These tables make the IBM fonts’ characteristics available to XPAF.
After you complete your entries on the Install Custom Fonts panel, press
ENTER. This panel appears:
Xerox Output Administrative Facility
Install Custom Replica Fonts (version 6 encoding or above)
COMMAND ===>
DATASET PREFIX
XPFLOAD Library:
XINPARM Library:
Font Table Library:
JOB CARD INFORMATION
===> //JOBNAME JOB (ACCOUNT),'NAME',CLASS=A
===> //*
===> //*
===> //*
The dataset prefixes you enter on this panel are used when generating
the custom font installation JCL.
Section Three: Managing Resources with XPAF
25-31
Managing custom fonts
Complete these fields and press ENTER:
Field
Action
DATASET PREFIX
Enter the high-level and mid-level qualifiers for your system load library.
XPFLOAD Library
XINPARM Library
Enter the high-level and mid-level qualifiers (if different from XPFLOAD) for the
library containing your initialization parameters. This is the dataset identified by
the XINPARM DD statement in the XOSF start-up proc.
Font Table Library
Enter the high-level and mid-level qualifiers (if different from XPFLOAD) for the
library in which the font tables are stored. In the XOSF start-up proc, this is the
dataset name in the DD statement specified by the FNTTBLDD initialization
parameter.
JOB CARD
INFORMATION
Enter site-specific job card information.
After you verify the information and press ENTER, this panel appears:
Xerox Output Administrative Facility
Install Custom Replica Fonts (version 6 encoding or above)
OPTION ===>
C.
Cancel JCL
E.
Edit JCL
K.
Keep JCL
S.
Submit JCL
Section Three: Managing Resources with XPAF
25-32
Managing custom fonts
Select the option you want to perform and press ENTER. Valid values are:
C
Cancels the generated JCL and returns to the Install Custom
Fonts batch job card panel.
E
Displays the generated JCL for editing purposes.
K
Keeps the generated JCL in a sequential dataset. After you save
the JCL, you can access this dataset and submit the job without
regenerating the JCL each time.
S
Submits the JCL. Standard TSO/ISPF JCL submission error or
confirmation messages are displayed.
NOTE: You cannot use the END command or the PF3 key to exit this
panel. If you want to return to the previous panel and do not want to
display, submit, or keep the JCL, you must enter C on the COMMAND
line and press ENTER.
Section Three: Managing Resources with XPAF
25-33
Managing custom fonts
Editing the JCL
If you enter E in the OPTION line on the JCL options panel, a panel
containing JCL similar to this appears (this panel contains dataset names
that were generated based on the entries you made on the previous
panels):
//job-name JOB job-information
//*
//*
//*
//***************************************************************
//* You are installing Xerox DECENTRALIZED fonts from DISK.
//* Ensure you are installing to a DECENTRALIZED library.
//* Centralized and Decentralized fonts must not be mixed.
//* Selection criteria: (*)
//***************************************************************
//STEP1
EXEC PGM=XOASUP00,REGION=8192K,PARM=userid
//STEPLIB DD DISP=SHR,DSN=prefix.XPFLOAD
//SYSPRINT DD SYSOUT=X
//XINPARM DD DISP=SHR,DSN=prefix.XINPARM
//TABLELIB DD DISP=SHR,DSN=prefix.font-table-library-name
//XOAPRINT DD SYSOUT=*,DCB=(LRECL=121,RECFM=FB,BLKSIZE=6050)
//FNTFILE DD DISP=SHR,DSN=font-dataset-name
//I2XFILE DD DISP=SHR,DSN=xpafi2x-table-dataset-name
//CD#FILE DD DISP=SHR,DSN=character-mapping-dataset-name
//XOAIN
DD *
INSTALL FONTS (*,XCCM5,XFONT,XCP12,N,)
(native-font-library-name)
(message-dataset-name)
/*
//STEP2
EXEC PGM=XOASUP00,REGION=8M,PARM=(userid),COND=(4,LT)
//STEPLIB DD DISP=SHR,DSN=prefix.XPFLOAD
//SYSPRINT DD SYSOUT=X
//XINPARM DD DISP=SHR,DSN=prefix.XINPARM
//TABLELIB DD DISP=SHR,DSN=prefix.font-table-library-name
//XOAPRINT DD SYSOUT=*,DCB=(LRECL=121,RECFM=FB,BLKSIZE=6050)
//XOAIN
DD *
CONVERT IBM('ibm-font-library-name')
/*
Section Three: Managing Resources with XPAF
25-34
Managing custom fonts
Keeping the JCL
If you enter K in the OPTION line on the JCL options panel, this panel
appears:
Xerox Output Administrative Facility
Install Custom Replica Fonts (version 6 encoding or above)
COMMAND ===>
* To keep the JCL, enter a new sequential dataset name.
Dataset Name:
Complete this field and press ENTER:
Field
Dataset Name
Action
Enter the name of the sequential dataset that is not currently cataloged. This is
the dataset in which your JCL will be stored.
To return to the previous panel, enter END and press ENTER.
TSO/Batch command
You should access the INSTALL FONTS batch command only through the
JCL generated by the XOAF option to ensure that the proper datasets are
defined and that the JCL is set up correctly.
Section Three: Managing Resources with XPAF
25-35
Managing custom fonts
Section Three: Managing Resources with XPAF
25-36
Displaying printer status information
26.
26
Displaying printer status information
Displaying the status of printers
To display printer status, enter 1 on the Display Printer Status menu
OPTION line. Press ENTER. A panel similar to this appears:
Xerox Output Administrative Facility
Display the Status of PDS(s) and Printers
COMMAND ===> NEXT
SCROLL===>
Address Space (Job) Name: XP92
PRINTERS
PRT1182
PRT1900
Display Number:
1 of
1
10
The following fields appear on the Display the Status of PDS(s) and
Printers panel. Use the COMMAND line in conjunction with the ‘SCROLL’
field to move between address spaces.
Field
COMMAND
Action
Enter a value to scroll through the display.
Valid values:
NEXT
Pages forward through the XOSF address spaces.
BACK
Pages backward through address spaces.
END
Terminates the display.
Field
SCROLL
Action
Enter a value to scroll through the display.
Valid values:
MAX
Pages to the beginning or end of an address space.
integer Pages a specific number of address spaces forward or backward.
Default: 1
Section Three: Managing Resources with XPAF
26-1
Displaying printer status information
Address Space (Job)
Name
Displays the job name for the address space.
Display Number of
Displays the current and maximum available address spaces. For example, 3
of 15 means that this is the third address space being displayed of a possible
15.
PRINTERS
Displays the status of all printers assigned to this address space. If a printer is
active, the job number is displayed. Printers that have been drained do not
appear on the display.
TSO/Batch command
You can use this TSO/batch command as an alternative to using the
Display Printers option:
DIS PLAY
P RINTERS
Section Three: Managing Resources with XPAF
26-2
Managing XPAF libraries
27.
27
Managing XPAF libraries
This chapter describes how to use the options available on the Manage
Libraries menu. These options enable you to perform these functions:
•
Display a list of members of a PDS or native library and browse,
delete, or offload members on the list
•
Browse a member of a PDS or native library
•
Delete a member of a PDS or native library
•
Reload a member to a native library
Displaying a directory of library members
Enter 1 on the Manage Libraries menu OPTION line and press ENTER.
This panel appears:
Xerox Output Administrative Facility
Display a Directory of Library Members
COMMAND ===>
Dataset Name:
Complete this field:
Field
Dataset Name
Action
Enter the dataset name of the library for which you want to list members. The
dataset can be either a PDS or a native library.
Section Three: Managing Resources with XPAF
27-1
Managing XPAF libraries
After you complete the dataset name, press ENTER. A panel similar to
this appears:
Xerox Output Administrative Facility
Selection List of Library Members
COMMAND ===>
Library Name:
XPAF30.TESTING.PDLLIB
Library
Blocks:
* Next to name, enter 'B' to browse, 'D' to delete,
|
v NAME
CREATE DATE/TIME UPDATE
$GLOB$.FMT1 .PDE
1996.081 15:47:25
1996.081
$GLOB$.FMT1A .PDE
1996.081 15:47:27
1996.081
$GLOB$.FMT10 .PDE
1996.081 15:47:26
1996.081
$GLOB$.FMT10A.PDE
1996.081 15:47:28
1996.081
$GLOB$.FMT10B.PDE
1996.081 15:47:26
1996.081
$GLOB$.FMT11 .PDE
1996.081 15:47:26
1996.081
$GLOB$.FMT11A.PDE
1996.081 15:47:28
1996.081
$GLOB$.FMT12 .PDE
1996.081 15:47:27
1996.081
$GLOB$.FMT13 .PDE
1996.081 15:47:27
1996.081
$GLOB$.FMT2 .PDE
1996.081 15:47:26
1996.081
$GLOB$.FMT2A .PDE
1996.081 15:47:27
1996.081
$GLOB$.FMT3 .PDE
1996.081 15:47:26
1996.081
$GLOB$.FMT3A .PDE
1996.081 15:47:27
1996.081
$GLOB$.FMT4 .PDE
1996.081 15:47:26
1996.081
SCROLL ===> PAGE
Total Used Avail
360
210
150
or 'O' to offload.
DATE/TIME
15:47:25
15:47:27
15:47:26
15:47:28
15:47:26
15:47:26
15:47:28
15:47:27
15:47:27
15:47:26
15:47:27
15:47:26
15:47:27
15:47:26
RECORDS
3
3
3
3
3
3
3
3
3
3
3
3
3
3
DIRLEN
0
0
0
0
0
0
0
0
0
0
0
0
0
0
Use this panel to perform the following functions:
•
To browse a member, enter B (browse) next to the name of the
member you want to browse. Then press ENTER.
•
To delete a member, enter D next to the name of the member you
want to delete. Then press ENTER.
NOTE: If you try to delete a member of a resource library using
this option, XPAF will not allow the member to be deleted if the
printer FSS is active.
•
To offload a member, enter O next to the name of the member you
want to offload. Then press ENTER. The offloaded member will be
placed in the userid.XLDWORK.OFFLOAD dataset. To offload more
than one member at a time, enter O next to the names of the
members that you want to offload. Then press ENTER.
Section Three: Managing Resources with XPAF
27-2
Managing XPAF libraries
When using this option, members are offloaded without user directory
information. Check the value under the ‘DIRLEN’ column and verify
that the resource will function correctly without the user directory
information. If unusable resources are produced, use the LDM batch
offload/reload process as an alternative.
NOTE: When offloading a native library member to a PDS
library, XOAF may change the member name to a valid PDS
member name. A message with the resulting PDS member
name is issued indicating a successful offload. If you intend to
reload the PDS member, note the altered member name given in
the offload message. You will need to use this altered name as
well as the original native library member name during the
reload process.
After completing the desired functions, enter END and press ENTER to
return to the display of the directory of members in that library.
TSO/Batch command
You can use this TSO/batch command as an alternative to using the
Display a Directory of Library Members option:
LIB RARY DIR ECTORY('library-dataset-name')
NOTE: This command only lists the contents of the library; you
cannot use this command to browse, delete, or offload library
members.
Section Three: Managing Resources with XPAF
27-3
Managing XPAF libraries
Browsing a copy of a member
Enter 2 on the Manage Libraries menu OPTION line and press ENTER.
This panel appears:
Xerox Output Administrative Facility
Browse a Member
COMMAND ===>
Dataset Name:
Member Name:
Complete these fields and press ENTER:
Field
Action
Dataset Name
Enter the name of the dataset in which the member you want to browse resides.
Member Name
Enter the name of the member you want to browse.
An ISPF browse panel similar to this is displayed:
-------------------------------------------------------------------BROWSE
XPAF.XLDWORK
Line 00000000 Col 001 080
Command ===>
Scroll ===> PAGE
************************** Top of Data ********************************
DSN=library-name LIST=member-name
member-name
.j.?.....l.................
/* ****************************************************** */
/* *********
V F U 'S
********** */
/* ****************************************************** */
VFU1:
VFU
ASSIGN=(1,1),
TOF=1,
BOF=255;
/* ****************************************************** */
/* *********
P D E 'S
********** */
/* ****************************************************** */
FONTS=L0112B,
BEGIN=(.18,.66);
************************** Bottom of Data ***************************
Input is not allowed. Standard ISPF browse options, such as scroll
forward and backward, are available. To exit this panel and return to the
previous panel, enter END and press ENTER.
Section Three: Managing Resources with XPAF
27-4
Managing XPAF libraries
TSO/Batch command
You can use this TSO/batch command as an alternative to using the
Browse a Member option:
LIB RARY DIS PLAY('library-dataset-name(member-name)')


HEX(  OFF  )
 ON 
NOTE: In the XPAF PDLLIB, each member name may be padded with
space characters to the right of the double entry name. If you do not
include the complete member name in the TSO/batch command,
XOAF will be unable to locate the member. For more information
about PDL member names, refer to chapter 21, “Loading resources
to a native library.”
Section Three: Managing Resources with XPAF
27-5
Managing XPAF libraries
Deleting a member
Enter 3 on the Manage Libraries menu OPTION line and press ENTER.
This panel appears:
Xerox Output Administrative Facility
Delete a Member
COMMAND ===>
Dataset Name:
Member Name:
Complete these fields and press ENTER:
Field
Action
Dataset Name
Enter the name of the dataset in which the member you want to delete resides.
Member Name
Enter the name of the member you want to delete.
NOTE: If you try to delete a member of a resource library using this
option, XPAF will not allow the member to be deleted if the printer
FSS is active.
TSO/Batch command
You can use this TSO/batch command as an alternative to using the
Delete a Member option:
LIB RARY DEL ETE('library-dataset-name(member-name)')
Section Three: Managing Resources with XPAF
27-6
Managing XPAF libraries
Reloading a member to a native library
Enter 4 on the Manage Libraries menu OPTION line and press ENTER.
This panel appears:
Xerox Output Administrative Facility
Reload a Member to a Native Library
COMMAND ===>
INPUT
Dataset Name:
Member Name:
OUTPUT
Dataset Name:
Member Name:
Complete these fields and press ENTER:
Field
INPUT
Action
Enter the name of the PDS from which the resource is being loaded.
Dataset Name
Member Name
Enter the name of the PDS member to be loaded.
NOTE: When you offloaded a native library member to a PDS library, XOAF
may have changed the member name to make it a valid PDS member
name. If this is the case, enter the altered member name here.
OUTPUT
Enter the name of the native library to which the resource will be loaded.
Dataset Name
Member Name
Enter a name only if it is different than the input PDS member.
NOTE: When you offloaded a native library member to a PDS library, XOAF
may have changed the member name to make it a valid PDS member
name. If this is the case, enter the original native library member name
here, or print jobs referencing the member could fail.
Section Three: Managing Resources with XPAF
27-7
Managing XPAF libraries
After you load a member, XOAF automatically creates a report and writes
it to a dataset that can be browsed or printed. The dataset is defined by
the DD name UJLLIST in the XOAF logon procedure. The report shows
the contents of the newly created library member(s).
When using this option, members are reloaded without user directory
information. Verify that the resource will function correctly without the
user directory information. If unusable resources are produced, use the
LDM batch offload/reload process as an alternative.
NOTE: This option reloads only individual members of a dataset to a
native library. If you need to reload multiple members or all members
to a native library, use the LDM batch utility. Refer to Section Two:
Installing and Customizing XPAF for more information about this
utility.
Section Three: Managing Resources with XPAF
27-8
Supported IBM character sets
28.
28
Supported IBM character sets
This chapter lists the IBM character sets that can be used in documents
sent to Xerox printers. For a more current list of fonts that are available to
XPAF, contact your local support representative.
Proportionally spaced character sets
Helvetica:
•
Roman Medium (H200A0, H200B0, H200D0, H200F0, H200H0,
H200J0, H200N0, H200T0, H200Z0, H20000, H20060, H20070,
H20080, H20090, H202A0, H202B0, H202D0, H202F0, H202H0,
H202J0, H202N0, H202T0, H202Z0, H20200, H20020, H20270,
H20280, H20290, H203A0, H203B0, H203D0, H203F0, H203H0,
H203J0, H203N0, H203T0, H203Z0, H20300, H20360, H20370,
H20380, H20390)
•
Roman Bold (H400A0, H400B0, H400D0, H400F0,
H400H0, H400J0, H400N0, H400T0, H400Z0, H40000,
H40070, H40080, H40090, H402A0, H402B0, H402D0,
H402H0, H402J0, H402N0, H402T0, H402Z0, H40200,
H40270, H40280, H40290, H403A0, H403B0, H403D0,
H403H0, H403J0, H403N0, H403T0, H403Z0, H40300,
H40370, H40380, H40390)
H40060,
H402F0,
H40020,
H403F0,
H40360,
Italic Medium (H300A0, H300B0, H300D0, H300F0,
H300H0, H300J0, H300N0, H300T0, H300Z0, H30000,
H30070, H30080, H30090, H302A0, H302B0, H302D0,
H302H0, H302J0, H302N0, H302T0, H302Z0, H30200,
H30270, H30280, H30290, H303A0, H303B0, H303D0,
H303H0, H303J0, H303N0, H303T0, H303Z0, H30300,
H30370, H30380, H30390)
H30060,
H302F0,
H30020,
H303F0,
H30360,
Italic Bold (H500A0, H500B0, H500D0, H500F0,
H500H0, H500J0, H500N0, H500T0, H500Z0, H50000,
H50070, H50080, H50090, H502A0, H502B0, H502D0,
H502H0, H502J0, H502N0, H502T0, H502Z0, H50200,
H50270, H50280, H50290, H503A0, H503B0, H503D0,
H503H0, H503J0, H503N0, H503T0, H503Z0, H50300,
H50370, H50380, H50390)
H50060,
H502F0,
H50020,
H503F0,
H50360,
•
•
Pi Serif:
•
Roman Medium (Q05500, Q05560, Q05580, Q055B0)
•
Roman Bold (Q07500, Q07560, Q07580, Q075B0)
Pi Sans Serif:
•
Roman Medium (P05500, P05560, P05580, P055B0)
•
Roman Bold (P07500, P07560, P07580, P075B0)
Sonoran Display (J055J0, J055Z0)
Sonoran Petite (Z05640)
Section Three: Managing Resources with XPAF
28-1
Supported IBM character sets
Sonoran Sans Serif:
•
Roman Medium (A05500, A05560 A05570, A05580, A05590,
A055A0, A055B0, A055D0, A055F0, A055J0, A055N0, A055T0,
A055Z0)
•
Roman Bold (A07500, A07560 A07570, A07580, A07590, A075A0,
A075B0, A075D0, A075F0, A075J0, A075N0, A075T0, A075Z0)
•
Italic Medium (A15500, A15560 A15570, A15580, A15590, A155A0,
A155B0, A155D0, A155F0, A155J0, A155N0, A155T0, A155Z0)
•
Italic Bold (A17500, A17560 A17570, A17580, A17590, A175A0,
A175B0, A175D0, A175F0, A175J0, A175N0, A175T0, A175Z0)
Sonoran Serif:
•
Roman Medium (T05500, T05560 T05570, T05580, T05590,
T055A0, T055B0, T055D0, T055F0, T055J0, T055N0, T055T0,
T055Z0)
•
Roman Bold (T07500, T07560 T07570, T07580, T07590, T075A0,
T075B0, T075D0, T075F0, T075J0, T075N0, T075T0, T075Z0)
•
Italic Medium (T15500, T15560 T15570, T15580, T15590, T155A0,
T155B0, T155D0, T155F0, T155J0, T155N0, T155T0, T155Z0)
•
Italic Bold (T17500, T17560 T17570, T17580, T17590, T175A0,
T175B0, T175D0, T175F0, T175J0, T175N0, T175T0, T175Z0)
Times New Roman:
•
Roman Medium (N200A0, N200B0, N200D0, N200F0, N200H0,
N200J0, N200N0, N200T0, N200Z0, N20000, N20060, N20070,
N20080, N20090, N202A0, N202B0, N202D0, N202F0, N202H0,
N202J0, N202N0, N202T0, N202Z0, N20200, N20020, N20270,
N20280, N20290, N203A0, N203B0, N203D0, N203F0, N203H0,
N203J0, N203N0, N203T0, N203Z0, N20300, N20360, N20370,
N20380, N20390)
•
Roman Bold (N400A0, N400B0, N400D0, N400F0, N400H0,
N400J0, N400N0, N400T0, N400Z0, N40000, N40060, N40070,
N40080, N40090, N402A0, N402B0, N402D0, N402F0, N402H0,
N402J0, N402N0, N402T0, N402Z0, N40200, N40020, N40270,
N40280, N40290, N403A0, N403B0, N403D0, N403F0, N403H0,
N403J0, N403N0, N403T0, N403Z0, N40300, N40360, N40370,
N40380, N40390)
•
Italic Medium (N300A0, N300B0, N300D0, N300F0, N300H0,
N300J0, N300N0, N300T0, N300Z0, N30000, N30060, N30070,
N30080, N30090, N302A0, N302B0, N302D0, N302F0, N302H0,
N302J0, N302N0, N302T0, N302Z0, N30200, N30020, N30270,
N30280, N30290, N303A0, N303B0, N303D0, N303F0, N303H0,
N303J0, N303N0, N303T0, N303Z0, N30300, N30360, N30370,
N30380, N30390)
•
Italic Bold (N500A0, N500B0, N500D0, N500F0, N500H0, N500J0,
N500N0, N500T0, N500Z0, N50000, N50060, N50070, N50080,
N50090, N502A0, N502B0, N502D0, N502F0, N502H0, N502J0,
N502N0, N502T0, N502Z0, N50200, N50020, N50270, N50280,
N50290, N503A0, N503B0, N503D0, N503F0, N503H0, N503J0,
N503N0, N503T0, N503Z0, N50300, N50360, N50370, N50380,
N50390)
Section Three: Managing Resources with XPAF
28-2
Supported IBM character sets
Uniformly spaced character sets
APL (S0AE10, S0AE20)
Document (S0DOTR)
Boldface (S0BRTR) Bold
Boldface Italic (S0BITR) Bold Italic
Courier:
•
Medium (S0CR10, S0CR12, S0CR15)
•
Bold (S0CB10, S0CB12, S0CB15)
•
Italic (S0CI10, S0CI12, S0CI15)
•
Ultra Expanded (S0CD15)
•
Ultra Expanded Italic (S0CW15)
•
Overstrike (S0CO10)
•
Extended (S0CE10)
•
Overstruck (S0CH10)
•
Courier12 (S0CR12)
•
Roman Medium (4200B0, 4200D0, 4200J0, 420000, 420070,
420080, 4202B0, 4202D0, 4202J0, 420200, 420270, 420280,
4203B0, 4203D0, 4203J0, 420300, 420370, 420380)
•
Roman Bold (4400B0, 4400D0, 4400J0, 440000, 440070, 440080,
4402B0, 4402D0, 4402J0, 440200, 440270, 440280, 4403B0,
4403D0, 4403J0, 440300, 440370, 440380)
•
Italic Medium (4300B0, 4300D0, 4300J0, 430000, 430070, 430080,
4302B0, 4302D0, 4302J0, 430200, 430270, 430280, 4303B0,
4303D0, 4303J0, 430300, 430370, 430380)
•
Italic Bold (4500B0, 4500D0, 4500J0, 450000, 450070, 450080,
4502B0, 4502D0, 4502J0, 450200, 450270, 450280, 4503B0,
4503D0, 4503J0, 450300, 450370, 450380)
Dump (L0DUMP)
Essay (S0ESTR)
Essay (S0ELTR) Light
Essay (S0EBTR) Bold
Essay (S0EITR) Italic
Essay (S0EOTR) Overstruck
Gothic (D0GT10, D0GT12, D0GT15, D0GT18, D0GT20, D0GT24)
Gothic (D0GL10, D0GL12, D0GL15) Semilight
Gothic (D0GC15) Semicondensed
Gothic (D0GB10, D0GB12) Bold
Gothic (D0GI12) Italic
Gothic Proportional (D0GP12)
Gothic Reverse (D0GR10)
Gothic Uppercase (L00GSC) Condensed
Gothic Uppercase (L00GUC) Condensed Underscored
Section Three: Managing Resources with XPAF
28-3
Supported IBM character sets
Gothic Uppercase (L0GU10, L0GU12, L0GU15) Underscored
ISIL Gothic (Bookmaster)
•
Medium (0005ZA, 0007ZA, 0008ZA, 0009ZA, 0010ZA, 0011ZA,
0012ZA, 0014ZA, 0016ZA, 0018ZA)
•
Bold (0007ZB, 0008ZB, 0009ZB, 0010ZB, 0011ZB, 0012ZB,
0014ZB, 0016ZB, 0018ZB)
•
Italic (0007ZC, 0008ZC, 0009ZC, 0010ZC, 0011ZC, 0012ZC,
0014ZC, 0016ZC, 0018ZC)
•
Bold italic (0007ZD, 0008ZD, 0009ZD, 0010ZD, 0011ZD, 0012ZD,
0014ZD, 0016ZD, 0018ZD)
•
Reverse medium (0007ZE, 0008ZE, 0009ZE, 0010ZE, 0011ZD,
0012ZE, 0014ZE, 0016ZE, 0018ZE)
•
Specials (0007XA, 0008XA, 0009XA, 0010XA, 0011XA, 0012XA,
0014XA, 0016XA, 0018XA)
•
Specials reverse (0007XE, 0008XE, 0009XE, 0010XE, 0011XE,
0012XE, 0014XE, 0016XE, 0018XE)
•
Screen Corner (0018SC)
Katakana (L0KATA)
Letter Gothic (S0LR12)
Letter Gothic (S0LB12) Bold
OCR AOA (L00AOA)
OCR AON (L00AON)
OCR BOA (L00BOA)
OCR OAB (L00OAB)
Orator (S0OR10)
Orator (S0OB10) Bold
Prestige (S0PR10, S0PR12)
Prestige (S0PB12) Bold
Prestige (S0PI12) Italic
Roman (D0RT10)
Script (S0SR12)
Serif (D0ST10, D0ST12, D0ST15)
Serif (D0SB12) Bold
Serif (D0SI10, D0SI12) Italic
Serif (D0SO12) Overstruck
Symbols (S0S193, S0S198)
Symbols OS6 (S0S192)
Text (L00T11)
Text (L0TU10) Underscored
Section Three: Managing Resources with XPAF
28-4
Character mapping tables
29.
29
Character mapping tables
This chapter describes some of the character mapping tables that relate
to XPAF font processing.
Table naming conventions
Character mapping tables are named in the following manner:
•
For centralized and decentralized character mapping tables, names
beginning with “C” indicate a centralized font mapping and names
beginning with “D” indicate a decentralized font mapping.
•
For code page tables, names beginning with “X” or “XC” indicate the
A03 (American) family of fonts. Names beginning with “RX” indicate
the R03 (European) family of fonts.
•
A name including the characters CM indicates that the table is a
character mapping table and can be specified in either the
‘Centralized Mapping Name’ or the ‘Decentralized Mapping Name’
field of an XPAFXFI entry.
•
A name including the characters CP (instead of CM) indicates that
the table is a code page table and can be specified in the ‘Code
Page Name’ field of an XPAFXFI table entry.
•
The last two digits indicate the number of the table in A03 Font
Reference Manual or R03 Font Reference Manual that details the
character set. For example, the name RXCM08 indicates a code
page table containing the character mapping for the R03 character
set, which is defined in table 8 of the R03 Font Reference Manual.
Section Three: Managing Resources with XPAF
29-1
Character mapping tables
Xerox code page tables (XCP1 through XCP19)
Table 29-1 identifies the code pages which are supplied with XPAF in
TABLELIB for the A03 family of fonts. These tables are used for printing
DCF/SCRIPT documents. The source for the code page tables is
distributed with XPAF in XPFSAMP.
Table 29-1.
Xerox code page tables (XCP1 through XCP19)
Table name
Description
XCP1
A03 character set 1
XCP2
A03 character set 2
XCP3
A03 character set 3
XCP4
A03 character set 4
XCP5
A03 character set 5
XCP6
A03 character set 6
XCP7
A03 character set 6 with extension 1
XCP8
A03 character set 7
XCP9
A03 character set 8
XCP10
A03 character set 8 with extension 1
XCP11
A03 character set 8 with extension 2
XCP12
A03 character set 9
XCP13
A03 character set 10
XCP14
A03 character set 10A
XCP15
A03 character set 10B
XCP16
A03 character set 14
XCP17
A03 character set 15
XCP18
A03 extension 1
XCP19
A03 extension 2
NOTE: XPAF provides a set of code page tables (RXCP07 through
RXCP34) in TABLELIB for the R03 family of fonts. These tables also
can be used for printing DCF documents. The source for these tables
is distributed with XPAF in XPFSAMP.
Section Three: Managing Resources with XPAF
29-2
Character mapping tables
Centralized-to-decentralized font conversion character
mapping tables
XPAF supplies two character mapping tables in TABLELIB which are used
when XPAF converts centralized fonts to decentralized fonts:
•
CCMV01 for the centralized character mapping of the font
•
DCMV01 (planes 01 and 02) for the decentralized character
mapping of the font
XPAF also supplies the decentralized character mapping table, DCMV02
(planes 01 and 02), in TABLELIB. This table can be used for mapping
fonts that exceed the 64K storage memory limit during centralized-todecentralized font conversion. Refer to chapter 25, “Managing custom
fonts” for more information about the function of this table.
The contents of CCMV01, DCMV01, and DCMV02 are shown in tables
29-2 through 29-11. These tables provide the following information:
•
The ASCII hexadecimal mapping value for each character in the font
•
The actual character that resides in each ASCII location
•
The standard font character identifier that uniquely identifies the
character
The shaded areas in tables 29-2 through 29-11 identify ASCII code points
to which characters cannot be mapped. Refer to chapter 24, “Managing
XPAF tables” for information about the restrictions for character mapping.
NOTE: The source for CCMV01, DCMV01, and DCMV02 is
distributed with XPAF in XPFSAMP.
Section Three: Managing Resources with XPAF
29-3
Character mapping tables
Table 29-2.
CCMV01 character mapping table (x0 to x9)
x0
x1
x2
x3
x4
x5
x6
x7
x8
x9
SA520000
SA530000
SM490000
CEPHEX13
CEPHEX14
CEPHEX15
SS680000
SF040000
CEPHEX18
CEPHEX19
0x
1x
2x
3x
4x
5x
6x
7x
!
“
#
$
%
&
‘
(
)
SP010000
SP020000
SP040000
SM010000
SC030000
SM020000
SM030000
SP050000
SP060000
SP070000
0
1
2
3
4
5
6
7
8
9
ND100000
ND010000
ND020000
ND030000
ND040000
ND050000
ND060000
ND070000
ND080000
ND090000
@
A
B
C
D
E
F
G
H
I
SM050000
LA020000
LB020000
LC020000
LD020000
LE020000
LF020000
LG020000
LH020000
LI020000
P
Q
R
S
T
U
V
W
X
Y
LP020000
LQ020000
LR020000
LS020000
LT020000
LU020000
LV020000
LW020000
LX020000
LY020000
¢
a
b
c
d
e
f
g
h
i
SC040000
LA010000
LB010000
LC010000
LD010000
LE010000
LF010000
LG010000
LH010000
LI010000
p
q
r
s
t
u
v
w
x
y
LP010000
LQ010000
LR010000
LS010000
LT010000
LU010000
LV010000
LW010000
LX010000
LY010000
ND061000
ND071000
ND081000
ND091000
8x
¹
²
³
ND101000
ND011000
ND021000
ND031000
ND041000
ND051000
¡
¿
SM340000
SM350000
SM570000
SM470000
SF050000
SA540000
SP030000
SP160000
CEPHEX98
CEPHEX99
Á
Ã
À
Â
Ä
Å
Æ
Ç
É
È
LA120000
LA200000
LA140000
LA160000
LA180000
LA280000
LA520000
LC420000
LE120000
LE140000
IJ
Ñ
Ó
Õ
Ò
Ô
Ö
Ø
Œ
LI520000
LN200000
CEPHEXB
2
LO120000
LO020000
LO140000
LO160000
LO180000
LO620000
LO520000
á
ã
à
â
ä
å
æ
ç
é
è
LA110000
LA190000
LA130000
LA150000
LA170000
LA270000
LA510000
LC410000
LE110000
LE130000
ij
ñ
ó
õ
ò
ô
ö
ø
œ
LI510000
LN190000
CEPHEXD
2
LO110000
LO190000
LO130000
LO150000
LO170000
LO610000
LO510000
´
˜
`
ˆ
¨
°
f
¸
y
w
SD120000
SD200000
SD140000
SD160000
SD180000
SD280000
GF010000
SD410000
GP610000
GO310000
´
˜
`
ˆ
¨
°
ª
º
I
÷
SD110000
SD190000
SD130000
SD150000
SD170000
SD290000
SM210000
SM200000
LI610000
SA060000
9x
Ax
Bx
Cx
Dx
Ex
Fx
Section Three: Managing Resources with XPAF
29-4
Character mapping tables
Table 29-3.
CCMV01 character mapping table (xA to xF)
xA
xB
xC
xD
xE
xF
{
|
}
¬
¼
½
SM110000
SM130000
SM140000
SM660000
NF040000
NF010000
*
+
,
-
.
/
SM040000
SA010000
SP080000
SP100000
SP110000
SP120000
:
;
<
=
>
?
SP130000
SP140000
SA030000
SA040000
SA050000
SP150000
J
K
L
M
N
O
LJ020000
LK020000
LL020000
LM020000
LN020000
LO020000
Z
[
\
]
^
_
LZ020000
SM060000
SM070000
SM080000
SS390000
SP090000
j
k
l
m
n
o
LJ010000
LK010000
LL010000
LM010000
LN010000
LO010000
z
°
LZ010000
SM190000
SA020000
SF020000
SF010000
SF030000
SP061000
SA011000
SA001000
SP071000
SM250000
SM240000
£
Fr
ƒ
1
2
SC020000
XC357243
CEPHEX9C
SC070000
XC357375
XC357376
Ê
Ë
Í
Ì
Î
Ï
LE160000
LE180000
LI120000
LI140000
LI160000
LI180000
0x
1x
2x
3x
4x
5x
6x
7x
8x
9x
Ax
§
Bx
Cx
Dx
/3
/3
Ú
Ù
Û
Ü
CEPHEXBA
LU120000
LU140000
LU160000
LU180000
CEPHEXBF
ê
ë
í
ì
î
ï
LE150000
LE170000
LI110000
LI130000
LI150000
LI170000
ß
ú
ù
û
ü
LS610000
LU110000
LU130000
LU150000
LU170000
CEPHEXDF
CEPHEXEA
CEPHEXEB
CEPHEXEC
CEPHEXED
CEPHEXEE
CEPHEXEF
©
F
•
¾
µ
a
SM520000
GF020000
SD270000
NF050000
SM170000
LA011000
Ex
Fx
Section Three: Managing Resources with XPAF
29-5
Character mapping tables
Table 29-4.
x0
DCMV01 (plane 01) character mapping table (x0 to x9)
x1
x2
x3
x4
x5
x6
x7
x8
x9
0x
1x
2x
3x
4x
5x
6x
7x
!
“
#
$
%
&
‘
(
)
SP010000
SP020000
SP040000
SM010000
SC030000
SM020000
SM030000
SP050000
SP060000
SP070000
0
1
2
3
4
5
6
7
8
9
ND100000
ND010000
ND020000
ND030000
ND040000
ND050000
ND060000
ND070000
ND080000
ND090000
@
A
B
C
D
E
F
G
H
I
SM050000
LA020000
LB020000
LC020000
LD020000
LE020000
LF020000
LG020000
LH020000
LI020000
P
Q
R
S
T
U
V
W
X
Y
LP020000
LQ020000
LR020000
LS020000
LT020000
LU020000
LV020000
LW020000
LX020000
LY020000
¢
a
b
c
d
e
f
g
h
i
SC040000
LA010000
LB010000
LC010000
LD010000
LE010000
LF010000
LG010000
LH010000
LI010000
p
q
r
s
t
u
v
w
x
y
LP010000
LQ010000
LR010000
LS010000
LT010000
LU010000
LV010000
LW010000
LX010000
LY010000
¼
½
NF040000
NF010000
8x
9x
Ax
Bx
Cx
Dx
Ex
Fx
Á
Ã
À
Â
Ä
Å
Æ
Ç
É
È
LA120000
LA200000
LA140000
LA160000
LA180000
LA280000
LA520000
LC420000
LE120000
LE140000
IJ
Ñ
²
Ó
Õ
Ò
Ô
Ö
Ø
Œ
LI520000
LN200000
ND021000
0
LO120000
LO020000
LO140000
LO160000
LO180000
LO620000
LO520000
á
ã
à
â
ä
å
æ
ç
é
è
LA110000
LA190000
LA130000
LA150000
LA170000
LA270000
LA510000
LC410000
LE110000
LE130000
ij
ñ
¡
ó
õ
ò
LI510000
LN190000
SP030000
LO110000
LO190000
LO130000
´
˜
`
ˆ
¨
f
¸
y
w
SD120000
SD200000
SD140000
SD160000
SD180000
GF010000
SD410000
GP610000
GO310000
´
˜
`
ˆ
¨
°
ª
º
I
÷
SD110000
SD190000
SD130000
SD150000
SD170000
SD290000
SM210000
SM200000
LI610000
SA060000
Section Three: Managing Resources with XPAF
29-6
Character mapping tables
Table 29-5.
DCMV01 (plane 01) character mapping table
(xA to xF)
xA
xB
xC
xD
xE
xF
*
+
,
-
.
/
SM040000
SA010000
SP080000
SP100000
SP110000
SP120000
:
;
<
=
>
?
SP130000
SP140000
SA030000
SA040000
SA050000
SP150000
J
K
L
M
N
O
LJ020000
LK020000
LL020000
LM020000
LN020000
LO020000
Z
[
\
]
^
_
LZ020000
SM060000
SM070000
SM080000
SS390000
SP090000
j
k
l
m
n
o
LJ010000
LK010000
LL010000
LM010000
LN010000
LO010000
z
°
{
|
}
¬
LZ010000
SM190000
SM110000
SM130000
SM140000
SM660000
£
Fr
¹
ƒ
1
2
SC020000
XC357243
ND011000
SC070000
XC357375
XC357376
Ê
Ë
Í
Ì
Î
Ï
LE160000
LE180000
LI120000
LI140000
LI160000
LI180000
³
Ú
Ù
Û
Ü
§
ND031000
LU120000
LU140000
LU160000
LU180000
SM240000
ê
ë
í
ì
î
ï
LE150000
LE170000
LI110000
LI130000
LI150000
LI170000
ù
û
ü
¿
LU130000
LU150000
LU170000
SP160000
0x
1x
2x
3x
4x
5x
6x
7x
8x
9x
Ax
Bx
Cx
Dx
Ex
Fx
/3
/3
ô
ö
ø
œ
ß
ú
LO150000
LO170000
LO610000
LO510000
LS610000
LU110000
©
F
•
¾
µ
a
SM520000
GF020000
SD270000
NF050000
SM170000
LA011000
Section Three: Managing Resources with XPAF
29-7
Character mapping tables
Table 29-6.
x0
DCMV01 (plane 02) character mapping table (x0 to x9)
x1
x2
x3
x4
x5
x6
x7
x8
x9
0x
1x
2x
°
SP010000
SD280000
SA520000
SA530000
SM490000
CEPHEX13
CEPHEX14
CEPHEX15
SS680000
SF040000
ND101000
ND041000
ND051000
ND061000
ND071000
ND081000
ND091000
SP061000
SA011000
SA001000
SF050000
SA540000
CEPHEX98
CEPHEX99
CEPHEX9C
CEPHEXB2
CEPHEXBA
CEPHEXBF
CEPHEXD2
CEPHEXDF
3x
4x
5x
6x
7x
8x
9x
Ax
Bx
Cx
Dx
Ex
Fx
Section Three: Managing Resources with XPAF
29-8
Character mapping tables
Table 29-7.
DCMV01 (plane 02) character mapping table
(xA to xF)
xA
xB
xC
xD
xE
xF
CEPHEX18
CEPHEX19
SA020000
SF020000
SF010000
SF030000
SP071000
SM250000
SM340000
SM350000
SM570000
SM470000
CEPHEXEA
CEPHEXEB
CEPHEXEC
CEPHEXED
CEPHEXEE
CEPHEXEF
0x
1x
2x
3x
4x
5x
6x
7x
8x
9x
Ax
Bx
Cx
Dx
Ex
Fx
Section Three: Managing Resources with XPAF
29-9
Character mapping tables
Table 29-8.
x0
DCMV02 (plane 01) character mapping table (x0 to x9)
x1
x2
x3
x4
x5
x6
x7
x8
x9
0x
1x
2x
3x
4x
5x
6x
7x
!
“
#
$
%
&
‘
(
)
SP010000
SP020000
SP040000
SM010000
SC030000
SM020000
SM030000
SP050000
SP060000
SP070000
0
1
2
3
4
5
6
7
8
9
ND100000
ND010000
ND020000
ND030000
ND040000
ND050000
ND060000
ND070000
ND080000
ND090000
@
A
B
C
D
E
F
G
H
I
SM050000
LA020000
LB020000
LC020000
LD020000
LE020000
LF020000
LG020000
LH020000
LI020000
P
Q
R
S
T
U
V
W
X
Y
LP020000
LQ020000
LR020000
LS020000
LT020000
LU020000
LV020000
LW020000
LX020000
LY020000
¢
a
b
c
d
e
f
g
h
i
SC040000
LA010000
LB010000
LC010000
LD010000
LE010000
LF010000
LG010000
LH010000
LI010000
p
q
r
s
t
u
v
w
x
y
LP010000
LQ010000
LR010000
LS010000
LT010000
LU010000
LV010000
LW010000
LX010000
LY010000
8x
9x
Ax
Bx
Cx
Dx
Ex
Fx
Section Three: Managing Resources with XPAF
29-10
Character mapping tables
Table 29-9.
DCMV02 (plane 01) character mapping table
(xA to xF)
xA
xB
xC
xD
xE
xF
*
+
,
-
.
/
SM040000
SA010000
SP080000
SP100000
SP110000
SP120000
:
;
<
=
>
?
SP130000
SP140000
SA030000
SA040000
SA050000
SP150000
J
K
L
M
N
O
LJ020000
LK020000
LL020000
LM020000
LN020000
LO020000
Z
[
\
]
^
_
LZ020000
SM060000
SM070000
SM080000
SS390000
SP090000
j
k
l
m
n
o
LJ010000
LK010000
LL010000
LM010000
LN010000
LO010000
z
°
{
|
}
¬
LZ010000
SM190000
SM110000
SM130000
SM140000
SM660000
0x
1x
2x
3x
4x
5x
6x
7x
8x
9x
Ax
Bx
Cx
Dx
Ex
Fx
Section Three: Managing Resources with XPAF
29-11
Character mapping tables
Table 29-10. DCMV02 (plane 02) character mapping table (x0 to x9)
x0
x1
x2
x3
x4
x5
x6
x7
x8
x9
SP010000
SA520000
SA530000
SM490000
CEPHEX13
CEPHEX14
CEPHEX15
SS680000
SF040000
CEPHEX18
¹
²
³
SF030000
ND101000
ND011000
ND021000
ND031000
ND041000
ND051000
ND061000
ND071000
ND081000
¡
¿
SM240000
SM340000
SM350000
SM570000
SM470000
SF050000
SA540000
SP030000
SP160000
CEPHEX98
2/
0x
1x
2x
3x
4x
5x
6x
§
Á
Ã
À
Â
Ä
Å
Æ
Ç
É
XC357376
LA120000
LA200000
LA140000
LA160000
LA180000
LA280000
LA520000
LC420000
LE120000
Ï
IJ
Ñ
Ó
Õ
Ò
Ô
Ö
Ø
LI180000
LI520000
LN200000
CEPHEXB2
LO120000
LO020000
LO140000
LO160000
LO180000
LO620000
á
ã
à
â
ä
å
æ
ç
é
LA110000
LA190000
LA130000
LA150000
LA170000
LA270000
LA510000
LC410000
LE110000
ï
ij
LI170000
LI510000
3
7x
CEPHEXBF
8x
9x
Ax
Bx
Cx
ö
ø
œ
ß
ú
ù
û
ü
LO170000
LO610000
LO510000
LS610000
LU110000
LU130000
LU150000
LU170000
CEPHEXDF
´
¸
y
w
SD410000
GP610000
GO310000
CEPHEXEA
CEPHEXEB
CPEHEXEC
CEPHEXED
CEPHEXEE
CEPHEXEF
º
I
÷
©
F
•
¾
µ
a
SM200000
LI610000
SA060000
SM520000
GF020000
SD270000
NF050000
SM170000
LA011000
SD120000
´
SD110000
Dx
Ex
Fx
Section Three: Managing Resources with XPAF
29-12
Character mapping tables
Table 29-11. DCMV02 (plane 02) character mapping table
(xA to xF)
xA
xB
xC
xD
xE
xF
0x
1x
2x
¼
½
CEPHEX19
NF040000
NF010000
SA020000
SF020000
SF010000
ND091000
SP061000
SA011000
SA001000
SP071000
SM250000
£
Fr
ƒ
1
CEPHEX99
SC020000
XC357243
CEPHEX9C
SC070000
XC357375
È
Ê
Ë
Í
Ì
Î
LE140000
LE160000
LE180000
LI120000
LI140000
LI160000
3x
4x
5x
6x
7x
Œ
/3
Ú
Ù
Û
Ü
LO520000
CEPHEXBA
LU120000
LU140000
LU160000
LU180000
è
ê
ë
í
ì
î
LE130000
LE150000
LE170000
LI110000
LI130000
LI150000
8x
9x
Ax
Bx
ñ
ó
õ
ò
ô
LN190000
CEPHEXD2
LO110000
LO190000
LO130000
LO150000
˜
`
ˆ
¨
°
f
SD200000
SD140000
SD160000
SD180000
SD280000
GF010000
˜
`
ˆ
¨
°
ª
SD190000
SD130000
SD150000
SD170000
SD290000
SM210000
Cx
Dx
Ex
Fx
Section Three: Managing Resources with XPAF
29-13
Character mapping tables
Section Three: Managing Resources with XPAF
29-14
XRFBATCH utility
30.
30
XRFBATCH utility
This chapter describes the utility, XRFBATCH, that can be used to convert
all AFP page segments in a PDS to .IMG and/or RES .IMG format and
load the resulting images to a native library. XRFBATCH, which is
distributed in XPFSAMP, performs the same function as the Convert IBM
AFP Page Segments to Xerox .IMG and/or RES Format option on the
Convert Resources menu. Refer to chapter 22, “Converting resources” for
more information about this option.
XRFBATCH converts only standard page segment libraries. It does not
convert overlays or composed text. Also, XRFBATCH does not convert
page segments that have names starting with the letter O.
There is no revision support in XOAF. After you convert a page segment
using this utility, it will not be automatically reconverted if you change it.
To use a revised version of a previously converted page segment re-run
XRFBATCH with the REPLACE=Y option, then specify AUTOREV=X in
the printer profile to send the new image to the printer.
XRFBATCH does not convert page segments to native decentralized
images when IMGNUM=IMG. To accomplish this you must first convert
them as centralized images to the Centralized Native XPAF Image
Library. In the printer profile of the decentralized printer specify
SIMAGELIB= the centralized library and specify AUTOREV=X. XPAFwill
perform the conversion dynamically at print time.
Setting up XRFBATCH
You can specify the following parameters in the JCL.
NOTE: You cannot specify all of the parameters at one time because
the IBM JCL PARM= statement limits the number of characters within
the parentheses to no more than 100 characters. Therefore, you
should specify a parameter only if you require a value other than the
default value.
CAUTION: If you use XRFBATCH to preconvert page segment
resources that are images common to AFP and DJDE print jobs, use
of IMAGENUM=IMG may cause unexpected results.
Section Three: Managing Resources with XPAF
30-1
XRFBATCH utility
Parameter
COMPMODE
Action
Specify the image compression mode used for converting the image file. Use
this parameter only if COMPTYPE=TIME.
Valid values:
ENC
LIN
Run-length encoded compression mode.
Line-predicted compression mode.
Default: LIN
COMPTYPE
Specify the image optimization compression type when converting raster data.
Valid values:
SIZE
Compresses images to the smallest possible size, regardless of
the length of processing time involved.
TIME
Compresses images in the quickest way, as specified in the
COMPMODE parameter.
Default: SIZE
CONVTONE
Specify whether the image resolution conversion algorithm will use dark or light
dots at certain decision points. This will cause images that are very dark or very
light to be printed slightly darker or lighter and may be required if an image has
characteristics which do not convert satisfactorily using the default. This
parameter takes effect only if you specify 1 or 3 for the CONVTYPE parameter.
Valid values: 1 (darkest) through 240 (lightest).
Default: 120
CONVTYPE
Specify the image resolution conversion type.
Valid values:
0
Does not scale the image dimension but does scale the position of the
image. Image position scaling allows the image to print in the correct
relative location on the page when printed on a Xerox printer as
opposed to printing on an IBM printer. Image position scaling is
increased by a factor of 25%.
1
Scales the image dimension and image position of an AFP image to
300 dpi before sending it to the printer. IOCA-encoded images are
scaled from any resolution to 300 dpi. All other AFP images are scaled
from 240-to-300 dpi, an increase of 25%.
3
Scales the image dimension and image position of an AFP image to
300 dpi based on the current L-units value specified in the IDD or IID
structured field of the image. IOCA-encoded images are scaled from
any resolution to 300 dpi. For IM-type images, any L-units value that
does not specify 300 dpi is assumed to be 240 dpi.
Default: 1
NOTE: If you specify 0, the size of the converted image will print smaller in
XPAF (by a factor of 20%) than the original 240 dpi image printed in AFP.
Section Three: Managing Resources with XPAF
30-2
XRFBATCH utility
Parameter
DESTPRTR
or
DEST
Action
Specify whether the page segments should be converted to images in
centralized or decentralized format.
Valid values:
C
Specifies that your destination printer is a centralized printer.
D
Specifies that your destination printer is a decentralized printer.
Default: C
IMAGEDDN
or
ODDN
IMGNM
Specify the native library where the converted page segments will be stored.
This name must match the name in the IMAGELIB DD statement in the JCL.
Default: IMAGELIB
Specify the image output name to use.
Valid values:
AFP
Generates full 20-character names and is required for resources
used in AFP print jobs.
IMG
Uses the pseg member name without the s1 prefix if one exists.
This allows the image name to be used directly in a DJDE IMAGE=
statement. (This is not supported on decentralized images.)
NOTE: XRFBATCH does not convert page segments to native
decentralized images when IMGNUM=IMG. To accomplish this you must
first convert them as centralized images to the Centralized Native XPAF
Image Library. In the printer profile of the decentralized printer specify
SIMAGELIB= the centralized library and specify AUTOREV=X. XPAFwill
perform the conversion dynamically at print time.
Default: AFP
INPUTDDN
or
IDDN
Specify the IBM resource library containing the page segments to be converted.
This name must match the name in the INFILE DD statement in the JCL.
Default: INFILE
NOTE: XRFBATCH does not convert page segments that have names that
begin with the letter O.
Section Three: Managing Resources with XPAF
30-3
XRFBATCH utility
Parameter
LOGDSN
Action
Specify the dataset to be used for logging messages. This sequential dataset
must have the same specifications as your XLOG dataset, but the XLOG
dataset itself should not be used with this parameter.
NOTE: If you do not specify the LOGDSN parameter, the dataset specified
in the XPAFXLOG DD statement is used. If neither of these is specified,
messages are displayed on the system console. If you do not want to use
logging, change the JCL to specify DD DUMMY in the XPAFXLOG DD
statement.
Valid values: A 1- to 44-character dataset name.
Default: None
MAXIMGPS
or
MIPS
Specify the maximum number of images within a single page segment in the
library that will be converted.
Valid values: 1 through 999.
Default: 16
PAPERSIZ
Specify the paper size to be used by the printed image.
or
Valid values:
PSIZ
LETTER
LEGAL
LONG
A3
A4
Default: LETTER
PRINTENV
or
PENV
Identify the type of centralized printers you use to print AFP data streams
through XPAF. This parameter is used to determine how XPAF converts images
colorized via the IID structured field for printing on a centralized printer.
This parameter only applies to AFP data streams containing images colorized
via the IID structured field that will be sent to centralized printers.
Valid values:
MONO Specifies that XPAF jobs are printed only on monochrome
printers. XPAF converts any colorized images to monochrome
black .IMG files.
COLR
Specifies that XPAF jobs are printed only on highlight color
printers. XPAF converts any colorized images to color RES .IMG
files.
BOTH
Specifies that XPAF jobs are printed on both monochrome and
highlight color printers. XPAF converts any colorized images to
both monochrome black .IMG and color RES .IMG files.
Default: MONO
Section Three: Managing Resources with XPAF
30-4
XRFBATCH utility
Parameter
Action
REPLACE
Specify if existing images will be overwritten with the new image.
or
Valid values:
REPL
Y
Specifies that existing members are to be replaced.
N
Specifies that existing members will not be replaced.
Default: N
REVVIDEO
or
RVID
Specify whether to translate the image into reverse video on output. This
translation consists of reversing the printing of all pixels in the image. For black
images, all white pixels are printed as black, and all black pixels are printed as
white. This parameter is not supported for color images.
Valid values:
Y
N
Reverses all pixels.
Does not reverse pixels.
Default: N
ROTATION
Specify the orientation for the image.
or
Valid values:
ROT
P
L
I
J
Portrait
Landscape
Inverse portrait
Inverse landscape
Default: P
NOTE: AFP images that were generated for IBM printers are rotated 0
degrees. For these images, regardless of document orientation, be sure to
specify a rotation of P.
Section Three: Managing Resources with XPAF
30-5
XRFBATCH utility
Executing XRFBATCH
After entering the necessary parameter values, submit the job. If you
enter an incorrect value for any parameter, XRFBATCH uses the default.
Sample JCL
Sample JCL for XRFBATCH is shown below. Sample JCL also is provided
for XRFBATCH in XPFSAMP.
//job-name JOB job-information
//*
//*
//*
************************************************************
//*
*
THIS SAMPLE JCL IS PROVIDED TO EXECUTE THE BATCH
*
//*
*
UTILITY FOR PRE-CONVERTING IBM AFP PAGE SEGMENTS
*
//*
*
BEFORE PRINTING. CHANGE THIS JOB AS NECESSARY TO
*
//*
*
NAME THE LIBRARIES AND PARAMETERS OF YOUR CHOICE.
*
//*
************************************************************
//*
//*
//XRFBATCH EXEC PGM=XRFBATCH,COND=(0,NE),
<--- PSEG CONVERT PGM
//
PARM=('COMPTYPE=SIZE',
SIZE OR TIME
<--- COMPRESSION TYPE
//
'CONVTYPE=1',
0 OR 1 OR 3
<--- CONVERSION TYPE
//
'DESTPRTR=C',
C OR D
<--- DESTINATION PRTR
//
'IMAGEDDN=IMAGELIB', IMAGELIB
<--- IMAGE LIB DDNAME
//
'INPUTDD=INFILE',
INFILE
<--- PSEG PDS DDNAME
//
'MAXIMGPS=16',
1-999
<--- MAX # PSEG IMGS
//
'PAPERSIZ=LETTER',
A3/4,LEGAL,LONG<--- PAPER SIZE NAME
//
'PRINTENV=MONO',
MONO,COLR,BOTH <--- PRTR ENVIRONMENT
//
'ROTATION=P')
P, L, I, OR J <--- IMG ORIENTATION
//STEPLIB
DD DSN=prefix.XPFLOAD,DISP=SHR
<--- XPAF LOAD LIB
//INFILE
DD DSN=prefix.PSEGLIB,DISP=SHR
<--- INPUT PSEG PDS
//IMAGELIB
DD DSN=prefix.CIMGLIB,DISP=SHR
<--- OUTPUT IMAGE LIB
//XPAFXLOG
DD DSN=prefix.XPAFXLOG,DISP=OLD
<--- XPAF MESSAGE LOG
//
Section Three: Managing Resources with XPAF
30-6
Section Four:
Printing Documents with XPAF
This section provides the information you need to know in order to print
documents through XPAF. For each supported type of document, it
addresses these topics:
•
•
•
•
•
Preparing and using resources
Modifying document processing and format
Using advanced features, such as color
Converting data streams to other formats
Troubleshooting printing problems
Before you begin to use XPAF’s printing facilities, verify that XPAF has
been installed and that the IVPs can be run successfully.
As the systems or application programmer responsible for printing
documents through XPAF, you should be familiar with the IBM z/OS JCL
concepts needed to code and submit jobs successfully (for example, you
must use standard JCL syntax).
Section Four: Printing Documents with XPAF
General information
31.
31
General information
This chapter explains how XPAF determines the processing mode for a
document after it is submitted for printing, and how XPAF uses
system-level features, such as banner pages and user exits, which were
set up at installation time. In addition, it explains how to:
•
Change the processing mode for a document
•
Print pass-through documents to PCL-capable printers
•
Download resources to a printer independently of any document
How does XPAF select the document processing mode?
Whenever you print a document, XPAF must examine the inbound data to
determine what type of document has been submitted. During dataset
open processing, XPAF examines the data and assigns a document type.
Document types
XPAF classifies each document it processes as belonging to one of six
types: NM, DJDE, JCL, XES, PCL5, AFPX, or AFPA. This section
describes each document type and how it is selected.
NM
DJDE
Indicates a native mode (printer-ready) document. If a document is
created and submitted without any extended JCL keywords, DJDE
packets, XES criteria, or AFP attributes, then XPAF will process it as
native mode.
Indicates a DJDE document. If a document includes one or more of these
characteristics, then XPAF will process it as DJDE mode:
•
The keyword PRMODE=DJDE is specified on the OUTPUT
statement in the JCL.
•
The first record in the data stream contains a valid IDEN, and that
IDEN matches the IDEN value specified in the initialization
parameter.
For any dataset that contains DJDE extended JCL keywords or a valid
IDEN in the first data record, XPAF assumes DJDE processing even if
PRMODE=LINE. However, if any AFP attributes are associated with the
document, then AFP mode will override DJDE mode.
Section Four: Printing Documents with XPAF
31-1
General information
JCL
Indicates a document that uses extended JCL keywords. If a document
includes one or more extended JCL keywords, XPAF will process it as
JCL mode. However, if any AFP attributes are associated with the
document, then AFP mode will override JCL mode.
NOTE: JCL type is equivalent to DJDE because XPAF uses the
extended JCL keyword values to build DJDEs for the outbound data
stream destined for a Xerox printer.
XES
Indicates an XES document. If a document includes one or more of these
characteristics in the first record, then XPAF will process it as XES mode:
•
•
It includes a X'27' carriage control value.
It includes the ‘=UDK=’ character string.
If any AFP attributes are associated with the document, then AFP mode
will override XES mode.
AFPX
Indicates a page-formatted document. Refer to the description of AFPA
below. Although page-formatted and AFP documents are two different
types of data streams, XPAF uses the same code for converting each type
of document to a format supported by Xerox printers. Therefore, this
explanation uses the term “AFP attributes” to refer to characteristics that
may apply to either page-formatted or AFP documents.
AFPA
Indicates an AFP document. If a document includes one or more of these
characteristics, XPAF will process it as AFP:
•
Any record within the data stream includes a X'5A' carriage control
value.
•
The keywords FCB and/or UCS are included on the DD statement in
the JCL.
•
The keywords CHARS, FCB, FORMDEF, PAGEDEF,
PRMODE=PAGE, and/or UCS are included on the OUTPUT
statement in the JCL.
For any dataset that contains AFP extended JCL keywords or contains a
5A carriage control in the first data record, XPAF assumes AFP
processing, no matter what value has been specified for the PRMODE.
Processing hierarchy
AFP attributes take precedence over all other document characteristics.
If a document contains any AFP attributes, then it will be processed as
AFP, regardless of any other factors. For example, if a document contains
embedded DJDEs, but the DD statement in the JCL specifies
PAGEDEF=A06420, then XPAF will process the document as AFP. The
DJDEs will be printed as data and not interpreted as DJDEs.
Section Four: Printing Documents with XPAF
31-2
General information
AFP processing exceptions
Certain conditions can alter the standard processing type hierarchy:
•
If SYSFCB=**** is coded in the XINSXOSF member of XINPARM,
XPAF discards the value specified by either the PAGEDEF or FCB
IBM JCL keyword.
•
If SYSFLSH=**** is coded in the XINSXOSF member of XINPARM,
XPAF discards the value specified by the FLASH IBM JCL keyword.
•
If SYSFONT=**** is coded in the XINSXOSF member of XINPARM,
XPAF discards the value specified by either the CHARS or UCS IBM
JCL keyword.
Depending on the document, these values can disable AFP processing.
For example, assume you submitted a document that included only one
JCL keyword on the OUTPUT statement: PAGEDEF=ABCD. By definition,
this would have normally caused XPAF to use AFP processing. However,
because you coded SYSFCB=**** in the XINSXOSF member of
XINPARM, XPAF discarded the PAGEDEF value. The document was then
processed as native mode rather than AFP.
FCB Processing Clarification
The use of the FCB extended JCL keyword will function differently,
depending on how the XPAF system is configured.
If the JCL for an AFP data stream includes the FCB IBM JCL keyword but
not the PAGEDEF IBM JCL keyword, the FCB value is used as a
PAGEDEF value. However, the FCB value is not used as a PAGEDEF
value if any of these conditions exist:
•
If FCB=Y is included in the initialization or printer profile parameters
•
If XJCF simulation processing is in effect
If the JES printer definition has an FCB specified, XPAF will use this FCB
as a PAGEDEF if a PAGEDEF has not been specified via extended JCL,
even if the JES printer FCB value matches the SYSFCB= value in the
initialization parameters. Set FCB=NONE on the JES printer definition to
instruct XPAF to use the default PAGEDEF if no FCB has been specified
via extended JCL.
The Printer Profile parameter FCB=Y is a processing option for
centralized printers that instructs XPAF to download a Forms Control
Buffer (FCB) to the printer whenever it changes. For any such
(centralized) printer that has FCB=Y specified (either through the
initialization parameters or in its Printer Profile), an FCB will be
downloaded to the printer from SYS1.IMAGELIB whenever the FCB name
changes from the last one downloaded. This processing does not occur
for decentralized, PCL-capable or PDF printers because they do not
recognize the FCB string. However, specifying FCB=Y in the Printer
Profile for these printer types will cause XPAF not to consider an FCB
name as a PAGEDEF.
If you specify FCB=Y for a centralized printer it will prevent XPAF from
treating an FCB name as a PAGEDEF and considering a document an
AFP document based on that criteria only. However, XPAF will attempt to
download an FCB with the current FCB name and you will get an error
message if that FCB name does not exist in SYS1.IMAGELIB.
XPAF is compliant with PSF and processes the FCB parameter in the
same way that PSF does.
Section Four: Printing Documents with XPAF
31-3
General information
Using user exit 02 to change the processing mode
You can select the processing mode for a data stream by defining certain
test criteria in user exit 02. You can use any of the fields available in the
XDIB control block to build your test criteria and determine the desired
document type. For example, you may test FORMS, CLASS, and FCB to
decide if a document should be printed as native mode or AFP.
For more information on user exits and how to code them, refer to Section
Two: Installing and Customizing XPAF.
Processing modes available
You must code user exit 02 to update the XDIBDFMT field with the desired
format type:
blank
XPAF determines what processing mode to use based on the
extended JCL and the data stream.
NM
Forces the job through native mode processing. No extended
JCL processing is provided, and no DJDE processing is provided
for decentralized and PCL-capable printers.
DJDE
Forces the job through DJDE processing. No extended JCL
processing is provided.
JCL
Forces the job through extended JCL processing. For
decentralized printers, DJDE-to-XES processing also is included.
XES
Forces the job through XES processing to decentralized printers.
PCL5
Forces pass-through processing to PCL-capable printers.
AFPX
Forces page-formatted processing.
AFPA
Forces AFP processing.
NOTE: NM and DJDE processing are equivalent for centralized
printers.
Sample user exit
A sample user exit (XUXIT02A) is provided in XPFSAMP to demonstrate
this feature.
Section Four: Printing Documents with XPAF
31-4
General information
Printing pass-through documents to PCL-capable printers
You can send a data stream specifying pass-through mode to any
XPAF-supported decentralized or PCL-capable printer if the printer
supports the printer command language of the data stream. (For example,
the data stream for a PCL document does not require a print command
conversion by XPAF before being sent to a PCL-capable printer.) Data
streams which may be printed in pass-through mode include:
•
•
•
•
HPGL
PCL
PostScript
XES
CAUTION: If you try to print a pass-through document through XPAF
to a non-Xerox printer, results will be unpredictable.
Resource processing
XPAF does not perform any conditioning on resources included in a
pass-through document. All of the information required to print the
document must be contained within the data stream because the data
stream is sent directly to the printer without being altered.
Font availability for banner pages
When printing banner pages for pass-through documents, XPAF uses the
default font specified in the PORTFONT or LANDFONT printer profile
parameter. The default fonts for PCL-capable printers are P0612A and
L0112B, which are supplied in the decentralized font library. If you have
changed the values for your default portrait and/or landscape fonts, you
may need to update the PORTFONT and/or LANDFONT printer profile
parameters to specify fonts that are available in the decentralized font
library.
Color processing
If the HPGL and PostScript emulators in your Xerox printer support color,
then HPGL and PostScript pass-through documents also will be printed in
color.
Section Four: Printing Documents with XPAF
31-5
General information
Printer commands
Since XPAF performs no verification on the document, you can include
any available HPGL, PCL, PostScript, or XES commands in your data
stream.
However, if a pass-through data stream contains commands that are not
supported by the target printer, unpredictable results may occur. For
example, unpredictable results will occur if you send a document
containing PCL color commands to a PCL-capable printer that does not
support color.
Section Four: Printing Documents with XPAF
31-6
General information
Job submission
To print a pass-through document through XPAF, perform these steps:
Step 1.
On the system where the pass-through document was created, print the
document to disk.
Step 2.
Upload the file from the PC or disk to the host system. Be sure to use a
binary upload.
NOTE: If you use any upload procedure besides binary, you may not
be able to print the file.
Step 3.
Ensure that you have specified PCLREQ=PASS in either the printer’s
profile or the extended JCL to indicate that the document prints in
pass-through mode.
Step 4.
Ensure that you have specified a value for the PCLDS extended JCL
keyword to indicate the type of data stream to be printed.
Step 5.
Submit the job for printing through XPAF. Make sure you include a DD
statement, similar to this one, in the JCL used to submit the job:
//OUTDD OUTPUT PCLDS=PCL5,PCLREQ=PASS
Section Four: Printing Documents with XPAF
31-7
General information
Troubleshooting problems
Occasionally, your output may not print as you expected. If this happens,
review the items in table 31-1 for information to help you resolve the
problem.
Table 31-1.
Common printing errors for pass-through documents
Symptom
Explanation
Steps to take
Printer commands are printed as
text.
The printer does not support the
specified printer command.
If a PJL command is printed,
remove the command from the
data stream.
When printing pass-through
documents, the output prints
incorrectly.
The data stream in pass-through
mode was changed by JES
because blank truncation was
specified.
Ensure that BLNKTRNC=NO is
specified for the output class to
indicate that blank truncation has
not been set.
Section Four: Printing Documents with XPAF
31-8
General information
Downloading resources
You can download resources to a printer that supports downloading
independently of any documents that may reference them. To do this,
specify the REVFONT, REVFORM, REVIMAGE, and REVLOGO
extended JCL keywords in the data stream.
For example, to download a form named ‘INV1’ and any fonts, images, or
logos that it references, use JCL similar to this:
//job-name JOB job-information
//DOWNLD EXEC PGM=IEBGENER
//OUT OUTPUT REVFONT=*,REVFORM=*,REVIMAGE=*,REVLOGO=*
//SYSIN
DD DUMMY
//SYSPRINT DD SYSOUT=*
//SYSUT2
DD SYSOUT=*,OUTPUT=*.OUT
//SYSUT1
DD *
@@@DJDE FORMS=INV1,END;
TEST RESOURCE DOWNLOAD.
/*
This JCL enables you to download a resource with a minimum of printed
text.
Section Four: Printing Documents with XPAF
31-9
General information
Using system-level features
Some features that affect XPAF’s processing of your documents are set
up at installation. This section provides a brief description of these
features to ensure that you are aware of them.
Banner pages
Banner pages, also known as separator pages, are issued with each print
job and contain job information, such as the user ID, job ID, and print date.
A banner page may be issued as a header page, a trailer page, and/or a
separator page between datasets.
Selecting the banner page format
XPAF uses its default format for banner pages unless your systems
programmer specified another format during installation. The format of
banner pages at your site may have been changed through parameters,
keywords, or user exits. For information on setting up banner pages, refer
to Section Two: Installing and Customizing XPAF.
Changing the banner page format
To request a different format for the banner pages for your print jobs,
contact your systems programmer.
Checkpoint restart
For DJDE, page-formatted, and AFP documents sent to centralized,
decentralized, and PCL-capable printers, XPAF supports a checkpoint
restart.
Initiating a checkpoint restart
The console operator can initiate a checkpoint restart using standard
JES2 or JES3 printer commands for interrupting or halting a printer, or the
XPAF-exclusive command TERMINATE TASK. For each type of
document, processing resumes from the most recent checkpoint as
specified in the CKPTPAGE JES printer parameter.
Refer to Section Seven: XPAF Operator Guide for more information about
using operator commands.
Section Four: Printing Documents with XPAF
31-10
General information
Changing the checkpoint interval
At the system level, your systems programmer may have set the interval
between checkpoints using the CKPTPAGE JES printer parameter in the
JES printer definition. Contact your systems programmer if you need the
system-level interval changed.
For a particular document, you can set the interval between checkpoints
by including the CKPTPAGE IBM JCL keyword in the JCL used to submit
the job. Refer to Section Five: XPAF Parameter and Keyword Reference
for information about the CKPTPAGE IBM JCL keyword.
Forward spacing and backspacing a document
For line-mode, DJDE, XES, page-formatted, and AFP documents sent to
centralized, decentralized, and PCL-capable printers, XPAF supports
forward spacing and backspacing. For each type of document, the printer
forward spaces or backspaces to a specified page number from the
current page being printed by XOSF (this may not be the actual page that
is being printed by the printer).
Initiating forward spacing and backspacing
The console operator initiates forward spacing and back spacing using
standard JES2 or JES3 printer commands for forward spacing or
backspacing documents.
Limitation
When using this feature, forward spacing or backspacing to a specified
line number or across dataset boundaries is not supported.
Section Four: Printing Documents with XPAF
31-11
General information
Printing to file or disk
In addition to printing, you can direct any line-mode, DJDE,
page-formatted, or AFP document that XPAF has prepared for a
centralized printer to disk and/or file. This allows you to archive printable
output for later use. For example, you could use this feature to create a
disk backup of an important document, or to store your output to file and
send it to a service bureau for printing.
Enabling this feature
This feature must be enabled at installation using a combination of
initialization and printer profile parameters:
•
You must specify values for the OPDALLOC, OPDUNIT, OPHLQ,
OPTEXPDT, OPTUNIT, OPTVOLCT, and OPVOLSER initialization
parameters to enable dynamic allocation of file and/or disk datasets.
•
You also must specify the WRITER printer profile parameter to
specify the output destination (printer, file, and/or disk).
For more information about setting up XPAF to print to file and/or disk,
refer to Section Two: Installing and Customizing XPAF. For a complete
description of the identified parameters, refer to Section Five: XPAF
Parameter and Keyword Reference.
Selecting the destination for a particular document
At print time, you can direct a specific document to any supported
combination of printer, file, and/or disk by specifying the OPWRITER
extended JCL keyword in the JCL used to submit the job. For more
information about this keyword, refer to Section Five: XPAF Parameter
and Keyword Reference.
Before you attempt to direct a particular document to file and/or disk,
contact your systems programmer to verify that this feature has been
enabled.
Printing output from file
To print a document that was written to file using the output-to-file option,
the DFAULT PDL distributed in XPFSAMP must have been downloaded
to the printer and compiled using the PDL printer command. Mount the file
on the printer’s file drive, then at the printer console, enter this command:
START file,DEFAULT
Limitation — maximum record length
When using this feature, note that the maximum output record length
supported is 256 bytes. If your input record length is greater than 256
bytes, data will be truncated in the output record that is written to file or
disk. However, when the data is printed on a centralized printer, the
output is not truncated.
Section Four: Printing Documents with XPAF
31-12
General information
SMF recording
XPAF supports IBM’s System Management Facility (SMF) recording
capability for line-mode, DJDE, XES, page formatted, and AFP document
types. SMF recording is not supported for pass-through documents.
XPAF writes an enhanced SMF type 6 PSF record when document
processing is complete, and stores it in the system SMF dataset, if
recording has been activated.
While XPAF supports SMF recording for printing via TCP or BARR
configurations and other intermediate spooling devices, note that for
these configurations, your SMF records will reflect job creation
information instead of actual printing information. Therefore, you may see
differences in your SMF statistics for these types of jobs. For example, the
SMF record will be updated even if the job did not print.
XPAF also supports SMF recording when running in either
XPSC-compatibility mode or XPAF full-client mode:
•
In XPSC-compatibility mode, XPAF writes one SMF record in the
XPSM format.
•
In XPAF full-client mode, you may choose to have XPSM write either
an SMF record for XPAF processing; an SMF record for XPSM
processing; or two records, one for each type of processing. The
SMF record written by XPSM is not a type 6 record.
For further information on SMF recording for XPSM, refer to the XPSM
user documentation.
Activating
You can activate SMF recording at installation based on the system for
which you wish to receive information:
•
For XPAF, specify the SMF initialization parameter.
•
For XPSC-compatibility mode or XPAF full-client mode, specify the
XPSMBRS and/or XPSMSRS initialization parameters.
For each type of system, SMF recording also can be controlled through
the SET SMF RECORDING ON|OFF operator command.
For more information about these initialization parameters, refer to
Section Five: XPAF Parameter and Keyword Reference. For more
information about the SET SMF RECORDING ON|OFF operator
command, refer to Section Seven: XPAF Operator Guide.
Accessing SMF accounting information
If you need access to SMF accounting information, contact your systems
programmer. For more information about SMF processing, refer to
Section Two: Installing and Customizing XPAF.
SMF accounting for VIPP documents
SMF impression and page counts for VIPP documents are based on a
simple count of 'Skip to Channel 1' carriage control characters and may
Section Four: Printing Documents with XPAF
31-13
General information
not reflect the actual number of pages that are printed with the associated
JDT.
A true page count should be determined from the printer accounting logs.
User exits
Your site may use user exits to modify XPAF processing (for example, to
modify banner page processing).
Implementing
Typically, user exits are coded and SMP/E-installed during XPAF
installation, although user exits also may be added or changed at a later
date. For information on coding and installing user exits, refer to Section
Two: Installing and Customizing XPAF.
Getting information about user exits at your site
Contact your systems programmer to determine if any user exits are
currently implemented at your site, or to request that a user exit be
implemented.
Section Four: Printing Documents with XPAF
31-14
Printing line-mode documents
32.
32
Printing line-mode documents
This chapter contains the information you need to print line-mode
documents through XPAF. It addresses these topics:
•
Verifying that your resources have been set up correctly
•
Including resources in your documents
•
Modifying the processing of your documents
•
Using advanced features, such as color
•
Processing line-mode documents as DJDE or AFP documents
In addition, it provides troubleshooting tips for resolving some of the
common problems you may encounter as you print line-mode documents.
Data stream definition
Line-mode (or 3211) documents are data streams which consist of
carriage control commands and line data.
If you enhance the look of your line-mode data streams by using extended
JCL keywords, XPAF no longer considers the data stream a line-mode
data stream. XPAF will process it as the relevant data stream type.
XPAF support
You can print line-mode documents through XPAF to any supported
centralized, decentralized, PCL-capable printer or convert them to PDF.
Preparing resources
For many types of documents, there are issues related to resource
preparation that you need to address before you submit jobs for printing.
However, because line-mode documents contain no printer control
commands, they are printed using the fonts, forms, images, logos, colors,
and paper trays in effect at the printer at the time the document is printed.
•
For centralized printers, these attributes are determined by the
started JDE/JDL on the printer or the environment set up by the
previous job or job step.
•
For decentralized and PCL-capable printers or PDF devices, these
attributes are determined by the setup values of the specific printer.
Section Four: Printing Documents with XPAF
32-1
Printing line-mode documents
Using resources
Just as there are no steps needed to prepare resources for line-mode
documents, there are also no procedures for specifying resources.
Modifying document processing
For line-mode documents, extended JCL keywords are not used. If you
use extended JCL keywords, XPAF no longer considers it a line-mode
document. XPAF will process it as the relevant data stream type.
Using advanced features
Because line-mode documents contain no printer control commands,
advanced features, such as using color or selecting paper trays, are
limited to the defaults at the printer as defined by the started JDE/JDL,
printer setup, or operator command(s).
Printing documents
Submit your documents for printing using standard JCL. Make sure your
output class specifies a supported centralized, decentralized, or
PCL-capable printer or PDF device.
Section Four: Printing Documents with XPAF
32-2
Printing line-mode documents
Processing line-mode documents as DJDE or AFP
documents
You can cause XPAF to process a line-mode document as a DJDE or AFP
document by specifying the DEFLINE initialization or printer profile
parameter or the PRMODE IBM JCL keyword.
For more information about how XPAF determines the processing mode
for a document, refer to chapter 31, “General information.”
For DJDE processing
To change the processing mode to DJDE, use one of these options:
•
For all documents or documents directed to a particular printer,
specify DEFLINE=DJDE in your initialization parameters or printer’s
profile to force XPAF to process all line-mode documents as DJDE
documents using the default JDE/JDL.
•
For a particular document, specify PRMODE=DJDE in the JCL to
cause the line-mode document to be processed as a DJDE
document using the default JDE/JDL.
This processing applies only for decentralized and PCL-capable printers
or converting to PDF, because centralized printers always print in DJDE
mode. If the document is directed to a decentralized or PCL-capable
printer or converting to PDF, XPAF will process it through the
DJDE-to-XES conversion. The font will then be determined by the default
JDE/JDL rather than the active font on the decentralized printer, ensuring
that you receive consistent line-mode output from both centralized and
decentralized printers.
For AFP processing
To change the processing mode to AFP, use one of these options:
•
For all documents or documents directed to a particular printer,
specify DEFLINE=PAGE in your initialization parameters or printer’s
profile to force XPAF to process all line-mode documents as AFP
documents using the default PAGEDEF, FORMDEF, and CHARS
values.
•
For a particular document, specify PRMODE=PAGE in the JCL to
cause the line-mode document to be processed as an AFP
document using the default PAGEDEF, FORMDEF, and CHARS
values.
Section Four: Printing Documents with XPAF
32-3
Printing line-mode documents
Troubleshooting problems
Occasionally, your output may not print as you expected. If this happens,
review the items in table 32-1 for information to help you resolve the
problem.
Table 32-1.
Common printing errors for line-mode documents
Symptom
Explanation
The document does not fit on the
correct number of pages, or lines
do not break correctly on a page.
The active font on the printer uses
more space than you expected.
Typically, a monospaced font
uses more space than a
proportional font. For example:
For a centralized printer, review
the PDL to determine the font in
use. Once you have made any
changes needed, recompile the
PDL on the printer.
This is text
(arial 10 pt)
For a decentralized printer, check
the default font on the printer, and
select a new font if necessary.
This is text
(monotype.com 10 pt)
The document prints in the
incorrect orientation.
The print orientation for line-mode
documents is determined as
follows:
•
•
•
For centralized printers,
orientation is based on the
started JDL on the printer.
For decentralized printers,
orientation is based on the
orientation of the active font.
For PCL-capable printers
and PDF conversion,
orientation is determined by
the last active font on the
printer. If you use the XPAF
default banner page, this will
be a landscape font.
Steps to take
For a PCL-capable printer or
conversion to PDF, check the
default font specified in the
PORTFONT or LANDFONT
printer profile parameter, and
specify a new font if necessary.
For a centralized printer, review
the PMODE parameter in the
active PDE. Once you have made
any changes needed, recompile
the PDL on the printer.
For a decentralized printer, check
the orientation of the default font
on the printer.
•
To print a document in
portrait orientation, ensure
that a portrait font is
selected.
•
To print a document in
landscape orientation,
ensure that a landscape font
is selected.
For a PCL-capable printer or PDF
conversion, update your banner
page if necessary to specify a font
in the correct orientation.
When printing to a highlight color
printer, the document prints in
highlight color instead of black.
Someone has issued the
SUBSTITUTE INK command at
the highlight color printer’s
console to select the highlight
color.
Section Four: Printing Documents with XPAF
Issue another SUBSTITUTE INK
command to change the color
back to black.
32-4
Printing DJDE documents
33.
33
Printing DJDE documents
This chapter contains the information you need to print DJDE documents
through XPAF. It addresses these topics:
•
•
•
•
•
Verifying that your resources have been set up correctly
Including resources in your documents
Modifying the processing of your documents
Using advanced features, such as color
Converting DJDE documents to XES documents
In addition, it provides troubleshooting tips for resolving some of the
common problems you may encounter as you print DJDE documents.
Data stream definition
DJDE documents contain embedded Xerox printing commands called
Dynamic Job Descriptor Entries (DJDEs). DJDEs are control statements
that specify how a document should be printed on a centralized printer.
They allow you to dynamically modify the centralized printing environment
established by the PDL on the printer.
DJDE processing enables certain printer parameters to be changed from
one job, page, or record boundary to the next. For example, if the PDL on
your printer specified COPIES=2, but you needed five copies of a report,
you could override the PDL setting for that one report by coding a DJDE
in the input data stream to specify COPIES=5.
You can generate DJDE data streams in one of three ways:
•
Format a line-mode data stream using standard IBM and XPAF
extended JCL.
•
Code DJDEs directly in a data stream or use an application to
produce a data stream containing DJDEs. In addition, you can
modify the initial DJDE packet using standard IBM and XPAF
extended JCL.
•
Build an XJCFSIM table to generate the DJDEs. Refer to chapter 38,
“Using XPAF extended features,” for information on XJCF
processing.
For detailed information about using PDL and DJDEs, refer to your
centralized printer’s reference manual.
Section Four: Printing Documents with XPAF
33-1
Printing DJDE documents
XPAF support
You can print DJDE documents on supported centralized, decentralized,
and PCL-capable printers or convert them to PDF. During document
processing, XPAF converts any JCL keywords to DJDEs.
•
For documents sent to a centralized printer, no further processing is
required.
•
For documents sent to a decentralized printer, the DJDEs are
converted to XES commands.
•
For documents sent to a PCL-capable printer, the DJDEs are
converted to XES commands, then the XES commands are
converted to PCL commands.
•
For documents converted to PDF, the DJDEs are converted to XES
commands, then the XES commands are converted to PDF.
DJDE/Extended JCL keyword processing
Extended JCL keywords override DJDE parameters in the initial packet of
the data stream, which in turn override the PDL printer commands.
However, the extended JCL keywords do not override any subsequent
DJDE parameters in the data stream (that is, those not in the initial
packet).
Section Four: Printing Documents with XPAF
33-2
Printing DJDE documents
Preparing resources
For DJDE documents, there are tasks related to resource preparation that
you need to complete before you submit jobs for printing. Before you
begin printing documents, contact the system administrator responsible
for maintaining your print resources to ensure that the applicable tasks
have been completed.
NOTE: These tasks are summarized in table 33-1 and described in
detail in Section Three: Managing Resources with XPAF.
Table 33-1.
Resource preparation for DJDE documents
Resource type
Fonts
User actions needed
Print time processing
Load any centralized or decentralized
fonts you have purchased from Xerox Font
Services or a third-party vendor to the
appropriate native font libraries.
XPAF will download fonts from the native
font library if they have not been included
inline or if they are not resident on the
printer.
Convert a centralized font to decentralized
format if you do not have a decentralized
version of the font, but want to use the
same font in documents printed to both
centralized and decentralized printers.
XPAF does not dynamically convert
centralized fonts to decentralized format. If
you do not preconvert the font, document
processing will be terminated.
NOTE: All fonts included with XPAF,
except language-specific R03 fonts,
are provided in both centralized and
decentralized format, so
preconversion is not necessary for
these fonts. However, you must
preconvert language-specific R03
centralized fonts to decentralized
format.
Section Four: Printing Documents with XPAF
33-3
Printing DJDE documents
Table 33-1.
Resource preparation for DJDE documents (Continued)
Resource type
Fonts
(continued)
User actions needed
Print time processing
Before you convert a centralized font that
you have purchased from either Xerox
Font Services or a third-party vendor to
decentralized format, update the
applicable font tables as needed:
During centralized-to-decentralized font
conversion, XOAF uses the centralized
and decentralized character mapping
tables to determine where to place the
centralized characters in the decentralized
font.
•
Ensure that the Xerox Font
Information (XPAFXFI) entry for the
centralized font contains valid
centralized and decentralized
character mapping table names.
•
Verify that all expected character IDs
exist in the centralized character
mapping table, and that the character
IDs in the decentralized character
mapping table are mapped to the
desired code point and plane number
combination.
(optional) Create a resident font list for
each printer.
XPAF will check the printer’s font list to
determine whether a requested font is
resident on the printer. If the font is not
resident, XPAF will download it.
If the printer can store downloaded
resources permanently, XPAF will update
the printer’s font list when it downloads a
font.
Forms
Load your centralized and decentralized
forms to the appropriate native form
libraries.
XPAF will download forms from the native
form library if they have not been included
inline or if they are not resident on the
printer.
For documents sent to decentralized
printers, XPAF converts any centralized
forms referenced in the document to
decentralized format.
For documents sent to PCL-capable
printers, the decentralized (XES) form is
then converted to PCL format.
For documents converted to PDF, the
decentralized images are then converted
to PDF format.
(optional) Create a resident form list for
each printer.
XPAF will check the printer’s form list to
determine whether a requested form is
resident on the printer. If the form is not
resident, XPAF will download it.
If the printer can store downloaded
resources permanently, XPAF will update
the printer’s form list when it downloads a
form.
Section Four: Printing Documents with XPAF
33-4
Printing DJDE documents
Table 33-1.
Resource preparation for DJDE documents (Continued)
Resource type
Images
User actions needed
Load your centralized and decentralized
images to the appropriate native image
libraries.
Print time processing
XPAF will download images from the
native image library if they have not been
included inline or if they are not resident on
the printer.
For documents sent to decentralized
printers, XPAF converts any centralized
images referenced in the document to
decentralized format.
For documents sent to PCL-capable
printers, the decentralized images are then
converted to PCL format.
For documents sent to PDF devices, the
decentralized images are then converted
to PDF format.
(optional) Create a resident image list for
each printer.
XPAF will check the printer’s image list to
determine whether a requested image is
resident on the printer. If the image is not
resident, XPAF will download it.
If the printer can store downloaded
resources permanently, XPAF will update
the printer’s image list when it downloads
an image.
Logos
Load centralized logos to the native logo
library.
XPAF will download logos from the native
logo library if they have not been included
inline or if they are not resident on the
printer.
Convert centralized logos to decentralized
fonts for printing on decentralized printers.
XPAF does not dynamically convert
centralized logos to decentralized fonts. If
you do not preconvert the logo, document
processing will be terminated.
(optional) Create a resident logo list for
each centralized printer.
XPAF will check the printer’s logo list to
determine whether a requested logo is
resident on the printer. If the logo is not
resident, XPAF will download it.
If the printer can store downloaded
resources permanently, XPAF will update
the printer’s logo list when it downloads a
logo.
Section Four: Printing Documents with XPAF
33-5
Printing DJDE documents
Table 33-1.
Resource preparation for DJDE documents (Continued)
Resource type
Color
User actions needed
(Optional) For highlight color processing,
create a color cross-reference table to
map the ink color specified in a DJDE
document to the ink color loaded on the
highlight color printer.
Print time processing
XPAF will look in the specified color
cross-reference table to determine the
color to use; however, XPAF cannot verify
that the color specified in the table
matches the ink loaded on the printer.
Operator intervention will be required at
the printer under these circumstances:
Paper trays
•
If the color you specify in the color
cross-reference table is not loaded on
the printer.
•
If you have not created a color
cross-reference table, and the color
specified in the document does not
match the ink loaded on the printer.
(Optional) For full color processing using
custom colors not defined in the color
conversion table, update the color
conversion table to map centralized
highlight color to decentralized full color,
then load it in the appropriate native
library.
XPAF will use the color conversion table to
determine the RGB color values to be used
on the decentralized printer. If your
document uses a color not defined in this
table, XPAF will substitute black for the
undefined color.
Update any cluster mapping tables that
differ from your site’s setup to map
centralized paper tray cluster names to
paper trays on decentralized and
PCL-capable printers.
When printing to a decentralized or
PCL-capable printer, XPAF will attempt to
match the cluster name specified in the
document to an entry in the cluster
mapping table. It there is a match, XPAF
will use that entry to issue a tray select for
the tray specified.
NOTE: The paper size for a page is
determined by the PAPERSIZE= value in
the active JDE.
PDL
Load your PDL files to the native PDL
libraries. You must ensure that the PDL
members compiled on the printer are
identical to those loaded to the native PDL
libraries, or your results will be
unpredictable.
Section Four: Printing Documents with XPAF
XPAF will use the values in the specified
PDL files to help determine the format and
processing requirements for the
document.
33-6
Printing DJDE documents
Using resources
For DJDE documents, the fonts, forms, images, and logos you specify in
your document can be:
•
Included inline as part of the document. Inline resources are
specified using the FILE DJDE command in the data stream.
•
Resident on the printer. Printer-resident resources can be specified
using PDL, DJDEs, or extended JCL keywords.
•
Downloaded from an XPAF resource library at print time.
The following sections contain information about extended JCL keywords
you can use to specify and update resources at print time. For detailed
information about a particular keyword, refer to Section Five: XPAF
Parameter and Keyword Reference. For information about using PDL and
DJDEs to include resources in a document, refer to your centralized
printer’s reference manual.
Specifying
XPAF provides a number of extended JCL keywords which you can use
to specify fonts, forms, and images in your DJDE documents.
Fonts
You can specify up to 16 fonts to be used within a document using the
FONTnn extended JCL keyword. In conjunction with this keyword, you
can use the FINDEX extended JCL keyword to establish font indexing.
FINDEX enables you to specify the byte position, initial value, and number
of low order bits to use in the index.
If you do not specify a font using DJDEs or JCL keywords, the printer will
print the document using the font specified or defaulted to in the started
JDL on the printer.
Forms
You can specify forms using several extended JCL keywords:
•
Use the XFORMn extended JCL keyword to specify the names of up
to three forms to be printed in a document. If the document is
duplexed, the form(s) will be printed on both sides of the page.
•
Use the BFORMn extended JCL keyword to specify the names of up
to three forms to be printed on the back of a duplex page.
•
Use the RFORM extended JCL keyword to specify the form to be
included on all RTEXT pages.
Images
You can specify an image to be included in your DJDE document using
the IMAGE extended JCL keyword. This keyword enables you to specify
the name, position, and color attributes of an image.
Section Four: Printing Documents with XPAF
33-7
Printing DJDE documents
Logos
There are no extended JCL keywords available for specifying logos.
Logos can only be referenced through a form.
Revising
If your site has created or received a new version of a resource and
loaded it to the appropriate XPAF native resource library, the version in
the library may no longer match the version on the printer.
For data streams that reference Xerox native resources, you can specify
AUTOREV=XEROX in your initialization parameters or the printer's profile
to ensure that your document is printed using the most current version of
the resource.
To ensure that your document is printed using the most current version of
the resource, include the appropriate REVxxxxx extended JCL
keyword(s) in the JCL used to submit the job:
•
•
•
•
REVFONT
REVFORM
REVIMAGE
REVLOGO
REVxxxxx downloads the specified resource to the printer. Then, for
centralized and decentralized printers that are capable of permanently
storing resources, the resource is stored on the printer so it will be
available for subsequent jobs. For centralized printers only, if you also
have specified the equivalent DELxxxxx printer profile parameter or
extended JCL keyword (DELFONT, DELFORM, DELIMAGE, or
DELLOGO), the resource will not be stored on the printer.
Deleting
You may not want to keep all your resources resident on a printer. Some
reasons why you might want to delete them from the printer include:
•
Testing. If you are testing a new version of a font, form, image, or
logo, you may not want to store it until you are certain it is the
version you plan to use.
•
Security. If you want to ensure that a particular resource (such as a
licensed font or signature logo) cannot be copied from the printer,
you should not store it on the printer.
•
Limited printer disk space. If you have limited storage on your
printer, you can delete resources to increase the amount of space
available.
For centralized printers only, you can print a specific document without
storing one or more of its resources on the printer. To do this, use the
appropriate DELxxxxx extended JCL keyword(s):
•
•
•
•
DELFONT
DELFORM
DELIMAGE
DELLOGO
Section Four: Printing Documents with XPAF
33-8
Printing DJDE documents
Each of these keywords downloads the specified resource(s) to the
centralized printer. Then after the document is printed, it deletes them
from the printer so that they will no longer be available.
NOTE: You can include the DELxxxxx parameter(s) in the centralized
printer’s profile to specify that for all documents, the resources that
are downloaded will be deleted from the printer after use.
Section Four: Printing Documents with XPAF
33-9
Printing DJDE documents
Modifying document processing
There are many document features you can change at print time using
XPAF-supplied parameters and keywords. This section summarizes the
extended JCL keywords available in XPAF to change DJDE document
processing. Refer to Section Five: XPAF Parameter and Keyword
Reference for information about the keywords identified in this section
and for IBM JCL keywords available for DJDE processing.
Table 33-2.
Extended JCL keywords for DJDE processing
Extended JCL
keyword
Function
BEGIN1– BEGIN4
Defines the origins for up to four logical pages per physical
page.
BOF
Specifies the bottom-of-form line number.
CHAN01– CHAN12
Assigns a line number to a channel assignment.
CME
Identifies the copy modification entry to be used for printing
the document.
FORMAT
Specifies the PDE to be used to format a document.
JDE
Identifies the JDE to be used for the document.
JDL
Identifies the JDL to be used for the document.
MARGIN
Specifies the left page margin for the document to be
printed.
PMODE
Specifies the print orientation for the document.
SIDE
Species the positioning of the first logical page of the
document to the first logical page of a physical sheet.
TOF
Specifies the top-of-form line number. This is the line with
reference to the top of page on which the first line of text will
print in an overflow condition.
Section Four: Printing Documents with XPAF
33-10
Printing DJDE documents
Using advanced features
Through XPAF, you can print DJDE highlight color documents to both
highlight and full color printers. If your printer is equipped with finishing
equipment, you can use Document Finishing Architecture (DFA) interface
support.
Highlight color
Highlight color DJDE documents can be printed on any centralized printer,
PCL-capable printer that supports PCL5C color printing or when
converted to PDF. By using extended JCL keywords, you can override the
colors selected by DJDEs (for example, INKXREF) or add color not
included in the original DJDEs (for example, COLORIMG).
If you use extended JCL keywords to add highlight color to a DJDE
document, you also can print that document on a printer that does not
support color. XPAF will ignore the color-related extended JCL keywords
and the document will be printed in black.
Mapping color requests
If the text colors in your document do not match the colors on the highlight
color printer, you can map the color requests to the colors on your printer
through color cross-reference tables. When you print a document, XPAF
changes the color request from the color coded in the data stream to the
color specified in the color cross-reference table.
You can print a highlight color document to a PCL-capable printer that
supports PCL5C color printing or convert the document to PDF without
modifying the document. XPAF uses the color conversion table to convert
highlight color requests to RGB format for the text only. You can update
the color conversion table if you want to change its default color
assignments or add custom colors. If you modify the color conversion
table, you must reload it using either the XOAF Maintain the Color
Conversion Table option on the Manage Tables menu or the LOAD INKS
TSO/batch command.
Refer to Section Three: Managing Resources with XPAF for more
information about creating, maintaining, and loading these tables.
Section Four: Printing Documents with XPAF
33-11
Printing DJDE documents
Using color resources
You can include color forms, images, and logos in your DJDE documents.
Forms
The color forms you create using the XPAF Forms Generator can be
printed through XPAF without modification.
Images and logos
Images that have not been converted to color format can be printed in
color using the COLORIMG extended JCL keyword.
Using extended JCL keywords
Using extended JCL keywords, you can specify highlight color features for
a document. Extended JCL keywords override any corresponding DJDE
keywords included in the initial packet of a document.
Table 33-3.
Highlight color-related extended JCL keywords for DJDE documents
Extended JCL
keyword
Function
COLORIMG
Identifies colors to be applied to up to eight IMAGE DJDE records that are not
already coded with an INKREF name.
ICATALOG
Identifies the ink catalog to use when ink references do not specify an ink catalog.
IDFAULT
Identifies the ink to be used when an ink is not specified in a resource.
IDR
Specifies the ink descriptor name.
ILIST
Specifies up to eight ink reference names to be used in an ink list and referenced
by the ink index.
IMAGE
Defines image positioning and color parameters for the named image.
INKINDEX
Specifies the position within a user data record that contains the index to a specific
ink reference name.
INKXLIB
Identifies the DD name of the library where the color cross-reference tables are
stored.
INKXREF
Identifies the name of the color cross-reference table.
IRESULT
Identifies the ink to be used when different inks overlay on a pixel.
NUMBER
Specifies that page numbers will be printed for a document, and in which color they
will be printed
Section Four: Printing Documents with XPAF
33-12
Printing DJDE documents
Table 33-3.
Highlight color-related extended JCL keywords for DJDE documents (Continued)
Extended JCL
keyword
Function
PALETTE
Identifies the color palette to be used on the page.
XMP
Specifies whether to use Xerographic mode switching (XMS) to print the entire
document using highlight color print mode.
Color-related keyword overrides
This table shows the overrides for printer commands, initial packet
DJDEs, and extended JCL keywords.
Table 33-4.
Color-related keyword overrides for DJDE documents
PDL command/parameter
Overridden by
DJDE keyword in
the initial packet
Overridden by
extended JCL
keyword
ABNORMAL/IMISMATCH
ABNORMAL/ISUBSTITUTE
CME/INK
IDR/ICATALOG
ICATALOG
ICATALOG
IDR/ILIST
ILIST
ILIST
IDR/PALETTE
PALETTE
PALETTE
LINE/INKINDEX
INKINDEX
INKINDEX
OUTPUT/BFORM
BFORM
BFORM1– BFORM3
OUTPUT/FORMS
FORMS
XFORM1– XFORM3
OUTPUT/IDFAULT
IDFAULT
IDFAULT
OUTPUT/IDR
IDR
IDR
OUTPUT/IMAGE
IMAGE
IMAGE
OUTPUT/IRESULT
IRESULT
IRESULT
OUTPUT/NUMBER
NUMBER
NUMBER
OUTPUT/XMP
XMP
XMP
OUTPUT/CYCLEFORMS
Section Four: Printing Documents with XPAF
33-13
Printing DJDE documents
Document finishing
You can use XPAF features to control some aspects of document
finishing, including:
•
•
•
•
•
Collating
Shifting data for binding purposes
Stapling
Setting the finishing boundary
Paper tray selection
Collating
For centralized printers only, when you are printing multiple copies of a
document, you can use the COLLATE extended JCL keyword to ensure
that XPAF prints one complete copy of the document before starting the
next copy.
Shifting output for binding
You can use the SHIFT extended JCL keyword to specify a shift of the
page data for binding purposes. Shifting data toward the outer edge of the
page helps prevent text from being obscured when pages are bound
together or hole-punched.
Stapling
For centralized printers that support stapling, you can staple documents
by specifying the JDE extended JCL. This keyword must name a JDE that
is coded for stapling.
XPAF provides a sample JDE called STAPLE in the XPFSAMP member
DFAULT. STAPLE has been commented out. To use it, you must
uncomment it, then load it into your PDL library on the host, and compile
it on the printer.
You can use your own JDE if you wish. The JDE must contain a statement
similar to this:
OUTPUT STAPLE=YES,NT01=YES,FACEUP=YES;
The JDE must be loaded into your PDL library on the host, downloaded to
the printer, and compiled.
Section Four: Printing Documents with XPAF
33-14
Printing DJDE documents
Setting the finishing boundary
For centralized printers only, you can specify a finishing boundary for a
document if your printer supports the Document Finishing Architecture
(DFA) interface (version 4.1 or higher). The output is finished at the end
of the document.
To specify a finishing boundary, perform these steps:
Step 1.
Ensure that the printer’s profile specifies FEATURE=DFA.
Step 2.
Use the SF1 and/or SF2 extended JCL keywords in your JCL to instruct
XPAF to send DJDEs to the printer to raise (that is, turn on) or lower (that
is, turn off) signal function 1 and/or signal function 2 for document
finishing purposes.
Refer to Section Five: XPAF Parameter and Keyword Reference for more
information about the SF1 and SF2 extended JCL keywords. For more
information about DJDEs, refer to the PDL/DJDE reference manual for
your printer.
NOTE: XPAF does not determine the function of signal function 1 and
signal function 2; the signal’s function is defined by the third-party
finishing equipment. Refer to the finishing equipment documentation
supplied by your third-party vendor for more information about the
equipment’s use of signal functions.
Using extended JCL keywords
Using extended JCL keywords, you can specify several finishing features
for a document
Table 33-5.
Finishing-related extended JCL keywords for DJDE documents
Extended JCL
keyword
Function
COLLATE
Specifies whether the output will be collated.
SF1
Specifies that XPAF will send a DJDE to the centralized printer
to control signal function 1 at the start of a page.
SF2
Specifies that XPAF will send a DJDE to the centralized printer
to control signal function 2 at the start of a page.
SHIFT
Specifies a shift of the page data for binding purposes.
Section Four: Printing Documents with XPAF
33-15
Printing DJDE documents
Paper tray selection
XPAF uses cluster mapping tables to map a centralized paper tray cluster
name to a paper tray on a decentralized or PCL-capable printer.
XPAF provides a default cluster mapping table for each printer model.
You can also specify your own cluster mapping tables using the
CLUSTRTB printer profile parameter or extended JCL keyword. Refer to
Section Three: Managing Resources with XPAF for a discussion on how
cluster mapping tables are used and for instructions on creating and
updating the cluster mapping tables.
CAUTION: If you specify a value for PAPERSIZ in your extended
JCL, that value overrides the PAPERSIZE= value in the active JDE.
All other cluster mapping table processing occurs normally.
Using extended JCL keywords
Using extended JCL keywords, you can specify several paper-related
table features for a document.
Table 33-6.
Paper table-related extended JCL keywords for DJDE documents
Extended JCL
keyword
Function
CLUSTRTB
Identifies the cluster mapping table used by XPAF to map a centralized paper tray cluster
name to a paper tray on a decentralized or PCL-capable printer.
FEED
Specifies the printer cluster (paper tray group) from which paper will be selected.
NOTE: When printing to a decentralized or PCL-capable printer, XPAF matches the
value for this keyword to an entry in the cluster mapping table to determine the paper
size and decentralized paper tray.
PAPERSIZ
Specifies the paper size to be used for the document. The paper loaded in the tray from
which the job feeds must be the same size as you specify using this keyword.
CAUTION: The value for this keyword overrides any PAPERSIZE= entries in the
currently active JDE.
PAPNAMTB
Identifies the paper name table used by XPAF to determine the physical paper size
dimensions that correlate to a specified paper name.
Section Four: Printing Documents with XPAF
33-16
Printing DJDE documents
Printing documents
Submit your documents for printing using standard JCL. Make sure your
job class references a supported centralized, decentralized, or
PCL-capable printer or PDF device.
NOTE: The next section contains information about converting DJDE
documents to XES documents for printing on decentralized printers.
If you direct your document to a PCL-capable printer, the DJDE
commands will be converted to XES commands, then the XES
commands are converted to PCL commands. Refer to chapter 34,
“Printing XES documents” for information about the XES-to-PCL
conversion.
Section Four: Printing Documents with XPAF
33-17
Printing DJDE documents
Converting DJDE documents to XES documents
If you direct a DJDE document to a decentralized printer, XPAF will
convert the DJDE commands into XES commands. Print lines are then
formatted with XES commands so that the printed results will match the
results from a centralized printer.
Processing overview
When printing documents to a decentralized printer, the DJDE-to-XES
conversion is invoked whenever:
•
A DJDE command is found in the first record of the data stream
•
PRMODE=DJDE is specified in the JCL used to submit the job
This includes jobs conditioned by extended JCL that reference features
that are invoked by DJDEs. The DJDE environment is maintained
between datasets and is reset only when a banner page/RSTACK
condition is detected.
Default values
The PDL stored in your native PDL library is used to apply default JSL
values and cataloged member values. A native PDL library is specified in
the XOSF start-up proc DD statement named by the PDLLIB initialization
or printer profile parameter. If this library does not exist or is not loaded
with current information, the job formatting will be limited to values found
in the DJDEs.
Multiple-step jobs
For multiple-step jobs sent to decentralized or PCL-capable printers, if
line-mode data is in a separate step from the DJDEs that format the data,
XPAF may print the data as a line-mode document using the
decentralized or PCL-capable printer’s default font, respectively. If this
happens, you must force the line-mode data to go through the
DJDE-to-XES conversion and use the formatting parameters from the
previous DJDE step. You can do this in one of several ways:
•
Include a DJDE command in the first record of the line-mode data
stream.
•
Specify PRMODE=DJDE in your JCL to identify the line-mode data
stream as DJDE data stream.
•
Specify DEFLINE=DJDE in your initialization parameters or printer’s
profile to force all line-mode data to be treated as DJDE data.
Section Four: Printing Documents with XPAF
33-18
Printing DJDE documents
Supported DJDE/PDL statements
Table 33-7 lists the DJDE and PDL statements supported for
DJDE-to-XES conversion. This table does not list any DJDE and PDL
statements that are either not applicable or not supported.
Table 33-7.
DJDE/PDL statements supported for DJDE-to-XES conversion
DJDE/PDL statement
Command
BANNER
HCOUNT
BANNER
TCOUNT
BANNER
TEST
CME
CONSTANT
CME
FONT
CME
INK
CME
LINE
CME
POSITION
CODE
ASSIGN
CODE
DEFAULT
CRITERIA
CHANGE
CRITERIA
CONSTANT
CRITERIA
LINENUM
DJDE
ALTER
DJDE
ASSIGN
DJDE
BATCH
DJDE
BEGIN
DJDE
BFORM
DJDE
BOF
DJDE
C (comment)
DJDE
CANCEL
DJDE
COLLATE
DJDE
COPIES
DJDE
DATA
Section Four: Printing Documents with XPAF
Limitations
33-19
Printing DJDE documents
Table 33-7.
DJDE/PDL statements supported for DJDE-to-XES conversion (Continued)
DJDE/PDL statement
Command
DJDE
DUPLEX
DJDE
END
DJDE
FEED
DJDE
FILE
DJDE
FONTINDEX
DJDE
FONTS
DJDE
FORMAT
DJDE
FORMS
DJDE
GRAPHIC
DJDE
IDFAULT
DJDE
ILIST
DJDE
IMAGE
DJDE
INKINDEX
DJDE
ITEXT
DJDE
JDE
DJDE
JDL
DJDE
MARGIN
DJDE
MODIFY
DJDE
NUMBER
DJDE
OTEXT
DJDE
OVERPRINT
DJDE
PMODE
DJDE
RFORM
DJDE
RTEXT
DJDE
SHIFT
DJDE
SIDE
DJDE
STOCKS
Limitations
Only .FRM and .IMG files are recognized and are
treated as temporary resources
Section Four: Printing Documents with XPAF
33-20
Printing DJDE documents
Table 33-7.
DJDE/PDL statements supported for DJDE-to-XES conversion (Continued)
DJDE/PDL statement
Command
DJDE
TOF
IDEN
OFFSET
IDEN
PREFIX
IDEN
SKIP
IDR
ILIST
LINE
DATA
LINE
FONTINDEX
LINE
INKINDEX
LINE
MARGIN
LINE
OVERPRINT
LINE
VFU
OUTPUT
BFORM
OUTPUT
COLLATE
OUTPUT
COPIES
OUTPUT
COVER
OUTPUT
CYCLEFORMS
OUTPUT
DUPLEX
OUTPUT
FEED
OUTPUT
FORMAT
OUTPUT
FORMS
OUTPUT
GRAPHIC
OUTPUT
IDFAULT
OUTPUT
IMAGE
OUTPUT
MODIFY
OUTPUT
NUMBER
OUTPUT
OFFSET
OUTPUT
PAPERSIZE
Limitations
Supported only on duplex printers.
Section Four: Printing Documents with XPAF
33-21
Printing DJDE documents
Table 33-7.
DJDE/PDL statements supported for DJDE-to-XES conversion (Continued)
DJDE/PDL statement
Command
OUTPUT
SHIFT
PDE
BEGIN
PDE
FONTS
PDE
PMODE
RAUX
TEST
RFEED
TEST
ROFFSET
TEST
ROUTE
RFORM
ROUTE
RTEXT
RPAGE
SIDE
RPAGE
TEST
RPAGE
WHEN
RSTACK
DELIMITER
RSTACK
TEST
TABLE
CONSTANT
TABLE
MASK
VFU
ASSIGN
VFU
BOF
VFU
TOF
VOLUME
CODE
Limitations
Only these options are supported: IGNORE-CHAR,
CHARSPEC1, and CHARSPEC2.
Section Four: Printing Documents with XPAF
33-22
Printing DJDE documents
Processing limitations
When directing a DJDE document to a decentralized or PCL-capable
printer or converting to PDF, restrictions apply to certain elements,
including:
•
•
•
•
•
Decentralized printer functionality
Image magnification
Operator messages
Paper trays
Color start Metacodes
Color start Metacodes
When using the Fill color start (X'0A') and Highlight color start (X'0C')
metacodes, an INKLIST must be used to determine the color to use.
Decentralized printer functionality
These limitations apply for decentralized printers:
•
Output from a DJDE-to-XES conversion is limited to the functionality
of the destination decentralized printer. XPAF ignores DJDE and
PDL commands that do not apply to the destination decentralized
printer.
•
Because of differences in the printers’ hardware and software, XPAF
handles invalid DJDE packets differently for centralized and
decentralized printers. Results vary depending on the invalid
command and cannot be predicted.
Section Four: Printing Documents with XPAF
33-23
Printing DJDE documents
Image magnification
Output from a DJDE-to-XES conversion limits centralized image
magnification to two or four times the actual size. This is a limitation of
decentralized image processing.
Table 33-8 shows the differences between centralized and decentralized
image magnification (assuming that x is your centralized image
magnification factor).
Table 33-8.
Image magnification factors
Centralized
Decentralized
0.125  x  2
1
2x4
2
4x8
4
Operator messages
These limitations apply to the ITEXT and OTEXT extended JCL keywords:
•
ITEXT or OTEXT messages cannot be specified for a particular copy
of a job.
•
OTEXT messages that specify the END parameter appear at the
start of the output print job rather than at the end.
•
The WAIT parameter is ignored, and operator intervention is
required to continue printing the job.
Paper trays
These limitations apply to paper tray processing:
•
Paper tray remapping on the printer is not supported. You should
use a cluster mapping table instead to define paper tray mapping for
decentralized and PCL-capable printers.
•
Because it is a centralized printer operator command, XPAF cannot
support the CLUSTER printer command during DJDE-to-XES
conversion. Use a cluster mapping table instead to define paper tray
mapping for decentralized and PCL-capable printers.
•
XPAF will terminate processing of any document with a PDL-defined
paper size that is not supported by the destination decentralized or
PCL-capable printer.
Section Four: Printing Documents with XPAF
33-24
Printing DJDE documents
Troubleshooting problems
Occasionally, your output may not print as you expected. If this happens,
review the items in table 33-9 for information to help you resolve the
problem.
Table 33-9.
Common printing errors for DJDE documents
Symptom
Explanation
Steps to take
The printed output contains a
blank page prior to the first page
of data.
A blank page is printed prior to the
first page of data for DJDE jobs
whose first record contains a
space 1 line and print ANSI
carriage control (space character)
and a DJDE.
To prevent a blank page from
printing, replace the space 1 line
and print carriage control
character on the first DJDE record
with a write without spacing
carriage control character (+).
The printed output contains form
positioning errors.
If no paper size is specified in the
source version of a form, XPAF
uses a default value of LETTER
(8 1/2 inches by 11 inches).
Ensure that the appropriate paper
size value is specified in the
source version of the form, then
recompile it.
If the form you want to print was
designed for a paper size other
than LETTER, but no paper size
was specified in the form, then the
form will be mispositioned when
printed through XPAF.
After you start the printer and
submit a job, XPAF fails with an
0C1 abend.
If you recently applied z/OS/JES
maintenance but did not rerun the
XPAF usermod installation job,
then XPAF no longer has access
to the correct JES control block
offsets for processing at your site.
Section Four: Printing Documents with XPAF
Resubmit UMJOB101 to APPLY
the JES offset table.
33-25
Printing DJDE documents
Table 33-9.
Common printing errors for DJDE documents (Continued)
Symptom
DJDEs are printed as data.
Explanation
You have mismatched values in
your initialization parameters,
extended JCL keywords, and/or
PDL. These mismatched values
can cause two types of errors:
•
•
When printing a multiple-step job
to a decentralized or PCL-capable
printer, data is not formatted
correctly.
XPAF may process the DJDE
document in another mode
(such as AFP).
Steps to take
Issue the SET INTENSIVE
LOGGING ON operator command
to enable intensive logging to the
XPAF log dataset. Review the log
for messages identifying the
processing mode in effect.
•
If AFP processing is active,
ensure that the SYSFCB
initialization parameter value
matches the JES default FCB
value, and that the
SYSFONT initialization
parameter value matches the
JES default UCS value.
•
If DJDE processing is active,
ensure that your IDENnn,
DJDEOFnn, and DJDESKnn
initialization parameter
values match the
corresponding values in the
PDL.
XPAF may be unable to
recognize the DJDEs in the
document.
If the line-mode data is in a
separate step from the DJDE
packets that format the data,
XPAF may print the data as a
line-mode document using the
decentralized or PCL-capable
printer’s default font.
Section Four: Printing Documents with XPAF
You must force the line-mode
data to go through the
DJDE-to-XES conversion and use
the formatting parameters from
the previous DJDE step. Perform
one of these actions:
•
Include a DJDE command in
the first record of the
line-mode data stream.
•
Specify PRMODE=DJDE in
your JCL to identify the
line-mode data stream as a
DJDE data stream.
•
Specify DEFLINE=DJDE in
your initialization parameters
or printer’s profile to force all
line-mode data to be treated
as DJDE data.
33-26
Printing XES documents
34.
34
Printing XES documents
This chapter contains the information you need to print XES documents
through XPAF. It addresses these topics:
Verifying that your resources have been set up correctly
•
•
•
•
Including resources in your documents
Modifying the processing of your documents
Using advanced features, such as color
Converting XES documents to PCL documents
In addition, it provides troubleshooting tips for resolving some of the
common problems you may encounter as you print XES documents.
Data stream definition
In XES data streams, escape sequences dynamically change parameters
for decentralized printers. You can define a user-defined key (UDK),
which acts as a signal to the printer that an escape sequence follows.
Escape sequences can be used to define the format and processing for a
document. For example, you can include escape sequences that position
text on a page, draw rules, and change fonts. Refer to your decentralized
printer XES reference manual for more information on XES commands.
Expected format of XES data stream
When printing native mode XES data streams via XPAF, the data stream
must meet these criteria:
•
Be in EBCDIC encoded format
•
The first record must contain =UDK= starting in the first column
•
For data streams being sent to PCL-capable printers or converted to
PDF, include only supported XES commands
For a listing of XES commands supported for PCL-capable printers or
converted to PDF, refer to “Supported XES commands” later in this
chapter and your printer documentation.
Section Four: Printing Documents with XPAF
34-1
Printing XES documents
XPAF support
You can print XES documents through XPAF to any decentralized or
PCL-capable printer or convert them to PDF.
•
When printing to a decentralized printer, XPAF accepts escape
sequences and sends them to the printer without conversion.
•
When printing to a PCL-capable printer, XPAF converts the escape
sequences to PCL commands before sending them to the printer.
•
When printing to a PDF-capable printer, XPAF converts the escape
sequences to PDF commands before sending them to the printer.
NOTE: XES documents cannot be printed on centralized printers.
Section Four: Printing Documents with XPAF
34-2
Printing XES documents
Preparing resources
For XES data streams, there are tasks related to resource preparation
that you need to complete before you submit jobs for printing. Before you
begin printing documents, contact the system administrator responsible
for maintaining your print resources to ensure that the applicable tasks
have been completed.
NOTE: These tasks are summarized in table 34-1 and described in
detail in Section Three: Managing Resources with XPAF.
.
Table 34-1.
Resource preparation for XES documents
Resource type
Fonts
User actions needed
Print time processing
Load any decentralized fonts you have
purchased from either Xerox Font Services
or a third-party vendor to the native
decentralized font library.
XPAF will download decentralized fonts
from the native font library if they have not
been included inline or if they are not
resident on the decentralized printer.
NOTE: If you are using PCL or PDF
-capable printers, you do not load
fonts to the PCL or PDF font library;
XPAF converts decentralized fonts to
PCL or PDF bitmapped format during
processing, then stores them in the
PCL or PDF font library for
subsequent use.
If you have purchased centralized fonts
from either Xerox Font Services or a
third-party vendor, you can convert those
fonts to decentralized format and specify
them in XES documents sent to
decentralized or PCL-capable printers or
converted to PDF.
When printing an XES document to a
decentralized or PCL-capable printer or
converting to PDF, XPAF does not
dynamically convert centralized fonts to
decentralized format. If you attempt to
specify a centralized font, document
processing will be terminated.
Convert a centralized font to decentralized
format if you do not have a decentralized
version of the font, but want to use it in
XES documents.
NOTE: All fonts included with XPAF
are provided in both centralized and
decentralized format, so
preconversion is not necessary for
these fonts.
Section Four: Printing Documents with XPAF
34-3
Printing XES documents
Table 34-1.
Resource preparation for XES documents (Continued)
Resource type
Fonts
(Continued)
User actions needed
Create a resident font list for each
decentralized printer.
Print time processing
XPAF will check the decentralized printer’s
font list to determine whether a requested
font is resident on the printer. If the font is
not resident, XPAF will download it.
If the decentralized printer can store
downloaded resources permanently,
XPAF will update the printer’s font list
when it downloads a font.
Forms
Load your decentralized forms to the
native decentralized form library.
XPAF will download decentralized forms
from the native form library if they have not
been included inline or if they are not
resident on the decentralized printer.
NOTE: If you are using PCL-capable
printers or converting to PDF, you do
not need to load forms to the PCL or
PDF form library; XPAF converts a
decentralized form to a PCL or PDF
macro (which contains a set of PCL or
PDF commands that define the form)
during processing, then stores it in the
PCL or PDF form library for
subsequent use.
Create a resident form list for each
decentralized printer.
XPAF will check the decentralized printer’s
form list to determine whether a requested
form is resident on the printer. If the form
is not resident, XPAF will download it.
If the decentralized printer can store
downloaded resources permanently,
XPAF will update the printer’s form list
when it downloads a form.
Section Four: Printing Documents with XPAF
34-4
Printing XES documents
Table 34-1.
Resource preparation for XES documents (Continued)
Resource type
Images
User actions needed
Load your decentralized images to the
native decentralized image library.
Print time processing
XPAF will download images from the
native image library if they have not been
included inline or if they are not resident on
the printer.
NOTE: If you are using PCL-capable
printers or converting to PDF, you do
not need to load images to the PCL or
PDF image library; XPAF converts
images from sixelized format to
bitmapped (HP raster graphic) format
during processing, then stores them in
the PCL or PDF image library for
subsequent use.
Create a resident image list for each
decentralized printer.
XPAF will check the decentralized printer’s
image list to determine whether a
requested image is resident on the printer.
If the image is not resident, XPAF will
download it.
If the decentralized printer can store
downloaded resources permanently,
XPAF will update the printer’s image list
when it downloads an image.
Logos
Convert centralized logos to decentralized
fonts if you want to use them in XES
documents.
Color
For highlight color processing: None.
Paper trays
XPAF does not dynamically convert
centralized logos to decentralized fonts for
use in native XES documents. If you
attempt to specify a logo, document
processing will be terminated.
For full color processing: None.
XPAF passes color-specific XES
commands to PCL or PDF
None.
XPAF passes the XES paper tray select
command directly to a decentralized
printer, and converts it to an equivalent
PCL tray select command when printing to
a PCL-capable printer.
(If the XES document is the result of a
DJDE-to-XES conversion, then the paper
tray may have been specified originally in
the DJDE document using the cluster
mapping table.)
PDL
None.
Section Four: Printing Documents with XPAF
Not applicable. PDL does not affect XPAF
processing of XES documents.
34-5
Printing XES documents
Using resources
For XES documents, the fonts, forms, and images you specify in your
document can be:
•
Resident on the printer. Printer-resident resources can be specified
using XES commands.
•
Downloaded from an XPAF resource library at print time.
The following sections contain information about extended JCL keywords
you can use to specify and update resources at print time. For detailed
information about a particular keyword, refer to Section Five: XPAF
Parameter and Keyword Reference.
Specifying
For XES documents, there are no extended JCL keywords which you can
use to specify resources at print time.
Revising
If your site has created or received a new version of a resource and
loaded it to the appropriate XPAF native resource library, the version in
the library may no longer match the version on the printer.
For data streams that reference Xerox native resources, you can specify
AUTOREV=XEROX in your initialization parameters or the printer's profile
to ensure that your document is printed using the most current version of
the resource.
To ensure that your document is printed using the most current version of
the resource, include the appropriate REVxxxxx extended JCL
keyword(s) in the JCL used to submit the job:
•
•
•
REVFONT
REVFORM
REVIMAGE
REVxxxxx downloads the specified resource to the printer. Then, for
centralized printers and decentralized printers that are capable of
permanently storing resources, the resource is stored on the printer so it
will be available for subsequent jobs. For centralized printers only, if you
also have specified the equivalent DELxxxxx printer profile parameter or
extended JCL keyword (DELFONT, DELFORM, or DELIMAGE), the
resource will not be stored on the printer.
Deleting
For XES documents, there are no extended JCL keywords which you can
use to delete resources resident on a printer.
Section Four: Printing Documents with XPAF
34-6
Printing XES documents
Modifying document processing
For XES documents, there are several extended JCL keywords available
to modify document processing, as shown in table 34-2. Refer to Section
Five: XPAF Parameter and Keyword Reference for additional information
about these keywords.
Table 34-2.
Extended JCL keywords for XES processing
Extended JCL keyword
Function
PCLDS
Identifies the data stream being printed.
PCLREQ
For printing to a PCL-capable printer, indicates whether the document is
converted to PCL5 format, passed through without conversion, or converted
as specified by the PCL printer profile parameter.
Section Four: Printing Documents with XPAF
34-7
Printing XES documents
Using advanced features
Because XPAF does not enhance the processing of advanced features
(such as using color or selecting paper trays), you are limited to the XES
commands supported by the destination decentralized or PCL-capable
printer.
Color
Although there are no extended JCL keywords available for specifying
color, you can include color in your XES documents by specifying XES
color-specific commands. These commands enable you to add color to
text, graphic lines, background text highlighting, and graphic window
bitmap separations.
NOTE: You cannot specify highlight color in an XES document.
When printing to a color PCL printer or converting to PDF, XPAF accepts
XES printer commands which allow you to implement color, including the
commands identified in table 34-3.
Table 34-3.
Color commands for XES data streams
Command
Function
Assign Ink Color
Specifies the color or gray-shade parameter values to use as the substitute
for a color or gray-shade palette entry.
Text Highlight
Specifies the background text color or gray-shade for characters that
appear highlighted. This value may be applied on a text or paragraph basis.
Ink Change
Selects a color or gray-shade entry for the palette. This value can then be
used for text, logos, non-graphic lines, and any other data that has been
digitized into font characters.
Line Draw X
Draws a non-graphic line of specified length along the X-axis of the page.
Use the S variable to select the color or gray-shade palette entry.
Line Draw Y
Draws a non-graphic line of specified length along the Y-axis of the page.
Use the S variable to select the color or gray-shade palette entry.
Vector Draw
Draws a non-graphic line of specified length along the X-axis, the Y-axis, or
diagonally across the page. Use the S variable to select the color or
gray-shade palette entry.
Graphic Window
Defines an area on the page where graphics will be printed. Use the C
variable to specify the color of the separation bitmap to use for the graphic
window.
For more information on these commands, refer to the Xerox 4700 II Color
Laser Printing System Printer Language Reference.
Section Four: Printing Documents with XPAF
34-8
Printing XES documents
Paper tray selection
For XES documents printed to PCL-capable printers, the XES tray select
command is converted to a PCL tray select command. Because XES and
PCL use different identifiers to select the manual feed tray, the tray
selected may not be equivalent to the original. You may need to change
your XES document to specify the PCL manual feed tray correctly.
Section Four: Printing Documents with XPAF
34-9
Printing XES documents
Verifying your print environment
This section identifies any additional steps you should take before you
begin submitting jobs.
Printing to a PCL-capable printer
Before you print XES documents to a PCL-capable printer, check with
your systems programmer to ensure that these actions have been
completed:
•
The PCL font, form, and image resource libraries have been
allocated and initialized on the host system.
•
The PFONTLIB, PFORMLIB, and PIMAGELIB initialization and/or
printer profile parameters have been coded and point to the DD
statements that define the PCL resource libraries for the specified
printer.
For more information about setting the above options, refer to Section
Two: Installing and Customizing XPAF. For more information about these
parameters and keywords, refer to Section Five: XPAF Parameter and
Keyword Reference.
Printing documents
Submit your documents for printing using standard JCL. Make sure your
job class references a supported decentralized or PCL-capable printer or
conversion to PDF.
Section Four: Printing Documents with XPAF
34-10
Printing XES documents
Converting XES documents to PCL or PDF documents
Using XPAF, you can convert DJDE, XES, page-formatted, and AFP
documents to PCL or PDF format for printing on PCL capable printers or
conversion to PDF. DJDE, page-formatted, and AFP documents are first
converted to XES documents, which are then converted to PCL or PDF
format.
Processing overview
When printing documents to a PCL capable printer or converted to PDF,
XPAF searches the PCL or PDF resource libraries to determine if the
resources already reside in the libraries. If they do, then XPAF uses the
resources stored in the libraries. If they do not, or if you have requested
a revision of them, then XPAF dynamically converts the resources.
•
XPAF converts each font from Xerox 2700 format to PCL or PDF
bitmapped format, then stores it in the library specified by the
PFONTLIB or FFONTLIB initialization or printer profile parameter.
This conversion ensures that the correct positioning is used when
the page output is produced.
•
XPAF converts each form from XES format to a PCL or PDF macro
which contains a set of PCL or PDF commands that define the form.
The PCL or PDF macro is executed at print time to reproduce the
form as it appeared in XES format.
•
XPAF converts each image from sixelized format to bitmapped (HP
raster graphic) format, then stores it in the library specified by the
PIMAGELIB initialization or printer profile parameter.
Resources which are included inline in the data stream are converted to
PCL format but are not stored in the PCL or PDF resource libraries. There
are two reasons for handling inline resources this way:
•
To ensure that an inline test resource does not overlay a stored
production version of the same name.
•
For security reasons, so that signature fonts or other confidential
resources are not accessible to other jobs.
XPAF downloads the necessary resources every time a PCL or PDF job
is printed but does not store them on the printer.
Supported XES commands
Table 34-4 lists the XES commands that are supported by XPAF for PCL
or PDF processing.
NOTE: If you include an unsupported XES command in a document,
XPAF will issue an error message indicating that an unsupported
command has been specified. It ignores the command and
processing continues, but your output may be unpredictable.
Section Four: Printing Documents with XPAF
34-11
Printing XES documents
Table 34-4.
XES commands supported for XES-to-PCL or PDF
conversion
XES command
Definition
=UDK=
Set a new UDK string
+X
Reset printer OSS
+F
Font load
+A
Font add
+M
Merge page load
a
Absolute text positioning
rd
Relative down text positioning
ru
Relative up text positioning
rl
Relative left text positioning
rr
Relative right text positioning
x
Draw X line
y
Draw Y line
n
Font switching (n = 0 through 9)
+n
Font form assignment (n = 0 through 9)
+N
Form load
+P
Print job
+Q
Print job mixed orientations
+U
Unload all files
+V
Merge page unload
c
Paper tray select
gr
Graphic repeat
gw
Graphic window
m
Page boundary margins. (Double page margins not
supported.)
zd
Merge stop
ze
Merge start
zf
Units 300ths
Section Four: Printing Documents with XPAF
34-12
Printing XES documents
Table 34-4.
XES commands supported for XES-to-PCL or PDF
conversion (Continued)
XES command
Definition
zyd
Duplex start
zye
Duplex stop
zyf
Duplex invert start
zyi
Duplex side select
f
Ink assign
zi
Ink change
Processing limitations
When directing an XES document to a PCL-capable printer or converted
to PDF, restrictions apply to certain elements, including:
•
•
•
•
Color
Fonts stored on the printer
Printers supported
Document conversions
Color
When printing DJDE, page-formatted, and AFP documents containing
color to PCL-capable printers or converted to PDF, documents can be
printed on color PCL -capable printers or converted to full color PDF
documents.
Fonts stored on the printer
XPAF downloads all necessary resources each time a PCL or PDF job is
printed but does not store them on the printer. If you do not have your
fonts stored in a native library because your site is set up to store fonts
only on a printer (or use cartridge fonts), you must modify your procedure.
When printing an XES document to a PCL or PDF capable printer, if XPAF
determines that a requested font is not available in the decentralized font
library, then it will be unable to convert the decentralized font to a PCL or
PDF bitmapped font. Processing will be terminated.
If this error occurs, you must either edit the document to specify a
decentralized font that is available in the decentralized font library, or load
the requested font to the decentralized font library on the host.
Section Four: Printing Documents with XPAF
34-13
Printing XES documents
NOTE: When printing banner pages, XPAF uses the default font
specified in the PORTFONT or LANDFONT printer profile
parameters. The default fonts for PCL-capable printers are P0612A
and L0112B, which are supplied in the decentralized font library. If
you have changed the values for your default portrait and/or
landscape fonts, you may need to update the PORTFONT and/or
LANDFONT printer profile parameters to specify fonts that are
available in the decentralized font library.
Printers supported
Support for the PCL or PDF conversion only applies for documents printed
to Xerox printers that support the PCL or PDF printer command language.
Document conversions
When printing DJDE, page-formatted, and AFP documents to PCL
-capable printers or converted to PDF, any limitations which exist for the
conversion to XES remain in effect. That is, the XES-to-PCL or PDF
conversion cannot overcome any limitations of the DJDE-to-XES, page
format-to-XES, or AFP-to-XES document conversions.
Section Four: Printing Documents with XPAF
34-14
Printing page-formatted documents
35.
35
Printing page-formatted documents
This chapter contains the information you need to print page-formatted
documents through XPAF. It addresses these topics:
•
•
•
•
•
Verifying that your resources have been set up correctly
Including resources in your documents
Modifying the processing of your documents
Using advanced features, such as color
Converting page-formatted documents to other formats
In addition, it provides troubleshooting tips for resolving some of the
common problems you may encounter as you print page-formatted
documents.
Data stream definition
Page-formatted documents are line-mode documents that have been
formatted into discrete pages using a page format. Refer to Section Eight:
Xerox Page Format Editor User Guide for information about creating and
maintaining page formats.
NOTE: You cannot use a page format to format a document that
contains DJDE, XES, AFP, or PCL commands. These commands are
not supported by page-format processing and will produce
unexpected results.
XPAF support
You can print page-formatted documents through XPAF to any supported
centralized, decentralized, or PCL-capable printer or convert them to
PDF.
•
For documents sent to a centralized printer, XPAF converts the
page-formatted document to a Metacode document.
•
For documents sent to a decentralized printer, XPAF converts the
page format settings to XES commands.
•
For documents sent to a PCL-capable printer, XPAF converts the
page format settings to XES commands, then converts the XES
commands to PCL commands.
•
For documents converted to a PDF capable printer, XPAF converts
the page format settings to XES commands, then converts the XES
commands to PDF commands.
Section Four: Printing Documents with XPAF
35-1
Printing page-formatted documents
Preparing resources
For page-formatted documents, there are tasks related to resource
preparation that you need to complete before you submit jobs for printing.
Before you begin printing documents, contact the system administrator
responsible for maintaining your print resources to ensure that the
applicable tasks have been completed.
NOTE: These tasks are summarized in table 35-1 and described in
detail in Section Three: Managing Resources with XPAF, and Section
Eight: Xerox Page Format Editor User Guide.
Table 35-1.
Resource preparation for page-formatted documents
Resource type
Fonts
User actions needed
Print time processing
Load any centralized or decentralized
fonts you have purchased from Xerox Font
Services or a third-party vendor to the
appropriate native font libraries.
XPAF will download fonts from the native
font library if they have not been included
inline or if they are not resident on the
printer.
Before you convert a centralized font that
you have purchased from either Xerox
Font Services or a third-party vendor to
decentralized format, update the
applicable font tables as needed:
During centralized-to-decentralized
conversion, XOAF uses the centralized
and decentralized mapping tables to
determine where to place the centralized
characters in the decentralized font.
•
Ensure that the XPAFXFI table entry
for the centralized font contains valid
centralized and decentralized
mapping table names.
•
Verify that all ex