How to Utilize a Message File and Display Messages on the Green Screen
In this article, I will introduce a tool that I’ve integrated into my RPGLE application, written entirely in /Free format. This tool is designed to simplify the process of sending warnings, errors, or informational messages directly to the green screen, where users can see them when they press Enter. It's a straightforward yet powerful utility that reduces the need for repetitive coding, allowing you to focus on the core business logic of your application.
Note: In the sample code provided in the "Use Case" section, I utilized a message file. Please note that the actual message file itself is not included. However, for your reference, the structure of the message file is illustrated below:
Message ID Severity Message Text
L000001 0 TEST Prog
L000002 0 JAS Company Name
L000003 0 TEST3
L000004 0 F3=Exit F6=Process
L000005 0 From Date
L000006 0 To Date
MSG0001 0 This is my first message in the message subfile.
MSG0002 0 This is a test message
How to Use the jssflmsg Service Program
1. Source Code Placement
Ensure the following setup:
- The source code QPROTOSRC/jssflmsg must be placed in the QPROTOSRC source member.
- The source code QRPGLESRC/jssflmsg must be placed in the QRPGLESRC source member.
- Both source members should reside within the same library.
2. Purpose
The QPROTOSRC/jssflmsg member is used within QRPGLESRC to copy the necessary declarations and parameters for the application to function as a service program. This is achieved by binding the /copy directive during the compilation process.
Additionally, the QPROTOSRC/jssflmsg source code is utilized by RPG applications that require this service program.
3. Compilation Instructions
Step 1: Create the Module
CRTRPGMOD MODULE(*CURLIB/jssflmsg) SRCFILE(*CURLIB/QRPGLESRC) SRCMBR(jssflmsg) DBGVIEW(*SOURCE) REPLACE(*YES)
Step 2: Create the Service Program
CRTSRVPGM SRVPGM(*CURLIB/jssflmsg) EXPORT(*ALL) ACTGRP(*CALLER)
Note: The *CURLIB is used as the default library in this example. You may specify any library where you want the objects to be stored.
4. Binding Directory
Once the service program is created, it should be added to a binding directory. For example, I use JASTOOL as my binding directory. You can use any binding directory that suits your needs.
ADDBNDDIRE BNDDIR(*CURLIB/JASTOOL) OBJ((jssflmsg))
Display file declarations
In your display file (DSPF), you will need to include the records MSGSFL (subfile message record) and MSGCTL (subfile control record) that is associated with MSGSFL. If you prefer to use a window-style display, create a record of type WDWSFL instead of SFLMSG.
A R S1CONTROL
A CF03
A CF06
A CF12
A RTNCSRLOC(*RECNAME &$CREC &
A FRCDTA
A CSRLOC($CROW $CCOL)
A OVERLAY
A $CROW 3S 0H
A $CCOL 3S 0H
A L00003 12A O 5 8MSGID(L00 0003 CPIMCBOMFM)
A $CMP 3Y 0B 5 21EDTCDE(Z)
A COLOR(TRQ)
A DSPATR(&CCMP)
** Below are needed declaration for the display file
** ##PSGM is declared in RPG under workstation data structure
** Keyword (SFLMSGRCD) the row number where the message will show
**
A R MSGSFL SFL
A SFLMSGRCD(24)
A MSGKEY SFLMSGKEY
A ##PSPGM SFLPGMQ(10)
A R MSGCTL SFLCTL(MSGSFL)
A FRCDTA
A OVERLAY
A SFLDSP
A SFLDSPCTL
A SFLINZ
A N99 SFLEND
A SFLSIZ(0002)
A SFLPAG(0001)
A ##PSPGM SFLPGMQ(10)
Use Case
To call the SndSFLMsg$ function, provide the following parameters:
- Message Queue: The name of the message queue.
- Message: The text to be displayed, either hardcoded or combined with a message ID and input value.
- Message ID (optional): A specific message ID from a message file.
- Message File (optional): The name of the message file, typically matching the display file name to use with a program data structure.
- Message File Library (optional): The library name, or use
*LIBL.
To call the ClrSFLMsg$ function, provide:
- Message Queue: The name of the message queue to clear, typically specified as the calling program's name.