Connection Setup & Advanced Setup
DESKTOP CLIENT GUIDE


Connection Setup
Purpose
You can create a connection to various data sources using the Connection Builder Wizard. You must have Admin rights to create a new connection.

To get to Connection Setup from the Synoptix control panel, click Admin in the Setup group, then click the Connection Setup tab.


   

Click Add at lower right of the window to enter the Connection Builder Wizard. The Connection Name and Type Setup dialog box displays.

   

Definitions
Company/Connection Name: Name your connection. You can use your company's name, or any other name desired.

Host Package: Select your accounting package/database software.

Click Next. The Host Connection Setup dialog box displays, which allows you to enter connection parameters for the database containing your financial or other data.

The dialog box pictured below is for connecting to MS SQL Server. However, connection parameters show may vary depending on the database you're connecting to.

   

Definitions
These definitions refer to information required for MS SQL Server.

Database Server Name/IP Address: This is the unique name or IP address of the computer the database server is installed on. The name should be entered with no backslashes.

Port #: This is the port number used to address this instance of the database server. Most database installations have a default port that is used upon installation. The default port is initially displayed here. Unless your company's port number has been changed, use the default port number.

User Name: This is the database user name the software will use to login to the database server. You may use any user name that has access to the database, for example, the user name that your accounting system uses. However, for the highest level of security it's recommended you use a user that has Read Only access to the database.

Password: This is the password that corresponds to the above user name.

Host Database Container Name: This is the unique database container name as specified by the database software selected.It  should be the name of the database containing data for this company.

Click Next. The General Preferences Setup dialog box displays.

   

Definitions
Home Currency: Select the desired currency for the connection.

Click Next. The Host Specifics Setup dialog box displays.

   

This last dialog box may allow you to enter specific parameters based on the accounting package you are connecting to. These parameters may include currencies, ledgers, entities and account masks. Refer to the specific dialog box on your screen for additional information.

When any additional parameters have been entered, click Finish to save your connection and exit the Connection Builder Wizard.


Definitions
Back: Click Back to make changes before saving your connection.

Finish: Click Finish to save your connection and exit the Connection Builder Wizard.

Cancel: Click Cancel to close the Wizard without saving your connection.


Advanced Setup

Purpose

The purpose of Advanced Setup is to set the maximum amount of memory and database connections the software uses. To get to the Advanced Setup tab, from the Synoptix desktop client control panel, go to Setup > Admin > Advanced Setup.

   


Definitions
Maximum Memory Used: This is the amount of allocated memory, in MB. The software allows you to set the maximum amount of memory it can use. This prevents the computer from locking up if a user creates a report which uses more RAM then the computer has available. The number this field is set to depends on how much overall RAM the computer has installed. As a general rule, the minimum value should be around 512 MB, but depending on the size and type of reports being run, this could be much higher. If you try to run a large report and it does not complete, you may want to increase the Maximum Memory Used, log out and log back in, then try running the report again.

Optimize Memory: Optimize Memory notes your computer’s available memory and allocates half, to a maximum of 4096MB, for use by the software. While Optimize Memory will not automatically set a maximum over 4096MB, you can manually enter a larger amount. Regardless of which method you choose, click OK to save changes and use that amount.

Reports DB Max Connections: This is the maximum number of connections the software can open to the report definitions database. Setting this to 150 is usually adequate. As a general rule, the software attempts to open two simultaneous connections for every report it runs.

Set Connections By: You have the ability to set database connection parameters either by Company or by Database. Usually, setting connections by Company is sufficient. However, if number of connections is a concern and/or you have multiple companies on a single database server, you may want to use the Database option.

Maximum Connections to Database: This is the total number of connections the software is able to open to a company or database at any given time. Based on the way various reports are constructed, this number can be changed to maximize performance. A typical value is 25, but it can vary significantly depending on your database's configuration.

Connections Left Open: This is the number of database connections left open after a report has been run. It takes time to open a connection, so leaving some open speeds the running of subsequent reports. Setting this to a value somewhere between 1 and the value set for Maximum Connections is generally sufficient.


This guide applies to Synoptix version 7 and 8


Forum Jump:

Forum Software: MyBB© 2002-2022 MyBB Group.