Table of contents
-
LANSA for i User Guide
- About this guide
-
1. LANSA Overview
- 1.1 How is LANSA used?
- 1.2 The Components of LANSA
- 1.3 Accessing LANSA
- 1.4 LANSA Command
- 1.5 The Major LANSA Developer Menus
- 1.6 The Major LANSA Developer(*Advanced) Screens
- 1.7 Messages and the Help Key
- 1.8 Command Entry Line
- 1.9 Select LANSA Objects via the Prompt Key
- 1.10 Last Action Details
- 1.11 Task Tracking
- 1.12 Expedited Program Change (EPC) Log
- 1.13 Long Names
-
2. Fields
- 2.1 The Field Control Menu
- 2.2 Select Field(s) to Be Worked With
- 2.3 Create New Field Definitions
- 2.4 Review or Change Field Definitions
- 2.5 Field Multilingual Attributes
- 2.6 Field Rules/Triggers
- 2.7 Range of Values Rule
- 2.8 List of Values Rule
- 2.9 Code / Table File Lookup Rule
- 2.10 Simple Logic Rule
- 2.11 Complex Logic Rule
- 2.12 Date Format / Range Rule
- 2.13 Triggers
-
2.14 Field Help Text
- 2.14.1 Steps to Create, Review or Change HELP Text
- 2.14.2 HELP Text Copy Options
- 2.14.3 Use the IBM Source Entry Utility (SEU)
- 2.14.4 Use Special Characters to Enhance HELP Text
- 2.14.5 Use Substitution/Control Values in HELP Text
- 2.14.6 Substitution/Control Values for Windows-specific HELP Text
- 2.14.7 Use IBM i Office Help Documents
- 2.14.8 Exit from the SEU Utility
- 2.14.9 Use Panel Groups for Help Text
- 2.14.10 Create Panel Groups for HELP Text in LANSA
- 2.14.11 Help Text Considerations when using Panel Groups
- 2.15 Print Field Definitions
- 2.16 System Variables
- 2.17 Print System Variable Definitions
- 2.18 Multilingual Variables
- 2.19 Print Multilingual Variable Definitions
- 2.20 Field Reference File
-
3. Files
- 3.1 What Is a File and What Is a File Definition?
- 3.2 The File Control Menu
- 3.3 Select File Definition(s) to Work With
- 3.4 Create a New File Definition
- 3.5 File Definition Maintenance
- 3.6 Delete a File Definition
- 3.7 Make a New or Amended File Definition Operational
- 3.8 Print File Definitions
- 3.9 Bulk Load of OTHER files
- 3.10 The File Definition Menu
- 3.11 Fields in the File Definition
- 3.12 Logical Views/Files Associated with File Definition
- 3.13 File Level Rules/Triggers
- 3.14 Access Routes to Other Files
-
3.15 Virtual Fields
- 3.15.1 Examples of Virtual Field Applications
- 3.15.2 Steps to Define, Review or Change Virtual Fields
- 3.15.3 Virtual Fields Maintenance
- 3.15.4 Substringing of a Field/Record
- 3.15.5 Concatenation of Field(s)
- 3.15.6 Mathematical Calculation of a Field
- 3.15.7 Date Conversion of a Field
- 3.15.8 Virtual Field RPG Source Code Maintenance
- 3.15.9 Edit Virtual Field RPG Code
- 3.16 Batch Control Logic
- 3.17 Database File Attributes
- 3.18 File Multilingual Attributes
-
3.19 Load the Definition of a File NOT Maintained by LANSA
- 3.19.1 What Happens When a File Definition Is Loaded (or Re-Loaded)?
- 3.19.2 When Should a File Definition Be Loaded (or Re-Loaded)?
- 3.19.3 The Steps to Loading Definition of File Not Maintained by LANSA
- 3.19.4 Elect whether or not to Make Logical File Accessible
- 3.19.5 Review Messages that Result from Attempted Load
- 3.20 Tips and Techniques for Defining Files Using LANSA
-
4. Processes and Functions
- 4.1 What Is a Process and What Is a Function?
- 4.2 Process Control Menu
- 4.3 Select Processes to Be Worked With
- 4.4 Create a New Process Definition
- 4.5 Existing Process Definition Maintenance
- 4.6 Delete a Process Definition
- 4.7 Compile a Process from New or Amended Definition
-
4.8 Process Help Text
- 4.8.1 Steps to Create or Change Process HELP Text
- 4.8.2 Choose the Process or Function HELP Text
- 4.8.3 HELP Text Copy Options
- 4.8.4 Using the IBM Source Entry Utility SEU (Source Entry Utility)
- 4.8.5 Use Special Characters to Enhance HELP Text
- 4.8.6 Use Substitution/Control Values in HELP Text
- 4.8.7 Substitution/Control Values for Windows-specific HELP Text
- 4.8.8 Exit from the SEU Utility
- 4.9 Print Process Definitions
- 4.10 Use/Execute a Process from a Workstation
- 4.11 Submit a Process to Batch
- 4.12 LANSA Debug Mode
- 4.13 Process Definition
- 4.14 Create a New Function
-
4.15 Edit a Function's RDML Commands
- 4.15.1 What are RDML Commands?
- 4.15.2 Automatic Functions, Manual Functions and their RDML Commands
- 4.15.3 Steps to Editing RDML Commands
- 4.15.4 Line Edit Actions When Using the LANSA Program Editor
- 4.15.5 Prompt RDML Commands
- 4.15.6 Function Keys Available When Using Formatted Prompt
- 4.15.7 About the IBM Program Editor SEU
- 4.15.8 IBM Program Editor SEU
- 4.15.9 Exit from the IBM Editor SEU
- 4.15.10 Function Checker
- 4.15.11 Screen Design Facility
- 4.15.12 Design a Screen Format
- 4.15.13 Report Design Facility
- 4.15.14 Design a Report
- 4.15.15 Use Cycle and Repeat Values to Enhance Report Image
- 4.15.16 A Note for Right-to-Left Language Users
- 4.15.17 Action EX, F3 or F12 (Exit)
- 4.15.18 Action GR (Add/Remove Grid)
- 4.15.19 Action M or F16 (Move)
- 4.15.20 Actions TI or F6 and TC or F21 (Text Insert/Change)
- 4.15.21 Action TD or F22 (Text Delete)
- 4.15.22 Action FI or F6 (Field Insert)
- 4.15.23 Action FD or F22 (Field Delete)
- 4.15.24 Action ID or F17 (Identification Change)
- 4.15.25 Pxxx Actions for Manipulating Pop-Up Windows
- 4.15.26 Action WLn (Move Window Left)
- 4.15.27 Action WRn (Move Window Right)
- 4.15.28 Action Wn (Move Window to n)
- 4.15.29 Action W? (Display Current Window Details)
- 4.15.30 Action Run (Roll Image up n Lines)
- 4.15.31 Action RDn (Roll Image down n Lines)
- 4.15.32 Action SP (Change Space before/after Values)
- 4.15.33 Canceling Pending Screen/Report Design Actions
- 4.15.34 Some Tips for Inputting / Changing RDML Programs
- 4.16 Rename a Function
- 4.17 Delete a Function
- 4.18 Function Control Table
- 4.19 Special Entries on the Process Menu
- 4.20 Multilingual Special Entries
- 4.21 Other Processes on the Process Menu
- 4.22 Process Parameters
- 4.23 Miscellaneous Process Details
- 4.24 Process Multilingual Attributes
- 4.25 The Action Bar Control Table
-
5. Housekeeping
- 5.1 The Housekeeping Menu
-
5.2 Review and Change Access to LANSA Objects
- 5.2.1 LANSA Objects and Security
- 5.2.2 Initial User Access to Objects
- 5.2.3 The Special *PUBLIC User
- 5.2.4 Initial Public Access to Objects
- 5.2.5 Steps to Review or Change Object Security
- 5.2.6 Select the Objects to Review or Change
- 5.2.7 Review or Change the Object Security
- 5.2.8 External Security Matching
- 5.3 User Access to the LANSA System
- 5.4 Task Tracking
- 5.5 How to Invoke the Work With Tasks Facility
- 5.6 Reorganizing the LANSA Internal Database
- 5.7 Changing Partition Being Worked With
- 5.8 System Partition Definitions
- 5.9 Frameworks and Groups
- 5.10 Partition Multilingual Attributes
-
5.11 The File Maintenance Utility
- 5.11.1 When to Use or Not Use the File Maintenance Utility?
- 5.11.2 Steps to Invoke the File Maintenance Utility
- 5.11.3 Select the Physical File
- 5.11.4 Select the Maintenance Access Path
- 5.11.5 Steps to Use the File Maintenance Utility
- 5.11.6 Select the Type of File Maintenance Required
- 5.11.7 Add New Records to the File
- 5.11.8 Browse a File - Select the Browse Fields to be Displayed
- 5.11.9 Specify the Key(s) to Be Used
- 5.11.10 Browse a File - Select a Specific Record to Maintain
- 5.11.11 Display, Change or Delete a Specific File Record
-
5.12 Exporting and Importing
- 5.12.1 Control the Export and Import of Visual LANSA Components
- 5.12.2 Control the Export and Import of LANSA Web Components
-
5.12.3 Work with Export Lists
- Work with Lists of Objects to Be Exported
- Submit a PC Export Run to Batch
- Submit a IBM i Export Run to Batch
- Work With Objects in a List
- Save New or Changed List Details
- Generic Object Names
- Add Fields to the List
- Add Files to the List
- Add Logical Views to the list
- Add I/O or OAM Modules to the list
- Add Processes/Functions to the List (Select by Process Name)
- Add Functions to the List
- Add System Variables to the List
- Add Multilingual Variables to the List
- Add Application Templates to the List
- Add All Partition Objects to the List
- Add Non-LANSA Objects to the List
- Add Message Files to PC Export Lists
- Add All Objects Worked on Under a Task Identifier
- Add Export Lists to the List
- Review/Delete Objects Already in the List
- Define Substitution Variables Used in a List
- Define IBM i Command to Execute
- Add Web HTML or XML Components to the List
- Add Technology Services to the List
- Add Weblets to the List
- Add Visual LANSA Components to the list
- 5.12.4 Steps to Import Objects
- 5.12.5 Exporting Objects - Tips and Techniques
- 5.12.6 Importing Objects - Tips and Techniques
- 5.12.7 Direct Exporting of Objects in a List
- 5.12.8 Direct Importing of Objects
-
5.13 Application Templates
- 5.13.1 Invoke the Work With Application Templates Facility
- 5.13.2 Work with Application Template Definitions
- 5.13.3 Creating Application Templates
- 5.13.4 Review/Change Application Template Definition
- 5.13.5 Review/Change Application Template Commands
- 5.13.6 Maintain Template HELP Panels
- 5.13.7 Create a New HELP Panel
- 5.13.8 Review/Change a HELP Panel Definition
- 5.13.9 Review/Change a HELP Panel Body
-
5.14 Impact Analysis
- 5.14.1 Work with Impact Lists
- 5.14.2 Select Task Identifier(s)
- 5.14.3 Work with Impact List Entries
- 5.14.4 Impact List - Profile Search
- 5.14.5 Impact List - Related Search
- 5.14.6 Reasons for an Entry
- 5.14.7 Display Details of Object/Reason
- 5.14.8 Find Impact List Entries
- 5.14.9 Run Impact List searches in Batch
- 5.14.10 Considerations when using Impact Lists
- 5.15 The Multilingual Development Textual Data Facility
- 5.16 Common Input Options
- 6. Administration
-
7. Documentor
- 7.1 Work with Documents
- 7.2 Work with Objects to Be Documented
- 7.3 Input Options to Create, Review or Change Document Definition
- 7.4 Work with Selected Objects to Be Documented
- 7.5 Include Fields in the Document
- 7.6 Include Files in the Document
- 7.7 Include Processes/Functions in Document
- 7.8 Include Other Documents into the Document
- 7.9 Review/Exclude Objects in the Document
- 7.10 Review/Change Table of Contents
- 7.11 Submit a Document Production Run to Batch
- 7.12 Documentor Default Printing Options -DC@A06 Configuration
- 7.13 Questions and Answers
- 8. LANSA PC Development
-
9. Developer Services
- 9.1 Developer Services Components
- 9.2 Developer Services Menu
- 9.3 Display LANSA/Workstation Messages
- 9.4 Work with Developer Messages (LANSA/Messages)
- 9.5 Execute an IBM i Command
- 9.6 User Defined Developer Services Exit Programs
- 9.7 Notifying a User of Developer Messages
- 9.8 Export Developer Messages
- 9.9 Import Developer Messages
- 9.10 Purge Developer Messages
-
9.11 Developer Services Configuration
- 9.11.1 User Defined Developer Services Exit Programs
- 9.11.2 User Defined User Profile Validation Program
- 9.11.3 User Defined Send a Developer Message Program
- 9.11.4 User Defined Developer Message Category Codes Table
- 9.11.5 Extended Information Data Area - DC@A07 Configuration
- 9.11.6 Next Developer Message Number - DC@A09 Configuration
-
10. Configuration
- 10.1 Work with Configuration Items
-
10.2 LANSA Communications Extensions Configuration Items (COMMS_EXTENSIONS)
- 10.2.1 LANSA Communications Definitions (COMMS_DEFINITIONS)
- 10.2.2 EIM Authorized User (COMMS_EIM_USER)
- 10.2.3 LANSA Communications Extensions Facility Tracing Records (COMMS_FACILITY_TRACE)
- 10.2.4 LANSA Communications Extensions Listener Records (COMMS_LISTENER_RECS)
- 10.2.5 LANSA Communications Routing Records(COMMS_ROUTING_RECS)
- 10.3 LANSA 3rd Party ILE Extensions
- Appendix A. Virtual Fields
- Appendix B. System Data Areas
-
Appendix C. Technical Notes
- User Defined Program/File Error Handler
- User Defined Prompt Key Message Handler
-
User Exit Programs
- If the User Exit Program uses SQL CLI
- User Exit F@BGNCMT - Start Commitment Control
- User Exit F@ENDCMT - End Commitment Control
- User Exit UEX@0001 - an Alternative RDML Command Editor
- User Exit UEX@0002 - an Alternative Help Text Editor
- User Exit LCXP9000 - User Exit for PC-Based Products
- User Exit - Export/Import Message logger
-
User Exit CIDT (Can I Do This)
-
When the CIDT user exit is called and how
- CIDT user exit for Fields, components & WAMs (object type DF)
- CIDT user exit for System Variables (object type SV)
- CIDT user exit for Multilingual Variables (object type MT)
- CIDT user exit for Files (object type FD)
- CIDT user exit for Processes (object type PD)
- CIDT user exit for Functions (object type PF)
- CIDT user exit for Templates (object type AT)
- CIDT user exit for Web Components (object type WC)
- CIDT user exit for XML Components (object type XC)
- CIDT user exit for Technology Services (object type AA)
- CIDT user exit for Weblets (object type WL)
- To validate task for import (object type blank)
-
When the CIDT user exit is called and how
-
User Exit IJDT (I Just Did This)
-
When the IJDT user exit is called and how
- IJDT user exit for Fields, components & WAMs (object type DF)
- IJDT user exit for System Variables (object type SV)
- IJDT user exit for Multilingual Variables (object type MT)
- IJDT user exit for Files (object type FD)
- IJDT user exit for Processes (object type PD)
- IJDT user exit for Functions (object type PF)
- IJDT user exit for Templates (object type AT)
- IJDT user exit for Web Components (object type WC)
- IJDT user exit for XML Components (object type XC)
- IJDT user exit for Technology Services (object type AA)
- IJDT user exit for Weblets (object type WL)
- IJDT user exit for Validating Task (object type $$)
-
When the IJDT user exit is called and how
- User Exit LANSA Security Check
- User Exit for Environment
- User Exit for SUBMIT command
- The Permanent File Overrides Facility
- The @@UPID Field in LANSA Created Files
- Commitment Control
- Using *DBOPTIMIZE / *DBOPTIMIZE_Batch
-
Trigger Functions
- What is a Trigger Function?
- Creating a Trigger Function
- Activating a Trigger Function
- Exactly When Are Triggers Invoked?
- The TRIG_OPER and TRIG_RETC Variables and TRIG_LIST Working List
- What Codes Are Passed in TRIG_OPER to the Trigger?
- How Many Entries Are Passed in the TRIG_LIST?
- What Return Codes Are Used in TRIG_RETC and How Can They Be Set?
- Triggers - A Classic Example
- Examples of how Triggers Might be Used
- Triggers - Restrictions and Limitations
- Triggers - Some Do's and Don'ts
- User Defined Reporting Attributes
- Hindi Numerics
- GUI WIMP Constructs
- ILE Implementation
- Function Routing
- Built-In Function Notes