Agent and Marshaller Options dialog

This dialog is used to configure the local computer as a local agent, remote computers as local agents, or remote computers as connected agents.

To make use of agents other than the local agent, one agent must be configured to act as the coordinator, and all agents (both local and remote), must be configured to connect to the coordinator. It is also necessary to have a coordinator if you wish to make use of the remote results root to share results amongst users.

It is possible to make local and remote configuration changes from the current computer (using this dialog) or from the remote computers concerned.

The dialog is displayed when you click the Manage button ( Manage... local or Manage... coordinator ) in the Run Control Window.

Show image

WSMarshaller Connection: Connected to [local/remote ]

This area initially shows the two connection possibilities (local or remote) and the associated types of connection (pipe and TCP/IP). Note that the area label changes to indicate the current connection. Show dialog properties

Local - Pipe

This is the default. With this option selected, simulations will run either locally on the current computer or, with further configuration, on other computers that are agents of this one.

Remote - TCP/IP

With this option selected, you can connect to a remote computer that will run simulations or act as a coordinator of agent computers that will run simulations.

TCP/IP Connection Settings

This area is shown when the Remote - TCP/IP option is selected. The initial settings are for a local connection and need to be changed for a remote connection.

Machine Name	This is the name of the remote computer on which you want to run simulations or which you want to be a coordinator of agent computers that will run simulations.
Port Number	This is the port number for the remote computer named above. The default is 40500.

Connect

You click this button to establish a connection with the local or remote computer specified above, especially if you have changed the connection.

Errors

Click to open the WSMarshaller Errors dialog, which will report connection errors if any are found.

Clean

Connected Agents

This area is where you load configuration data from agents or a coordinator, whether current or intended. Show dialog properties

Load From

By clicking this button you are obtaining information about the computer currently shown in the adjacent drop-down list. Depending on your choice, two or three tabbed panels are revealed (Agent Type and Agent Options, or Agent Type, Agent Options, and Coordinator Settings).

Drop-down list

From this list you can choose the computer for which you want to load or set configuration data.

Local Agent	This is the current local computer. There is no need to configure this if all you want to do is run simulations on this computer from the product installed on this computer. However, if you want to use this computer as an agent for another computer or as a coordinator of agent computers, then you can configure this in the associated tabbed panels.
Coordinator	This option will appear if you have already set up a computer as a coordinator. By loading from this you will be able to configure the coordinator in the associated tabbed panels.
A named remote computer	This option will appear if you have already set up a remote computer as an agent. By loading from this you will be able to configure the named remote computer in the associated tabbed panels.

Agent Type

This tab is where you specify whether the computer being configured should be a standalone agent or part of a workgroup using an agent coordinator. The tab is shown when Load From has been clicked in the Connected Agents area. Show dialog properties

Standalone (local machine only)

If you select this option, the workgroup designation and remote availability options are not applicable and are removed from view.

The "local machine" can be a remote computer if that is what you selected in the Connected Agents area.

Workgroup (using an agent coordinator)

This is the option to select if you want to set up a collection of computers with a coordinator.

With this option selected, the Designation and Remote Availability tabbed panels are shown.

Designation

This is where you choose which computer will act as the coordinator for the workgroup.

Use this agent as the coordinator	Whether on a local computer or a remote one, selecting this option will set the agent currently being configured as the coordinator. If you select this option, the Coordinator Settings tab is shown.
Use coordinator on (computer name or IP address)	If you select this option, the Coordinator Settings tab is not shown, because the coordinator settings should be made on or for the remote computer identified here.

Remote Availability

This is where you specify which licence to use if you want the agent to be capable of running simulations from a remotely invoked run.

Act as a remote agent, using licence:	If this box is ticked, this agent can be used as a remote agent, provided that valid licence information is entered in the associated fields.
Licence type	The options in the drop-down list are: Autodetect local Old style network (Net Hasp) New style network (Hasp HL Net) Old style local (Sentinel) New style local (Hasp HL Max) Soft local Soft Network (on demand) Thales
Computer name or IP address	This is the name or address of the computer from which the agent being configured gets its licence for running the jobs it has been asked to run by another agent.
HASP key ID / soft licence no.	This is the key ID or soft licence number of the computer from which the agent being configured gets its licence for running the jobs it has been asked to run by another agent.
Engine size	This is enabled when the Licence Type is set to Thales, and allows you to choose from a drop-down list, the maximum number of nodes / elements that can be processed by the InfoWorks WS Pro engines using the specified Thales licence.
TS size	This enabled when the Licence type is set to Thales, and allows you to choose from a drop-down list, the maximum number of nodes / elements that can be used in InfoWorks WS Pro using the specified Thales licence.

Agent Options

This tab is where you set various options for an agent. Note especially that on the Performance tab you can set maximum concurrent jobs and maximum threads. The tab is shown when Load From has been clicked in the Connected Agents area. Show dialog properties

Do not allow simulation on 'This computer'

Applies to the computer currently being configured. Tick to prevent use of the computer for simulations.

TCP/IP Ports

This is where you can set the various TCP/IP port values. All connected agents need to use the same set of ports otherwise they cannot communicate. If the defaults are not used, or if an agent is changed for some reason, then the associated agents must also be changed to match, so that communications between agents is maintained.

Sim control	Normally use the default 40201. If this is changed, change it to the same value on all associated agents.
File transfer	Normally use the default 40202. If this is changed, change it to the same value on all associated agents.
Coordinator	Normally use the default 40203. If this is changed, change it to the same value on all associated agents.
Use TCP/IP for clients (not recommended)	~

Housekeeping

These are options for minimising storage and performance problems.

Cancel inactive jobs after (days)	Leave the default value of 14 days or enter a new number of days.
Delete working files after (days)	Leave the default value of 28 days or enter a new number of days.

Permissions

This is where you set who can make configuration changes on agent computers.

Allow agent configuration changes by | Any user

This default option will allow any user to make configuration changes.

Allow agent configuration changes by | Owners of databases with IDs:

This option will allow only owners of specified databases to make configuration changes.

Clicking Add will open the Add Database dialog. This contains a drop-down list that may contain database IDs for you to choose. Alternatively, you can type in the ID of a database, then click OK.

Clicking Remove will remove the highlighted database ID.

Logging and Diagnostics

This is where you can decide the level of detail in the logs created during simulation runs.

Log detail	The default is Normal, but you can choose Basic or Trace.
Keep working folders after job completes	The default is for working folders to be deleted.

Performance

This is where you can match job runs to thread limits and computer core availability.

Number of job slots

For the coordinator it is recommended that maximum number of job slots is set to a value less than the total number of cores, to leave at least one core for doing coordinator work.

The default is 1.

Max threads total

This field is used to specify the maximum total number of threads to be used by all active simulation and mesh jobs running on the specified agent. If set to 0, the actual limit is set to the number of cores on the machine.

The total thread limit is shared equally amongst active jobs. Each active job is allocated at least one thread (even if this takes the total threads above the limit). Per-job limits are not exceeded.

A priority job is allocated the total number of threads and runs at a higher priority than the already active jobs, each of which is allocated a single thread.

Compress data during file transfer

This may help performance when transferring data across networks.

Custom Settings [KEY=VALUE]

Additional options that may be applied to the agent.

Removal of daily log files

The keyword LOGEXPIRYDAYS can be used to specify the number of days that must elapse before the agent daily log files are deleted. For example, LOGEXPIRYDAYS=30 would mean that the log files are automatically deleted after 30 days. The default value is 21 days.

Custom settings are rarely required and should normally be applied only on the advice of the Innovyze Support Team.

Coordinator Settings

This tab is where you create and maintain groups of agents. The tab is shown when Load From for a coordinator has been clicked in the Connected Agents area, or when Workgroup (using an agent coordinator) has been selected on the Agent Type tabbed panel. Show dialog properties

Remote agents visibility statement

The three options available by clicking the browse button Browse

determine whether some or all remote agents are listed in the Connected Agents area.

Group

Clicking the plus button Plus

adds an automatically named new group. You can change the name in the Name box on the Edit tabbed panel. Clicking the minus button Minus

deletes the currently shown group.

Edit

This is where you can view and change the name and description of an agent group.

Name	Shows the name and description of the current agent group (the one currently showing in the Group box, above). You can edit the name here.
Description	Shows the description for the current agent group. You can edit the description here.

Agents in group

The box lists the agents in the current group (the one currently showing in the Group box, above).

You can add agents:

by entering the details of a known device in the form name:port or
by clicking the Add button to open the Add Agent dialog, then entering or selecting a computer identifier.

You can remove an agent by highlighting it in the box and clicking Remove.

Permitted Databases

The box lists the permitted databases in the current group (the one currently showing in the Group box, above).

You can add permitted databases by clicking the Add button to open the Add Database dialog, then entering or selecting a database identifier.

You can remove a permitted database by highlighting it in the box and clicking Remove.

Save To

When you want to save changes, select the target from the drop-down list then click Save To.

If you attempt to close the dialog without saving the changes, you will be prompted to save the changes by a warning that identifies the target.

Run Control window