Installation Guide: Migrating Report~Pro v20

Transcription

1 Introduction... 2 Overview... 2 System Requirements... 3 Hardware Requirements... 3 Software Requirements... 4 Assumptions... 4 Notes... 4 Installation Package Download... 5 Package Contents... 5 Pre-Installation Checks... 6 Stage 1: Collation Check... 6 Stage 2: Surface Area Configuration... 6 Installation... 7 Stage 3: Backup and Restore the SQL Databases... 7 Stage 4: Patches... 8 Stage 5: Active Directory... 8 Stage 6: SQL Server Security Settings... 8 Stage 7: SQL Server Security Settings DMM Role Stage 8: FileMaker Export Configuration Stage 9: Event Scheduler... 7 Stage 10: Setting SQL Import Parameters... 8 Stage 11: Setting the SQL Import Job... 9 Stage 12: Delta Module Manager Installation Stage 13: DMM Service (Optional) Stage 14: Financial Express (Optional) Appendix 1 Installation notes Appendix 2 Test Connections Appendix 3 Uninstalling Report~Pro Appendix 4 ExportRP Scripts Appendix 5 Configuring FileMaker Pro This information is based on Delta Financial Systems understanding of the current legislation. You should not rely solely on the information provided by Delta Financial Systems but should also form your own opinion as to the practical applications of the current legislation. April 2017 Delta Financial Systems Ltd Eliot Park Innovation Centre 4 Barling Way Nuneaton Warwickshire CV10 7RH Tel: Fax:

2 Introduction Report~Pro is a data warehouse application that stores data transferred from the SIPP~Pro and/or SSAS~Pro applications and underpins the Delta Module Manager. Overview This document: Is a migration guide for the Report~Pro databases and includes Microsoft SQL Server Configuration. Details the exporting of data from SIPP~Pro and/or SSAS~Pro. Details the importing of data into Report~Pro, along with failure/recovery, troubleshooting, and uninstalling procedures. This document does not cover: The installation of FileMaker Server, FileMaker Pro, SIPP~Pro, SSAS~Pro or the Delta Module Manager (covered in separate installation guides). The installation of Microsoft SQL Server. This document assumes: Pre-installation of Microsoft SQL Server 2012 on a Windows Server 2008/2012 operating system. Note: Variations relating to either the operating system or the version of Microsoft SQL Server being used are described in the relevant appendix. April

3 System Requirements Hardware Requirements Report~Pro requires Microsoft SQL Server to be installed on your system. Table 1 below summarises the minimum requirements as stated by Microsoft. Further details can be found at: SQL 2012/2014/2016* (Enterprise / Standard edition) 32-bit (x86) Processor Type Pentium III (compatible processor or higher) Memory (RAM) 64-bit (x64) Speed Minimum 1.0 GHz 1.4 GHz Recommended 2.0 GHz or faster 2.0 GHz or faster Minimum 1 GB 1 GB Recommended 4 GB or more 4 GB or more Hard Disk Minimum 6 GB 6 GB Table 1 x64 minimum: AMD Opteron, AMD Athlon 64, Intel Xeon with Intel EM64T support, Intel Pentium IV with EM64T support *Note: SQL Server 2016 is supported on x64 processors only. It is no longer supported on x86 processors. Delta recommend the following: Memory 6 GB (8 GB if using Hyper V) Hard Disk Space Disk space requirements will vary with the SQL Server components you install. Table 2 April

4 Software Requirements Supported Server Operating Systems Windows 2008 R2 Server (w/sp2) Windows 2008 Small Business Server (SBS) please refer to appendix 1 for additional details Windows 2012 & 2012 R2 Server Table 3 Note:.NET 3.5 SP1 is a requirement for SQL Server 2012 when you select Database Engine, Reporting Services, Master Data Services, Data Quality Services, Replication, or SQL Server Management Studio, and it is no longer installed by SQL Server Setup. Supported SQL Versions Microsoft SQL Server 2012 Standard & Enterprise Editions Microsoft SQL Server 2014 Standard & Enterprise Editions Microsoft SQL Server 2016 Standard & Enterprise Editions Table 4 Assumptions It is assumed that FileMaker has already been correctly installed, and the following paths have been used: File FileMaker Server Application FileMaker Pro 5.5 SIPP~Pro Data Files SSAS~Pro Data Files PFData.FP5 ExportRP.FP5 FMStart.BAT FMStop.BAT ExportRP.BAT Table 5 Location C:\FMSERVER C:\Program Files (x86)\fmpro55 C:\FMSERVER\SIPPDATA C:\FMSERVER\SSASDATA C:\FMSERVER C:\FMSERVER C:\FMSERVER\BATCHES C:\FMSERVER\BATCHES C:\FMSERVER\BATCHES Note: These paths may exist on a different server to that of Report~Pro. It is also assumed that Microsoft SQL Server has already been installed. Notes The Report~Pro databases can co-exist with other SQL applications and can be installed on the same physical machine as the FileMaker server. Delta s recommendation for best performance is to install the SQL Report~Pro databases onto a dedicated SQL server, which is separate from the FileMaker Server. April

5 Installation Package Download Before starting to use this guide, you must be in possession of the installation package. Note: This may already be available through a share on your network. If you do not already have the package then you will be sent an containing a link to our secure File Transfer System (FTS). Note: If you have not received an FTS activation , please contact the Delta Support Team on Once you have downloaded the installation package, unzip this folder into a location accessible to the installation workstation. Package Contents Package Report~Pro Migration Guide SQL Scripts for Security and Jobs New and Changed Report Objects (if supplied) Core Files (.FP5) Batch Files (.BAT) Microsoft Framework 3.5 Installation Package Microsoft Visual Basic 5.0 Runtime (used for Financial Express only) SilverTierSchema Delta Module Manager Installation Guide Delta Module Manager Client and Server Installation Packages Table 6 April

6 Pre-Installation Checks Stage 1: Collation Check The Report~Pro data warehouse databases are designed to utilise collation order Latin1_General_CI_AS, or UK English, and the collation order of your SQL system databases must be set to the same. i. Check the collation order of your SQL installation by running the script located in: \...\01 Pre-Installation Checks\01 Collation\ ii. Check the collation for the 4 system databases matches as follows: DB Name Recovery Status Updateability User Access Collation master SIMPLE ONLINE READ_WRITE MULTI_USER Latin1_General_CI_AS model FULL ONLINE READ_WRITE MULTI_USER Latin1_General_CI_AS msdb SIMPLE ONLINE READ_WRITE MULTI_USER Latin1_General_CI_AS tempdb SIMPLE ONLINE READ_WRITE MULTI_USER Latin1_General_CI_AS Table 7 Note: If the system databases are not set to the correct collation order, you will need to either change the collation to the UK British collation Latin1_General_CI_AS (CI = Case Insensitive, AS = Accent Sensitive) by reinstalling SQL Server or if this is not possible due to other SQL databases requiring a different collation order, then you will need to locate an alternative SQL Server. Stage 2: Surface Area Configuration The Report~Pro databases requires the CLR and OLE Automation options to be enabled. Note: This task can also be completed using the GUI (see Appendix 1). i. Run the script located in: \...\01 Pre-Installation Checks\02 Surface Area\ ii. Check the value of the run_value field matches as follows: April

7 Installation Stage 3: Backup and Restore the SQL Databases Before commencing this step, please note the following: You MUST have full system admin rights on the SQL server. The new SQL instance should NOT have any existing database with a name that matches any found in the table below: Database name SIPP_ReportPro_Audit SIPP_ReportPro 0000_SIPP_Premium SSAS_ReportPro 0000_SSAS_Premium Table 8 Description Holds Audit Information for main data tables The main SIPP data repository Holds information for the Report Engine and custom routines, if applicable. If custom routines do apply, the database name will change from 0000 to your client account number The main SSAS data repository Holds information for the Report Engine and custom routines, if applicable. If custom routines do apply, the database name will change from 0000 to your client account number i. If you have not already done so, take a backup from your existing server of all the SQL databases listed above. Note: If you are unsure how to backup a database using Microsoft SQL Server Management Studio, the following link will provide assistance: Note: If you do not currently have all five databases installed, please can you inform Delta Technical Support so we can assist you in installing these. Please continue through this document as this does not affect the migration process. ii. Restore the database backup files from the old system in the exact order shown in the table above. Note: If you are unsure how to restore a database using Microsoft SQL Server Management Studio, the following link will provide assistance: April

8 Stage 4: Patches i. Execute the appropriate script(s) found in \...\02 Installation\04 Patch\ depending on which database(s) you have restored: o 01 SIPP Ownership.sql o 02 SSAS Ownership.sql ii. iii. Execute script S99 Check DB File Sizing and Growth.sql. Paste the results into a new window then execute. Stage 5: Active Directory In order for clients to be able to run the Delta Module Manager successfully they will require the correct access permissions to the Report~Pro databases. A security group may already exist if your new server resides within the same Windows domain as the old one. If so, move on to the next stage. i. Create a user group in your Active Directory. Note: Delta recommends that you use the name DMMGroup. ii. Add users to this group who require access to the Delta Module Manager. Stage 6: SQL Server Security Settings The Active Directory group created in previous step now needs to be added to the SQL Security logins and then permission granted to the group for the Report~Pro databases. i. Open Microsoft SQL Server Management Studio. ii. Expand Security in the Object Explorer window, right click Logins and select New Login. April

9 iii. Click the Search button. iv. Click the Advanced button. v. Click the Object Types button. April

10 vi. vii. Select the Groups tick box and click OK. Click the Locations button. viii. Select Entire Directory and click OK. ix. In the Name field enter DMMGroup and click the Find Now button. April

11 x. In the Search Results window, select the newly created Group and click OK. xi. Click the OK button. xii. xiii. Set Default database to 0000_SIPP_Premium. Click OK to finish OR perform the next steps as appropriate. April

12 Optional Steps If you created a new domain group in Stage 5 then the following steps will require completion, otherwise move on to the next stage. i. Select User Mapping from the left-hand tree. ii. Check the following tick boxes (as appropriate): o o o o o 0000_SIPP_Premium SIPP_ReportPro SIPP_ReportPro_Audit 0000_SSAS_Premium SSAS_ReportPro iii. Click OK to finish. Stage 7: SQL Server Security Settings DMM Role The SQL Server database role DMM was created as part of the original installation scripts. This role needs to be re-assigned permission to the objects within the Report~Pro databases. i. Locate the folder \...\02 Installation\07 Security Scripts. This folder contains the following scripts: 100 Apply Security Model SIPP.sql 100 Apply Security Model SSAS.sql ii. iii. iv. Right click one script and select open with Notepad. Edit the script wherever you see DomainName\DMMGroup with your own company credentials and save. Execute the amended script. Note: The field name DMMGroup may vary if you have chosen another name back in Stage 5. v. Repeat steps 2-4 for the other script. April

13 Stage 8: FileMaker Export Configuration If you are only migrating Report~Pro & leaving FileMaker Server where it is, then Stage 8 can be skipped. Step 1: ExportRP.FP5 In order for the data within FileMaker to be available to Report~Pro, an export task needs to be configured on the server running FileMaker. Note: This server may differ to the Report~Pro server. i. Locate folder \...\02 Installation\08 FileMaker\01 FP5. ii. Copy ExportRP.FP5 to installdrive:\fmserver\ on the FileMaker server. Note: Do not copy if FileMaker is currently live i.e. if FileMaker Server service is running. Step 2: Batch Files i. Locate folder \...\02 Installation\08 FileMaker\02 Batches\02 CreateCSVFolders\. ii. Execute CreateCSVFolders.bat on the FileMaker server. iii. Locate folder \...\02 Installation\08 FileMaker\02 Batches\03 ExportRP\. iv. Copy ExportRP.bat to installdrive:\fmserver\batches\ on the FileMaker server. v. Open ExportRP.bat in Notepad and verify the paths listed are correct (amend where necessary). Note: For steps ii & iv, choose the relevant sub-folder based on your system architecture (32 or 64-bit) Example 1 Typical Example 2 Separate machines April

14 Note: If SQL Server and FileMaker Server are installed on separate machines then the CSV folders must be shared and the ExportRP batch file needs to be updated as in Example 2. Step 3: ExportRP Settings Please select an appropriate option in order to open the ExportRP file. The option choice will depend on the state of the FileMaker Server service: Option 1 Hosted Mode (FileMaker Server service running) i. Launch FileMaker Pro in TCP/IP mode. ii. iii. Click the Hosts button. Open ExportRP.FP5. Option 2 Offline Mode (FileMaker Server service stopped) i. Locate the folder \...\FMServer. ii. Double click the file ExportRP.FP5. Important: If the Cancel button is not pressed within 5 seconds (approx.) then the script will execute and could cause corruption to your FileMaker data. i. As soon as the above screen has loaded, click the Cancel button in the left-hand menu. ii. Open Edit > Preferences > Document. April

15 i. Select the required script from the Perform script drop down menu (see appendix). Step 4: SIPP~Pro Settings (if applicable) i. Launch FileMaker Pro in TCP/IP mode. ii. Open Pmanger.SIP (use DBA password). iii. On the Main Menu Click on Administration. April

16 iv. Click on Preferences v. Click on User Parameters April

17 vi. Set the required path in the field Report~Pro Folder. o o 64-bit = C:\Program Files (x86)\fmpro55\sippreportprocsv 32-bit = C:\Program Files\FMPro55\SIPPReportProCSV vii. viii. Press the Menu button to return and commit changes. Exit FileMaker Pro. Step 5: SSAS~Pro Settings (if applicable) i. Launch FileMaker Pro in TCP/IP mode. ii. Open Manager.DFS (use DBA password). April

18 iii. On the Main Menu, click on Administration. iv. Click on Preferences. April

19 v. Click on User Parameters. vi. Set the required path in the Report~Pro folder field. o o 64-bit = C:\Program Files (x86)\fmpro55\ssasreportprocsv 32-bit = C:\Program Files\FMPro55\SSASReportProCSV vii. viii. Press the Menu button to return and commit changes. Exit FileMaker Pro. April

20 Stage 9: Event Scheduler If you are only migrating Report~Pro & leaving FileMaker Server where it is, then Stage 9 can be skipped. Step 1: Task Creation i. Create the following scheduled tasks in order to retrieve the information from the FileMaker server: A. Stop FileMaker Server service B. Export Data C. Start FileMaker Server service Note: Item(s) A & C should already be complete as part of the FileMaker Server install. The table below contains the recommended times to set: Time Name File Frequency Event 22:00 STOP FMServer FMStop.bat Daily FileMaker Server service stops. (This may have been already set as part of the FileMaker Server Installation) 22:15 ExportRP ExportRP.bat Daily This will delete any previously exported CSV files and then export all data from SIPP~Pro/SSAS~Pro into CSV files. 06:00 START FMServer Table 9 FMStart.bat Daily FileMaker Server service starts. (This would have been already set as part of the FileMaker Server Installation) Note: If any of these times are subsequently changed, please notify Delta. Note: The user account set to execute the export task must have launched and configured FileMaker Pro before the task runs (See Appendix 5). April

21 Stage 10: Setting SQL Import Parameters Installation Guide: Migrating Report~Pro v20 i. Using SQL Server Management Studio locate the table ptimportparameters in both the SIPP_ReportPro and SSAS_ReportPro databases and edit the following fields where necessary. ImportFolder Configure this field with the path to the folder containing the CSV files. This will be the same as the Report~Pro Folder path as set in SIPP~Pro and SSAS~Pro User Parameters screen. Note: This path must contain a backslash at the end. Failure to do so will import blank data. Note: If this path is located on another server then you will need to ensure that the UNC path is set to point to the appropriate share location and that the share permissions are configured appropriately. FieldDelimiter When FileMaker Pro exports it s SIPP~Pro and/or SSAS~Pro data to CSV files, the delimiter value within the CSV files created by FileMaker will be set to either a comma or semi-colon. Please check one of the CSV files once they have been created to determine the separator and adjust this table field accordingly. Note: Unfortunately, it has not been possible to determine why some servers create a comma and others a semi-colon, therefore this can only be determined after the initial CSV files have been created by FileMaker. Examples [SIPP_ReportPro].[dbo].[ptImportParameters] Field Name Value ImportParameters_ID 1 ImportFolder C:\Program Files (x86)\fmpro55\sippreportprocsv\ FieldDelimiter ; RowDelimiter \n StartAtRow 2 Table 10 [SSAS_ReportPro].[dbo].[ptImportParameters] Field Name Value ImportParameters_ID 1 ImportFolder C:\Program Files (x86)\fmpro55\ssasreportprocsv\ FieldDelimiter ; RowDelimiter \n StartAtRow 2 Table 11 April

22 Stage 11: Setting the SQL Import Job i. Use the job script provide by Delta located in the folder \...\02 Installation\11 Job. o o SIPP~Pro - Create SIPP Job.sql SSAS~Pro - Create SSAS Job.sql ii. Create schedules for the jobs as per the table below: Time Name Frequency Event 23:00 Delta SIPP~Pro - Import, Process and Export Files Daily The Daily Import Job is made up of 2 elements Step 1 Import SIPP~Pro CSV Files. Step 2 Populate the DMM Reporting tables 01:00 Delta SSAS~Pro Import, Process and Export Files Daily Step 1 Import SSAS~Pro CSV Files Table 12 April

23 Stage 12: Delta Module Manager Installation Installation Guide: Migrating Report~Pro v20 Please refer to the separate guide Installation Guide - Delta Module Manager Launcher. Note: Customers who have not adopted the launcher version the Delta Module Manager will need to contact Delta for advice on which package/guide to use. Stage 13: DMM Service (Optional) In order for any of the server modules to operate autonomously the Delta Module Manager needs to be installed as a service. Installation i. Open the DMM and select Modules > Task Scheduler. ii. Click Install Service button. iii. Click Yes. April

24 iv. Enter domain credentials with sufficient privileges to install a service. Note: These credentials should ideally be a service account to avoid future password changes disabling the service. v. The service will have been installed offline and will require starting using the Start Process button or via the Windows services snap-in. Uninstallation vi. Open the DMM and select Modules > Task Scheduler. vii. Click Uninstall Service button. viii. Click Yes. April

25 ix. A command window will flash up as above and once it has disappeared the uninstallation should be complete. Stage 14: Financial Express (Optional) If your organisation uses the Financial Express data feed then it is necessary to perform the following tasks: Visual Basic 5 i. Run the installer from datadrive:\...\vb5\. Dynamic Link Library Registration ii. Run the following command (run as administrator): REGSVR32 "C:\Program Files (x86)\fmpro55\delta Module Manager\finexdec.dll" Note: Edit folder path above to reflect your own environmental setup. April

26 Appendix 1 Installation notes Backups The databases contain critical data that is required for the Delta Module Manager to function correctly, therefore Delta strongly recommend that you schedule a daily offsite backup of these databases. Note: It is up to you to decide how to back these up e.g. SQL maintenance plan or 3 rd party solution with SQL plugin. Firewall If you have an active firewall then you will need to create an inbound rule to allow the Delta Module Manager to communicate with the SQL database. Open inbound ports: o o TCP/ UDP/ Note: If other SQL instances are already present then this port number may be taken and another will need to be configured in both SQL and the firewall rules. Microsoft Windows 2008 Small Business Server (SBS) and SQL Server Microsoft Windows SBS 2008 does not support the installation of a complete version of SQL Server on the same machine as the operating system. Note: This applies to all versions of Windows SBS 2008 and to both SQL Server 2005 and SQL Server The SQL Management Tools must therefore be installed on to a separate machine. This would normally be expected to be another server, however installation to a PC is acceptable provided the PC is left switched on and is accessible for maintenance purposes. Note: This machine must be accessible 24/7, for application support purposes. The alternative to all of this would be to install on a Windows 2008 Server (not the SBS version) as this supports the installation of a complete version of SQL server on the same machine. April

27 Surface Area Configuration in SSMS These options are configured by the script in Stage 2. The following shows how to configure using the GUI. i. In SQL Server Management Studio, locate and right click the instance name to be configured and select "Facets" from the context menu as shown below. ii. When the View Facets dialog box displayed, select "Surface Area Configuration" from the Facet drop down to display the facet properties, as shown below. iii. iv. Select CLRIntegrationEnabled and ensure the property is set to True Select OleAutomationEnabled and ensure the property is set to True v. Click on OK to apply them to the server. April

28 Appendix 2 Test Connections The following steps can be used to check connectivity to the databases. Go to Control Panel > Administrative Tools > Data Sources (ODBC). Click on the Add button. Scroll to the bottom of the list and choose SQL Server. Click on the Finish button. April

29 Enter a Test Name and SQL Server Name. Click on the Next button. For example, Name - My SQL Server Server - Select the server on which SQL Server is installed: Set the option With Windows NT authentication using the network login ID and click on the Next button: Select one of the Databases you have setup, and click Next and then Finish : April

30 Click on Test Data Source and you should receive a TESTS COMPLETED SUCCESSFULLY! message as shown in the following screenshots: Repeat this process for all databases. If all connectivity tests are successful, move to Stage 5. If a connection failed then the following error message will appear. If this happens, repeat Stages 1, 2 and 3 (if you can set up a workstation with a relevant user logon that can run Enterprise Manager this may give a better indication of why you cannot connect still). Also ensure that you can connect to the SQL server from the SQL Server itself using the ODBC connection test. April

31 Appendix 3 Uninstalling Report~Pro Installation Guide: Migrating Report~Pro v20 Prior to removal please backup the SQL databases using your chosen backup method. Load the Microsoft SQL Server Management Console. Expand Databases. Select each of the following databases in turn and press the Delete key. Note: Each time you press delete you will be presented with the Delete Object window for the database you are going to delete. Click the OK button to delete the database April

32 Appendix 4 ExportRP Scripts SIPPReportPro_SIP SIPP~Pro CSV files export script only. SSASReportPro_DFS SSAS~Pro CSV files export script only. BOTHReportPro_SIP/DFS SSAS~Pro & SIPP~Pro CSV files export script. BOTHRP_SIP/DFS+Acc Upd SSAS~Pro & SIPP~Pro CSV files export script + bank balance and holdings balance value update script. PFDataON_SIP Financial Express file process script (SIPP~Pro only). PFDataReportPro_SIP Financial Express file process script (SIPP~Pro only) + SIPP~Pro CSV files export script. PFandBothReportPro_SIPP/DFS Financial Express file process script + SIPP~Pro & SSAS~Pro CSV files export script. April

33 Appendix 5 Configuring FileMaker Pro Installation Guide: Migrating Report~Pro v20 When launching FileMaker Pro within a new Windows profile for the first time, you will be presented with a configuration window which will interfere with the automated export process if not configured. If you have chosen to create a service account for running the ExportRP scheduled task, then the steps outlined below need to be followed. Log in to Windows as the new account and run FileMaker Pro. Select the radio button Open an existing file Tick the checkbox No longer show this dialog and Click on OK. Click Cancel. Close FileMaker Pro. To ensure that this was successful, load FileMaker Pro and verify the Open File dialog box is displayed only. This account is now setup correctly for running FileMaker scripts automatically. Note: If the account is changed the above steps must be repeated. April