Some of SynWeb's settings can be configured within SynWeb.
With the SynWeb Settings window, you can change the:
...
Note: The SynWeb Settings window can only be accessed by an administrator.
Other settings for SynWeb must be configured with Synergetic. See the Synergetic System maintenance manual.
Note: If you have recently altered SynWeb configuration settings in Synergetic and cannot see the changes, click System > Reload Configuration Settings to refresh the SynWeb Settings window and reload the current window.
| Anchor | ||||
|---|---|---|---|---|
|
You can also customise the look and feel of SynWeb by creating custom CSS files. See Customising SynWeb CSS
| Anchor | ||||
|---|---|---|---|---|
|
| Expand | ||
|---|---|---|
| ||
To open the SynWeb Settings window:
|
SynWeb Settings window key fields and buttons
Fields
Field | Description | ||||||
|---|---|---|---|---|---|---|---|
Config File | Location of the SynWeb configuration file. | ||||||
User Name | Your Synergetic user name. | ||||||
User ID | Your Synergetic ID. | ||||||
Windows User Name | Your Windows user name. | ||||||
SynWeb Version | Version of SynWeb your organisation is running. | ||||||
Client Machine Name | Name of the computer SynWeb is open on. | ||||||
Database User Name | Your database username. | ||||||
Database Server | Name of the database server. | ||||||
Database Server Finance | Name of the financial database server. | ||||||
Database Server Media | Name of the media database server. | ||||||
Database Name | Name of the database. | ||||||
Database Name Finance | Name of the financial database. | ||||||
Database Name Media | Name of the media database. | ||||||
Database Schema Finance | Finance database schema when the application is running using a single database. | ||||||
Single Database Flag | Whether the application is running using a single database. | ||||||
Report Database Server | Name of the reports database server. | ||||||
Reports Path | Location of the reports run by Crystal Reports. | ||||||
Reports User Name | User name used to connect to Crystal Reports. | ||||||
Reports Password | Password used to connect to Crystal Reports. | ||||||
Authentication Mode | Authentication mode used by SynWeb:
| ||||||
Mode B_ Comment | Comment to explain authentication mode B. | ||||||
Mode S_ Comment | Comment to explain authentication mode S. | ||||||
Mode W_ Comment | Comment to explain authentication mode W. | ||||||
Mode WP_ Comment | Comment to explain authentication mode WP. | ||||||
Mode BP_ Comment | Comment to explain authentication mode BP. | ||||||
Mode WPI_ Comment | Comment to explain authentication mode WPI. | ||||||
Mode STP_ Comment | Comment to explain authentication mode STP. | ||||||
Mode SAML_Comment | Comment to explain authentication mode SAML. | ||||||
Mode AAD_Comment | Comment to explain authentication mode AAD. | ||||||
Show Connection String if Login Error Flag | Set to 1 to display the database connection string when a login error occurs. | ||||||
Show Detailed DB Errors Flag | Set to 1 to display detailed errors from the database. | ||||||
Show Exception Stack Trace Flag | Set to 1 to display detailed error-tracing information. | ||||||
Config Description | Text to appear in the web browser title bar and at the top of the login prompt. | ||||||
Login Message | Message displayed beneath the
 button when users log into SynWeb. | ||||||
Header Colour | Colour of the banner at the top of SynWeb. | ||||||
Menu Colour | Colour of the menu bar at the top of SynWeb. | ||||||
Title Image Left URL | URL (Universal Resource Location) of the image that appears in the top left of SynWeb. | ||||||
Title Image Right URL | URL of the image that appears in the top right of SynWeb. | ||||||
Synergetic Web Service Authorisation Url | Synergetic Authorisation web service URL provided by Synergetic for API integration. | ||||||
Synergetic Web Service Authorisation Vendor Token Guid | Synergetic Authorisation web service vendor token GUID provided by Synergetic for API integration. | ||||||
Synergetic Web Service Authorisation Vendor Password | Synergetic Authorisation web service vendor password provided by Synergetic for API integration. | ||||||
Web Service Administration Product Flag | Cut down version of SynWeb to maintain web services only. Value will be set by Synergetic as required. | ||||||
Domain Name Prefix | The domain name used to connect to the database when using the WPI (Windows Authentication impersonation) authentication mode. | ||||||
Domain Name Prefix_Comment | Comment to explain the Domain Name Prefix. | ||||||
Config Group Security Groups CSV | Comma-separated list of groups to restrict permissions to certain sections of SynWeb in certain circumstances. For example, to prevent a teacher marking attendances from home. | ||||||
Config Group Security Groups CSV_Comment | Comment to explain the Config Group Security Groups CSV setting. | ||||||
Default Page | The default starting page when using these authentication credentials. | ||||||
Default Page_Comment | Comment to explain the Default Page. | ||||||
Multi Tenant Application Flag | Whether the application is running under multi-tenant mode or not. Value provided by Synergetic. | ||||||
User Form Simple Enable Query Flag | Used for user form simple, provided by Synergetic, value provided by Synergetic. | ||||||
User Form Simple Sql User Name | SQL username for user form simple. | ||||||
User Form Simple Sql Password | SQL user password for user form simple. | ||||||
Recaptcha Public Key | Recaptcha public key for user form simple. | ||||||
Recaptcha Private Key | Recaptcha private key for user form simple. | ||||||
Recaptcha Enabled Flag | Recaptcha enabled flag for user form simple. | ||||||
Recaptcha Url for Verification | Recaptcha verification URL for user form simple. | ||||||
Poke Ssrs On Start Up Flag | Start SSRS service on SynWeb start-up to allow for faster access to SSRS reports. | ||||||
Web Service Mobile Sqlite Session Seconds | Mobile web service session seconds. | ||||||
Web Service Mobile Sqlite Path | Mobile web service SQL Lite database path. | ||||||
Web Service Mobile Encryption Mode | Mobile web service encryption mode. | ||||||
Web Service Mobile Encryption Mode_Comment | Comment to explain the Web Service Mobile Encryption Mode setting. | ||||||
Syn API Address | SynAPI (Custom web service) address for testing from SynWeb. | ||||||
Syn API Vendor Token GUID | SynAPI (Custom web service) vendor GUID for testing from SynWeb. | ||||||
Syn API Vendor Password | SynAPI (Custom web service) vendor password for testing from SynWeb. | ||||||
SAMLSSO Http Url | SAML Single Sign On URL when using SAML authentication mode. | ||||||
SAML Logout Http Url | SAML Logout URL when using SAML authentication mode. | ||||||
SAMLX509 Certificate Path | SAML X509 certificate path when using SAML authentication mode. | ||||||
SAML Request Format | Request format when using SAML authentication mode. | ||||||
Syn Web Login Http Url | SynWeb login URL when using SAML authentication mode. | ||||||
Claim Attribute Name | Name of the claim attribute. | ||||||
AAD Instance | Instance of the Azure Active Directory. | ||||||
Tenant | Tenant domain name. | ||||||
Client Id | Client id. | ||||||
App Resource Id | Application resource id. | ||||||
App Base Address | Base address (url) for the application. |
SynAPI fields
Note: The following fields are only used by SynAPI.
Field | Description |
|---|---|
Web Service SQL User Name | User name used by web services or third party applications when connecting to the database. |
Web Service SQL Password | Password used by web services or third party applications when connecting to the database. |
WebServiceData-SetName | The top-level XML data set name for web service output. |
WebServiceData-TableName | The top-level XML data table name for web service output. |
Study period fields
Note: The following fields are only used by Study Period.
Field | Description |
|---|---|
Override User Name | User name to connect to the database when using anonymous authentication for student sign in. |
Override Password | Password to connect to the database when using anonymous authentication for student sign in. |
Override User Name_Comment | Comment to explain the Override User Name. |
Override App Role | Database role used to limit access to SynWeb when using anonymous authentication. |
Override App Role Password | Database password used to limit access to SynWeb when using anonymous authentication. |
Override App Role_Comment | Comment to explain the Override App Role. |
Buttons
Button | Description |
| Save changes to the configuration settings. |
