Skip to content

Using the Design Tool to Deploy a Model

To use the Design Tool to deploy a model, select a deployment option: Deploy to the Local Server or Deploy to Remote Server. The Deploy to Remote Server option deploys the model to any designated remote server.

Web services are automatically provided by the session server as an embedded SOAP stack or REST service after a model package is deployed with the WSDL and metadata generated at deployment, for more information view Deploy Web Services.


If your integration solution includes a Web application created with Verastream's Web Builder, you must also deploy the Web application files. See Deploying a Verastream Web Application for more information.

Select Deployment Options

The Deploy to Local Server or Deploy to Remote Server commands on the Design Tool's File menu, deploy the model using the default host name and port number, with no session pool.


The Deploy to Remote Server option provides the ability to use another Host Integrator server besides the one included with the Design Tool. This option is limited to the same basic settings as the local server deployment; it does not include all the options available when deploying to a non-local server using the packagemodel and activatemodel commands.

To modify these defaults or to use a session pool, set deployment options:

  1. On the File menu, select Deployment Options.
  2. The Host tab of the Deployment Options dialog box displays the host name and port number that the server connects to when the model is loaded. If you don't use the Deployment Options dialog box, the Deploy to Local Server command deploys the model using the default host name and port number, and without a session pool. Use the edit boxes on the Host tab, to change these to whatever is required for your server.
    • The Sessions connect to host defined by model will use the settings in the Session Settings dialog box.
    • To use host settings other than those specified in the Sessions Settings dialog box, click Sessions connect to specified host and type in a host name and port number.
  3. Click the Sessions tab. To deploy the model without using a session pool, select Deploy as a single session and skip to step 7 below.

    If your model uses a session pool, select Deploy as a session pool and provide the session pool name, the startup entity name, and the minimum and maximum numbers of sessions.

  4. Open the Variables tab. If the default variable values stored in the model are suitable for all pooled sessions, clear the Provide variable values for pool check box and proceed to the last step. Otherwise, check the Provide variable values for pool check box and proceed to the next step.

  5. The names of the variables defined in the model appear in the Variable column of the Variable names table.

    • Select Include for each variable which must have a non-default value.
    • Select Unique for each variable which must have a different value for every session in the pool. (At least one variable must be marked unique.)
    • Select Hidden for variable values that must be encrypted in the deployment and server configuration files. This check box is checked by default for variables marked as "hidden" in the model.
    • Use the Variable values table to assign values to your variables.

    The table will contain a row for each session. The number of rows is equal to the maximum session pool size. The Session (leftmost) column numbers the sessions in the pool. Additional columns, each labeled with an "included" variable name, appear to the right. Enter a value for each variable name in each session.

  6. The Recording tab controls model debug options. The default, Record Nothing, is appropriate for most cases. Change these settings if you want to take advantage of the Model Debug Messages feature. Click OK.

Resetting deployment options

Click the Defaults button to reset the model's deployment options back to the default settings.

View deployed model in Administrative Console

In the Administrative Console you can verify that the model, pool, and model variable lists have successfully deployed.

  1. Open the Administrative Console and, if necessary, connect to your management server.
  2. Open the Session Server Explorer. (Perspective > Host Integrator > Session Servers)
  3. In the left pane, open Installation > Servers > [your server name]. Double-click on the Models, Model Variable Lists, or Pools items to view the configuration tab in the right pane, associated with each. You can right-click on an item and choose Properties to view the specific properties for each model, model variable list, or pool.


Because any changes that you may make to model or session pool configurations (except pool scheduling) in the Administrative Console are overwritten by subsequent deployments from the Design Tool or by the activatemodel command, it is best to make those changes in the Design Tool.