02
Sat, Nov
2 New Articles
  1. You are here:  
  2. Home
  3. Programming
  4. Programming - Other
  5. CL
  6. The CL Corner: Add Your Own Options to the IBM WRKOUTQ Command

The CL Corner: Add Your Own Options to the IBM WRKOUTQ Command

CL
Typography
  • Smaller Small Medium Big Bigger
  • Default Helvetica Segoe Georgia Times

Did you know you could enhance the IBM "Work with" commands?

 

Over the years, many users have asked for the ability to enhance IBM-provided displays. With V6R1, this is now possible with the commands Work with Output Queue (WRKOUTQ), Work with Spooled Files (WRKSPLF), Work with Job Spool Files (WRKJOB OPTION(*SPLF), and even the Status Print (D P) of the System/36 environment. While IBM continues to reserve numeric options such as 1 for send, 2 for change, 3 for hold, and so on, users can now define their own alphabetic options such as A for archive, E for email, F for fax, and so on. In this article, we will see how to add a new option, P (Print Next or Prioritize), to move a spooled report to the top of an output queue.

 

The enabler for this new support is the UIM Spooled File User-defined List Action Exit Point, QIBM_QSP_SPLF_LSTACT, which is documented here. This exit point allows you to define a user program that should be called when a specific alphabetic option is entered on the "Work with" panel associated with the above IBM commands. For instance, to have the system call the user program VINING/PRIORITY whenever option P is entered, you would use the following Add Exit Program (ADDEXITPGM) command:

 

ADDEXITPGM EXITPNT(QIBM_QSP_SPLF_LSTACT) FORMAT(LASP0100) PGMNBR(*LOW)

   PGM(VINING/PRIORITY) PGMDTA(*JOB 1 P)

 

If you are not familiar with the ADDEXITPGM command, you can find additional information about the parameters being used here. The key point is that the third element of the PGMDTA parameter specifies the option being enabled--in this case, P for priority printing.

 

When the user enters option P, the system will call the program PRIORITY in library VINING, passing these five parameters:

 

Required Parameter Group:

 

1

Exit point name

Input

Char(20)

2

Format

Input

Char(8)

3

User-defined action

Input

Char(1)

4

Spooled file identity

Input

Char(*)

5

Length of spooled file identity

Input

Binary(4)

 

 

The first parameter is the name of the exit point calling the PRIORITY program (QIBM_QSP_SPLF_LSTACT), the second parameter is the format of the information being passed (LASP0100 as that is the format we registered for with the ADDEXITPGM command), the third parameter is the option entered by the user (P), the fourth parameter is the information needed to uniquely identify the spool file the user selected, and the fifth parameter is the length of the spool file identification information.

 

The following program, PRIORITY, implements the option P processing:

 

    Pgm        Parm(&Exit_Name &Format &Action &Spool_ID + 

                 &Spl_ID_Len)                              

                                                           

    Dcl        Var(&Exit_Name)  Type(*Char) Len(20)        

    Dcl        Var(&Format)     Type(*Char) Len(8)         

    Dcl        Var(&Action)     Type(*Char) Len(1)         

    Dcl        Var(&Spool_ID)   Type(*Char) Len(82)        

      Dcl      Var(&Job_Name)   Type(*Char) Len(10) +      

                 Stg(*Defined) DefVar(&Spool_ID 1)         

      Dcl      Var(&User_Name)  Type(*Char) Len(10) +      

                 Stg(*Defined) DefVar(&Spool_ID 11)        

      Dcl      Var(&Job_Number) Type(*Char) Len(6) +       

                 Stg(*Defined) DefVar(&Spool_ID 21)        

      Dcl      Var(&Splf_Name)  Type(*Char) Len(10) +      

                 Stg(*Defined) DefVar(&Spool_ID 27)        

      Dcl      Var(&Splf_Nbr)   Type(*Int) +               

                 Stg(*Defined) DefVar(&Spool_ID 37)      

      Dcl      Var(&Sys_Name)   Type(*Char) Len(8) +     

                 Stg(*Defined) DefVar(&Spool_ID 41)      

      Dcl      Var(&Crt_Date)   Type(*Char) Len(7) +     

                 Stg(*Defined) DefVar(&Spool_ID 49)      

      Dcl      Var(&Crt_Time)   Type(*Char) Len(6) +     

                 Stg(*Defined) DefVar(&Spool_ID 56)      

      Dcl      Var(&OutQ_Name)  Type(*Char) Len(10) +    

                 Stg(*Defined) DefVar(&Spool_ID 62)      

      Dcl      Var(&OutQ_Lib)   Type(*Char) Len(10) +    

                 Stg(*Defined) DefVar(&Spool_ID 72)      

    Dcl        Var(&Spl_ID_Len) Type(*Int)               

                                                         

    Dcl        Var(&MSPF0100)   Type(*Char) Len(114)      

      Dcl      Var(&Src_JName)  Type(*Char) Len(10) +     

                 Stg(*Defined) DefVar(&MSPF0100 1)        

      Dcl      Var(&Src_JUsr)   Type(*Char) Len(10) +     

                 Stg(*Defined) DefVar(&MSPF0100 11)       

      Dcl      Var(&Src_JNbr)   Type(*Char) Len(6) +      

                 Stg(*Defined) DefVar(&MSPF0100 21)       

      Dcl      Var(&Src_IntJID) Type(*Char) Len(16) +     

                 Stg(*Defined) DefVar(&MSPF0100 27)       

      Dcl      Var(&Src_SplID)  Type(*Char) Len(16) +     

                 Stg(*Defined) DefVar(&MSPF0100 43)       

      Dcl      Var(&Src_SplF)   Type(*Char) Len(10) +     

                 Stg(*Defined) DefVar(&MSPF0100 59)       

      Dcl      Var(&Src_SplNbr) Type(*Int) +               

                 Stg(*Defined) DefVar(&MSPF0100 69)       

      Dcl      Var(&Tgt_OutQ)   Type(*Char) Len(10) +     

                 Stg(*Defined) DefVar(&MSPF0100 73)         

      Dcl      Var(&Tgt_OutQL)  Type(*Char) Len(10) +       

                 Stg(*Defined) DefVar(&MSPF0100 83)         

      Dcl      Var(&Src_SysNam) Type(*Char) Len(8) +        

                 Stg(*Defined) DefVar(&MSPF0100 93)         

      Dcl      Var(&Src_CrtDat) Type(*Char) Len(7) +        

                 Stg(*Defined) DefVar(&MSPF0100 101)        

      Dcl      Var(&Src_CrtTim) Type(*Char) Len(6) +        

                 Stg(*Defined) DefVar(&MSPF0100 109)

    Dcl        Var(&MsgTxt)     Type(*Char) Len(80)      

    Dcl        Var(&Msg_Key)    Type(*Char) Len(4)       

    Dcl        Var(&QUSEC_BPrv) Type(*Int)  Value(0)     

    Dcl        Var(&L_MSPF0100) Type(*Int)               

        

    If Cond(&Exit_Name = 'QIBM_QSP_SPLF_LSTACT') Then(Do)   

       If Cond(&Format = 'LASP0100') Then(Do)               

          If Cond(&Action = 'P') Then(Do)                   

             ChgVar Var(&Src_JName)  Value(&Job_Name)       

             ChgVar Var(&Src_JUsr)   Value(&User_Name)      

             ChgVar Var(&Src_JNbr)   Value(&Job_Number)     

             ChgVar Var(&Src_IntJID) Value(' ')             

             ChgVar Var(&Src_SplID)  Value(' ')              

             ChgVar Var(&Src_SplF)   Value(&Splf_Name)       

             ChgVar Var(&Src_SplNbr) Value(&Splf_Nbr)        

             ChgVar Var(&Tgt_OutQ)   Value('*SAME')          

             ChgVar Var(&Tgt_OutQL)  Value(' ')              

             ChgVar Var(&Src_SysNam) Value(&Sys_Name)        

             ChgVar Var(&Src_CrtDat) Value(&Crt_Date)         

             ChgVar Var(&Src_CrtTim) Value(&Crt_Time)        

                                                             

             RtvVarSiz Var(&MSPF0100) Size(&L_MSPF0100)      

             Call Pgm(QSPMOVSP) Parm(&MSPF0100 &L_MSPF0100 + 

                      'MSPF0100' &QUSEC_BPrv)                

             Chgvar Var(&MsgTxt) Value( +                    

                'Spool file' *BCat &Splf_Name *BCat +        

                'moved to top of output queue')              

 

Bruce Vining

Bruce Vining is president and co-founder of Bruce Vining Services, LLC, a firm providing contract programming and consulting services to the System i community. He began his career in 1979 as an IBM Systems Engineer in St. Louis, Missouri, and then transferred to Rochester, Minnesota, in 1985, where he continues to reside. From 1992 until leaving IBM in 2007, Bruce was a member of the System Design Control Group responsible for OS/400 and i5/OS areas such as System APIs, Globalization, and Software Serviceability. He is also the designer of Control Language for Files (CLF).A frequent speaker and writer, Bruce can be reached at This email address is being protected from spambots. You need JavaScript enabled to view it.. 

MC Press books written by Bruce Vining available now on the MC Press Bookstore.

IBM System i APIs at Work IBM System i APIs at Work
Leverage the power of APIs with this definitive resource.
List Price $89.95

Now On Sale

BLOG COMMENTS POWERED BY DISQUS

LATEST COMMENTS

Support MC Press Online

$

Book Reviews

Resource Center

  • SB Profound WC 5536 Have you been wondering about Node.js? Our free Node.js Webinar Series takes you from total beginner to creating a fully-functional IBM i Node.js business application. You can find Part 1 here. In Part 2 of our free Node.js Webinar Series, Brian May teaches you the different tooling options available for writing code, debugging, and using Git for version control. Brian will briefly discuss the different tools available, and demonstrate his preferred setup for Node development on IBM i or any platform. Attend this webinar to learn:

  • SB Profound WP 5539More than ever, there is a demand for IT to deliver innovation. Your IBM i has been an essential part of your business operations for years. However, your organization may struggle to maintain the current system and implement new projects. The thousands of customers we've worked with and surveyed state that expectations regarding the digital footprint and vision of the company are not aligned with the current IT environment.

  • SB HelpSystems ROBOT Generic IBM announced the E1080 servers using the latest Power10 processor in September 2021. The most powerful processor from IBM to date, Power10 is designed to handle the demands of doing business in today’s high-tech atmosphere, including running cloud applications, supporting big data, and managing AI workloads. But what does Power10 mean for your data center? In this recorded webinar, IBMers Dan Sundt and Dylan Boday join IBM Power Champion Tom Huntington for a discussion on why Power10 technology is the right strategic investment if you run IBM i, AIX, or Linux. In this action-packed hour, Tom will share trends from the IBM i and AIX user communities while Dan and Dylan dive into the tech specs for key hardware, including:

  • Magic MarkTRY the one package that solves all your document design and printing challenges on all your platforms. Produce bar code labels, electronic forms, ad hoc reports, and RFID tags – without programming! MarkMagic is the only document design and print solution that combines report writing, WYSIWYG label and forms design, and conditional printing in one integrated product. Make sure your data survives when catastrophe hits. Request your trial now!  Request Now.

  • SB HelpSystems ROBOT GenericForms of ransomware has been around for over 30 years, and with more and more organizations suffering attacks each year, it continues to endure. What has made ransomware such a durable threat and what is the best way to combat it? In order to prevent ransomware, organizations must first understand how it works.

  • SB HelpSystems ROBOT GenericIT security is a top priority for businesses around the world, but most IBM i pros don’t know where to begin—and most cybersecurity experts don’t know IBM i. In this session, Robin Tatam explores the business impact of lax IBM i security, the top vulnerabilities putting IBM i at risk, and the steps you can take to protect your organization. If you’re looking to avoid unexpected downtime or corrupted data, you don’t want to miss this session.

  • SB HelpSystems ROBOT GenericCan you trust all of your users all of the time? A typical end user receives 16 malicious emails each month, but only 17 percent of these phishing campaigns are reported to IT. Once an attack is underway, most organizations won’t discover the breach until six months later. A staggering amount of damage can occur in that time. Despite these risks, 93 percent of organizations are leaving their IBM i systems vulnerable to cybercrime. In this on-demand webinar, IBM i security experts Robin Tatam and Sandi Moore will reveal:

  • FORTRA Disaster protection is vital to every business. Yet, it often consists of patched together procedures that are prone to error. From automatic backups to data encryption to media management, Robot automates the routine (yet often complex) tasks of iSeries backup and recovery, saving you time and money and making the process safer and more reliable. Automate your backups with the Robot Backup and Recovery Solution. Key features include:

  • FORTRAManaging messages on your IBM i can be more than a full-time job if you have to do it manually. Messages need a response and resources must be monitored—often over multiple systems and across platforms. How can you be sure you won’t miss important system events? Automate your message center with the Robot Message Management Solution. Key features include:

  • FORTRAThe thought of printing, distributing, and storing iSeries reports manually may reduce you to tears. Paper and labor costs associated with report generation can spiral out of control. Mountains of paper threaten to swamp your files. Robot automates report bursting, distribution, bundling, and archiving, and offers secure, selective online report viewing. Manage your reports with the Robot Report Management Solution. Key features include:

  • FORTRAFor over 30 years, Robot has been a leader in systems management for IBM i. With batch job creation and scheduling at its core, the Robot Job Scheduling Solution reduces the opportunity for human error and helps you maintain service levels, automating even the biggest, most complex runbooks. Manage your job schedule with the Robot Job Scheduling Solution. Key features include:

  • LANSA Business users want new applications now. Market and regulatory pressures require faster application updates and delivery into production. Your IBM i developers may be approaching retirement, and you see no sure way to fill their positions with experienced developers. In addition, you may be caught between maintaining your existing applications and the uncertainty of moving to something new.

  • LANSAWhen it comes to creating your business applications, there are hundreds of coding platforms and programming languages to choose from. These options range from very complex traditional programming languages to Low-Code platforms where sometimes no traditional coding experience is needed. Download our whitepaper, The Power of Writing Code in a Low-Code Solution, and:

  • LANSASupply Chain is becoming increasingly complex and unpredictable. From raw materials for manufacturing to food supply chains, the journey from source to production to delivery to consumers is marred with inefficiencies, manual processes, shortages, recalls, counterfeits, and scandals. In this webinar, we discuss how:

  • The MC Resource Centers bring you the widest selection of white papers, trial software, and on-demand webcasts for you to choose from. >> Review the list of White Papers, Trial Software or On-Demand Webcast at the MC Press Resource Center. >> Add the items to yru Cart and complet he checkout process and submit

  • Profound Logic Have you been wondering about Node.js? Our free Node.js Webinar Series takes you from total beginner to creating a fully-functional IBM i Node.js business application.

  • SB Profound WC 5536Join us for this hour-long webcast that will explore:

  • Fortra IT managers hoping to find new IBM i talent are discovering that the pool of experienced RPG programmers and operators or administrators with intimate knowledge of the operating system and the applications that run on it is small. This begs the question: How will you manage the platform that supports such a big part of your business? This guide offers strategies and software suggestions to help you plan IT staffing and resources and smooth the transition after your AS/400 talent retires. Read on to learn: