1 4 1 Parameters

1.4.1 Parameters

REQUEST

This is the action requested to be performed within LANSA. The action requested can be up to 10 characters in length. The actions that may be requested include:

• MENU: Specifies that the Main System Menu (Advanced if DEVELOPER(*ADVANCED) is specified) is to be presented on entry to LANSA. This is the default action, and the one most likely to be used by developers.

• RUN: Specifies that a process or a function is to be used. This allows a process or a function to be called without going through the normal LANSA menus.
  Refer to Using A Process Or Function Directly From Your Own Application for more details.

• SUBMIT: Specifies that a process is to be submitted to batch. This allows a process to be submitted without going through the normal LANSA menus.
  Refer to Submitting A Process To Batch Directly From Your Own Application for more details.

• EXPORT: Specifies that an IBM i export list is to be exported directly. This allows an export list to be exported without going through the normal LANSA menus.
  Refer to Direct Exporting of Objects in a List for more details.
  It is not recommended that this facility be used interactively (i.e. directly from a workstation) because of the relatively large number of database I/Os performed.
  To use this request, the user profile being used must have access to Work with Lists of Objects to Be Exported in the Housekeeping Menu. Refer to User Access to the LANSA System for information.

• IMPORT: Specifies that the import facility is to be used directly. This allows an import to be done without going through the normal LANSA menus.
  Refer to Direct Importing of Objects for more details.
  It is not recommended that this facility be used interactively (i.e. directly from a workstation) because of the relatively large number of database I/Os performed.
  To use this request, the user profile being used must have access to Import objects into this Partition in the Housekeeping Menu. Refer to User Access to the LANSA System for information.

• REORG: Specifies that the re-organization facility be executed directly. This allows a LANSA re-organization to be run without going through the normal LANSA menus.
  Refer to Directly Invoking The Re-organization Facilityfor more details.
  It is not recommended that this facility be used interactively (i.e. directly from a workstation) because of the relatively large number of database I/Os performed.
  To use this request, the user profile being used must have access to Submit job to reorg LANSA internal database in the Housekeeping Menu. Refer to User Access to the LANSA System for information.

• LICENSE or LICENCE: Specifies that the LANSA License Facility be invoked. This cannot be accessed via normal LANSA menus.
  Refer to The LANSA License Facility in the Installing LANSA on IBM i Guide for more details.

• EXPORTMSGS: Specifies that developer messages are to be exported. This cannot be done via normal LANSA menus.
  Refer to Export Developer Message for more details.
  It is not recommended that this facility be used interactively (i.e. directly from a workstation) because of the relatively large number of database I/Os performed.

• IMPORTMSGS: Specifies that developer messages are to be imported. This cannot be done via normal LANSA menus.
  Refer to Import Developer Messages for more details.
  It is not recommended that this facility be used interactively (i.e. directly from a workstation) because of the relatively large number of database I/Os performed.

• LCOE: Specifies that LANSA Open is to be used. This is used internally by LANSA Open and is not usable in a normal LANSA invocation.

• FIELDS: Specifies that the Field Control Menu (Work With Fields screen if DEVELOPER(*ADVANCED)) is to be presented on entry to LANSA.
  To use this request, the user profile being used must have access to Work with fields, Advanced menu. Refer to User Access to the LANSA System for information.

• FILES: Specifies that the File Control Menu (Work With Files screen if DEVELOPER(*ADVANCED)) is to be presented on entry to LANSA.
  To use this request, the user profile being used must have access to the Work with files, Advanced menu. Refer to User Access to the LANSA System for information.

• PROCESSES: Specifies that the Process Control Menu (Work With Processes screen if DEVELOPER(*ADVANCED)) is to be presented on entry to LANSA.
  To use this request, the user profile being used must have access to the Work with processes, Advanced menu. Refer to User Access to the LANSA System for information.

• STRMONITOR: This is no longer available.

• STRMON: Specifies that the host monitor for Visual LANSA is to be started. This is used internally by Visual LANSA and is not usable in a normal LANSA invocation.

• PCMAINT: Specifies that the PC Maintenance for Visual LANSA is to be started. This allows definition of information for Visual LANSA.
  Refer to Maintaining the PC Definition File for more details.

• PCEXPORT: Specifies that a PC export list is to be exported directly. This allows a PC export list to be exported directly without going through the normal LANSA menus.
  Refer to Direct Exporting of Objects in a List for more details. It is not recommended that this facility be used interactively (that is, directly from a workstation) because of the relatively large number of I/Os performed.
  To use this request, the user profile being used must have access to the Work with list of objects to be exported in the Housekeeping Menu. Refer to User Access to the LANSA System for information.

• VERIFYFRT: Causes a Function Routing Table (FRT) to be verified. Refer to What is Function Routing? for more detailed information about this facility.

• STRLISTEN: Specifies that the LANSA Communications Extensions Listener Job is to be started. Refer to the LANSA Communications Setup Guide for details of how and when to use this option.

• CONFIGURE: Specifies that the LANSA Work with Configuration Items Facility be invoked. This cannot be accessed via normal LANSA menus. Refer to the Working with Configuration Items for details of how to use this facility.

• ABOUT: Causes the details of this LANSA system, such as LANSA version number, OS version number, libraries and IFS to be displayed on the LANSA Configuration Details screen, frequently called LANSA About. You can capture this data on a Save file, to send to LANSA Support in the event of a query. The save file is DCXSUPDTA and it will be saved in the LANSA_XXXPGMLIB/SUPPORT directory.
  This same information can also be captured using a web interface with the URL:

      http://123.45.67.89/cgi-bin/lansaweb?procfun+lansaweb+about+dem

     In this case the information can be saved to a save file or, if your email is configured, emailed directly to your LANSA support desk.

• X_RUN: Specifies that an RDMLX function is to be executed on IBM i.

PROCESS

This parameter is used to specify the name of the process to RUN, SUBMIT or X_RUN. It can be up to 10 characters in length.

FUNCTION

This parameter is used to specify the name of the function to RUN or X_RUN. It can be up to 7 characters in length.

PARM01

This parameter is used to specify parameter number 1. It can be up to 256 characters in length.

If the request is RUN or SUBMIT, this must exactly match the first user parameter defined for the process being run or submitted.

If the request is EXPORT or PCEXPORT, this must be the name of the previously defined list that specifies object(s) to be exported. It can be up to 7 characters in length.

If the request is IMPORT, this must be the device or device file name if importing from magnetic tape or on a disk, otherwise blank. It can be up to 10 characters in length.

If the request is EXPORTMSGS, this must be the name of the file to receive the export developer message header details. It can be up to 10 characters in length.

If the request is IMPORTMSGS, this must be the name of the file to that contains the developer message header details to be imported. It can be up to 10 characters in length.

If the request is STRLISTEN, this can optionally be the special value *UNLOCK. The special value *UNLOCK tells the Listener Job to leave LANSA resources unlocked. This option reduces the dependency of the Listener Job on the LANSA system from which it is started.

If the request is REORG, this acts as Change Work Spaces parameter and valid values are N, Y and blank. If the value is blank the default value is 'N"

PARM02

This parameter is used to specify parameter number 2. It can be up to 256 characters in length.

If the request is RUN or SUBMIT, this must exactly match the second user parameter defined for the process being run or submitted.

If the request is EXPORT, this must be the device or device file name if exporting on magnetic tape or disk, blank otherwise. It can be up to 10 characters in length.

If the request is PCEXPORT, this must be the CheckOutUsage of R (read only) or M (maintenance).

If the request is IMPORT, this must be save file name if importing from a save file, otherwise blank. Can be a qualified name. It can be up to 21 characters in length.

If the request is EXPORTMSGS, this must be the name of the file to receive the export developer message text details. It can be up to 10 characters in length.

If the request is IMPORTMSGS, this must be the name of the file to that contains the developer message text details to be imported. It can be up to 10 characters in length.

If the request is REORG, this acts as Total FFC parameter and valid values are 1 to 99 and blank. If the value is blank the default value is 99

PARM03

This parameter is used to specify parameter number 3. It can be up to 256 characters in length.

If the request is RUN or SUBMIT, this must exactly match the third user parameter defined for the process being run or submitted.

If the request is EXPORT, this must be the save file name if exporting to a save file, blank otherwise. Can be a qualified name. It can be up to 21 characters in length.

If the request is PCEXPORT, and the CheckOutUsage (PARM02) is M (maintenance), this must be the Task. It can be up to 8 characters in length.

If the request is IMPORT, this must be name of message queue to which messages and inquiries are to be sent. It can be up to 10 characters in length.

If the request is EXPORTMSGS, this must be the name of the library where the exported developer message files will be created. It can be up to 10 characters in length.

If the request is IMPORTMSGS, this must be the name of library that contains the developer message files to be imported. It can be up to 10 characters in length.

If the request is REORG, this acts as Total Compiles parameter and valid values are 1 to 99 and blank. If the value is blank the default value is 20

PARM04 

This parameter is used to specify parameter number 4. It can be up to 256 characters in length.

If the request is RUN or SUBMIT, this must exactly match the fourth user parameter defined for the process being run or submitted.

If the request is EXPORT, this must be the file sequence number if exporting to a device (see PARM02). The default is *END if not specified. It can be up to 7 characters in length (numerics).

If the request is PCEXPORT, and the CheckOutUsage (PARM02) is M (maintenance), this must be the PC Name. It can be up to 10 characters in length.

If the request is IMPORT, this must be the source system type (IBM i). It can be up to 6 characters in length.

If the request is EXPORTMSGS, this must be the export start date. This is in CCYYMMDD format. All developer messages created or changed on or after the export start date will be exported. This must be 8 characters in length.

If the request is REORG, this acts as Remove Multilingual support parameter and valid values are N, Y and blank. If the value is blank the default value is N

PARM05

This parameter is used to specify parameter number 5. It can be up to 256 characters in length.

If the request is RUN or SUBMIT, this must exactly match the fifth user parameter defined for the process being run or submitted.

If the request is EXPORT, this is whether or not to omit RDML source code from exported data. (YES or NO). The default is NO if not specified. It can be up to 3 characters in length.

If the request is IMPORT, this is the file sequence number if importing from a device (see PARM01). The file sequence number can be up to 7 numbers long. The default is *SEARCH. If the import is from an optical device (see PARM01), then this is the optical file name. The optical file name can be up to 80 characters long.

If the request is REORG, this acts as Purge Developer Message starting from date parameter and valid value is a date format in CCYYMMDD and blank. If the value is blank the default value is 00000000. The date must be a valid date, as it is not validated.

PARM06

This parameter is used to specify parameter number 6. It can be up to 256 characters in length.

If the request is RUN or SUBMIT, this must exactly match the sixth user parameter defined for the process being run or submitted.

If the request is EXPORT, this is the languages to be exported. Up to 64 language codes can be specified or *ALL to export all languages. Only applicable to multilingual partitions. It can be up to 256 characters in length.

If the request is IMPORT, this is whether or not to import all languages in the exported data. (Y or N). Only applicable to multilingual partitions. This is 1 character in length.

If the request is REORG, this acts as Delete Deleted Partition Language Extensions and valid values N, Y and blank. If the value is blank the default value is N

PARM07

This parameter is used to specify parameter number 7. It can be up to 256 characters in length.

If the request is RUN or SUBMIT, this must exactly match the seventh user parameter defined for the process being run or submitted.

If the request is EXPORT, this is do not save to media - leave in QTEMP. (YES or NO) Default is NO if not specified. It can be up to 3 characters in length.

If the request is IMPORT, this is the languages to be imported. Up to 64 language codes or *ALL to import all languages in exported data. Only applicable to multilingual partitions. It can be up to 256 characters in length.

If the request is REORG, this acts as Reorganize Shared LANSA system files and valid values N, Y and blank. If the value is blank the default value is N

PARM08

This parameter is used to specify parameter number 8. It can be up to 256 characters in length.

If the request is RUN or SUBMIT, this must exactly match the eighth user parameter defined for the process being run or submitted.

If the request is EXPORT, this is whether or not to include LANSA/Document details in the export. (YES or NO). Default is NO if not specified. It can be up to 3 characters in length.

If the request is IMPORT, this is the default language. Defaults to current language if not specified. Only applicable to multilingual partitions. It can be up to 4 characters in length.

If the request is REORG, this acts as Purge Task History starting from date parameter and valid value is a date format in CCYYMMDD and blank. If the value is blank the default value is 00000000. The date must be a valid date, as it is not validated.

PARM09

This parameter is used to specify parameter number 9. It can be up to 256 characters in length.

If the request is RUN or SUBMIT, this must exactly match the ninth user parameter defined for the process being run or submitted.

If the request is EXPORT, specify in characters 1 – 3 whether or not to omit frameworks and groups. (YES or NO). Defaults to NO if not specified.

If the request is IMPORT, specify, in characters 1-3, whether or not to assign new internal names. (YES or NO). Defaults to YES if not specified.

Use characters 4-6 to delete the $$ files. Pass as YES or NO. Defaults to NO if not specified.

If YES, any $$ version of the files being imported will be automatically deleted. The file name to be deleted is composed of $$ plus the first 8 characters of the file name. Where 9 and 10 character file names are not unique in the first 8 characters, this may result in additional $$ files being deleted. (For the processing to complete, these files must be deleted.)

PARM10

This parameter is used to specify parameter number 10. It can be up to 256 characters in length.

If the request is RUN or SUBMIT, this must exactly match the tenth user parameter defined for the process being run or submitted.

If the request is IMPORT, specify in characters 1-10  the name of the library containing export objects. Only applicable for IBM i to S/38 transfer. It can be up to 10 characters in length.

Use characters 11-13 to specify Allow Name Changes. Pass as YES or NO. Defaults to NO if not specified.

Use characters 14-16 to specify Allow Type Changes. Pass as YES or NO. Defaults to NO if not specified.

Use characters 17 –19 to specify whether or not to omit frameworks and groups. (YES or NO). Defaults to NO if not specified.

PARTITION

This parameter is used to specify the name of the partition to be used. It can be up to 3 characters in length.

If not specified, the partition defaults to the SYS partition.

LANGUAGE

This parameter is used to specify the language to be used. It can be up to 4 characters in length.

Only applicable to multilingual partitions.

If not specified, the language defaults to the partition default language.

TASK_ID

This parameter is used to specify the task identifier to be used for development work. It can be up to 8 characters in length.

PC_TYPE

This parameter is used to specify the type of PC used with the GUI. This is 1 character in length.This is used internally by LANSA and is not usable in a normal LANSA invocation.

DEVELOPER

This parameter is used to specify whether LANSA presents a command line and work with interface. It is up to 9 characters in length.

• *NO, N: Specifies that the LANSA menus are presented in the traditional style without a command line.

• *YES, Y: Specifies that the LANSA menus are presented in the traditional style with a command line.
  If access is given to developer services (see ALLOW_MSGS), then the options to execute an IBM i command and execute user defined developer services exit programs will be available.

• *ADVANCED, A: Specifies that the LANSA menus are presented in the work with style with a command line.
  If access is given to developer services (refer to ALLOW_MSGS), then the options to execute an IBM i command and execute user defined developer services exit programs will be available.

ALLOW_MSGS

This parameter is used to specify whether or not access is given to developer services. It is up to 4 characters in length.

• *NO, N: Specifies that no access is given to developer services. This includes the notification of developer messages.

• *YES, Y: Specifies that access is given to developer services.

DATE_SRCE

This parameter is used to specify where to retrieve the date and date format from. It is up to 7 characters in length.

• *SYSTEM, S: Specifies that the date and date format are to be retrieved from the system values. This is the default.

• *JOB, J: Specifies that the date and date format are to be retrieved from the job attributes.

BDEBUG

This parameter is used to specify that batch debug of LANSA RDML functions is required.  This is used internally by LANSA and is not useable in a normal LANSA invocation.

BDEBUG_DEV

This parameter is used to specify the name of the display device to be used for debugging batch RDML functions. This is used internally by LANSA and is not useable in a normal LANSA invocation.

BDEBUG_MSG

This parameter is used to specify the name of the message queue to be used to issue messages when using batch debugging. This is used internally by LANSA and is not useable in a normal LANSA invocation.

X_RUNADPRM

This parameter is used to specify additional parameters for an X_RUN request. These additional parameters must be specified in the X_RUN format, e.g. PRTR=*PATH. Refer to Standard X_RUN Parameters in the Technical Reference Guide for details of X_RUN parameters.

For examples, refer to 1.4.2 Execute RDMLX function.