SLM Database Configuration Guide
SLM database configuration establishes the Microsoft SQL Server databases, users and permissions required by Safety Lifecycle Manager. SLM uses three databases—Cluster, Master and Revision—which work together as part of the application’s underlying database environment.
After the databases have been restored, administrators create the database logins and users required by SLM. Different roles are assigned to the application, administration and SSRS users according to the level of database access each requires.
This guide explains the SLM database configuration process demonstrated in the training, including database restoration, login and user creation, database roles, stored procedure and function permissions, API-related permissions and full database backups.
Understanding SLM Database Configuration
SLM uses Microsoft SQL Server to store and manage application data. The SLM database configuration demonstrated in the training consists of three databases:
- Cluster
- Master
- Revision
Each database must be available within the SQL Server environment before the associated users and permissions can be configured.
The overall configuration process can be divided into four main stages:
- Restore the three SLM databases.
- Create the required SQL Server logins and database users.
- Assign the required roles and permissions.
- Create backups of the configured databases.
For information about the wider server environment surrounding these databases, see the SLM On-Premise Hardware and Software Requirements guide.
Restoring the SLM Databases
The first stage is restoring the Cluster, Master and Revision databases from their supplied SQL Server backup files.
The training demonstrates the restoration process through SQL Server Management Studio. Once connected to the appropriate database server, the administrator opens the database restore function and selects the backup file as the restore device.
The process is performed separately for each database:
- Restore the Cluster database.
- Restore the Master database.
- Restore the Revision database.
After all three operations have completed successfully, SQL Server Management Studio should show the Cluster, Master and Revision databases within the server’s database list.
The supplied database backup files and deployment-specific database names should be used when performing an actual SLM installation rather than relying on example filenames from the training.
Creating SQL Server Logins for SLM
Once the databases have been restored, the next SLM database configuration step is creating the three SQL Server logins used to access the databases.
The training identifies:
- Application login
- Administration login
- SSRS login
The application login is used by the SLM application, the administration login provides the required administrative database access, and the SSRS login is used by SQL Server Reporting Services reports to retrieve data.
The training creates these logins using SQL statements executed against the SQL Server master database. The login-creation statements specify the appropriate login name and associated password.
After the statements have executed successfully, the new logins can be reviewed within the Security and Logins area of SQL Server Management Studio.
Configuring SLM Database Users and Roles
Creating the server logins is only part of the process. A corresponding database user must then be created for each login within each of the three SLM databases.
The SLM database configuration demonstrated in the training assigns different database roles according to the purpose of each user:
- Application user – Data Reader and Data Writer
- Admin user – DB Owner
- SSRS user – Data Reader
The application user therefore has the read and write access required by the application. The admin user receives the database-owner role, while the SSRS user is limited to reading the data required for reporting.
The user-creation and role-assignment script must be applied to each of the SLM databases: Cluster, Master and Revision.
After the script has executed, administrators can review the Users area of each database and inspect role membership to confirm that the expected users and roles have been created.
Assigning Stored Procedure and Function Permissions
Additional permissions are required for SLM to use stored procedures and database functions.
After the users have been created, the training demonstrates granting permissions for:
- Stored procedures
- Scalar functions
- Tabular functions
The supplied SQL script iterates through the relevant database objects and assigns the required permissions to the specified user.
Execution permissions are granted for the applicable stored procedures and scalar functions. Select permissions are granted for the applicable tabular functions.
The process is performed for the application, admin and SSRS users and must be applied across the Cluster, Master and Revision databases as demonstrated in the training.
These scripts form part of the SLM-specific database configuration. Administrators should therefore use the MSS-supplied SQL scripts for their deployment rather than attempting to recreate the permission statements from this overview.
Database Permissions Required by the SLM API
The training demonstrates one further permission associated with the SLM application and API.
A view-definition permission is assigned so that the application can inspect database metadata required by the API. The training explains that this includes information such as:
- Primary keys
- Foreign keys
- Default column values
This metadata is used by the API when performing model-level validations for operations such as updating or deleting records.
The permission is executed against the SQL Server system master database rather than the SLM Master database, making that distinction important when applying the supplied configuration script.
For more information about how external applications interact with SLM, see the SLM API Usage Guide.
Creating Full SLM Database Backups
The final procedure demonstrated in the SLM database configuration training is creating a full backup of each database.
Within SQL Server Management Studio, the administrator selects the required database and opens the Backup function through the Tasks menu.
The demonstrated process is:
- Select the database to back up.
- Open Tasks and select Backup.
- Set the destination to disk.
- Remove the default destination where necessary.
- Select the required backup folder and filename.
- Confirm that the backup type is Full.
- Enable compressed backup.
- Run the backup.
This process is repeated for the Cluster, Master and Revision databases so that each SLM database has its own backup file.
Microsoft provides additional technical information about creating full SQL Server database backups. SLM-specific filenames, locations and configuration should continue to follow the deployment information supplied by MSS.
Configuration vs. Ongoing Database Maintenance
SLM database configuration and database maintenance are closely related, but they serve different purposes.
Configuration establishes the databases, access accounts and permissions required for SLM to operate. It also provides the initial process for creating full database backups.
Ongoing maintenance covers recurring activities performed after the environment has been configured, including scheduled backups, integrity checks, cleanup, index maintenance and statistics maintenance.
For those recurring tasks, see the SLM Database Maintenance Guide.
Keeping these responsibilities separate makes it easier for administrators to distinguish between initial or deployment-related database setup and the recurring maintenance required throughout the life of the SLM environment.
Reviewing the Database Configuration
After completing the configuration process, administrators should confirm that the required database components demonstrated in the training are present.
A practical review should confirm:
- Cluster, Master and Revision databases are restored.
- The application, administration and SSRS logins exist.
- Corresponding users exist within each SLM database.
- Each user has the appropriate database role.
- Required stored procedure and function permissions have been applied.
- The required API-related database metadata permission has been assigned.
- Full backups can be created for all three databases.
SLM database configuration provides the foundation for database access by the application, administrators, reporting services and API. Once that foundation is established, recurring maintenance and monitoring can be managed as separate operational activities.
