Configuration

All BcsService configurations are stored in the DigaSystem registry in the subkey "BcsService". If only one configuration is defined, it will be used automatically when the BcsService is started. In the following figure, there is only one configuration "Local".

If more than one configuration is specified, the desired configuration must be specified. Each configuration is stored in its own subkey which is named after the configuration name that was provided in the installation process. See .Using multiple configurations v3.2 for details.

In the following figure, there are two configurations "Config1" and "Config2".

Configurations can be stored in the global and in the local registry. Both registries are scanned but the local registry has priority over the global registry.

Create configuration with default values

o avoid to enter parameter names it's recommended to use the command line /SetDefaultValues to create configuration with all parameteres with default values. See .Install & Configure & Uninstall Windows service v3.6

Logging

Since BcsService version 3.2, the standard DigaSQL logging mechanism is used. To enable the logging for a specified configuration, set the variable with the name "BcsService-ConfigurationNameHere" in the "Protocol" subkey of the DigaSystem registry.

If any error occurs before the DigaSQL log is initialized (e.g. configuration with specified name not found) than the standard Windows Application log is used. This means if BcsService does not start, check the Windows Application log for any messages.

Windows log

BcsService uses the standard Windows log (Windows Application log) for logging if the DigaSQL isn't accessible. E.g. before the DigaSQL initialization or if the DigaSQL initialization failed. All Windows log entries show the configuration name in the source field, e.g. BcsService_Config1. That simplifies the analysis if BcsService is installed with multiple configurations.

Be aware! When using special characters (at least space and - ) in the configuration name, Windows interprets them as separators and stores only parts of the name in the source field of the Windows log.

E.g. for a configuration with the name VM-Station-2020-BCS the source field will store only 2020-BCS instead of BcsService_VM-Station-2020-BCS. To avoid that, don't use any special characters in configuration names.

DigaSystem registry subkeys and parameters

BcsService\ConfigurationName

Parameter name

Description

LogLevel

Determined how much details will be stored into log for this configuration. Only followed values can be specified otherwise error occurred

Critical - only very important messages will be logged. Errors aren't included
Error - very important messages and all errors are logged
Warning - very important messages, errors and warnings are logged
Information - very important messages, errors, warnings and verbose messages (include HTTP & WebSocket API calls) are logged. Warning! This level can generate large log files. Enable it only if you want to log all API calls on BcsService side
Debug - all messages (included HTTP & WebSocket API calls) and special information for support are logged. Warning! This level generate very large log files. Enable it only if it requested from support

Default value
Error

BcsService\ConfigurationName\BCS

Contains parameters affected to linked BCS

Parameter name	Description
Name	BCS (not workstation!!!) name from DigaSystem registry in key "Digas\PlanServer\NameHere" Example: LocalBCS
BcsUser	Identity under which the service connects to the BCS server for internal tasks. User should have rights to read all programs metadata Example: Admin
BcsPassword	Password for the identity encrypted in BCS format. Example: ****
PollingInterval	Polling interval (milliseconds) for checking active connections from clients. If all connections under with specified BCS user are inactive more as this interval than connection to BCS will be closed and all clients used this user name should be login by BCS again. Default value 60000

BcsService\ConfigurationName\Database

Contains database service parameters

Parameter name

Description

DatabaseUser

Identity under which the service connects to the DigaSQL database. User should have rights to read all used tables.

Example:
Admin

DatabasePassword

Password for the identity to the DigaSQL database encrypted in BCS format.

Example:
****

BcsService\ConfigurationName\FileCopy

The parameters of this key define the behavior of BcsService regarding when or when not to copy files into media directories. For a description of the individual parameters see the key "DigAIRange\FileCopy".

BcsService\ConfigurationName\Paths

Contains path to affected locations

Parameter name	Description
MediaFolder	Folder where temporary stored received media files Default value: BcsService_Directory\Media\ Example: D:\Media\
HtmlFolder	Local path with data for HTML streaming. E.g. install WebDigAIRange into this folder to using BCS Service as host for WebDigAIRange Default value: BcsService_Directory\Html\ Example: D:\Html\
MediaFolder0 MediaFolder1 ... MediaFolderN	Optional parameters in any count to provide file access via BCS Service. By default BCS Service restricted any file access to followed locations Directory from MediaFolder parameter (see above) and all subdirectories Directory from HtmlFolder parameter (see above) and all subdirectories BCS media directories and all subdirectories To provide file access via BCS Service to any other directories with all subdirectories define it in extra parameters MediaFolder0...N If any parameter value is empty it's ignored. Example: \\fileserver\extra\audio\

BcsService\ConfigurationName\Paths\AllowList

Contains optional directories in any count to provide file access via BCS Service.

Parameter name

Description

AllowFolder0
AllowFolder1
...
AllowFolderN

Optional parameters in any count to provide file access via BCS Service. By default BCS Service restricted any file access to followed locations

Directory from MediaFolder parameter (see above) and all subdirectories
Directory from HtmlFolder parameter (see above) and all subdirectories
BCS media directories and all subdirectories
Database media directories and all subdirectories

To provide file access via BCS Service to any other directories with all subdirectories define it in extra parameters AllowFolder0...N
If any parameter value is empty it's ignored..
Deny list is more important as allow list. This means if the same path is present in the both (allow & deny) lists than file access will be denied, because of deny access has more priority as allow access.

Example:
\\fileserver\extra\audio\

BcsService\ConfigurationName\Paths\DenyList

Contains optional directories in any count to provide file access via BCS Service.

Parameter name

Description

DenyFolder0
DenyFolder1
...
DenyFolderN

Optional parameters in any count to restrict file access via BCS Service. By default BCS Service restricted any file access to followed locations

Directory from MediaFolder parameter (see above) and all subdirectories
Directory from HtmlFolder parameter (see above) and all subdirectories
BCS media directories and all subdirectories
Database media directories and all subdirectories

To restrict file access via BCS Service to any directory with all subdirectories define it in extra parameters DenFolder0...N
If any parameter value is empty it's ignored..
Deny list is more important as allow list. This means if the same path is present in the both (allow & deny) lists than file access will be denied, because of deny access has more priority as allow access.

Example:
\\fileserver\extra\audio\InternalAudios

BcsService\ConfigurationName\Service

Contains web service parameters

Name	Description
AcceptNoRightsCheckFlag	Accept NoRightsCheck BCS flag from requests. If not allowed any request with NoRightsCheck flag will be returned with error message. Only followed values can be specified otherwise error occurred True False Default value: False
HttpInactivityTimeout	Closing BCS connection inactivity timeout in milliseconds due inactivity for HTTP clients Default value: 60000
WebSocketInactivityTimeout	Closing BCS connection inactivity timeout (milliseconds) due inactivity for WebSocket clients. Disabled if zero. If disabled BCS connections will be closed only after closing event from WebSocket API Default value: 60000
ScanWebSocketClients	Active scan WebSocket clients to identify dead connections. Clients must support ping / pong communication. If active mode enabled service actively scan WebSocket clients with ping / pong communication top identify dead connections. If active mode disabled every WebSocket client must periodically send either ping or PostHeartbeat (see BCS Service SDK for details) message to the service to indicate about alive connection. Active mode is recommended to reduce the service load and simplify the WebSocket clients True (recommended) False Default value: True
BaseAddress	HTTP base address of the service. Mainly defines the port. Default value: http://+:8081/ Example: http://localhost:8081/
HTTPSAddress	HTTPS base address of the service. Mainly defines the port.. Can be used together or without HTTP. Disabled if empty. You need to configure the certificate Default value: http://+:8071/ Example: https://localhost:8071/
WebSocketPort	Port for the WebSocket Server. If zero or omitted no WebSocket server Example: 8100
WSSPort	Port for the WSS Server. If zero or omitted no WSS server. You need to configure the Certificate Example: 8105
WSSCertificate	Local path to .crt or .pfx file with certificate for WSS connections. If empty or omitted no WSS server. Try to use .crt instead .pfx Example: C:\ProgramData\Certificates\WSS.crt
WSSCertificatePassword	Optional password to certificate for WSS connections encrypted in BCS format Example: ****
RootName	Name of the Web Service root. Used in API. E.g. http://localhost:8081/bcs/ Default value: bcs
FileHandlingResultKeepTime	Keep time (milliseconds) for information about file handling state and progress in internal cache for result requests after file handling task is finished Default value: 60000
SendDefaultAudio	Optional send default audio about non existed prelisten file instead error. Only followed values can be specified otherwise error occurred True - send default audio about non existed prelisten file False - return error if prelisten file not found Default value: True
AllowAutomaticAccessToBcsMediaDirectories	Automatically provide file access to all BCS media directories without including it into allow list True - provide file access to all BCS media directories without including it into allow list False - don't provide file access to BCS media directories without including it into allow list Default value: True
AllowAutomaticAccessToDbMediaDirectories	Automatically provide file access to all database media directories without including it into allow list. If this option enabled service start can be might slower because depends from the number of accessible database table True - provide file access to all database media directories without including it into allow list False - don't provide file access to database media directories without including it into allow list Default value: True
EnableMemoryConsumptionWatcher	Watch memory consumption and logged it with log level "Information". Enable it only if it requested from support True - enable memory consumption log once every 60 second False - disable memory consumption log Default value: False