Web Application Start Options
Applies to WAM and .NET.
When you start a Web browser Framework application you can optionally add details to the URL that impact the way that your application executes.
Typically starting URLs are formatted like this example:
http://nnn.nn.nn.nn/...../vf_Sy001_System_ENG_BASE.htm
Optionally you can add parameters to the URL formatted like this:
http://nnn.nn.nn.nn/...../vf_Sy001_System_ENG_BASE.htm?Parm=value+Parm=value+ ..... +Parm=value
where the allowable parm and values are:
| Parm | Comments |
|
Partition=xxx |
Specify the partition that the Framework is to connect to. VLF.WEB applications default this parameter to the partition that the Framework was saved from. VLF.NET applications default this parameter to DEM, so you should always specify this parameter. |
|
Trace=XXXX |
Specify the trace mode as Y or TRUE for a user level trace. Specify trace mode SYSTEM for a deeper system level trace. Note: In RAMP-TS sessions automatic error trapping is suppressed when TRACE mode has been turned on. This may allow script and HTML errors to be more easily isolated and debugged. |
|
User=xxxx |
Specify the user that the Framework is to use when connecting to the system. This value defines what user profile value prefills any log on dialog required by the Framework. If User= and Password= are both specified then the any log on dialog will be bypassed and the values passed directly to the server. Security considerations may apply to the viability of specifying user and password details on URLs. |
|
Developer=Y or Developer=True
|
Indicates that the current user is a developer. Additional error handling and checking will be activated to aid the development process. Do NOT use this option in applications deployed to end-users or while performing performance testing.
|
|
Password=xxxx |
Specify the password that the Framework is to use when connecting to the system. This value defines what password value prefills any log on dialog required by the Framework. If User= and Password= are both specified then the any log on dialog will be bypassed and the values passed directly to the server. If no password is required specify Password=none. Security considerations may apply to the viability of specifying user and password details on URLs. |
|
SwitchTo=xxxx SwitchObject=xxxxx SwitchCommand=xxxxxxx |
SwitchTo=, SwitchObject= and SwitchCommand= values may be specified to cause a Framework Switch instruction to be executed immediately that the Framework commences execution. Switching to an instance level command associated with a business object is not possible because the user must manually select an instance first. |
|
URLDATA1= xxxxx through URLDATA5=xxxxx |
Specify up to five user data values that need to be passed into the application from the starting URL. The values specified in these parameters can be accessed by shipped User Imbedded Interface Point (IIP) UFU0001 (or equivalent) as fields #URLDATA1 through #URLDATA5. Executing WAM filters or command handlers can access these values by getting properties #Com_Owner.avURLData1 through #Com_Owner.avURLData5. These values may be specified in encoded URI format if required (eg: to handle imbedded blanks, etc). |
|
Stats=Y |
Specify the stats mode as Y to cause a basic statistics window to be displayed and updated while the application is executing. See following note 1 for details. |
|
WAMHelp=Y |
Activates end-user help for fields on WAMs. |
|
TSUser=xxxxxxxx NLUser=xxxxxxxx
|
The overriding user profile that should be used in RAMP-TS or RAMP-NL applications when attempting to connect to the 5250 server. Note that RAMP-NL does not support the use of user profiles containing the "@" (at) symbol. See Note 2 following for user profile default rules. |
|
TSPassword=xxxxxxxxxx NLPassword=xxxxxxxxxx
|
The overriding password that should be used in RAMP-TS or RAMP-NL applications when attempting to connect to the 5250 server. See Note 2 following for password default rules. |
|
NLHostName=xxxxxxxxx |
The symbolic host or connection name that newlook should use in RAMP applications when attempting to connect to the 5250 server. This symbolic name must be defined to newlook as a connection. The default is blank. If you use the NLHostName parameter you should not specify an NLIPAddress or NLPortNumber parameter value. |
|
NLIPAddress |
The IP address that newlook should use in RAMP applications when attempting to connect to the 5250 server. The default is the host name from which the Framework start page was started. If you use the NLIPAddress parameter you should not specify an NLHostName parameter value. |
|
NLPortNumber |
The IP port number that newlook should use in RAMP applications when attempting to connect to the 5250 server. The default is 23. If you use an NLPortNumber parameter you should also specify an NLIPAddress value. If you use the NLPortNumber parameter you should not specify an NLHostName parameter value. |
|
NLLiteClient
|
Indicates whether newlook should use a liteclient license when it is started, regardless of any default value determined when the Framework was generated. Allowable positive values are NLLiteClient=Y or NLLiteClient=TRUE. Any other value will be taken as negative (ie: false).
|
|
NLIniFile |
Specify Name of the newlook .INI file to use with your RAMP application. This value will override the one specified in the Server definition. |
|
NLUpdateFile |
Specify Name of the nlupdate.txt file to use with your RAMP application. This value will override the one specified in the Server definition. |
|
NLCodeBase |
Specify Name of the newlook.cab file to use with your RAMP application. This value will override the one specified in the Server definition. |
|
DEBUG=Y,<<host IP>>:<<port>>
|
Allows WAM command handlers and filters to be debugged remotely. The <<host IP>> is the ip of the computer where the Visual LANSA development environment (IDE) is running. On LANSA systems earlier than SP5 + EPC830, the <<port>> is the port used by the listener (see the Communications Administrator for the port used by your listener). An example of using remote debug for WAMS on your own PC would be to add: +DEBUG=Y,127.0.0.1:4545 to the URL
On LANSA systems where EPC830 has been applied and later systems, LANSA has a separate service for debugging The <<port>> for this service can be found in the IDE, under Options, Settings, Debug. It is often port 51234. An example of using remote debugging for WAMS on your own PC would be to add: +DEBUG=Y,127.0.0.1:51234 to the URL
|
|
Theme=XXXX
|
Used in .NET applications only. Ignored in other applications. Specifies the color and style theme to be used in the executing application. If not specified, the theme specified in the Framework definition by the application designer is used. Allowable values are 2007BLUE, 2007SILVER, 2007GRAPHITE and 2007OLIVE. |
|
NETURL |
When a VLF.NET application is started, the NETURL=value indicates the place from which VLF related HTML pages and JavaScript files should be loaded. For a VLF developer this is most typically their private folder, for example NetURL=http://MYHOST/images/MyPrivateFolder/ In a production application this is most typically the LANSA for web images folder, for example http://MYSERVER/Images/ |
|
TSPrivateSet= |
Specifies the Private Definition/aXes Project Folder that any RAMP-TS session started should use. When used, specify just the private definition/aXes folder name, not the complete path name. The path to the folder is implicit. If not specified, the private definition/aXes folder used will default to the value associated with the RAMP-TS server flagged as the “deployment server” at the time the framework was last saved. |
|
TSPrivateShared= |
This property corresponds to the Contains SHARED Object option in a RAMP-TS server definition which allows you to have the SHARED object in your own private definition/aXes folder. Allowable values are True and False. If you use TSPRIVATESHARED=TRUE and the file is not found you will get an error. |
|
TSLoadPath= |
Specifies the load path that any RAMP-TS session started should use. If not specified, the load path used will default to the value associated with the RAMP-TS server flagged as the “deployment server” at the time the framework was last saved. |
|
TSIPAddress= |
Specifies the IP address that any RAMP-TS session started should use. If not specified, the IP address will default to IP address of the VLF-WEB session. Typically TSIPADDDRESS and TSPORTNUMBER are used together. The VLF-WEB session and the RAMP-TS session must be in the same domain. The RAMP-TS server’s IP address needs to be defined as a trusted server. |
|
TSPortNumber= |
Specifies the port number any RAMP-TS session started should use. If not specified, the port number used will default to the value associated with the RAMP-TS server flagged as the “deployment server” at the time the framework was last saved. Typically TSIPADDDRESS and TSPORTNUMBER are used together. |
|
TSUSEHTTP= |
TSUSEHTTPS=Y is for RAMP-TS only. It indicates that aXes should be loaded using https:\\ as the protocol. If used, the VLF-WEB (LANSA for the Web) application must also use https:\\. Additionally both aXes and LANSA for the web must load from the same domain (that is literally from the exactly the same name on the URL). |
|
TOUCH=Y
|
Enables and disables Framework functionality to make it more touch friendly. For an overview please refer to Touch Device Considerations. If the TOUCH parameter is not present in the URL the VLF will guess whether it's running on such device.
|
|
ZOOM=
|
The CSS zoom to apply to the VLF. The default zoom value is 1.4.
|
|
CHKPSWEXPIRY = Y CHKPSWEXPIRY = Yes |
Set to Y to compare the expiry date of the password typed in during WEB sign on with the current date. If the difference is less than the value specified in ISSUEWARNING, a warning message is issued. Refer to the shipped Web IIP for User signon function UFU0001 in process UF_SYSBR. |
|
ISSUEWARNING = nnn |
Specifies how many days before the password expiry date a message will be issued during Web signon to warn that the password is about to expire. Refer to the shipped Web IIP for User signon function UFU0001 in process UF_SYSBR. |
|
ALLOWPSWCHG = Y ALLOWPSWCHG = Yes |
When this parameter is set to Yes, the end-user can change the IBM i password. The signon dialog will contain fields in which to enter the old and the new password, and a Change button. Refer to the shipped Change Password IIP function UFU0006 in process UF_SYSBR. |
|
IBMISERVER |
Name or IP address of the IBM i Server Mapper for password expiry and password change. |
|
IBMIPORT |
Port of the server specified in IBMISERVER. |
Note 1: Using Stats=Y
Using Stats=Y causes a basic statistics window to be displayed and updated while the application is executing.
The details shown reflect elapsed times as measured by the client system.
SERVER-SIDE: This is the time between when the web form was submitted to the server and when it arrived back at the client system, therefore it includes the server side processing time and all send and receive communication delays.
CLIENT-SIDE: This is the time between when the web form arrived at the client and when all client side processing of it was completed (excluding any additional time taken by the browser to draw the web form).
OVERALL: This is the time between when the web form was submitted to the server when all client side processing of it was completed (excluding any additional time taken by the browser to draw the web form). OVERALL is approximately equal to SERVER-SIDE + CLIENT-SIDE.
In very broad terms these statistics can be used to identify problem areas in your application such as:
High SERVER-SIDE values may indicate that:
- Your filter or command handler may be too complex and taking too long to execute on the server.
- The communications delay between your client system and your web server is too long.
High CLIENT-SIDE values may indicate that:
- Your filter or command handler is causing the client side to do too much processing. A cause of this may be the overloading of the client side by browse lists with too many entries in them or by client systems with slow or busy CPUs.
Note 2: RAMP-TS and RAMP-NL User Profile and Password defaulting
The user profile and password used by RAMP-TS or RAMP-NL when attempting to connect to a 5250 server are defaulted as follows:
- If your Framework is using Framework security and the user needs to log on, the user profile and password they use to log on become the initial default values.
- For RAMP-NL only, the user profile that the user logs on to the framework as may have a specific RAMP-NL user profile or password associated with it. These values, if present, will override the initial defaults.
- Any user (TSUSER/NLUSER) or password (NLPASSWORD/TSPASSWORD) parameters specified on the start up URL will override any of the preceding default values.
- Finally, a user profile and password may be returned by the system logon validation program. These values will completely override any other default or deduced user or password values.
Tip: If you are having problems with RAMP user profiles or passwords then try executing your application with TRACE=Y to see the values that are being used.