CA Spool Java Transformers

The CA Spool Java Transformers convert print data streams from one format to another. The CA Spool Java transformers automatically transform IBM AFP, Xerox, Metacode, and text reports stored in a CA View database to Adobe PDF (Portable Document Format) files. This capability lets you view CA View AFP and Metacode reports as PDF files from CA OM Web Viewer Release 12.1 and mtcwv.
view140
The CA Spool Java Transformers convert print data streams from one format to another. The CA Spool Java transformers automatically transform IBM AFP, Xerox, Metacode, and text reports stored in a CA View database to Adobe PDF (Portable Document Format) files. This capability lets you view CA View AFP and Metacode reports as PDF files from CA OM Web Viewer Release 12.1 and
Web Viewer
.
The  CA Spool Java transformers can run under the control of CA Spool or can run stand alone as a self-contained started task.
Note:
To view PDF files, you must have Adobe Reader installed on your computer.
2
2
How CA Spool Java Transformers Work
The Java transformers work as follows:
  1. When CA View receives a request to transform an AFP, Metacode, or text report to PDF, it performs these actions:
    • Opens the input report and obtains the input report attributes.
    • Obtains the transform configuration parameters from DDname STDENV/STDENVX.
    • Copies the input report to the CA Spool Java transformers input directory.
    • Queues the CA Spool Java transformers request, either by writing a CA Spool request file or by writing a request job file into the CA Spool Java transformers queue report directory
  2. CA Spool Java transformers perform the print data stream transformation.
  3. CA View returns the PDF files obtained from the CA Spool Java transformers output directory to CA OM Web Viewer or
    Web Viewer
    . In the diagram, "WebViewer" could be either CA OM Web Viewer or
    Web Viewer
    .
How_Java_Transfoermers_Work.png
Install CA Spool Java Transformers
You can install the CA Spool Java Transformer Interface through CA DRAS to convert print data streams from one format to another, as follows:
  1. Do one of the following:
    • If you are using CA OM Web Viewer, add the CA Spool Java Transformer DD statements to the CA DRAS JCL Procedure for CA OM Web Viewer.
    • If you are using
      Web Viewer
      , add the CA Spool Java Transformer DD statements to the Tomcat procedure for
      Web Viewer
      .
  2. Configure the CA Spool Java Transformer environment variables.
  3. Update the CA Spool CAIQPARM initialization parameters, if Java transformers run controlled by CA Spool.
  4. Verify the installation.
Add the CA Spool Java Transformer DD Statements to the CA DRAS Procedure
If the Java transformers run under the control of CA Spool, uncomment the CA Spool Java transformer DD statements, the CA Spool Java transformers load library, and the CA Spool load library.
The CBY3OPTN member CAHAX2YP contains the configuration parameters required by the CA Spool Java transformers.
BYC3JST in CAI.CBY3PROC contains samples of the following CA Spool Java Transformer DD statements:
  • STEPLIB
    Indicates the libraries that contain the CA DRAS server modules, repository agent modules, the CA Spool Java transformers load library, and optionally the CA Spool load library.
  • STDENV
    Specifies the CA Spool Java Transformer configuration parameters. This file contains various parameters that control the CA Spool Java Transformation of AFP, Metacode, and text reports to PDF.
  • BXYTRACE
    Specifies the CA Spool Java Transformer tracing file if tracing is activated.
  • SYSPRINT
    Specifies the CA Spool Java Transformer report file, if the file is specified in the CA Spool Java Transformer configuration file.
Add the CA Spool Java Transformer DD Statements to the Tomcat Procedure for
Web Viewer
If the Java transformers run under the control of CA Spool, uncomment the CA Spool Java transformer DD statements, the CA Spool Java transformers load library, and the CA Spool load library.
The CVDEOPTN member CAHVX2YP contains the environment variables that the CA Spool Java transformers require.
CAHVTOMX in CAI.CVDEOPTN contains a sample Apache Tomcat procedure with the following CA Spool Java Transformer DD statements:
  • STEPLIB
    Indicates the libraries that contain the CA View load library, repository agent modules, the CA Spool Java transformers load library, and optionally the CA Spool load library.
  • STDENVX
    Specifies the CA Spool Java Transformer configuration parameters. This file contains various parameters that control the CA Spool Java Transformation of AFP, Metacode, and text reports to PDF.
Configure the CA Spool Java Transformer Environment Variables
#----------------------------------------------------------------------# # # # CA DRAS/View/Spool Java Transformer configuration file. # # # #----------------------------------------------------------------------# X2YY_TRACE=MIN Minimum Trace #X2YY_TRACE=ALL Maximum Trace X2YY_INTYPE=COMM List original report type as Comments #X2YY_INTYPE=DESC List original report type as Descrip X2YY_PAGELIM=9999 Max number of pages (0-999999999) X2YY_LINELIM=50000 Max number of lines (0-999999999) X2YY_SUBID=ESF CA Spool Subsystem ID #X2YY_PROC=procname CA Spool Java Transformer JCL procedure name X2YY_A2PD=DRASA2PD CA Spool AFP-to-PDF transform node X2YY_M2PD=DRASM2PD CA Spool Metacode-to-PDF transform node X2YY_M2PDPRM=DJDE Metacode report PRMODE= X2YY_T2PD=DRAST2PD CA Spool Text-to-PDF wrapper node X2YY_REPT=E If error write transform report #X2YY_REPT=Y Always write transform report #X2YY_REPT=N Never write transform report #X2YY_REPT=V Write BX2YYTRACE and transform report X2YY_AFP=LINE A2PD transform ACIF, PAGE, PDEF/FDEF file #X2YY_AFP=ALL A2PD transform all AFP files #X2YY_AFP=PAGE A2PD transform ACIF and PAGE files #X2YY_AFP=ACIF A2PD transform ACIF files #X2YY_TEMPDS=KEEP Keep temp files after transform X2YY_RETAIN=0 Retain output files minutes (0-9999999) #X2YY_RETAIN=60 Retain output files 1 hour #X2YY_RETAIN=2880 Retain PDF output files 2 days #X2YY_RETAIN=525600 Retain PDF output files 1 year X2YY_UTILWARN=75 Output file system utilization threshold% #X2YY_QUEUE=/usr/lpp/caspoold2e/xenos/queue Queue Directory X2YY_INPUT=/usr/lpp/caspoold2e/xenos/input Input Directory X2YY_OUTPUT=/usr/lpp/caspoold2e/xenos/output Output Directory X2YY_REPORTS=/usr/lpp/caspoold2e/xenos/reports Reports Directory #X2YY_SMFRTY=249 Stand Alone Java Transform SMF rec type
Environment Variable Parameters
The environment variable parameters of the CA Spool Java Transformer Interface follow:
X2YY_TRACE
Syntax
X2YY_TRACE=[MIN | ALL]
Specifies whether to write trace messages to JESMSGLG.
  • MIN
    Writes CAHASGX09 transform elapse time messages.
  • ALL
    Writes internal trace messages.
X2YY_INTYPE
Syntax
X2YY_INTYPE=[COMM | DESC]
Specifies whether to add input file type info to the CA OM Web Viewer Report list.
The input file types are:
'AFP ACIF', 'AFP PAGE', 'AFP LINE', 'METACODE' and 'TEXT'.
  • COMM
    Displays input file type in the Report Comments field.
  • DESC
    Displays input file type in the Report Description field.
If X2YY_INTYPE=DESC/COMM is specified, the recognized file format is added to the CA OM Web Viewer Report list.
X2YY_PAGELIM
Syntax
X2YY_PAGELIM=0-999999999
Specifies the maximum number of pages in a report to be transformed. If a CA View report contains more pages than the X2YY_PAGELIM specified limit, it is not transformed.
The default value is 0 which means no page limit.
X2YY_LINELIM
Syntax
X2YY_LINELIM=0-999999999
Specifies the maximum number of lines in a report to be transformed. If a CA View report contains more lines than the X2YY_LINELIM specified limit, it is not transformed.
The default value is 0 which means no line limit.
X2YY_SUBID
Syntax
X2YY_SUBID=esfx
Specifies the Subsystem ID of the CA Spool task that performs the transformation.
Use this parameter if you want to run the CA Spool Java transformers under the control of CA Spool.
Default:
ESF
X2YY_PROC
Syntax
X2YY_PROC=procname
Specifies the JCL procedure name to start the Stand Alone Java Transformer FSS task.
Use this parameter to run the CA Spool Java transformers stand alone as a self-contained started task.
Default:
None. Transformation requests are queued to the CA Spool subsystem specified by X2YY_SUBID.
X2YY_A2PD
Syntax
X2YY_A2PD=a2pdnode
If X2YY_SUBID is specified, this parameter specifies the name of the CA Spool printer node that drives the AFP-to-PDF transformation. AFP-to-PDF transformation is not performed if this parameter is not specified.
If X2YY_PROC is specified, this parameter must be set to value of "A2PD" or "A2PDL".
You can optionally specify X2YY_A2PD = A2PDL. This setting generates a linearized PDF, which loads faster in most browsers than a non-linearized PDF.
X2YY_M2PD
Syntax
X2YY_M2PD=m2pdnode
If X2YY_SUBID is specified, this parameter specifies the name of the CA Spool printer node which is used to drive the Metacode-to-PDF transformation. Metacode-to-PDF transformation is not performed if this parameter is not specified.
If X2YY_PROC is specified, this parameter must be set to value of "M2PD" or "M2PDL".
You can optionally specify X2YY_M2PD = M2PDL. This setting generates a linearized PDF, which loads faster in most browsers than a non-linearized PDF.
X2YY_M2PDPRM
Syntax
X2YY_M2PDPRM=m2pdprm
Specifies the PRMODE of CA View reports that are to be Metacode-to-PDF transformed before viewing.
Default:
METACODE
A Metacode report's initial JDL and initial JDE parameters can be specified through the FormDef and PageDef JCL parameters.
X2YY_T2PD
Syntax
X2YY_T2PD=t2pdnode
Specifies the name of the CA Spool printer node that drives the Text-to-PDF wrapping. Text-to-PDF transformation is not performed if the default value for this parameter is not specified.
This parameter is supported only if X2YY_SUBID specified.
X2YY_REPT
Syntax
X2YY_REPT=[N | E | Y | V]
Specifies whether the transformation report is written to the SYSPRINT DDname in the job step.
  • N
    (NO) Does not write the transformation report.
  • E
    (ERROR, Default) Writes the transformation report, if the return code is greater than 4.
  • Y
    (YES) Writes the transformation report.
  • V
    (Verbose) Writes the transformation report. Writes internal trace entries to the BXYTRACE DD statement, if present.
    The Verbose option works only when runninng the Java Transformers under CA Spool and not when running stand alone.
Default:
E
X2YY_AFP
Syntax
X2YY_AFP=[ACIF | PAGE | LINE | ALL]
Specifies which type of View AFP report must be AFP-to-PDF transformed before viewing.
  • ACIF
    Defines SARFSS ACIF processed AFP reports.
  • PAGE
    Defines ACIF and PRMODE=PAGE AFP reports.
  • LINE
    Defines PAGE and FORMDEF/PAGEDEF AFP reports.
  • ALL
    Defines LINE and all text reports without FORMDEF/PAGEDEF.
Default:
ACIF if X2YY_A2PD specified
If X2YY_A2PD=ALL and X2YY_T2PD are not specified, text files with no PageDef and FormDef values are A2PD transformed.
X2YY_TEMPDS
Syntax
X2YY_TEMPDS=KEEP
Specifies that USS files created by the transformation process in the USS directories specified by the X2YY_INPUT, X2YY_OUTPUT and X2YY_REPORTS variables must not be removed after the transformation is completed.
The only valid value for X2YY_TEMPDS is KEEP. Specify it only when required for problem determination.
Default is not to keep USS files after transformation.
X2YY_RETAIN
Syntax
X2YY_RETAIN=0-9999999
Specifies how many minutes to keep PDF output files, after they were last used. By keeping the PDF output files, they can be reused without transformation.
The default is not to keep PDF output files after use.
Examples
  • X2YY_RETAIN=0
    Removes PDF output files after use
  • X2YY_RETAIN=60
    Retains PDF output files for 1 hour
  • X2YY_RETAIN=2880
    Retains PDF output files for 2 days
  • X2YY_RETAIN=525600
    Retain PDF output files for 1 year
X2YY_UTILWARN
Syntax
X2YY_UTILWARN=0-100
Specifies a utilization threshold percent value for the USS file system containing the output directory. If the file system utilizations exceed the specified threshold, value message ESF4475 is issued.
Example
  • X2YY_UTILWARN=75
    Defines Output file system utilization threshold%
X2YY_QUEUE
Syntax
X2YY_QUEUE=/***/queue
Specifies the CA Spool Java Transformer USS directory to which the transformation request job file is written before transformation. Configure the CA Spool Java Transformer FSS task to read queue files from the same directory.
Both CA DRAS task and the CA Spool Java Transformer FSS task must have read and write permissions to this directory.
Specify this parameter if the X2YY_PROC parameter is specified to run the CA Spool Java Transformers stand alone as a Stand Alone Java Transformer FSS task.
X2YY_INPUT
Syntax
X2YY_INPUT=/***/input
Specifies the CA Spool Java Transformer USS directory to which the input CA View report is written before transformation. Configure the CA Spool Java Transformer FSS task to read input files from the same directory.
Both the CA DRAS task and the CA Spool Java Transformer FSS task must have read and write permissions to this directory.
X2YY_OUTPUT
Syntax
X2YY_OUTPUT=/***/output
Specifies the CA Spool Java Transformer USS directory from which the PDF output file is read after transformation. Configure the CA Spool Java Transformer FSS task to write output files to the same directory.
Both the CA DRAS task and the CA Spool Java Transformer FSS task must have read and write permissions to this directory.
X2YY_REPORTS
Syntax
X2YY_REPORTS=/***/reports
Specifies the CA Spool Java Transformer USS directory from which the transform report is read after transformation. Configure the CA Spool Java Transformer FSS task to write transformation reports to the same directory.
Both the CA DRAS task and the CA Spool Java Transformer FSS task must have read and write permissions to this directory.
Specify this parameter if the X2YY_PROC parameter is configured to run the CA Spool Java Transformers stand alone as a Java Transformer FSS task.
X2YY_SMFRTY
Syntax
X2YY_SMFRTY=
128-255
Specifies the SMF record type for CA Spool Java Transformer user SMF records (CA Spool SMF Subtype 12 – File Transformation records).
If X2YY_SMFRTY is not specified no SMF records are written.
Specify this parameter if the X2YY_PROC parameter is specified to run the CA Spool Java Transformers stand alone as a self-contained started task.
Update the CA Spool CAIQPARM Initialization Parameters
If the CA Spool Java transformers run under the control of CA Spool, update the transformer and printer definitions of the CAIQPARM initialization parameters, as follows:
  1. Add the following transformer definitions to the CAIQPARM initialization parameter deck:
    X2YY START=YES,MAXFILES=10 X2YYDEF D2EVISIO,PROC=CAIQD2E,MAXTASK=10,DEFAULT=YES
  2. Add the following printer definitions to the CAIQPARM initialization parameter deck:
    DEFNODE A2PDF,AFP2PDF,TCPHOST=DUMMY,TCPDRIV=DISK NODE DRASA2PD,A2PDF,GROUP=1,X2YY=D2EVISIO,TRANSFRM=A2PDwT DEFNODE M2PDF,META2PDF,TCPHOST=DUMMY,TCPDRIV=DISK NODE DRASM2PD,M2PDF,GROUP=1,X2YY=D2EVISIO,TRANSFRM=M2PDwT DEFNODE T2PDF,TEXT2PDF,TCPHOST=DUMMY,TCPDRIV=DISK,TRANS=C037T19U NODE DRAST2PD,T2PDF,GROUP=1, TCPDRIV=DISK,TRANSFRM=T2PDTw, DRIVPRM1='PATH=/usr/lpp/caspoold2e/xenos/output/&FNO.pdf', DRIVPRM2='pathmode=SIRWXU,SIRWXG,SIRWXO', DRIVPRM3='FILENAME=*.PDFLB'
The user ID assigned to the Java Transformer FSS task and the user ID assigned to the job executing the Batch Transformer utility must have appropriate permissions to read and write files to the directories specified in the X2YY_INPUT, X2YY_OUTPUT and X2YY_REPORTS variables. They must also have update authority for the CA Spool target node and files queued for that node
Verify the Installation
You can verify that the CA Spool Java Transformer interface has been successfully installed by viewing a report, as follows:
  1. If the Java transformers run under the control of CA Spool, restart CA Spool with the updated CAIQPARM data set.
    If the Java transformers run as a self-contained started task, start the CAIQD2E JCL procedure from the operator console.
  2. If you are using
    Web Viewer
    , restart the CCS Tomcat procedure.
    If you are using CA Output Management Web Viewer 12.0 or 12.1, restart CA DRAS with the updated JCL procedure and updated CAHAX2YP parameter member.
  3. Log in to
    Web Viewer
    or CA Output Management Web Viewer 12.0 or 12.1, whichever you are using.
  4. Restart CA DRAS with the updated JCL procedure and updated CAHAX2YP parameter member.
  5. Log on to CA OM Web Viewer.
  6. Display the report list, and click an AFP report for viewing.
    The CA View report is now transformed into PDF and displayed by Adobe Reader in a new browser window.
    For the first time, the PDF is displayed after 10-15 seconds; the time taken to start the CA Spool Java Transformer FSS task.
    If the transformation fails, check the Transformation Report written to the CA DRAS SYSPRINT allocation.
If the Java transformers run under the control of CA Spool, use the CA Spool PFSS command to stop the CA Spool Java Transformer task.
If the Java transformers run as a self-contained started task, use the MVS STOP command to stop the CA Spool Java Transformer task.
Performance Considerations
You can improve the CA Spool Java Transformer interface performance and reduce the transformation elapse times by moving some of the CA Spool Java Transformer USS directories to a temporary file system (TFS), like /tmp, so that you have a high-speed file system for temporary transformation files. The temporary file system is an in-memory file system that is not written to DASD.
You must be sure that the temporary file system (TFS) is of sufficient size or that it is permitted to grow, so that it can contain the CA Spool Java Transformer USS directories you are moving to the TFS.
The following order is recommended, when deciding what directories to move:
CAIQENVA:
CAHAX2YP:
1
QUEUE=/tpv/caspoold2e/xenos/queue
X2YY_QUEUE=/usr/lpp/caspoold2e/xenos/queue
2
REPORT=/tpv/caspoold2e/xenos/reports
X2YY_REPORTS=/usr/lpp/caspoold2e/xenos/reports
3
INPUT=/tpv/caspoold2e/xenos/input
X2YY_INPUT=/usr/lpp/caspoold2e/xenos/input
4
OUTPUT=/tpv/caspoold2e/xenos/output
X2YY_OUTPUT=/usr/lpp/caspoold2e/xenos/output
For more information about the topics on this page, see the following resources: