Welcome to the. SACRRA Data Master Application. Administration Guide

Transcription

1 Welcome to the SACRRA Data Master Application Administration Guide SACRRA DMA Help Guide v1.0 Copyright All Rights Reserved - South African Credit & Risk Reporting Association SACRRA

2 Contents COPYRIGHT... 3 TYPOGRAPHICAL CONVENTIONS... 4 INTRODUCTION... 6 DOWNLOAD... 7 HARDWARE REQUIREMENTS... 8 SOFTWARE REQUIREMENTS... 9 DEPLOYMENT DEPLOYMENT SCENARIOS DMA INSTALLATION SQL SERVER CONFIGURATION REGISTERING A MEMBER ADDING A NEW USER SYSADMIN PASSWORD RESET TROUBLESHOOTING SUPPORT INDEX

3 Copyright Copyright on this product is held by the South African Credit & Risk Reporting Association All Rights Reserved - SACRRA No part of this manual, in whole or in part, may be reproduced, transferred, copied, photocopied or translated without the prior agreement and without explicit written permission from SACRRA. SACRRA retains the right to make alterations to the content of this guide without the obligation to inform third parties. It is important to read and accept our Terms & Conditions, Security and Privacy policies on our website at Microsoft, Windows, Windows Server 2003, Windows Server 2008, Microsoft SQL Server, SQL Server and Datacenter are trademarks or registered trademarks of the Microsoft Corporation. All brand or product names are trademarks or registered trademarks of their respective holders. South African Credit & Risk Reporting Association Block N, Central Park, th Road, Midrand, 0057 Produced in the Republic of South Africa First Edition,

4 Typographical conventions Before you start using this guide, it is important to understand the terms and typographical conventions that are used in the documentation. The following types of formatting identify special information: Formatting Type of Information Example Please note that some of these convention formats may not have been used in the document Bold Menu options, command buttons, tabs, dialog box titles, labels and options. Names of the icons and items. Names of screens, tabbed pages, and pop-up windows. On the Tools menu, click Options. Data Entry A key to be"typed" TypeYto continue. Roman Error message names The printer is offline. Monospace Emphasis (Italics) Text that you need to type into text fields. Also used for field values. In the Date box, type:april 1 Italic text used to emphasise important points. Also You must close the window before used to indicate states in the workflow of processes and you exit. procedures. Press Next to continue. List bullets [ ] A bulleted list displays a series of concepts, items, or options. The database owner can: Create and delete a database Add, delete, or modify a document Add, delete, or modify any information in the database List numbering [ ] A numbered list displays procedural or other sequential lists. Step-by-step procedures are instructions followed to complete a specific task. To log on to a database: 1. On the File menu, click Open Database 2. In User Name, type your name 3. In Password, type your password, then click OK CAPITALS Names of keys on the keyboard. For example: ENTER, SHIFT, CTRL, or ALT. KEY+ KEY Keyboard combinations where you press and hold down one key and then press another. Use the CTRL+S to save the data. 4

5 Notice icons in Lists A bulleted list containing embedded notice messages. The database owner can: 1. Example Option 1 Create and delete a database Indicates a general notification 2. Example Option 2 Indicates a cautionary notification 3. Example Option 3 Here be dragons Add, delete, or modify any information in the database Indicates a helpful hint 4. Example Option 4 Indicates a warning notification 5. Example Option 5 Indicates a Best Practice hint Notice icons Indicates a general notification. Indicates an important notification. Definition: Indicates a definition explanation. Indicates a cautionary notification. Indicates a warning notification. Indicates a Best Practice hint. Indicates a helpful hint. 5

6 Introduction This topic is an introduction to the Data Master Application (DMA) system administration and discusses the various tasks required to configure and manage your installation. Please use the checklist below to ensure consistency and completeness of deploying and installing the DMA in various scenarios. ACTIVITY Download DMA application Instructions to download the applicable DMA install package. Checked Hardware Requirements Software Requirements Deployment This section lists the minimum hardware requirements for running Data Master Application (DMA). This section lists the minimum software requirements to install and run the DMA for both 32-bit and 64-bit systems. DMA is designed to be scalable so it can accommodate both small and large deployments. As you deploy to your production site you should be aware of the number of custom accounts and deploy DMA to a system capable of handling the volume. DMA Installation Ensure that you have Administrator privileges before you attempt to install DMA. The.NET 4.0 & 4.5 frameworks and MS-SQL Server Express will install automatically if required..net 3.5 must be enabled if you are running Windows 10 A reboot of your Windows operating system will occur if.net is installed You must ensure that your Firewall allows the DMA agent service Internet access to Port 443 SQL Server configuration DMA Registration DMA User creation SysAdmin Password reset Troubleshooting Support This topic provides a step-by-step procedure for customising the DMA when deployed to connect to a MS-SQL Server. The DMA Registration option is where members will register their Member Number and Product Key supplied by SACRRA. The registered member may add users to take on specific responsibilities. This option allows System Administrators to change their password. The troubleshooting topic provides solutions available for issues that may incur. This option describes methods to use when contacting SACRRA support services. 6

7 Download The Data Master Application (DMA) is a software application that allows a Member to understand and validate the data quality of the SACRRA format files ahead of the submission to a Credit Bureau. Prior to installing the software you must download the DMA package from the SACRRA website at dma.sacrra.org.za. Depending on your group policy for software installations, you may select to download either the DMA MSI version (setup.msi) or the DMA EXE version (setup.exe). To install DMA, run the setup install file as an administrator. 7

8 Hardware Requirements There are two classifications of DMA deployment, namely Low Volume and High Volume, where: Low Volume is the number of accounts that are less than or equal to in total and may be processed on a local workstation or a dedicated server. High Volume is the number of accounts that are greater than and must be processed on a dedicated server. The DMA Application may also be deployed to a virtual environment such as VMWare or Hyper-V The following requirements should be met to ensure smooth operation of the Data Master Application: Requirement Detail Low Volume Hardware Single CPU Dual Core i5 2.0 GHz or faster 4GB RAM At least 80GB free space on Hard Drive High Volume Hardware 2 x Quad Core Processor 2.0 GHz or faster 6GB RAM At least 250GB free space on Hard Drive Capacity Planning The DMA Member instance of the application running on the specification mentioned above will accommodate the following: 20 concurrent Users Approximately 1300 Reports (Daily and monthly combined) As the number of reports start to reach the maximum threshold in a member database, the database is automatically pruned to make space for new reports. As a result there is no need to archive the database. 8

9 Software Requirements The DMA installation requires specific software to be in place for successful operation. SUPPORTED WINDOWS OPERATING SYSTEMS The DMA application requires any one of the following operating platforms. Windows 7 SP1 (32/64 bit) Windows 8 (32/64 bit) Windows 8.1 (32/64 bit) (Preferable for Low Volume) Windows 10 (32/64 bit) (Preferable for Low Volume) Windows Server 2008 R2 (64-bit) Standard, Enterprise and Datacentre editions Windows Server 2012 R2 (64-bit) Standard, Enterprise and Datacentre editions (Preferable for High volume) For all platforms, we recommend that you upgrade your Windows operating system to the latest Service Pack and critical updates available from the Windows Update website to ensure the best compatibility and security. PREREQUISITE SOFTWARE The DMA Application requires the following prerequisite software to be installed. They will be automatically installed during the installation process, if not already found on the target system. The following software are required: Microsoft.Net Framework 4.0 Microsoft.Net Framework 4.5 SQL Server Express LocalDB 2012 SP2 High Volume installations require the following Microsoft SQL Server editions are supported: SQL Server 2012 (64-bit) - Standard edition (preferable) SQL Server 2014 (64-bit) - Standard edition For all platforms, we recommend that you upgrade your Windows operating system to the latest Service Pack and critical updates available from the Windows Update website to ensure the best compatibility and security. SUPPORTED CLIENT WEB BROWSERS The DMA Application requires the use of a Web Browser that supports both HTML5 and CCS3. The following web browsers are supported: Internet Explorer Version 11 Chrome Version 41 FireFox Version 36 9

10 Deployment When you embark on the process of installing the DMA application, it is important that you give some consideration to the type of deployment structure you should use. Firstly, consideration should be given to the database, namely, the MS-SQL version you should deploy: MS-SQL Standard server edition MS-SQL Enterprise server edition MS-SQL Express Local DB edition and secondly, to the DMA deployment in a local or server-based environment: If your company has a large IT infrastructure and the number of customers exceed 500,000 then it would be appropriate to deploy the DMA into a high-end multi-server environment. If your company has a small to medium IT infrastructure and the number of customers are less than 500,000 then a single server or localised standalone workstation may be more suitable. Take a look at the different scenarios that are recommended. 10

11 Deployment Scenarios The DMA application can be deployed to many different scenarios dependent on your available IT infrastructure requirements. The scenarios are divided into two groups, one for clients with more than 500,000 records and one for clients with less than 500,000 records. It is recommended that you implement a centralised server-based deployment. Reason: Long-running tasks will not interfere with workstation activity. The tasks will be abandoned if the workstation is shut down. You can use one of the following configuration scenarios to align with the network infrastructure preferred by your network administrators. Scenario 1 This scenario is recommended for most clients with large server platforms requiring high levels of security. It consists of a dedicated MS-SQL Standard server, a dedicated DMA application server and a workstation running one of the supported browsers. 500,000 records and above Scenario 2 This scenario may be used by clients with medium-sized server platforms and consists of MS-SQL Standard and the DMA application installed on the same dedicated server and a workstation running one of the supported browsers. Scenario 3 This scenario may be used by clients with small server platforms and consists of a dedicated MS-SQL Standard and the DMA application installed on a workstation and running one of the supported browsers. 11

12 Less than 500,000 records Scenario 4 This scenario may be used by clients with a small server platform and consists of a Local DB using MS-SQL Express and the DMA application running on the same dedicated server and a workstation running one of the supported browsers. Scenario 5 This scenario may be used by clients without a server platform and consists of a Local DB using MS-SQL Express and the DMA application installed on a workstation running one of the supported browsers. Scenario 6 This scenario may be used by clients without a server platform and consists of MS-SQL Standard and the DMA application installed on a workstation running one of the supported browsers. 12

13 DMA Installation The DMA installation wizard will take you through a number of steps and install the application on your selected workstation or server. Step Double-click on the setup.exe file in your download folder to start the installation. The wizard first verifies the setup package to ensure integrity. Action To install DMA you must have administrator privileges assigned to you on the workstation. The following prerequisite software must be installed prior to installing the DMA and as a result will be automatically installed if not available. Microsoft.Net Framework 4.0 Microsoft.Net Framework 4.5 SQL Server Express LocalDB 2012 SP2 SQL Server 2012 (64-bit) - Standard edition (preferable) SQL Server 2014 (64-bit) - Standard edition This dialog is displayed when the setup detects and lists the prerequisite software that is not available on the target system. Click Next to continue. You may also cancel the process at this step. If any of the prerequisite software is already installed it will not be reinstalled. If any of the.net software is installed, a reboot is required to complete the installation. 13

14 Step Action The required software is extracted from the setup package and installed. Click Next to continue. You may also cancel the process at this step. When the prerequisite software has been successfully installed, you are asked to continue and install the DMA application. Click Next to continue or Cancel to abort the process at this step. You should read, understand and accept the license agreement. Click Next to continue or Cancel to abort the process at this step. 14

15 Step Action When you have acknowledged that you have read the license agreement, Setup will install the DMA application and the DMA agent to the destination folder. Click Next to continue or Cancel to abort the process at this step. Select the program group to create the application shortcuts. Click Next to continue or Cancel to abort the process at this step. When you have acknowledged that you have read the license agreement, Setup will install the DMA application and the DMA agent. When successfuy installed, you may select to start the application immediately and then click Finish. 15

16 SQL Server Configuration When deploying the DMA Application to a dedicated SQL Server, the database connection string must be changed to redirect the DMA from the default LocalDB to the SQL Server. You should have the SQL Server database installed and running. To do this, edit the CPA.DMA.Agent.exe.config configuration file located in the DMA Application folder, typically "C:\Program Files\SACRRA\DMA". You may use Notepad or any other text editor. There are four default connection strings found in the connectionstrings section of the configuration file which connect the DMA during installation to a LocalDB database. LocalDB is a lightweight version of the SQL Server Express Database Engine that starts on demand and runs in user mode. To connect to a SQL server database you should change the connection strings. <connectionstrings> <add name="defaultconnection" connectionstring=" Data Source=(LocalDb)\v11.0;AttachDbFilename=$TARGETDIR$\App_Data\cpadma_config.mdf ; Integrated Security=True " providername="system.data.sqlclient" /> <add name="pdfreport" connectionstring=" Data Source=(LocalDb)\v11.0;AttachDbFilename=$TARGETDIR$\App_Data\cpadma_pdfreport. mdf; Integrated Security=True" providername="system.data.sqlclient" /> <add name="xlsreport" connectionstring=" Data Source=(LocalDb)\v11.0;AttachDbFilename=$TARGETDIR$\App_Data\cpadma_xlsreport. mdf; Integrated Security=True" providername="system.data.sqlclient" /> <add name="snapshotreport" connectionstring=" Data Source=(LocalDb)\v11.0;AttachDbFilename=$TARGETDIR$\App_Data\cpadma_snapshotre port.mdf; Integrated Security=True" providername="system.data.sqlclient" /> </connectionstrings> $TARGETDIR$ is the folder where the DMA application is installed. Edit the SQL Server connection strings with the following parameters: <connectionstrings> <add name="defaultconnection" connectionstring="data source=$dbservername$; initial catalog=cpadma_config; persist security info=true; user id=$dbusername$; password=$dbpassword$; MultipleActiveResultSets=True; App=EntityFramework" providername="system.data.sqlclient" /> <add name="pdfreport" connectionstring="data source=$dbservername$; initial catalog=cpadma_pdfreport; persist security info=true; user id=$dbusername$; password=$dbpassword$;multipleactiveresultsets=true; App=EntityFramework" providername="system.data.sqlclient" /> <add name="xlsreport" connectionstring="data source=$dbservername$; initial 16

17 catalog=cpadma_xlsreport; persist security info=true; user id=$dbusername$; password=$dbpassword$; MultipleActiveResultSets=True; App=EntityFramework" providername="system.data.sqlclient" /> <add name="snapshotreport" connectionstring="data source=$dbservername$; initial catalog=cpadma_snapshotreport; persist security info=true;user id=$dbusername$; password=$dbpassword$; MultipleActiveResultSets=True; App=EntityFramework" providername="system.data.sqlclient" /> </connectionstrings> $DBSERVERNAME$ is the name of the SQL Server on the network. $DBUSERNAME$ is the SQL Server user which should be granteddb_owner permissions to the four databases. $DBPASSWORD$ is the password for the SQL Server user. SQL Server Database preparation To further prepare the DMA to operate with a SQL Server database, execute with the following steps: 1. Ensure that the DMA Agent service has been stopped. 2. Copy the database files from the local folder $TARGETDIR$\App_Data\*.* to the database server. 3. Attach all four MDF database files to the SQL server instance. 4. Grant db_owner permissions for the four databases, for the user $DBUSERNAME$. 5. Start the DMA Agent service. Save the file then test the DMA connection to the database. 17

18 Registering a member Each installation will require a unique Member Number and a Product Key to be entered which is supplied to you by SACRRA. When the DMA system starts for the first time after installation, you will be requested to enter your Member credentials. 1. Enter your supplied Member number. 2. Enter a name for your members group then enter your supplied Product key. 3. Finally create a password for the Member. 4. Follow the on-screen guidelines for creating a password as it is imperative that you create a strong password. To allow the system to generate a random password for you, click Generate Password. The new system generated password is displayed above the user fields required prior to registration. 5. You may click the User button to send the relevant user an to advise of the new user account. 6. When you are done, check and validate all of the entries then click Register. Sign in You may now log in to the DMA using"sysadmin" as your user name and using the password you created on the Register screen. You may now create additional users for your group. If your session is inactive for 10 minutes, you will be automatically logged out. 18

19 Adding a New User User Maintenance is an administrative process performed by authorised system administrators"sysadmin" to add, delete or edit users. To add a new user, click the Add User button. 1. Enter a user name, preferably made up from the first and last name of the new user, then enter the user's first and last names. EXAMPLE: Username =YourUserName First = FirstName Last = LastName 2. Then enter the user's address using a valid format, such as,"name@sample.com" and also enter a valid telephone number. 3. Next, create a password for the user. Follow the on-screen guidelines for creating a password as it is imperative that you create a strong password. To allow the system to generate a random password for you, click Generate Password. The new system generated password is displayed above the user fields required prior to registration. The new system generated password is displayed above the fields that you entered prior to registration. 4. You may click the User button to send the relevant user an to advise of the new user account. 5. Finally, select the system roles you want to grant to the user. This implies that the user will have access to these menu options. ROLES Dashboard The dashboard provides you with an overall visualisation of file uploads and validation statistics. Validation You can use the Validation Reports option to view a detailed overview of record counts, rejections, warnings and overall file status of recently uploaded files. 19

20 Export If you are a SACRRA member without Internet access, the automatic synchronisation of validated data with the SACRRA DMA instance cannot take place. You may then use the Export option to package the validated data and send it to a specific SACRRA address where it will be automatically detected and processed. File Loader The file loader option is the facility you will use to import a data file requiring to have it's data validated against very specific validation rules. Profile The profile option allows you to edit and update your personal login credentials or to just change your password. 7. When you are done, check and validate all of the entries then click Save. If you are logged in as a user and your session is inactive for 10 minutes, you will be automatically logged out. 20

21 SysAdmin Password reset For the sake of security, you should change or reset your "sysadmin" password regularly. To reset your password in DMA, take the following steps: You must know your current Member number and Product Key to reset your system admin password. On the DMA user interface login screen, click the User button at the top-right corner and select the Reset sysadmin password option. Enter your current Member number, Group name and Product Key then enter your new password and confirm. To save the new password, click Reset Password. 21

22 Troubleshooting This topic will attempt to assist you in isolating the source of a problem you may encounter, typically through a process of elimination whereby possible sources of the problem are investigated and eliminated, beginning with the most obvious or easiest problem to fix. Select the relevant item below to view details of the solution. Browser cannot connect to server Check if the DMA Agent service has started in Windows services. Click Start > Run >services.msc. Find the DMA agent and check if it is running. If not, click the Start option. My issue is not listed here Click the Support button at the top of the DMA screen to get the relevant contact details for support. If not possible, send an to dma@sacrra.org.za or call

23 Support To get technical support to help you derive maximum value from your DMA software, click the Support button at the top of the DMA screen to get the relevant contact details for any support requirement you may have. Telephone: Remember to always have your current DMA version number available when you contact the support desk. 23

24 INDEX A Administrator privileges, 6 C Capacity Planning, 8 Configuration file, 16 Connection string, 16 D Deployment, 10 Deployment Scenarios, 11 DMA Installation, 13 Download, 7 F Firewall, 6 H Hardware Requirements, 8 I Introduction, 6 P Prerequisite Software, 9 R Register S Generate Password, 18 Member Number, 18 Product Key, 18 Register, 18 Registering a member, 18 Session time-out, 18, 20 Software Requirements, 9 SQL Server Configuration, 16 Support, 23 Supported Client Web Browsers, 9 Supported Windows Operating Systems, 9 SysAdmin Password reset, 21 T Troubleshooting, 22 Typographical conventions, 4 U User Maintenance, 19 Add User, 19 Adding a New User, 19 System Roles, 19 24