LANSA - Recently Updated Pages

Read Messages

petewood — Mon, 13 Apr 2009 12:28:23 CDT

Reads through the messages generated by the system and/or previous functions. The with_args(Y) option of the GET_MESSAGE BIF removes the messages from the message list.

* =======================================================
* Subroutine : GetMsg
* Description : Capture validation errors
* =======================================================
SUBROUTINE NAME(GETMSG)
DEFINE FIELD(#ERRTXT) TYPE(*CHAR) LENGTH(100)
USE BUILTIN(GET_MESSAGE) WITH_ARGS(Y) TO_GET(#RETCODE #ERRTXT #MESGID)
DOWHILE COND('#RETCODE = OK')
MESSAGE MSGID(DCM9897) MSGF(DC@M01)
USE BUILTIN(GET_MESSAGE) WITH_ARGS(Y) TO_GET(#RETCODE #ERRTXT #MESGID)
UPRINT FIELDS(#ERRTXT)
ENDWHILE
ENDROUTINE

Code Snippets

petewood — Mon, 13 Apr 2009 12:27:39 CDT

Read Messages

Home

petewood — Mon, 13 Apr 2009 12:21:11 CDT

This wiki will contain RDML and RDMLX code snippets and some documentation items from the Lansa docs that I find it difficult to locate within the documentation itself.

get_message

petewood — Tue, 28 Oct 2008 07:44:44 CDT

Gets the details of the next message from the program queue of the RDML function.
Normally the returned message details are then processed or printed by the RDML function in some non-standard way.
Messages on the program queue of an RDML function normally displayed on line 22/24 of the next screen presented to the user and then automatically cleared / removed.
Messages may have been placed on the program message queue by operating system commands, Built-In Functions, invalid I/O requests and/or RDML commands such as MESSAGE, VALUECHECK, etc.

Arguments:

Number	Type	Required or Optional	Description	Minimum Length	Maximum Length	Minimum Decimals	Maximum Decimals
1	Alpha	Optional	Remove message from queue Y - message is removed N - message is not removed Default value is Y.	1	1

Return Values:

Number	Type	Required or Optional	Description	Minimum Length	Maximum Length	Minimum Decimals	Maximum Decimals
1	Alpha	Required	Message return code OK = message returned NO = no message found	2	2
2	Alpha	Optional	Message text	1	132
3	Alpha	Optional	Message number	1	7
4	Alpha	Optional	Message file name	1	10
5	Alpha	Optional	Message file library	1	10
6	Alpha	Optional	Message substitution variable	1	132

RDML Example:
Insert a new name and address into file NAMES in a batch program. If an error is detected, print details of the name and address an exception report with all associated error messages.
DEFINE FIELD(#ERRTXT)TYPE(*CHAR)LENGTH(100) LABEL('Error:')
DEF_LINE NAME(#NAME)FIELDS(#CUSTNO#ADDRESS1 #ADDRESS2#ZIPCODE)
DEF_LINE NAME(#ERROR)FIELDS(#ERRTXT)IDENTIFY(*LABEL)

INSERT FIELDS(#NAME)TO_FILE(NAMES)VAL_ERROR(*NEXT)
IF_STATUS IS_NOT(*OKAY)

PRINT LINE(#NAME)
USE BUILTIN(GET_MESSAGE)TO_GET(#RETCODE#ERRTXT)
DOWHILE COND('#RETCODE=OK')
PRINT LINE(#ERROR)
USE BUILTIN(GET_MESSAGE) TO_GET(#RETCODE#ERRTXT)
ENDWHILE

ENDIF
Note: Running the same program under System i and in LANSA SuperServer mode will produce different messages.

A retrieved message using this BIF on the System i will display:

Messagetext:Recordtobeupdatedhasbeenchangedbyanotherjob/user
Messagenumber:IOM0017
Messagefilename:DC@M01

Running in LANSA SuperServer mode (against the System i) will display:

Messagetext:Recordtobeupdatedhasbeenchangedbyanotherjob/user
Messagenumber:*STCMSG
Messagefilename:2

This is a design consideration that, due to technical complexities, will not be changed in the short term.

RDML I/O Return Codes

petewood — Tue, 28 Oct 2008 07:32:19 CDT

Return Code	Description/Meaning
OK	OKAY. Operation completed normally. No errors detected.
ER	FATAL ERROR. Fatal file error detected. Error is probably irrecoverable. Locate cause of problem, correct, and re-attempt the operation.
VE	VALIDATION ERROR. Insert, update or delete operation failed to satisfy a file or dictionary level validation check.
NR	NO RECORD. No record(s) could be found matching the request.
EF	END OF FILE. End of file detected during read operation.
BF	BEGINNING OF FILE. Beginning of file detected during a read backwards.
EQ	EQUAL KEY FOUND. A record with a key equal to the key specified was found in the file.
NE	NO EQUAL KEY FOUND. No record could be found with a key equal to the key specified.

There are various ways of checking the return code after an I/O operation has been performed.

The first is to always use the IO_STATUS(*STATUS) default parameter on an I/O command. In this case the return code is mapped into a field called #IO$STS which can be referenced just like any other field.

For example:
FETCH FIELDS(#ORDERHEAD) FROM_FILE(ORDHDR) WITH_KEY(#ORDER)
IF COND('#IO$STS *NE OK')
MESSAGE MSGTXT('Order not found in current order file')
ENDIF
The second is to use the IO_STATUS parameter to map the return code into a user defined field.
For example:
DEFINE FIELD(#RETCODE) TYPE(*CHAR) LENGTH(2)
FETCH FIELDS(#ORDERHEAD) FROM_FILE(ORDHDR) WITH_KEY(#ORDER) IO_STATUS(#RETCODE)
IF COND('#RETCODE *NE OK')
MESSAGE MSGTXT('Order not found in current order file')
ENDIF
The third, and probably the best, is to use the IF_STATUS command to test the last return code automatically. The example already used would become:
FETCH FIELDS(#ORDERHEAD) FROM_FILE(ORDHDR) WITH_KEY(#ORDER)
IF_STATUS IS_NOT(*OKAY)
MESSAGE MSGTXT('Order not found in current order file')
ENDIF

Date Format Codes

petewood — Tue, 28 Oct 2008 07:30:54 CDT

Code	Format of date
A	System date format
B	DDMMYY
C	DD/MM/YY
D	YYMMDD
E	YY/MM/DD
F	MMDDYY
G	MM/DD/YY
H	DDMMYYYY
I	DD/MM/YYYY
J	YYYYMMDD
K	YYYY/MM/DD
L	MMDDYYYY
M	MM/DD/YYYY
N	DDMMMYY (ie 05JUN07)
O	DDMMMYYYY (ie 05JUN07)
P	DDxx MMMMMMMMM YY (ie 16TH JUNE 07)
Q	DDxx MMMMMMMMM YYYY (ie 16TH JUNE 2007)
R	DDD (ie MON, TUE, WED, ...)
S	DDDDDDDDD (ie MONDAY, TUESDAY, WEDNESDAY...)
T	DDDDDDDDD (in selected language ie LLLLLLLLLL)
U	MMMMMMMMMM (in selected language ie LLLLLLLLLL)
V	8 digit system date format
W	YYMM
X	MMYY
Y	YYYYMM
Z	MMYYYY
1	CYYMMDD

numeric_string

petewood — Tue, 28 Oct 2008 07:30:23 CDT

Converts a number to a string.

Arguments:

Number	Type	Required or Optional	Description	Minimum Length	Maximum Length	Minimum Decimals	Maximum Decimals
1	Numeric	Required	Number to be converted	1	29	0	9
2	Alpha	Optional	Removes trailing zeroes from the decimal portion of the number. Y = Trim Default = Y	1	1

Return Values:

Number	Type	Required or Optional	Description	Minimum Length	Maximum Length	Minimum Decimals	Maximum Decimals
1	Alpha	Required	Number as a string	1	31

RDML Example:
DEFINE FIELD(#SALARY)TYPE(*DEC) LENGTH(20)DECIMALS(0)
DEFINE FIELD(#SALCHR)TYPE(*CHAR) LENGTH(20)
...
USE BUILTIN(NUMERIC_STRING) WITH_ARGS(#SALARY) TO_GET(#SALCHR)

checknumeric

petewood — Tue, 28 Oct 2008 07:29:28 CDT

Checks a string only contains allowable values and converts the digital and decimal portions into numeric variables.

Arguments:

Number	Type	Required or Optional	Description	Minimum Length	Maximum Length	Minimum Decimals	Maximum Decimals
1	Alpha	Required	String to be converted	1	256
2	Numeric	Optional	Maximum number of integers allowed Range: 0 - 63 Default: 15	1	3	0	0
3	Numeric	Optional	Maximum number of decimals allowed Range: 0 - 63 Default: 9	1	3	0	0
4	Alpha	Optional	List of allowable characters to be ignored e.g. $, %, C, R	1	50

Return Values:

Number	Type	Required or Optional	Description	Minimum Length	Maximum Length	Minimum Decimals	Maximum Decimals
1	Numeric	Required	Return integer portion	1	Unlimited	0	0
2	Numeric	Optional	Return decimal portion	1	Unlimited	1	Unlimited
3	Alpha	Optional	Return okay code (Y/N)	1	1
4	Alpha	Optional	Return sign of the number (+ or -)	1	1
5	Numeric	Optional	Return number of integers	1	3
6	Numeric	Optional	Return number of decimals	1	3	0	0

RDML Example:
To get a packed decimal 9,2 result field #P92 from an alphanumeric field #A using 2 intermediate work fields called #P90 and #DEC.
DEFINE FIELD(#P92) TYPE(*DEC) LENGTH(9) DECIMALS(2)
DEFINE FIELD(#P90) TYPE(*DEC) LENGTH(9) DECIMALS(0)
DEFINE FIELD(#DEC) TYPE(*DEC) LENGTH(2) DECIMALS(2)
...
USE BUILTIN(CHECKNUMERIC)WITH_ARGS(#A72) TO_GET(#P90#DEC)
CHANGE FIELD(#P92)TO('#P90+#DEC')

Built-in Functions

petewood — Tue, 28 Oct 2008 07:16:12 CDT

The information from these pages is taken directly from the Lansa Documentation. I have modified some of the RDML(X) examples so that they made more sense to me.

Messages

petewood — Tue, 28 Oct 2008 07:14:04 CDT

These built-in functions are used to use and/or manipulate the messages retrieved from a message file.

get_message

String Handling

petewood — Tue, 28 Oct 2008 07:13:16 CDT

These built-in functions are used to manipulate or evaluate strings.

Tables of codes

petewood — Fri, 15 Jun 2007 10:39:05 CDT

Tables of various codes used within the LANSA RDML and RDMLX

Standard Field Edit Codes

acedanger — Tue, 05 Jun 2007 07:27:10 CDT

Code	Commas	Decimal Point	Leading Zero Suppression	Zero Balance	Type of Sign Used	Position
1	Y	Y	Y	Y	None
2	Y	Y	Y		None
3		Y	Y	Y	None
4		Y	Y		None
A	Y	Y	Y	Y	CR	Trailing
B	Y	Y	Y		CR	Trailing
C		Y	Y	Y	CR	Trailing
D		Y	Y		CR	Trailing
J	Y	Y	Y	Y	-	Trailing
K	Y	Y	Y		-	Trailing
L		Y	Y	Y	-	Trailing
M		Y	Y		-	Trailing
N	Y	Y	Y	Y	-	Leading
O	Y	Y	Y		-	Leading
P		Y	Y	Y	-	Leading
Q		Y	Y		-	Leading
W **			Y
Y *			Y
Z *			Y

** Note that W is a special date edit code with OS/400 version considerations.
* Note that Y is a special date edit code and Z is a special sign removal code.