Working with Model Variable Lists
When you build a model in the Host Integrator Design Tool, you can create model
variables, which are placeholders for data. Situations where model variables
are useful include:
- The same model variable value needs to be used for all sessions in a session
- Host user IDs and passwords must be provided for all sessions in a session
pool, rather than being provided by the user.
You can accomplish these tasks by configuring your session
pools to provide values for the model variables in the models in your session
pools. To use a single value for all sessions in a pool, configure an individual
model variable. If you need to provide a unique model variable value for
each session in the pool, create a model variable list that contains a set of
values for the model variables in the model on which your session pool is based.
Note: When the data object
provides a value for a model variable, it overrides any model variable values
that have been assigned in the Administrative WebStation.
For more information about creating model variables in the Design Tool, search
for "Model variable" in the Design Tool online help.
A typical use of a model variable list is to store host user IDs and passwords
to be used by the data object. It is often necessary to create a pool of host
user IDs and passwords for your client applications to use. In this case, you
would create a model variable list that would assign a host user ID and password
for each client session.
Keep the following restrictions in mind as you create and configure model variable
- A session pool can use more than one model variable list, but a variable
cannot appear in more than one list being used by the same session pool.
- The model on which the session pool is based must contain all the variables
specified in the variable list.
- A session pool's total session count cannot exceed the number of entries
in the model variable list(s) it uses.
Creating and Configuring Model Variable Lists
To create and configure a model variable list, you can use the Administrative WebStation or define it during deployment with deployment descriptors. It is recommended that you choose one of these options and continue to use the same option for other updates; changes performed on the Administrative WebStation will be overwritten when you use a deployment descriptor file.
- Log on to the Administrative WebStation using an Administrator
profile and switch to configure
- In the Administrative WebStation navigation tree, click Host Integrator
Servers, and then click the name of the server on which you want to create
the model variable list.
- In the navigation tree under the server name, click Server Configuration,
and then click Host Parameters. Under Host Parameters, click Model Variable
- Above the navigation tree, click Add. An entry is added to the navigation
tree for the model variable list, and the default model variable list name
(VariableListName) is displayed in the panel. To change the name, type the
new name in the panel, and then click Submit.
At this point, a model variable list has been created. This list can be used
by all session pools on the server. To complete the process, follow the steps
below to create list entries in your model variable list:
- In the navigation tree, click the name of the model variable list you just
created, and then click List Entries.
- A default model variable list is displayed in the panel that contains space
for one variable name and one variable value. In the VariableName box, enter
the name of the variable, for example, userID.
The variable name you enter here must be a variable configured in the model
on which the session pool that will use this model variable list is based.
- In the VariableValue space, enter a value for this variable, for example
User1. Click Submit.
- To add an additional value for this variable, click Add Entry and enter
the next value for this variable. Repeat this process for each value for this
- To add an additional variable to this list, click Add Variable, and then
enter the name of the variable. When you add a variable, a default variable
value is displayed. To change this value, select it and then enter the new
value. Click Submit.
- In the navigation tree under the name or your variable list, click List
- At least one variable in the list should contain unique values. Otherwise,
you should just create individual model variables. In the List Properties
table, select the Must be unique on host check box for the variables
that will have unique values. Doing so will prevent duplicate values being
added to the list for this variable.
- To hide the value for a variable when the console is in view
mode, select the Do not show this variable's value check box. These
variables are encrypted. This corresponds to Encrypt value in the Design
Note: the variable value will continue to be displayed when the console
is in configuration mode.
- Click Submit or Save.
Now that you've created a model variable list, configure one or more session
pools to use it. To do this:
- In the navigation tree, click Session Pools, and then click the name of
the session pool that you want to configure.
- In the navigation tree under the session pool name, click Model Variable
- A list of model variable lists is displayed in the panel. Select one or
more lists, and then click Submit or Save.
Note: To select more than one list,
hold down the [Ctrl] key and click the name of each list you want to select.
To deselect an already selected list, hold down the [Ctrl] key and click the
highlighted name of each list you want to deselect. You cannot deselect lists
by clicking outside the list of Model Variable Lists.
Session pools are based on models. When you create a model variable list, you
must provide variable names that are valid for the model on which the session
pool that will be using this model variable list is based.
If you do not know that correct name for a variable, follow these steps:
- Switch the Administrative WebStation to configure
- In the navigation tree, click the name of the session
- Under the Session Pool name, click Model Variables. If at least one model
variable has been configured in this session pool, the Model Variables column
contains a list of model variables for the model on which the session pool
is based. To view all model variables, open the list.
- If no model variables have been configured in this session pool, click Add
Variable to display a list of model variables.