There are a few optional configuration parameters that may be set for the InfoWorks Workgroup Server. These options are set in a simple text file called snumbat.ini. The Workgroup Server installer does not install a default version of this file. You will have to create it yourself if you want to change the default settings. Note it is not necessary to use a snumbat.ini if you are using a standard workgroup database. The file should be located in the directory where the Workgroup Server is installed, the directory containing snumbat.exe, which is normally “ C:\Program Files\Autodesk\InfoWorks Workgroup Server”. The file should use UTF-8 encoding if it contains non-ASCII characters.
All parameters are optional and have the format keyword=value. Any line that starts with a # in the first column is a “comment” line and is ignored. Any parameters which are changed by this mechanism will generate an entry in the Windows Application Event Log when the Data Server is started, confirming that the change has been applied. It is viewed as good practice to review the Event Log after started the Data Server to verify these parameters are in force.
The table below lists most of the available parameters. Parameters related to authentication are listed separately in the relevant section of this document.
Keyword in snumbat.ini | Description |
---|---|
Port |
Specifies the TCP port number to listen on. The default value is 40000 |
HttpServerPort |
Specifies the TCP port number to use for serving attached files via http. The default value is 40010 |
HttpServerEnabled |
Specifies whether serving attached files via http is enabled. The default value is 1 (enabled). Set to 0 to disable. |
DataPath |
Specifies the data directory for the Data Store. For best performance and reliability this should be on a local drive and not on a network share. A warning will be generated in the Event log if this drive does not appear to be a local drive. The Workgroup Server Service will not start if DataPath is set to a location that cannot be accessed. In this case an error will be put in the event log. The default value is C:\ProgramData\Innovyze\SNumbatData |
LogToFile |
0 – Log output is sent to the Windows Event log only. 1 – Log output is also sent to a file called snumbat.log in the root of the Data Store directory. Note that different levels of logging detail can be set for the event log and file log using the LogLevel and LogLevelEvent parameters respectively. The default setting is 0 |
LogLevel |
Specifies the log level threshold for logging to the log file. Lower thresholds add more detail. 4 – Errors only 3 – includes warnings 2 – includes start-up/shutdown information 1 – includes general information about usage (to log file only) 0 – includes debug information (to log file only) The default setting is 2. We do not recommend setting a higher value. |
LogLevelEventLog |
Specifies the log level threshold for logging to the Windows Event Log. The levels are as for the LogLevel parameter. The default setting is 2. We do not recommend setting a higher value and we recommend using the log file if more detailed logging (0 or 1) is required. |
DisableReverseDNS |
The Workgroup Server uses reverse DNS to lookup the name of incoming connections. If reverse DNS is not setup for your network this lookup might add a second or two to each connection to the Workgroup Server. Setting this parameter to 1 will disable the lookup. The default setting is 0 |
AllowDatabaseCreation |
Controls whether clients can create standard databases. This setting can be useful if you are using Oracle or SQL Server database and do not want users to be able to create standard ones. 0 – Creation disallowed 1 – Creation allowed The default setting is to allow database creation by clients. |
AllowDatabaseCreationInRoot |
Controls whether clients can create standard databases at the top level (i.e. not in a group) 0 – Creation disallowed 1 – Creation allowed The default setting is to allow database creation at the root level by clients. |
AllowDatabaseGroupCreation |
Controls whether clients can create database groups 0 – Creation disallowed 1 – Creation allowed The default setting is to allow database group creation by clients. |
AttachmentPath | Specifies the directory to be used to store InfoNet/InfoAsset attachments other than videos (e.g. images, documents). The default location is “C:ProgramData\Innovyze\SNumbatData\Attachments”. This need not be specified as a local drive. |
VideoPath |
Specifies the directory to be used to store InfoNet/InfoAsset attachments that are videos. The default location is “C:ProgramData\Innovyze\SNumbatData\Videos”. This need not be specified as a local drive. It is allowable to set VideoPath to be the same as AttachmentPath. Important: Prior to version 2019.2, videos were stored under AttachmentPath. Any videos that were uploaded to the database before version 2019.2 will remain under the AttachmentPath but can be migrated to the VideoPath using the ‘Migrate Videos’ tool in the Workgroup Client. Videos uploaded using Workgroup Clients from version 2019.2 onward will be uploaded to the VideoPath. Videos uploaded using older Workgroup Clients will continue to be uploaded to the AttachmentPath. Videos will be displayed correctly in any version of the Workgroup Client regardless of where they are stored.
|
AttachmentExternalSharePath |
Deprecated. Specifies a Windows share path that can be used by Workgroup Clients to access the files in the AttachmentPath directly (i.e. not via http). The default is that this is not set and that files are accessed via http. |
VideoExternalSharePath |
Deprecated. Specifies a Windows share path that can be used by Workgroup Clients to access the files in the VideoPath directly (i.e. not via http). The default is that this is not set and that files are accessed via http. |
ProcessVideos |
This option is used only by InfoAsset Online and requires that the video processing tools have been installed. If set to 1, all videos that are uploaded as attachments will be processed to convert them to a standard, browser-friendly codec and format, at multiple resolutions and bit rates. Note that this setting applies to video attachments in all databases managed by the server that are at version 2019.2 or later. The default setting is 0 (no processing of videos). |
ProtectedUrlPrefix ProtectedUrlTokenType ProtectedUrlTokenSource ProtectedUrlTokenSecret AzureServicePrincipalTenant ServicePrincipalID GoogleDriveProxy |
These options are used to configure the Workgroup Server to acquire and distribute access tokens needed to allow users to make use of links to data files (particularly videos) stored in Azure or on Google Drive. More details can be found in the documents “InfoAsset - Quickstart - Working with videos in Azure blob storage” and “InfoAsset - Quickstart - Working with videos in Google Drive” The default is that none of these options are set. |
Example snumbat.ini with the default options set
Port= 40000 #DataPath= LogToFile=0 LogLevel=2 DisableReverseDNS=0 AllowDatabaseCreation=1 AllowDatabaseCreationInRoot=1 AllowDatabaseGroupCreation=1