Lansa Tech Ref Guide

Technical Reference Guide V10.0

Date of issue: June 23, 2003 2003 LANSA

DisclaimerThe information contained in this material represents the current view of LANSA as of the date of publication. Because LANSA must respond to changing market conditions, it should not be interpreted to be a commitment on the part of LANSA, and LANSA cannot guarantee the accuracy of any information presented after the date of publication. Information in this guide may contain technical inaccuracies or typographical errors. All information is for informational purposes only. Every effort has been made to ensure that the information in this material is accurate, however, in no event shall LANSA be liable for any damages arising from its use. LANSA MAKES NO WARRANTIES, EXPRESSED OR IMPLIED.

Trademarks All brand names and product names used in this guide are trademarks, registered trademarks or trade names of their respective holders.


ii

ContentsRDML Commands .....................................................................................................................1 RDMLX Commands ...................................................................................................................5 Built-In Functions by Category ................................................................................................7 System Variables.....................................................................................................................19 Formats, Values and Codes ...................................................................................................20 Template Commands and Variables .....................................................................................21 Error Messages........................................................................................................................22 RDML Commands ...................................................................................................................23 ABORT................................................................................................................................24 ADD_ENTRY ......................................................................................................................27 BEGIN_LOOP.....................................................................................................................31 BEGINCHECK ....................................................................................................................33 BROWSE ............................................................................................................................39 CALL ...................................................................................................................................48 CALLCHECK ......................................................................................................................57 CASE ..................................................................................................................................65 CHANGE.............................................................................................................................69 CHECK_FOR......................................................................................................................74 CLOSE................................................................................................................................77 CLR_LIST ...........................................................................................................................79 COMMIT .............................................................................................................................80 CONDCHECK.....................................................................................................................81 CONTINUE .........................................................................................................................86 DATECHECK......................................................................................................................88 DEF_ARRAY ......................................................................................................................94 DEF_BREAK.....................................................................................................................102 DEF_COND ......................................................................................................................111 DEF_FOOT.......................................................................................................................115 DEF_HEAD.......................................................................................................................118 DEF_LINE.........................................................................................................................123 DEF_LIST .........................................................................................................................127 DEF_REPORT..................................................................................................................138 DEFINE.............................................................................................................................143 DELETE ............................................................................................................................155 DISPLAY...........................................................................................................................161 DLT_ENTRY .....................................................................................................................177 DLT_LIST..........................................................................................................................179 DOUNTIL ..........................................................................................................................180 DOWHILE .........................................................................................................................183 ELSE .................................................................................................................................186 END_LOOP ......................................................................................................................187 ENDCASE.........................................................................................................................188 ENDCHECK......................................................................................................................189 ENDIF ...............................................................................................................................195 ENDPRINT........................................................................................................................196 ENDROUTINE ..................................................................................................................198 ENDSELECT ....................................................................................................................199 ENDUNTIL ........................................................................................................................200 ENDWHILE .......................................................................................................................201 EXCHANGE......................................................................................................................202 EXEC_CPF .......................................................................................................................209


iii

EXEC_OS400 ...................................................................................................................210 EXECUTE .........................................................................................................................212 EXIT ..................................................................................................................................213 FETCH ..............................................................................................................................215 FILECHECK......................................................................................................................221 FUNCTION .......................................................................................................................226 GET_ENTRY ....................................................................................................................236 GOTO ...............................................................................................................................238 GROUP_BY ......................................................................................................................239 IF .......................................................................................................................................241 IF_ERROR........................................................................................................................242 IF_KEY..............................................................................................................................244 IF_MODE ..........................................................................................................................247 IF_NULL............................................................................................................................249 IF_STATUS.......................................................................................................................251 INCLUDE ..........................................................................................................................253 INSERT.............................................................................................................................256 INZ_LIST...........................................................................................................................261 KEEP_AVG.......................................................................................................................263 KEEP_COUNT..................................................................................................................265 KEEP_MAX.......................................................................................................................268 KEEP_MIN........................................................................................................................270 KEEP_TOTAL...................................................................................................................272 LEAVE ..............................................................................................................................274 LOC_ENTRY ....................................................................................................................277 MENU ...............................................................................................................................280 MESSAGE ........................................................................................................................282 ON_ERROR......................................................................................................................290 OPEN ................................................................................................................................293 OTHERWISE ....................................................................................................................302 OVERRIDE .......................................................................................................................303 POINT ...............................................................................................................................314 POP_UP ...........................................................................................................................318 PRINT ...............................................................................................................................333 RANGECHECK.................................................................................................................335 RENAME...........................................................................................................................340 REQUEST.........................................................................................................................342 RETURN ...........................................................................................................................357 ROLLBACK.......................................................................................................................358 SELECT ............................................................................................................................359 SELECTLIST ....................................................................................................................372 SELECT_SQL...................................................................................................................374 SET_ERROR ....................................................................................................................385 SET_MODE ......................................................................................................................388 SKIP ..................................................................................................................................389 SORT_LIST ......................................................................................................................390 SPACE..............................................................................................................................392 SUBMIT ............................................................................................................................393 SUBROUTINE ..................................................................................................................399 SUBSTRING .....................................................................................................................410 TRANSFER.......................................................................................................................413 UPD_ENTRY ....................................................................................................................416 UPDATE ...........................................................................................................................419 UPRINT.............................................................................................................................426 USE...................................................................................................................................430 VALUECHECK..................................................................................................................432 WHEN ...............................................................................................................................437 RDMLX Commands ...............................................................................................................439 BEGIN_COM ....................................................................................................................440


iv

DEFINE_COM ..................................................................................................................442 DEFINE_EVT....................................................................................................................445 DEFINE_MAP ...................................................................................................................447 DEFINE_PTY....................................................................................................................452 END_COM ........................................................................................................................455 END_FOR.........................................................................................................................456 ENDROUTINE ..................................................................................................................457 EVTROUTINE...................................................................................................................458 FOR ..................................................................................................................................461 IF_REF..............................................................................................................................465 INVOKE ............................................................................................................................466 MTHROUTINE ..................................................................................................................467 PTYROUTINE...................................................................................................................469 SET ...................................................................................................................................470 SET_REF..........................................................................................................................471 SIGNAL.............................................................................................................................475 WEB_MAP ........................................................................................................................476 WEBROUTINE..................................................................................................................477 Referring to Property Values ............................................................................................478 Generic References to Components ................................................................................479 Variant Variable ................................................................................................................480 Qualified Properties ..........................................................................................................482 Calling RDML Programs from RDMLX .............................................................................483 Built-In Functions ..................................................................................................................485 ACCESS_FILE..................................................................................................................486 ACCESS_RTE ..................................................................................................................488 ACCESS_RTE_KEY.........................................................................................................490 ADD_DD_VALUES ...........................................................................................................491 ALLOW_EXTRA_USER_KEY ..........................................................................................492 BCONCAT ........................................................................................................................494 BUILD_WORK_OPTIONS................................................................................................495 CALL_SERVER_FUNCTION ...........................................................................................498 CENTRE ...........................................................................................................................501 CHECK_AUTHORITY ......................................................................................................502 CHECK_OUT....................................................................................................................504 CHECKNUMERIC.............................................................................................................505 CHECKSTRING................................................................................................................506 CLR_MESSAGES.............................................................................................................507 COMPARE_FILE_DEF .....................................................................................................508 COMPILE_PROCESS ......................................................................................................509 CONCAT...........................................................................................................................515 CONNECT_FILE...............................................................................................................516 CONNECT_SERVER .......................................................................................................519 CONVERTDATE...............................................................................................................522 CONVERTDATE_NUMERIC............................................................................................523 COPY_OBJECT................................................................................................................524 CREATE_SPACE .............................................................................................................525 DATEDIFFERENCE .........................................................................................................529 DATEDIFFERENCE_ALPHA ...........................................................................................530 DEFINE_DB_SERVER .....................................................................................................531 DEFINE_OS_400_SERVER.............................................................................................534 DEFINE_OTHER_SERVER .............................................................................................539 DEFINE_SPACE_CELL ...................................................................................................543 DELETE_CHECKS ...........................................................................................................545 DELETE_PROCESS ........................................................................................................547 DELETE_FUNCTION .......................................................................................................549 DELETE_IN_SPACE ........................................................................................................550 DELETE_SAVED_LIST ....................................................................................................551 DELETE_TRIGGERS .......................................................................................................553


v

DESTROY_SPACE ..........................................................................................................555 DISCONNECT_FILE.........................................................................................................556 DISCONNECT_SERVER .................................................................................................558 DLL ...................................................................................................................................559 DLT_FIELD .......................................................................................................................563 DLT_FILE..........................................................................................................................564 DLT_PROCESS_ATTACH ...............................................................................................566 DOM_ADD_FIELD............................................................................................................567 DOM_ADD_ITEM .............................................................................................................569 DOM_CLOSE_DATABASE ..............................................................................................571 DOM_CLOSE_DOCUMENT ............................................................................................572 DOM_CLOSE_FILE..........................................................................................................573 DOM_CREATE_DOCUMENT ..........................................................................................574 DOM_DELETE_DOCUMENT...........................................................................................575 DOM_DELETE_FIELD .....................................................................................................576 DOM_DELETE_ITEM .......................................................................................................577 DOM_END_SEARCH_DOCS ..........................................................................................578 DOM_EXECUTE_AGENT ................................................................................................579 DOM_GET_FIELD ............................................................................................................580 DOM_GET_ITEM..............................................................................................................582 DOM_GET_NXT_DOCUMENT ........................................................................................584 DOM_OPEN_DATABASE ................................................................................................585 DOM_OPEN_DOCUMENT ..............................................................................................587 DOM_OPEN_FILE............................................................................................................588 DOM_SEARCH_DOCUMENTS .......................................................................................590 DOM_UPDATE_DOCUMENT ..........................................................................................592 DOM_UPDATE_FIELD.....................................................................................................593 DOM_UPDATE_ITEM ......................................................................................................595 DROP_DD_VALUES ........................................................................................................597 DROP_EXTRA_USER_KEYS..........................................................................................598 END_FILE_EDIT...............................................................................................................599 END_FUNCTION_EDIT ...................................................................................................600 END_PROCESS_EDIT ....................................................................................................601 END_RTV_SPLF_LIST ....................................................................................................602 EXCHANGE_ALPHA_VAR ..............................................................................................603 EXCHANGE_NUMERIC_VAR .........................................................................................604 EXECUTE_TEMPLATE ....................................................................................................605 EXPONENTIAL.................................................................................................................606 EXPORT_OBJECTS.........................................................................................................608 FETCH_IN_SPACE ..........................................................................................................611 FILE_FIELD ......................................................................................................................612 FILE_FIELD_VIRTUAL .....................................................................................................613 FILLSTRING .....................................................................................................................614 FINDDATE ........................................................................................................................616 FINDDATE_ALPHA ..........................................................................................................617 GET_AUTHORITIES ........................................................................................................618 GET_BIF_LIST .................................................................................................................621 GET_CHAR_AREA...........................................................................................................622 GET_COMPONENT_LIST ...............................................................................................624 GET_COMPOSITION .......................................................................................................626 GET_ENVIRONMENTS ...................................................................................................627 GET_FIELD ......................................................................................................................628 GET_FIELD_INFO............................................................................................................630 GET_FIELD_LIST.............................................................................................................634 GET_FILE_INFO ..............................................................................................................636 GET_FUNCTION_ATTR ..................................................................................................640 GET_FUNCTION_INFO ...................................................................................................642 GET_FUNCTION_LIST ....................................................................................................645 GET_FUNCTION_RDML..................................................................................................647


vi

GET_HELP .......................................................................................................................649 GET_ILENTRY_LIST........................................................................................................651 GET_KEYWORD_STRING ..............................................................................................654 GET_LOGICAL_LIST .......................................................................................................658 GET_MESSAGE...............................................................................................................660 GET_MESSAGE_DESC...................................................................................................662 GET_MESSAGE_LIST .....................................................................................................663 GET_ML_VARIABLE ........................................................................................................665 GET_MULTVAR_LIST......................................................................................................666 GET_NUM_AREA.............................................................................................................668 GET_PHYSICAL_LIST .....................................................................................................669 GET_PROCESS_ATTR ...................................................................................................671 GET_PROCESS_INFO ....................................................................................................673 GET_PROCESS_LIST .....................................................................................................675 GET_PROPERTIES .........................................................................................................677 GET_REGISTRY_VALUE ................................................................................................680 GET_SERVER_LIST ........................................................................................................682 GET_SESSION_VALUE...................................................................................................683 GET_SPLF_LIST_ENTRY................................................................................................684 GET_SYSTEM_VARIABLE ..............................................................................................687 GET_SYSVAR_LIST ........................................................................................................688 GET_TASK_DETAILS ......................................................................................................690 GET_TASK_LIST..............................................................................................................692 GET_TEMPLATE_LIST ....................................................................................................694 IMPORT_OBJECTS .........................................................................................................695 INSERT_IN_SPACE .........................................................................................................696 ISSUEINQUIRY ................................................................................................................697 ISSUEMESSAGE .............................................................................................................699 JSM_CLOSE.....................................................................................................................700 JSM_COMMAND..............................................................................................................701 JSM_OPEN.......................................................................................................................702 LEFT .................................................................................................................................703 LOAD_FILE_DATA ...........................................................................................................704 LOAD_OTHER_FILE ........................................................................................................706 LOCK_OBJECT ................................................................................................................708 LOGICAL_KEY .................................................................................................................712 LOGICAL_VIEW ...............................................................................................................714 MAIL_ADD_ATTACHMENT .............................................................................................715 MAIL_ADD_ORIGINATOR ...............................................................................................717 MAIL_ADD_RECIPIENT...................................................................................................719 MAIL_ADD_TEXT.............................................................................................................721 MAIL_SEND......................................................................................................................723 MAIL_SET_OPTION.........................................................................................................724 MAIL_SET_SUBJECT ......................................................................................................727 MAIL_START....................................................................................................................728 MAKE_FILE_OPERATIONL.............................................................................................730 MAKE_SOUND.................................................................................................................734 MESSAGE_BOX_ADD .....................................................................................................735 MESSAGE_BOX_APPEND..............................................................................................736 MESSAGE_BOX_CLEAR ................................................................................................737 MESSAGE_BOX_SHOW .................................................................................................738 MESSAGE_COLLECTOR ................................................................................................741 NUMERIC_STRING..........................................................................................................742 PHYSICAL_KEY ...............................................................................................................743 PUT_CHAR_AREA...........................................................................................................744 PUT_COND_CHECK........................................................................................................746 PUT_DATE_CHECK.........................................................................................................749 PUT_FIELD.......................................................................................................................752 PUT_FIELD_ML................................................................................................................755


vii

PUT_FILE_CHECK...........................................................................................................756 PUT_FILE_ML ..................................................................................................................760 PUT_FUNCTION_ATTR...................................................................................................761 PUT_FUNCTION_ML .......................................................................................................763 PUT_FUNCTION_RDML ..................................................................................................764 PUT_HELP .......................................................................................................................766 PUT_ML_VARIABLE ........................................................................................................768 PUT_NUM_AREA.............................................................................................................769 PUT_PROCESS_ACTIONS .............................................................................................770 PUT_PROCESS_ATTACH...............................................................................................772 PUT_PROCESS_ATTR....................................................................................................773 PUT_PROCESS_ML ........................................................................................................775 PUT_PROGRAM_CHECK ...............................................................................................776 PUT_RANGE_CHECK .....................................................................................................780 PUT_REGISTRY_VALUE ................................................................................................784 PUT_SYSTEM_VARIABLE ..............................................................................................786 PUT_TRIGGER ................................................................................................................788 PUT_VALUE_CHECK ......................................................................................................790 RCV_FROM_DATA_QUEUE ...........................................................................................793 REBUILD_FILE.................................................................................................................795 REBUILD_TABLE_INDEX ................................................................................................797 RESET_@@UPID ............................................................................................................798 RESTORE_SAVED_LIST.................................................................................................799 REVERSE.........................................................................................................................801 RIGHT...............................................................................................................................802 ROUND.............................................................................................................................803 SAVE_LIST.......................................................................................................................804 SCANSTRING ..................................................................................................................807 SELECT_IN_SPACE ........................................................................................................809 SELECT_LONG................................................................................................................811 SELECTNEXT_IN_SPACE ..............................................................................................812 SET_ACTION_BAR ..........................................................................................................814 SET_AUTHORITY ............................................................................................................815 SET_DD_ATTRIBUTES ...................................................................................................818 SET_FILE_ATTRIBUTE ...................................................................................................820 SET_FOR_HEAVY_USAGE ............................................................................................822 SET_FOR_LIGHT_USAGE ..............................................................................................823 SET_SESSION_VALUE ...................................................................................................824 SHOW_HELP ...................................................................................................................830 SND_TO_DATA_QUEUE .................................................................................................832 SPACE_OPERATION ......................................................................................................835 SQUARE_ROOT ..............................................................................................................837 START_FILE_EDIT ..........................................................................................................838 START_FUNCTION_EDIT ...............................................................................................841 START_PROCESS_EDIT ................................................................................................843 START_RTV_SPLF_LIST ................................................................................................845 SYSTEM_COMMAND ......................................................................................................847 TCONCAT.........................................................................................................................849 TEMPLATE_@@ADD_LST .............................................................................................850 TEMPLATE_@@CANSNNN............................................................................................851 TEMPLATE_@@CLR_LST..............................................................................................852 TEMPLATE_@@GET_FILS ............................................................................................853 TEMPLATE_@@NANSNNN............................................................................................856 TEMPLATE_@@SET_FILS .............................................................................................857 TEMPLATE_@@SET_IDX...............................................................................................859 TRANSFORM_FILE..........................................................................................................860 TRANSFORM_LIST..........................................................................................................866 UNLOAD_FILE_DATA......................................................................................................875 UNLOCK_OBJECT...........................................................................................................876


viii

UPDATE_IN_SPACE .......................................................................................................878 UPPERCASE....................................................................................................................879 WAF_CRTOBJ..................................................................................................................880 WAF_DEFFOLD ...............................................................................................................881 WAF_DEFSTOBJ .............................................................................................................882 WAF_DLTEOBJ................................................................................................................883 WAF_FETCHOBJ .............................................................................................................884 WAF_FINDOBJ.................................................................................................................885 WAF_INDEXOBJ ..............................................................................................................886 WAF_PPRTOBJ ...............................................................................................................887 WAF_PRINTOBJ ..............................................................................................................888 WAF_RESET ....................................................................................................................889 WAF_RMVOBJ .................................................................................................................890 WAF_SCAN ......................................................................................................................891 WAF_SENDOBJ ...............................................................................................................893 WAF_SETC ......................................................................................................................895 WAF_STOROBJ ...............................................................................................................897 WAF_USE.........................................................................................................................898 WEB_BUILD_COMPONENT............................................................................................899 WEB_CREATE_PAGE .....................................................................................................901 WEB_STATIC_PAGE .......................................................................................................907 WEB_UPD_PAGE ............................................................................................................910 ZIP_ADD...........................................................................................................................912 ZIP_DELETE ....................................................................................................................914 ZIP_EXTRACT..................................................................................................................915 ZIP_GET_INFO ................................................................................................................917 ZIP_MAKE_EXE ...............................................................................................................919 System Variables...................................................................................................................921 General Variables .............................................................................................................922 Function Only Variables....................................................................................................927 Special Variables ..............................................................................................................928 Built-In Function Variables ................................................................................................929 LANSA for the Web System Variables .............................................................................930 Formats, Values and Codes .................................................................................................931 Date Formats ....................................................................................................................932 Standard Field Edit Codes ................................................................................................933 RDML Field Attributes and their Use ................................................................................934 RDML I/O Return Codes...................................................................................................944 Help Text Enhancement & Substitution Values................................................................945 Template Commands and Variables ...................................................................................949 @@CLR_LST Command .................................................................................................950 @@CMP_IDX Command .................................................................................................951 @@COMMENT Command ..............................................................................................953 @@DEC_IDX Command .................................................................................................954 @@GET_FILS Command ................................................................................................955 @@GOTO Command ......................................................................................................957 @@IF Command..............................................................................................................958 @@INC_IDX Command...................................................................................................959 @@LABEL Command......................................................................................................960 @@MAK_LSTS Command ..............................................................................................961 @@MRG_LSTS Command..............................................................................................963 @@QUESTION Command ..............................................................................................964 @@RTV_FLDS Command...............................................................................................966 @@RTV_KEYS Command ..............................................................................................968 @@RTV_RELN Command ..............................................................................................969 @@SET_IDX Command ..................................................................................................970 General Template Variables .............................................................................................971 Question and Answer Template Variables .......................................................................973


ix

File Template Variables ....................................................................................................974 List Template Variables ....................................................................................................975 Template Error Messages ................................................................................................977 Tips for Template Programming .......................................................................................978 Technical Notes .....................................................................................................................981 RDML Command Parameters ..........................................................................................982 RDMLX Technical Notes ..................................................................................................995 Built-In Function Notes .....................................................................................................996 Appendix A - Sample RDML Programs ...............................................................................997 Adding Records to a File (One at a Time) ........................................................................998 A Simple Inquiry................................................................................................................999 Modifying the Simple Inquiry to Do Maintenance ...........................................................1000 Modifying the Simple Inquiry to Do It All .........................................................................1002 Browsing and Selecting ..................................................................................................1004 A Multiple File Inquiry .....................................................................................................1006 Adding Records to a File (Many At a Time)....................................................................1007 Minimizing Database I/Os ...............................................................................................1012 Using the KEEP_LAST Parameter .................................................................................1014 Generalized Subroutine ..................................................................................................1015 Page At a Time Scrolling (Forward Only) .......................................................................1016 Page at a Time Scrolling (Backwards & Forwards) ........................................................1018 Appendix B - Producing Reports Using LANSA ..............................................................1021 Introduction to Report Production ...................................................................................1022 Using the DEF_LINE Command.....................................................................................1023 Using the DEF_HEAD Command...................................................................................1025 Numbering Report Pages ...............................................................................................1027 Using the DEF_FOOT Command...................................................................................1028 Using a Leading DEF_BREAK Command......................................................................1029 Using a Trailing DEF_BREAK Command.......................................................................1031 Printing on Multiple Lines................................................................................................1033 Submitting Reports to Batch ...........................................................................................1035 Reporting Q & A..............................................................................................................1036 Appendix C - Application Template Program Examples .................................................1037 Data Entry Program ........................................................................................................1038 Header/Detail Style Inquiry Template .............................................................................1041 Appendix D - Domino Integration Examples ....................................................................1045 Example 1: Creating a New Document in a Database ...................................................1046 Example 2: Selecting Documents from a Database using a View .................................1048 Example 3: Executing an Agent in a Database ..............................................................1050 Example 4: Updating Documents Selected from a Browse List .....................................1051 Appendix E - System Variable Evaluation Programs ......................................................1053 RDML Functions .............................................................................................................1055 3GL Programs.................................................................................................................1057 Index .....................................................................................................................................1061


x

RDML Commands

RDML CommandsAlso see: Appendix A-Sample RDML Programs Appendix B-Producing Reports Using LANSA The following commands make up the complete LANSA RDML programming language. The hyperlink from the command column will take you to the Command's description and syntax diagram. The in the example column will take you straight to the Command's example. *

* indicates that there may be portability conflicts. Check the command for details. Command ABORT ADD_ENTRY BEGIN_LOOP BEGINCHECK BROWSE CALL CALLCHECK CASE CHANGE CHECK_FOR CLOSE CLR_LIST COMMIT CONDCHECK CONTINUE DATECHECK DEF_ARRAY DEF_BREAK DEF_COND DEF_FOOT Description Abort function with error message Add new entry to a list Begin a processing group Begin validation check block Browse and select records from a file Call a program or process/function Validate data by calling a program Begin a case condition Change content of field(s) Check for record in a file Close file(s) Clear a list Commit data base changes Validate data by checking a condition Continue next iteration of loop Validate data as a valid date or in date range Define an array Define report break line(s) Define a condition Define report foot line(s) * * * * * * * * Example


1

RDML Commands

DEF_HEAD DEF_LINE DEF_LIST DEF_REPORT DEFINE DELETE DISPLAY DLT_ENTRY DLT_LIST DOUNTIL DOWHILE ELSE END_LOOP ENDCASE ENDCHECK ENDIF ENDPRINT ENDROUTINE ENDSELECT ENDUNTIL ENDWHILE EXCHANGE EXEC_CPF EXEC_OS400 EXECUTE EXIT FETCH

Define report heading line(s) Define report detail line(s) Define a browse or working list Define report attributes Define a field in this function Delete record(s) from a file Display information on a workstation Delete an entry from a working list Delete a list Do until a condition is true. Do while a condition is true. Else, if an IF condition is not true End a processing loop End a case condition End a validation check block End an IF condition End all printing End a subroutine End a select loop End a DOUNTIL loop End a DOWHILE loop Exchange information with another function Execute a CPF command Execute an iSeries operating system Execute a subroutine Exit from LANSA Fetch a record from a file Discontinued

* * *

* *

* *

* *

*


2

RDML Commands

FILECHECK FUNCTION GET_ENTRY GOTO GROUP_BY IF IF_ERROR IF_KEY IF_MODE IF_NULL IF_STATUS INCLUDE INSERT INZ_LIST KEEP_AVG KEEP_COUNT KEEP_MAX KEEP_MIN KEEP_TOTAL LEAVE LOC_ENTRY MENU MESSAGE ON_ERROR OPEN OTHERWISE OVERRIDE

Validate data by checking against a file Define function control options Get entry from a list Pass control to another command Group fields under a common name If a condition is true If a validation error was detected If a key was used at workstation If screen display mode is If field(s) are null If I/O status flag is Include RDML from another function Insert a new record into a file Initialize a list Keep average of fields Keep count of fields Keep maximum of fields Keep minimum of fields Keep total of fields Leave current loop Locate an entry in a list Transfer to process main menu Issue a message On a validation error being detected Open file(s) If no WHEN commands are satisfied Override field's dictionary attributes

* *

* *

* *

* *

*


3

RDML Commands

POINT POP_UP PRINT RANGECHECK RENAME REQUEST RETURN ROLLBACK SELECT SELECTLIST SELECT_SQL SET_ERROR SET_MODE SKIP SORT_LIST SPACE SUBMIT SUBROUTINE SUBSTRING TRANSFER UPD_ENTRY UPDATE UPRINT USE VALUECHECK WHEN

Point file to another file/library/member Present a pop up window on a workstation Print line(s) on a report Validate data by a range of values check Rename a field within a file Request information from the workstation Return from a subroutine Roll back data base changes Select records from a file Select entries from a list Select records from a file using SQL Set a validation error Set screen display mode Skip to line "n" on a report Sort list into a nominated order Space "n" lines on a report Submit a program or process to batch Define a subroutine Substring one field into another field Transfer control to another function Update an entry in a list Update record(s) in a file Print information (unformatted) Use a Built In Function Validate data by a list of values check When condition is true (within CASE)

* *

* *

* *

*

*

*

* *

*

* *


4

RDMLX Commands

RDMLX Commands

BEGIN_COM DEFINE_COM DEFINE_EVT DEFINE_MAP DEFINE_PTY END_COM END_FOR ENDROUTINE EVTROUTINE FOR IF_REF INVOKE MTHROUTINE PTYROUTINE SET SET_REF SIGNAL WEB_MAP WEBROUTINE

Starts a component definition. Defines a component inside another. Creates a custom-specified event. Creates input and output parameters. Creates a custom-specified property. Ends a component definition. Ends a FOR loop. Ends EVTROUTINE, MTHROUTINE & PTYROUTINE block. Defines a routine for an event. Enables the definition of a looping block of code. Compares references of component variables. Invokes a method. Creates a custom-specified method. Creates a custom-specified property. Sets a property. Creates component reference. Triggers a custom-specified event. Defines inputs and outputs of WEBROUTINE Defines routine to process an input and/or output request of a Web Application Module (WAM)


5

RDMLX Commands


6

Built-In Functions by Category

Built-In Functions by CategoryThe platform applicable for each BIF and a description has been presented in each category table. Application Execution Control Built-In Functions Authority Built-In Functions Client/Server Support Built-In Functions Data Area Built-In Functions Data Queue Built-In Functions Date and Time Built-In Functions Domino Integration Built-In Functions Email Handling Built-In Functions Enhanced 5250 User Interface Built-In Functions Exchange List Built-In Functions Export/Import/Deployment Built-In Functions Field and Component Related Built-In Functions File Related Built-In Functions Function Related Built-In Functions JSM Built-In Functions List Handling Built-In Functions Locking Built-In Functions Mathematical Built-In Functions Messages and Message Handling Built-In Functions Message Box Built-in Functions Miscellaneous Built-In Functions Process Related Built-In Functions Rule/Trigger Related Built-In Functions Space Built-In Functions Spool File Built-In Functions String Handling Built-In Functions Template Related Built-In Functions Web Built-In Functions Workfolder Application Facility/400 Built-In Functions Zip Built-In Functions

Date Formats

Application Execution Control Built-In Functions Built-In Function GET_SESSION_VALUE SET_FOR_HEAVY_USAGE SET_FOR_LIGHT_USAGE SET_SESSION_VALUE Authority Built-In Functions Built-In Function CHECK_AUTHORITY GET_AUTHORITIES SET_AUTHORITY Client/Server Support Built-In Functions Built-In Function Description Description Check authority on object. Retrieves a list of authorities and returns it in a variable length working list. Sets user authority to a LANSA object. Description Returns the value for a specified X_RUN parameter. Set for heavy usage mode. Set for light usage mode. Set or reset a Visual LANSA session value.


7


CALL_SERVER_FUNCTION CONNECT_FILE CONNECT_SERVER DEFINE_OS_400_SERVER DEFINE_DB_SERVER DEFINE_OTHER_SERVER DISCONNECT_FILE DISCONNECT_SERVER GET_SERVER_LIST

Calls a function on a server. Connects a file to a server. See Database Connection Notes Connects to a server. See Database Connection Notes Defines an OS/400 server machine. Defines database for redirected files. See Database Connection Notes Defines a non-OS/400 server system. Disconnects a file from a server. Disconnects from a server. Returns a list of all servers known to LANSA Communications Extensions.

Data Area Built-In Functions Built-In Function GET_CHAR_AREA GET_NUM_AREA PUT_CHAR_AREA PUT_NUM_AREA Data Queue Built-In Functions Built-In Function RCV_FROM_DATA_QUEUE SND_TO_DATA_QUEUE Date and Time Built-In Functions Date Formats Description Receive working list entry(s) from a data queue Send working list entry(s) to a data queue Description Get a character value from a data area. Get a numeric value from a data area. Put a character value into a data area. Put a numeric value into a data area.

Built-In Function CONVERTDATE CONVERTDATE_NUMERIC DATEDIFFERENCE DATEDIFFERENCE_ALPHA FINDDATE FINDDATE_ALPHA Domino Integration Built-In Functions Built-In Function DOM_ADD_FIELD

Description Converts format of alphanumeric date. Converts format of numeric date Calculates the difference between two dates. Calculates the difference between two alphanumeric dates Finds date "n" days after/before a given date. Finds date "n" days after/before a given alphanumeric date

Description Adds a field to an open data note using the item name.


8


Built-In Function DOM_ADD_ITEM DOM_CLOSE_DATABASE DOM_CLOSE_FILE DOM_CLOSE_DOCUMENT DOM_CREATE_DOCUMENT DOM_DELETE_DOCUMENT DOM_DELETE_FIELD DOM_DELETE_ITEM DOM_END_SEARCH_DOCS DOM_EXECUTE_AGENT DOM_GET_FIELD DOM_GET_ITEM DOM_GET_NXT_DOCUMENT DOM_CLOSE_DATABASE DOM_CLOSE_FILE DOM_OPEN_DATABASE DOM_OPEN_DOCUMENT DOM_SEARCH_DOCUMENTS DOM_UPDATE_DOCUMENT DOM_UPDATE_FIELD DOM_UPDATE_ITEM

Description Adds an item to an open data note using the item name. Closes an opened Domino/Notes Database on a local or remote Domino server. Closes an opened Domino/Notes File on a local or remote Domino server. Closes an open document when no longer required. Creates a new document/data note in memory within an opened database. Deletes a document/data note from the database using the given Note ID. Deletes a field from an open document/data note using the item name. Deletes an item from an open document/data note using the item name. Releases all memory that was allocated for search process. Executes an Agent. Gets a field from an open data note using the item name. Gets an item from an open data note using the item name. Retrieves Note ID from the ID Table. Closes a Domino/Notes Database on a local or remote Domino server. Closes a Domino/Notes File on a local or remote Domino server. Opens a Domino/Notes Database on a local or remote Domino server Opens the specified document within a database using the given Note ID. Searches a database for documents/data notes matching selection criteria or using a previously created view. Updates a document/data note in the database. Updates an existing field to an open data note using the item name. Updates an existing item to an open data note using the item name.

Email Handling Built-In Functions Also see Email Built-In Functions Notes Built-In Function MAIL_START Description Initialize a mail message


9


MAIL_ADD_TEXT MAIL_ADD_ATTACHMENT MAIL_ADD_RECIPIENT MAIL_ADD_ORIGINATOR MAIL_SET_SUBJECT MAIL_SET_OPTION MAIL_SEND

Append message text Add attachment file Add a recipient Add an originator Set the mail message subject Set O/S specific mail option Send mail message

Enhanced 5250 User Interface Built-In Functions Built-In Function ADD_DD_VALUES ALLOW_EXTRA_USER_KEY BUILD_WORK_OPTIONS DROP_DD_VALUES DROP_EXTRA_USER_KEYS SET_ACTION_BAR SET_DD_ATTRIBUTES SHOW_HELP Exchange List Built-In Functions Built-In Function EXCHANGE_ALPHA_VAR EXCHANGE_NUMERIC_VAR Export/Import/Deployment Built-In Functions Built-In Function EXPORT_OBJECTS GET_BIF_LIST GET_COMPOSITION GET_ENVIRONMENTS GET_PROPERTIES GET_TASK_DETAILS GET_TASK_LIST GET_TEMPLATE_LIST Description Creates LANSA Import formatted files LANSA objects specified. Searches for BIF name and returns BIF details. Returns the list of objects that comprise a LANSA Object. Return a list of the Environment Names and a build environment indicator. Returns the version details for a single LANSA object. Retrieves a list of all objects modified under the specified task. Reads LX_F75 to return a list of tasks. Returns a list of all templates in the system Description Put an alphanumeric value on the exchange list. Put a numeric value on the exchange list. Description Add dropdown values. Allow an extra user function keys to be used. Build option lists for a "Work With" Driver Drop dropdown values. Drop all extra user function keys assigned. Make pull down choices available / unavailable. Set attributes of a drop down field. Modally display help


10


IMPORT_OBJECTS OBJECT_PROPAGATE Field and Component Related Built-In Functions Built-In Function DLT_FIELD GET_COMPONENT_LIST GET_FIELD GET_FIELD_INFO GET_FIELD_LIST GET_HELP GET_MULTVAR_LIST GET_ML_VARIABLE GET_SYSVAR_LIST GET_SYSTEM_VARIABLE PUT_FIELD PUT_FIELD_ML PUT_HELP PUT_ML_VARIABLE PUT_SYSTEM_VARIABLE File Related Built-In Functions Built-In Function ACCESS_FILE ACCESS_RTE ACCESS_RTE_KEY COMPARE_FILE_DEF DLT_FILE END_FILE_EDIT FILE_FIELD

Acts as an interface to the LANSA Import Facility. Propagate an object to a given repository group.

Description Deletes a field definition from the LANSA Repository. Returns a list of Components. Retrieves attributes of a LANSA Repository field for the calling RDML function. Retrieves a list of LANSA internal database field information for the calling RDML function Retrieves a list of LANSA Repository fields and descriptions for the calling RDML function. Gets a list of help text for a specified field, function or process. Retrieves a list of multi-lingual variables and values for the calling RDML function. Retrieves a multilingual variable definition. Retrieves a list of system variables and descriptions, programs and program types for the calling RDML function. Retrieves a system variable definition. Inserts/updates a field in the LANSA Repository. Puts/updates a list of field multilingual attributes in different languages. Puts/updates a list of help text for a specified field, function or process. Adds/updates a multilingual variable definition to the Repository. Creates/amends a system variable.

Description Read records from any file in the system. Specifies/re-specifies the attributes of an "access route". Specifies/re-specifies the name of a field or value that is to be used to access data via an access route. Compares two CTD files and indicates if a difference is found. Submits a batch job to delete a file and its associated logical files and I/O module. Ends an "edit session" on the definition of a nominated LANSA file. Specifies/re-specifies a field in format of the file being edited.


11


FILE_FIELD VIRTUAL GET_FILE_INFO GET_LOGICAL_LIST GET_PHYSICAL_LIST LOAD_FILE_DATA LOAD_OTHER_FILE LOGICAL_KEY LOGICAL_VIEW MAKE_FILE_OPERATIONL PHYSICAL_KEY PUT_FILE_ML REBUILD_FILE REBUILD_TABLE_INDEX RESET_@@UPID SET_FILE_ATTRIBUTE START_FILE_EDIT UNLOAD_FILE_DATA Function Related Built-In Functions Built-In Function DELETE_FUNCTION END_FUNCTION_EDIT GET_FUNCTION_ATTR GET_FUNCTION_INFO GET_FUNCTION_LIST

Specifies/re-specifies a virtual field of the file definition being edited. Retrieves a list of file related information from the LANSA internal database for the calling RDML function. Retrieves a list of physical files, associated logical views and descriptions for the calling RDML function. Retrieves a list of physical files and descriptions for the calling RDML function. Calls the OAM for the requested file and loads the data. Loads the definition of an "OTHER" file. Specifies/re-specifies the name of a field that is a key of a logical view/file. Specifies/re-specifies the name and basic attributes of a logical view/file Submits a batch job to create/recreate a file plus associated logical files and I/O module. Specifies/re-specifies the key of the physical file associated with the file being edited. Puts/updates a list of file multilingual attributes in different languages. Optionally drops the existing file and its views, and creates the new file from the CTD file . Rebuild OS/400 High Speed Index Reset the @@UPID field to zero in any file. Sets a file's database attributes. Starts an "edit session" on the definition of a nominated LANSA file definition. Calls the OAM for a file and unloads all its data to a flat file.

Description Deletes all details of the function currently being edited. Ends an active edit session on a LANSA function definition. Gets an attribute of the function being edited. Retrieves a list of function related information from the LANSA internal database for the RDML function. Retrieves a list of processes, associated functions and descriptions from the LANSA internal database for the calling RDML function. Returns the RDML code associated with a function. Sets an attribute of a function definition that is being edited.

GET_FUNCTION_RDML PUT_FUNCTION_ATTR


12


PUT_FUNCTION_ML PUT_FUNCTION_RDML START_FUNCTION_EDIT

Puts/updates a list of function multilingual attributes in different languages. Stores the RDML code associated with a function from a working list. Starts an "edit session" on the definition of a nominated LANSA function definition.

Unique Operating System and Platform Access Built-In Functions Built-In Function DLL GET_REGISTRY_VALUE PUT_REGISTRY_VALUE SYSTEM_COMMAND JSM Built-In Functions Built-In Function JSM_COMMAND JSM_OPEN JSM_CLOSE List Handling Built-In Functions Built-In Function DELETE_SAVED_LIST RESTORE_SAVED_LIST SAVE_LIST TRANSFORM_FILE TRANSFORM_LIST Locking Built-In Functions Built-In Function DescriptionLANSA for iSeries

Description Invoke a function contained in a DLL. This BIF will return the Value for the specified Registry Key. This BIF will add/update the value for the specified Registry Key. Execute an operating system command.

Description Sends a command string to the currently open JSM server connection. Opens a connection to the JSM server. Closes the currently open connection to the JSM server.

Description Delete a previously saved list. Restore a previously saved list. Save a working list to disk. Transform a disk file into a working list(s). Transform working list(s) to a disk file.

LOCK_OBJECT UNLOCK_OBJECT Mathematical Built-In Functions Built-In Function EXPONENTIAL ROUND SQUARE_ROOT

Lock a User Object. Unlock a User Object.

Y Y

Description Calculate exponential value. Rounds off a decimal value. Calculate a square root value.


13


Messages and Message Handling Built-In Functions Built-In Function CLR_MESSAGES GET_MESSAGE GET_MESSAGE_DESC GET_MESSAGE_LIST ISSUEINQUIRY ISSUEMESSAGE MESSAGE_COLLECTOR Message Box Built-in Functions Built-In Function MESSAGE_BOX_ADD MESSAGE_BOX_APPEND MESSAGE_BOX_CLEAR MESSAGE_BOX_SHOW Miscellaneous Built-In Functions Built-In Function GET_ILENTRY_LIST MAKE_SOUND Process Related Built-In Functions Built-In Function COMPILE_PROCESS DELETE_PROCESS DLT_PROCESS_ATTACH END_PROCESS_EDIT GET_PROCESS_ATTR GET_PROCESS_INFO GET_PROCESS_LIST PUT_PROCESS_ACTIONS Description Submits a batch job to compile a process and all selected functions. Submits a batch job to delete a process and all of its functions. Deletes attached processes and/or functions from the definition of the process definition being edited. Ends an active edit session on a LANSA process definition. Gets attributes of a process definition. Retrieves a list of process related information from the LANSA internal database for the calling RDML function. Retrieves a list of processes and descriptions from the LANSA internal database for the calling RDML function. Puts the definition of an action bar layout into the definition of the process definition. Description Retrieves a list of Impact List entries and descriptions from the data dictionary. Causes a standard sound to be queued. Description Adds items to the message box assembly area. Appends items to the message box assembly area. Clears the current message box assembly area. Causes a standard MS message box to be displayed. Description Clear all messages from RDML program queue. Gets details of next message from RDML pgm queue. Gets the description of a message from a msg file. Loads the list with each subsequent message file/message stored in the message table. Issue an inquiry message to a message queue. Issue a message to a message queue. Nominate function as a message collector.


14


PUT_PROCESS_ATTACH PUT_PROCESS_ATTR PUT_PROCESS_ML START_PROCESS_EDIT

Puts a process and/or function "attachment" into the definition of the process definition. Sets an attribute of a process definition within an edit session. Puts/updates a list of process multilingual attributes in different languages. Starts an "edit session" on the definition of a nominated LANSA process definition.

Rule/Trigger Related Built-In Functions Built-In Function DELETE_CHECKS DELETE_TRIGGERS PUT_COND_CHECK PUT_DATE_CHECK PUT_FILE_CHECK PUT_PROGRAM_CHECK PUT_RANGE_CHECK PUT_TRIGGER PUT_VALUE_CHECK Description Deletes standard Repository or File level validation checks from nominated field. Deletes standard Repository or File level triggers from nominated field for subsequent replacement Create/amend a "simple conditional logic" Repository or File level validation check Create/amend a "date range/date format" Repository or File level validation check. Create/amend a "code/table file lookup" Repository or File level validation check. Create/amend a "call user program" Repository or File level validation check. Create/amend a "range of values" Repository or File level validation check. Create/amend a Repository or File level trigger. Create/amend a "list of values" Repository or File level validation check.

Space Built-In Functions Built-In Function CREATE_SPACE DEFINE_SPACE_CELL DELETE_IN_SPACE DESTROY_SPACE FETCH_IN_SPACE INSERT_IN_SPACE SELECT_IN_SPACE SELECTNEXT_IN_SPACE SPACE_OPERATION Description Creates a space object with the specified name Defines a cell (or column) within the specified space object. Deletes all cell rows that matches the key values supplied Destroys a space object with the specified name Retrieves the values of the first cell row that matches the key values supplied. Inserts a set of cell values into a space object Retrieves the values of the first row of cells that match the key values supplied Retrieves the values of the next row of cells that match the key values supplied. Request a miscellaneous space object operation


15


UPDATE_IN_SPACE Spool File Built-In Functions Built-In Function START_RTV_SPLF_LIST GET_SPLF_LIST_ENTRY END_RTV_SPLF_LIST String Handling Built-In Functions Built-In Function BCONCAT CENTRE CHECKNUMERIC CHECKSTRING CONCAT FILLSTRING GET_KEYWORD_STRING LEFT NUMERIC_STRING REVERSE RIGHT SCANSTRING TCONCAT UPPERCASE Template Related Built-In Functions Built-In Function EXECUTE_TEMPLATE TEMPLATE_@@ADD_LST TEMPLATE_@@CANSNNN TEMPLATE_@@CLR_LST TEMPLATE_@@GET_FILS TEMPLATE_@@NANSNNN TEMPLATE_@@SET_FILS

Updates a single cell row that matches the key values supplied

Description Provides the selection criteria for retrieval of spool files. Retrieves the details of the specified spooled files. Closes the list and releases the storage allocated to that list.

Description Concatenate strings with a blank character. CENTRE an argument string into a return string. Check and convert an alpha string to numeric form. Check a string only contains allowable values. Concatenate strings in full (no truncation). Fill a field with occurrences of a string. Get keywords and values from an ESF string. Left align argument into return string. Convert a number to a string. Reverse a text string. Right align argument into return string. Scan a string for first occurrence of a pattern. Concatenate strings with trailing blanks truncated. Convert a string to uppercase characters.

Description Executes an application template to generate RDML function code into a working list. Allows a new field to be added to an application template list. Allows an application template character reply variable to be set before execution. Clears an application template list. Returns a list of all related files from a nominated base file Allows an application template numeric reply variable to be set before execution. Allows file(s) from a list of files to be "selected" for use within an application template.


16


TEMPLATE_@@SET_IDX

Allows an index variable to be set to a nominated value before execution.

Web Built-In Functions Built-In Function WEB_BUILD_COMPONENT WEB_CREATE_PAGE WEB_STATIC_PAGE WEB_UPD_PAGE Description Build a Web Component. Creates the Web Component and its related Page. Outputs Static HTML to the IFS. Update text for specific page.

Workfolder Application Facility/400 Built-In Functions Built-In Function WAF_CRTOBJ WAF_DEFFOLD WAF_DEFSTOBJ WAF_DLTEOBJ WAF_FETCHOBJ WAF_FINDOBJ WAF_INDEXOBJ WAF_PPRTOBJ WAF_PRINTOBJ WAF_RESET WAF_RMVOBJ WAF_SCAN Description Returns the object path of a new document that it creates. Creates a new empty case. Adds a document to a case. Places a delete in the delete request file. Writes a retrieve request to the optical request file. Locates all documents within a specified case. Adds Document description and Document Type to a document.. Sends the formatted print command to the image workstation. Queues print requests to an image workstation printer. Resets the image workstation. Removes a document from a case. This Built-In Function: - generates unique name for scanned document - determines the DASD path for the next document using Workfolder Application Facility balancing - sends the formatted scan command to the image workstation and waits for the workstation return code - returns the return code to the calling program - returns the index value to the calling program if one was requested - adds a document record to the Workfolder Application Facility database file upon normal completion. Displays one or more image documents on an image workstation. Sends the set configuration command to the ImagePlus Workstation Program. Puts the formatted store request into the optical request file, increments the active request count, and returns to caller. Tells LANSA that you are going to use the AS/400

WAF_SENDOBJ WAF_SETC WAF_STOROBJ WAF_USE


17


Workfolder Application Facility. Zip Built-In Functions Also see Zip Built-in Function Note Built-In Function ZIP_ADD ZIP_DELETE ZIP_EXTRACT ZIP_GET_INFO ZIP_MAKE_EXE Description Adds files to zip file. Deletes files from zip file. Extracts files from zip file. Retrieve information about zip file. Create executable file from zip file.


18

System Variables

System VariablesRefer to:

General Variables Function Only Variables BIF Variables Special Variables LANSA for the Web System Variables Appendix E - System Variable Evaluation Programs


19

Formats, Values and Codes

Formats, Values and CodesRefer to:

Date Formats Standard Field Edit Codes Arithmetic and Expression Operators RDML Field Attributes and their Use RDML I/O Return Codes Help Text Enhancement and Substitution Values


20

Template Commands and Variables

Template Commands and Variables

@@CLR_LST @@ CMP_IDX @@COMMENT @@DEC_IDX @@GET_FILS @@GOTO @@IF @@INC_IDX @@LABEL @@MAK_LSTS @@MRG_LSTS @@QUESTION @@RTV_FLDS @@RTV_KEYS @@RTV_RELN @@SET_IDX Also see:

Clears a working list Compares an index value Adds a comment line to the generated RDML code Decreases an index value Gets the files to be used in this template Passes control to a label Tests a condition and pass control to a label Increases an index value A label which is the subject of another command Makes a list of selected fields from another list(s) Merges a list(s) with another list(s) Asks a question and receives a reply Retrieves the fields in a file Retrieves the keys of a file Retrieves the relationship between two files Sets an index value

General Template Variables Question and Answer Template Variables File Template Variables List Template Variables Template Error Messages Appendix C - Application Template Program Examples


21

Error Messages

Error MessagesThe following error messages are in other guides:

LANSA Server Error Codes Error Code 23 - Enhanced APPC Return Codes (Client Access/400, Netsoft Router, etc.). Error Code 23 - CPI-C Return Codes (Host Integration Server 2000, Network Services for DOS). Communications Error Codes in the LANSA Communications Setup Guide.


22

RDML Commands

RDML CommandsGo to RDML Commands List for a summary of the commands. The following commands make up the complete LANSA RDML programming language. Provided for each command is:

A description References to related commands A syntax diagram Explanation of each parameter Warnings /Comments Examples.


23

RDML Commands

ABORTThe ABORT command is used to cause an executing RDML program to end immediately and optionally issue an error message. Ending a function via an ABORT command is considered to be an "abnormal" end and the entire process is canceled by LANSA. For the implications of commitment control refer to Using Commitment Controlin the LANSA for iSeries User Guide. Also See ABORT Parameters ABORT Examples CALL (see the IF_ERROR parameter) EXIT MENU RETURNOptional ABORT -------- MSGTXT --------*NONE --------------------------> 'message text' >-- MSGID -------- *NONE --------------------------> message identifier >-- MSGF --------- *NONE --------------------------> message file library name >-- MSGDTA ------- substitution variables -------| | expandable group expression | -------- 20 max ---------------

ABORT ParametersMSGTXT MSGID MSGF MSGDTA

MSGTXTAllows up to 80 characters of message text to be specified. This text will be displayed when the function ends as an error message. The message text specified should be enclosed in quotes. Use either the MSGTXT parameter or the MSGID/MSGF parameters but not both.

MSGIDAllows a standard message identifier to be specified as the message that should be issued when the function ends. Message identifiers must be 7 characters long. Use this parameter in conjunction with the MSGF parameter.

MSGFSpecifies the message file in which the message identified in the MSGID parameter will be found. This parameter is a qualified name. The message file name must be specified. If required the library in which the message file resides can also be specified. If no library name is specified, library *LIBL is assumed.


24

RDML Commands

MSGDTAUse this parameter only in conjunction with the MSGID and MSGF parameters. It specifies from 1 to 20 values that are to be used to replace "&n" substitution variables in the message specified in the MSGID parameter. Values in this parameter may