The standard web page that provides a Inventu Viewer+ Terminal Emulation (FVTerm) session is the SCTerm.html page, which, as installed is in the FVTerm application folder. Thus, the URL would be:
http[s]://[servername][port][/FVTerm]/SCTerm.html
Note that it is quite possible that the SCTerm.html page has been copied and customized to provide additional javascript files, CSS customization and so on, the the SCTerm portion of the URL may be different depending on if a custom version has been deployed. Also, the FVTerm virtual folder may not be present if the server has been configured to make the FVTerm application the default for the server.
Starting a Session with the FVAPISession Class (FVTermSession Class for FVTermParent.js implementions)
Included in this help file is an example HTML page that uses the FVMsgApi.ConnectMsgFVTerm or ConnectFVTerm factory function to initialize an iFrame as well as run custom javascript at the point that the started FVTerm session is active.
Note that starting in September of 2023, a new version of the Javascript includes the FVTermMsgApi.js file which utilizes messaging with the child iFrame instead of direct access as utilized with the original FVTermParent.js module. As the latest versions of modern browsers no longer support the document.domain setting (without bypassing recommended security settings), it is recommended that any applications using the FVTermParent.js module transition to FVTermMsgApi.js
Starting a Session Directly
By default, when the FVTerm page is loaded, a new session is initiated and displayed to the user. This can be controlled using parameters on the URL. Parameters are triggered with the presence of the ?Application= or ?hostName= initial parameters. The Application parameter is used when a Inventu Viewer+ Enhanced User Interface application has an integrated FVTerm session. It used to be the first required parameter but starting May 17, 2017, the query string can start with ?hostName= setting. Starting late 2018, it can also start with ?view= and ?profile=.
When not part of an integrated UI application, the ?hostName should start the query string. There are a number of other query string values you can set to control how the FVTerm application starts in the iFrame. The names and usage are as follows.
Note-- all query names are case sensitive
Application |
The application name to associate with the session--this must correlate to an entry in the web.config and match an application name specified there. For enhanced UI environments |
sessionKey |
The sessionKey of an already existing session. If this option is provided, the FVTerm child frame will be activated with the existing session current screen displayed. |
profile |
If no sessionKey is provided, and the recommended profiles mode is active (introduced late 2018), the name of the profile to connect to -- this replaces the "hostName" query name. |
view |
When the recommended profiles mode is active, you can set the view that contains the profile to connect and that will be displayed after the user closes the new session being initialized. This can also set certain behaviors of the connection if your views have different settings. Default is "top". |
hostName |
If no sessionKey is provided, and profiles mode is not active, the host name to connect to can be specified. If not provided, the last host connected by the user's browser or the default host for the Inventu Viewer+ FVTerm application will be connected to. |
AutoStart |
If set to true the displayed session will autostart. Generally this is set true in most use cases, or the user will see the connection menu instead of an active session. |
keepAlive |
If set to true the started session will not be terminated when the browser or iFrame is closed or the user navigates away from the FVTerm application. Default is false. |
userID |
If a value is provided, on startup of the FVTerm session the active user will be set to this value. This is available to server-side API code as well as displayed in the Admin Console session information. |
userLoc |
If set to a string, such as an IP Address, when the connection is made, the value passed will be used as the user's location. This is useful in some UNIX/LINUX environments that use the user's IP address. |
Example--connect and start a Host1 session:
http[s]://[servername][port]/FVTerm/SCTerm.html?profile=Host1&AutoStart=true
