Some of SynWeb's settings can be configured within SynWeb.
...
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 Name | Name of the database. |
| Database Schema Finance | Finance database schema when the application is running using a single database. The default value is Finance. |
| 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:
Note: When using SAML, values are required for OverrideUserName, OverridePassword, SAMLSSOHttpUrl, SAMLLogoutHttpUrl, SynWebLoginHttpUrl and ClaimAttributeName. Note: You may require additional network configuration for the W, WP and BW authentication modes. Contact Synergetic Support for more information. |
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. Note: For security purposes, this should be set to 0 unless you are diagnosing a problem. |
Show Detailed DB Errors Flag | Set to 1 to display detailed errors from the database. Note: For security purposes, this should be set to 0 unless you are diagnosing a problem. |
Show Exception Stack Trace Flag | Set to 1 to display detailed error-tracing information. Note: For security purposes, this should be set to 0 unless you are diagnosing a problem. |
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 |
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 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. Note: This overwrites any domain name typed in by the user. |
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. Note: This setting and the following four settings are not used by SynWeb. |
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. Note: This setting and the following three settings are used for the Synergetic Web Service and do not affect SynWeb. |
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. |
| SAML Login Binding | Binding method used to send the login request to the IdP (third-party SAML based identity provider). Methods include:
|
| SAML Logout Binding | Binding method used to send the logout request to the IdP (third-party SAML based identity provider). Methods include:
|
| SAML Login Destination | IdP URL the authentication request can be sent to, originating from the SP (service provider). |
| SAML Logout Destination | Logout URL of the IdP, used to send the SAML logout request and terminate the session from the SP (service provider). Important: The endpoint must support Single Sign Out. |
SAML Login X509 Certificate Path | Path of the SAML signing certificate used to authenticate the messages from the IdP. Usual example (including tilde prefix): ~/Site/Certificates/yourcertname.crt |
| SAML Logout X509 Certificate Path | Path of the certificate used to sign the logout request being sent out to the IdP. This is most likely a private key (.pfx) file. |
| SAML Logout X509 Certificate Private Key Password | Private key used to utilise the certificate to sign the request. The key must be encoded using the Portal/SynWeb Configuration tool. |
| SAMLSP Issuer | Issuer URI which is sent with every request for the IdP to verify. |
| SAMLIDP User Home Page Url | URL of the login page of the IdP, used if there is a logout failure. The link is used to redirect the user so they can logout manually. |
| SAMLComparisonMode | Mode used to evaluate authentication responses received from the IdP. Note: The default value is exact. |
| SAMLRequestedAuthnContexts | Comma-separated list of authorisation contexts included in the authentication request sent out to the IdP. Note: The default is password. |
AAD Instance | Instance of the Azure Active Directory Note: This setting and the following four settings are used for AAD authentication. This is an unsupported feature. |
Tenant | Tenant domain name. |
Client Id | Client id. |
App Resource Id | Application resource id. |
App Base Address | Base address (url) for the application. |
| Database Pool Enabled Flag | Whether to allow database connection pooling. Type:
|
| Database Pool Size Max | Maximum number of connections allowed in the pool. |
| Database Pool Size Min | Minimum number of connections the pool must maintain. |
| Multi Subnet Failover Enabled Flag | Whether multi subnet failover is enabled. |
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. |
WebServiceDataSetName | The top-level XML data set name for web service output. |
WebServiceDataTableName | 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. |
.gif)
...