17
Wed, Apr
5 New Articles

TechTip: Implement Your Own DLTOBJ Command via the Undocumented QLIDLOBJ API

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

Wouldn't it be nice to have just one delete command for all object types?

 

As an IBM i developer, you have numerous object-related commands that accept a qualified object name and a valid object type to identify the target object(s) to work with—for example, WRKOBJ OBJ(XLIB/XFILE) OBJTYPE(*FILE), ALCOBJ OBJ(XLIB/XPGM) OBJTYPE(*PGM), DSPOBJD OBJ(XLIB/XSPC) OBJTYPE(*USRSPC), etc. However, you do not have a Delete Object (DLTOBJ) command. Instead, you have a bunch of object type?specific delete object commands, such as Delete Program (DLTPGM), Delete File (DLTF), and so on.

Therefore, it's hard to design a program that is expected to delete objects of different types via a single delete command. For example, a CL program doing such stuff might look like this:

DCL &OBJLIB *CHAR 10

DCL &OBJNAM *CHAR 10

DCL &OBJTYP *CHAR 7

IF COND(&OBJTYP *EQ '*PGM') THEN(DLTPGM PGM(&OBJLIB/&OBJNAM))

IF COND(&OBJTYP *EQ '*FILE') THEN(DLTF FILE(&OBJLIB/&OBJNAM))

/* ... ... */

/* Endless IF/THEN statements ... */

To solve this problem, obviously you can write a CL program like the above-shown example, filled with lines of IF/THEN statements. However, a much simpler solution has been discussed several times in the Midrange-L and RPG400-L mailing lists. That solution is the undocumented API QLIDLOBJ. The following post from Walden H. Leverich gave a brief introduction to the QLIDLOBJ API:

RE: Object manipulation API documentation

   Subject: RE: Object manipulation API documentation

   From: "Walden H. Leverich" <waldenl@xxxxxxxxxxxxxxx>;

   Date: Mon, 12 Mar 2001 12:48:25 -0500

QLIDLOBJ is the delete object "API", however it is in the system domain so you can't use it without tweaking your program. The nice thing about the QLIDLOBJ program is it takes the object type as a parameter so I've created a DLTOBJ command here that takes the object and type and deletes it. Much nicer than a giant IF statement that call the correct DLTxxx command based on type.

-Walden

PS. We tweaked.

In a post in September 2000 (Re: Recycle Bin in AS/400?), Peter Dow pointed out: …there are 81 DLT* commands, many of which call the same command processing program, QLIDLOBJ.

Simon Coulter provided the necessary parameter format of the QLIDLOBJ API in a post in November, 2001:

However, since that program is not an exposed API (as I recall it accepts 2 parameters: a char(20) for qualified object and a CHAR(10) for object type without the asterisk, but since it is a system domain program it is a little difficult to invoke) most sites have written a DLTOBJ command which performs a function similar to your requested ADDDSKSPC command.

The approach I'd like to introduce is slightly different from Walden's:

  • Create a copy of the QLIDLOBJ API, and change the copy to the user domain (instead of QLIDLOBJ itself).
  • Wrap a Delete Object (DLTOBJ) command over the copy of the QLIDLOBJ API.

Determine Which Commands Use QLIDLOBJ as Their Command Processing Program

In order to build a DLTOBJ command, it's necessary to know which delete object commands are backed by the QLIDLOBJ API. External object types supported by different releases of IBM i may differ slightly, and so do the delete object commands. To know exactly which delete object commands use QLIDLOBJ as their Command Processing Program (CPP), you can consider the following approach. Start a QShell session, and issue the following command:

ls /qsys.lib/DLT*.CMD | \

while read CMD; \

do OBJNAME=$(basename   $CMD); \

OBJNAME=${OBJNAME%.*}; \

system "dspcmd   QSYS/$OBJNAME" | \

if grep 'Program to process   command.*QLIDLOBJ' > /dev/null; \

then echo $OBJNAME; \

fi; \

done

Output of the above-shown QShell command on a VRM540 IBM i might look like this (a total of 67 delete object commands using QLIDLOBJ as their CPP):

DLTALRTBL

DLTAUTL

DLTBNDDIR

DLTCFGL

DLTCLD

DLTCLS

DLTCMD

DLTCNNL

DLTCOSD

DLTCRQD

DLTCSI

DLTCTLD

DLTDEVD

DLTDTAARA

DLTDTAQ

DLTEDTD

DLTF

DLTFNTRSC

DLTFNTTBL

DLTFORMDF

DLTFTR

DLTGSS

DLTIGCDCT

DLTIGCSRT

DLTIMGCLG

DLTIPXD

DLTJOBD

DLTJOBQ

DLTJRN

DLTJRNRCV

DLTLIND

DLTMEDDFN

DLTMGTCOL

DLTMOD

DLTMODD

DLTMSGF

DLTMSGQ

DLTNODGRP

DLTNODL

DLTNTBD

DLTNWID

DLTNWSCFG

DLTNWSD

DLTOUTQ

DLTOVL

DLTPAGDFN

DLTPAGSEG

DLTPDFMAP

DLTPDG

DLTPGM

DLTPNLGRP

DLTPSFCFG

DLTQMFORM

DLTQMQRY

DLTQRY

DLTSBSD

DLTSCHIDX

DLTSPADCT

DLTSQLPKG

DLTSRVPGM

DLTTBL

DLTTIMZON

DLTUSRIDX

DLTUSRQ

DLTUSRSPC

DLTVLDL

DLTWSCST

With this information, now you can create your DLTOBJ command within a few minutes.

The Delete Object (DLTOBJ) Command

The following example source of the DLTOBJ command is extracted from dltobj.cl-cmd.

             CMD       PROMPT('Delete Object (DLTOBJ)')

             PARM       KWD(OBJ) TYPE(Q_OBJ) MIN(1)   PROMPT('Object')

             PARM       KWD(OBJTYPE) TYPE(*CHAR) LEN(7)   RSTD(*YES) +

                         SPCVAL((*ALRTBL   ALRTBL) (*AUTL AUTL) +

                         (*BNDDIR BNDDIR)   (*CFGL CFGL) (*CLD CLD) +

                         (*CLS CLS) (*CMD   CMD) (*CNNL CNNL) (*COSD +

                         COSD) (*CRQD CRQD)   (*CSI CSI) (*CTLD +

                         CTLD) (*DEVD DEVD)   (*DTAARA DTAARA) +

                         (*DTAQ DTAQ) (*EDTD   EDTD) (*FILE FILE) +

                         (*FNTRSC FNTRSC)   (*FNTTBL FNTTBL) +

                         (*FORMDF FORMDF)   (*FTR FTR) (*GSS GSS) +

                         (*IGCDCT IGCDCT)   (*IGCSRT IGCSRT) +

                         (*IMGCLG IMGCLG)   (*IPXD IPXD) (*JOBD +

                         JOBD) (*JOBQ JOBQ)   (*JRN JRN) (*JRNRCV +

                         JRNRCV) (*LIND   LIND) (*MEDDFN MEDDFN) +

                         (*MGTCOL MGTCOL)   (*MODULE MODULE) (*MODD +

                         MODD) (*MSGF MSGF)   (*MSGQ MSGQ) (*NODGRP +

                         NODGRP) (*NODL   NODL) (*NTBD NTBD) (*NWID +

                         NWID) (*NWSCFG   NWSCFG) (*NWSD NWSD) +

                          (*OUTQ OUTQ) (*OVL OVL) (*PAGDFN   PAGDFN) +

                         (*PAGSEG PAGSEG)   (*PDFMAP PDFMAP) (*PDG +

                         PDG) (*PGM PGM)   (*PNLGRP PNLGRP) (*PSFCFG +

                         PSFCFG) (*QMFORM   QMFORM) (*QMQRY QMQRY) +

                         (*QRYDFN QRYDFN)   (*SBSD SBSD) (*SCHIDX +

                         SCHIDX) (*SPADCT   SPADCT) (*SQLPKG SQLPKG) +

                         (*SRVPGM SRVPGM)   (*TBL TBL) (*TIMZON +

                         TIMZON) (*USRIDX   USRIDX) (*USRQ USRQ) +

                         (*USRSPC USRSPC)   (*VLDL VLDL) (*WSCST +

                         WSCST)) MIN(1)   PROMPT('Object type')

Q_OBJ:       QUAL       TYPE(*GENERIC)   LEN(10)

             QUAL       TYPE(*NAME) LEN(10) DFT(*LIBL) +

                        SPCVAL((*CURLIB) (*LIBL))   PROMPT('Library')

Create a User Domain Copy of the QLIDLOBJ API as the CPP of the DLTOBJ Command

As Walden stated in his post, the QLIDLOBJ API is in the System Domain and hence cannot be invoked directly from user domain programs at security level 40 or above. One possible method to overcome this limit is to change QLIDLOBJ's domain attribute from System Domain to User Domain. However, to minimize the possible effect of this change, I recommend creating a duplicate program in the user domain for QLIDLOBJ as the CPP of the DLTOBJ command. Note that to create your own copy of the QLIDLOBJ API (say a program called DLTOBJ), you will need sufficient authorities. Also you should set proper authorities on the duplicated DLTOBJ program so that it can be used by target operators or programs.

The domain attribute of an MI object is stored in its MI object header, which is composed of a 32-byte base segment header and a 224-byte Encapsulated Program Architecture (EPA) header. By investigating the MI object header and conducting proper experiments, you can easily find the domain bit(s) at your specific IBM i release. For example:

  • At VRM520, the domain bits are bytes 6–7 in the 32-byte base segment header. A value of hex 8000 means System Domain, and a value of hex 0001 means User Domain.
  • At VRM540, the domain bit is bit 7 of the ATT1 field in the 224-byte EPA header. The ATT1 field is a 1-byte field at the beginning of the EPA header (i.e., at offset hex 20 from the beginning of the MI object header). A value 1 of EPA.ATT1 bit 7 means System Domain, and a value of 0 means User Domain.

After locating the domain bit(s), you can change the domain attribute of your copy of QLIDLOBJ (the DLTOBJ program) via the System Service Tools (SST).

Note: Patching program objects via the SST could be dangerous to your system. Please take the underlying risks into consideration before actually changing the domain attribute of your duplicated DLTOBJ program via the SST!

Finally, compile your DLTOBJ command like this:

CRTCMD CMD(XLIB/DLTOBJ) PGM(XLIB/DLTOBJ) SRCFILE(...)

Alternatively, if you're unwilling to patch a program object via the SST or if your target IBM i runs under security level 30 (or below?!), you can use the QLIDLOBJ API directly:

CRTCMD CMD(XLIB/DLTOBJ) PGM(QSYS/QLIDLOBJ) SRCFILE(...)

Test Your DLTOBJ Command

Now, are you ready to test your newly created DLTOBJ command? Imagine that you want to remove all objects created at a specific date from a library called BLDLIB. You could code a couple of simple CL programs like the following:

A290 (a290.clp)

             PGM       PARM(&CRTDAT)

             DCL       VAR(&CRTDAT) TYPE(*CHAR) LEN(6)

             DSPOBJD   OBJ(BLDLIB/*ALL) OBJTYPE(*ALL)   DETAIL(*BASIC) +

                         OUTPUT(*OUTFILE)   OUTFILE(OBJD) /* +

                         Retrieve object   description information */

             OVRDBF     FILE(OBJD) SHARE(*YES)

             OPNQRYF   FILE((OBJD)) QRYSLT('ODCDAT *EQ "'   *CAT +

                         &CRTDAT *CAT   '"') /* Select objects to +

                         delete by creation   date */

             CALL       PGM(A291) /* Call A291 to actually   delete +

                         selected objects */

             CLOF       OPNID(OBJD)

             DLTOVR     FILE(OBJD)

A291 (a291.clp)

             DCLF       FILE(OBJD)

READ:         RCVF       RCDFMT(QLIDOBJD)

             MONMSG     MSGID(CPF0864) EXEC(GOTO CMDLBL(BYE))

             DLTOBJ     OBJ(&ODLBNM/&ODOBNM)   OBJTYPE(&ODOBTP) /* +

                         Delete an object   via the DLTOBJ command */

             GOTO       CMDLBL(READ)

BYE:         ENDPGM

Compile the CL programs, and then call A290 like this:

CALL A290 '010813' /* Remove all objects created at 2013-01-08 from BLDLIB. */

Junlei Li

Junlei Li is a programmer from Tianjin, China, with 10 years of experience in software design and programming. Junlei Li began programming under i5/OS (formerly known as AS/400, iSeries) in late 2005. He is familiar with most programming languages available on i5/OS—from special-purpose languages such as OPM/ILE RPG to CL to general-purpose languages such as C, C++, Java; from strong-typed languages to script languages such as QShell and REXX. One of his favorite programming languages on i5/OS is machine interface (MI) instructions, through which one can discover some of the internal behaviors of i5/OS and some of the highlights of i5/OS in terms of operating system design.

 

Junlei Li's Web site is http://i5toolkit.sourceforge.net/, where his open-source project i5/OS Programmer's Toolkit (https://sourceforge.net/projects/i5toolkit/) is documented.

BLOG COMMENTS POWERED BY DISQUS

LATEST COMMENTS

Support MC Press Online

$0.00 Raised:
$

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: