Configure Branch Compression Server (BCS)

Change Branch Compression Server (BCS) Service Account

After installation, Branch Compression Server (BCS) service runs under the Local System account which is suitable in most cases. To change the account under which the service runs, please follow the steps listed below:

Launch the Services Control Panel and right click on SpeedyDB BCS (highlighted below).
From the menu, choose Properties. The SpeedyDB BCS Properties form will appear. Click to choose the Log On tab.
Click to choose This Account and type in the desired account name and password.
Click on the OK button to confirm the change.

Change Branch Compression Server (BCS) Settings

The settings of Branch Compression Server (BCS) are stored in BCS.ini which is a text file. This file was created using the specified parameters during the installation.

There are a number of sections in the file:

Network
Network specifies network related parameters such as IP address and port number for BCS.
BCSPort1
BCSPort1 section specifies the first port of BCS.
BCSPort2 section specifies the second port of BCS.
And so on.
Encryption
Encryption section specifies data encryption related parameters.
Log
Log section specifies how BCS log information for auditing and trouble-shooting purpose.
Metadata Cache
Metadata Cache section specifies cache parameters for metadata.
Row Cache
Row Cache section specifies cache parameters for rows (records).
Result Cache
Result Cache section specifies cache parameters for groups of rows (records).
Compressed Cache
Compressed Cache section specifies cache parameters for compressed cache.
Uncompressed Cache
Uncompressed Cache section specifies cache parameters for uncompressed cache.
SpeedyDB Manager
SpeedyDB Manager section specifies the user name and password for SpeedyDB Manager.

Network Section

There are 10 items in this section. The following is an example of the section contents

        [Network]
        NumberOfBcsPorts=1
        DcsServer=192.168.1.100
        DcsPort=3568
        BranchID=111
        ReceiveBufferSize=1024  ;in KB 1024 means 1MB
        SendBufferSize=1024  ;in KB 1024 means 1MB
        TimeOut=120
        LiveMessageInterval=10
        SaveCaches=1
        SaveCacheInterval=3600
        CacheFileDirectory=C:\Program Files (x86)\SpeedyDB\BCS\Caches\

NumberOfBcsPorts
NumberOfBcsPorts specifies how many BCS ports will be used.
DcsServer
DcsServer specifies the IP address or host name of the DCS.
DcsPort
DcsPort specifies the port number of the DCS.
BranchID
BranchID specifies a unique ID to identify this BCS. It must be a unique value for each BCS installed.
ReceiveBufferSize
ReceiveBufferSize specifies the receiving buffer for the TCP connection between BCS and DCS. A larger value is desired to avoid congestion for long fat pipe.
SendBufferSize
SendBufferSize specifies the sending buffer for the TCP connection between BCS and DCS. A larger value is desired to avoid congestion for long fat pipe.
LiveMessageInterval
LiveMessageInterval specifies how often BCS will send a "live message" to DCS.
SaveCaches
SaveCaches specifies if caches are being saved to hard disks in order to reload them when BCS restarted.
SaveCacheInterval
SaveCacheInterval specifies how often BCS will save caches. A value of 0 means BCS will not save caches periodically (BCS will save caches when it is being stopped or receive "Save Cache" request from the DCS if SaveCaches is 1).
CacheFileDirectory
CacheFileDirectory specifies the location for saving caches.

BcsPort1 Section

BcsPort1 section specifies the first BCS port.
BcsPort2 section specifies the second BCS port.
And so on.
NumberOfBcsPorts parameter in Network section specify the number of BCS ports.

There are 5 items in this section. The following is an example of the section contents

        [BcsPort1]
        BcsAddress=
        BcsPort=3560
        DatabaseServerID=1

BcsAddress
BcsAddress specifies the IP address to which the BCS listens to. If you leave it empty as in the above example, the BCS will listen to all the IP addresses on the host computer.
BcsPort
BcsPort specifies the port number to which the BCS listens to.
DatabaseServerID
DatabaseServerID specifies the database server ID. The valid value is from 1 to NumberOfDatabaseServers (defined in the Network Section of DCS.ini). ID of "1" is corresponding to the database server defined in DatabaseServer1 section in DCS.ini, NumberOfDatabaseServers (defined in the Network Section of DCS.ini). ID of "2" is corresponding to the database server defined in DatabaseServer2 section in DCS.ini, and so on.

Encryption Section

There are 5 items in this section. The following is an example of the section contents

        [Encryption]
        
        ;0--Encryption Off   1--Encryption On
        EncryptionOption=0   

        ;must be full path
        PrivateKeyFile=C:\SslCert\server.pem         

        ;must be full path
        CertificateFile=C:\SslCert\server.pem         

        ;must be full path
        CAFile=C:\SslCert\ca.pem   ;must be full path

        ;must be full path.  If both CAFile and CAPath is empty, then a dummy certificate will
        ;be created by BCS or DCS
        CAPath=C:\SslCert

EncryptionOption
Valid value is 0 and 1.
- 0: Encryption is off
- 1: Encryption is on
PrivateKeyFile
The private key file of the DCS in PEM format. In order to enforce the security, the file must be stored in a secure location that requires special permission to access it. A full path must be specified.
CertificateFile
The file contains the certificates from your database servers.
CAFile
The file that contains certificate chain all the way to the trusted Certification Authorities (CA).
CAPath
The directory that contains certificates wiath a chain all the way to the trusted Certification Authorities (CA).

See Enable data encryption in DB-WAN-Accel for more details.

Log Section

This section is used to configure how Branch Compression Server logs activities for trouble-shooting purposes.

There are 19 items in this section. The following is an example of the section contents

        [Log]
        
        LogDirectory=C:\MsgDump
        CallingTreeDumpLevel=0

        IsLogSql=0
        IsLogDbSentMessage=0
        IsLogDbRecvMessage=0

        IsLogSpdSentMessage=0
        IsLogSpdRecvMessage=0

        IsLogSpdSentRawMessage=0
        IsLogSpdRecvRawMessage=0

        IsLogCallingTree = 0

        ExceptionFileName=Exceptions.bin

        SqlFileName="sqlDcs.txt"
        DbSentFileName="DbSentBcs.bin"
        DbRecvFileName="DbRecvBcs.bin"

        SpdSentFileName="SpdSentBcs.bin"
        SpdRecvFileName="SpdRecvBcs.bin"

        SpdSentRawFileName = "SpdSentRawBcs.bin"
        SpdRecvRawFileName = "SpdRecvRawBcs.bin"

        CallingTreeFileName="CallingTreeBCS.bin"

LogDirectory
The directory for log files.
IsLogDbSentMessage
1: Log all messages sent to database servers.
0: No to log messages sent to database servers.
IsLogDbRecvMessage
1: Log all messages received from database servers.
0: No to log messages received from database servers.
IsLogSpdSentMessage
1: Log all messages sent to Branch Compression Server (BCS) in uncompressed format. 0: Not to log messages sent to Branch Compression Server (BCS) in uncompressed format.
IsLogSpdRecvMessage
1: Log all messages received from Branch Compression Server (BCS) in uncompressed format. 0: Not to log messages received from Branch Compression Server (BCS) in uncompressed format.
IsLogSpdSentRawMessage
1: Log all messages sent to Branch Compression Server (BCS) in compressed format. 0: Not to log messages sent to Branch Compression Server (BCS) in compressed format.
IsLogSpdRecvRawMessage
1: Log all messages received from Branch Compression Server (BCS) in compressed format. 0: Not to log messages received from Branch Compression Server (BCS) in compressed format.
IsLogCallingTree
1: Log calling tree 0: Not to log calling tree
RequestFileName
The file name used to log requests (log level 5).
ExceptionFileName
The file name used to log exceptions.
SqlFileName
The file name used to log SQL statements and stored procedures issued.
DbSentFileName
The file name used to log messages sent to database servers.
DbRecvFileName
The file name used to log messages received from database servers.
SpdSentFileName
The file name used to log messages sent to Branch Compression Server (BCS) in uncompressed format.
SpdRecvFileName
The file name used to log messages received from Branch Compression Server (BCS) in uncompressed format.
SpdSentRawFileName
The file name used to log messages sent to Branch Compression Server (BCS) in compressed format.
SpdRecvRawFileName
The file name used to log messages received from Branch Compression Server (BCS) in compressed format.
CallingTreeFileName
The file name used to log calling tree.

Metadata Cache Section

This section specifies how metadata is cached. There are 4 items in the section. The following is an example of the section contents.

        NumberOfItems = 500000
        Memory = 40
        MemoryFullThreshold = 95
        MemoryEmptyThreshold = 80

NumberOfItems
Number of items can be stored in Metadata Cache of the BCS.
Memory
The memory allocated for "Metadata Cache" in mega bytes. In the above example, up to 40M will be allocated to Metadata Cache.
MemoryFullThreshold
Specifies how full the Metadata Cache can get before we have to purge the less frequently used items from Metadata Cache. In the above example, if the memory usage of Metadata Cache reaches 90% of the allocated memory (40M X 90% = 36M), the BCS will start to purge the less frequently used items until the memory usage reaches ItemEmptyThreshold.
MemoryEmptyThreshold
Specifies how empty the metadata cache should be purged to. In the above example, if the memory usage of Metadata Cache reaches 85% of the allocated memory (40M X 85% = 34M), the BCS will stop purging.

Row Cache Section

This section specifies how rows (records) are cached. There are 4 items in the section. The following is an example of the section contents.

        [Row Cache]
        NumberOfItems =   21600000
        Memory = 330
        MemoryFullThreshold = 92
        MemoryEmptyThreshold = 87

See Metadata Cache section above for the meanings of each item.

Result Cache Section

This section specifies how groups of rows (records) are cached. There are 4 items in the section. The following is an example of the section contents.

        [Result Cache]
        NumberOfItems = 7000000
        Memory = 40
        MemoryFullThreshold = 95
        MemoryEmptyThreshold = 80

See Metadata Cache section above for the meanings of each item.

Compressed Cache Section

When the memory usages of Metadata Cache, Row Cache and/ or Result Cache reaches the threshold specified by MemoryFullThreshold, the less frequently used items will be purged into Compressed Cache. If those purged items are reused, those items are put back into the corresponding caches (Metadata Cache, Row Cache, or Result Cache).

        [Compressed Cache]
        Memory = 360
        MemoryFullThreshold = 93
        MemoryEmptyThreshold = 88

See Metadata Cache section above for the meanings of each item.

Uncompressed Cache Section

Uncompressed Cache is a temporary buffer for decompressing Compressed Cache items.

        [Uncompressed Cache]
        Memory = 50
        MemoryFullThreshold = 75
        MemoryEmptyThreshold = 55

See Metadata Cache section above for the meanings of each item.

SpeedyDB Manager Section

This section is used to configure the user name and password for SpeedyDB Manager (A tool used to monitor DB-WAN-Accel).

There are 2 items in this section. The following is an example of the section contents:

        [SpeedyDB Manager]
        UserName=SpeedyDB
        Password=SpeedyDB

UserName
User Name for SpeedyDB Manager.
Password
Password for SpeedyDB Manager.

The UserName and Password in this section correspond to the User Name and Password on the form to follow.

A monitor for DB-WAN-Accel (the WAN Accelerator for SQL Server, Oracle, DB2, MySql etc).

A monitor for DB-WAN-Accel (the WAN Accelerator for SQL Server, Oracle, DB2, MySql etc).