nGenue installation guide¶
This guide serves as the master reference for installing the nGenue application in your environment. It outlines a step-by-step process starting from verifying that your system meets the necessary hardware and software requirements, to setting up essential backend components such as Microsoft SQL Server and restoring the application database. It also includes guidance on launching the nGenue application and performing critical post-installation tasks like configuring SQL Server Reporting Services (SSRS) for report generation.
Each section below contains detailed instructions to help you complete the installation successfully. Following the steps in the listed order ensures that dependencies are handled correctly and reduces the risk of errors during setup.
| Step category | Description | Link |
|---|---|---|
| System requirements | Provides detailed information about the operating system versions supported by nGenue, minimum hardware specifications, and third-party software dependencies such as .NET Framework or IIS. | View system requirements |
| Install SQL Server | Walks through the installation and basic configuration of Microsoft SQL Server, which serves as the core database engine for nGenue. This step includes setting up authentication modes, user roles, and enabling necessary services. | Install Microsoft SQL Server |
| Restore database | Explains how to restore the nGenue database from the latest backup file provided during deployment. This includes steps for using SQL Server Management Studio (SSMS), verifying the restore, and setting user permissions. | Restore database backup |
| Run nGenue application | Covers how to start the nGenue application after all prerequisites are met. It also explains basic login, initial setup options, and how to confirm successful connectivity to the database. | Run nGenue application |
| SSRS configuration | Describes how to configure SQL Server Reporting Services (SSRS) to work with nGenue's reporting features. This includes setting report URLs, permissions, and data source connections. | Configure SSRS |
Pre-installation checklist¶
Before you begin installing nGenue, it is important to ensure that the target environment is fully prepared. Taking the time to validate prerequisites upfront helps avoid interruptions, rework, and unexpected issues during or after installation.
- Start by confirming that the target server meets the minimum hardware requirements defined for nGenue. This includes adequate CPU capacity, sufficient memory, and enough disk space to accommodate the application, database, logs, and future data growth. Running nGenue on under-provisioned hardware can lead to performance degradation and stability issues.
- Next, verify that a supported version of Windows Server is installed and fully patched with the latest security and stability updates. Unsupported or outdated operating system versions may cause compatibility issues with dependent components such as SQL Server, IIS, or SSRS.
- Ensure that you have administrator-level access on all servers involved in the installation, including application, database, and reporting servers. Administrative privileges are required to install software, configure services, assign permissions, and make system-level changes during the setup process.
- Microsoft SQL Server installation media should be readily available before proceeding. This includes both the SQL Server engine and SQL Server Management Studio (SSMS), which is required to restore the nGenue database and perform validation tasks. Confirm that SSMS is installed and accessible on the database server or a trusted administration workstation.
- The nGenue database backup file provided for deployment must be accessible from the SQL Server instance. Ensure that the backup file is stored in a secure location with appropriate read permissions and that sufficient disk space is available for the restored database files.
- Network connectivity between the application server, database server, and SSRS server must be verified in advance. Required network ports should be open and unrestricted to allow seamless communication between components. Firewall or network restrictions at this stage can result in application startup failures or reporting issues later.
- Finally, review endpoint security policies on all involved servers. Appropriate exclusions should be configured for SQL Server data directories, transaction logs, backups, and nGenue application folders. This helps prevent file locking issues and performance degradation.
Completing these pre-installation checks ensures that the environment is stable, secure, and ready for a smooth nGenue installation.
Post-installation validation¶
Once the installation is complete, it is critical to validate that all nGenue components are functioning as expected. Post-installation validation helps confirm that the system is ready for business use and reduces the risk of issues during user onboarding.
- Begin by validating the nGenue application itself. Launch the application and ensure that it starts without any errors or warnings. Log in using a valid user account and confirm that authentication works as expected. After logging in, navigate through key application screens to verify that pages load correctly and the application responds smoothly.
- Next, validate the database connectivity and health. Confirm that the application is connected to the correct SQL Server instance and database. If database jobs or scheduled processes are configured, verify that they are running successfully. Reviewing SQL Server logs at this stage can help identify warnings, permission issues, or configuration errors that may not be immediately visible in the application.
- Reporting validation is equally important. Access the SQL Server Reporting Services (SSRS) web portal and confirm that the report server is reachable. Open and execute at least one sample nGenue report to ensure that report data sources are correctly configured and permissions are properly assigned. Reports should load and return data without connection, authentication, or authorization errors. Any issues identified during post-installation validation should be resolved before the system is handed over for business or end-user access.
Common installation issues and considerations¶
- During installation or validation, some common issues may arise due to configuration gaps or environmental constraints. Missing or insufficient SQL Server permissions can prevent the nGenue application from starting or accessing required database objects. Incorrect SSRS URL or report server configuration may cause reports to fail or not load within the application.
- Network-related restrictions, such as closed firewall ports or blocked communication paths between servers, can interfere with database connectivity or reporting services. Additionally, mismatched SQL Server collation settings between the database and server can lead to data inconsistencies or application errors.
If you encounter any of these issues, refer to the relevant installation or configuration sections for detailed troubleshooting steps and corrective actions.
Support¶
If issues persist after reviewing logs and validating configurations, gather relevant diagnostic information before escalating the issue. This includes application logs, SQL Server logs, error messages, screenshots, and details about the installation step where the issue occurred.
For further assistance, contact the nGenue support team.