Configuring vsrvtcp

Configuring the vsrvtcp.ini for Individual User Profiles

This SECTION is still under development.

The vsrvtcp.ini file contains the user profile definitions for your Visimage3 users. Many CUs create two or three profiles for their users to share: one each for live, eom and test. Others prefer to setup individual (password protected) profiles for their users. These CUs generally enforce password aging as well.

This article describes the recommended way to setup your vsrvtcp.ini file to support individual profiles for all users. The layout described here requires vsrvtcp version 4.9.2.x or higher.

A discussion of the different sections of a sample INI file follows. At the bottom of the page, the INI file is repeated in its entirety to allow you to copy/paste all of the sections.

User Profiles

The individual username sections do not require very much information:

• The username appears between [...]
• Include "Admin=Y" for administrator users.
• All users get the "profile=spec_$VSVAR1" which is explained in more detail below.
• Include a password.

[john.doe]
  profile=spec_$VSVAR1
  password=GrantMeAccess!

[jane.doe]
  Admin=y
  profile=spec_$VSVAR1
  password=Iamyouradmin!

1. We have chosen to use the convention "first.last" for our user names. Choose a convention that makes sense for your organization.
2. Because Jane is an Admin user, she can create & delete other Visimage3 users and reset their passwords. This video gives more information on the Visimage3 Admin menu.
3. The "password" key is the unencrypted password. Use this key when editing the vsrvtcp.ini file. When the password is changed from Visimage3, the encrypted password will be stored in the v_password key.

Connection Setup in Visimage3

When a user creates a connection in Visimage3, the "Host Profile Name" they specify is their username followed by "!live", "!eom" or "!test". If the "!xxxx" is omitted, the connection will fail. The text that follows the first ! char is stored in VSVAR1, thus when a user connects using "username!live" the variable $VSVAR1 is set to the value live. This means that the "profile=spec_$VAVAR1" will be evaluated as "spec_live". This simple "switch" allows a user to connect to live, eom or test data all from a single user profile.

The LIVE, EOM and TEST profiles

In the spec_live, spec_eom and spec_test profiles shown below, variables are set which are later by the spec_common profile. The use of variables (and shared profiles) minimizes the INI file complexity because the same information does not have to be repeated.

[spec_live]
  filogin=bolive
  finame=LIVE
  profile=spec_common

[spec_eom]
  filogin=bolive
  finame=LIVE
  profile=spec_common

[spec_test]
  filogin=botest
  finame=TEST
  profile=spec_common

[spec_common]
  login=$filogin
  directory=/var/summit/spectrum/$finame/FI/VISIMAGE
  temp=./temp
  batchdir=$SPX_HOME/FI/VISIMAGE
  EQ_DBSERVER=localhost:eloq-$finame
  vmgr=/ASKPLUS/visimage/vmgr_$VSVAR1
  profile=default_settings
  profile=askplus

=== Other Default Settings ===

[default_settings]
  ASKCHAR=ROM8
  IEEE=1
  ASKODX=1
  ASKJOINS=1
  VMGRLIST=1
  DBCLOSEMODE2=1
  ASK_OLDDATE=1
  HPSPLITYEAR=50
  ASKERR=1
  GAUGE=1
  CISAM=Y
  DISABLE_STREAM_CMD=Y
  ALLOW_EDIT_HOST_FILE=N

=== The AskPlus Profile ===

[askplus]
  askplus=/usr/bin/nice -20 /ASKPLUS/askplus $VSVAR3

VSVAR Variables

There are three VSVAR variables that are available using the syntax discussed above. If a user connects with "username!one!two!three", then VSVAR1=one, VSVAR2=two and VSVAR3=three. Not all variables need to be used. For example, using the INI file above, a connection with "username!live!!e852" will connect to the summit_live profile and execute AskPlus version E.8.5.2 (see Note 9).

Notes:

1. Indicates that Jane is an Admin user.
2. When Jane connects using "jane.doe!live" the variable $VSVAR1 will have the value live and therefore the profile used will be "summit_live". This simple "switch" allows Jane to connect to live, eom or test data all from a single user profile.
3. When Jane changes her password, the new password will be stored encrypted in the INI file.
4. The variable filogin is used to specify which UNIX login will be used for the connection. The connection is the same for live and eom, but usually different for test. The actual login is used in the summit_common profile using the statement "login=$filogin"
5. The variable fipath is used later in the summit_common profile to configure the default directory.
6. The EQ_DBSERVER will need to be different as well. Here we just use a different value, but possible we could have used the fipath variable depending on the valid values for EQ_DBSERVER. You can also reference a filename that contains the username and password to use for the database connection.
7. The summit_common profile contains all of the shared connection information and uses pre-defined variables where needed to customize the connection. Notice the use of $VSVAR1 again in the vmgr statement.
8. Introduced in AskPlus E.8.5.4 batchdir is a new variable that overrides the directory setting when AskPlus is launched in batch using "username!live".
9. The default_settings profile contains general AskPlus settings. These are typically saved in a separate profile, but that is not required.
10. Notice the $VSVAR3 variable on the AskPlus run line. As noted previously, this allows a user to start server requesting a specific version of AskPlus.