The SYNCHRO Server is controlled by a configuration files: config.xml which is located in the application installation directory.
A default configuration file is installed with the SYNCHRO Server product fully configured with default settings to allow a single concurrent client to connect to the default “Example” project when the SYNCHRO Server is started
The files contain instructions, called directives, that tell the Server how to run. The file is in an XML format so its easy to edit the configuration by hand.
Tip: | Remember to make a back-up copies of your configuration files, in case one of the changes you make while experimenting renders the server inoperable. Also, remember that configuration changes you make don't take effect until you restart the server. |
The SYNCHRO Server XML file is composed of a simple set of XML Tags (the markup constructs that begin with "<" and end with ">" characters) and Elements (the information between tags). In the following sections each element is described by its tags and allowed contents.
The Appendices provides an example config.xml file for reference, and a formal description of the XML
Note: | As with any XML document, all tag names are Case Sensitive... |
The following configuration option should appear in the config.xml file once:
Tag: |
Type: |
Usage: |
Notes |
---|---|---|---|
port |
INTEGER |
The listening port that clients will connect on. |
Firewalls and other security software must be configured to allow access to the server process on this port. |
directory |
TEXT |
The directory that will be used as a base directory for all the projects being run on this server |
|
The SYNCHRO Server can manage multiple projects. The configuration for each project is defined within the project element. There should be one project element for each project.
The following configuration option should appear in the config.xml file once within project tags.
Tag: |
Type: |
Usage: |
Notes: |
---|---|---|---|
name |
TEXT |
Defines not only the directory (within the base directory, described above) that will be used for all the project information, but also the project name that clients MUST use to connect to this project. Project Names are case sensitive. All files relating to a project are contained within this directory - |
For backup purposes backup the whole directory |
Each project record contains exactly one <journalsettings> tag which describes the journal policy. Inside this tag the following records are available: |
|||
checkpointlimit |
INTEGER |
Defines the number of checkpoints the server will store. This number should be not less than 1. Otherwise default value of 100 is utilized. Once this threshold is exceeded, redundant checkpoints will be cleared when no clients are connected to server |
|
transactionstocheckpointratiothreshold |
REAL |
Defines the relation of size of stored transactions to size of checkpoint. This ration should be non-negative, otherwise default value of 1.0 is utilized. Exceeding this threshold is a reason to create new checkpoint |
|
transactionsizethreshold |
INTEGER |
Defines the relation of size of transactions in MB. This size should be non-negative, otherwise default value of 50 MB is utilized. Exceeding this threshold is a reason to create new checkpoint |
|
transactionsnumberthreshold |
INTEGER |
Forces SWP to create checkpoint after certain amount of transactions are processed. Special value -1 means: ignore this option - checkpoints will be created based on other options |
|
journalsizesoftlimit |
INTEGER |
Defines the size of journal (both transactions and checkpoints) in MB. This size should be non-negative, otherwise default value of 1000MB is utilized. Exceeding this threshold is a reason to clear the journal when no clients are connected to server |
|
journalsizehardlimit |
INTEGER |
Defines the size of journal (both transactions and checkpoints) in MB. This size should be non-negative, otherwise default value of 2000MB is utilized. Exceeding this threshold is a reason to clear the journal immediately. Server will stop and clear the journal up to soft limit before continue. |
|
Under <SynchroServer> (root) tag following options can be added: |
|||
<objectNumberThreshold> |
INTEGER |
database cache cleanup is allowed to happen when certain amount of objects are loaded and ready-to-release, default value is 10000. This is advanced database cache parameter and it is not recommended to play with it wihtout special need.
|
|
<memoryThreshold> |
INTEGER |
memory size in MB occupied by SWP process that should lead to database cache cleanup (maximum expected memory usage). This is advanced database cache parameter and it is not recommended to play with it wihtout special need. Default value is 6000.
|
|
<releaseThreshold> |
INTEGER |
memory size in MB that is allowed to stay once cleanup is performed. This is advanced database cache parameter and it is not recommended to play with it without special need. Default value is 3000.
|
|
Short example on the parameters described above. For example user tries to deploy the relatively big SP file into the database. Server starts to deploy and creates some objects, which of course consume memory. At some point memory consumption hit the limit <memoryThreshold> and the number of objects that are not currently used exceeds 10000 (which is true for most cases). SWP will perform cache cleanup and release unused objects untill the amount of memory consumed will not decrease beyond <releaseThreshold>. This may happen several times during deployment process. Memory consumption plot will look like a saw in this case. |
|||
<LDAPHost> |
STRING |
the same as "Host name or IP address" option in synchro LDAP options (Options->General->LDAP Authentification Server).
|
|
<LDAPDN> |
STRING |
the same as "Base DN" option in synchro LDAP options (Options->General->LDAP Authentification Server). |
|
<LDAPUsernameAttributeName> |
STRING |
the same as "Username attribute" option in synchro LDAP options (Options->General->LDAP Authentification Server).
|
|
<LDAPPort> |
INTEGER |
the same as "Port" option in synchro LDAP options (Options->General->LDAP Authentification Server).
|
|
Those options duplicate the options defined in PRO to access to LDAP server to import/login the users in order for SWP to be able to perform login for LDAP users.
|
A Log message is generated on SYNCHRO Server startup for each project that has invalid checkpoint settings, in this scenario the project will be started with the default settings, described above.