Share
 
 

Advanced Page

The Advanced page allows users to configure advanced optional parameters. The available parameters depend on the service that is currently selected on the Tree pane.

The table below lists the options and data available on the page:

Option Description

Search

Used to filter the display of configuration parameters in the list below.

The filter is case insensitive. So, for example, type minutes in the Search box and the parameter lists will be filters and only show parameters that contain the word minutes.

Parameter list

List of parameters that are available for the currently selected service. See sections below for more information.

There are three types of parameters:

  • Boolean – true or false
  • String – a string of characters
  • Integer – a positive number

The list contains the following columns:

Parameter - name of the configuration parameter, and is of the type <section>.<keyword>.

Status - Indicates if the value is the application default value or it is different and has been set by the user.

Value - Actual parameter value that will be used by the server.

Context menu options

A context menu is available for each parameter. There are two types of context menus:

  • Containing the Modify, Copy and Reset options - for String and Integer parameters
  • Containing the Toggle, Copy and Reset options - for a Boolean parameter

Right-click a parameter on the list to display context menu options:

Context menu option Description
Modify Opens the Enter a Value dialog to allow parameter modification.

Toggle

Changes a Boolean value to its negation.

Copy

Copies a parameter to the clipboard.

Reset

Changes a parameter to its default value.

Live Server parameters

Live Server - Advanced Page

The table below lists the available parameters:

Parameter Description

Database.AgentPort

Database agent handling client connections. Specifies the port that the agent listens to that handles the currently selected database.

Default - AgentPort=35001

Factory.CancelJobMinutes

Defines the number of minutes after a job is submitted to the InfoWorks ICM Agent that it will be cancelled by the Innovyze Live Server if the job is still incomplete. If the value is 0, then submitted jobs will never be cancelled by the Innovyze Live Server. However, they will be cancelled by the InfoWorks ICM Agent in accordance with the Cancel inactive jobs after days setting in the Agent Options dialog in ICMLive Configuration Manager.

Default - CancelJobMinutes=1440

Factory.CleanupFrequencyMinutes

Defines how often the state information is cleaned up.

Default - CleanupFrequencyMinutes=360

Factory.DeleteStateHours

Number of hours that must elapse before current or previous simulation data can be deleted from persisted state.

Default - DeleteStateHours=72

Factory.RetryFrequencyMinutes

For purposes of creating and dispatching simulations

Frequency at which database and sim agent connections are to be re-tried when previous connection attempts failed.

Default - RetryFrequencyMinutes=10

Log.LogFileMaintMinutes

Text log maintenance is run once per day. This parameter specifies the number of minutes that must elapse after midnight before running the text log maintenance.

Default - LogFileMaintMinutes=15

Log.LogFilePurgeDays

Number of days that must elapse before purging the old text log files.

Default - LogFilePurgeDays=30

Maintenance.LogMaintMinutes

Specifies how many minutes past midnight to run sim log maintenance. Sim log maintenance is run once a day.

Default - LogMaintMinutes=10

Maintenance.PurgeLogFileDays

Number of days after which old sim maintenance log files are to be purged.

Default - PurgeLogFileDays=60

Maintenance.RetryCount

For purposes of running sim maintenance

Number of times to retry failed database and sim agent connections before terminating the daily sim maintenance task.

Default - RetryCount=12

Maintenance.RetryFrequencyMinutes

For purposes of running sim maintenance

Frequency at which database and sim agent connections are to be re-tried when previous connection attempts failed.

Default - RetryFrequencyMinutes=15

Maintenance.SimMaintMinutes

Specifies how many minutes past midnight to run sim maintenance. Sim maintenance is run once a day.

Default - SimMaintMinutes=30

Messenger.BufferDays

The number of days from the current date that the server will buffer messages that are provided to the Live Operator Client. This controls the number of server messages that a user may view in the Live Operator Client.

Default - BufferDays=3

Messenger.MaxMessages

Maximum number of messages that the server will buffer within the period specified in the Messenger.BufferDays parameter. The maximum allowed value is 2000.

Default - MaxMessages=500

Messenger.PurgePastMidnightMinutes

Specifies the number of minutes past midnight to purge the previous day messages. Old server messages are purged from memory once per day.

Tip: These messages are only purged from the server buffer, not from the system event log.

Default - PurgePastMidnightMinutes=3

Monitor.ConnectFrequencyMinutes

Defines how often a database connection is to be re-tried.

Default - ConnectFrequencyMinutes=10

Monitor.RetryInitStateMinutes

Defines how often a state should be re-initialised when a database connection fails when the service is starting.

Default - RetryInitStateMinutes=1

Monitor.ScanFrequencyMinutes

Defines how often the database is scanned for changes.

Default - ScanFrequencyMinutes=6

Run.RunOriginNoDST

The value, either true or false, indicates whether or not to ignore daylight savings time when calculating run origin dates.

RunOriginNoDST=true – The run origin uses the local time, ignoring daylight savings time.

RunOriginNoDST=false – The run origin uses the local time only.

Default - RunOriginNoDST=true

Scheduler.NumLateMinutes

Do not initiate late simulations if the next scheduled simulation starts within the specified time period.

Default - NumLateMinutes=15

Sentinel.LastFileWriteToleranceSeconds

Do not initiate an externally triggered run if the last triggered file write has occurred within the tolerance specified since the last file write.

Default - Sentinel.LastFileWriteToleranceSeconds=5

Sentinel.NumStaleMinutes

Do not initiate an externally triggered run if the last trigger file write occurred earlier than the current time minus the number of minutes specified.

Default - Sentinel.NumStaleMinutes=15

SimControl.Hostname

Sim agent configuration for the server local agent when running on a remote computer

Name of the computer that will run simulations on behalf of the server.

Default - Hostname=

SimControl.MaxSimEngineThreads

Sim engine multi-threading parameter used to control the maximum number of sim engine threads. Any value up to a maximum value of 99 overrides the sim agent setting, but a value of 0 indicates to use the sim agent configured value.

Default - MaxSimEngineThreads=0

SimControl.RunAsLogonUser

Specifies the username credentials used for simulation jobs.

RunAsLogonUser=false – Simulations run as the original pseudo-username (InnovyzeLiveServer) that was used as the username at the inception of ICMLive.

RunAsLogonUser=true – Simulations run with the username credentials that the Live Server service is configured to logon as.

Default - RunAsLogonUser=true

SimControl.RunOn

Computer where simulations are run:

. - this computer only

* - any computer

<group> - any computer that is a member of the named group

Default - RunOn=*

SimControl.SimPort

Sim server configuration for the server local agent when running on a remote computer

Port that the sim agent is listening to that is going to run simulations on behalf of the server.

Default - SimPort=40001

SimControl.UseLocalPipe

Sim agent configuration for the server local agent when running on the local host

The value, either true or false, indicates whether or not to use the sim agent running on the local machine.

UseLocalPipe=true - ignores Hostname and SimPort and the server connects to the sim agent running on the localhost using pipes.

UseLocalPipe=false - Hostname and SimPort must be configured to a valid remote host / port and the server connects to the sim agent running on the remote host using TCP/IP.

Default - UseLocalPipe=true

TaskScheduler.NumLateMinutes

Do not initiate late tasks if the next scheduled task starts within the specified time period.

Default - NumLateMinutes=30

TransLog.PurgeLogFileDays

When to purge an old transaction log. Specifies the number of days to elapse before the transaction log is deleted by the Innovyze Live Server.

Default - PurgeLogFileDays=60

TransLog.StartLogMaintMinutes

Transaction log maintenance is run once per day. This parameter specifies how many minutes past midnight to initiate transaction log maintenance.

Default - StartLogMaintMinutes=20

For more detailed information please refer to the Innovyze Live Server Administration Guide available for download here.

Data Loader parameters

Data Loader - Advanced Page

The table below lists the available parameters:

Parameter Description

Initiator.CleanupFrequencyMinutes

Defines how often TSD update jobs are to be released. This also encompasses any other internal clean-up activities.

Default - CleanupFrequencyMinutes=60

Initiator.ReleaseCompletedJobsHours

Number of hours that must elapse before a completed TSDB update job is released from the job queue. These jobs are usually failed jobs because successful jobs are released immediately upon completion.

Default - ReleaseCompletedJobsHours=24

Initiator.RetryFrequencyMinutes

For purposes of creating and dispatching TSDB updates

Frequency at which database and job agent connections are to be re-tried when previous connection attempts failed.

Default - RetryFrequencyMinutes=10

JobControl.Hostname

Job agent configuration for the server local agent when running on a remote computer

Name of the computer that will perform TSDB updates on behalf of the server.

Default - Hostname=

JobControl.Port

Job server configuration for the server local agent when running on a remote computer

Port that the job agent is listening to that is going to run TSDB updates on behalf of the server.

Default - Port=40001

JobControl.UseLocalPipe

Job agent configuration for the server local agent when running on the local host

The value, either 0 or 1, indicates whether or not to use the sim agent running on the local machine.

UseLocalPipe=1 - ignores Hostname and Port. The server connects to the job agent running on the localhost using pipes.

UseLocalPipe=0 - Hostname and Port must be configured to a valid remote host / port. The server connects to the job agent running on the remote host using TCP/IP.

Default - UseLocalPipe=1

Log.LogFileMaintMinutes

Text log maintenance is run once per day. This parameter specifies the number of minutes that must elapse after midnight before running the text log maintenance.

Default - LogFileMaintMinutes=15

Log.LogFilePurgeDays

Number of days that must elapse before purging the old text log files.

Default - LogFilePurgeDays=30

Maintenance.LogMaintMinutes

Specifies how many minutes past midnight to run sim log maintenance. Sim log maintenance is run once a day.

Default - LogMaintMinutes=10

Monitor.ConnectFrequencyMinutes

Defines how often database connections are to be re-tried.

Default - ConnectFrequencyMinutes=15

Monitor.ScanFrequencyMinutes

Defines how often the database is scanned for changes.

Default -ScanFrequencyMinutes=6

Scheduler.NumLateMinutes

Do not initiate late TSD updates if the last file write has occurred within the tolerance specified since the last file write.

Default - LastFileWriteToleranceSeconds=30

Sentinel.LastFileWriteToleranceSeconds

Do not initiate late TSD updates if the last file write has occurred within the tolerance specified since the last file write.

Default - LastFileWriteToleranceSeconds=0

For more detailed information please refer to the Innovyze Data Loader Administration Guide available for download here.

Editing a parameter

A parameter can be edited by using one of the following methods:

  • Select a parameter in the list and press enter.
  • Double click a parameter entry in the list.
  • Select Modify (or Toggle for a Boolean parameter) from the context menu.

In every case with the exception of boolean parameters (whose status is immediately changed to its negation), the Enter a Value dialog is displayed.

Was this information helpful?