documentation
.HELP!
Visual LANSA Framework Documentation
Code Examples
Visual LANSA Framework
previous page
next page
Code Examples
RDML for a Windows Mini Filter
RDMLX for a WAM Mini Filter
previous page
start
next page
Menu
Homepage
Table of contents
Visual LANSA Framework Guide
Introduction
What is the Visual LANSA Framework?
What Does It Look Like?
Should You Use the Framework?
Who Is It For?
What Are Its Benefits?
What's New
Features No Longer Supported
IBM i Password Management
IBM i Password Expiry Checking
IBM i Password Expiry Checking in Windows
IBM i Password Expiry Checking in Web
Changing the IBM i Password
Changing the IBM i Password in Windows
Changing the IBM i Password in Web
Customized User/Authority Reporting
Development Status
Updated Organizations Business Object Instance List
Shipped Resources Instance List Browser Updated
New Theme 2014 Clean
Code Table Data Handlers Can Now Be LANSA Reusable Parts
Reusable Parts as Instance List Relationship Handlers
What Was New in Previous Versions
New Features in EPC 130100 version of the Framework
New Features in EPC 870 version of the Framework
New Features in EPC 868 version of the Framework
VLF.Web Runs in Internet Explorer, Firefox, Chrome and Safari
Using VLF-WEB Applications with Safari, Firefox or Chrome
Configuring Web RAMP-TS for Chrome, Safari and Firefox
aXes-TS2 Can Now Be Used in RAMP-TS
Date and Date/Time Columns
Edit Code
End-users Can Choose Instance List Columns to Be Displayed
Control Row Color in Instance Lists
Selection of Multiple Items Can Now Be Controlled in Instance Lists
Instance List Toolbar Buttons Can Have Associated Text Descriptions
Code Can Directly Access Visual Lansa Trees
Button on Framework Signon Screen Can Launch A Web Page
Web Page Can Be Shown on the VLF.WIN User Logon Screen
Demonstration System
Connecting to Servers
VLF.NET Enhancements
Commands and Command Handlers
User-Interface Enhancements
Other Enhancements
New features in EPC 839 version of the Framework
New features in EPC 831 version of the Framework
VLF.NET
Developer's Workbench
Visual Themes
Trace can be disabled for Framework Web applications
Execute the Framework in Prototype Mode Only
Improved filter and command handler snap-in facility
Improved Images palette
Specify your Framework version number
Keep old XML Framework versions organized
Set session values before connection
Selection Block Size set to 500 by default
Server connection recovery
Programmatic instance list sorting
Filters can override instance list column headings
Maximum Web Password Length is now 32
Optionally show current business object in window title
Improved Focused Input Style
Improved XP and Vista fields and buttons in web browser applications
Show or hide Instance list tool bar buttons
General Purpose Document Manager
Maximum Number of Application Views increased to 100
Quick Find Box on the tool bar
Easy access to latest Demonstration System
Enable/disable peer objects in instance lists
The tabbing order of buttons can be controlled
Control when an object can be opened in a new window
Improved start up times for DBCS Web applications
Control Web Framework start-up dimensions
Visual Ids on Web can be hidden
Programmatically shrinking and expanding panes in Windows
Test the Activated state of filters and command handlers
VLF.WEB logon improvements
New features in EPC 826 version of the Framework
New features in EPC 804 version of the Framework
Framework Windows
Favorites Folder
Command Usage tab
Navigation pane view buttons have changed
Tree view
List view
Drop-down button
Applications in tree navigation pane are shown in bold
Instance List can optionally be displayed with alternate row color
Translation of end-user visible text
New default translation tables for Framework server definitions
New UF_SYSTM IIP (Imbedded Interface Point) methods that you can override
New Virtual Clipboard Control Options
Improved Application Tracing for Relationship Handlers
New features in EPC 793 version of the Framework
You Need to Regenerate Your Web Browser and Javascript Files
The Web Browser Application Load Window has Changed
Faster Framework web start-up times including RAMP
Faster Framework Windows start-up times including RAMP
Improved Framework web application instance list performance
Improved Framework Windows instance list handling
Improved documentation for instance list processing and options
New PROGRAM_EXIT option for Framework locking
New Show in Menu when Disabled option
New method #Com_Owner.avShowMessages
The Preload Framework Images option has been removed
New features in EPC 785 version of the Framework
The Way the Demonstration System is Installed has Changed
Merge Items from One Framework to Another
If You Want Your Project to Succeed
Getting Started
Computer System Requirements
Other Requirements
Starting the Framework
Should you use Windows or Web Browser Applications?
Core Users and Occasional Users
Using a Unified Technology Does Not Mean You Can Have a Single User Interface
The Zero Deployment Advantage
Setting Up Your Framework Environment
Install the Framework on the Server
System i Apache Web Server
Step 1. Ensure that LANSA for the Web is installed and operational on your server
Step 2. Make sure that your Apache HTTP server is configured to support server side includes and optionally VLF.NET application deployment
Step 3. Ensure that Extended Exchange is enabled
Step 4. Install the Framework software
How to start the HTTP server Administration (ADMIN) facility
Windows Web Server
Step 1. Ensure that LANSA for the Web is installed and operational on your server.
Step 2. Make sure that your HTTP server is configured to support server side includes
Step 3. Install the Framework software
Install and Configure the Framework on Visual LANSA Workstation(s)
Step 1. Install the Base Visual LANSA Framework Software
Step 2. Configure the Visual LANSA Workstation(s)
Step 1. Verify use of Microsoft Internet Explorer
Step 2. Enable the Framework for Web Browser applications
Step 3. Set up your Windows webserver or your iSeries webserver
Step 4. Save your Framework details to your web server
Step 5. Test execution of your Framework in a Web Browser
The Demonstration Application
HTML Startup Page
Graphical Content
Complex Grids
Web Content
Google Maps Gadget Integration
Wizards
Data Entry
Dynamic Report Generation
Integration of desktop and folders into a VL application
Integration with Microsoft Excel
Video Content
Mini-Filters
Generic Notes Command Handler
Generic Spooled Files Command Handler
IBM i Server Message Queues
The Programming Techniques Application
Development Architecture
Usage Scenario: One Designer Multiple Developers
Usage Scenario: Multiple Designers Multiple Developers
Development Status Feature
How to Create a New Framework Version
Use Save As
Associated XML Definition Files
Optionally Change Associated XML Definition Files
Start a Framework Version
Notes For RAMP Users
How to Keep Automatic Backup Copies of Your Framework
How to Export Framework Definitions
How to Merge Items from one Framework to Another
The Merge Tool Window
Using the Merge Tool
Example of Combining Two RAMP Framework Definitions
Collecting the Definitions
Merging the Definitions
Key Concepts
Menu Options in Brackets
Application
Business Object
Filter
Instance List
Command
Command Handler
Navigation Pane
Tree view
List view
Drop-down button
Launching Applications from the Status Bar
OBJECT-ACTION User Interfaces
If you have used a PC then OBJECT-ACTION should be familiar
If you have used a 5250 then OBJECT-ACTION should be familiar
Mock Up Filters and Command Handlers
Images Palette
Tailoring the Window Layout
Standard Look
Wider Instance List
Filter to the Right
Filter in the Middle with Wider Instance List Area
Filter and Instance List at the Bottom
Application Choices to the Right
Application Choices Moved to Tool Bar
Standard Layout with Command Handler on Top
Standard Layout with Command Handler on Top, Filter And Instance List Reversed
Application Selection on Top
Application Selection at the Bottom
Floating Filters
Floating Instance Lists
Administration Objects
Users
Servers
Help and Tutorials
Building the Application
Personalize Your Framework
To Change these Settings
Framework Caption
Framework Icon
Framework splash image
The technical support URL
The Sign on Screen image
First Splash Screen
Define Your Application
Define Your Business Objects
Optionally Group Business Objects into Application Views
Prototype Your Filters
Prototype Your Commands and Their Handlers
Validate Your Design
Create Your Own Filters
Create Your Own Command Handlers
Optionally Create Your Own Instance List
Deploy the Application
Tutorials
Before You Use the Tutorials
Tutorials for Prototyping
VLF000 - Execute Framework Application
Step 1. Execute the Visual LANSA Framework
Step 2. Execute an Application
Step 3. Using Filters to Find an Employee
Step 4. Using Commands and Command Handlers
Summary
VLF001 - Defining Your HR Application
Step 1. Create a New Application
Step 2. Specify Identification Options
Step 3. Specify Startup Options
Step 4. View Commands Enabled
Step 5. Execute the About Command
Step 6. View Overall Themes
Summary
VLF002 - Defining Your Business Objects
Step 1. Decide on the Business Objects
Step 2. Create the Business Objects
Step 3. Specify Business Object Commands
Step 4. Add the Business Objects to the Application
Step 5. Specify Business Object Icons
Step 6. View the Business Objects
Summary
VLF003 - Prototyping Your Filters
Step 1. Define By Name Filter for Employees
Step 2. Prototype the Instance List
Step 3. Prototype the Filter Designs for Employees
Step 4. Filters for Statistical Reporting Business Object
Step 5. View the Filters
Summary
VLF004 - Prototyping Your Commands
Step 1. View Command Definitions
Step 2. Set Command Display for New
Step 3. Prototype the New Command Handler
Step 4. Prototype the Other Command Handlers
Step 5. Define Commands for Statistical Reporting
Step 6. Specify Command Display
Step 7. Prototype Command Handlers for Statistical Reporting
Summary
VLF005 - Validating the Prototype
Step 1. Validate Your Prototype in Windows mode
Step 2. (Optional) Setting up your Environment for Web Browser applications
Step 3. (Optional) Validate Your Prototype in Web mode
Summary
Tutorials for Windows Applications
The Personnel File
VLF006WIN - Snapping in A Real Windows Filter
Step 1. Creating Your Real By Name Filter
Step 2. Snapping In the By Name Filter
Step 3. Filter Code
Step 4. Creating a Real By Location Filter
Step 5. Snapping in the By Location Filter
Summary
VLF007WIN - Snapping in A Real Windows Command Handler
Step 1. Creating Your Real Command Handler
Step 2. Snapping in Your Command Handler
Summary
VLF009WIN - Adding Instance List Columns in Windows Applications
Step 1: Add Columns to the Instance List
Step 2: Change your filter
Step 3: Remove the Additional Columns
Summary
VLF010WIN - Creating a Mini Filter
Step 1. Create the Mini Filter Interface
Step 2. Write the Mini Filter Code
Step 3. Snap in the Mini filter and Test It
Step 4. Use the Virtual Clipboard to Save and Restore the Search Value
Summary
VLF011WIN - Creating a Parent Child Instance List
Step 1. Create Two New Business Objects
Step 2. Establish the Parent-Child Relationship
Step 3. Create a Hidden Filter for Company Departments
Step 4. Create a Relationship Handler to Load Sections
Step 5. Display Additional Columns in the Instance List
Step 6. Access the Properties of Hidden Child Objects
Summary
VLF012WIN - Controlling Navigation Using Switching and the Virtual Clipboard
Step 1. Create a Filter for Department Sections
Step 2. Create a Details Command Handler for Department Sections
Step 3. Add Logic to Switch from Sections to the Employees Business Object
Step 4. Record Switch History using the Virtual Clipboard
Step 5. Use the Switch History to Return to the Original Business Object
Summary
VLF013WIN - Signaling Events
Step 1. Change Employee Surname and Save the Changes
Step 2. Add the avSignalEvent to the Employee Details Command Handler
Step 3. Add a Routine to Listen for the EMPLOYEE_CHANGED Event
Step 4. Test Signaling
Summary
VLF014WIN - Debugging/Tracing
Step 1. Add a Trace Statement to Indicate Enter Key Was Pressed
Step 2. Add More Trace Statements
Step 3. Start Tracing Programmatically
Summary
Tutorials for WAM Web Browser Applications
The Personnel File
VLF006WAM - Snapping in A Real WAM Web Filter
Step 1. Creating Your Real WAM Filter
Step 2. Snapping In the WAM By Name Filter
Step 3. Creating a WAM By Location Filter
Step 4. Snapping in the WAM By Location Filter
Summary
VLF007WAM - Snapping in a Real WAM Web Command Handler
Step 1. Creating Your Real WAM Command Handler
Step 2. Snapping in Your WAM Command Handler
Summary
VLF009WAM - Adding Instance List Columns in WAM Applications
Step 1: Add Columns to the Instance List
Step 2: Change your filter
Step 3: Remove the Additional Columns
Summary
VLF011WAM - Creating a Parent Child Instance List
Step 1. Create Two New Business Objects
Step 2. Establish the Parent-Child Relationship
Step 3. Create a Hidden Filter for Company Departments
Step 4. Create a Relationship Handler to Load Sections
Step 5. Display Additional Columns in the Instance List
Step 6. Access the Properties of Hidden Child Objects
Summary
VLF012WAM - Controlling Navigation Using Switching and the Virtual Clipboard
Step 1. Create a Filter for Department Sections
Step 2. Create a Details Command Handler for Department Sections
Step 3. Add Logic to Switch from Sections to the Employees Business Object
Step 4. Record Switch History using the Virtual Clipboard
Step 5. Use the Switch History to Return to the Original Business Object
Summary
VLF013WAM - Signaling Events
Step 1. Change Employee Surname and Save the Changes
Step 2. Add the avSignalEvent to the Employee Details Command Handler
Step 3. Add a Routine to Listen for the EMPLOYEE_CHANGED Event
Step 4. Test Signaling
Summary
VLF014WAM - Debugging/Tracing
Step 1. Add a Trace Statement to Indicate Enter Key Was Pressed
Step 2. Add More Trace Statements
Summary
Tutorials for Deployment
VLF008WIN - Deploying the Windows Framework
Step 1. Create the Package
Step 2. Specify the Startup Form and Database Type
Step 3. Disable all Prompting
Step 4. Add Framework Components
Step 5. Add Other Framework Objects
Step 6. Add Your Own Components
Step 7. Add the Data
Step 8. Add an Icon
Step 9. Check the Package
Step 10. Build the Package
Step 11. Ship the Package
Summary
Frequently Asked Questions
Can I customise the VLF WEB signon dialog?
When I include a jQuery Weblet in a VLF Wam it doesnt look right. What is wrong?
Can I use Visual LANSA Framework in Direct-X mode?
Can I change the options that the user searches for in the Quick Find box?
Can I control what happens when the user clicks on an option that they have located by using the Quick Find box?
How to find out the L4Web images folder and path name in a VLF-WEB application?
Can I change the business object instance caption that appears in the area above my command handlers?
Can I stop VLF NET overriding CCS changes to background Colors of objects in WAMs?
How can I tell if my WAM function is executing in a browser (VLF.WEB) or under .NET (VLF.NET)?
How do I execute an initial Framework level command when starting up a Framework application?
How do I make the VLF use my corporate look?
How do I create an elaborate prototype?
Do I have to (re)define my user profiles into the Framework?
Do I have to (re)define my user passwords into the Framework?
Are there techniques to minimize user profile (re)definition?
How can I execute the VLF as a web application without using SSI?
Can I run web applications using secure sockets layer (SSL)?
How can I make my web applications launch into a new window?
How can different users access different data libraries in Web applications?
When I start the Framework as an administrator (for example UF_ADMIN), the Framework appears briefly and then disappears?
I do my unit and suite testing in Design mode. Is this a good practice?
When I run the Framework security does not seem to work?
Why options I have disabled for Windows and/or the Web browser are displayed?
How can I translate text, for example the caption of the instance list Clear List button?
How do I enroll my own visual styles?
How do I change a visual style at run time?
I have created a new command but it does not appear in the menus or the toolbar?
Can I define the toolbar by application?
I change Instance Command Presentation but the changes do not take effect?
How do I run my application in SuperServer mode?
Are copies of my Framework design kept?
I have just deleted an object but it is still visible?
I have just deleted an object and want to get it back again?
How do I change Help About logos?
How do I change introduction logos?
How do I change the logo shown when the Framework starts executing?
I have just changed my Framework design but the change has not taken effect?
How do I enrol my own bitmaps and icons?
Why are some menus and menu options in brackets?
How are Framework settings remembered?
How are instance lists remembered?
Can more than one person design the same Framework at the same time?
Where does the Images Palette get the pictures from (when using the HTML formatted Images Palette)?
When I execute my Framework in a browser some of my icons and bitmaps don't display properly?
How are icons and bitmap names used when my Framework is executed in a browser?
How can I convert icons and bitmaps to GIF files?
Where do I need to put my GIFs so that my browser applications can use them?
Can my Web browser applications be used with System i multi-tier web server configurations?
Can my Web browser applications be used with Windows multi-tier web server configurations?
How can I change the visual styles used in Web browser applications
What is a temporary directory and what is it used for?
How can I purge old information from my temporary directory?
Can I purge old information from my temporary directory in a batch job?
How can users sign off from VLF-WEB sessions?
Text appears in English when I execute Framework as a web application
I want to restore the default window layout for the Framework
How can I hide the address and status bars on Framework popup windows when using IE7?
The URL to start my deployed VLF web browser application is too complex for users to reliably type in to their browsers
What should I do when I get a mysterious WAM crash in my Framework RAMP application?
How do I pick up the servers that have been defined in the Framework using the Servers option of the Administration menu?
Why do I get a message saying 'Compression source file vf_multi_NAT.js not found'?
Why do I get a message saying 'Compression source file vf_multi_LLL.js not found'?
How can I change the list of Framework versions shown?
Framework Programming
Windows Filter and Command Handler Anatomy
WAM Filter and Command Handler Anatomy
Hidden Command Handler Anatomy
Example of a Hidden Command Handler for Windows Applications
Example of a Hidden Command Handler for Web Applications
Framework Ancestor Components
List Manager and Instance Lists
Basic Instance List Processing
Visual Identifiers
Programmatic Identifiers
Testing Identifiers
Filters and List Manager
Updating and Deleting Instance List Entries
Command Handlers and List Manager
Current/Selected Instance
Authority to Instances
More about Instance Lists
Adding Additional Columns to Instance Lists
Programming your instance list
Date/Time Additional Column Programming Example
Overriding Instance List Column Headings
Programmatically Sorting the Instance List
Changing the Color of List Entries (RowColor)
In VLF.WIN environment
Relationship Handler
Snap in Instance List
In VLF.WEB environment
WAMs
Relationship Handler
Popup Panel Hints in the Instance List
How to Use the Instance List Popup Feature
Instance Lists with Different Types of Objects
Parent-Child Relationships
Peer-to-Peer Relationships
Defining the Object Relationships
Reviewing the Instance List Relationships Holistically
Prototyping and Displaying Instance Lists
Adding Entries to the Instance List
Hiding Objects in Navigation Pane
Work with Hidden Child Objects
Changing the order of child business objects in the instance list tree
Things to Watch Out For
Application Tracing for Relationship Handlers
Sample Relationship Handler Function
Sample Relationship Reusable Part
Physical Instance Lists
Planning parent-child relationships
You can add the entries to the instance list in any order
You can dynamically add children to an instance list "on demand"
When a child is in the instance list it must have a parent
You can dynamically update individual entries in a parent-child instance list without collapsing the visual tree
You can dynamically delete individual entries in a parent-child instance list without collapsing the visual tree
You can dynamically add individual entries in a parent-child instance list without collapsing the visual tree
Instance List Tips and Techniques
Page-at-a-Time logic may indicate a conceptual problem with filters
Instance lists do not have to reflect the database that underpins them
Create Your Own Snap-in Instance List
Instance List with more than 10 alphanumeric and/or 10 numeric additional columns
Sample Filter using 34 columns (16 alpha, 16 numeric + Visual IDs)
Matching Snap in Instance List Browser
Source for Snap-in Instance List Example
Advanced Instance List Processing
Avoid Duplicated Instance List Code
Centralize all your Instance List Activities
Moving towards Real Business Object Management
Manipulate Instance Lists from RAMP Scripts
Delegate Common Tasks to your own Instance List 'Manager'
Low Level Direct Access to the Visualization Trees
Export Instance List Contents
Template Support
Getting Started
Creating Your First Report Template
Publishing Shared Templates
Modifying Report Templates
VLF.NET Excel Report Template Design Frequently Asked Questions
Can I have a running total figure in my report?
Can I include charts in my report?
Is there a way to configure a template to force all data to be retrieved first prior to generating the report?
How can I put printing date & time on the report?
How can I insert the username of the user who generates the report?
How do I keep some rows together in a page?
How can I tell a template to fit all columns in a page when generating reports?
Framework Manager
UpperCase Conversions
Numeric to Alphanumeric Conversions
Application Error Handling
How To Use It
Example
Properties Used
Framework Locking Service to Handle Unsaved Changes
Saving unsaved changes using uQueryCanDeactivate / avNotifyDeactivation
Reason Code
Comments/Warnings
The Virtual Clipboard
Remembering Information
Exchanging Information
Listening for Changes
Other Things Worth Knowing
Persistence, Resetting and Deploying in Windows Applications
Basic Tracing Service
Event Signaling Service
avSignalEvent
#Com_owner.avEvent
Object Switching Service
Introductory avSwitch Examples
Referencing Applications, Business Objects and Commands
Advanced avSwitch Examples
avSwitch Method
AvAddSwitchInstances Event
AvAddSwitchInstance Method
Troubleshooting Switch Examples
Custom Property Access Service
User Authority Access Service
Show Messages Service
Temporarily Overriding Object Captions
Get Visual LANSA Framework Icon Reference
Change a visual style at run time
Framework Windows Management
Programmatically Creating and Managing Windows
Finding a Window
Enumerating All Windows
The Current and Main Windows
Window Opening Information
Notifying other Windows of Significant Events
Keeping Windows Open
Switching in Windows
Windows and Imbedded Interface Points
Expanding, Shrinking and Focusing Panes
avPaneShrink Method
avPaneExpand Method
avPaneMaximize Method
avPaneRestore Method
avPaneFocus Method
avCmdPanelState Property
Windows Resource Usage
Usage Expectations
Resource Leakage
Advanced Filter Styles
Instant Filters
Drill Down Filters
Power Filters
Hidden Filter
Mini Filters
Properties
Events
Code Examples
RDML for a Windows Mini Filter
RDMLX for a WAM Mini Filter
Web Programming
WAM Programming
Stateless Programming
UB_xxxxx User Buttons
Maintaining State in WAM Filters and Command Handlers
Use the WAM capabilities
Use the Framework's Virtual Clipboard
Using LANSA Weblets with Framework WAMs
Rules for WAM Filters and Command Handlers
Touch Device Considerations
Tracing Web Applications
Tracing on iPads
Tracing on Android Touch Devices
VLF.NET Applications
Microsoft's .NET Framework
Deployment
VLF.NET Manual Deployment An Alternative Way of Deploying VLF.NET
Launching a VLF.NET Application
Digital Certificates
VLF.NET Form Layout Details
Visual Themes
Windows Framework Properties Applicable to VLF.NET
Framework-AJAX Applications
Mandatory Skills
AJAX Applications in the Framework
AJAX Pages and Functions
Interaction between AJAX pages and AJAX functions
Information Flow Between AJAX Pages and Functions
Things an AJAX pages must provide to the Framework
Things the Framework Provides to an AJAX page
AJAX Exercises
Exercise 1: AJAXEX1 Hello World
Exercise 2: AJAXEX2 Doing Some Simple AJAX
Exercise 3: AJAXEX3 Using Asynchronous Processing
Exercise 4: AJAXEX4 Using the Instance List
Tracing
Tracing in Your Client Side AJAX Pages
Tracing in Your Server Side AJAX Functions
Messages and Errors
Messages Issued by AJAX Functions
Handling Fatal Errors in AJAX Functions
Frequently Asked Questions
Restrictions
Recommendations
Web Configuration Assistant
Web Application Start Options
Program Coding Assistant
Step 1. Select Object
Step 2. Select the Target Platform
Step 3. Select Type of Code Review Abstracts
Step 4. Fill in Prompts
Step 5. Generate Code
Step 6. Create the Component
Code Tables
Framework Code Tables
Code Table Data Flow
Setting up a Code Table
Step 1. Create a Table
Step 2. Define a Table
Step 3. Enter data into a code table
Using a Code Table in your application
As a part of a referential integrity check
As a decode or lookup operation in your programs
Advanced options when setting up a code table
Multilingual Data
Sequencing
Choosing the description field
Creating your own table data handler function
Read Only Tables
Inactive Table Entry indicator
Creating Your Own Table Data Handler Reusable Part
Frequently asked Questions about Code Tables
Using Assistants to handle more complex "codes"
Approach 1: Single Window Multiple Assistants
Approach 2: Multiple Windows Multiple Assistants
Approach 3: Multiple Windows Multiple Assistants (some Complex)
How are Assistants started?
How do Assistants interact with other parts of the application?
Using Unicode Data with the Framework
Unicode Data in Code Tables
Unicode Data in Virtual Clipboard
Unicode Data in Tracing
End-user Help (F1)
Help Text for Windows Applications
Help Text for Web Applications
Disabling or diverting the F1=Help key in Framework applications
Designing Filter and Command Handler Layouts
Programming Tips
Component Names and Identifiers
Advanced Enter Key Handling in VL applications
Possible Technique for Handling "New" in VLF And Ramp Application Designs
Quick Find Override Feature
Setup
Advanced Topics
Using your Visual LANSA Framework in Direct-X mode
Win32
Mixed Mode
Snap In Instance Lists
Snap In command handlers and filters
Considerations for ISVs
Deploying a Framework Version
Naming Space Considerations for Managing Different Frameworks
Users, Groups and Security
Basic Framework Security
Set Up Server or Servers
Activating Basic Framework Security
Maintaining Users
Maintaining User Authorities
Maintaining User Groups
Five Things You Need to Know About Basic Framework Security
User and authority data is usually stored in files VFPPF06 and VFPPF07 on the server
Data in VFPPF06/07 controls access to Framework objects for both Web and Windows users
There are two sets of user profiles and passwords on the server
You can assign authorities to groups of users
In design mode security is not applied
Advanced Options
You can add your own extra layers of security checking
You can make the Framework validate user profiles and passwords using your own security system
You do not have to use Framework security
A user who signs on with one profile can be automatically changed to another
Two different Frameworks can share the same set of users
User and security data can be stored as an XML file instead of using files VFPPF06/07
You can store other information relating to a user
You can include the user profile and password in a start URL
Export or Import of Full or Partial User Data
How to Export User Data
How to Import User data from an XML file
Set up the Framework to Generate an XML file from an External Source of user data and import it
The rules for Creating an XML file of User Data
Writing your own version of the User Authority report
Frequently Asked Questions (Users and Security)
I do my unit and suite testing in Design mode. Is this a good practice?
When I run the Framework security does not seem to work?
Why options I have disabled for Windows and/or the Web browser are displayed?
Why does a user with my user profile get automatically created?
What are the user timeout settings used for?
Can I control which user profile appears on the status bar?
How can my RDML programs access the user profile that the user signed on as, and the user profile shown in the status bar?
How can I allow the user to change their own password?
When I start the Framework as an administrator (for example UF_ADMIN), the Framework appears briefly and then disappears?
Some Scenarios
Scenario: System i Web Server
Assumptions
Settings
Modifications to your version of UFU0001
Enroll Typical Users in the Framework
Scenario: System i Server, Users Connect with Super Server
Assumptions
Settings
Enroll Users and Groups
Scenario: Windows Server, Users Connect with Super Server
Assumptions
Settings
Enroll Users and Groups
More Information
More Details about Groups
Create Your Own Imbedded Interface Points (IIP)
More Details about being Signed on as a Different User
How to Share Users between Different Frameworks
Creating Web Interface for Maintaining Users and Authorities
Server Profile Management and Issues
Deploying Server Definitions
Scenario: In House Development, Well Known Servers
Scenario: ISV, Single Unknown Server
Scenario: ISV, Multiple Unknown Servers
Server Connection Recovery
Server Connection Recovery Settings
Attempt Automatic session recovery
Time interval between checks of connection status
Check connection before executing commands
Check connection before selecting applications and business objects
Action to take when session cannot be recovered
Check Connection using function
Programmatic server connection checking
Examples
Public Signals
Examples
Multilingual Application Issues
Imbedded Interface Points (IIPs)
What Imbedded Interface Points are Provided?
Windows
Web
Both Windows and Web
Adding your own object security validation
avCheckAuth Method
Adding your own instance level security validation
avCheckInstanceAuth Method
avCheckInstanceAuth Example
Custom Properties
Frequently Asked Questions about Custom Properties
Things to be careful with when using Custom Properties
Writing queries over Visual LANSA Framework objects
Getting Started
Using the First Query Example
Using the Second Query Example
Using the Third Query Example
Creating Your Own Queries
Other things worth knowing about Query Programs
Examples
UF_TRVRS - Signal VLF Objects
UF_QRY01 - Simple Example of How to Listen For General Framework Objects And View Their Properties
UF_QRY02 - Listening for General Framework Objects And View Their Properties
UF_QRY03 - Listening for Ramp Objects And View Their Properties
Troubleshooting
Troubleshooting Filters and Command Handlers
Framework fails as soon as you select your new Windows filter or command handler
When you recompile your Windows filter or command handler it fails with a "Permission Denied" error.
Your browser application filter or command handler behaves unexpectedly or erratically
Troubleshooting Snap-In Instance Lists
Debugging Browser Problems
Internet Explorer
Firefox, Chrome and Safari
Application Performance
Work as an End-User
Best-Case Conditions
Worst-Case Conditions
A Risk Check List
Assessing Performance in Framework Web Applications
Step 1. Use consistent and reproducible environments
Step 2. Make a Reproducible Assessment Script (ie: a RAS)
Step 3. Perform your RAS - To get a Baseline or to Test a Change
Step 4. Assessing the Average CPU per Server Interaction
Step 5. Identify and Assess any Client-side Problem Areas
Step 6. Identify and Assess any Server Side Problem Areas
Step 7. Identifying the Next Most Significant Problem Area
Using CITRIX, ISA and Windows Terminal Server Projected Desktop Technologies
Options for Very Large Frameworks
Definitions
Framework Window
Title Bar
Toolbar
Menu Bar
Popup Menu
Navigation Pane
Application Bar
Application and Business Object Tree
Business Object Bar
Application View
Filter Tab
Filter Folder
Instance List
Command Tab
Command Folder
Property Tab Sheets
Application Views
Authorities
Bitmaps and Icons
Create Links
Commands Enabled
Command Display
Custom Properties
Data
Definition
Developer Preferences Web Server
Export Design
Filters
Filter Snap-in Settings
Filter Settings
Framework Details
Help About
Icons
Identification
Instance List/Relations
Istance List Relationships Summary
Other Options
Server Details
Startup
Subtypes
Toolbar and Menus
Usage
User Administration Settings
User Details
Visual Styles
Visualization
Web/RAMP Details
Dialogs
Update Server from Visual LANSA Workstation
Current Framework Design Details
RAD-PAD Notes
Shipped System and Demonstration Objects
All available Images (GIFs)
Execute Framework as a Web Application
Choose Browser
Start
RAMP Application Testing
Turn Tracing On
In Language
URL
Touch Device
Properties
Add Fields from this Physical File
Additional Columns for Building AColumn and NColumn Values
Address for Error Notification
Administrative User
Advise User With a Message
AJAX Page (HTML File)
Alignment of Image on Form
Allow Dynamic Overriding of Default Application Texts
Allow Generic Searching
Allow Float
Allow IBM i password change
Allow in Windows
Allow Instance List to be sent to MS-Excel
Allow Multiple Selection
Allow Multiple Selections
Allow on Web
Allow Panes to be Shrunk and Expanded
Allow Search/Recently Used Limit
Allow Selection from Navigation Pane
Allow Side by Side Display
Allow this Object to be Opened in a New Window
Allow User to Clear Instance List
Allow Users to Switch Views
Alter Development Status
As the Default Command
ASCII Translation Table Name and Library
Associated AJAX Function
Automatic Save Time in Minutes
Automatically Enable for New Applications
Automatically Enable for New Business Objects
Automatically Enable for New Business Object Instances
Automatically Increment when Saving
Bitmap
Blank Lines Around Comments
Business Object Command
Business Object List
Bypass Locks
Caption
Caption (Singular)
Caption with Accelerator
Certificate File (PFX)
Certificate File Password
Change Password IIP
Check Password Expiry
Check Still Connected Before Doing Database IO
Client CCSID
Client Server Translation Table
Close Confirmation Message
Codebase
Code Table Data
Code Table Definition/ Reusable Part Data Handler (ID)
Code Table Definition/ Use a Reusable Part
Code Table Field Definitions
Columns for Instance Lists
Command Tab Location
Command Tab Show All
Command Tab Style
Commitment Control
Compile Framework as Microsoft .NET 2.0 Executable
Component Identifier
Contains Favorites
Contains SHARED Object
Copyright Notice to Be Used
Copyright Text
Create Component
Database Name
Database Password
Database Type
Database User
DBCS Capable
Default Command
Default Font when Printing a Report Using Windows
Default Properties for Fields on Filter Panels
Default Properties for Fields on Handler Panels
Defined In
Displayed Field
Development Status Captions
Developer Preferences XML File
Divert Locks
Double Click for Default Command
Do you want to use a mapped drive when uploading to the websever?
Drag and Drop the Fields
EBCDIC Translation Table Name and Library
Edit Panel
Email Address
Email Zip File To
Enable Child when Parent Selected
Enable Clear List Button
Enable Command
Enable Development Status Feature
Enable Framework for AJAX style applications
Enable Framework for WAMS
Enable Framework for Web browser Applications
Enable Framework for WEBEVENT Functions
Enable Parent when Child Selected
Enable Peers when Selected
Enable Popup Panels
Enable the Position Menu Option
Encrypt XML Files
End User can change theme
End-users Must Sign on to this Framework
Engine
Execute as Hidden Command
Execution Priority
Execution Mode Load Path
Export Developer Preferences
Export Tables
Export Framework Design
Export Include All Versions
Export Images Palette
Export RAMP Definitions
Export RAD-PAD Notes
Export RAD-PAD Defaults
Export Servers
Export Users
Field Prefix to be Used
Fields That You Want to Appear in a List at The Bottom of Your Handler
Fields That You Want to Appear on the Top of Your Command Handler
File Prefix to be used for MS-Excel (Business object properties, Instance List tab)
Filter Tab Location
Filter Tab Style
First Time Only
Fixed / Default Values
Focused Input Field Style
Framework Fatal Error
Function Handling Table Data storage
Generate Web Pages
Groups this user belongs to
Height
Help Text
Hide All Other Command Tabs
Hint
Host Name or IP Address
IBM i Host Server Mapper Name / IP address
IBM i Host Server Mapper Port
Icon
Icon and Bitmap Enroller
IIP - User Signon Function Name
IIP Function to return web user authorities
Import Users Imbedded Interface Point
Image File
Image / Web Page to Display on Form
Images Folder
Import Users from XML
Inactive Table Entry indicator
Include Default Save Button and Logic
Include Default Search Button
Include Layout Managed Button and Field Areas
Include uInitalize Routine in Command Handler
Include uInitialize Routine in Filter
Include uTerminate Routine in Command Handler
Include uTerminate Routine in Filter
Input Method
Instance Command
Instance Command Presentation
Instance List Relationship Summary
Instance List Tool Bar Location
Instance List Tool Bar Height or Width
Instance List Tool Bar Text Location
Internal Identifier
IP Address
IP Address and Port Number
Intro Caption
Intro URL
Keep newlook SID File Versions
Keep Versions in Subfolders
Keep XML File Versions
Keys of the View
Keys from the Instance List
Language Field
Languages
LANSA Language Code
Last Changed
Launch Button Caption
Launch from Status Bar
Launch URL (Windows)
Launch URL (Web / .Net)
List Panel
Load Path
Location for Buttons
Log off Inactivity Timeout
Log on Inactivity Timeout
Major Comment Separator
Marker for Code Requiring Manual Completion
Maximum Decimals
Maximum Entries in List
Maximum Length
Maximum Signon Attempts Allowed
Maximum Web Password Length
Meta Tag
Minor Comment Separator
Mock Up RAD-PAD
MTXT String Loader
Multiline Tab Sheet Captions
Multiple Window Control Bar Location
Name
Name of User Set to be Used
.NET Component Class Name and Assembly
.NET Target Platform
Nodes XML File
Number of Additional Windows a User can have Open Concurrently
Object Command Presentation
Open Latest Demonstration System
Optional Arguments
Optional Mapped Drives - Images Folder and Private Working Folder
Overall Theme
Own Window Size
Partition
Partition is Enabled for RDMLX
New Password
Physical File from which the Child Data Comes From
Popup Panel Name
Port Number
Preferred web scheme/skin
Private Definition/aXes Project Folder
Private Working Folder
Programmatic Identifiers for Building AKey and NKey Values
Property Type
Prototype Only
RAD-PAD File Name
RAD-PAD File Format
RAMP Destinations
RAMP Javascript Charset
RAMP Password
RAMP Tools Mode Load Path
RAMP User
Read Only
Referenced .NET Assemblies
Remember Key Values between Filter Executions
Relationship Handler
Relationship Type
Report on Users - Imbedded Interface Point (Id)
Restricted Access
Routine to listen for signals to update the instance list
Save and Restore Instance Lists
Save as Deployment Server
Script for Uploading to your LANSA for the Web Folders
Search Field Width
Select the Keys of the Selected View to be used for Search Operations
Select the View to Be Used For Filtering and Searching Operations
Selection Block Size
Selection Limit
Sequence
Sequence Using
Server Client Translation Table
Server IIP function to validate sign on
Server Name
Server Overrides
Server Settings XML File
Server Type
Shortcut
Show Additional Columns
Show Current Business Object in Window Title
Show in Help About Text
Show in Menu
Show When Disabled
Show on Instance List Tool Bar
Show On Popup Menus
Show on Toolbar
Show the 'Windows' Menu in this Framework
Show on Connect Dialog
Show When Disabled
Snap in Instance List Browser ID
Specify the Underlying Physical File that Will Be Searched by this Filter
Options
Stay Active
Stay Active Default for Command Handlers and Filters
Store Users in XML File and Store users in DBMS Tables VFPPF06/07
SubTypes
System Info
Table Definitions XML File
Technical Support
Temporary Directory on PC
Temporary Folder Name
The location of the images directory on the server
The physical file that most closely resembles this business object is
The type of server
The webservers images path
Timeout to use for developers
Toolbar Button Caption
Toolbar Button Width
Toolbar Group
Tool Bar Height
Tool Bar Style
Trim Working Set
Type of Layout Style to be Used
Unique Identifier
Update File
Uppercase
Upper and Lower Case Password
URL
Use a Grid for Displaying Any List
Use HTTPS
Use INI file
Use Framework Users and Authority
Use liteclient license
Use a Reusable Part
Use Shared Instance List for Relationships
Use a Webevent/WAM for Help
Use Windows Credentials
User Authorities Report File
User Can Change Own Password
User Imbedded Interface Point
User Is Disabled
User Must Specify all Chosen Keys
Users May Work Offline if the Remote Server Is Not Available
User Object Name/Type
User Profile
Users Sign on Locally to Use the Framework
Users Sign on to a Remote Server to Use the Framework
Value(s) can be changed by Administrator
Warn before (days)
*WEBEVENT Function and/or WAM Component or AJAX Routine
Web Help Function/Webroutine Name
Web Help Process/WAM Name
Web Help Window Features
Web Initial Filter Pane height (%)
Web Initial Filter Pane width (% of right panel)
Web Initial Navigation Pane width (%)
Web Server Caption
Web Server IP Address
Web Server Port
Width
View as Drop Down on Toolbar
View as A Single Tree
View as Two Lists Side By Side
View as Two Lists Over and Under
View Used to Read the Child Data
Windows Code Page
Visual Identifiers for Building VisualID1 and VisualID2 Values
Visual Style Base Style
Visual Style Protected Fields and Areas
Visual Style Dark Background Small Font
Visual Style Dark Background Large Font
Visual Style Status Bar Fields
Visual Style URLs
VLF.NET Screen Layout Persistence Level
Your Framework Version Number
Appendix
What is Included in the Framework?
LANSA Repository Objects
Demonstration Repository Objects
User Repository Objects
Framework Repository Objects
Operating System Objects
Permanent File Objects
Temporary or Semi-Persistent Files
Things You Should Back Up
Get in touch
Submit feedback about this site to:
[email protected]