(IBM i fans only) Program Status Data Structure (PSDS), %editc BIF (Built-In Function), and %subst BIF in RPG free.

By -
Rpg free example


The program is indeed a simple and minimal example that demonstrates the usage of Program Status Data Structure (PSDS), %editc BIF (Built-In Function), and %subst BIF (Built-In Function) in RPG free.

 

Program Status Data Structure (PSDS): The psds named Pgm is utilized to store system-related information like the current user and program time. The pgm.User and pgm.PgmTime fields are accessed within the program.

 

%editc BIF: The %editc BIF is used to convert the zoned decimal value P_PGMTIME into a character representation. This is commonly done when formatting numeric values for display.

 

%subst BIF: The %subst BIF is used to extract portions of the formatted time string P_PGMTIMEchar. It is used to create a time string in the format "HH:MM:SS" by extracting and concatenating substrings.

 

Overall, this program is a concise example that showcases the use of these RPG features for obtaining system-related information and manipulating data for display.

RPG's Program Data Structure.


in RPG (Report Program Generator), the Program Data Structure (also known as PDS or Program Status Data Structure) is a special data structure used to control the flow and status of the program. It includes information about indicators, error conditions, and the program's overall status.


The Program Data Structure is typically defined at the beginning of an RPG program and is used to manage the program's execution. It consists of various fields, each serving a specific purpose.


Here is a basic example :

**free
  ctl-opt option(*nodebugio:*srcstmt:*nounref);

  dcl-ds Pgm psds qualified ;
    User    char(10) pos(358); // 358 367 Current user
    PgmTime zoned(6) pos(282); // 282 287 Program Time
  end-ds ;

  dcl-s P_USER char(10);
  dcl-s P_PGMTIME zoned(6);
  dcl-s P_PGMTIMEchar char(52);

// *******************************************************
// * PGM start                                           *
// *******************************************************

  P_USER    = pgm.User;
  P_PGMTIME = pgm.PgmTime;
  P_PGMTIMEchar = %subst(%editc(P_PGMTIME:'X'):1:2) + ':' +
                  %subst(%editc(P_PGMTIME:'X'):3:2) + ':' +
                  %subst(%editc(P_PGMTIME:'X'):5:2);

  Dsply P_USER;
  Dsply P_PGMTIMEchar;

  *inlr = *on; 

This RPG program performs the following actions:


Control Options:


The ctl-opt statement is used to set various control options for the program.

option(*nodebugio) indicates that debug I/O operations are not allowed.

option(*srcstmt) allows the use of the SRCSTMT keyword in debugging.

option(*nounref) specifies that unreferenced data structures are not considered as errors.



Program Data Structure (PDS):


A Program Data Structure (psds) named Pgm is declared.

It is qualified (qualified) to indicate that its subfields are referenced using dot notation.

It contains two subfields:

User: A character field of length 10, located at position 358 in the program status data structure (PSDS). This field represents the current user.

PgmTime: A zoned decimal field of length 6, located at position 282 in the PSDS. This field represents the program time.



Local Variables:


P_USER: A local character variable of length 10 is declared to store the value of pgm.User.

P_PGMTIME: A local zoned decimal variable of length 6 is declared to store the value of pgm.PgmTime.

P_PGMTIMEchar: A local character variable of length 52 is declared to store the formatted version of the program time.



Main Procedure:


Values from the PSDS (pgm.User and pgm.PgmTime) are assigned to the local variables P_USER and P_PGMTIME.

P_PGMTIMEchar is then calculated by formatting P_PGMTIME into a string with the format "HH:MM:SS".

The Dsply operation is used to display the values of P_USER and P_PGMTIMEchar on the screen.

Finally, *inlr is set to *on to indicate that the program should end when it reaches the last record.



In summary, the program retrieves the current user and program time from the program status data structure (PSDS), formats the program time, and displays both the user and the formatted time on the screen using the Dsply operation. After that, the program ends (*inlr = *on).

Comments

  1. AnonymousNovember 30, 2023 at 6:16 PM

    Hi Aldo, for User and date/time variables you don't need PSDS, you can use: "Specifying INZ(*USER) intializes any character field or subfield to the name of the current user profile. Character fields must be at least 10 characters long. If the field is longer than 10 characters, the user name is left-justified in the field with blanks in the remainder.

    Date fields can be initialized to *SYS or *JOB. Time and Timestamp fields can be initialized to *SYS." taken from RPG manual

    ReplyDelete
    Replies
    1. Aldo SUCCIDecember 1, 2023 at 10:27 AM

      Thank you for your valuable input! It's fantastic to learn alternative approaches, and your contribution adds depth to the discussion. Grazie mille for sharing your knowledge!

      Delete
  2. AnonymousDecember 1, 2023 at 2:24 AM

    In the case of a job that swaps the current profile and ends with *InLR=*Off, may need to retrieve in a sub-proc.
    dcl-s currentUser char(10) inz(*user);

    ReplyDelete
    Replies
    1. Aldo SUCCIDecember 1, 2023 at 10:21 AM

      Thank you so much for your insightful observation! Your comment adds valuable considerations to the discussion.
      I appreciate your engagement and hope to hear more from you in the future. Grazie mille!

      Delete

Post a Comment

Popular posts from this blog

(IBM i fans only) Efficient WRKSPLF with WSF - How to Search string into spooled files, Sort, and Generate PDFs on IBMi

By -
Image
Searching Spooled Files Made Easy: A Unique Solution Managing spooled files efficiently is crucial for users dealing with numerous rows of print data. IBM's WRKSPLF command provides a standard way to interact with spooled files, but it lacks certain features that can significantly enhance user experience. In this article, we'll delve into a powerful functionality that IBM doesn't offer — the ability to search among spooled file lists. Our goal is to highlight the advantages of this capability and introduce a practical solution. The Limitations of Standard WRKSPLF While the WRKSPLF command is a handy tool for working with spooled files, it falls short in certain aspects. One prominent limitation is the inability to search efficiently through the list of spooled file rows. Users often find it challenging to quickly locate specific files based on criteria like creation date, status, or content. Introducing a Unique Solution: WSF (WorkSpooledFiles) To address the limitations of...
Read more

(IBM i fans only) Detecting and Handling Non-Printable Characters in DB2 SQL Using LOCATE() and REPLACE() Functions

By -
Image
When working with DB2 SQL on the IBMi platform, one of the challenges we might encounter is dealing with non-printable characters in our data. These are characters that don't have a direct representation on a standard keyboard and can cause display programs to crash if not handled properly. For this example, we'll be working with the CLANA00F file, which contains customer data. You can find details on how to create this file on my blog post here . Non-printable characters can sneak into our records for various reasons, and to prevent issues, we can run an SQL query that uses the LOCATE() function. This function returns the position of the first occurrence of a substring within a string, allowing us to detect these problematic characters. Suppose we have a customer name with a non-printable character, specifically the EBCDIC '0D' character, which corresponds to the "Carriage Return" (CR) control character in ASCII. To find this character in our records, we can ...
Read more

(IBM i fans only) How to Sniff User Access

By -
Image
If you need to monitor user access on your IBM i system, you can use SQL to query the history log. Note: At the end of this post, you'll find a request directly addressed to you, the readers. Here’s a simple example of how you can do this: SELECT MESSAGE_ID,        MESSAGE_TIMESTAMP,        FROM_USER,        MESSAGE_TEXT     FROM TABLE (             QSYS2.HISTORY_LOG_INFO()         )     WHERE message_id IN ('CPF1164', 'CPF1124')           AND FROM_USER IN ('QSECOFR', 'QSYS', 'QSYSOPR')     ORDER BY MESSAGE_TIMESTAMP In this query: - QSYS2.HISTORY_LOG_INFO(): This function retrieves information from the history log. -  message_id IN ('CPF1164', 'CPF1124') : Filters the results to include only specific message IDs, which indicate sign-on and sign-off events. - FROM_USER in ('QSECOFR', 'QSYS', 'QSYSOPR'): Filters the resu...
Read more