Appendix. Sage Sage SQL Gateway, Executive Dashboard Add-on
Advertisement
Advertisement
Sage SQL Gateway with Sage Executive Dashboard Appendix
Appendix
Supported Configurations
The following configurations are supported with Sage SQL Gateway and the
Executive Dashboard add-on. The Executive Dashboard application can be installed on any computer that can connect to the SQL Server instance.
Configuration 1
Installed on this machine:
• Windows server or client OS
• Sage 300 CRE Server
• SQL Server or SQL Express
• Sage SQL Gateway and the
Executive Dashboard add-on
Sage 300 CRE data
SQL data warehouse
NOTES:
•
If you install SQL Server Standard or Enterprise, you might need to adjust memory
usage to avoid performance degradation. This is explained on page 55.
•
With this configuration, no additional expense is incurred if you use SQL Express, or if a Standard or Enterprise license is already available.
Configuration 2
Installed on Machine 1:
• Windows server OS
• Sage 300 CRE Server
• Sage SQL Gateway and the
Executive Dashboard add-on
Installed on Machine 2:
• Windows server or client OS
• SQL Server Standard or
SQL Express
NOTES:
•
See “Checklist: Implementing Configuration 2” on page 56.
•
In this configuration, data travels over the network (from the Pervasive database on
Machine 1 to the SQL Server database on Machine 2). This can impact performance.
•
If Machine 2 runs on Windows 7 or 8, you can use SQL Express or
SQL Server Standard. If you use the latter, consider capping the maximum memory
available to the instance. (See “Adjust Memory Usage in SQL Server” on page 55.)
© 2015 Sage Software, Inc.
43
Appendix
Configuration 3
Sage SQL Gateway
Installed on Machine 1:
• Windows server OS
• Sage 300 CRE Server
Installed on Machine 2:
• Windows server OS
• SQL Server or SQL Express
• Sage SQL Gateway and the
Executive Dashboard add-on
• Sage 300 CRE Workstation
NOTES:
•
See “Checklist: Implementing Configuration 3” on page 57.
•
On Machine 2, the workstation edition of Sage 300 Construction and Real Estate must be installed.
•
This configuration requires a workstation installation of Sage 300 Construction and
Real Estate.
Configuration 4
Installed on Machine 1:
• Windows server OS
• Sage 300 CRE Server
Installed on Machine 2:
• Windows server OS
• Sage 300 CRE Workstation
• Sage SQL Gateway and the
Executive Dashboard add-on
Installed on Machine 3:
• Windows server or client OS
• SQL Server or SQL Express
NOTES:
•
See “Checklist: Implementing Configuration 4” on page 58.
•
This configuration incurs double the network traffic required for replication.
•
Machine 2 requires a workstation installation of Sage 300 Construction and
Real Estate.
44 © 2015 Sage Software, Inc.
Sage SQL Gateway with Sage Executive Dashboard Appendix
Time Required for Replication
The amount of time required for replications depends on several factors:
The amount of memory (RAM) available to SQL Server. If you use
SQL Express (the version installed by the Sage SQL Gateway wizard), the amount of RAM that can be accessed is limited by the program itself. If you use the Standard or Enterprise editions of SQL Server, you can adjust the memory
The server’s processor (CPU) speed can significantly reduce replication time.
The Sage 300 Construction and Real Estate User Guide lists the minimum processor as a dual-core 2.4 GHz. If you installed Sage SQL Gateway and
SQL Server on the same server as the Sage 300 Construction and Real Estate server, a more robust processor will result in better replication times.
If you selected a configuration that distributes the Sage SQL Gateway components across more than one computer (Configurations 2 through 4 list in
“Supported Configurations” on page 43), your network bandwidth will be a
factor in replication time. Configuration 4 incurs double the network traffic as
Configurations 2 or 3.
Finally, the size of your database is an important factor in replication time.
Moving closed jobs and transactions to an archive folder, or excluding history or other tables from replication, can improve performance.
© 2015 Sage Software, Inc.
45
Appendix Sage SQL Gateway
System Specifications
Depending on the configuration you select, verify that all systems in your
Sage SQL Gateway implementation have sufficient resources.
For performance and reliability, we strongly suggest solid state hard drives
(SSD) with at least 100 MB/s read-write speed for SQL Server database storage.
On the computer that runs SQL Server, sufficient hard disk space must be available for additional copies of your Sage 300 Construction and Real Estate database created during replication.
The amount of free space needed will depend on the current size of your database plus anticipated growth.
When you replicate your data, selecting both
Classic
and
Modern
views
will increase the amount of free space needed. (See page 40.)
This table shows the minimum requirements for the Sage SQL Gateway server, not including Sage 300 Construction and Real Estate.
WARNING:
The User’s Guide for Sage 300 Construction and Real Estate lists minimum server hardware and resources. If you install SQL Server and Sage SQL Gateway on the production server, extra hard disk space and RAM will be needed. Verify that your current server has sufficient resources for the additional load.
Sage SQL Gateway Requirements
Operating System If Sage 300 Construction and Real Estate 13.1 Rev 5 is installed, you can use:
Windows 7 (32bit or 64bit)
Windows 8 (32bit or 64bit)
Windows Server 2008 R2
Windows Server 2012
If Sage 300 Construction and Real Estate 14.1 is installed, you can also use:
Windows 8.1 (32bit or 64bit)
Windows Server 2012 R2
NOTE:
Apply all security updates to the operating system.
SQL Server or
SQL Express
SQL Server 2012 with Service Pack 1 or
SQL Server 2014
NOTES:
•
Apply all security updates to SQL Server.
•
SQL Server 2012 requires Service Pack 1 to be applied to
Windows 7 and to Windows Server 2008 R2.
•
It also requires that .NET Framework 3.5 with Service
Pack 1 be enabled. See page 8 for more information.
46 © 2015 Sage Software, Inc.
Sage SQL Gateway with Sage Executive Dashboard Appendix
Sage SQL Gateway Requirements
Microsoft .NET
Framework
Version 3.5 with SP1 is required by SQL Server 2012.
Version 4.51 is required by Sage SQL Gateway, and is installed if not already present.
NOTE:
Apply all security updates to .NET.
Microsoft Windows
Installer
TCP/IP
Firewall Exceptions
Version 3.5 is automatically installed during
Sage SQL Gateway installation if not already present.
Communication protocol used by Sage SQL Gateway.
Create an exclusion for the incoming SQL Server traffic. To use automatic notifications, also create an exclusion for the outgoing email server.
Sage 300 Construction and Real Estate
Version 13.1 Rev 5 or later is required. Earlier versions will not work with Sage SQL Gateway.
Executive Dashboard Requirements
Operating System
Other settings
Windows 7 (32bit or 64bit)
Windows 8 (32bit or 64bit)
Microsoft Windows Server 2008 R2
Microsoft Windows Server 2012
NOTE:
Apply all security updates to the operating system.
You do not need to install Sage 300 Construction and
Real Estate, Sage SQL Gateway, or SQL Server on computers that will run Executive Dashboard.
About SQL Server
We strongly recommend that you allow the Sage SQL Gateway installation routine
to install and configure the SQL Server instance for you (as described on page 14).
If you decide to install SQL Server yourself, read this section and follow the installation instructions carefully.
Do not use an Existing Instance
Sage SQL Gateway has special server collation requirements, so existing instances are unlikely to be configured correctly. Also, Sage SQL Gateway routinely creates and deletes warehouse and intermediary databases as part of normal processing. For this reason, do not use an existing SQL Server instance with Sage SQL Gateway.
If you already have SQL Server installed on your server, plan to install a new instance or select an installation option that installs SQL Express for you (explained
© 2015 Sage Software, Inc.
47
Appendix Sage SQL Gateway
Supported Versions of SQL Server
We support SQL Server 2012 with Server Pack 1 and SQL Server 2014. The 32-bit or 64-bit options are supported, and you can select the Express, Standard, or
Enterprise editions.
NOTE:
We do not support SQL Server versions 2008 or 2008 R2.
Selecting the Express, Standard, or Enterprise Edition
Choosing the SQL Express edition for Sage SQL Gateway can be a cost-effective way to implement the utility, but you should consider the limitations of the no-cost editions. Databases larger than 10 gigabytes are not supported, and the Express edition is limited in the amount of CPU and RAM resources it can access.
If the combined size of the Sage 300 Construction and Real Estate company folders you will use with Sage SQL Gateway is currently near or above the 10 gigabyte limit, you’ll need to purchase the Standard or Enterprise edition of SQL Server.
To Install SQL Server
The sequence and content of the SQL Server installation screens vary according to the version and edition you select. Start the installation and follow the wizard.
Several of the screens shown in this document require special settings, and they might not appear in the sequence shown.As you proceed through the installation wizard, verify that you have established the required settings for the current screen before moving to subsequent screens.
Instance Configuration
Service accounts
Setup role
Feature selection
Server collation
Account provisioning
WARNING:
The most critical configuration step for Sage SQL Gateway’s SQL Server
installation, you will need to re-install the instance.
48 © 2015 Sage Software, Inc.
Sage SQL Gateway with Sage Executive Dashboard Appendix
Setup Role
In the
Setup Role
window, select
SQL Server Feature Installation
.
WARNING:
If you select
All Features With Defaults
, your instance settings will not be compatible with Sage SQL Gateway.
Feature Selection
In the
Feature Selection
window, the options vary based on the SQL Server edition.
The minimum features required for Sage SQL Gateway are:
Database Engine Services
Management Tools - Basic
© 2015 Sage Software, Inc.
49
Appendix Sage SQL Gateway
Instance Configuration
You can use a default or named instance as the Sage SQL Gateway instance. A specific name is not required—you can assign any name to it.
50 © 2015 Sage Software, Inc.
Sage SQL Gateway with Sage Executive Dashboard Appendix
Server Collation
WARNING:
This is the most critical configuration step for Sage SQL Gateway’s
SQL Server instance. Follow these instructions exactly. If you do not set the collation correctly during installation, you will need to re-install the instance.
On the
Server Configuration > Collation
tab, the collation must be set to
Latin1_General_CS_AS
. This must be set at the instance level.
1.
2.
In the
Server Configuration > Collation
window, click
Customize
.
Select
Windows collation designator and sort order
.
3.
4.
In the
Collation designator
list, select
Latin1_General
.
Select the following two check boxes:
Case-sensitive
Accent-sensitive
© 2015 Sage Software, Inc.
51
Appendix Sage SQL Gateway
Service Accounts
On the
Server Configuration > Service Accounts
tab, provide an account name for each of the services. If this is a named instance, set the
Startup Type
for the
SQL Server Browser
service to
Automatic
.
Account Provisioning
1.
2.
On the
Database Engine Configuration > Account Provisioning
tab, select
Mixed Mode
.
Enter a password for the SQL Server system administrator’s account (
sa
.)
52
3.
4.
Click
Add Current User
to add the current Windows account as a SQL Server administrator. (This Windows user must have permissions to access the default data and backup locations.)
Additionally, click
Add
to add another user as an administrator.
© 2015 Sage Software, Inc.
Sage SQL Gateway with Sage Executive Dashboard
Configure TCP/IP
After the installation is finished, configure the communication protocol.
1.
2.
Open the configuration manager by selecting
Start > All Programs >
Microsoft SQL Server [2012 or 2014]> Configuration Tools >
SQL Server Configuration Manager
.
Expand
SQL Server Network Configuration
.
Appendix
3.
4.
Click the instance associated with Sage SQL Gateway.
Verify that the
TCP/IP
protocol is
Enabled
, and disable all other protocols.
When you make changes to the protocols, you’ll see this message:
5.
6.
7.
8.
Click
Yes
. You’ll restart the services when you are finished.
In the same window, expand
SQL Native Client 11.0 Configuration
and click
Client Protocols
To restart the
SQL Server
services, open the
Services
window. Depending on your operating system, you can find this by selecting
Start >
Administrative Tools > Services
; or by selecting
Start > Control Panel
and typing
Services
in the search field.
Scroll down to the SQL Server services and restart each service for the
Sage SQL Gateway instance.
© 2015 Sage Software, Inc.
53
Appendix Sage SQL Gateway
Set the Default Data Location
1.
2.
In SQL Server Management Studio, right-click the database engine and select
Properties
.
Click
Database Settings
.
54
3.
Next to
Data
,
Log
, and
Backup
, select the location for your data warehouse files. For best performance, we recommend that you:
Set
Data
,
Log
, and
Backup
locations on 3 separate physical drives.
Store the production database (
Data
) and log (
Log
) on SSD hard drives.
© 2015 Sage Software, Inc.
Sage SQL Gateway with Sage Executive Dashboard Appendix
Adjust Memory Usage in SQL Server
When you install the Standard or Enterprise editions of SQL Server, the instance is configured to use all available memory on the server by default. To avoid performance degradation of the operating system, SQL Server, or other functionality on the server, cap the memory available to SQL Server.
WARNING:
Only system administrators with experience managing servers should change memory usage settings. The appropriate maximum memory usage will be unique to your situation, as it depends on the total hardware resources available and the other functions performed by this server.
To adjust memory usage:
1.
In SQL Server Management Studio, right-click the database engine and select
Properties
.
2.
3.
In the
Server Properties
window, click
Memory
.
Set the
Maximum Server Memory
as needed.
2 billion MB = 2,000 GB
Typical servers might have 8 or 16 GB RAM
(approximately 8,000 or 16,000 MB). Enter a number in the appropriate range to effectively limit SQL Server. For example, entering
6,144
limits SQL Server to 6 GB.
TIPS:
•
The
Maximum Server Memory
reflects the amount of memory that SQL Server potentially can use—not the amount of memory available to the computer.
•
This number is expressed in megabytes (MB). The default value for this field—more than 2 billion—is equivalent to two terabytes (TB) of memory. A reasonable entry for a server with 8GB RAM is
6,144
MB, or 6 GB, leaving 2 GB for the operating system.
© 2015 Sage Software, Inc.
55
Appendix Sage SQL Gateway
Checklist: Implementing Configuration 2
Installed on Machine 1:
• Windows server OS
• Sage 300 CRE Server
• Sage SQL Gateway and the
Executive Dashboard add-on
Installed on Machine 2:
• Windows server or client OS
• SQL Server Standard or
SQL Express
1.
2.
3.
4.
5.
6.
7.
On
Machine 1
, complete “Sage 300 Construction and Real Estate Tasks” on
page 11, and “Sage SQL Gateway server tasks” on page 12.
On
Machine 2
, complete “Microsoft SQL Server machine tasks” on page 13.
If you will install SQL Server 2012 on your own, install it now on
Machine 2
Otherwise, download the Sage SQL Gateway installation file and open it. Select only the last check box and complete the SQL Express installation.
❑
Sage SQL Gateway
❑
Executive Dashboard Add-on
✔
SQL Server 2012 Express
On
Machine 1
, open the Sage SQL Gateway installation file. If you see a
SQL Express option, clear the last check box and complete the installation.
✔
Sage SQL Gateway
✔
Executive Dashboard Add-on
❑
SQL Server 2012 Express
On
Machine 1
, open Sage SQL Gateway. Enter
[Machine 2]\sagesqlgateway
(or the applicable instance name if you installed SQL Server on your own).
Select the check box to use your Windows credentials, and click
Log on
.
If the logon fails, verify each item shown here. The first list applies to
Machine 2
, and the second list applies to
Machine 1
.
56
8.
Click
Yes
to the messages about configuring the instance and enabling the
Executive Dashboard add-on. Configure warehouses as needed.
© 2015 Sage Software, Inc.
Sage SQL Gateway with Sage Executive Dashboard
Checklist: Implementing Configuration 3
Appendix
Installed on Machine 1:
• Windows server OS
• Sage 300 CRE Server
Installed on Machine 2:
• Windows server OS
• SQL Server or SQL Express
• Sage SQL Gateway and the
Executive Dashboard add-on
• Sage 300 CRE Workstation
1.
2.
3.
4.
5.
6.
7.
On
Machine 1
, complete “Sage 300 Construction and Real Estate Tasks” on page 11.
On
Machine 2
:
Complete “Sage SQL Gateway server tasks” on page 12, including the
client installation of Sage 300 Construction and Real Estate.
Complete “Microsoft SQL Server machine tasks” on page 13.
If you will install SQL Server 2012 on your own, install it now on
Machine 2
Download the Sage SQL Gateway installation file and open it. If you downloaded a SQL Express option, you see three check boxes. If you’ve already installed SQL Server 2012, clear the last check box. Otherwise, leave it selected and complete the installation.
✔
Sage SQL Gateway
✔
Executive Dashboard Add-on
✔
SQL Server 2012 Express
Open Sage SQL Gateway. Enter
[Machine 2]\sagesqlgateway
(or the applicable instance name if you installed SQL Server on your own).
Select the check box to use your Windows credentials, and click
Log on
.
If the logon fails, verify each item shown here. (Both lists apply to
Machine 2
.)
8.
Click
Yes
to the messages about configuring the instance and enabling the
Executive Dashboard add-on. Configure warehouses as needed.
© 2015 Sage Software, Inc.
57
Appendix Sage SQL Gateway
Checklist: Implementing Configuration 4
Installed on Machine 1:
• Windows server OS
• Sage 300 CRE Server
Installed on Machine 2:
• Windows server OS
• Sage 300 CRE Workstation
• Sage SQL Gateway and the
Executive Dashboard add-on
Installed on Machine 3:
• Windows server or client OS
• SQL Server or SQL Express
1.
2.
3.
4.
5.
6.
7.
8.
On
Machine 1
, complete“Sage 300 Construction and Real Estate Tasks” on page 11.
On
Machine 2
, complete “Sage SQL Gateway server tasks” on page 12,
including the client installation of Sage 300 Construction and Real Estate.
On
Machine 3
, complete “Microsoft SQL Server machine tasks” on page 13.
If you will install SQL Server 2012 on your own, install it now on
Machine 3
Otherwise, download the Sage SQL Gateway installation file and open it. Select only the last check box, and complete the installation.
❑
Sage SQL Gateway
❑
Executive Dashboard Add-on
✔
SQL Server 2012 Express
On
Machine 2
, open the Sage SQL Gateway installation file. If you selected a
SQL Express option, clear the last check box and complete the installation.
✔
Sage SQL Gateway
✔
Executive Dashboard Add-on
❑
SQL Server 2012 Express
On
Machine 2
, open Sage SQL Gateway.
Enter
[Machine 3]\sagesqlgateway
(or the applicable instance name if you installed SQL Server on your own).
Select the check box to use your Windows credentials, and click
Log on
.
58 © 2015 Sage Software, Inc.
Sage SQL Gateway with Sage Executive Dashboard
9.
If the logon fails, verify each item shown here. The first list applies to
Machine 3
. The second list applies to
Machine 2
.
Appendix
10.
Click
Yes
to the messages about configuring the instance and enabling the
Executive Dashboard add-on. Configure warehouses as needed.
© 2015 Sage Software, Inc.
59
Appendix Sage SQL Gateway
60 © 2015 Sage Software, Inc.
Download
Public link updated
The public link to your chat has been updated. You may view and manage your chat links after registration here.
Document public link
Advertisement