-
Notifications
You must be signed in to change notification settings - Fork 10
Build Scripts Folder Contents
| Previous FineBuild Folder Contents | FineBuild Configuration File Next |
|---|
All of the following components are located in the \FineBuild\Build Scripts folder:
This is the cacls command from the standard Windows install media. It is included here in case this file has been excluded from the site Windows build.
The CmdHere script opens a Command window based on the current folder.
This is the cscript command from the standard Windows install media. It is included here in case this file has been excluded from the site Windows build.
The FBConfigBuild script is used to prepare and validate parameters passed to the SQLFineBuild script.
The FBConfigDiscover script is not currently used within SQL FineBuild.
The FBConfigReport script provides a status report of the SQL FineBuild processing.
The FBConfigVar script is used to set Windows variables used by the SQLFineBuild script.
The FBManageAccount script is a class used to manage various parts of account management.
The FBManageBoot script is a class used to manage all aspects of rebooting the server.
The FBManageBuildfile script is a class used to manage the SQL FineBuild Buildfile.
The FBManageCluster script is a class used to manage Windows Cluster configuration.
The FBManageInstall script is a class used to manage software installation.
The FBManageJob script is a class used to manage SQL Server Agent Jobs and Windows Task Scheduler Jobs.
The FBManageLog script is a class used to manage SQL Server FineBuild logging.
The FBManageRSWMI script is a class used to manage Report Services and Power BI Server WMI processing.
The FBManageService script is a class used to manage Windows Services used by SQL FineBuild.
The FBMonitor script is a class used to detect if an install process has stalled.
The FBUtils script is a class used to provide Helper functions to SQL FineBuild.
This file contains a template for the FineBuild run-time Buid file.
The FineBuild1Preparation script builds the disk shares and folder names and applies the security required by the SQL Server install process.
The FineBuild2InstallSQL script performs the installation of SQL Server.
Additional options for the SQL Server Setup program can be provided. See FineBuild Run Time Parameters for a list of what FineBuild will accept.
The FineBuild3InstallFixes script performs the installation of SQL Server Service Packs, Cumulative Updates and Books Online updates. A backup of critical System databases is also made.
The FineBuild4InstallXtas script performs the installation of various optional components for SQL Server that can be installed by FineBuild.
The FineBuild5ConfigureSQL script performs SQL Server configuration that must be performed using the install process.
This script moves files (including some system database files) to new locations and will fail if these files are not in their expected original location. See SQL Server Configuration for details of the work performed.
The FineBuild6ConfigureUsers script performs user customisation of the SQL Server client tools to improve their performance, and other customisation intended to improve DBA productivity.
This Cab file contains the scripts needed to install Policy Based Management (PBM) objects on to SQL Server, and to configure PBM for immediate use. These are installed into SQL Server at Policy Based Management in the FineBuild Reference Manual.
The file contains:
- 60 Condition facets, identified by starting with the letter C.
- 13 Restriction facets, identified by starting with the letter R.
- 16 Target facets, identified by starting with the letter T.
- 58 Policies.
- Schedules and jobs to process the policies.
- Scripts to change the job names created by SQL Server for PBM to include the schedule name, to help the DBA identify what work is being done.
This Cab file contains the following files. These are installed into SQL Server at Configure Generic Maintenance Processes.
| File Name | Description |
|---|---|
| Alert Event Maintenance Process Fail.sql | Raise an Alert is a maintenance process fails |
| CmdHere.bat | Opens a Command window based on the current folder |
| Install.vbs | Install routine for the Generic Maintenance routines |
| Job DBA_CSIMaintenance.sql | Job to run CSI Maintenance |
| MaintenanceSolution.sql | Install file for Ola Hallengren's DB Maintenance processes |
| MaintenanceSolution2005.sql | Install file for Ola Hallengren's DB Maintenance processes for SQL 2005 |
| Message 700000.sql | Message used if a maintenance process fails |
| Proc sp_send_dbmail(SQL2000).sql | Provides the call interface to sp_send_dbmail for SQL Server 2000 systems. It is a wrapper for xp_sendmail and will only be installed on SQL 2000. |
| Proc spBackupLogAlert.sql | Perform a Log Backup when triggered by a log full condition |
| Proc spCSIMaintenance.sql | Run maintenance against ColumnStore Indexes (CSI) |
| Proc spDeleteOldBackups.sql | Delete obsolete backups |
| Proc spProcessAllDB.sql | Run a maintenance process against all databases. Specific databases can be excluded via a parameter |
| Proc spSetDBMaintenance.sql | Build database backup jobs and alerts |
| Proc spSetDBOptions.sql | Set standard DB Options |
| Proc spSetTally.sql | Populate the Tally table |
| Proc spUpdateUsage.sql | Update Space Used statistics |
| SetupASBackup.vbs | Create SSAS Backup jobs |
| SQL sp_configure.sql | Sets sp_configure options required for Generic Maintenance |
| Table DBAKeyValues.sql | Table to hold Key and Value pairs for the DBA |
| Table CSIMaintenance.sql | Table to log results of spCSIMaintenance processing |
| Table Tally.sql | Table to hold sequential numbers. The default number is 1m rows |
The Get-ADSPNAudit script produces the SPNAudit File
This file contains an updated .Net manifest for the SQL 2005 DTS Designer component, as described in KB917406.
This Cab file contains the following files. Please see Non-English Versions of SQL Server in the Reference Manual for details of how to use these files.
| File Name | Description |
|---|---|
| SQLFineBuildDEU.bat | Parameters for installing a German language version of SQL Server |
| SQLFineBuildITA.bat | Parameters for installing an Italian language version of SQL Server |
This is the ntrights command from the W2003 Resource Kit. It is included here in case this file has been excluded from the site Windows build.
This is the reg command from the Windows 2003 install CD. It is included here in case this file has been excluded from the site Windows build.
The ReplaceText script is used by other scripts to perform a find and replace function on a specified file.
This Cab file contains the following files that are used to install the Report Service KeepAlive process.
| File Name | Description |
|---|---|
| Install.vbs | Installs the RSKeepAlive process |
| RSKeepAlive.vbs | Performs the RSKeepAlive process |
The Set-AODBSecondary script is used initialise databases in an Availability Group on the Secondary servers for SQL 2016 and below.
The Set-AOAlerts script is used to install the following processes:
| Process Name | Description |
|---|---|
| Alert Event - AG Failover | Trigger Job DBA: AG State Change when an AG failover occurrs |
| Alert Event - AG State Change | Trigger Job DBA: AG State Change when an AG state change occurrs |
| Function FB_GetAGServers | Gets list of servers for an Availability Group |
| Job DBA: AG State Change | Run FB_AGPostFailover in response to an Event Trigger |
| Proc FB_AGFailover | Process planned failover of an Availability Group |
| Proc FB_AGPostFailover | Configure DB Synchronisation and Job Schedules following an Availability Group failover |
| Table FB_AGPostFailoverDBOwner | Creates table to hold non-standard Database Owner names that must be applied after a Failover |
| Table FB_AGPostFailoverDBUser | Creates table to hold user mappings that must be applied after a Failover |
The Set-AOSystemData script is used to install the following processes:
| Process Name | Description |
|---|---|
| Job DBA: Copy System Data | Job to copy system data from Primary to Secondary nodes |
| Proc FB_AGSystemData | Copy system data for master and msdb from Primary to Secondary nodes |
| Table FB_AGSystemDataJobExceptions | Table to hold list of jobs that should run on Secondary nodes |
| Role FB_AGSystemData | Adds the FB_AGSystemData role to master and msdb databases |
This file sets up the system administrator accounts for SQL 2005 Analysis Services.
The Set-ClusterGroup script is used to install the following processes:
| Process Name | Description |
|---|---|
| Job DBA: Move Cluster Core | Runs the FB_ClusterCore process |
| Proc FB_ClusterCore | Move the Core Cluster Resources to a Secondary node |
The Set-DBADB script creates the DBA_Data database. It is intended to be run from SQLCMD and be passed parameters to specify the database name and the file locations for the instance being configured.
The Set-DBMail script configures the Database Mail profile for SQL Server. This file is based on the Sample Database Mail Configuration template supplied with SQL Server, and tailored to include standardised values.
The Set-FBVersion script sets the SQL FineBuild version to be displayed by the SQLFineBuild.bat script.
The Set-ManagementDWDB script creates the Management Data Warehouse database. It is intended to be run from SQLCMD and be passed parameters to specify the database name and the file locations for the instance being configured.
The Set-MDSDB script is not currently used by SQL FineBuild.
The SQL Server Outlook profile file is used with Outlook to create the Outlook MAPI profile for SQL Mail functionality. It was created using the Office Custom Installation Wizard, and tailored to contain standardised values.
The Set-ResourceGovernor script provides a basic Resource Governor configuration that can classify most workloads.
The Set-RSDBOptions script configures database options and additional indexes for Reporting Services
The Set-RSDBs script creates the Reporting Services databases when Reporting Services is clustered. It is intended to be run from SQLCMD and be passed parameters to specify the database name and the file locations for the instance being configured.
The Set-RSSecurity script is used to set security within Reporting Services, via the RS command. It is based on the AddItemSecurity.rss file from the SQL Server Samples collection.
This Powershell script enables remote access to Powershell by the DBA Sysadmin and DBA Non-Sysadmin Windows groups.
The SET-SSISDB script creates the SSIS Catalog database
The Set-SSISDBOptions script configures database options and additional indexes for the SSIS Catalog Database SSISDB
The Set-StartJobProxy script installs the StartJob Proxy process.
This Set-SystemDBOptions script configures database options and additional indexes for the System Databases.
Windows batch file to install SQL 2005 SP1. This is not used within SQL FineBuild and is included for convenience only.
This Cab file contains the following files. These are installed into SQL Server at process Add DBA routines to DBA_DB Database in the Reference Manual.
| File Name | Description |
|---|---|
| Install.bat Installation routine for the other files. | |
| Job Archive suspect_pages.sql | Daily job to run spArchiveSuspectPages routine |
| Proc FB_DBRestore | Database Restore procedure |
| Proc spArchiveSuspectPages.sql | Move contents of the suspect_pages table to the DBA database, and alert the DBA if any suspect pages have been found |
| Proc spCreateAgentProxy.sql | Simplify the creation of a SQL Agent proxy account |
| Proc spDTSExportPackages.sql | Export details of DTS packages. The automated export or import of DTS packages using SQL Server facilities will lose the layout of these packages and annotations in DTS Designer. It will not affect how they work, just how they look in DTS Designer |
| Proc spDTSImportPackage.sql | Import details of DTS packages that were previously exported. The same restriction on keeping the DTS Designer layout and annotations applies to imports as it does to exports |
| Proc spDTSReplaceOwner.sql | Replace the owner on all DTS packages in SQL Server |
| Proc spResetJobnamesMDW.sql | Change MDW job names to more descriptive format |
| Proc spResetJobnamesPBM.sql | Change PBM job names to more descriptive format |
| Proc spScriptAlerts.sql | Export details of SQL Agent Alerts |
| Proc spScriptFunctions.sql | Export details of User Defined Functions (UDFs). The script includes any permissions that have been defined for the function |
| Proc spScriptJobs.sql | Export details of SQL Agent Jobs. This routine is based on sample code published by Nigel Rivett www.nigelrivett.net, and its use is acknowledged and appreciated. Many of the spScript… routines were in turn based on the enhancements to the spScriptJobs routine |
| Proc spScriptLogins.sql | Export details of SQL Server Logins |
| Proc spScriptMessages.sql | Export details of SQL Server Messages |
| Proc spScriptOperators.sql | Export details of SQL Agent Operators |
| Proc spScriptProcs.sql | Export details of Stored Procedures. The script includes any permissions that have been defined for the procedure |
| Proc sp_ScriptRoles.sql | Export details of any user database roles that exist in a specified database |
| Proc spScriptTables.sql | Export details of user Tables. The script includes any Constraints, Indexes, Triggers and Permissions that have been defined for the table |
| Proc spScriptViews.sql | Export details of user Views. The script includes any Indexes, Triggers and Permissions that have been defined for the view |
| Proc spSetDBOptions | Set standard database options |
| Table suspect_pages_archive.sql | Table in the DBA database to hold archived rows from the suspect_pages table. The DBA should periodically clear out old data from this table |
The SqlServiceStop script stops various services related to SQL Server. It is used during the Service Pack and Cumulative Update installations to prevent locked file situations.
The SqlSysDBCopy script copies the mssqlsystemresource and master files to a backup location on the Backup drive.
This Cab file contains the following files. These are installed into SQL Server at process System DB Management in the Reference Manual.
| File Name | Description |
|---|---|
| Alert BasicSetup.sql | Alerts for error severity 17 and above |
| Alert Login Fail.sql | Alert for notification of failed logins |
| Alert Login sa Success.sql | Alert for notification of successful use of the sa account |
| Install.bat | Installation routine for the other files |
| Job Create New Errorlog.sql | Creates the Create New Errorlog job |
| Msg Messages.sql | Adds a standard set of messages to SQL Server |
| Oper SQL_Alerts.sql | Creates the SQL_Alerts SQL Agent operator |
| Proc sp_GetEnvVarValue.sql | Returns the value of a given Windows environment variable |
| UDT Hugemoney.sql | Creates the Hugemoney user data type in the model database |
This Cab file contains the following files. They are only required when upgrading an instance from an old version of SQL Server to a more recent version. See Upgrade from Old Version of SQL Server in the Reference Manual for details of using these files.
| File Name | Description |
|---|---|
| CmdHere.bat | Opens a Command window based on the current folder. |
| SQL2000_Export.bat | Installs and runs stored procedures that export details from a SQL Server 2000 instance that are required for the replacement SQL Server instance |
| SQL2008_Edit_Jobs.bat | Edits the file containing jobs exported from SQL Server 2000. It changes file names, SQL Agent job tokens (as described in KB 915845), and other details to comply with SQL Server naming standards |
| SQL2008_Import.bat | Imports details into a new SQL Server instance previously exported from an old SQL Server instance |
| This script can be restarted at specific points within the script by adding the appropriate Process Id as a parameter. If any step fails the failed process can be rerun in its entirety after completing any relevant troubleshooting |
The Troubleshooting Performance Problems file contains Best practice information on resolving performance problems in SQL Server 2005. It is published as a Word document on http://download.microsoft.com/download/4/7/a/47a548b9-249e-484c-abd7-29f31282b04d/tshootperfprobs.doc. After downloading, it was converted to PDF format for inclusion in the Build.
The Troubleshooting Performance Problems file contains Best practice information on resolving performance problems in SQL Server 2008 and above. It is published as a Word document on https://docs.microsoft.com/en-us/previous-versions/sql/sql-server-2008/dd672789(v=sql.100). After downloading, it was converted to PDF format for inclusion in the Build.
The User1Preparation script is a sample script that can be modified as required by each site.
It should be used to deploy any preparation the site wishes to include in its standard build process, prior to SQL Server being installed. See Site-Specific Components in the Reference Manual for more details.
The User2Configuration script is a sample script that can be modified as required by each site.
It should be used to deploy any additional SQL Server configuration the site wishes to include in its standard build process. See Site-Specific Components in the Reference Manual for more details.
Copyright FineBuild Team © 2012 - 2021. License and Acknowledgements
| Previous FineBuild Folder Contents | Top | FineBuild Configuration File Next |
|---|
Key SQL FineBuild Links:
SQL FineBuild supports:
- All SQL Server versions from SQL 2019 through to SQL 2005
- Clustered, Non-Clustered and Core implementations of server operating systems
- Availability and Distributed Availability Groups
- 64-bit and (where relevant) 32-bit versions of Windows
The following Windows versions are supported:
- Windows 2022
- Windows 11
- Windows 2019
- Windows 2016
- Windows 10
- Windows 2012 R2
- Windows 8.1
- Windows 2012
- Windows 8
- Windows 2008 R2
- Windows 7
- Windows 2008
- Windows Vista
- Windows 2003
- Windows XP